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 IP4_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv4_ADDRESS)))
216 #define IP6_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv6_ADDRESS)))
217 #define IP6_COPY_LINK_ADDRESS(Mac1, Mac2) (CopyMem ((Mac1), (Mac2), sizeof (EFI_MAC_ADDRESS)))
220 // The debug level definition. This value is also used as the
221 // syslog's servity level. Don't change it.
223 #define NETDEBUG_LEVEL_TRACE 5
224 #define NETDEBUG_LEVEL_WARNING 4
225 #define NETDEBUG_LEVEL_ERROR 3
228 // Network debug message is sent out as syslog packet.
230 #define NET_SYSLOG_FACILITY 16 // Syslog local facility local use
231 #define NET_SYSLOG_PACKET_LEN 512
232 #define NET_SYSLOG_TX_TIMEOUT (500 * 1000 * 10) // 500ms
233 #define NET_DEBUG_MSG_LEN 470 // 512 - (ether+ip4+udp4 head length)
236 // The debug output expects the ASCII format string, Use %a to print ASCII
237 // string, and %s to print UNICODE string. PrintArg must be enclosed in ().
238 // For example: NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name));
240 #define NET_DEBUG_TRACE(Module, PrintArg) \
242 NETDEBUG_LEVEL_TRACE, \
246 NetDebugASPrint PrintArg \
249 #define NET_DEBUG_WARNING(Module, PrintArg) \
251 NETDEBUG_LEVEL_WARNING, \
255 NetDebugASPrint PrintArg \
258 #define NET_DEBUG_ERROR(Module, PrintArg) \
260 NETDEBUG_LEVEL_ERROR, \
264 NetDebugASPrint PrintArg \
268 Allocate a buffer, then format the message to it. This is a
269 help function for the NET_DEBUG_XXX macros. The PrintArg of
270 these macros treats the variable length print parameters as a
271 single parameter, and pass it to the NetDebugASPrint. For
272 example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name))
276 NETDEBUG_LEVEL_TRACE,
280 NetDebugASPrint ("State transit to %a\n", Name)
283 @param Format The ASCII format string.
284 @param ... The variable length parameter whose format is determined
285 by the Format string.
287 @return The buffer containing the formatted message,
288 or NULL if memory allocation failed.
299 Builds an UDP4 syslog packet and send it using SNP.
301 This function will locate a instance of SNP then send the message through it.
302 Because it isn't open the SNP BY_DRIVER, apply caution when using it.
304 @param Level The servity level of the message.
305 @param Module The Moudle that generates the log.
306 @param File The file that contains the log.
307 @param Line The exact line that contains the log.
308 @param Message The user message to log.
310 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
311 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet
312 @retval EFI_SUCCESS The log is discard because that it is more verbose
313 than the mNetDebugLevelMax. Or, it has been sent out.
327 Return the length of the mask.
329 Return the length of the mask. Valid values are 0 to 32.
330 If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM.
331 NetMask is in the host byte order.
333 @param[in] NetMask The netmask to get the length from.
335 @return The length of the netmask, or IP4_MASK_NUM (33) if the mask is invalid.
345 Return the class of the IP address, such as class A, B, C.
346 Addr is in host byte order.
348 The address of class A starts with 0.
349 If the address belong to class A, return IP4_ADDR_CLASSA.
350 The address of class B starts with 10.
351 If the address belong to class B, return IP4_ADDR_CLASSB.
352 The address of class C starts with 110.
353 If the address belong to class C, return IP4_ADDR_CLASSC.
354 The address of class D starts with 1110.
355 If the address belong to class D, return IP4_ADDR_CLASSD.
356 The address of class E starts with 1111.
357 If the address belong to class E, return IP4_ADDR_CLASSE.
360 @param[in] Addr The address to get the class from.
362 @return IP address class, such as IP4_ADDR_CLASSA.
372 Check whether the IP is a valid unicast address according to
373 the netmask. If NetMask is zero, use the IP address's class to get the default mask.
375 If Ip is 0, IP is not a valid unicast address.
376 Class D address is used for multicasting and class E address is reserved for future. If Ip
377 belongs to class D or class E, Ip is not a valid unicast address.
378 If all bits of the host address of Ip are 0 or 1, Ip is not a valid unicast address.
380 @param[in] Ip The IP to check against.
381 @param[in] NetMask The mask of the IP.
383 @return TRUE if Ip is a valid unicast address on the network, otherwise FALSE.
394 Check whether the incoming IPv6 address is a valid unicast address.
396 If the address is a multicast address has binary 0xFF at the start, it is not
397 a valid unicast address. If the address is unspecified ::, it is not a valid
398 unicast address to be assigned to any node. If the address is loopback address
399 ::1, it is also not a valid unicast address to be assigned to any physical
402 @param[in] Ip6 The IPv6 address to check against.
404 @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE.
409 NetIp6IsValidUnicast (
410 IN EFI_IPv6_ADDRESS
*Ip6
415 Check whether the incoming Ipv6 address is the unspecified address or not.
417 @param[in] Ip6 - Ip6 address, in network order.
419 @retval TRUE - Yes, incoming Ipv6 address is the unspecified address.
420 @retval FALSE - The incoming Ipv6 address is not the unspecified address
425 NetIp6IsUnspecifiedAddr (
426 IN EFI_IPv6_ADDRESS
*Ip6
430 Check whether the incoming Ipv6 address is a link-local address.
432 @param[in] Ip6 - Ip6 address, in network order.
434 @retval TRUE - The incoming Ipv6 address is a link-local address.
435 @retval FALSE - The incoming Ipv6 address is not a link-local address.
440 NetIp6IsLinkLocalAddr (
441 IN EFI_IPv6_ADDRESS
*Ip6
445 Check whether the Ipv6 address1 and address2 are on the connected network.
447 @param[in] Ip1 - Ip6 address1, in network order.
448 @param[in] Ip2 - Ip6 address2, in network order.
449 @param[in] PrefixLength - The prefix length of the checking net.
451 @retval TRUE - Yes, the Ipv6 address1 and address2 are connected.
452 @retval FALSE - No the Ipv6 address1 and address2 are not connected.
458 EFI_IPv6_ADDRESS
*Ip1
,
459 EFI_IPv6_ADDRESS
*Ip2
,
464 Switches the endianess of an IPv6 address.
466 This function swaps the bytes in a 128-bit IPv6 address to switch the value
467 from little endian to big endian or vice versa. The byte swapped value is
470 @param Ip6 Points to an IPv6 address.
472 @return The byte swapped IPv6 address.
478 EFI_IPv6_ADDRESS
*Ip6
481 extern IP4_ADDR gIp4AllMasks
[IP4_MASK_NUM
];
484 extern EFI_IPv4_ADDRESS mZeroIp4Addr
;
486 #define NET_IS_DIGIT(Ch) (('0' <= (Ch)) && ((Ch) <= '9'))
487 #define NET_ROUNDUP(size, unit) (((size) + (unit) - 1) & (~((unit) - 1)))
488 #define NET_IS_LOWER_CASE_CHAR(Ch) (('a' <= (Ch)) && ((Ch) <= 'z'))
489 #define NET_IS_UPPER_CASE_CHAR(Ch) (('A' <= (Ch)) && ((Ch) <= 'Z'))
491 #define TICKS_PER_MS 10000U
492 #define TICKS_PER_SECOND 10000000U
494 #define NET_RANDOM(Seed) ((UINT32) ((UINT32) (Seed) * 1103515245UL + 12345) % 4294967295UL)
497 Extract a UINT32 from a byte stream.
499 This function copies a UINT32 from a byte stream, and then converts it from Network
500 byte order to host byte order. Use this function to avoid alignment error.
502 @param[in] Buf The buffer to extract the UINT32.
504 @return The UINT32 extracted.
514 Puts a UINT32 into the byte stream in network byte order.
516 Converts a UINT32 from host byte order to network byte order, then copies it to the
519 @param[in, out] Buf The buffer in which to put the UINT32.
520 @param[in] Data The data to be converted and put into the byte stream.
531 Initialize a random seed using current time.
533 Get current time first. Then initialize a random seed based on some basic
534 mathematical operations on the hour, day, minute, second, nanosecond and year
537 @return The random seed, initialized with current time.
547 #define NET_LIST_USER_STRUCT(Entry, Type, Field) \
548 BASE_CR(Entry, Type, Field)
550 #define NET_LIST_USER_STRUCT_S(Entry, Type, Field, Sig) \
551 CR(Entry, Type, Field, Sig)
554 // Iterate through the double linked list. It is NOT delete safe
556 #define NET_LIST_FOR_EACH(Entry, ListHead) \
557 for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)
560 // Iterate through the double linked list. This is delete-safe.
561 // Don't touch NextEntry. Also, don't use this macro if list
562 // entries other than the Entry may be deleted when processing
563 // the current Entry.
565 #define NET_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead) \
566 for(Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink; \
567 Entry != (ListHead); \
568 Entry = NextEntry, NextEntry = Entry->ForwardLink \
572 // Make sure the list isn't empty before getting the first/last record.
574 #define NET_LIST_HEAD(ListHead, Type, Field) \
575 NET_LIST_USER_STRUCT((ListHead)->ForwardLink, Type, Field)
577 #define NET_LIST_TAIL(ListHead, Type, Field) \
578 NET_LIST_USER_STRUCT((ListHead)->BackLink, Type, Field)
582 Remove the first node entry on the list, and return the removed node entry.
584 Removes the first node entry from a doubly linked list. It is up to the caller of
585 this function to release the memory used by the first node, if that is required. On
586 exit, the removed node is returned.
588 If Head is NULL, then ASSERT().
589 If Head was not initialized, then ASSERT().
590 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
591 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
594 @param[in, out] Head The list header.
596 @return The first node entry that is removed from the list, NULL if the list is empty.
602 IN OUT LIST_ENTRY
*Head
606 Remove the last node entry on the list and return the removed node entry.
608 Removes the last node entry from a doubly linked list. It is up to the caller of
609 this function to release the memory used by the first node, if that is required. On
610 exit, the removed node is returned.
612 If Head is NULL, then ASSERT().
613 If Head was not initialized, then ASSERT().
614 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
615 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
618 @param[in, out] Head The list head.
620 @return The last node entry that is removed from the list, NULL if the list is empty.
626 IN OUT LIST_ENTRY
*Head
630 Insert a new node entry after a designated node entry of a doubly linked list.
632 Inserts a new node entry designated by NewEntry after the node entry designated by PrevEntry
633 of the doubly linked list.
635 @param[in, out] PrevEntry The entry after which to insert.
636 @param[in, out] NewEntry The new entry to insert.
642 IN OUT LIST_ENTRY
*PrevEntry
,
643 IN OUT LIST_ENTRY
*NewEntry
647 Insert a new node entry before a designated node entry of a doubly linked list.
649 Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry
650 of the doubly linked list.
652 @param[in, out] PostEntry The entry to insert before.
653 @param[in, out] NewEntry The new entry to insert.
658 NetListInsertBefore (
659 IN OUT LIST_ENTRY
*PostEntry
,
660 IN OUT LIST_ENTRY
*NewEntry
665 // Object container: EFI network stack spec defines various kinds of
666 // tokens. The drivers can share code to manage those objects.
680 #define NET_MAP_INCREAMENT 64
683 Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.
685 Initialize the forward and backward links of two head nodes donated by Map->Used
686 and Map->Recycled of two doubly linked lists.
687 Initializes the count of the <Key, Value> pairs in the netmap to zero.
689 If Map is NULL, then ASSERT().
690 If the address of Map->Used is NULL, then ASSERT().
691 If the address of Map->Recycled is NULl, then ASSERT().
693 @param[in, out] Map The netmap to initialize.
703 To clean up the netmap, that is, release allocated memories.
705 Removes all nodes of the Used doubly linked list and frees memory of all related netmap items.
706 Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.
707 The number of the <Key, Value> pairs in the netmap is set to zero.
709 If Map is NULL, then ASSERT().
711 @param[in, out] Map The netmap to clean up.
721 Test whether the netmap is empty and return true if it is.
723 If the number of the <Key, Value> pairs in the netmap is zero, return TRUE.
725 If Map is NULL, then ASSERT().
728 @param[in] Map The net map to test.
730 @return TRUE if the netmap is empty, otherwise FALSE.
740 Return the number of the <Key, Value> pairs in the netmap.
742 @param[in] Map The netmap to get the entry number.
744 @return The entry number in the netmap.
754 Allocate an item to save the <Key, Value> pair to the head of the netmap.
756 Allocate an item to save the <Key, Value> pair and add corresponding node entry
757 to the beginning of the Used doubly linked list. The number of the <Key, Value>
758 pairs in the netmap increase by 1.
760 If Map is NULL, then ASSERT().
762 @param[in, out] Map The netmap to insert into.
763 @param[in] Key The user's key.
764 @param[in] Value The user's value for the key.
766 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
767 @retval EFI_SUCCESS The item is inserted to the head.
775 IN VOID
*Value OPTIONAL
779 Allocate an item to save the <Key, Value> pair to the tail of the netmap.
781 Allocate an item to save the <Key, Value> pair and add corresponding node entry
782 to the tail of the Used doubly linked list. The number of the <Key, Value>
783 pairs in the netmap increase by 1.
785 If Map is NULL, then ASSERT().
787 @param[in, out] Map The netmap to insert into.
788 @param[in] Key The user's key.
789 @param[in] Value The user's value for the key.
791 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
792 @retval EFI_SUCCESS The item is inserted to the tail.
800 IN VOID
*Value OPTIONAL
804 Finds the key in the netmap and returns the point to the item containing the Key.
806 Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every
807 item with the key to search. It returns the point to the item contains the Key if found.
809 If Map is NULL, then ASSERT().
811 @param[in] Map The netmap to search within.
812 @param[in] Key The key to search.
814 @return The point to the item contains the Key, or NULL if Key isn't in the map.
825 Remove the node entry of the item from the netmap and return the key of the removed item.
827 Remove the node entry of the item from the Used doubly linked list of the netmap.
828 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
829 entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL,
830 Value will point to the value of the item. It returns the key of the removed item.
832 If Map is NULL, then ASSERT().
833 If Item is NULL, then ASSERT().
834 if item in not in the netmap, then ASSERT().
836 @param[in, out] Map The netmap to remove the item from.
837 @param[in, out] Item The item to remove.
838 @param[out] Value The variable to receive the value if not NULL.
840 @return The key of the removed item.
847 IN OUT NET_MAP_ITEM
*Item
,
848 OUT VOID
**Value OPTIONAL
852 Remove the first node entry on the netmap and return the key of the removed item.
854 Remove the first node entry from the Used doubly linked list of the netmap.
855 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
856 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
857 parameter Value will point to the value of the item. It returns the key of the removed item.
859 If Map is NULL, then ASSERT().
860 If the Used doubly linked list is empty, then ASSERT().
862 @param[in, out] Map The netmap to remove the head from.
863 @param[out] Value The variable to receive the value if not NULL.
865 @return The key of the item removed.
872 OUT VOID
**Value OPTIONAL
876 Remove the last node entry on the netmap and return the key of the removed item.
878 Remove the last node entry from the Used doubly linked list of the netmap.
879 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
880 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
881 parameter Value will point to the value of the item. It returns the key of the removed item.
883 If Map is NULL, then ASSERT().
884 If the Used doubly linked list is empty, then ASSERT().
886 @param[in, out] Map The netmap to remove the tail from.
887 @param[out] Value The variable to receive the value if not NULL.
889 @return The key of the item removed.
896 OUT VOID
**Value OPTIONAL
901 (EFIAPI
*NET_MAP_CALLBACK
) (
903 IN NET_MAP_ITEM
*Item
,
908 Iterate through the netmap and call CallBack for each item.
910 It will contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
911 from the loop. It returns the CallBack's last return value. This function is
912 delete safe for the current item.
914 If Map is NULL, then ASSERT().
915 If CallBack is NULL, then ASSERT().
917 @param[in] Map The Map to iterate through.
918 @param[in] CallBack The callback function to call for each item.
919 @param[in] Arg The opaque parameter to the callback.
921 @retval EFI_SUCCESS There is no item in the netmap, or CallBack for each item
923 @retval Others It returns the CallBack's last return value.
930 IN NET_MAP_CALLBACK CallBack
,
931 IN VOID
*Arg OPTIONAL
936 // Helper functions to implement driver binding and service binding protocols.
939 Create a child of the service that is identified by ServiceBindingGuid.
941 Get the ServiceBinding Protocol first, then use it to create a child.
943 If ServiceBindingGuid is NULL, then ASSERT().
944 If ChildHandle is NULL, then ASSERT().
946 @param[in] Controller The controller which has the service installed.
947 @param[in] Image The image handle used to open service.
948 @param[in] ServiceBindingGuid The service's Guid.
949 @param[in, out] ChildHandle The handle to receive the created child.
951 @retval EFI_SUCCESS The child was successfully created.
952 @retval Others Failed to create the child.
957 NetLibCreateServiceChild (
958 IN EFI_HANDLE Controller
,
960 IN EFI_GUID
*ServiceBindingGuid
,
961 IN OUT EFI_HANDLE
*ChildHandle
965 Destroy a child of the service that is identified by ServiceBindingGuid.
967 Get the ServiceBinding Protocol first, then use it to destroy a child.
969 If ServiceBindingGuid is NULL, then ASSERT().
971 @param[in] Controller The controller which has the service installed.
972 @param[in] Image The image handle used to open service.
973 @param[in] ServiceBindingGuid The service's Guid.
974 @param[in] ChildHandle The child to destroy.
976 @retval EFI_SUCCESS The child was destroyed.
977 @retval Others Failed to destroy the child.
982 NetLibDestroyServiceChild (
983 IN EFI_HANDLE Controller
,
985 IN EFI_GUID
*ServiceBindingGuid
,
986 IN EFI_HANDLE ChildHandle
990 Get handle with Simple Network Protocol installed on it.
992 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
993 If Simple Network Protocol is already installed on the ServiceHandle, the
994 ServiceHandle will be returned. If SNP is not installed on the ServiceHandle,
995 try to find its parent handle with SNP installed.
997 @param[in] ServiceHandle The handle where network service binding protocols are
999 @param[out] Snp The pointer to store the address of the SNP instance.
1000 This is an optional parameter that may be NULL.
1002 @return The SNP handle, or NULL if not found.
1007 NetLibGetSnpHandle (
1008 IN EFI_HANDLE ServiceHandle
,
1009 OUT EFI_SIMPLE_NETWORK_PROTOCOL
**Snp OPTIONAL
1013 Retrieve VLAN ID of a VLAN device handle.
1015 Search VLAN device path node in Device Path of specified ServiceHandle and
1016 return its VLAN ID. If no VLAN device path node found, then this ServiceHandle
1017 is not a VLAN device handle, and 0 will be returned.
1019 @param[in] ServiceHandle The handle where network service binding protocols are
1022 @return VLAN ID of the device handle, or 0 if not a VLAN device.
1028 IN EFI_HANDLE ServiceHandle
1032 Find VLAN device handle with specified VLAN ID.
1034 The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle.
1035 This function will append VLAN device path node to the parent device path,
1036 and then use LocateDevicePath() to find the correct VLAN device handle.
1038 @param[in] ControllerHandle The handle where network service binding protocols are
1040 @param[in] VlanId The configured VLAN ID for the VLAN device.
1042 @return The VLAN device handle, or NULL if not found.
1047 NetLibGetVlanHandle (
1048 IN EFI_HANDLE ControllerHandle
,
1053 Get MAC address associated with the network service handle.
1055 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
1056 If SNP is installed on the ServiceHandle or its parent handle, MAC address will
1057 be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.
1059 @param[in] ServiceHandle The handle where network service binding protocols are
1061 @param[out] MacAddress The pointer to store the returned MAC address.
1062 @param[out] AddressSize The length of returned MAC address.
1064 @retval EFI_SUCCESS MAC address was returned successfully.
1065 @retval Others Failed to get SNP mode data.
1070 NetLibGetMacAddress (
1071 IN EFI_HANDLE ServiceHandle
,
1072 OUT EFI_MAC_ADDRESS
*MacAddress
,
1073 OUT UINTN
*AddressSize
1077 Convert MAC address of the NIC associated with specified Service Binding Handle
1078 to a unicode string. Callers are responsible for freeing the string storage.
1080 Locate simple network protocol associated with the Service Binding Handle and
1081 get the mac address from SNP. Then convert the mac address into a unicode
1082 string. It takes 2 unicode characters to represent a 1 byte binary buffer.
1083 Plus one unicode character for the null-terminator.
1085 @param[in] ServiceHandle The handle where network service binding protocol is
1087 @param[in] ImageHandle The image handle used to act as the agent handle to
1088 get the simple network protocol.
1089 @param[out] MacString The pointer to store the address of the string
1090 representation of the mac address.
1092 @retval EFI_SUCCESS Converted the mac address a unicode string successfully.
1093 @retval EFI_OUT_OF_RESOURCES There are not enough memory resources.
1094 @retval Others Failed to open the simple network protocol.
1099 NetLibGetMacString (
1100 IN EFI_HANDLE ServiceHandle
,
1101 IN EFI_HANDLE ImageHandle
,
1102 OUT CHAR16
**MacString
1106 Detect media status for specified network device.
1108 The underlying UNDI driver may or may not support reporting media status from
1109 GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine
1110 will try to invoke Snp->GetStatus() to get the media status. If media is already
1111 present, it returns directly. If media is not present, it will stop SNP and then
1112 restart SNP to get the latest media status. This provides an opportunity to get
1113 the correct media status for old UNDI driver, which doesn't support reporting
1114 media status from GET_STATUS command.
1115 Note: there are two limitations for the current algorithm:
1116 1) For UNDI with this capability, when the cable is not attached, there will
1117 be an redundant Stop/Start() process.
1118 2) for UNDI without this capability, in case that network cable is attached when
1119 Snp->Initialize() is invoked while network cable is unattached later,
1120 NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer
1121 apps to wait for timeout time.
1123 @param[in] ServiceHandle The handle where network service binding protocols are
1125 @param[out] MediaPresent The pointer to store the media status.
1127 @retval EFI_SUCCESS Media detection success.
1128 @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle.
1129 @retval EFI_UNSUPPORTED The network device does not support media detection.
1130 @retval EFI_DEVICE_ERROR SNP is in an unknown state.
1136 IN EFI_HANDLE ServiceHandle
,
1137 OUT BOOLEAN
*MediaPresent
1141 Create an IPv4 device path node.
1143 The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.
1144 The header subtype of IPv4 device path node is MSG_IPv4_DP.
1145 The length of the IPv4 device path node in bytes is 19.
1146 Get other information from parameters to make up the whole IPv4 device path node.
1148 @param[in, out] Node The pointer to the IPv4 device path node.
1149 @param[in] Controller The controller handle.
1150 @param[in] LocalIp The local IPv4 address.
1151 @param[in] LocalPort The local port.
1152 @param[in] RemoteIp The remote IPv4 address.
1153 @param[in] RemotePort The remote port.
1154 @param[in] Protocol The protocol type in the IP header.
1155 @param[in] UseDefaultAddress Whether this instance is using default address or not.
1160 NetLibCreateIPv4DPathNode (
1161 IN OUT IPv4_DEVICE_PATH
*Node
,
1162 IN EFI_HANDLE Controller
,
1163 IN IP4_ADDR LocalIp
,
1164 IN UINT16 LocalPort
,
1165 IN IP4_ADDR RemoteIp
,
1166 IN UINT16 RemotePort
,
1168 IN BOOLEAN UseDefaultAddress
1172 Create an IPv6 device path node.
1174 The header type of IPv6 device path node is MESSAGING_DEVICE_PATH.
1175 The header subtype of IPv6 device path node is MSG_IPv6_DP.
1176 The length of the IPv6 device path node in bytes is 43.
1177 Get other information from parameters to make up the whole IPv6 device path node.
1179 @param[in, out] Node The pointer to the IPv6 device path node.
1180 @param[in] Controller The controller handle.
1181 @param[in] LocalIp The local IPv6 address.
1182 @param[in] LocalPort The local port.
1183 @param[in] RemoteIp The remote IPv6 address.
1184 @param[in] RemotePort The remote port.
1185 @param[in] Protocol The protocol type in the IP header.
1190 NetLibCreateIPv6DPathNode (
1191 IN OUT IPv6_DEVICE_PATH
*Node
,
1192 IN EFI_HANDLE Controller
,
1193 IN EFI_IPv6_ADDRESS
*LocalIp
,
1194 IN UINT16 LocalPort
,
1195 IN EFI_IPv6_ADDRESS
*RemoteIp
,
1196 IN UINT16 RemotePort
,
1202 Find the UNDI/SNP handle from controller and protocol GUID.
1204 For example, IP will open an MNP child to transmit/receive
1205 packets. When MNP is stopped, IP should also be stopped. IP
1206 needs to find its own private data that is related the IP's
1207 service binding instance that is installed on the UNDI/SNP handle.
1208 The controller is then either an MNP or an ARP child handle. Note that
1209 IP opens these handles using BY_DRIVER. Use that infomation to get the
1212 @param[in] Controller The protocol handle to check.
1213 @param[in] ProtocolGuid The protocol that is related with the handle.
1215 @return The UNDI/SNP handle or NULL for errors.
1220 NetLibGetNicHandle (
1221 IN EFI_HANDLE Controller
,
1222 IN EFI_GUID
*ProtocolGuid
1226 This is the default unload handle for all the network drivers.
1228 Disconnect the driver specified by ImageHandle from all the devices in the handle database.
1229 Uninstall all the protocols installed in the driver entry point.
1231 @param[in] ImageHandle The drivers' driver image.
1233 @retval EFI_SUCCESS The image is unloaded.
1234 @retval Others Failed to unload the image.
1239 NetLibDefaultUnload (
1240 IN EFI_HANDLE ImageHandle
1244 Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.
1246 @param[in] String The pointer to the Ascii string.
1247 @param[out] Ip4Address The pointer to the converted IPv4 address.
1249 @retval EFI_SUCCESS Converted to an IPv4 address successfully.
1250 @retval EFI_INVALID_PARAMETER The string is malformated, or Ip4Address is NULL.
1255 NetLibAsciiStrToIp4 (
1256 IN CONST CHAR8
*String
,
1257 OUT EFI_IPv4_ADDRESS
*Ip4Address
1261 Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the
1262 string is defined in RFC 4291 - Text Pepresentation of Addresses.
1264 @param[in] String The pointer to the Ascii string.
1265 @param[out] Ip6Address The pointer to the converted IPv6 address.
1267 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1268 @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.
1273 NetLibAsciiStrToIp6 (
1274 IN CONST CHAR8
*String
,
1275 OUT EFI_IPv6_ADDRESS
*Ip6Address
1279 Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.
1281 @param[in] String The pointer to the Ascii string.
1282 @param[out] Ip4Address The pointer to the converted IPv4 address.
1284 @retval EFI_SUCCESS Converted to an IPv4 address successfully.
1285 @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.
1286 @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to lack of resources.
1292 IN CONST CHAR16
*String
,
1293 OUT EFI_IPv4_ADDRESS
*Ip4Address
1297 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of
1298 the string is defined in RFC 4291 - Text Pepresentation of Addresses.
1300 @param[in] String The pointer to the Ascii string.
1301 @param[out] Ip6Address The pointer to the converted IPv6 address.
1303 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1304 @retval EFI_INVALID_PARAMETER The string is malformated or Ip6Address is NULL.
1305 @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.
1311 IN CONST CHAR16
*String
,
1312 OUT EFI_IPv6_ADDRESS
*Ip6Address
1316 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.
1317 The format of the string is defined in RFC 4291 - Text Pepresentation of Addresses
1318 Prefixes: ipv6-address/prefix-length.
1320 @param[in] String The pointer to the Ascii string.
1321 @param[out] Ip6Address The pointer to the converted IPv6 address.
1322 @param[out] PrefixLength The pointer to the converted prefix length.
1324 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1325 @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.
1326 @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.
1331 NetLibStrToIp6andPrefix (
1332 IN CONST CHAR16
*String
,
1333 OUT EFI_IPv6_ADDRESS
*Ip6Address
,
1334 OUT UINT8
*PrefixLength
1338 // Various signatures
1340 #define NET_BUF_SIGNATURE SIGNATURE_32 ('n', 'b', 'u', 'f')
1341 #define NET_VECTOR_SIGNATURE SIGNATURE_32 ('n', 'v', 'e', 'c')
1342 #define NET_QUE_SIGNATURE SIGNATURE_32 ('n', 'b', 'q', 'u')
1345 #define NET_PROTO_DATA 64 // Opaque buffer for protocols
1346 #define NET_BUF_HEAD 1 // Trim or allocate space from head
1347 #define NET_BUF_TAIL 0 // Trim or allocate space from tail
1348 #define NET_VECTOR_OWN_FIRST 0x01 // We allocated the 1st block in the vector
1350 #define NET_CHECK_SIGNATURE(PData, SIGNATURE) \
1351 ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE)))
1354 // Single memory block in the vector.
1357 UINT32 Len
; // The block's length
1358 UINT8
*Bulk
; // The block's Data
1361 typedef VOID (EFIAPI
*NET_VECTOR_EXT_FREE
) (VOID
*Arg
);
1364 //NET_VECTOR contains several blocks to hold all packet's
1365 //fragments and other house-keeping stuff for sharing. It
1366 //doesn't specify the where actual packet fragment begins.
1370 INTN RefCnt
; // Reference count to share NET_VECTOR.
1371 NET_VECTOR_EXT_FREE Free
; // external function to free NET_VECTOR
1372 VOID
*Arg
; // opeque argument to Free
1373 UINT32 Flag
; // Flags, NET_VECTOR_OWN_FIRST
1374 UINT32 Len
; // Total length of the assocated BLOCKs
1381 //NET_BLOCK_OP operates on the NET_BLOCK. It specifies
1382 //where the actual fragment begins and ends
1385 UINT8
*BlockHead
; // Block's head, or the smallest valid Head
1386 UINT8
*BlockTail
; // Block's tail. BlockTail-BlockHead=block length
1387 UINT8
*Head
; // 1st byte of the data in the block
1388 UINT8
*Tail
; // Tail of the data in the block, Tail-Head=Size
1389 UINT32 Size
; // The size of the data
1394 EFI_IP6_HEADER
*Ip6
;
1398 //NET_BUF is the buffer manage structure used by the
1399 //network stack. Every network packet may be fragmented. The Vector points to
1400 //memory blocks used by each fragment, and BlockOp
1401 //specifies where each fragment begins and ends.
1403 //It also contains an opaque area for the protocol to store
1404 //per-packet information. Protocol must be careful not
1405 //to overwrite the members after that.
1410 LIST_ENTRY List
; // The List this NET_BUF is on
1412 NET_IP_HEAD Ip
; // Network layer header, for fast access
1413 TCP_HEAD
*Tcp
; // Transport layer header, for fast access
1414 EFI_UDP_HEADER
*Udp
; // User Datagram Protocol header
1415 UINT8 ProtoData
[NET_PROTO_DATA
]; //Protocol specific data
1417 NET_VECTOR
*Vector
; // The vector containing the packet
1419 UINT32 BlockOpNum
; // Total number of BlockOp in the buffer
1420 UINT32 TotalSize
; // Total size of the actual packet
1421 NET_BLOCK_OP BlockOp
[1]; // Specify the position of actual packet
1425 //A queue of NET_BUFs. It is a thin extension of
1426 //NET_BUF functions.
1431 LIST_ENTRY List
; // The List this buffer queue is on
1433 LIST_ENTRY BufList
; // list of queued buffers
1434 UINT32 BufSize
; // total length of DATA in the buffers
1435 UINT32 BufNum
; // total number of buffers on the chain
1439 // Pseudo header for TCP and UDP checksum
1451 EFI_IPv6_ADDRESS SrcIp
;
1452 EFI_IPv6_ADDRESS DstIp
;
1455 UINT32 NextHeader
:8;
1456 } NET_IP6_PSEUDO_HDR
;
1460 // The fragment entry table used in network interfaces. This is
1461 // the same as NET_BLOCK now. Use two different to distinguish
1462 // the two in case that NET_BLOCK be enhanced later.
1469 #define NET_GET_REF(PData) ((PData)->RefCnt++)
1470 #define NET_PUT_REF(PData) ((PData)->RefCnt--)
1471 #define NETBUF_FROM_PROTODATA(Info) BASE_CR((Info), NET_BUF, ProtoData)
1473 #define NET_BUF_SHARED(Buf) \
1474 (((Buf)->RefCnt > 1) || ((Buf)->Vector->RefCnt > 1))
1476 #define NET_VECTOR_SIZE(BlockNum) \
1477 (sizeof (NET_VECTOR) + ((BlockNum) - 1) * sizeof (NET_BLOCK))
1479 #define NET_BUF_SIZE(BlockOpNum) \
1480 (sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))
1482 #define NET_HEADSPACE(BlockOp) \
1483 (UINTN)((BlockOp)->Head - (BlockOp)->BlockHead)
1485 #define NET_TAILSPACE(BlockOp) \
1486 (UINTN)((BlockOp)->BlockTail - (BlockOp)->Tail)
1489 Allocate a single block NET_BUF. Upon allocation, all the
1490 free space is in the tail room.
1492 @param[in] Len The length of the block.
1494 @return The pointer to the allocated NET_BUF, or NULL if the
1495 allocation failed due to resource limitations.
1505 Free the net buffer and its associated NET_VECTOR.
1507 Decrease the reference count of the net buffer by one. Free the associated net
1508 vector and itself if the reference count of the net buffer is decreased to 0.
1509 The net vector free operation decreases the reference count of the net
1510 vector by one, and performs the resource free operation when the reference count
1511 of the net vector is 0.
1513 @param[in] Nbuf The pointer to the NET_BUF to be freed.
1523 Get the index of NET_BLOCK_OP that contains the byte at Offset in the net
1526 For example, this function can be used to retrieve the IP header in the packet. It
1527 also can be used to get the fragment that contains the byte used
1528 mainly by the library implementation itself.
1530 @param[in] Nbuf The pointer to the net buffer.
1531 @param[in] Offset The offset of the byte.
1532 @param[out] Index Index of the NET_BLOCK_OP that contains the byte at
1535 @return The pointer to the Offset'th byte of data in the net buffer, or NULL
1536 if there is no such data in the net buffer.
1544 OUT UINT32
*Index OPTIONAL
1548 Create a copy of the net buffer that shares the associated net vector.
1550 The reference count of the newly created net buffer is set to 1. The reference
1551 count of the associated net vector is increased by one.
1553 @param[in] Nbuf The pointer to the net buffer to be cloned.
1555 @return The pointer to the cloned net buffer, or NULL if the
1556 allocation failed due to resource limitations.
1566 Create a duplicated copy of the net buffer with data copied and HeadSpace
1567 bytes of head space reserved.
1569 The duplicated net buffer will allocate its own memory to hold the data of the
1572 @param[in] Nbuf The pointer to the net buffer to be duplicated from.
1573 @param[in, out] Duplicate The pointer to the net buffer to duplicate to. If
1574 NULL, a new net buffer is allocated.
1575 @param[in] HeadSpace The length of the head space to reserve.
1577 @return The pointer to the duplicated net buffer, or NULL if
1578 the allocation failed due to resource limitations.
1585 IN OUT NET_BUF
*Duplicate OPTIONAL
,
1590 Create a NET_BUF structure which contains Len byte data of Nbuf starting from
1593 A new NET_BUF structure will be created but the associated data in NET_VECTOR
1594 is shared. This function exists to perform IP packet fragmentation.
1596 @param[in] Nbuf The pointer to the net buffer to be extracted.
1597 @param[in] Offset Starting point of the data to be included in the new
1599 @param[in] Len The bytes of data to be included in the new net buffer.
1600 @param[in] HeadSpace The bytes of the head space to reserve for the protocol header.
1602 @return The pointer to the cloned net buffer, or NULL if the
1603 allocation failed due to resource limitations.
1616 Reserve some space in the header room of the net buffer.
1618 Upon allocation, all the space is in the tail room of the buffer. Call this
1619 function to move space to the header room. This function is quite limited
1620 in that it can only reserve space from the first block of an empty NET_BUF not
1621 built from the external. However, it should be enough for the network stack.
1623 @param[in, out] Nbuf The pointer to the net buffer.
1624 @param[in] Len The length of buffer to be reserved from the header.
1630 IN OUT NET_BUF
*Nbuf
,
1635 Allocate Len bytes of space from the header or tail of the buffer.
1637 @param[in, out] Nbuf The pointer to the net buffer.
1638 @param[in] Len The length of the buffer to be allocated.
1639 @param[in] FromHead The flag to indicate whether to reserve the data
1640 from head (TRUE) or tail (FALSE).
1642 @return The pointer to the first byte of the allocated buffer,
1643 or NULL, if there is no sufficient space.
1649 IN OUT NET_BUF
*Nbuf
,
1655 Trim Len bytes from the header or the tail of the net buffer.
1657 @param[in, out] Nbuf The pointer to the net buffer.
1658 @param[in] Len The length of the data to be trimmed.
1659 @param[in] FromHead The flag to indicate whether trim data is from the
1660 head (TRUE) or the tail (FALSE).
1662 @return The length of the actual trimmed data, which may be less
1663 than Len if the TotalSize of Nbuf is less than Len.
1669 IN OUT NET_BUF
*Nbuf
,
1675 Copy Len bytes of data from the specific offset of the net buffer to the
1678 The Len bytes of data may cross several fragments of the net buffer.
1680 @param[in] Nbuf The pointer to the net buffer.
1681 @param[in] Offset The sequence number of the first byte to copy.
1682 @param[in] Len The length of the data to copy.
1683 @param[in] Dest The destination of the data to copy to.
1685 @return The length of the actual copied data, or 0 if the offset
1686 specified exceeds the total size of net buffer.
1699 Build a NET_BUF from external blocks.
1701 A new NET_BUF structure will be created from external blocks. An additional block
1702 of memory will be allocated to hold reserved HeadSpace bytes of header room
1703 and existing HeadLen bytes of header, but the external blocks are shared by the
1704 net buffer to avoid data copying.
1706 @param[in] ExtFragment The pointer to the data block.
1707 @param[in] ExtNum The number of the data blocks.
1708 @param[in] HeadSpace The head space to be reserved.
1709 @param[in] HeadLen The length of the protocol header. The function
1710 pulls this amount of data into a linear block.
1711 @param[in] ExtFree The pointer to the caller-provided free function.
1712 @param[in] Arg The argument passed to ExtFree when ExtFree is
1715 @return The pointer to the net buffer built from the data blocks,
1716 or NULL if the allocation failed due to resource
1723 IN NET_FRAGMENT
*ExtFragment
,
1725 IN UINT32 HeadSpace
,
1727 IN NET_VECTOR_EXT_FREE ExtFree
,
1728 IN VOID
*Arg OPTIONAL
1732 Build a fragment table to contain the fragments in the net buffer. This is the
1733 opposite operation of the NetbufFromExt.
1735 @param[in] Nbuf Points to the net buffer.
1736 @param[in, out] ExtFragment The pointer to the data block.
1737 @param[in, out] ExtNum The number of the data blocks.
1739 @retval EFI_BUFFER_TOO_SMALL The number of non-empty blocks is bigger than
1741 @retval EFI_SUCCESS The fragment table was built successfully.
1748 IN OUT NET_FRAGMENT
*ExtFragment
,
1749 IN OUT UINT32
*ExtNum
1753 Build a net buffer from a list of net buffers.
1755 All the fragments will be collected from the list of NEW_BUF, and then a new
1756 net buffer will be created through NetbufFromExt.
1758 @param[in] BufList A List of the net buffer.
1759 @param[in] HeadSpace The head space to be reserved.
1760 @param[in] HeaderLen The length of the protocol header. The function
1761 pulls this amount of data into a linear block.
1762 @param[in] ExtFree The pointer to the caller provided free function.
1763 @param[in] Arg The argument passed to ExtFree when ExtFree is called.
1765 @return The pointer to the net buffer built from the list of net
1772 IN LIST_ENTRY
*BufList
,
1773 IN UINT32 HeadSpace
,
1774 IN UINT32 HeaderLen
,
1775 IN NET_VECTOR_EXT_FREE ExtFree
,
1776 IN VOID
*Arg OPTIONAL
1780 Free a list of net buffers.
1782 @param[in, out] Head The pointer to the head of linked net buffers.
1788 IN OUT LIST_ENTRY
*Head
1792 Initiate the net buffer queue.
1794 @param[in, out] NbufQue The pointer to the net buffer queue to be initialized.
1800 IN OUT NET_BUF_QUEUE
*NbufQue
1804 Allocate and initialize a net buffer queue.
1806 @return The pointer to the allocated net buffer queue, or NULL if the
1807 allocation failed due to resource limit.
1817 Free a net buffer queue.
1819 Decrease the reference count of the net buffer queue by one. The real resource
1820 free operation isn't performed until the reference count of the net buffer
1821 queue is decreased to 0.
1823 @param[in] NbufQue The pointer to the net buffer queue to be freed.
1829 IN NET_BUF_QUEUE
*NbufQue
1833 Remove a net buffer from the head in the specific queue and return it.
1835 @param[in, out] NbufQue The pointer to the net buffer queue.
1837 @return The pointer to the net buffer removed from the specific queue,
1838 or NULL if there is no net buffer in the specific queue.
1844 IN OUT NET_BUF_QUEUE
*NbufQue
1848 Append a net buffer to the net buffer queue.
1850 @param[in, out] NbufQue The pointer to the net buffer queue.
1851 @param[in, out] Nbuf The pointer to the net buffer to be appended.
1857 IN OUT NET_BUF_QUEUE
*NbufQue
,
1858 IN OUT NET_BUF
*Nbuf
1862 Copy Len bytes of data from the net buffer queue at the specific offset to the
1865 The copying operation is the same as NetbufCopy, but applies to the net buffer
1866 queue instead of the net buffer.
1868 @param[in] NbufQue The pointer to the net buffer queue.
1869 @param[in] Offset The sequence number of the first byte to copy.
1870 @param[in] Len The length of the data to copy.
1871 @param[out] Dest The destination of the data to copy to.
1873 @return The length of the actual copied data, or 0 if the offset
1874 specified exceeds the total size of net buffer queue.
1880 IN NET_BUF_QUEUE
*NbufQue
,
1887 Trim Len bytes of data from the buffer queue and free any net buffer
1888 that is completely trimmed.
1890 The trimming operation is the same as NetbufTrim but applies to the net buffer
1891 queue instead of the net buffer.
1893 @param[in, out] NbufQue The pointer to the net buffer queue.
1894 @param[in] Len The length of the data to trim.
1896 @return The actual length of the data trimmed.
1902 IN OUT NET_BUF_QUEUE
*NbufQue
,
1908 Flush the net buffer queue.
1910 @param[in, out] NbufQue The pointer to the queue to be flushed.
1916 IN OUT NET_BUF_QUEUE
*NbufQue
1920 Compute the checksum for a bulk of data.
1922 @param[in] Bulk The pointer to the data.
1923 @param[in] Len The length of the data, in bytes.
1925 @return The computed checksum.
1938 @param[in] Checksum1 The first checksum to be added.
1939 @param[in] Checksum2 The second checksum to be added.
1941 @return The new checksum.
1947 IN UINT16 Checksum1
,
1952 Compute the checksum for a NET_BUF.
1954 @param[in] Nbuf The pointer to the net buffer.
1956 @return The computed checksum.
1966 Compute the checksum for TCP/UDP pseudo header.
1968 Src and Dst are in network byte order, and Len is in host byte order.
1970 @param[in] Src The source address of the packet.
1971 @param[in] Dst The destination address of the packet.
1972 @param[in] Proto The protocol type of the packet.
1973 @param[in] Len The length of the packet.
1975 @return The computed checksum.
1980 NetPseudoHeadChecksum (
1988 Compute the checksum for the TCP6/UDP6 pseudo header.
1990 Src and Dst are in network byte order, and Len is in host byte order.
1992 @param[in] Src The source address of the packet.
1993 @param[in] Dst The destination address of the packet.
1994 @param[in] NextHeader The protocol type of the packet.
1995 @param[in] Len The length of the packet.
1997 @return The computed checksum.
2002 NetIp6PseudoHeadChecksum (
2003 IN EFI_IPv6_ADDRESS
*Src
,
2004 IN EFI_IPv6_ADDRESS
*Dst
,
2005 IN UINT8 NextHeader
,
2010 The function frees the net buffer which allocated by the IP protocol. It releases
2011 only the net buffer and doesn't call the external free function.
2013 This function should be called after finishing the process of mIpSec->ProcessExt()
2014 for outbound traffic. The (EFI_IPSEC2_PROTOCOL)->ProcessExt() allocates a new
2015 buffer for the ESP, so there needs a function to free the old net buffer.
2017 @param[in] Nbuf The network buffer to be freed.
2021 NetIpSecNetbufFree (
2026 This function obtains the system guid from the smbios table.
2028 @param[out] SystemGuid The pointer of the returned system guid.
2030 @retval EFI_SUCCESS Successfully obtained the system guid.
2031 @retval EFI_NOT_FOUND Did not find the SMBIOS table.
2036 NetLibGetSystemGuid (
2037 OUT EFI_GUID
*SystemGuid