2 This library is only intended to be used by UEFI network stack modules.
3 It provides basic functions for the UEFI network stack.
5 Copyright (c) 2005 - 2010, Intel Corporation
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #include <Protocol/Ip6.h>
21 #include <Library/BaseLib.h>
23 typedef UINT32 IP4_ADDR
;
24 typedef UINT32 TCP_SEQNO
;
25 typedef UINT16 TCP_PORTNO
;
28 #define NET_ETHER_ADDR_LEN 6
29 #define NET_IFTYPE_ETHERNET 0x01
31 #define NET_VLAN_TAG_LEN 4
32 #define ETHER_TYPE_VLAN 0x8100
34 #define EFI_IP_PROTO_UDP 0x11
35 #define EFI_IP_PROTO_TCP 0x06
36 #define EFI_IP_PROTO_ICMP 0x01
37 #define IP4_PROTO_IGMP 0x02
41 // The address classification
43 #define IP4_ADDR_CLASSA 1
44 #define IP4_ADDR_CLASSB 2
45 #define IP4_ADDR_CLASSC 3
46 #define IP4_ADDR_CLASSD 4
47 #define IP4_ADDR_CLASSE 5
49 #define IP4_MASK_NUM 33
50 #define IP6_PREFIX_NUM 129
52 #define IP6_HOP_BY_HOP 0
53 #define IP6_DESTINATION 60
54 #define IP6_FRAGMENT 44
57 #define IP6_NO_NEXT_HEADER 59
59 #define IP_VERSION_4 4
60 #define IP_VERSION_6 6
65 // Ethernet head definition
68 UINT8 DstMac
[NET_ETHER_ADDR_LEN
];
69 UINT8 SrcMac
[NET_ETHER_ADDR_LEN
];
74 // 802.1Q VLAN Tag Control Information
78 UINT16 Vid
: 12; // Unique VLAN identifier (0 to 4094)
79 UINT16 Cfi
: 1; // Canonical Format Indicator
80 UINT16 Priority
: 3; // 802.1Q priority level (0 to 7)
85 #define VLAN_TCI_CFI_CANONICAL_MAC 0
86 #define VLAN_TCI_CFI_NON_CANONICAL_MAC 1
89 // The EFI_IP4_HEADER is hard to use because the source and
90 // destination address are defined as EFI_IPv4_ADDRESS, which
91 // is a structure. Two structures can't be compared or masked
92 // directly. This is why there is an internal representation.
110 // ICMP head definition. Each ICMP message is categorized as either an error
111 // message or query message. Two message types have their own head format.
121 UINT32 Fourth
; // 4th filed of the head, it depends on Type.
123 } IP4_ICMP_ERROR_HEAD
;
129 } IP4_ICMP_QUERY_HEAD
;
140 EFI_IP6_HEADER IpHead
;
141 } IP6_ICMP_ERROR_HEAD
;
146 } IP6_ICMP_INFORMATION_HEAD
;
149 // UDP header definition
159 // TCP header definition
176 #define NET_MAC_EQUAL(pMac1, pMac2, Len) \
177 (CompareMem ((pMac1), (pMac2), Len) == 0)
179 #define NET_MAC_IS_MULTICAST(Mac, BMac, Len) \
180 (((*((UINT8 *) Mac) & 0x01) == 0x01) && (!NET_MAC_EQUAL (Mac, BMac, Len)))
182 #define NTOHL(x) SwapBytes32 (x)
184 #define HTONL(x) NTOHL(x)
186 #define NTOHS(x) SwapBytes16 (x)
188 #define HTONS(x) NTOHS(x)
189 #define NTOHLL(x) SwapBytes64 (x)
190 #define HTONLL(x) NTOHLL(x)
191 #define NTOHLLL(x) Ip6Swap128 (x)
192 #define HTONLLL(x) NTOHLLL(x)
195 // Test the IP's attribute, All the IPs are in host byte order.
197 #define IP4_IS_MULTICAST(Ip) (((Ip) & 0xF0000000) == 0xE0000000)
198 #define IP4_IS_LOCAL_BROADCAST(Ip) ((Ip) == 0xFFFFFFFF)
199 #define IP4_NET_EQUAL(Ip1, Ip2, NetMask) (((Ip1) & (NetMask)) == ((Ip2) & (NetMask)))
200 #define IP4_IS_VALID_NETMASK(Ip) (NetGetMaskLength (Ip) != IP4_MASK_NUM)
202 #define IP6_IS_MULTICAST(Ip6) (((Ip6)->Addr[0]) == 0xFF)
205 // Convert the EFI_IP4_ADDRESS to plain UINT32 IP4 address.
207 #define EFI_IP4(EfiIpAddr) (*(IP4_ADDR *) ((EfiIpAddr).Addr))
208 #define EFI_NTOHL(EfiIp) (NTOHL (EFI_IP4 ((EfiIp))))
209 #define EFI_IP4_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv4_ADDRESS)) == 0)
211 #define EFI_IP6_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv6_ADDRESS)) == 0)
213 #define IP6_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv6_ADDRESS)))
214 #define IP6_COPY_LINK_ADDRESS(Mac1, Mac2) (CopyMem ((Mac1), (Mac2), sizeof (EFI_MAC_ADDRESS)))
217 // The debug level definition. This value is also used as the
218 // syslog's servity level. Don't change it.
220 #define NETDEBUG_LEVEL_TRACE 5
221 #define NETDEBUG_LEVEL_WARNING 4
222 #define NETDEBUG_LEVEL_ERROR 3
225 // Network debug message is sent out as syslog packet.
227 #define NET_SYSLOG_FACILITY 16 // Syslog local facility local use
228 #define NET_SYSLOG_PACKET_LEN 512
229 #define NET_SYSLOG_TX_TIMEOUT (500 * 1000 * 10) // 500ms
230 #define NET_DEBUG_MSG_LEN 470 // 512 - (ether+ip4+udp4 head length)
233 // The debug output expects the ASCII format string, Use %a to print ASCII
234 // string, and %s to print UNICODE string. PrintArg must be enclosed in ().
235 // For example: NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name));
237 #define NET_DEBUG_TRACE(Module, PrintArg) \
239 NETDEBUG_LEVEL_TRACE, \
243 NetDebugASPrint PrintArg \
246 #define NET_DEBUG_WARNING(Module, PrintArg) \
248 NETDEBUG_LEVEL_WARNING, \
252 NetDebugASPrint PrintArg \
255 #define NET_DEBUG_ERROR(Module, PrintArg) \
257 NETDEBUG_LEVEL_ERROR, \
261 NetDebugASPrint PrintArg \
265 Allocate a buffer, then format the message to it. This is a
266 help function for the NET_DEBUG_XXX macros. The PrintArg of
267 these macros treats the variable length print parameters as a
268 single parameter, and pass it to the NetDebugASPrint. For
269 example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name))
273 NETDEBUG_LEVEL_TRACE,
277 NetDebugASPrint ("State transit to %a\n", Name)
280 @param Format The ASCII format string.
281 @param ... The variable length parameter whose format is determined
282 by the Format string.
284 @return The buffer containing the formatted message,
285 or NULL if failed to allocate memory.
295 Builds an UDP4 syslog packet and send it using SNP.
297 This function will locate a instance of SNP then send the message through it.
298 Because it isn't open the SNP BY_DRIVER, apply caution when using it.
300 @param Level The servity level of the message.
301 @param Module The Moudle that generates the log.
302 @param File The file that contains the log.
303 @param Line The exact line that contains the log.
304 @param Message The user message to log.
306 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
307 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet
308 @retval EFI_SUCCESS The log is discard because that it is more verbose
309 than the mNetDebugLevelMax. Or, it has been sent out.
322 Return the length of the mask.
324 Return the length of the mask. Valid values are 0 to 32.
325 If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM.
326 NetMask is in the host byte order.
328 @param[in] NetMask The netmask to get the length from.
330 @return The length of the netmask, or IP4_MASK_NUM (33) if the mask is invalid.
340 Return the class of the IP address, such as class A, B, C.
341 Addr is in host byte order.
343 The address of class A starts with 0.
344 If the address belong to class A, return IP4_ADDR_CLASSA.
345 The address of class B starts with 10.
346 If the address belong to class B, return IP4_ADDR_CLASSB.
347 The address of class C starts with 110.
348 If the address belong to class C, return IP4_ADDR_CLASSC.
349 The address of class D starts with 1110.
350 If the address belong to class D, return IP4_ADDR_CLASSD.
351 The address of class E starts with 1111.
352 If the address belong to class E, return IP4_ADDR_CLASSE.
355 @param[in] Addr The address to get the class from.
357 @return IP address class, such as IP4_ADDR_CLASSA.
367 Check whether the IP is a valid unicast address according to
368 the netmask. If NetMask is zero, use the IP address's class to get the default mask.
370 If Ip is 0, IP is not a valid unicast address.
371 Class D address is used for multicasting and class E address is reserved for future. If Ip
372 belongs to class D or class E, Ip is not a valid unicast address.
373 If all bits of the host address of Ip are 0 or 1, Ip is not a valid unicast address.
375 @param[in] Ip The IP to check against.
376 @param[in] NetMask The mask of the IP.
378 @return TRUE if Ip is a valid unicast address on the network, otherwise FALSE.
389 Check whether the incoming IPv6 address is a valid unicast address.
391 If the address is a multicast address has binary 0xFF at the start, it is not
392 a valid unicast address. If the address is unspecified ::, it is not a valid
393 unicast address to be assigned to any node. If the address is loopback address
394 ::1, it is also not a valid unicast address to be assigned to any physical
397 @param[in] Ip6 The IPv6 address to check against.
399 @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE.
403 NetIp6IsValidUnicast (
404 IN EFI_IPv6_ADDRESS
*Ip6
409 Check whether the incoming Ipv6 address is the unspecified address or not.
411 @param[in] Ip6 - Ip6 address, in network order.
413 @retval TRUE - Yes, unspecified
418 NetIp6IsUnspecifiedAddr (
419 IN EFI_IPv6_ADDRESS
*Ip6
423 Check whether the incoming Ipv6 address is a link-local address.
425 @param[in] Ip6 - Ip6 address, in network order.
427 @retval TRUE - Yes, link-local address
432 NetIp6IsLinkLocalAddr (
433 IN EFI_IPv6_ADDRESS
*Ip6
437 Check whether the Ipv6 address1 and address2 are on the connected network.
439 @param[in] Ip1 - Ip6 address1, in network order.
440 @param[in] Ip2 - Ip6 address2, in network order.
441 @param[in] PrefixLength - The prefix length of the checking net.
443 @retval TRUE - Yes, connected.
449 EFI_IPv6_ADDRESS
*Ip1
,
450 EFI_IPv6_ADDRESS
*Ip2
,
455 Switches the endianess of an IPv6 address
457 This function swaps the bytes in a 128-bit IPv6 address to switch the value
458 from little endian to big endian or vice versa. The byte swapped value is
461 @param Ip6 Points to an IPv6 address
463 @return The byte swapped IPv6 address.
468 EFI_IPv6_ADDRESS
*Ip6
471 extern IP4_ADDR gIp4AllMasks
[IP4_MASK_NUM
];
474 extern EFI_IPv4_ADDRESS mZeroIp4Addr
;
476 #define NET_IS_DIGIT(Ch) (('0' <= (Ch)) && ((Ch) <= '9'))
477 #define NET_ROUNDUP(size, unit) (((size) + (unit) - 1) & (~((unit) - 1)))
478 #define NET_IS_LOWER_CASE_CHAR(Ch) (('a' <= (Ch)) && ((Ch) <= 'z'))
479 #define NET_IS_UPPER_CASE_CHAR(Ch) (('A' <= (Ch)) && ((Ch) <= 'Z'))
481 #define TICKS_PER_MS 10000U
482 #define TICKS_PER_SECOND 10000000U
484 #define NET_RANDOM(Seed) ((UINT32) ((UINT32) (Seed) * 1103515245UL + 12345) % 4294967295UL)
487 Extract a UINT32 from a byte stream.
489 This function copies a UINT32 from a byte stream, and then converts it from Network
490 byte order to host byte order. Use this function to avoid alignment error.
492 @param[in] Buf The buffer to extract the UINT32.
494 @return The UINT32 extracted.
504 Puts a UINT32 into the byte stream in network byte order.
506 Converts a UINT32 from host byte order to network byte order, and then copies it to the
509 @param[in, out] Buf The buffer to put the UINT32.
510 @param[in] Data The data to put.
521 Initialize a random seed using current time.
523 Get current time first. Then initialize a random seed based on some basic
524 mathematical operations on the hour, day, minute, second, nanosecond and year
527 @return The random seed, initialized with current time.
537 #define NET_LIST_USER_STRUCT(Entry, Type, Field) \
538 BASE_CR(Entry, Type, Field)
540 #define NET_LIST_USER_STRUCT_S(Entry, Type, Field, Sig) \
541 CR(Entry, Type, Field, Sig)
544 // Iterate through the double linked list. It is NOT delete safe
546 #define NET_LIST_FOR_EACH(Entry, ListHead) \
547 for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)
550 // Iterate through the double linked list. This is delete-safe.
551 // Don't touch NextEntry. Also, don't use this macro if list
552 // entries other than the Entry may be deleted when processing
553 // the current Entry.
555 #define NET_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead) \
556 for(Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink; \
557 Entry != (ListHead); \
558 Entry = NextEntry, NextEntry = Entry->ForwardLink \
562 // Make sure the list isn't empty before getting the first/last record.
564 #define NET_LIST_HEAD(ListHead, Type, Field) \
565 NET_LIST_USER_STRUCT((ListHead)->ForwardLink, Type, Field)
567 #define NET_LIST_TAIL(ListHead, Type, Field) \
568 NET_LIST_USER_STRUCT((ListHead)->BackLink, Type, Field)
572 Remove the first node entry on the list, and return the removed node entry.
574 Removes the first node entry from a doubly linked list. It is up to the caller of
575 this function to release the memory used by the first node, if that is required. On
576 exit, the removed node is returned.
578 If Head is NULL, then ASSERT().
579 If Head was not initialized, then ASSERT().
580 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
581 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
584 @param[in, out] Head The list header.
586 @return The first node entry that is removed from the list, NULL if the list is empty.
592 IN OUT LIST_ENTRY
*Head
596 Remove the last node entry on the list and return the removed node entry.
598 Removes the last node entry from a doubly linked list. It is up to the caller of
599 this function to release the memory used by the first node, if that is required. On
600 exit, the removed node is returned.
602 If Head is NULL, then ASSERT().
603 If Head was not initialized, then ASSERT().
604 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
605 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
608 @param[in, out] Head The list head.
610 @return The last node entry that is removed from the list, NULL if the list is empty.
616 IN OUT LIST_ENTRY
*Head
620 Insert a new node entry after a designated node entry of a doubly linked list.
622 Inserts a new node entry designated by NewEntry after the node entry designated by PrevEntry
623 of the doubly linked list.
625 @param[in, out] PrevEntry The entry after which to insert.
626 @param[in, out] NewEntry The new entry to insert.
632 IN OUT LIST_ENTRY
*PrevEntry
,
633 IN OUT LIST_ENTRY
*NewEntry
637 Insert a new node entry before a designated node entry of a doubly linked list.
639 Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry
640 of the doubly linked list.
642 @param[in, out] PostEntry The entry to insert before.
643 @param[in, out] NewEntry The new entry to insert.
648 NetListInsertBefore (
649 IN OUT LIST_ENTRY
*PostEntry
,
650 IN OUT LIST_ENTRY
*NewEntry
655 // Object container: EFI network stack spec defines various kinds of
656 // tokens. The drivers can share code to manage those objects.
670 #define NET_MAP_INCREAMENT 64
673 Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.
675 Initialize the forward and backward links of two head nodes donated by Map->Used
676 and Map->Recycled of two doubly linked lists.
677 Initializes the count of the <Key, Value> pairs in the netmap to zero.
679 If Map is NULL, then ASSERT().
680 If the address of Map->Used is NULL, then ASSERT().
681 If the address of Map->Recycled is NULl, then ASSERT().
683 @param[in, out] Map The netmap to initialize.
693 To clean up the netmap, that is, release allocated memories.
695 Removes all nodes of the Used doubly linked list and frees memory of all related netmap items.
696 Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.
697 The number of the <Key, Value> pairs in the netmap is set to zero.
699 If Map is NULL, then ASSERT().
701 @param[in, out] Map The netmap to clean up.
711 Test whether the netmap is empty and return true if it is.
713 If the number of the <Key, Value> pairs in the netmap is zero, return TRUE.
715 If Map is NULL, then ASSERT().
718 @param[in] Map The net map to test.
720 @return TRUE if the netmap is empty, otherwise FALSE.
730 Return the number of the <Key, Value> pairs in the netmap.
732 @param[in] Map The netmap to get the entry number.
734 @return The entry number in the netmap.
744 Allocate an item to save the <Key, Value> pair to the head of the netmap.
746 Allocate an item to save the <Key, Value> pair and add corresponding node entry
747 to the beginning of the Used doubly linked list. The number of the <Key, Value>
748 pairs in the netmap increase by 1.
750 If Map is NULL, then ASSERT().
752 @param[in, out] Map The netmap to insert into.
753 @param[in] Key The user's key.
754 @param[in] Value The user's value for the key.
756 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
757 @retval EFI_SUCCESS The item is inserted to the head.
765 IN VOID
*Value OPTIONAL
769 Allocate an item to save the <Key, Value> pair to the tail of the netmap.
771 Allocate an item to save the <Key, Value> pair and add corresponding node entry
772 to the tail of the Used doubly linked list. The number of the <Key, Value>
773 pairs in the netmap increase by 1.
775 If Map is NULL, then ASSERT().
777 @param[in, out] Map The netmap to insert into.
778 @param[in] Key The user's key.
779 @param[in] Value The user's value for the key.
781 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
782 @retval EFI_SUCCESS The item is inserted to the tail.
790 IN VOID
*Value OPTIONAL
794 Finds the key in the netmap and returns the point to the item containing the Key.
796 Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every
797 item with the key to search. It returns the point to the item contains the Key if found.
799 If Map is NULL, then ASSERT().
801 @param[in] Map The netmap to search within.
802 @param[in] Key The key to search.
804 @return The point to the item contains the Key, or NULL if Key isn't in the map.
815 Remove the node entry of the item from the netmap and return the key of the removed item.
817 Remove the node entry of the item from the Used doubly linked list of the netmap.
818 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
819 entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL,
820 Value will point to the value of the item. It returns the key of the removed item.
822 If Map is NULL, then ASSERT().
823 If Item is NULL, then ASSERT().
824 if item in not in the netmap, then ASSERT().
826 @param[in, out] Map The netmap to remove the item from.
827 @param[in, out] Item The item to remove.
828 @param[out] Value The variable to receive the value if not NULL.
830 @return The key of the removed item.
837 IN OUT NET_MAP_ITEM
*Item
,
838 OUT VOID
**Value OPTIONAL
842 Remove the first node entry on the netmap and return the key of the removed item.
844 Remove the first node entry from the Used doubly linked list of the netmap.
845 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
846 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
847 parameter Value will point to the value of the item. It returns the key of the removed item.
849 If Map is NULL, then ASSERT().
850 If the Used doubly linked list is empty, then ASSERT().
852 @param[in, out] Map The netmap to remove the head from.
853 @param[out] Value The variable to receive the value if not NULL.
855 @return The key of the item removed.
862 OUT VOID
**Value OPTIONAL
866 Remove the last node entry on the netmap and return the key of the removed item.
868 Remove the last node entry from the Used doubly linked list of the netmap.
869 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
870 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
871 parameter Value will point to the value of the item. It returns the key of the removed item.
873 If Map is NULL, then ASSERT().
874 If the Used doubly linked list is empty, then ASSERT().
876 @param[in, out] Map The netmap to remove the tail from.
877 @param[out] Value The variable to receive the value if not NULL.
879 @return The key of the item removed.
886 OUT VOID
**Value OPTIONAL
891 (*NET_MAP_CALLBACK
) (
893 IN NET_MAP_ITEM
*Item
,
898 Iterate through the netmap and call CallBack for each item.
900 It will contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
901 from the loop. It returns the CallBack's last return value. This function is
902 delete safe for the current item.
904 If Map is NULL, then ASSERT().
905 If CallBack is NULL, then ASSERT().
907 @param[in] Map The Map to iterate through.
908 @param[in] CallBack The callback function to call for each item.
909 @param[in] Arg The opaque parameter to the callback.
911 @retval EFI_SUCCESS There is no item in the netmap or CallBack for each item
913 @retval Others It returns the CallBack's last return value.
920 IN NET_MAP_CALLBACK CallBack
,
921 IN VOID
*Arg OPTIONAL
926 // Helper functions to implement driver binding and service binding protocols.
929 Create a child of the service that is identified by ServiceBindingGuid.
931 Get the ServiceBinding Protocol first, then use it to create a child.
933 If ServiceBindingGuid is NULL, then ASSERT().
934 If ChildHandle is NULL, then ASSERT().
936 @param[in] Controller The controller which has the service installed.
937 @param[in] Image The image handle used to open service.
938 @param[in] ServiceBindingGuid The service's Guid.
939 @param[in, out] ChildHandle The handle to receive the created child.
941 @retval EFI_SUCCESS The child was successfully created.
942 @retval Others Failed to create the child.
947 NetLibCreateServiceChild (
948 IN EFI_HANDLE Controller
,
950 IN EFI_GUID
*ServiceBindingGuid
,
951 IN OUT EFI_HANDLE
*ChildHandle
955 Destroy a child of the service that is identified by ServiceBindingGuid.
957 Get the ServiceBinding Protocol first, then use it to destroy a child.
959 If ServiceBindingGuid is NULL, then ASSERT().
961 @param[in] Controller The controller which has the service installed.
962 @param[in] Image The image handle used to open service.
963 @param[in] ServiceBindingGuid The service's Guid.
964 @param[in] ChildHandle The child to destroy.
966 @retval EFI_SUCCESS The child is successfully destroyed.
967 @retval Others Failed to destroy the child.
972 NetLibDestroyServiceChild (
973 IN EFI_HANDLE Controller
,
975 IN EFI_GUID
*ServiceBindingGuid
,
976 IN EFI_HANDLE ChildHandle
980 Get handle with Simple Network Protocol installed on it.
982 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
983 If Simple Network Protocol is already installed on the ServiceHandle, the
984 ServiceHandle will be returned. If SNP is not installed on the ServiceHandle,
985 try to find its parent handle with SNP installed.
987 @param[in] ServiceHandle The handle where network service binding protocols are
989 @param[out] Snp The pointer to store the address of the SNP instance.
990 This is an optional parameter that may be NULL.
992 @return The SNP handle, or NULL if not found.
998 IN EFI_HANDLE ServiceHandle
,
999 OUT EFI_SIMPLE_NETWORK_PROTOCOL
**Snp OPTIONAL
1003 Retrieve VLAN ID of a VLAN device handle.
1005 Search VLAN device path node in Device Path of specified ServiceHandle and
1006 return its VLAN ID. If no VLAN device path node found, then this ServiceHandle
1007 is not a VLAN device handle, and 0 will be returned.
1009 @param[in] ServiceHandle The handle where network service binding protocols are
1012 @return VLAN ID of the device handle, or 0 if not a VLAN device.
1018 IN EFI_HANDLE ServiceHandle
1022 Find VLAN device handle with specified VLAN ID.
1024 The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle.
1025 This function will append VLAN device path node to the parent device path,
1026 and then use LocateDevicePath() to find the correct VLAN device handle.
1028 @param[in] ControllerHandle The handle where network service binding protocols are
1030 @param[in] VlanId The configured VLAN ID for the VLAN device.
1032 @return The VLAN device handle, or NULL if not found.
1037 NetLibGetVlanHandle (
1038 IN EFI_HANDLE ControllerHandle
,
1043 Get MAC address associated with the network service handle.
1045 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
1046 If SNP is installed on the ServiceHandle or its parent handle, MAC address will
1047 be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.
1049 @param[in] ServiceHandle The handle where network service binding protocols are
1051 @param[out] MacAddress The pointer to store the returned MAC address.
1052 @param[out] AddressSize The length of returned MAC address.
1054 @retval EFI_SUCCESS MAC address is returned successfully.
1055 @retval Others Failed to get SNP mode data.
1060 NetLibGetMacAddress (
1061 IN EFI_HANDLE ServiceHandle
,
1062 OUT EFI_MAC_ADDRESS
*MacAddress
,
1063 OUT UINTN
*AddressSize
1067 Convert MAC address of the NIC associated with specified Service Binding Handle
1068 to a unicode string. Callers are responsible for freeing the string storage.
1070 Locate simple network protocol associated with the Service Binding Handle and
1071 get the mac address from SNP. Then convert the mac address into a unicode
1072 string. It takes 2 unicode characters to represent a 1 byte binary buffer.
1073 Plus one unicode character for the null-terminator.
1075 @param[in] ServiceHandle The handle where network service binding protocol is
1077 @param[in] ImageHandle The image handle used to act as the agent handle to
1078 get the simple network protocol.
1079 @param[out] MacString The pointer to store the address of the string
1080 representation of the mac address.
1082 @retval EFI_SUCCESS Convert the mac address a unicode string successfully.
1083 @retval EFI_OUT_OF_RESOURCES There are not enough memory resource.
1084 @retval Others Failed to open the simple network protocol.
1089 NetLibGetMacString (
1090 IN EFI_HANDLE ServiceHandle
,
1091 IN EFI_HANDLE ImageHandle
,
1092 OUT CHAR16
**MacString
1096 Create an IPv4 device path node.
1098 The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.
1099 The header subtype of IPv4 device path node is MSG_IPv4_DP.
1100 The length of the IPv4 device path node in bytes is 19.
1101 Get other info from parameters to make up the whole IPv4 device path node.
1103 @param[in, out] Node Pointer to the IPv4 device path node.
1104 @param[in] Controller The controller handle.
1105 @param[in] LocalIp The local IPv4 address.
1106 @param[in] LocalPort The local port.
1107 @param[in] RemoteIp The remote IPv4 address.
1108 @param[in] RemotePort The remote port.
1109 @param[in] Protocol The protocol type in the IP header.
1110 @param[in] UseDefaultAddress Whether this instance is using default address or not.
1115 NetLibCreateIPv4DPathNode (
1116 IN OUT IPv4_DEVICE_PATH
*Node
,
1117 IN EFI_HANDLE Controller
,
1118 IN IP4_ADDR LocalIp
,
1119 IN UINT16 LocalPort
,
1120 IN IP4_ADDR RemoteIp
,
1121 IN UINT16 RemotePort
,
1123 IN BOOLEAN UseDefaultAddress
1127 Create an IPv6 device path node.
1129 The header type of IPv6 device path node is MESSAGING_DEVICE_PATH.
1130 The header subtype of IPv6 device path node is MSG_IPv6_DP.
1131 The length of the IPv6 device path node in bytes is 43.
1132 Get other info from parameters to make up the whole IPv6 device path node.
1134 @param[in, out] Node Pointer to the IPv6 device path node.
1135 @param[in] Controller The controller handle.
1136 @param[in] LocalIp The local IPv6 address.
1137 @param[in] LocalPort The local port.
1138 @param[in] RemoteIp The remote IPv6 address.
1139 @param[in] RemotePort The remote port.
1140 @param[in] Protocol The protocol type in the IP header.
1145 NetLibCreateIPv6DPathNode (
1146 IN OUT IPv6_DEVICE_PATH
*Node
,
1147 IN EFI_HANDLE Controller
,
1148 IN EFI_IPv6_ADDRESS
*LocalIp
,
1149 IN UINT16 LocalPort
,
1150 IN EFI_IPv6_ADDRESS
*RemoteIp
,
1151 IN UINT16 RemotePort
,
1157 Find the UNDI/SNP handle from controller and protocol GUID.
1159 For example, IP will open an MNP child to transmit/receive
1160 packets. When MNP is stopped, IP should also be stopped. IP
1161 needs to find its own private data which is related the IP's
1162 service binding instance that is install on UNDI/SNP handle.
1163 Now, the controller is either a MNP or ARP child handle. But
1164 IP opens these handle BY_DRIVER, use that info, we can get the
1167 @param[in] Controller Then protocol handle to check.
1168 @param[in] ProtocolGuid The protocol that is related with the handle.
1170 @return The UNDI/SNP handle or NULL for errors.
1175 NetLibGetNicHandle (
1176 IN EFI_HANDLE Controller
,
1177 IN EFI_GUID
*ProtocolGuid
1181 This is the default unload handle for all the network drivers.
1183 Disconnect the driver specified by ImageHandle from all the devices in the handle database.
1184 Uninstall all the protocols installed in the driver entry point.
1186 @param[in] ImageHandle The drivers' driver image.
1188 @retval EFI_SUCCESS The image is unloaded.
1189 @retval Others Failed to unload the image.
1194 NetLibDefaultUnload (
1195 IN EFI_HANDLE ImageHandle
1200 //Various signatures
1202 #define NET_BUF_SIGNATURE SIGNATURE_32 ('n', 'b', 'u', 'f')
1203 #define NET_VECTOR_SIGNATURE SIGNATURE_32 ('n', 'v', 'e', 'c')
1204 #define NET_QUE_SIGNATURE SIGNATURE_32 ('n', 'b', 'q', 'u')
1207 #define NET_PROTO_DATA 64 // Opaque buffer for protocols
1208 #define NET_BUF_HEAD 1 // Trim or allocate space from head
1209 #define NET_BUF_TAIL 0 // Trim or allocate space from tail
1210 #define NET_VECTOR_OWN_FIRST 0x01 // We allocated the 1st block in the vector
1212 #define NET_CHECK_SIGNATURE(PData, SIGNATURE) \
1213 ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE)))
1216 // Single memory block in the vector.
1219 UINT32 Len
; // The block's length
1220 UINT8
*Bulk
; // The block's Data
1223 typedef VOID (*NET_VECTOR_EXT_FREE
) (VOID
*Arg
);
1226 //NET_VECTOR contains several blocks to hold all packet's
1227 //fragments and other house-keeping stuff for sharing. It
1228 //doesn't specify the where actual packet fragment begins.
1232 INTN RefCnt
; // Reference count to share NET_VECTOR.
1233 NET_VECTOR_EXT_FREE Free
; // external function to free NET_VECTOR
1234 VOID
*Arg
; // opeque argument to Free
1235 UINT32 Flag
; // Flags, NET_VECTOR_OWN_FIRST
1236 UINT32 Len
; // Total length of the assocated BLOCKs
1243 //NET_BLOCK_OP operates on the NET_BLOCK. It specifies
1244 //where the actual fragment begins and ends
1247 UINT8
*BlockHead
; // Block's head, or the smallest valid Head
1248 UINT8
*BlockTail
; // Block's tail. BlockTail-BlockHead=block length
1249 UINT8
*Head
; // 1st byte of the data in the block
1250 UINT8
*Tail
; // Tail of the data in the block, Tail-Head=Size
1251 UINT32 Size
; // The size of the data
1256 EFI_IP6_HEADER
*Ip6
;
1260 //NET_BUF is the buffer manage structure used by the
1261 //network stack. Every network packet may be fragmented. The Vector points to
1262 //memory blocks used by each fragment, and BlockOp
1263 //specifies where each fragment begins and ends.
1265 //It also contains an opaque area for the protocol to store
1266 //per-packet information. Protocol must be careful not
1267 //to overwrite the members after that.
1272 LIST_ENTRY List
; // The List this NET_BUF is on
1274 NET_IP_HEAD Ip
; // Network layer header, for fast access
1275 TCP_HEAD
*Tcp
; // Transport layer header, for fast access
1276 EFI_UDP_HEADER
*Udp
; // User Datagram Protocol header
1277 UINT8 ProtoData
[NET_PROTO_DATA
]; //Protocol specific data
1279 NET_VECTOR
*Vector
; // The vector containing the packet
1281 UINT32 BlockOpNum
; // Total number of BlockOp in the buffer
1282 UINT32 TotalSize
; // Total size of the actual packet
1283 NET_BLOCK_OP BlockOp
[1]; // Specify the position of actual packet
1287 //A queue of NET_BUFs. It is a thin extension of
1288 //NET_BUF functions.
1293 LIST_ENTRY List
; // The List this buffer queue is on
1295 LIST_ENTRY BufList
; // list of queued buffers
1296 UINT32 BufSize
; // total length of DATA in the buffers
1297 UINT32 BufNum
; // total number of buffers on the chain
1301 // Pseudo header for TCP and UDP checksum
1313 EFI_IPv6_ADDRESS SrcIp
;
1314 EFI_IPv6_ADDRESS DstIp
;
1317 UINT32 NextHeader
:8;
1318 } NET_IP6_PSEUDO_HDR
;
1322 // The fragment entry table used in network interfaces. This is
1323 // the same as NET_BLOCK now. Use two different to distinguish
1324 // the two in case that NET_BLOCK be enhanced later.
1331 #define NET_GET_REF(PData) ((PData)->RefCnt++)
1332 #define NET_PUT_REF(PData) ((PData)->RefCnt--)
1333 #define NETBUF_FROM_PROTODATA(Info) BASE_CR((Info), NET_BUF, ProtoData)
1335 #define NET_BUF_SHARED(Buf) \
1336 (((Buf)->RefCnt > 1) || ((Buf)->Vector->RefCnt > 1))
1338 #define NET_VECTOR_SIZE(BlockNum) \
1339 (sizeof (NET_VECTOR) + ((BlockNum) - 1) * sizeof (NET_BLOCK))
1341 #define NET_BUF_SIZE(BlockOpNum) \
1342 (sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))
1344 #define NET_HEADSPACE(BlockOp) \
1345 (UINTN)((BlockOp)->Head - (BlockOp)->BlockHead)
1347 #define NET_TAILSPACE(BlockOp) \
1348 (UINTN)((BlockOp)->BlockTail - (BlockOp)->Tail)
1351 Allocate a single block NET_BUF. Upon allocation, all the
1352 free space is in the tail room.
1354 @param[in] Len The length of the block.
1356 @return Pointer to the allocated NET_BUF, or NULL if the
1357 allocation failed due to resource limit.
1367 Free the net buffer and its associated NET_VECTOR.
1369 Decrease the reference count of the net buffer by one. Free the associated net
1370 vector and itself if the reference count of the net buffer is decreased to 0.
1371 The net vector free operation decreases the reference count of the net
1372 vector by one, and performs the resource free operation when the reference count
1373 of the net vector is 0.
1375 @param[in] Nbuf Pointer to the NET_BUF to be freed.
1385 Get the index of NET_BLOCK_OP that contains the byte at Offset in the net
1388 For example, this function can be used to retrieve the IP header in the packet. It
1389 also can be used to get the fragment that contains the byte used
1390 mainly by the library implementation itself.
1392 @param[in] Nbuf Pointer to the net buffer.
1393 @param[in] Offset The offset of the byte.
1394 @param[out] Index Index of the NET_BLOCK_OP that contains the byte at
1397 @return Pointer to the Offset'th byte of data in the net buffer, or NULL
1398 if there is no such data in the net buffer.
1406 OUT UINT32
*Index OPTIONAL
1410 Create a copy of the net buffer that shares the associated net vector.
1412 The reference count of the newly created net buffer is set to 1. The reference
1413 count of the associated net vector is increased by one.
1415 @param[in] Nbuf Pointer to the net buffer to be cloned.
1417 @return Pointer to the cloned net buffer, or NULL if the
1418 allocation failed due to resource limit.
1428 Create a duplicated copy of the net buffer with data copied and HeadSpace
1429 bytes of head space reserved.
1431 The duplicated net buffer will allocate its own memory to hold the data of the
1434 @param[in] Nbuf Pointer to the net buffer to be duplicated from.
1435 @param[in, out] Duplicate Pointer to the net buffer to duplicate to, if
1436 NULL a new net buffer is allocated.
1437 @param[in] HeadSpace Length of the head space to reserve.
1439 @return Pointer to the duplicated net buffer, or NULL if
1440 the allocation failed due to resource limit.
1447 IN OUT NET_BUF
*Duplicate OPTIONAL
,
1452 Create a NET_BUF structure which contains Len byte data of Nbuf starting from
1455 A new NET_BUF structure will be created but the associated data in NET_VECTOR
1456 is shared. This function exists to do IP packet fragmentation.
1458 @param[in] Nbuf Pointer to the net buffer to be extracted.
1459 @param[in] Offset Starting point of the data to be included in the new
1461 @param[in] Len Bytes of data to be included in the new net buffer.
1462 @param[in] HeadSpace Bytes of head space to reserve for protocol header.
1464 @return Pointer to the cloned net buffer, or NULL if the
1465 allocation failed due to resource limit.
1478 Reserve some space in the header room of the net buffer.
1480 Upon allocation, all the space is in the tail room of the buffer. Call this
1481 function to move some space to the header room. This function is quite limited
1482 in that it can only reserve space from the first block of an empty NET_BUF not
1483 built from the external. But it should be enough for the network stack.
1485 @param[in, out] Nbuf Pointer to the net buffer.
1486 @param[in] Len The length of buffer to be reserved from the header.
1492 IN OUT NET_BUF
*Nbuf
,
1497 Allocate Len bytes of space from the header or tail of the buffer.
1499 @param[in, out] Nbuf Pointer to the net buffer.
1500 @param[in] Len The length of the buffer to be allocated.
1501 @param[in] FromHead The flag to indicate whether reserve the data
1502 from head (TRUE) or tail (FALSE).
1504 @return Pointer to the first byte of the allocated buffer,
1505 or NULL if there is no sufficient space.
1511 IN OUT NET_BUF
*Nbuf
,
1517 Trim Len bytes from the header or tail of the net buffer.
1519 @param[in, out] Nbuf Pointer to the net buffer.
1520 @param[in] Len The length of the data to be trimmed.
1521 @param[in] FromHead The flag to indicate whether trim data from head
1522 (TRUE) or tail (FALSE).
1524 @return Length of the actually trimmed data, which may be less
1525 than Len if the TotalSize of Nbuf is less than Len.
1531 IN OUT NET_BUF
*Nbuf
,
1537 Copy Len bytes of data from the specific offset of the net buffer to the
1540 The Len bytes of data may cross several fragments of the net buffer.
1542 @param[in] Nbuf Pointer to the net buffer.
1543 @param[in] Offset The sequence number of the first byte to copy.
1544 @param[in] Len Length of the data to copy.
1545 @param[in] Dest The destination of the data to copy to.
1547 @return The length of the actual copied data, or 0 if the offset
1548 specified exceeds the total size of net buffer.
1561 Build a NET_BUF from external blocks.
1563 A new NET_BUF structure will be created from external blocks. An additional block
1564 of memory will be allocated to hold reserved HeadSpace bytes of header room
1565 and existing HeadLen bytes of header, but the external blocks are shared by the
1566 net buffer to avoid data copying.
1568 @param[in] ExtFragment Pointer to the data block.
1569 @param[in] ExtNum The number of the data blocks.
1570 @param[in] HeadSpace The head space to be reserved.
1571 @param[in] HeadLen The length of the protocol header. The function
1572 pulls this amount of data into a linear block.
1573 @param[in] ExtFree Pointer to the caller-provided free function.
1574 @param[in] Arg The argument passed to ExtFree when ExtFree is
1577 @return Pointer to the net buffer built from the data blocks,
1578 or NULL if the allocation failed due to resource
1585 IN NET_FRAGMENT
*ExtFragment
,
1587 IN UINT32 HeadSpace
,
1589 IN NET_VECTOR_EXT_FREE ExtFree
,
1590 IN VOID
*Arg OPTIONAL
1594 Build a fragment table to contain the fragments in the net buffer. This is the
1595 opposite operation of the NetbufFromExt.
1597 @param[in] Nbuf Point to the net buffer.
1598 @param[in, out] ExtFragment Pointer to the data block.
1599 @param[in, out] ExtNum The number of the data blocks.
1601 @retval EFI_BUFFER_TOO_SMALL The number of non-empty blocks is bigger than
1603 @retval EFI_SUCCESS Fragment table is built successfully.
1610 IN OUT NET_FRAGMENT
*ExtFragment
,
1611 IN OUT UINT32
*ExtNum
1615 Build a net buffer from a list of net buffers.
1617 All the fragments will be collected from the list of NEW_BUF and then a new
1618 net buffer will be created through NetbufFromExt.
1620 @param[in] BufList A List of the net buffer.
1621 @param[in] HeadSpace The head space to be reserved.
1622 @param[in] HeaderLen The length of the protocol header. The function
1623 pulls this amount of data into a linear block.
1624 @param[in] ExtFree Pointer to the caller provided free function.
1625 @param[in] Arg The argument passed to ExtFree when ExtFree is called.
1627 @return Pointer to the net buffer built from the list of net
1634 IN LIST_ENTRY
*BufList
,
1635 IN UINT32 HeadSpace
,
1636 IN UINT32 HeaderLen
,
1637 IN NET_VECTOR_EXT_FREE ExtFree
,
1638 IN VOID
*Arg OPTIONAL
1642 Free a list of net buffers.
1644 @param[in, out] Head Pointer to the head of linked net buffers.
1650 IN OUT LIST_ENTRY
*Head
1654 Initiate the net buffer queue.
1656 @param[in, out] NbufQue Pointer to the net buffer queue to be initialized.
1662 IN OUT NET_BUF_QUEUE
*NbufQue
1666 Allocate and initialize a net buffer queue.
1668 @return Pointer to the allocated net buffer queue, or NULL if the
1669 allocation failed due to resource limit.
1679 Free a net buffer queue.
1681 Decrease the reference count of the net buffer queue by one. The real resource
1682 free operation isn't performed until the reference count of the net buffer
1683 queue is decreased to 0.
1685 @param[in] NbufQue Pointer to the net buffer queue to be freed.
1691 IN NET_BUF_QUEUE
*NbufQue
1695 Remove a net buffer from the head in the specific queue and return it.
1697 @param[in, out] NbufQue Pointer to the net buffer queue.
1699 @return Pointer to the net buffer removed from the specific queue,
1700 or NULL if there is no net buffer in the specific queue.
1706 IN OUT NET_BUF_QUEUE
*NbufQue
1710 Append a net buffer to the net buffer queue.
1712 @param[in, out] NbufQue Pointer to the net buffer queue.
1713 @param[in, out] Nbuf Pointer to the net buffer to be appended.
1719 IN OUT NET_BUF_QUEUE
*NbufQue
,
1720 IN OUT NET_BUF
*Nbuf
1724 Copy Len bytes of data from the net buffer queue at the specific offset to the
1727 The copying operation is the same as NetbufCopy but applies to the net buffer
1728 queue instead of the net buffer.
1730 @param[in] NbufQue Pointer to the net buffer queue.
1731 @param[in] Offset The sequence number of the first byte to copy.
1732 @param[in] Len Length of the data to copy.
1733 @param[out] Dest The destination of the data to copy to.
1735 @return The length of the actual copied data, or 0 if the offset
1736 specified exceeds the total size of net buffer queue.
1742 IN NET_BUF_QUEUE
*NbufQue
,
1749 Trim Len bytes of data from the queue header and release any net buffer
1750 that is trimmed wholely.
1752 The trimming operation is the same as NetbufTrim but applies to the net buffer
1753 queue instead of the net buffer.
1755 @param[in, out] NbufQue Pointer to the net buffer queue.
1756 @param[in] Len Length of the data to trim.
1758 @return The actual length of the data trimmed.
1764 IN OUT NET_BUF_QUEUE
*NbufQue
,
1770 Flush the net buffer queue.
1772 @param[in, out] NbufQue Pointer to the queue to be flushed.
1778 IN OUT NET_BUF_QUEUE
*NbufQue
1782 Compute the checksum for a bulk of data.
1784 @param[in] Bulk Pointer to the data.
1785 @param[in] Len Length of the data, in bytes.
1787 @return The computed checksum.
1800 @param[in] Checksum1 The first checksum to be added.
1801 @param[in] Checksum2 The second checksum to be added.
1803 @return The new checksum.
1809 IN UINT16 Checksum1
,
1814 Compute the checksum for a NET_BUF.
1816 @param[in] Nbuf Pointer to the net buffer.
1818 @return The computed checksum.
1828 Compute the checksum for TCP/UDP pseudo header.
1830 Src and Dst are in network byte order, and Len is in host byte order.
1832 @param[in] Src The source address of the packet.
1833 @param[in] Dst The destination address of the packet.
1834 @param[in] Proto The protocol type of the packet.
1835 @param[in] Len The length of the packet.
1837 @return The computed checksum.
1842 NetPseudoHeadChecksum (
1850 Compute the checksum for TCP6/UDP6 pseudo header.
1852 Src and Dst are in network byte order, and Len is in host byte order.
1854 @param[in] Src The source address of the packet.
1855 @param[in] Dst The destination address of the packet.
1856 @param[in] NextHeader The protocol type of the packet.
1857 @param[in] Len The length of the packet.
1859 @return The computed checksum.
1863 NetIp6PseudoHeadChecksum (
1864 IN EFI_IPv6_ADDRESS
*Src
,
1865 IN EFI_IPv6_ADDRESS
*Dst
,
1866 IN UINT8 NextHeader
,