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 - 2011, Intel Corporation. All rights reserved.<BR>
6 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<BR>
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>
22 #include <Library/BaseMemoryLib.h>
24 typedef UINT32 IP4_ADDR
;
25 typedef UINT32 TCP_SEQNO
;
26 typedef UINT16 TCP_PORTNO
;
29 #define NET_ETHER_ADDR_LEN 6
30 #define NET_IFTYPE_ETHERNET 0x01
32 #define NET_VLAN_TAG_LEN 4
33 #define ETHER_TYPE_VLAN 0x8100
35 #define EFI_IP_PROTO_UDP 0x11
36 #define EFI_IP_PROTO_TCP 0x06
37 #define EFI_IP_PROTO_ICMP 0x01
38 #define IP4_PROTO_IGMP 0x02
42 // The address classification
44 #define IP4_ADDR_CLASSA 1
45 #define IP4_ADDR_CLASSB 2
46 #define IP4_ADDR_CLASSC 3
47 #define IP4_ADDR_CLASSD 4
48 #define IP4_ADDR_CLASSE 5
50 #define IP4_MASK_NUM 33
51 #define IP6_PREFIX_NUM 129
53 #define IP6_HOP_BY_HOP 0
54 #define IP6_DESTINATION 60
55 #define IP6_ROUTING 43
56 #define IP6_FRAGMENT 44
59 #define IP6_NO_NEXT_HEADER 59
61 #define IP_VERSION_4 4
62 #define IP_VERSION_6 6
67 // Ethernet head definition
70 UINT8 DstMac
[NET_ETHER_ADDR_LEN
];
71 UINT8 SrcMac
[NET_ETHER_ADDR_LEN
];
76 // 802.1Q VLAN Tag Control Information
80 UINT16 Vid
: 12; // Unique VLAN identifier (0 to 4094)
81 UINT16 Cfi
: 1; // Canonical Format Indicator
82 UINT16 Priority
: 3; // 802.1Q priority level (0 to 7)
87 #define VLAN_TCI_CFI_CANONICAL_MAC 0
88 #define VLAN_TCI_CFI_NON_CANONICAL_MAC 1
91 // The EFI_IP4_HEADER is hard to use because the source and
92 // destination address are defined as EFI_IPv4_ADDRESS, which
93 // is a structure. Two structures can't be compared or masked
94 // directly. This is why there is an internal representation.
112 // ICMP head definition. Each ICMP message is categorized as either an error
113 // message or query message. Two message types have their own head format.
123 UINT32 Fourth
; // 4th filed of the head, it depends on Type.
125 } IP4_ICMP_ERROR_HEAD
;
131 } IP4_ICMP_QUERY_HEAD
;
142 EFI_IP6_HEADER IpHead
;
143 } IP6_ICMP_ERROR_HEAD
;
148 } IP6_ICMP_INFORMATION_HEAD
;
151 // UDP header definition
161 // TCP header definition
178 #define NET_MAC_EQUAL(pMac1, pMac2, Len) \
179 (CompareMem ((pMac1), (pMac2), Len) == 0)
181 #define NET_MAC_IS_MULTICAST(Mac, BMac, Len) \
182 (((*((UINT8 *) Mac) & 0x01) == 0x01) && (!NET_MAC_EQUAL (Mac, BMac, Len)))
184 #define NTOHL(x) SwapBytes32 (x)
186 #define HTONL(x) NTOHL(x)
188 #define NTOHS(x) SwapBytes16 (x)
190 #define HTONS(x) NTOHS(x)
191 #define NTOHLL(x) SwapBytes64 (x)
192 #define HTONLL(x) NTOHLL(x)
193 #define NTOHLLL(x) Ip6Swap128 (x)
194 #define HTONLLL(x) NTOHLLL(x)
197 // Test the IP's attribute, All the IPs are in host byte order.
199 #define IP4_IS_MULTICAST(Ip) (((Ip) & 0xF0000000) == 0xE0000000)
200 #define IP4_IS_LOCAL_BROADCAST(Ip) ((Ip) == 0xFFFFFFFF)
201 #define IP4_NET_EQUAL(Ip1, Ip2, NetMask) (((Ip1) & (NetMask)) == ((Ip2) & (NetMask)))
202 #define IP4_IS_VALID_NETMASK(Ip) (NetGetMaskLength (Ip) != IP4_MASK_NUM)
204 #define IP6_IS_MULTICAST(Ip6) (((Ip6)->Addr[0]) == 0xFF)
207 // Convert the EFI_IP4_ADDRESS to plain UINT32 IP4 address.
209 #define EFI_IP4(EfiIpAddr) (*(IP4_ADDR *) ((EfiIpAddr).Addr))
210 #define EFI_NTOHL(EfiIp) (NTOHL (EFI_IP4 ((EfiIp))))
211 #define EFI_IP4_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv4_ADDRESS)) == 0)
213 #define EFI_IP6_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv6_ADDRESS)) == 0)
215 #define IP6_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv6_ADDRESS)))
216 #define IP6_COPY_LINK_ADDRESS(Mac1, Mac2) (CopyMem ((Mac1), (Mac2), sizeof (EFI_MAC_ADDRESS)))
219 // The debug level definition. This value is also used as the
220 // syslog's servity level. Don't change it.
222 #define NETDEBUG_LEVEL_TRACE 5
223 #define NETDEBUG_LEVEL_WARNING 4
224 #define NETDEBUG_LEVEL_ERROR 3
227 // Network debug message is sent out as syslog packet.
229 #define NET_SYSLOG_FACILITY 16 // Syslog local facility local use
230 #define NET_SYSLOG_PACKET_LEN 512
231 #define NET_SYSLOG_TX_TIMEOUT (500 * 1000 * 10) // 500ms
232 #define NET_DEBUG_MSG_LEN 470 // 512 - (ether+ip4+udp4 head length)
235 // The debug output expects the ASCII format string, Use %a to print ASCII
236 // string, and %s to print UNICODE string. PrintArg must be enclosed in ().
237 // For example: NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name));
239 #define NET_DEBUG_TRACE(Module, PrintArg) \
241 NETDEBUG_LEVEL_TRACE, \
245 NetDebugASPrint PrintArg \
248 #define NET_DEBUG_WARNING(Module, PrintArg) \
250 NETDEBUG_LEVEL_WARNING, \
254 NetDebugASPrint PrintArg \
257 #define NET_DEBUG_ERROR(Module, PrintArg) \
259 NETDEBUG_LEVEL_ERROR, \
263 NetDebugASPrint PrintArg \
267 Allocate a buffer, then format the message to it. This is a
268 help function for the NET_DEBUG_XXX macros. The PrintArg of
269 these macros treats the variable length print parameters as a
270 single parameter, and pass it to the NetDebugASPrint. For
271 example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name))
275 NETDEBUG_LEVEL_TRACE,
279 NetDebugASPrint ("State transit to %a\n", Name)
282 @param Format The ASCII format string.
283 @param ... The variable length parameter whose format is determined
284 by the Format string.
286 @return The buffer containing the formatted message,
287 or NULL if memory allocation failed.
298 Builds an UDP4 syslog packet and send it using SNP.
300 This function will locate a instance of SNP then send the message through it.
301 Because it isn't open the SNP BY_DRIVER, apply caution when using it.
303 @param Level The servity level of the message.
304 @param Module The Moudle that generates the log.
305 @param File The file that contains the log.
306 @param Line The exact line that contains the log.
307 @param Message The user message to log.
309 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
310 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet
311 @retval EFI_SUCCESS The log is discard because that it is more verbose
312 than the mNetDebugLevelMax. Or, it has been sent out.
326 Return the length of the mask.
328 Return the length of the mask. Valid values are 0 to 32.
329 If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM.
330 NetMask is in the host byte order.
332 @param[in] NetMask The netmask to get the length from.
334 @return The length of the netmask, or IP4_MASK_NUM (33) if the mask is invalid.
344 Return the class of the IP address, such as class A, B, C.
345 Addr is in host byte order.
347 The address of class A starts with 0.
348 If the address belong to class A, return IP4_ADDR_CLASSA.
349 The address of class B starts with 10.
350 If the address belong to class B, return IP4_ADDR_CLASSB.
351 The address of class C starts with 110.
352 If the address belong to class C, return IP4_ADDR_CLASSC.
353 The address of class D starts with 1110.
354 If the address belong to class D, return IP4_ADDR_CLASSD.
355 The address of class E starts with 1111.
356 If the address belong to class E, return IP4_ADDR_CLASSE.
359 @param[in] Addr The address to get the class from.
361 @return IP address class, such as IP4_ADDR_CLASSA.
371 Check whether the IP is a valid unicast address according to
372 the netmask. If NetMask is zero, use the IP address's class to get the default mask.
374 If Ip is 0, IP is not a valid unicast address.
375 Class D address is used for multicasting and class E address is reserved for future. If Ip
376 belongs to class D or class E, Ip is not a valid unicast address.
377 If all bits of the host address of Ip are 0 or 1, Ip is not a valid unicast address.
379 @param[in] Ip The IP to check against.
380 @param[in] NetMask The mask of the IP.
382 @return TRUE if Ip is a valid unicast address on the network, otherwise FALSE.
393 Check whether the incoming IPv6 address is a valid unicast address.
395 If the address is a multicast address has binary 0xFF at the start, it is not
396 a valid unicast address. If the address is unspecified ::, it is not a valid
397 unicast address to be assigned to any node. If the address is loopback address
398 ::1, it is also not a valid unicast address to be assigned to any physical
401 @param[in] Ip6 The IPv6 address to check against.
403 @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE.
408 NetIp6IsValidUnicast (
409 IN EFI_IPv6_ADDRESS
*Ip6
414 Check whether the incoming Ipv6 address is the unspecified address or not.
416 @param[in] Ip6 - Ip6 address, in network order.
418 @retval TRUE - Yes, incoming Ipv6 address is the unspecified address.
419 @retval FALSE - The incoming Ipv6 address is not the unspecified address
424 NetIp6IsUnspecifiedAddr (
425 IN EFI_IPv6_ADDRESS
*Ip6
429 Check whether the incoming Ipv6 address is a link-local address.
431 @param[in] Ip6 - Ip6 address, in network order.
433 @retval TRUE - The incoming Ipv6 address is a link-local address.
434 @retval FALSE - The incoming Ipv6 address is not a link-local address.
439 NetIp6IsLinkLocalAddr (
440 IN EFI_IPv6_ADDRESS
*Ip6
444 Check whether the Ipv6 address1 and address2 are on the connected network.
446 @param[in] Ip1 - Ip6 address1, in network order.
447 @param[in] Ip2 - Ip6 address2, in network order.
448 @param[in] PrefixLength - The prefix length of the checking net.
450 @retval TRUE - Yes, the Ipv6 address1 and address2 are connected.
451 @retval FALSE - No the Ipv6 address1 and address2 are not connected.
457 EFI_IPv6_ADDRESS
*Ip1
,
458 EFI_IPv6_ADDRESS
*Ip2
,
463 Switches the endianess of an IPv6 address.
465 This function swaps the bytes in a 128-bit IPv6 address to switch the value
466 from little endian to big endian or vice versa. The byte swapped value is
469 @param Ip6 Points to an IPv6 address.
471 @return The byte swapped IPv6 address.
477 EFI_IPv6_ADDRESS
*Ip6
480 extern IP4_ADDR gIp4AllMasks
[IP4_MASK_NUM
];
483 extern EFI_IPv4_ADDRESS mZeroIp4Addr
;
485 #define NET_IS_DIGIT(Ch) (('0' <= (Ch)) && ((Ch) <= '9'))
486 #define NET_ROUNDUP(size, unit) (((size) + (unit) - 1) & (~((unit) - 1)))
487 #define NET_IS_LOWER_CASE_CHAR(Ch) (('a' <= (Ch)) && ((Ch) <= 'z'))
488 #define NET_IS_UPPER_CASE_CHAR(Ch) (('A' <= (Ch)) && ((Ch) <= 'Z'))
490 #define TICKS_PER_MS 10000U
491 #define TICKS_PER_SECOND 10000000U
493 #define NET_RANDOM(Seed) ((UINT32) ((UINT32) (Seed) * 1103515245UL + 12345) % 4294967295UL)
496 Extract a UINT32 from a byte stream.
498 This function copies a UINT32 from a byte stream, and then converts it from Network
499 byte order to host byte order. Use this function to avoid alignment error.
501 @param[in] Buf The buffer to extract the UINT32.
503 @return The UINT32 extracted.
513 Puts a UINT32 into the byte stream in network byte order.
515 Converts a UINT32 from host byte order to network byte order, then copies it to the
518 @param[in, out] Buf The buffer in which to put the UINT32.
519 @param[in] Data The data to be converted and put into the byte stream.
530 Initialize a random seed using current time.
532 Get current time first. Then initialize a random seed based on some basic
533 mathematical operations on the hour, day, minute, second, nanosecond and year
536 @return The random seed, initialized with current time.
546 #define NET_LIST_USER_STRUCT(Entry, Type, Field) \
547 BASE_CR(Entry, Type, Field)
549 #define NET_LIST_USER_STRUCT_S(Entry, Type, Field, Sig) \
550 CR(Entry, Type, Field, Sig)
553 // Iterate through the double linked list. It is NOT delete safe
555 #define NET_LIST_FOR_EACH(Entry, ListHead) \
556 for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)
559 // Iterate through the double linked list. This is delete-safe.
560 // Don't touch NextEntry. Also, don't use this macro if list
561 // entries other than the Entry may be deleted when processing
562 // the current Entry.
564 #define NET_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead) \
565 for(Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink; \
566 Entry != (ListHead); \
567 Entry = NextEntry, NextEntry = Entry->ForwardLink \
571 // Make sure the list isn't empty before getting the first/last record.
573 #define NET_LIST_HEAD(ListHead, Type, Field) \
574 NET_LIST_USER_STRUCT((ListHead)->ForwardLink, Type, Field)
576 #define NET_LIST_TAIL(ListHead, Type, Field) \
577 NET_LIST_USER_STRUCT((ListHead)->BackLink, Type, Field)
581 Remove the first node entry on the list, and return the removed node entry.
583 Removes the first node entry from a doubly linked list. It is up to the caller of
584 this function to release the memory used by the first node, if that is required. On
585 exit, the removed node is returned.
587 If Head is NULL, then ASSERT().
588 If Head was not initialized, then ASSERT().
589 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
590 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
593 @param[in, out] Head The list header.
595 @return The first node entry that is removed from the list, NULL if the list is empty.
601 IN OUT LIST_ENTRY
*Head
605 Remove the last node entry on the list and return the removed node entry.
607 Removes the last node entry from a doubly linked list. It is up to the caller of
608 this function to release the memory used by the first node, if that is required. On
609 exit, the removed node is returned.
611 If Head is NULL, then ASSERT().
612 If Head was not initialized, then ASSERT().
613 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
614 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
617 @param[in, out] Head The list head.
619 @return The last node entry that is removed from the list, NULL if the list is empty.
625 IN OUT LIST_ENTRY
*Head
629 Insert a new node entry after a designated node entry of a doubly linked list.
631 Inserts a new node entry designated by NewEntry after the node entry designated by PrevEntry
632 of the doubly linked list.
634 @param[in, out] PrevEntry The entry after which to insert.
635 @param[in, out] NewEntry The new entry to insert.
641 IN OUT LIST_ENTRY
*PrevEntry
,
642 IN OUT LIST_ENTRY
*NewEntry
646 Insert a new node entry before a designated node entry of a doubly linked list.
648 Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry
649 of the doubly linked list.
651 @param[in, out] PostEntry The entry to insert before.
652 @param[in, out] NewEntry The new entry to insert.
657 NetListInsertBefore (
658 IN OUT LIST_ENTRY
*PostEntry
,
659 IN OUT LIST_ENTRY
*NewEntry
664 // Object container: EFI network stack spec defines various kinds of
665 // tokens. The drivers can share code to manage those objects.
679 #define NET_MAP_INCREAMENT 64
682 Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.
684 Initialize the forward and backward links of two head nodes donated by Map->Used
685 and Map->Recycled of two doubly linked lists.
686 Initializes the count of the <Key, Value> pairs in the netmap to zero.
688 If Map is NULL, then ASSERT().
689 If the address of Map->Used is NULL, then ASSERT().
690 If the address of Map->Recycled is NULl, then ASSERT().
692 @param[in, out] Map The netmap to initialize.
702 To clean up the netmap, that is, release allocated memories.
704 Removes all nodes of the Used doubly linked list and frees memory of all related netmap items.
705 Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.
706 The number of the <Key, Value> pairs in the netmap is set to zero.
708 If Map is NULL, then ASSERT().
710 @param[in, out] Map The netmap to clean up.
720 Test whether the netmap is empty and return true if it is.
722 If the number of the <Key, Value> pairs in the netmap is zero, return TRUE.
724 If Map is NULL, then ASSERT().
727 @param[in] Map The net map to test.
729 @return TRUE if the netmap is empty, otherwise FALSE.
739 Return the number of the <Key, Value> pairs in the netmap.
741 @param[in] Map The netmap to get the entry number.
743 @return The entry number in the netmap.
753 Allocate an item to save the <Key, Value> pair to the head of the netmap.
755 Allocate an item to save the <Key, Value> pair and add corresponding node entry
756 to the beginning of the Used doubly linked list. The number of the <Key, Value>
757 pairs in the netmap increase by 1.
759 If Map is NULL, then ASSERT().
761 @param[in, out] Map The netmap to insert into.
762 @param[in] Key The user's key.
763 @param[in] Value The user's value for the key.
765 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
766 @retval EFI_SUCCESS The item is inserted to the head.
774 IN VOID
*Value OPTIONAL
778 Allocate an item to save the <Key, Value> pair to the tail of the netmap.
780 Allocate an item to save the <Key, Value> pair and add corresponding node entry
781 to the tail of the Used doubly linked list. The number of the <Key, Value>
782 pairs in the netmap increase by 1.
784 If Map is NULL, then ASSERT().
786 @param[in, out] Map The netmap to insert into.
787 @param[in] Key The user's key.
788 @param[in] Value The user's value for the key.
790 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
791 @retval EFI_SUCCESS The item is inserted to the tail.
799 IN VOID
*Value OPTIONAL
803 Finds the key in the netmap and returns the point to the item containing the Key.
805 Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every
806 item with the key to search. It returns the point to the item contains the Key if found.
808 If Map is NULL, then ASSERT().
810 @param[in] Map The netmap to search within.
811 @param[in] Key The key to search.
813 @return The point to the item contains the Key, or NULL if Key isn't in the map.
824 Remove the node entry of the item from the netmap and return the key of the removed item.
826 Remove the node entry of the item from the Used doubly linked list of the netmap.
827 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
828 entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL,
829 Value will point to the value of the item. It returns the key of the removed item.
831 If Map is NULL, then ASSERT().
832 If Item is NULL, then ASSERT().
833 if item in not in the netmap, then ASSERT().
835 @param[in, out] Map The netmap to remove the item from.
836 @param[in, out] Item The item to remove.
837 @param[out] Value The variable to receive the value if not NULL.
839 @return The key of the removed item.
846 IN OUT NET_MAP_ITEM
*Item
,
847 OUT VOID
**Value OPTIONAL
851 Remove the first node entry on the netmap and return the key of the removed item.
853 Remove the first node entry from the Used doubly linked list of the netmap.
854 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
855 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
856 parameter Value will point to the value of the item. It returns the key of the removed item.
858 If Map is NULL, then ASSERT().
859 If the Used doubly linked list is empty, then ASSERT().
861 @param[in, out] Map The netmap to remove the head from.
862 @param[out] Value The variable to receive the value if not NULL.
864 @return The key of the item removed.
871 OUT VOID
**Value OPTIONAL
875 Remove the last node entry on the netmap and return the key of the removed item.
877 Remove the last node entry from the Used doubly linked list of the netmap.
878 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
879 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
880 parameter Value will point to the value of the item. It returns the key of the removed item.
882 If Map is NULL, then ASSERT().
883 If the Used doubly linked list is empty, then ASSERT().
885 @param[in, out] Map The netmap to remove the tail from.
886 @param[out] Value The variable to receive the value if not NULL.
888 @return The key of the item removed.
895 OUT VOID
**Value OPTIONAL
900 (EFIAPI
*NET_MAP_CALLBACK
) (
902 IN NET_MAP_ITEM
*Item
,
907 Iterate through the netmap and call CallBack for each item.
909 It will contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
910 from the loop. It returns the CallBack's last return value. This function is
911 delete safe for the current item.
913 If Map is NULL, then ASSERT().
914 If CallBack is NULL, then ASSERT().
916 @param[in] Map The Map to iterate through.
917 @param[in] CallBack The callback function to call for each item.
918 @param[in] Arg The opaque parameter to the callback.
920 @retval EFI_SUCCESS There is no item in the netmap, or CallBack for each item
922 @retval Others It returns the CallBack's last return value.
929 IN NET_MAP_CALLBACK CallBack
,
930 IN VOID
*Arg OPTIONAL
935 // Helper functions to implement driver binding and service binding protocols.
938 Create a child of the service that is identified by ServiceBindingGuid.
940 Get the ServiceBinding Protocol first, then use it to create a child.
942 If ServiceBindingGuid is NULL, then ASSERT().
943 If ChildHandle is NULL, then ASSERT().
945 @param[in] Controller The controller which has the service installed.
946 @param[in] Image The image handle used to open service.
947 @param[in] ServiceBindingGuid The service's Guid.
948 @param[in, out] ChildHandle The handle to receive the created child.
950 @retval EFI_SUCCESS The child was successfully created.
951 @retval Others Failed to create the child.
956 NetLibCreateServiceChild (
957 IN EFI_HANDLE Controller
,
959 IN EFI_GUID
*ServiceBindingGuid
,
960 IN OUT EFI_HANDLE
*ChildHandle
964 Destroy a child of the service that is identified by ServiceBindingGuid.
966 Get the ServiceBinding Protocol first, then use it to destroy a child.
968 If ServiceBindingGuid is NULL, then ASSERT().
970 @param[in] Controller The controller which has the service installed.
971 @param[in] Image The image handle used to open service.
972 @param[in] ServiceBindingGuid The service's Guid.
973 @param[in] ChildHandle The child to destroy.
975 @retval EFI_SUCCESS The child was destroyed.
976 @retval Others Failed to destroy the child.
981 NetLibDestroyServiceChild (
982 IN EFI_HANDLE Controller
,
984 IN EFI_GUID
*ServiceBindingGuid
,
985 IN EFI_HANDLE ChildHandle
989 Get handle with Simple Network Protocol installed on it.
991 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
992 If Simple Network Protocol is already installed on the ServiceHandle, the
993 ServiceHandle will be returned. If SNP is not installed on the ServiceHandle,
994 try to find its parent handle with SNP installed.
996 @param[in] ServiceHandle The handle where network service binding protocols are
998 @param[out] Snp The pointer to store the address of the SNP instance.
999 This is an optional parameter that may be NULL.
1001 @return The SNP handle, or NULL if not found.
1006 NetLibGetSnpHandle (
1007 IN EFI_HANDLE ServiceHandle
,
1008 OUT EFI_SIMPLE_NETWORK_PROTOCOL
**Snp OPTIONAL
1012 Retrieve VLAN ID of a VLAN device handle.
1014 Search VLAN device path node in Device Path of specified ServiceHandle and
1015 return its VLAN ID. If no VLAN device path node found, then this ServiceHandle
1016 is not a VLAN device handle, and 0 will be returned.
1018 @param[in] ServiceHandle The handle where network service binding protocols are
1021 @return VLAN ID of the device handle, or 0 if not a VLAN device.
1027 IN EFI_HANDLE ServiceHandle
1031 Find VLAN device handle with specified VLAN ID.
1033 The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle.
1034 This function will append VLAN device path node to the parent device path,
1035 and then use LocateDevicePath() to find the correct VLAN device handle.
1037 @param[in] ControllerHandle The handle where network service binding protocols are
1039 @param[in] VlanId The configured VLAN ID for the VLAN device.
1041 @return The VLAN device handle, or NULL if not found.
1046 NetLibGetVlanHandle (
1047 IN EFI_HANDLE ControllerHandle
,
1052 Get MAC address associated with the network service handle.
1054 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
1055 If SNP is installed on the ServiceHandle or its parent handle, MAC address will
1056 be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.
1058 @param[in] ServiceHandle The handle where network service binding protocols are
1060 @param[out] MacAddress The pointer to store the returned MAC address.
1061 @param[out] AddressSize The length of returned MAC address.
1063 @retval EFI_SUCCESS MAC address was returned successfully.
1064 @retval Others Failed to get SNP mode data.
1069 NetLibGetMacAddress (
1070 IN EFI_HANDLE ServiceHandle
,
1071 OUT EFI_MAC_ADDRESS
*MacAddress
,
1072 OUT UINTN
*AddressSize
1076 Convert MAC address of the NIC associated with specified Service Binding Handle
1077 to a unicode string. Callers are responsible for freeing the string storage.
1079 Locate simple network protocol associated with the Service Binding Handle and
1080 get the mac address from SNP. Then convert the mac address into a unicode
1081 string. It takes 2 unicode characters to represent a 1 byte binary buffer.
1082 Plus one unicode character for the null-terminator.
1084 @param[in] ServiceHandle The handle where network service binding protocol is
1086 @param[in] ImageHandle The image handle used to act as the agent handle to
1087 get the simple network protocol.
1088 @param[out] MacString The pointer to store the address of the string
1089 representation of the mac address.
1091 @retval EFI_SUCCESS Converted the mac address a unicode string successfully.
1092 @retval EFI_OUT_OF_RESOURCES There are not enough memory resources.
1093 @retval Others Failed to open the simple network protocol.
1098 NetLibGetMacString (
1099 IN EFI_HANDLE ServiceHandle
,
1100 IN EFI_HANDLE ImageHandle
,
1101 OUT CHAR16
**MacString
1105 Detect media status for specified network device.
1107 The underlying UNDI driver may or may not support reporting media status from
1108 GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine
1109 will try to invoke Snp->GetStatus() to get the media status. If media is already
1110 present, it returns directly. If media is not present, it will stop SNP and then
1111 restart SNP to get the latest media status. This provides an opportunity to get
1112 the correct media status for old UNDI driver, which doesn't support reporting
1113 media status from GET_STATUS command.
1114 Note: there are two limitations for the current algorithm:
1115 1) For UNDI with this capability, when the cable is not attached, there will
1116 be an redundant Stop/Start() process.
1117 2) for UNDI without this capability, in case that network cable is attached when
1118 Snp->Initialize() is invoked while network cable is unattached later,
1119 NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer
1120 apps to wait for timeout time.
1122 @param[in] ServiceHandle The handle where network service binding protocols are
1124 @param[out] MediaPresent The pointer to store the media status.
1126 @retval EFI_SUCCESS Media detection success.
1127 @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle.
1128 @retval EFI_UNSUPPORTED The network device does not support media detection.
1129 @retval EFI_DEVICE_ERROR SNP is in an unknown state.
1135 IN EFI_HANDLE ServiceHandle
,
1136 OUT BOOLEAN
*MediaPresent
1140 Create an IPv4 device path node.
1142 The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.
1143 The header subtype of IPv4 device path node is MSG_IPv4_DP.
1144 The length of the IPv4 device path node in bytes is 19.
1145 Get other information from parameters to make up the whole IPv4 device path node.
1147 @param[in, out] Node The pointer to the IPv4 device path node.
1148 @param[in] Controller The controller handle.
1149 @param[in] LocalIp The local IPv4 address.
1150 @param[in] LocalPort The local port.
1151 @param[in] RemoteIp The remote IPv4 address.
1152 @param[in] RemotePort The remote port.
1153 @param[in] Protocol The protocol type in the IP header.
1154 @param[in] UseDefaultAddress Whether this instance is using default address or not.
1159 NetLibCreateIPv4DPathNode (
1160 IN OUT IPv4_DEVICE_PATH
*Node
,
1161 IN EFI_HANDLE Controller
,
1162 IN IP4_ADDR LocalIp
,
1163 IN UINT16 LocalPort
,
1164 IN IP4_ADDR RemoteIp
,
1165 IN UINT16 RemotePort
,
1167 IN BOOLEAN UseDefaultAddress
1171 Create an IPv6 device path node.
1173 The header type of IPv6 device path node is MESSAGING_DEVICE_PATH.
1174 The header subtype of IPv6 device path node is MSG_IPv6_DP.
1175 The length of the IPv6 device path node in bytes is 43.
1176 Get other information from parameters to make up the whole IPv6 device path node.
1178 @param[in, out] Node The pointer to the IPv6 device path node.
1179 @param[in] Controller The controller handle.
1180 @param[in] LocalIp The local IPv6 address.
1181 @param[in] LocalPort The local port.
1182 @param[in] RemoteIp The remote IPv6 address.
1183 @param[in] RemotePort The remote port.
1184 @param[in] Protocol The protocol type in the IP header.
1189 NetLibCreateIPv6DPathNode (
1190 IN OUT IPv6_DEVICE_PATH
*Node
,
1191 IN EFI_HANDLE Controller
,
1192 IN EFI_IPv6_ADDRESS
*LocalIp
,
1193 IN UINT16 LocalPort
,
1194 IN EFI_IPv6_ADDRESS
*RemoteIp
,
1195 IN UINT16 RemotePort
,
1201 Find the UNDI/SNP handle from controller and protocol GUID.
1203 For example, IP will open an MNP child to transmit/receive
1204 packets. When MNP is stopped, IP should also be stopped. IP
1205 needs to find its own private data that is related the IP's
1206 service binding instance that is installed on the UNDI/SNP handle.
1207 The controller is then either an MNP or an ARP child handle. Note that
1208 IP opens these handles using BY_DRIVER. Use that infomation to get the
1211 @param[in] Controller The protocol handle to check.
1212 @param[in] ProtocolGuid The protocol that is related with the handle.
1214 @return The UNDI/SNP handle or NULL for errors.
1219 NetLibGetNicHandle (
1220 IN EFI_HANDLE Controller
,
1221 IN EFI_GUID
*ProtocolGuid
1225 This is the default unload handle for all the network drivers.
1227 Disconnect the driver specified by ImageHandle from all the devices in the handle database.
1228 Uninstall all the protocols installed in the driver entry point.
1230 @param[in] ImageHandle The drivers' driver image.
1232 @retval EFI_SUCCESS The image is unloaded.
1233 @retval Others Failed to unload the image.
1238 NetLibDefaultUnload (
1239 IN EFI_HANDLE ImageHandle
1243 Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.
1245 @param[in] String The pointer to the Ascii string.
1246 @param[out] Ip4Address The pointer to the converted IPv4 address.
1248 @retval EFI_SUCCESS Converted to an IPv4 address successfully.
1249 @retval EFI_INVALID_PARAMETER The string is malformated, or Ip4Address is NULL.
1254 NetLibAsciiStrToIp4 (
1255 IN CONST CHAR8
*String
,
1256 OUT EFI_IPv4_ADDRESS
*Ip4Address
1260 Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the
1261 string is defined in RFC 4291 - Text Pepresentation of Addresses.
1263 @param[in] String The pointer to the Ascii string.
1264 @param[out] Ip6Address The pointer to the converted IPv6 address.
1266 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1267 @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.
1272 NetLibAsciiStrToIp6 (
1273 IN CONST CHAR8
*String
,
1274 OUT EFI_IPv6_ADDRESS
*Ip6Address
1278 Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.
1280 @param[in] String The pointer to the Ascii string.
1281 @param[out] Ip4Address The pointer to the converted IPv4 address.
1283 @retval EFI_SUCCESS Converted to an IPv4 address successfully.
1284 @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.
1285 @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to lack of resources.
1291 IN CONST CHAR16
*String
,
1292 OUT EFI_IPv4_ADDRESS
*Ip4Address
1296 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of
1297 the string is defined in RFC 4291 - Text Pepresentation of Addresses.
1299 @param[in] String The pointer to the Ascii string.
1300 @param[out] Ip6Address The pointer to the converted IPv6 address.
1302 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1303 @retval EFI_INVALID_PARAMETER The string is malformated or Ip6Address is NULL.
1304 @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.
1310 IN CONST CHAR16
*String
,
1311 OUT EFI_IPv6_ADDRESS
*Ip6Address
1315 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.
1316 The format of the string is defined in RFC 4291 - Text Pepresentation of Addresses
1317 Prefixes: ipv6-address/prefix-length.
1319 @param[in] String The pointer to the Ascii string.
1320 @param[out] Ip6Address The pointer to the converted IPv6 address.
1321 @param[out] PrefixLength The pointer to the converted prefix length.
1323 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1324 @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.
1325 @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.
1330 NetLibStrToIp6andPrefix (
1331 IN CONST CHAR16
*String
,
1332 OUT EFI_IPv6_ADDRESS
*Ip6Address
,
1333 OUT UINT8
*PrefixLength
1337 // Various signatures
1339 #define NET_BUF_SIGNATURE SIGNATURE_32 ('n', 'b', 'u', 'f')
1340 #define NET_VECTOR_SIGNATURE SIGNATURE_32 ('n', 'v', 'e', 'c')
1341 #define NET_QUE_SIGNATURE SIGNATURE_32 ('n', 'b', 'q', 'u')
1344 #define NET_PROTO_DATA 64 // Opaque buffer for protocols
1345 #define NET_BUF_HEAD 1 // Trim or allocate space from head
1346 #define NET_BUF_TAIL 0 // Trim or allocate space from tail
1347 #define NET_VECTOR_OWN_FIRST 0x01 // We allocated the 1st block in the vector
1349 #define NET_CHECK_SIGNATURE(PData, SIGNATURE) \
1350 ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE)))
1353 // Single memory block in the vector.
1356 UINT32 Len
; // The block's length
1357 UINT8
*Bulk
; // The block's Data
1360 typedef VOID (EFIAPI
*NET_VECTOR_EXT_FREE
) (VOID
*Arg
);
1363 //NET_VECTOR contains several blocks to hold all packet's
1364 //fragments and other house-keeping stuff for sharing. It
1365 //doesn't specify the where actual packet fragment begins.
1369 INTN RefCnt
; // Reference count to share NET_VECTOR.
1370 NET_VECTOR_EXT_FREE Free
; // external function to free NET_VECTOR
1371 VOID
*Arg
; // opeque argument to Free
1372 UINT32 Flag
; // Flags, NET_VECTOR_OWN_FIRST
1373 UINT32 Len
; // Total length of the assocated BLOCKs
1380 //NET_BLOCK_OP operates on the NET_BLOCK. It specifies
1381 //where the actual fragment begins and ends
1384 UINT8
*BlockHead
; // Block's head, or the smallest valid Head
1385 UINT8
*BlockTail
; // Block's tail. BlockTail-BlockHead=block length
1386 UINT8
*Head
; // 1st byte of the data in the block
1387 UINT8
*Tail
; // Tail of the data in the block, Tail-Head=Size
1388 UINT32 Size
; // The size of the data
1393 EFI_IP6_HEADER
*Ip6
;
1397 //NET_BUF is the buffer manage structure used by the
1398 //network stack. Every network packet may be fragmented. The Vector points to
1399 //memory blocks used by each fragment, and BlockOp
1400 //specifies where each fragment begins and ends.
1402 //It also contains an opaque area for the protocol to store
1403 //per-packet information. Protocol must be careful not
1404 //to overwrite the members after that.
1409 LIST_ENTRY List
; // The List this NET_BUF is on
1411 NET_IP_HEAD Ip
; // Network layer header, for fast access
1412 TCP_HEAD
*Tcp
; // Transport layer header, for fast access
1413 EFI_UDP_HEADER
*Udp
; // User Datagram Protocol header
1414 UINT8 ProtoData
[NET_PROTO_DATA
]; //Protocol specific data
1416 NET_VECTOR
*Vector
; // The vector containing the packet
1418 UINT32 BlockOpNum
; // Total number of BlockOp in the buffer
1419 UINT32 TotalSize
; // Total size of the actual packet
1420 NET_BLOCK_OP BlockOp
[1]; // Specify the position of actual packet
1424 //A queue of NET_BUFs. It is a thin extension of
1425 //NET_BUF functions.
1430 LIST_ENTRY List
; // The List this buffer queue is on
1432 LIST_ENTRY BufList
; // list of queued buffers
1433 UINT32 BufSize
; // total length of DATA in the buffers
1434 UINT32 BufNum
; // total number of buffers on the chain
1438 // Pseudo header for TCP and UDP checksum
1450 EFI_IPv6_ADDRESS SrcIp
;
1451 EFI_IPv6_ADDRESS DstIp
;
1454 UINT32 NextHeader
:8;
1455 } NET_IP6_PSEUDO_HDR
;
1459 // The fragment entry table used in network interfaces. This is
1460 // the same as NET_BLOCK now. Use two different to distinguish
1461 // the two in case that NET_BLOCK be enhanced later.
1468 #define NET_GET_REF(PData) ((PData)->RefCnt++)
1469 #define NET_PUT_REF(PData) ((PData)->RefCnt--)
1470 #define NETBUF_FROM_PROTODATA(Info) BASE_CR((Info), NET_BUF, ProtoData)
1472 #define NET_BUF_SHARED(Buf) \
1473 (((Buf)->RefCnt > 1) || ((Buf)->Vector->RefCnt > 1))
1475 #define NET_VECTOR_SIZE(BlockNum) \
1476 (sizeof (NET_VECTOR) + ((BlockNum) - 1) * sizeof (NET_BLOCK))
1478 #define NET_BUF_SIZE(BlockOpNum) \
1479 (sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))
1481 #define NET_HEADSPACE(BlockOp) \
1482 (UINTN)((BlockOp)->Head - (BlockOp)->BlockHead)
1484 #define NET_TAILSPACE(BlockOp) \
1485 (UINTN)((BlockOp)->BlockTail - (BlockOp)->Tail)
1488 Allocate a single block NET_BUF. Upon allocation, all the
1489 free space is in the tail room.
1491 @param[in] Len The length of the block.
1493 @return The pointer to the allocated NET_BUF, or NULL if the
1494 allocation failed due to resource limitations.
1504 Free the net buffer and its associated NET_VECTOR.
1506 Decrease the reference count of the net buffer by one. Free the associated net
1507 vector and itself if the reference count of the net buffer is decreased to 0.
1508 The net vector free operation decreases the reference count of the net
1509 vector by one, and performs the resource free operation when the reference count
1510 of the net vector is 0.
1512 @param[in] Nbuf The pointer to the NET_BUF to be freed.
1522 Get the index of NET_BLOCK_OP that contains the byte at Offset in the net
1525 For example, this function can be used to retrieve the IP header in the packet. It
1526 also can be used to get the fragment that contains the byte used
1527 mainly by the library implementation itself.
1529 @param[in] Nbuf The pointer to the net buffer.
1530 @param[in] Offset The offset of the byte.
1531 @param[out] Index Index of the NET_BLOCK_OP that contains the byte at
1534 @return The pointer to the Offset'th byte of data in the net buffer, or NULL
1535 if there is no such data in the net buffer.
1543 OUT UINT32
*Index OPTIONAL
1547 Create a copy of the net buffer that shares the associated net vector.
1549 The reference count of the newly created net buffer is set to 1. The reference
1550 count of the associated net vector is increased by one.
1552 @param[in] Nbuf The pointer to the net buffer to be cloned.
1554 @return The pointer to the cloned net buffer, or NULL if the
1555 allocation failed due to resource limitations.
1565 Create a duplicated copy of the net buffer with data copied and HeadSpace
1566 bytes of head space reserved.
1568 The duplicated net buffer will allocate its own memory to hold the data of the
1571 @param[in] Nbuf The pointer to the net buffer to be duplicated from.
1572 @param[in, out] Duplicate The pointer to the net buffer to duplicate to. If
1573 NULL, a new net buffer is allocated.
1574 @param[in] HeadSpace The length of the head space to reserve.
1576 @return The pointer to the duplicated net buffer, or NULL if
1577 the allocation failed due to resource limitations.
1584 IN OUT NET_BUF
*Duplicate OPTIONAL
,
1589 Create a NET_BUF structure which contains Len byte data of Nbuf starting from
1592 A new NET_BUF structure will be created but the associated data in NET_VECTOR
1593 is shared. This function exists to perform IP packet fragmentation.
1595 @param[in] Nbuf The pointer to the net buffer to be extracted.
1596 @param[in] Offset Starting point of the data to be included in the new
1598 @param[in] Len The bytes of data to be included in the new net buffer.
1599 @param[in] HeadSpace The bytes of the head space to reserve for the protocol header.
1601 @return The pointer to the cloned net buffer, or NULL if the
1602 allocation failed due to resource limitations.
1615 Reserve some space in the header room of the net buffer.
1617 Upon allocation, all the space is in the tail room of the buffer. Call this
1618 function to move space to the header room. This function is quite limited
1619 in that it can only reserve space from the first block of an empty NET_BUF not
1620 built from the external. However, it should be enough for the network stack.
1622 @param[in, out] Nbuf The pointer to the net buffer.
1623 @param[in] Len The length of buffer to be reserved from the header.
1629 IN OUT NET_BUF
*Nbuf
,
1634 Allocate Len bytes of space from the header or tail of the buffer.
1636 @param[in, out] Nbuf The pointer to the net buffer.
1637 @param[in] Len The length of the buffer to be allocated.
1638 @param[in] FromHead The flag to indicate whether to reserve the data
1639 from head (TRUE) or tail (FALSE).
1641 @return The pointer to the first byte of the allocated buffer,
1642 or NULL, if there is no sufficient space.
1648 IN OUT NET_BUF
*Nbuf
,
1654 Trim Len bytes from the header or the tail of the net buffer.
1656 @param[in, out] Nbuf The pointer to the net buffer.
1657 @param[in] Len The length of the data to be trimmed.
1658 @param[in] FromHead The flag to indicate whether trim data is from the
1659 head (TRUE) or the tail (FALSE).
1661 @return The length of the actual trimmed data, which may be less
1662 than Len if the TotalSize of Nbuf is less than Len.
1668 IN OUT NET_BUF
*Nbuf
,
1674 Copy Len bytes of data from the specific offset of the net buffer to the
1677 The Len bytes of data may cross several fragments of the net buffer.
1679 @param[in] Nbuf The pointer to the net buffer.
1680 @param[in] Offset The sequence number of the first byte to copy.
1681 @param[in] Len The length of the data to copy.
1682 @param[in] Dest The destination of the data to copy to.
1684 @return The length of the actual copied data, or 0 if the offset
1685 specified exceeds the total size of net buffer.
1698 Build a NET_BUF from external blocks.
1700 A new NET_BUF structure will be created from external blocks. An additional block
1701 of memory will be allocated to hold reserved HeadSpace bytes of header room
1702 and existing HeadLen bytes of header, but the external blocks are shared by the
1703 net buffer to avoid data copying.
1705 @param[in] ExtFragment The pointer to the data block.
1706 @param[in] ExtNum The number of the data blocks.
1707 @param[in] HeadSpace The head space to be reserved.
1708 @param[in] HeadLen The length of the protocol header. The function
1709 pulls this amount of data into a linear block.
1710 @param[in] ExtFree The pointer to the caller-provided free function.
1711 @param[in] Arg The argument passed to ExtFree when ExtFree is
1714 @return The pointer to the net buffer built from the data blocks,
1715 or NULL if the allocation failed due to resource
1722 IN NET_FRAGMENT
*ExtFragment
,
1724 IN UINT32 HeadSpace
,
1726 IN NET_VECTOR_EXT_FREE ExtFree
,
1727 IN VOID
*Arg OPTIONAL
1731 Build a fragment table to contain the fragments in the net buffer. This is the
1732 opposite operation of the NetbufFromExt.
1734 @param[in] Nbuf Points to the net buffer.
1735 @param[in, out] ExtFragment The pointer to the data block.
1736 @param[in, out] ExtNum The number of the data blocks.
1738 @retval EFI_BUFFER_TOO_SMALL The number of non-empty blocks is bigger than
1740 @retval EFI_SUCCESS The fragment table was built successfully.
1747 IN OUT NET_FRAGMENT
*ExtFragment
,
1748 IN OUT UINT32
*ExtNum
1752 Build a net buffer from a list of net buffers.
1754 All the fragments will be collected from the list of NEW_BUF, and then a new
1755 net buffer will be created through NetbufFromExt.
1757 @param[in] BufList A List of the net buffer.
1758 @param[in] HeadSpace The head space to be reserved.
1759 @param[in] HeaderLen The length of the protocol header. The function
1760 pulls this amount of data into a linear block.
1761 @param[in] ExtFree The pointer to the caller provided free function.
1762 @param[in] Arg The argument passed to ExtFree when ExtFree is called.
1764 @return The pointer to the net buffer built from the list of net
1771 IN LIST_ENTRY
*BufList
,
1772 IN UINT32 HeadSpace
,
1773 IN UINT32 HeaderLen
,
1774 IN NET_VECTOR_EXT_FREE ExtFree
,
1775 IN VOID
*Arg OPTIONAL
1779 Free a list of net buffers.
1781 @param[in, out] Head The pointer to the head of linked net buffers.
1787 IN OUT LIST_ENTRY
*Head
1791 Initiate the net buffer queue.
1793 @param[in, out] NbufQue The pointer to the net buffer queue to be initialized.
1799 IN OUT NET_BUF_QUEUE
*NbufQue
1803 Allocate and initialize a net buffer queue.
1805 @return The pointer to the allocated net buffer queue, or NULL if the
1806 allocation failed due to resource limit.
1816 Free a net buffer queue.
1818 Decrease the reference count of the net buffer queue by one. The real resource
1819 free operation isn't performed until the reference count of the net buffer
1820 queue is decreased to 0.
1822 @param[in] NbufQue The pointer to the net buffer queue to be freed.
1828 IN NET_BUF_QUEUE
*NbufQue
1832 Remove a net buffer from the head in the specific queue and return it.
1834 @param[in, out] NbufQue The pointer to the net buffer queue.
1836 @return The pointer to the net buffer removed from the specific queue,
1837 or NULL if there is no net buffer in the specific queue.
1843 IN OUT NET_BUF_QUEUE
*NbufQue
1847 Append a net buffer to the net buffer queue.
1849 @param[in, out] NbufQue The pointer to the net buffer queue.
1850 @param[in, out] Nbuf The pointer to the net buffer to be appended.
1856 IN OUT NET_BUF_QUEUE
*NbufQue
,
1857 IN OUT NET_BUF
*Nbuf
1861 Copy Len bytes of data from the net buffer queue at the specific offset to the
1864 The copying operation is the same as NetbufCopy, but applies to the net buffer
1865 queue instead of the net buffer.
1867 @param[in] NbufQue The pointer to the net buffer queue.
1868 @param[in] Offset The sequence number of the first byte to copy.
1869 @param[in] Len The length of the data to copy.
1870 @param[out] Dest The destination of the data to copy to.
1872 @return The length of the actual copied data, or 0 if the offset
1873 specified exceeds the total size of net buffer queue.
1879 IN NET_BUF_QUEUE
*NbufQue
,
1886 Trim Len bytes of data from the buffer queue and free any net buffer
1887 that is completely trimmed.
1889 The trimming operation is the same as NetbufTrim but applies to the net buffer
1890 queue instead of the net buffer.
1892 @param[in, out] NbufQue The pointer to the net buffer queue.
1893 @param[in] Len The length of the data to trim.
1895 @return The actual length of the data trimmed.
1901 IN OUT NET_BUF_QUEUE
*NbufQue
,
1907 Flush the net buffer queue.
1909 @param[in, out] NbufQue The pointer to the queue to be flushed.
1915 IN OUT NET_BUF_QUEUE
*NbufQue
1919 Compute the checksum for a bulk of data.
1921 @param[in] Bulk The pointer to the data.
1922 @param[in] Len The length of the data, in bytes.
1924 @return The computed checksum.
1937 @param[in] Checksum1 The first checksum to be added.
1938 @param[in] Checksum2 The second checksum to be added.
1940 @return The new checksum.
1946 IN UINT16 Checksum1
,
1951 Compute the checksum for a NET_BUF.
1953 @param[in] Nbuf The pointer to the net buffer.
1955 @return The computed checksum.
1965 Compute the checksum for TCP/UDP pseudo header.
1967 Src and Dst are in network byte order, and Len is in host byte order.
1969 @param[in] Src The source address of the packet.
1970 @param[in] Dst The destination address of the packet.
1971 @param[in] Proto The protocol type of the packet.
1972 @param[in] Len The length of the packet.
1974 @return The computed checksum.
1979 NetPseudoHeadChecksum (
1987 Compute the checksum for the TCP6/UDP6 pseudo header.
1989 Src and Dst are in network byte order, and Len is in host byte order.
1991 @param[in] Src The source address of the packet.
1992 @param[in] Dst The destination address of the packet.
1993 @param[in] NextHeader The protocol type of the packet.
1994 @param[in] Len The length of the packet.
1996 @return The computed checksum.
2001 NetIp6PseudoHeadChecksum (
2002 IN EFI_IPv6_ADDRESS
*Src
,
2003 IN EFI_IPv6_ADDRESS
*Dst
,
2004 IN UINT8 NextHeader
,
2009 The function frees the net buffer which allocated by the IP protocol. It releases
2010 only the net buffer and doesn't call the external free function.
2012 This function should be called after finishing the process of mIpSec->ProcessExt()
2013 for outbound traffic. The (EFI_IPSEC2_PROTOCOL)->ProcessExt() allocates a new
2014 buffer for the ESP, so there needs a function to free the old net buffer.
2016 @param[in] Nbuf The network buffer to be freed.
2020 NetIpSecNetbufFree (
2025 This function obtains the system guid from the smbios table.
2027 @param[out] SystemGuid The pointer of the returned system guid.
2029 @retval EFI_SUCCESS Successfully obtained the system guid.
2030 @retval EFI_NOT_FOUND Did not find the SMBIOS table.
2035 NetLibGetSystemGuid (
2036 OUT EFI_GUID
*SystemGuid