2 This library is only intended to be used by UEFI network stack modules.
3 It provides basic functions for the UEFI network stack.
5 Copyright (c) 2005 - 2010, Intel Corporation. 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>
23 typedef UINT32 IP4_ADDR
;
24 typedef UINT32 TCP_SEQNO
;
25 typedef UINT16 TCP_PORTNO
;
28 #define NET_ETHER_ADDR_LEN 6
29 #define NET_IFTYPE_ETHERNET 0x01
31 #define NET_VLAN_TAG_LEN 4
32 #define ETHER_TYPE_VLAN 0x8100
34 #define EFI_IP_PROTO_UDP 0x11
35 #define EFI_IP_PROTO_TCP 0x06
36 #define EFI_IP_PROTO_ICMP 0x01
37 #define IP4_PROTO_IGMP 0x02
41 // The address classification
43 #define IP4_ADDR_CLASSA 1
44 #define IP4_ADDR_CLASSB 2
45 #define IP4_ADDR_CLASSC 3
46 #define IP4_ADDR_CLASSD 4
47 #define IP4_ADDR_CLASSE 5
49 #define IP4_MASK_NUM 33
50 #define IP6_PREFIX_NUM 129
52 #define IP6_HOP_BY_HOP 0
53 #define IP6_DESTINATION 60
54 #define IP6_ROUTING 43
55 #define IP6_FRAGMENT 44
58 #define IP6_NO_NEXT_HEADER 59
60 #define IP_VERSION_4 4
61 #define IP_VERSION_6 6
66 // Ethernet head definition
69 UINT8 DstMac
[NET_ETHER_ADDR_LEN
];
70 UINT8 SrcMac
[NET_ETHER_ADDR_LEN
];
75 // 802.1Q VLAN Tag Control Information
79 UINT16 Vid
: 12; // Unique VLAN identifier (0 to 4094)
80 UINT16 Cfi
: 1; // Canonical Format Indicator
81 UINT16 Priority
: 3; // 802.1Q priority level (0 to 7)
86 #define VLAN_TCI_CFI_CANONICAL_MAC 0
87 #define VLAN_TCI_CFI_NON_CANONICAL_MAC 1
90 // The EFI_IP4_HEADER is hard to use because the source and
91 // destination address are defined as EFI_IPv4_ADDRESS, which
92 // is a structure. Two structures can't be compared or masked
93 // directly. This is why there is an internal representation.
111 // ICMP head definition. Each ICMP message is categorized as either an error
112 // message or query message. Two message types have their own head format.
122 UINT32 Fourth
; // 4th filed of the head, it depends on Type.
124 } IP4_ICMP_ERROR_HEAD
;
130 } IP4_ICMP_QUERY_HEAD
;
141 EFI_IP6_HEADER IpHead
;
142 } IP6_ICMP_ERROR_HEAD
;
147 } IP6_ICMP_INFORMATION_HEAD
;
150 // UDP header definition
160 // TCP header definition
177 #define NET_MAC_EQUAL(pMac1, pMac2, Len) \
178 (CompareMem ((pMac1), (pMac2), Len) == 0)
180 #define NET_MAC_IS_MULTICAST(Mac, BMac, Len) \
181 (((*((UINT8 *) Mac) & 0x01) == 0x01) && (!NET_MAC_EQUAL (Mac, BMac, Len)))
183 #define NTOHL(x) SwapBytes32 (x)
185 #define HTONL(x) NTOHL(x)
187 #define NTOHS(x) SwapBytes16 (x)
189 #define HTONS(x) NTOHS(x)
190 #define NTOHLL(x) SwapBytes64 (x)
191 #define HTONLL(x) NTOHLL(x)
192 #define NTOHLLL(x) Ip6Swap128 (x)
193 #define HTONLLL(x) NTOHLLL(x)
196 // Test the IP's attribute, All the IPs are in host byte order.
198 #define IP4_IS_MULTICAST(Ip) (((Ip) & 0xF0000000) == 0xE0000000)
199 #define IP4_IS_LOCAL_BROADCAST(Ip) ((Ip) == 0xFFFFFFFF)
200 #define IP4_NET_EQUAL(Ip1, Ip2, NetMask) (((Ip1) & (NetMask)) == ((Ip2) & (NetMask)))
201 #define IP4_IS_VALID_NETMASK(Ip) (NetGetMaskLength (Ip) != IP4_MASK_NUM)
203 #define IP6_IS_MULTICAST(Ip6) (((Ip6)->Addr[0]) == 0xFF)
206 // Convert the EFI_IP4_ADDRESS to plain UINT32 IP4 address.
208 #define EFI_IP4(EfiIpAddr) (*(IP4_ADDR *) ((EfiIpAddr).Addr))
209 #define EFI_NTOHL(EfiIp) (NTOHL (EFI_IP4 ((EfiIp))))
210 #define EFI_IP4_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv4_ADDRESS)) == 0)
212 #define EFI_IP6_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv6_ADDRESS)) == 0)
214 #define IP6_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv6_ADDRESS)))
215 #define IP6_COPY_LINK_ADDRESS(Mac1, Mac2) (CopyMem ((Mac1), (Mac2), sizeof (EFI_MAC_ADDRESS)))
218 // The debug level definition. This value is also used as the
219 // syslog's servity level. Don't change it.
221 #define NETDEBUG_LEVEL_TRACE 5
222 #define NETDEBUG_LEVEL_WARNING 4
223 #define NETDEBUG_LEVEL_ERROR 3
226 // Network debug message is sent out as syslog packet.
228 #define NET_SYSLOG_FACILITY 16 // Syslog local facility local use
229 #define NET_SYSLOG_PACKET_LEN 512
230 #define NET_SYSLOG_TX_TIMEOUT (500 * 1000 * 10) // 500ms
231 #define NET_DEBUG_MSG_LEN 470 // 512 - (ether+ip4+udp4 head length)
234 // The debug output expects the ASCII format string, Use %a to print ASCII
235 // string, and %s to print UNICODE string. PrintArg must be enclosed in ().
236 // For example: NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name));
238 #define NET_DEBUG_TRACE(Module, PrintArg) \
240 NETDEBUG_LEVEL_TRACE, \
244 NetDebugASPrint PrintArg \
247 #define NET_DEBUG_WARNING(Module, PrintArg) \
249 NETDEBUG_LEVEL_WARNING, \
253 NetDebugASPrint PrintArg \
256 #define NET_DEBUG_ERROR(Module, PrintArg) \
258 NETDEBUG_LEVEL_ERROR, \
262 NetDebugASPrint PrintArg \
266 Allocate a buffer, then format the message to it. This is a
267 help function for the NET_DEBUG_XXX macros. The PrintArg of
268 these macros treats the variable length print parameters as a
269 single parameter, and pass it to the NetDebugASPrint. For
270 example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name))
274 NETDEBUG_LEVEL_TRACE,
278 NetDebugASPrint ("State transit to %a\n", Name)
281 @param Format The ASCII format string.
282 @param ... The variable length parameter whose format is determined
283 by the Format string.
285 @return The buffer containing the formatted message,
286 or NULL if memory allocation failed.
297 Builds an UDP4 syslog packet and send it using SNP.
299 This function will locate a instance of SNP then send the message through it.
300 Because it isn't open the SNP BY_DRIVER, apply caution when using it.
302 @param Level The servity level of the message.
303 @param Module The Moudle that generates the log.
304 @param File The file that contains the log.
305 @param Line The exact line that contains the log.
306 @param Message The user message to log.
308 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
309 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet
310 @retval EFI_SUCCESS The log is discard because that it is more verbose
311 than the mNetDebugLevelMax. Or, it has been sent out.
325 Return the length of the mask.
327 Return the length of the mask. Valid values are 0 to 32.
328 If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM.
329 NetMask is in the host byte order.
331 @param[in] NetMask The netmask to get the length from.
333 @return The length of the netmask, or IP4_MASK_NUM (33) if the mask is invalid.
343 Return the class of the IP address, such as class A, B, C.
344 Addr is in host byte order.
346 The address of class A starts with 0.
347 If the address belong to class A, return IP4_ADDR_CLASSA.
348 The address of class B starts with 10.
349 If the address belong to class B, return IP4_ADDR_CLASSB.
350 The address of class C starts with 110.
351 If the address belong to class C, return IP4_ADDR_CLASSC.
352 The address of class D starts with 1110.
353 If the address belong to class D, return IP4_ADDR_CLASSD.
354 The address of class E starts with 1111.
355 If the address belong to class E, return IP4_ADDR_CLASSE.
358 @param[in] Addr The address to get the class from.
360 @return IP address class, such as IP4_ADDR_CLASSA.
370 Check whether the IP is a valid unicast address according to
371 the netmask. If NetMask is zero, use the IP address's class to get the default mask.
373 If Ip is 0, IP is not a valid unicast address.
374 Class D address is used for multicasting and class E address is reserved for future. If Ip
375 belongs to class D or class E, Ip is not a valid unicast address.
376 If all bits of the host address of Ip are 0 or 1, Ip is not a valid unicast address.
378 @param[in] Ip The IP to check against.
379 @param[in] NetMask The mask of the IP.
381 @return TRUE if Ip is a valid unicast address on the network, otherwise FALSE.
392 Check whether the incoming IPv6 address is a valid unicast address.
394 If the address is a multicast address has binary 0xFF at the start, it is not
395 a valid unicast address. If the address is unspecified ::, it is not a valid
396 unicast address to be assigned to any node. If the address is loopback address
397 ::1, it is also not a valid unicast address to be assigned to any physical
400 @param[in] Ip6 The IPv6 address to check against.
402 @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE.
407 NetIp6IsValidUnicast (
408 IN EFI_IPv6_ADDRESS
*Ip6
413 Check whether the incoming Ipv6 address is the unspecified address or not.
415 @param[in] Ip6 - Ip6 address, in network order.
417 @retval TRUE - Yes, incoming Ipv6 address is the unspecified address.
418 @retval FALSE - The incoming Ipv6 address is not the unspecified address
423 NetIp6IsUnspecifiedAddr (
424 IN EFI_IPv6_ADDRESS
*Ip6
428 Check whether the incoming Ipv6 address is a link-local address.
430 @param[in] Ip6 - Ip6 address, in network order.
432 @retval TRUE - The incoming Ipv6 address is a link-local address.
433 @retval FALSE - The incoming Ipv6 address is not a link-local address.
438 NetIp6IsLinkLocalAddr (
439 IN EFI_IPv6_ADDRESS
*Ip6
443 Check whether the Ipv6 address1 and address2 are on the connected network.
445 @param[in] Ip1 - Ip6 address1, in network order.
446 @param[in] Ip2 - Ip6 address2, in network order.
447 @param[in] PrefixLength - The prefix length of the checking net.
449 @retval TRUE - Yes, the Ipv6 address1 and address2 are connected.
450 @retval FALSE - No the Ipv6 address1 and address2 are not connected.
456 EFI_IPv6_ADDRESS
*Ip1
,
457 EFI_IPv6_ADDRESS
*Ip2
,
462 Switches the endianess of an IPv6 address.
464 This function swaps the bytes in a 128-bit IPv6 address to switch the value
465 from little endian to big endian or vice versa. The byte swapped value is
468 @param Ip6 Points to an IPv6 address.
470 @return The byte swapped IPv6 address.
476 EFI_IPv6_ADDRESS
*Ip6
479 extern IP4_ADDR gIp4AllMasks
[IP4_MASK_NUM
];
482 extern EFI_IPv4_ADDRESS mZeroIp4Addr
;
484 #define NET_IS_DIGIT(Ch) (('0' <= (Ch)) && ((Ch) <= '9'))
485 #define NET_ROUNDUP(size, unit) (((size) + (unit) - 1) & (~((unit) - 1)))
486 #define NET_IS_LOWER_CASE_CHAR(Ch) (('a' <= (Ch)) && ((Ch) <= 'z'))
487 #define NET_IS_UPPER_CASE_CHAR(Ch) (('A' <= (Ch)) && ((Ch) <= 'Z'))
489 #define TICKS_PER_MS 10000U
490 #define TICKS_PER_SECOND 10000000U
492 #define NET_RANDOM(Seed) ((UINT32) ((UINT32) (Seed) * 1103515245UL + 12345) % 4294967295UL)
495 Extract a UINT32 from a byte stream.
497 This function copies a UINT32 from a byte stream, and then converts it from Network
498 byte order to host byte order. Use this function to avoid alignment error.
500 @param[in] Buf The buffer to extract the UINT32.
502 @return The UINT32 extracted.
512 Puts a UINT32 into the byte stream in network byte order.
514 Converts a UINT32 from host byte order to network byte order, then copies it to the
517 @param[in, out] Buf The buffer in which to put the UINT32.
518 @param[in] Data The data to be converted and put into the byte stream.
529 Initialize a random seed using current time.
531 Get current time first. Then initialize a random seed based on some basic
532 mathematical operations on the hour, day, minute, second, nanosecond and year
535 @return The random seed, initialized with current time.
545 #define NET_LIST_USER_STRUCT(Entry, Type, Field) \
546 BASE_CR(Entry, Type, Field)
548 #define NET_LIST_USER_STRUCT_S(Entry, Type, Field, Sig) \
549 CR(Entry, Type, Field, Sig)
552 // Iterate through the double linked list. It is NOT delete safe
554 #define NET_LIST_FOR_EACH(Entry, ListHead) \
555 for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)
558 // Iterate through the double linked list. This is delete-safe.
559 // Don't touch NextEntry. Also, don't use this macro if list
560 // entries other than the Entry may be deleted when processing
561 // the current Entry.
563 #define NET_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead) \
564 for(Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink; \
565 Entry != (ListHead); \
566 Entry = NextEntry, NextEntry = Entry->ForwardLink \
570 // Make sure the list isn't empty before getting the first/last record.
572 #define NET_LIST_HEAD(ListHead, Type, Field) \
573 NET_LIST_USER_STRUCT((ListHead)->ForwardLink, Type, Field)
575 #define NET_LIST_TAIL(ListHead, Type, Field) \
576 NET_LIST_USER_STRUCT((ListHead)->BackLink, Type, Field)
580 Remove the first node entry on the list, and return the removed node entry.
582 Removes the first node entry from a doubly linked list. It is up to the caller of
583 this function to release the memory used by the first node, if that is required. On
584 exit, the removed node is returned.
586 If Head is NULL, then ASSERT().
587 If Head was not initialized, then ASSERT().
588 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
589 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
592 @param[in, out] Head The list header.
594 @return The first node entry that is removed from the list, NULL if the list is empty.
600 IN OUT LIST_ENTRY
*Head
604 Remove the last node entry on the list and return the removed node entry.
606 Removes the last node entry from a doubly linked list. It is up to the caller of
607 this function to release the memory used by the first node, if that is required. On
608 exit, the removed node is returned.
610 If Head is NULL, then ASSERT().
611 If Head was not initialized, then ASSERT().
612 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
613 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
616 @param[in, out] Head The list head.
618 @return The last node entry that is removed from the list, NULL if the list is empty.
624 IN OUT LIST_ENTRY
*Head
628 Insert a new node entry after a designated node entry of a doubly linked list.
630 Inserts a new node entry designated by NewEntry after the node entry designated by PrevEntry
631 of the doubly linked list.
633 @param[in, out] PrevEntry The entry after which to insert.
634 @param[in, out] NewEntry The new entry to insert.
640 IN OUT LIST_ENTRY
*PrevEntry
,
641 IN OUT LIST_ENTRY
*NewEntry
645 Insert a new node entry before a designated node entry of a doubly linked list.
647 Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry
648 of the doubly linked list.
650 @param[in, out] PostEntry The entry to insert before.
651 @param[in, out] NewEntry The new entry to insert.
656 NetListInsertBefore (
657 IN OUT LIST_ENTRY
*PostEntry
,
658 IN OUT LIST_ENTRY
*NewEntry
663 // Object container: EFI network stack spec defines various kinds of
664 // tokens. The drivers can share code to manage those objects.
678 #define NET_MAP_INCREAMENT 64
681 Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.
683 Initialize the forward and backward links of two head nodes donated by Map->Used
684 and Map->Recycled of two doubly linked lists.
685 Initializes the count of the <Key, Value> pairs in the netmap to zero.
687 If Map is NULL, then ASSERT().
688 If the address of Map->Used is NULL, then ASSERT().
689 If the address of Map->Recycled is NULl, then ASSERT().
691 @param[in, out] Map The netmap to initialize.
701 To clean up the netmap, that is, release allocated memories.
703 Removes all nodes of the Used doubly linked list and frees memory of all related netmap items.
704 Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.
705 The number of the <Key, Value> pairs in the netmap is set to zero.
707 If Map is NULL, then ASSERT().
709 @param[in, out] Map The netmap to clean up.
719 Test whether the netmap is empty and return true if it is.
721 If the number of the <Key, Value> pairs in the netmap is zero, return TRUE.
723 If Map is NULL, then ASSERT().
726 @param[in] Map The net map to test.
728 @return TRUE if the netmap is empty, otherwise FALSE.
738 Return the number of the <Key, Value> pairs in the netmap.
740 @param[in] Map The netmap to get the entry number.
742 @return The entry number in the netmap.
752 Allocate an item to save the <Key, Value> pair to the head of the netmap.
754 Allocate an item to save the <Key, Value> pair and add corresponding node entry
755 to the beginning of the Used doubly linked list. The number of the <Key, Value>
756 pairs in the netmap increase by 1.
758 If Map is NULL, then ASSERT().
760 @param[in, out] Map The netmap to insert into.
761 @param[in] Key The user's key.
762 @param[in] Value The user's value for the key.
764 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
765 @retval EFI_SUCCESS The item is inserted to the head.
773 IN VOID
*Value OPTIONAL
777 Allocate an item to save the <Key, Value> pair to the tail of the netmap.
779 Allocate an item to save the <Key, Value> pair and add corresponding node entry
780 to the tail of the Used doubly linked list. The number of the <Key, Value>
781 pairs in the netmap increase by 1.
783 If Map is NULL, then ASSERT().
785 @param[in, out] Map The netmap to insert into.
786 @param[in] Key The user's key.
787 @param[in] Value The user's value for the key.
789 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
790 @retval EFI_SUCCESS The item is inserted to the tail.
798 IN VOID
*Value OPTIONAL
802 Finds the key in the netmap and returns the point to the item containing the Key.
804 Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every
805 item with the key to search. It returns the point to the item contains the Key if found.
807 If Map is NULL, then ASSERT().
809 @param[in] Map The netmap to search within.
810 @param[in] Key The key to search.
812 @return The point to the item contains the Key, or NULL if Key isn't in the map.
823 Remove the node entry of the item from the netmap and return the key of the removed item.
825 Remove the node entry of the item from the Used doubly linked list of the netmap.
826 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
827 entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL,
828 Value will point to the value of the item. It returns the key of the removed item.
830 If Map is NULL, then ASSERT().
831 If Item is NULL, then ASSERT().
832 if item in not in the netmap, then ASSERT().
834 @param[in, out] Map The netmap to remove the item from.
835 @param[in, out] Item The item to remove.
836 @param[out] Value The variable to receive the value if not NULL.
838 @return The key of the removed item.
845 IN OUT NET_MAP_ITEM
*Item
,
846 OUT VOID
**Value OPTIONAL
850 Remove the first node entry on the netmap and return the key of the removed item.
852 Remove the first node entry from the Used doubly linked list of the netmap.
853 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
854 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
855 parameter Value will point to the value of the item. It returns the key of the removed item.
857 If Map is NULL, then ASSERT().
858 If the Used doubly linked list is empty, then ASSERT().
860 @param[in, out] Map The netmap to remove the head from.
861 @param[out] Value The variable to receive the value if not NULL.
863 @return The key of the item removed.
870 OUT VOID
**Value OPTIONAL
874 Remove the last node entry on the netmap and return the key of the removed item.
876 Remove the last node entry from the Used doubly linked list of the netmap.
877 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
878 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
879 parameter Value will point to the value of the item. It returns the key of the removed item.
881 If Map is NULL, then ASSERT().
882 If the Used doubly linked list is empty, then ASSERT().
884 @param[in, out] Map The netmap to remove the tail from.
885 @param[out] Value The variable to receive the value if not NULL.
887 @return The key of the item removed.
894 OUT VOID
**Value OPTIONAL
899 (EFIAPI
*NET_MAP_CALLBACK
) (
901 IN NET_MAP_ITEM
*Item
,
906 Iterate through the netmap and call CallBack for each item.
908 It will contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
909 from the loop. It returns the CallBack's last return value. This function is
910 delete safe for the current item.
912 If Map is NULL, then ASSERT().
913 If CallBack is NULL, then ASSERT().
915 @param[in] Map The Map to iterate through.
916 @param[in] CallBack The callback function to call for each item.
917 @param[in] Arg The opaque parameter to the callback.
919 @retval EFI_SUCCESS There is no item in the netmap, or CallBack for each item
921 @retval Others It returns the CallBack's last return value.
928 IN NET_MAP_CALLBACK CallBack
,
929 IN VOID
*Arg OPTIONAL
934 // Helper functions to implement driver binding and service binding protocols.
937 Create a child of the service that is identified by ServiceBindingGuid.
939 Get the ServiceBinding Protocol first, then use it to create a child.
941 If ServiceBindingGuid is NULL, then ASSERT().
942 If ChildHandle is NULL, then ASSERT().
944 @param[in] Controller The controller which has the service installed.
945 @param[in] Image The image handle used to open service.
946 @param[in] ServiceBindingGuid The service's Guid.
947 @param[in, out] ChildHandle The handle to receive the created child.
949 @retval EFI_SUCCESS The child was successfully created.
950 @retval Others Failed to create the child.
955 NetLibCreateServiceChild (
956 IN EFI_HANDLE Controller
,
958 IN EFI_GUID
*ServiceBindingGuid
,
959 IN OUT EFI_HANDLE
*ChildHandle
963 Destroy a child of the service that is identified by ServiceBindingGuid.
965 Get the ServiceBinding Protocol first, then use it to destroy a child.
967 If ServiceBindingGuid is NULL, then ASSERT().
969 @param[in] Controller The controller which has the service installed.
970 @param[in] Image The image handle used to open service.
971 @param[in] ServiceBindingGuid The service's Guid.
972 @param[in] ChildHandle The child to destroy.
974 @retval EFI_SUCCESS The child was destroyed.
975 @retval Others Failed to destroy the child.
980 NetLibDestroyServiceChild (
981 IN EFI_HANDLE Controller
,
983 IN EFI_GUID
*ServiceBindingGuid
,
984 IN EFI_HANDLE ChildHandle
988 Get handle with Simple Network Protocol installed on it.
990 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
991 If Simple Network Protocol is already installed on the ServiceHandle, the
992 ServiceHandle will be returned. If SNP is not installed on the ServiceHandle,
993 try to find its parent handle with SNP installed.
995 @param[in] ServiceHandle The handle where network service binding protocols are
997 @param[out] Snp The pointer to store the address of the SNP instance.
998 This is an optional parameter that may be NULL.
1000 @return The SNP handle, or NULL if not found.
1005 NetLibGetSnpHandle (
1006 IN EFI_HANDLE ServiceHandle
,
1007 OUT EFI_SIMPLE_NETWORK_PROTOCOL
**Snp OPTIONAL
1011 Retrieve VLAN ID of a VLAN device handle.
1013 Search VLAN device path node in Device Path of specified ServiceHandle and
1014 return its VLAN ID. If no VLAN device path node found, then this ServiceHandle
1015 is not a VLAN device handle, and 0 will be returned.
1017 @param[in] ServiceHandle The handle where network service binding protocols are
1020 @return VLAN ID of the device handle, or 0 if not a VLAN device.
1026 IN EFI_HANDLE ServiceHandle
1030 Find VLAN device handle with specified VLAN ID.
1032 The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle.
1033 This function will append VLAN device path node to the parent device path,
1034 and then use LocateDevicePath() to find the correct VLAN device handle.
1036 @param[in] ControllerHandle The handle where network service binding protocols are
1038 @param[in] VlanId The configured VLAN ID for the VLAN device.
1040 @return The VLAN device handle, or NULL if not found.
1045 NetLibGetVlanHandle (
1046 IN EFI_HANDLE ControllerHandle
,
1051 Get MAC address associated with the network service handle.
1053 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
1054 If SNP is installed on the ServiceHandle or its parent handle, MAC address will
1055 be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.
1057 @param[in] ServiceHandle The handle where network service binding protocols are
1059 @param[out] MacAddress The pointer to store the returned MAC address.
1060 @param[out] AddressSize The length of returned MAC address.
1062 @retval EFI_SUCCESS MAC address was returned successfully.
1063 @retval Others Failed to get SNP mode data.
1068 NetLibGetMacAddress (
1069 IN EFI_HANDLE ServiceHandle
,
1070 OUT EFI_MAC_ADDRESS
*MacAddress
,
1071 OUT UINTN
*AddressSize
1075 Convert MAC address of the NIC associated with specified Service Binding Handle
1076 to a unicode string. Callers are responsible for freeing the string storage.
1078 Locate simple network protocol associated with the Service Binding Handle and
1079 get the mac address from SNP. Then convert the mac address into a unicode
1080 string. It takes 2 unicode characters to represent a 1 byte binary buffer.
1081 Plus one unicode character for the null-terminator.
1083 @param[in] ServiceHandle The handle where network service binding protocol is
1085 @param[in] ImageHandle The image handle used to act as the agent handle to
1086 get the simple network protocol.
1087 @param[out] MacString The pointer to store the address of the string
1088 representation of the mac address.
1090 @retval EFI_SUCCESS Converted the mac address a unicode string successfully.
1091 @retval EFI_OUT_OF_RESOURCES There are not enough memory resources.
1092 @retval Others Failed to open the simple network protocol.
1097 NetLibGetMacString (
1098 IN EFI_HANDLE ServiceHandle
,
1099 IN EFI_HANDLE ImageHandle
,
1100 OUT CHAR16
**MacString
1104 Detect media status for specified network device.
1106 The underlying UNDI driver may or may not support reporting media status from
1107 GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine
1108 will try to invoke Snp->GetStatus() to get the media status. If media is already
1109 present, it returns directly. If media is not present, it will stop SNP and then
1110 restart SNP to get the latest media status. This provides an opportunity to get
1111 the correct media status for old UNDI driver, which doesn't support reporting
1112 media status from GET_STATUS command.
1113 Note: there are two limitations for the current algorithm:
1114 1) For UNDI with this capability, when the cable is not attached, there will
1115 be an redundant Stop/Start() process.
1116 2) for UNDI without this capability, in case that network cable is attached when
1117 Snp->Initialize() is invoked while network cable is unattached later,
1118 NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer
1119 apps to wait for timeout time.
1121 @param[in] ServiceHandle The handle where network service binding protocols are
1123 @param[out] MediaPresent The pointer to store the media status.
1125 @retval EFI_SUCCESS Media detection success.
1126 @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle.
1127 @retval EFI_UNSUPPORTED The network device does not support media detection.
1128 @retval EFI_DEVICE_ERROR SNP is in an unknown state.
1134 IN EFI_HANDLE ServiceHandle
,
1135 OUT BOOLEAN
*MediaPresent
1139 Create an IPv4 device path node.
1141 The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.
1142 The header subtype of IPv4 device path node is MSG_IPv4_DP.
1143 The length of the IPv4 device path node in bytes is 19.
1144 Get other information from parameters to make up the whole IPv4 device path node.
1146 @param[in, out] Node The pointer to the IPv4 device path node.
1147 @param[in] Controller The controller handle.
1148 @param[in] LocalIp The local IPv4 address.
1149 @param[in] LocalPort The local port.
1150 @param[in] RemoteIp The remote IPv4 address.
1151 @param[in] RemotePort The remote port.
1152 @param[in] Protocol The protocol type in the IP header.
1153 @param[in] UseDefaultAddress Whether this instance is using default address or not.
1158 NetLibCreateIPv4DPathNode (
1159 IN OUT IPv4_DEVICE_PATH
*Node
,
1160 IN EFI_HANDLE Controller
,
1161 IN IP4_ADDR LocalIp
,
1162 IN UINT16 LocalPort
,
1163 IN IP4_ADDR RemoteIp
,
1164 IN UINT16 RemotePort
,
1166 IN BOOLEAN UseDefaultAddress
1170 Create an IPv6 device path node.
1172 The header type of IPv6 device path node is MESSAGING_DEVICE_PATH.
1173 The header subtype of IPv6 device path node is MSG_IPv6_DP.
1174 The length of the IPv6 device path node in bytes is 43.
1175 Get other information from parameters to make up the whole IPv6 device path node.
1177 @param[in, out] Node The pointer to the IPv6 device path node.
1178 @param[in] Controller The controller handle.
1179 @param[in] LocalIp The local IPv6 address.
1180 @param[in] LocalPort The local port.
1181 @param[in] RemoteIp The remote IPv6 address.
1182 @param[in] RemotePort The remote port.
1183 @param[in] Protocol The protocol type in the IP header.
1188 NetLibCreateIPv6DPathNode (
1189 IN OUT IPv6_DEVICE_PATH
*Node
,
1190 IN EFI_HANDLE Controller
,
1191 IN EFI_IPv6_ADDRESS
*LocalIp
,
1192 IN UINT16 LocalPort
,
1193 IN EFI_IPv6_ADDRESS
*RemoteIp
,
1194 IN UINT16 RemotePort
,
1200 Find the UNDI/SNP handle from controller and protocol GUID.
1202 For example, IP will open an MNP child to transmit/receive
1203 packets. When MNP is stopped, IP should also be stopped. IP
1204 needs to find its own private data that is related the IP's
1205 service binding instance that is installed on the UNDI/SNP handle.
1206 The controller is then either an MNP or an ARP child handle. Note that
1207 IP opens these handles using BY_DRIVER. Use that infomation to get the
1210 @param[in] Controller The protocol handle to check.
1211 @param[in] ProtocolGuid The protocol that is related with the handle.
1213 @return The UNDI/SNP handle or NULL for errors.
1218 NetLibGetNicHandle (
1219 IN EFI_HANDLE Controller
,
1220 IN EFI_GUID
*ProtocolGuid
1224 This is the default unload handle for all the network drivers.
1226 Disconnect the driver specified by ImageHandle from all the devices in the handle database.
1227 Uninstall all the protocols installed in the driver entry point.
1229 @param[in] ImageHandle The drivers' driver image.
1231 @retval EFI_SUCCESS The image is unloaded.
1232 @retval Others Failed to unload the image.
1237 NetLibDefaultUnload (
1238 IN EFI_HANDLE ImageHandle
1242 Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.
1244 @param[in] String The pointer to the Ascii string.
1245 @param[out] Ip4Address The pointer to the converted IPv4 address.
1247 @retval EFI_SUCCESS Converted to an IPv4 address successfully.
1248 @retval EFI_INVALID_PARAMETER The string is malformated, or Ip4Address is NULL.
1253 NetLibAsciiStrToIp4 (
1254 IN CONST CHAR8
*String
,
1255 OUT EFI_IPv4_ADDRESS
*Ip4Address
1259 Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the
1260 string is defined in RFC 4291 - Text Pepresentation of Addresses.
1262 @param[in] String The pointer to the Ascii string.
1263 @param[out] Ip6Address The pointer to the converted IPv6 address.
1265 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1266 @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.
1271 NetLibAsciiStrToIp6 (
1272 IN CONST CHAR8
*String
,
1273 OUT EFI_IPv6_ADDRESS
*Ip6Address
1277 Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.
1279 @param[in] String The pointer to the Ascii string.
1280 @param[out] Ip4Address The pointer to the converted IPv4 address.
1282 @retval EFI_SUCCESS Converted to an IPv4 address successfully.
1283 @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.
1284 @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to lack of resources.
1290 IN CONST CHAR16
*String
,
1291 OUT EFI_IPv4_ADDRESS
*Ip4Address
1295 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of
1296 the string is defined in RFC 4291 - Text Pepresentation of Addresses.
1298 @param[in] String The pointer to the Ascii string.
1299 @param[out] Ip6Address The pointer to the converted IPv6 address.
1301 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1302 @retval EFI_INVALID_PARAMETER The string is malformated or Ip6Address is NULL.
1303 @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.
1309 IN CONST CHAR16
*String
,
1310 OUT EFI_IPv6_ADDRESS
*Ip6Address
1314 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.
1315 The format of the string is defined in RFC 4291 - Text Pepresentation of Addresses
1316 Prefixes: ipv6-address/prefix-length.
1318 @param[in] String The pointer to the Ascii string.
1319 @param[out] Ip6Address The pointer to the converted IPv6 address.
1320 @param[out] PrefixLength The pointer to the converted prefix length.
1322 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1323 @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.
1324 @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.
1329 NetLibStrToIp6andPrefix (
1330 IN CONST CHAR16
*String
,
1331 OUT EFI_IPv6_ADDRESS
*Ip6Address
,
1332 OUT UINT8
*PrefixLength
1336 // Various signatures
1338 #define NET_BUF_SIGNATURE SIGNATURE_32 ('n', 'b', 'u', 'f')
1339 #define NET_VECTOR_SIGNATURE SIGNATURE_32 ('n', 'v', 'e', 'c')
1340 #define NET_QUE_SIGNATURE SIGNATURE_32 ('n', 'b', 'q', 'u')
1343 #define NET_PROTO_DATA 64 // Opaque buffer for protocols
1344 #define NET_BUF_HEAD 1 // Trim or allocate space from head
1345 #define NET_BUF_TAIL 0 // Trim or allocate space from tail
1346 #define NET_VECTOR_OWN_FIRST 0x01 // We allocated the 1st block in the vector
1348 #define NET_CHECK_SIGNATURE(PData, SIGNATURE) \
1349 ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE)))
1352 // Single memory block in the vector.
1355 UINT32 Len
; // The block's length
1356 UINT8
*Bulk
; // The block's Data
1359 typedef VOID (EFIAPI
*NET_VECTOR_EXT_FREE
) (VOID
*Arg
);
1362 //NET_VECTOR contains several blocks to hold all packet's
1363 //fragments and other house-keeping stuff for sharing. It
1364 //doesn't specify the where actual packet fragment begins.
1368 INTN RefCnt
; // Reference count to share NET_VECTOR.
1369 NET_VECTOR_EXT_FREE Free
; // external function to free NET_VECTOR
1370 VOID
*Arg
; // opeque argument to Free
1371 UINT32 Flag
; // Flags, NET_VECTOR_OWN_FIRST
1372 UINT32 Len
; // Total length of the assocated BLOCKs
1379 //NET_BLOCK_OP operates on the NET_BLOCK. It specifies
1380 //where the actual fragment begins and ends
1383 UINT8
*BlockHead
; // Block's head, or the smallest valid Head
1384 UINT8
*BlockTail
; // Block's tail. BlockTail-BlockHead=block length
1385 UINT8
*Head
; // 1st byte of the data in the block
1386 UINT8
*Tail
; // Tail of the data in the block, Tail-Head=Size
1387 UINT32 Size
; // The size of the data
1392 EFI_IP6_HEADER
*Ip6
;
1396 //NET_BUF is the buffer manage structure used by the
1397 //network stack. Every network packet may be fragmented. The Vector points to
1398 //memory blocks used by each fragment, and BlockOp
1399 //specifies where each fragment begins and ends.
1401 //It also contains an opaque area for the protocol to store
1402 //per-packet information. Protocol must be careful not
1403 //to overwrite the members after that.
1408 LIST_ENTRY List
; // The List this NET_BUF is on
1410 NET_IP_HEAD Ip
; // Network layer header, for fast access
1411 TCP_HEAD
*Tcp
; // Transport layer header, for fast access
1412 EFI_UDP_HEADER
*Udp
; // User Datagram Protocol header
1413 UINT8 ProtoData
[NET_PROTO_DATA
]; //Protocol specific data
1415 NET_VECTOR
*Vector
; // The vector containing the packet
1417 UINT32 BlockOpNum
; // Total number of BlockOp in the buffer
1418 UINT32 TotalSize
; // Total size of the actual packet
1419 NET_BLOCK_OP BlockOp
[1]; // Specify the position of actual packet
1423 //A queue of NET_BUFs. It is a thin extension of
1424 //NET_BUF functions.
1429 LIST_ENTRY List
; // The List this buffer queue is on
1431 LIST_ENTRY BufList
; // list of queued buffers
1432 UINT32 BufSize
; // total length of DATA in the buffers
1433 UINT32 BufNum
; // total number of buffers on the chain
1437 // Pseudo header for TCP and UDP checksum
1449 EFI_IPv6_ADDRESS SrcIp
;
1450 EFI_IPv6_ADDRESS DstIp
;
1453 UINT32 NextHeader
:8;
1454 } NET_IP6_PSEUDO_HDR
;
1458 // The fragment entry table used in network interfaces. This is
1459 // the same as NET_BLOCK now. Use two different to distinguish
1460 // the two in case that NET_BLOCK be enhanced later.
1467 #define NET_GET_REF(PData) ((PData)->RefCnt++)
1468 #define NET_PUT_REF(PData) ((PData)->RefCnt--)
1469 #define NETBUF_FROM_PROTODATA(Info) BASE_CR((Info), NET_BUF, ProtoData)
1471 #define NET_BUF_SHARED(Buf) \
1472 (((Buf)->RefCnt > 1) || ((Buf)->Vector->RefCnt > 1))
1474 #define NET_VECTOR_SIZE(BlockNum) \
1475 (sizeof (NET_VECTOR) + ((BlockNum) - 1) * sizeof (NET_BLOCK))
1477 #define NET_BUF_SIZE(BlockOpNum) \
1478 (sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))
1480 #define NET_HEADSPACE(BlockOp) \
1481 (UINTN)((BlockOp)->Head - (BlockOp)->BlockHead)
1483 #define NET_TAILSPACE(BlockOp) \
1484 (UINTN)((BlockOp)->BlockTail - (BlockOp)->Tail)
1487 Allocate a single block NET_BUF. Upon allocation, all the
1488 free space is in the tail room.
1490 @param[in] Len The length of the block.
1492 @return The pointer to the allocated NET_BUF, or NULL if the
1493 allocation failed due to resource limitations.
1503 Free the net buffer and its associated NET_VECTOR.
1505 Decrease the reference count of the net buffer by one. Free the associated net
1506 vector and itself if the reference count of the net buffer is decreased to 0.
1507 The net vector free operation decreases the reference count of the net
1508 vector by one, and performs the resource free operation when the reference count
1509 of the net vector is 0.
1511 @param[in] Nbuf The pointer to the NET_BUF to be freed.
1521 Get the index of NET_BLOCK_OP that contains the byte at Offset in the net
1524 For example, this function can be used to retrieve the IP header in the packet. It
1525 also can be used to get the fragment that contains the byte used
1526 mainly by the library implementation itself.
1528 @param[in] Nbuf The pointer to the net buffer.
1529 @param[in] Offset The offset of the byte.
1530 @param[out] Index Index of the NET_BLOCK_OP that contains the byte at
1533 @return The pointer to the Offset'th byte of data in the net buffer, or NULL
1534 if there is no such data in the net buffer.
1542 OUT UINT32
*Index OPTIONAL
1546 Create a copy of the net buffer that shares the associated net vector.
1548 The reference count of the newly created net buffer is set to 1. The reference
1549 count of the associated net vector is increased by one.
1551 @param[in] Nbuf The pointer to the net buffer to be cloned.
1553 @return The pointer to the cloned net buffer, or NULL if the
1554 allocation failed due to resource limitations.
1564 Create a duplicated copy of the net buffer with data copied and HeadSpace
1565 bytes of head space reserved.
1567 The duplicated net buffer will allocate its own memory to hold the data of the
1570 @param[in] Nbuf The pointer to the net buffer to be duplicated from.
1571 @param[in, out] Duplicate The pointer to the net buffer to duplicate to. If
1572 NULL, a new net buffer is allocated.
1573 @param[in] HeadSpace The length of the head space to reserve.
1575 @return The pointer to the duplicated net buffer, or NULL if
1576 the allocation failed due to resource limitations.
1583 IN OUT NET_BUF
*Duplicate OPTIONAL
,
1588 Create a NET_BUF structure which contains Len byte data of Nbuf starting from
1591 A new NET_BUF structure will be created but the associated data in NET_VECTOR
1592 is shared. This function exists to perform IP packet fragmentation.
1594 @param[in] Nbuf The pointer to the net buffer to be extracted.
1595 @param[in] Offset Starting point of the data to be included in the new
1597 @param[in] Len The bytes of data to be included in the new net buffer.
1598 @param[in] HeadSpace The bytes of the head space to reserve for the protocol header.
1600 @return The pointer to the cloned net buffer, or NULL if the
1601 allocation failed due to resource limitations.
1614 Reserve some space in the header room of the net buffer.
1616 Upon allocation, all the space is in the tail room of the buffer. Call this
1617 function to move space to the header room. This function is quite limited
1618 in that it can only reserve space from the first block of an empty NET_BUF not
1619 built from the external. However, it should be enough for the network stack.
1621 @param[in, out] Nbuf The pointer to the net buffer.
1622 @param[in] Len The length of buffer to be reserved from the header.
1628 IN OUT NET_BUF
*Nbuf
,
1633 Allocate Len bytes of space from the header or tail of the buffer.
1635 @param[in, out] Nbuf The pointer to the net buffer.
1636 @param[in] Len The length of the buffer to be allocated.
1637 @param[in] FromHead The flag to indicate whether to reserve the data
1638 from head (TRUE) or tail (FALSE).
1640 @return The pointer to the first byte of the allocated buffer,
1641 or NULL, if there is no sufficient space.
1647 IN OUT NET_BUF
*Nbuf
,
1653 Trim Len bytes from the header or the tail of the net buffer.
1655 @param[in, out] Nbuf The pointer to the net buffer.
1656 @param[in] Len The length of the data to be trimmed.
1657 @param[in] FromHead The flag to indicate whether trim data is from the
1658 head (TRUE) or the tail (FALSE).
1660 @return The length of the actual trimmed data, which may be less
1661 than Len if the TotalSize of Nbuf is less than Len.
1667 IN OUT NET_BUF
*Nbuf
,
1673 Copy Len bytes of data from the specific offset of the net buffer to the
1676 The Len bytes of data may cross several fragments of the net buffer.
1678 @param[in] Nbuf The pointer to the net buffer.
1679 @param[in] Offset The sequence number of the first byte to copy.
1680 @param[in] Len The length of the data to copy.
1681 @param[in] Dest The destination of the data to copy to.
1683 @return The length of the actual copied data, or 0 if the offset
1684 specified exceeds the total size of net buffer.
1697 Build a NET_BUF from external blocks.
1699 A new NET_BUF structure will be created from external blocks. An additional block
1700 of memory will be allocated to hold reserved HeadSpace bytes of header room
1701 and existing HeadLen bytes of header, but the external blocks are shared by the
1702 net buffer to avoid data copying.
1704 @param[in] ExtFragment The pointer to the data block.
1705 @param[in] ExtNum The number of the data blocks.
1706 @param[in] HeadSpace The head space to be reserved.
1707 @param[in] HeadLen The length of the protocol header. The function
1708 pulls this amount of data into a linear block.
1709 @param[in] ExtFree The pointer to the caller-provided free function.
1710 @param[in] Arg The argument passed to ExtFree when ExtFree is
1713 @return The pointer to the net buffer built from the data blocks,
1714 or NULL if the allocation failed due to resource
1721 IN NET_FRAGMENT
*ExtFragment
,
1723 IN UINT32 HeadSpace
,
1725 IN NET_VECTOR_EXT_FREE ExtFree
,
1726 IN VOID
*Arg OPTIONAL
1730 Build a fragment table to contain the fragments in the net buffer. This is the
1731 opposite operation of the NetbufFromExt.
1733 @param[in] Nbuf Points to the net buffer.
1734 @param[in, out] ExtFragment The pointer to the data block.
1735 @param[in, out] ExtNum The number of the data blocks.
1737 @retval EFI_BUFFER_TOO_SMALL The number of non-empty blocks is bigger than
1739 @retval EFI_SUCCESS The fragment table was built successfully.
1746 IN OUT NET_FRAGMENT
*ExtFragment
,
1747 IN OUT UINT32
*ExtNum
1751 Build a net buffer from a list of net buffers.
1753 All the fragments will be collected from the list of NEW_BUF, and then a new
1754 net buffer will be created through NetbufFromExt.
1756 @param[in] BufList A List of the net buffer.
1757 @param[in] HeadSpace The head space to be reserved.
1758 @param[in] HeaderLen The length of the protocol header. The function
1759 pulls this amount of data into a linear block.
1760 @param[in] ExtFree The pointer to the caller provided free function.
1761 @param[in] Arg The argument passed to ExtFree when ExtFree is called.
1763 @return The pointer to the net buffer built from the list of net
1770 IN LIST_ENTRY
*BufList
,
1771 IN UINT32 HeadSpace
,
1772 IN UINT32 HeaderLen
,
1773 IN NET_VECTOR_EXT_FREE ExtFree
,
1774 IN VOID
*Arg OPTIONAL
1778 Free a list of net buffers.
1780 @param[in, out] Head The pointer to the head of linked net buffers.
1786 IN OUT LIST_ENTRY
*Head
1790 Initiate the net buffer queue.
1792 @param[in, out] NbufQue The pointer to the net buffer queue to be initialized.
1798 IN OUT NET_BUF_QUEUE
*NbufQue
1802 Allocate and initialize a net buffer queue.
1804 @return The pointer to the allocated net buffer queue, or NULL if the
1805 allocation failed due to resource limit.
1815 Free a net buffer queue.
1817 Decrease the reference count of the net buffer queue by one. The real resource
1818 free operation isn't performed until the reference count of the net buffer
1819 queue is decreased to 0.
1821 @param[in] NbufQue The pointer to the net buffer queue to be freed.
1827 IN NET_BUF_QUEUE
*NbufQue
1831 Remove a net buffer from the head in the specific queue and return it.
1833 @param[in, out] NbufQue The pointer to the net buffer queue.
1835 @return The pointer to the net buffer removed from the specific queue,
1836 or NULL if there is no net buffer in the specific queue.
1842 IN OUT NET_BUF_QUEUE
*NbufQue
1846 Append a net buffer to the net buffer queue.
1848 @param[in, out] NbufQue The pointer to the net buffer queue.
1849 @param[in, out] Nbuf The pointer to the net buffer to be appended.
1855 IN OUT NET_BUF_QUEUE
*NbufQue
,
1856 IN OUT NET_BUF
*Nbuf
1860 Copy Len bytes of data from the net buffer queue at the specific offset to the
1863 The copying operation is the same as NetbufCopy, but applies to the net buffer
1864 queue instead of the net buffer.
1866 @param[in] NbufQue The pointer to the net buffer queue.
1867 @param[in] Offset The sequence number of the first byte to copy.
1868 @param[in] Len The length of the data to copy.
1869 @param[out] Dest The destination of the data to copy to.
1871 @return The length of the actual copied data, or 0 if the offset
1872 specified exceeds the total size of net buffer queue.
1878 IN NET_BUF_QUEUE
*NbufQue
,
1885 Trim Len bytes of data from the buffer queue and free any net buffer
1886 that is completely trimmed.
1888 The trimming operation is the same as NetbufTrim but applies to the net buffer
1889 queue instead of the net buffer.
1891 @param[in, out] NbufQue The pointer to the net buffer queue.
1892 @param[in] Len The length of the data to trim.
1894 @return The actual length of the data trimmed.
1900 IN OUT NET_BUF_QUEUE
*NbufQue
,
1906 Flush the net buffer queue.
1908 @param[in, out] NbufQue The pointer to the queue to be flushed.
1914 IN OUT NET_BUF_QUEUE
*NbufQue
1918 Compute the checksum for a bulk of data.
1920 @param[in] Bulk The pointer to the data.
1921 @param[in] Len The length of the data, in bytes.
1923 @return The computed checksum.
1936 @param[in] Checksum1 The first checksum to be added.
1937 @param[in] Checksum2 The second checksum to be added.
1939 @return The new checksum.
1945 IN UINT16 Checksum1
,
1950 Compute the checksum for a NET_BUF.
1952 @param[in] Nbuf The pointer to the net buffer.
1954 @return The computed checksum.
1964 Compute the checksum for TCP/UDP pseudo header.
1966 Src and Dst are in network byte order, and Len is in host byte order.
1968 @param[in] Src The source address of the packet.
1969 @param[in] Dst The destination address of the packet.
1970 @param[in] Proto The protocol type of the packet.
1971 @param[in] Len The length of the packet.
1973 @return The computed checksum.
1978 NetPseudoHeadChecksum (
1986 Compute the checksum for the TCP6/UDP6 pseudo header.
1988 Src and Dst are in network byte order, and Len is in host byte order.
1990 @param[in] Src The source address of the packet.
1991 @param[in] Dst The destination address of the packet.
1992 @param[in] NextHeader The protocol type of the packet.
1993 @param[in] Len The length of the packet.
1995 @return The computed checksum.
2000 NetIp6PseudoHeadChecksum (
2001 IN EFI_IPv6_ADDRESS
*Src
,
2002 IN EFI_IPv6_ADDRESS
*Dst
,
2003 IN UINT8 NextHeader
,