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 - 2017, 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
40 #define DNS_MAX_NAME_SIZE 255
41 #define DNS_MAX_MESSAGE_SIZE 512
44 // The address classification
46 #define IP4_ADDR_CLASSA 1 // Deprecated
47 #define IP4_ADDR_CLASSB 2 // Deprecated
48 #define IP4_ADDR_CLASSC 3 // Deprecated
49 #define IP4_ADDR_CLASSD 4
50 #define IP4_ADDR_CLASSE 5
52 #define IP4_MASK_NUM 33
53 #define IP6_PREFIX_NUM 129
55 #define IP4_MASK_MAX 32
56 #define IP6_PREFIX_MAX 128
58 #define IP6_HOP_BY_HOP 0
59 #define IP6_DESTINATION 60
60 #define IP6_ROUTING 43
61 #define IP6_FRAGMENT 44
64 #define IP6_NO_NEXT_HEADER 59
66 #define IP_VERSION_4 4
67 #define IP_VERSION_6 6
69 #define IP6_PREFIX_LENGTH 64
76 #define DNS_TYPE_CNAME 5
77 #define DNS_TYPE_SOA 6
78 #define DNS_TYPE_WKS 11
79 #define DNS_TYPE_PTR 12
80 #define DNS_TYPE_HINFO 13
81 #define DNS_TYPE_MINFO 14
82 #define DNS_TYPE_MX 15
83 #define DNS_TYPE_TXT 16
84 #define DNS_TYPE_AAAA 28
85 #define DNS_TYPE_SRV_RR 33
86 #define DNS_TYPE_AXFR 252
87 #define DNS_TYPE_MAILB 253
88 #define DNS_TYPE_ANY 255
93 #define DNS_CLASS_INET 1
94 #define DNS_CLASS_CH 3
95 #define DNS_CLASS_HS 4
96 #define DNS_CLASS_ANY 255
101 // Ethernet head definition
104 UINT8 DstMac
[NET_ETHER_ADDR_LEN
];
105 UINT8 SrcMac
[NET_ETHER_ADDR_LEN
];
110 // 802.1Q VLAN Tag Control Information
114 UINT16 Vid
: 12; // Unique VLAN identifier (0 to 4094)
115 UINT16 Cfi
: 1; // Canonical Format Indicator
116 UINT16 Priority
: 3; // 802.1Q priority level (0 to 7)
121 #define VLAN_TCI_CFI_CANONICAL_MAC 0
122 #define VLAN_TCI_CFI_NON_CANONICAL_MAC 1
125 // The EFI_IP4_HEADER is hard to use because the source and
126 // destination address are defined as EFI_IPv4_ADDRESS, which
127 // is a structure. Two structures can't be compared or masked
128 // directly. This is why there is an internal representation.
146 // ICMP head definition. Each ICMP message is categorized as either an error
147 // message or query message. Two message types have their own head format.
157 UINT32 Fourth
; // 4th filed of the head, it depends on Type.
159 } IP4_ICMP_ERROR_HEAD
;
165 } IP4_ICMP_QUERY_HEAD
;
176 EFI_IP6_HEADER IpHead
;
177 } IP6_ICMP_ERROR_HEAD
;
182 } IP6_ICMP_INFORMATION_HEAD
;
185 // UDP header definition
195 // TCP header definition
212 #define NET_MAC_EQUAL(pMac1, pMac2, Len) \
213 (CompareMem ((pMac1), (pMac2), Len) == 0)
215 #define NET_MAC_IS_MULTICAST(Mac, BMac, Len) \
216 (((*((UINT8 *) Mac) & 0x01) == 0x01) && (!NET_MAC_EQUAL (Mac, BMac, Len)))
218 #define NTOHL(x) SwapBytes32 (x)
220 #define HTONL(x) NTOHL(x)
222 #define NTOHS(x) SwapBytes16 (x)
224 #define HTONS(x) NTOHS(x)
225 #define NTOHLL(x) SwapBytes64 (x)
226 #define HTONLL(x) NTOHLL(x)
227 #define NTOHLLL(x) Ip6Swap128 (x)
228 #define HTONLLL(x) NTOHLLL(x)
231 // Test the IP's attribute, All the IPs are in host byte order.
233 #define IP4_IS_MULTICAST(Ip) (((Ip) & 0xF0000000) == 0xE0000000)
234 #define IP4_IS_UNSPECIFIED(Ip) ((Ip) == 0)
235 #define IP4_IS_LOCAL_BROADCAST(Ip) ((Ip) == 0xFFFFFFFF)
236 #define IP4_NET_EQUAL(Ip1, Ip2, NetMask) (((Ip1) & (NetMask)) == ((Ip2) & (NetMask)))
237 #define IP4_IS_VALID_NETMASK(Ip) (NetGetMaskLength (Ip) != (IP4_MASK_MAX + 1))
239 #define IP6_IS_MULTICAST(Ip6) (((Ip6)->Addr[0]) == 0xFF)
242 // Convert the EFI_IP4_ADDRESS to plain UINT32 IP4 address.
244 #define EFI_IP4(EfiIpAddr) (*(IP4_ADDR *) ((EfiIpAddr).Addr))
245 #define EFI_NTOHL(EfiIp) (NTOHL (EFI_IP4 ((EfiIp))))
246 #define EFI_IP4_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv4_ADDRESS)) == 0)
248 #define EFI_IP6_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv6_ADDRESS)) == 0)
250 #define IP4_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv4_ADDRESS)))
251 #define IP6_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv6_ADDRESS)))
252 #define IP6_COPY_LINK_ADDRESS(Mac1, Mac2) (CopyMem ((Mac1), (Mac2), sizeof (EFI_MAC_ADDRESS)))
255 // The debug level definition. This value is also used as the
256 // syslog's severity level. Don't change it.
258 #define NETDEBUG_LEVEL_TRACE 5
259 #define NETDEBUG_LEVEL_WARNING 4
260 #define NETDEBUG_LEVEL_ERROR 3
263 // Network debug message is sent out as syslog packet.
265 #define NET_SYSLOG_FACILITY 16 // Syslog local facility local use
266 #define NET_SYSLOG_PACKET_LEN 512
267 #define NET_SYSLOG_TX_TIMEOUT (500 * 1000 * 10) // 500ms
268 #define NET_DEBUG_MSG_LEN 470 // 512 - (ether+ip4+udp4 head length)
271 // The debug output expects the ASCII format string, Use %a to print ASCII
272 // string, and %s to print UNICODE string. PrintArg must be enclosed in ().
273 // For example: NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name));
275 #define NET_DEBUG_TRACE(Module, PrintArg) \
277 NETDEBUG_LEVEL_TRACE, \
281 NetDebugASPrint PrintArg \
284 #define NET_DEBUG_WARNING(Module, PrintArg) \
286 NETDEBUG_LEVEL_WARNING, \
290 NetDebugASPrint PrintArg \
293 #define NET_DEBUG_ERROR(Module, PrintArg) \
295 NETDEBUG_LEVEL_ERROR, \
299 NetDebugASPrint PrintArg \
303 Allocate a buffer, then format the message to it. This is a
304 help function for the NET_DEBUG_XXX macros. The PrintArg of
305 these macros treats the variable length print parameters as a
306 single parameter, and pass it to the NetDebugASPrint. For
307 example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name))
311 NETDEBUG_LEVEL_TRACE,
315 NetDebugASPrint ("State transit to %a\n", Name)
318 @param Format The ASCII format string.
319 @param ... The variable length parameter whose format is determined
320 by the Format string.
322 @return The buffer containing the formatted message,
323 or NULL if memory allocation failed.
334 Builds an UDP4 syslog packet and send it using SNP.
336 This function will locate a instance of SNP then send the message through it.
337 Because it isn't open the SNP BY_DRIVER, apply caution when using it.
339 @param Level The severity level of the message.
340 @param Module The Module that generates the log.
341 @param File The file that contains the log.
342 @param Line The exact line that contains the log.
343 @param Message The user message to log.
345 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
346 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet
347 @retval EFI_SUCCESS The log is discard because that it is more verbose
348 than the mNetDebugLevelMax. Or, it has been sent out.
362 Return the length of the mask.
364 Return the length of the mask. Valid values are 0 to 32.
365 If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM.
366 NetMask is in the host byte order.
368 @param[in] NetMask The netmask to get the length from.
370 @return The length of the netmask, or IP4_MASK_NUM (33) if the mask is invalid.
380 Return the class of the IP address, such as class A, B, C.
381 Addr is in host byte order.
384 Classful addressing (IP class A/B/C) has been deprecated according to RFC4632.
385 Caller of this function could only check the returned value against
386 IP4_ADDR_CLASSD (multicast) or IP4_ADDR_CLASSE (reserved) now.
388 The address of class A starts with 0.
389 If the address belong to class A, return IP4_ADDR_CLASSA.
390 The address of class B starts with 10.
391 If the address belong to class B, return IP4_ADDR_CLASSB.
392 The address of class C starts with 110.
393 If the address belong to class C, return IP4_ADDR_CLASSC.
394 The address of class D starts with 1110.
395 If the address belong to class D, return IP4_ADDR_CLASSD.
396 The address of class E starts with 1111.
397 If the address belong to class E, return IP4_ADDR_CLASSE.
400 @param[in] Addr The address to get the class from.
402 @return IP address class, such as IP4_ADDR_CLASSA.
412 Check whether the IP is a valid unicast address according to
415 ASSERT if NetMask is zero.
417 If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address,
418 except when the originator is one of the endpoints of a point-to-point link with a 31-bit
421 @param[in] Ip The IP to check against.
422 @param[in] NetMask The mask of the IP.
424 @return TRUE if IP is a valid unicast address on the network, otherwise FALSE.
435 Check whether the incoming IPv6 address is a valid unicast address.
437 If the address is a multicast address has binary 0xFF at the start, it is not
438 a valid unicast address. If the address is unspecified ::, it is not a valid
439 unicast address to be assigned to any node. If the address is loopback address
440 ::1, it is also not a valid unicast address to be assigned to any physical
443 @param[in] Ip6 The IPv6 address to check against.
445 @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE.
450 NetIp6IsValidUnicast (
451 IN EFI_IPv6_ADDRESS
*Ip6
456 Check whether the incoming Ipv6 address is the unspecified address or not.
458 @param[in] Ip6 - Ip6 address, in network order.
460 @retval TRUE - Yes, incoming Ipv6 address is the unspecified address.
461 @retval FALSE - The incoming Ipv6 address is not the unspecified address
466 NetIp6IsUnspecifiedAddr (
467 IN EFI_IPv6_ADDRESS
*Ip6
471 Check whether the incoming Ipv6 address is a link-local address.
473 @param[in] Ip6 - Ip6 address, in network order.
475 @retval TRUE - The incoming Ipv6 address is a link-local address.
476 @retval FALSE - The incoming Ipv6 address is not a link-local address.
481 NetIp6IsLinkLocalAddr (
482 IN EFI_IPv6_ADDRESS
*Ip6
486 Check whether the Ipv6 address1 and address2 are on the connected network.
488 @param[in] Ip1 - Ip6 address1, in network order.
489 @param[in] Ip2 - Ip6 address2, in network order.
490 @param[in] PrefixLength - The prefix length of the checking net.
492 @retval TRUE - Yes, the Ipv6 address1 and address2 are connected.
493 @retval FALSE - No the Ipv6 address1 and address2 are not connected.
499 EFI_IPv6_ADDRESS
*Ip1
,
500 EFI_IPv6_ADDRESS
*Ip2
,
505 Switches the endianess of an IPv6 address.
507 This function swaps the bytes in a 128-bit IPv6 address to switch the value
508 from little endian to big endian or vice versa. The byte swapped value is
511 @param Ip6 Points to an IPv6 address.
513 @return The byte swapped IPv6 address.
519 EFI_IPv6_ADDRESS
*Ip6
522 extern IP4_ADDR gIp4AllMasks
[IP4_MASK_NUM
];
525 extern EFI_IPv4_ADDRESS mZeroIp4Addr
;
527 #define NET_IS_DIGIT(Ch) (('0' <= (Ch)) && ((Ch) <= '9'))
528 #define NET_IS_HEX(Ch) ((('0' <= (Ch)) && ((Ch) <= '9')) || (('A' <= (Ch)) && ((Ch) <= 'F')) || (('a' <= (Ch)) && ((Ch) <= 'f')))
529 #define NET_ROUNDUP(size, unit) (((size) + (unit) - 1) & (~((unit) - 1)))
530 #define NET_IS_LOWER_CASE_CHAR(Ch) (('a' <= (Ch)) && ((Ch) <= 'z'))
531 #define NET_IS_UPPER_CASE_CHAR(Ch) (('A' <= (Ch)) && ((Ch) <= 'Z'))
533 #define TICKS_PER_MS 10000U
534 #define TICKS_PER_SECOND 10000000U
536 #define NET_RANDOM(Seed) ((UINT32) ((UINT32) (Seed) * 1103515245UL + 12345) % 4294967295UL)
539 Extract a UINT32 from a byte stream.
541 This function copies a UINT32 from a byte stream, and then converts it from Network
542 byte order to host byte order. Use this function to avoid alignment error.
544 @param[in] Buf The buffer to extract the UINT32.
546 @return The UINT32 extracted.
556 Puts a UINT32 into the byte stream in network byte order.
558 Converts a UINT32 from host byte order to network byte order, then copies it to the
561 @param[in, out] Buf The buffer in which to put the UINT32.
562 @param[in] Data The data to be converted and put into the byte stream.
573 Initialize a random seed using current time and monotonic count.
575 Get current time and monotonic count first. Then initialize a random seed
576 based on some basic mathematics operation on the hour, day, minute, second,
577 nanosecond and year of the current time and the monotonic count value.
579 @return The random seed initialized with current time.
589 #define NET_LIST_USER_STRUCT(Entry, Type, Field) \
590 BASE_CR(Entry, Type, Field)
592 #define NET_LIST_USER_STRUCT_S(Entry, Type, Field, Sig) \
593 CR(Entry, Type, Field, Sig)
596 // Iterate through the double linked list. It is NOT delete safe
598 #define NET_LIST_FOR_EACH(Entry, ListHead) \
599 for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)
602 // Iterate through the double linked list. This is delete-safe.
603 // Don't touch NextEntry. Also, don't use this macro if list
604 // entries other than the Entry may be deleted when processing
605 // the current Entry.
607 #define NET_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead) \
608 for(Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink; \
609 Entry != (ListHead); \
610 Entry = NextEntry, NextEntry = Entry->ForwardLink \
614 // Make sure the list isn't empty before getting the first/last record.
616 #define NET_LIST_HEAD(ListHead, Type, Field) \
617 NET_LIST_USER_STRUCT((ListHead)->ForwardLink, Type, Field)
619 #define NET_LIST_TAIL(ListHead, Type, Field) \
620 NET_LIST_USER_STRUCT((ListHead)->BackLink, Type, Field)
624 Remove the first node entry on the list, and return the removed node entry.
626 Removes the first node entry from a doubly linked list. It is up to the caller of
627 this function to release the memory used by the first node, if that is required. On
628 exit, the removed node is returned.
630 If Head is NULL, then ASSERT().
631 If Head was not initialized, then ASSERT().
632 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
633 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
636 @param[in, out] Head The list header.
638 @return The first node entry that is removed from the list, NULL if the list is empty.
644 IN OUT LIST_ENTRY
*Head
648 Remove the last node entry on the list and return the removed node entry.
650 Removes the last node entry from a doubly linked list. It is up to the caller of
651 this function to release the memory used by the first node, if that is required. On
652 exit, the removed node is returned.
654 If Head is NULL, then ASSERT().
655 If Head was not initialized, then ASSERT().
656 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
657 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
660 @param[in, out] Head The list head.
662 @return The last node entry that is removed from the list, NULL if the list is empty.
668 IN OUT LIST_ENTRY
*Head
672 Insert a new node entry after a designated node entry of a doubly linked list.
674 Inserts a new node entry designated by NewEntry after the node entry designated by PrevEntry
675 of the doubly linked list.
677 @param[in, out] PrevEntry The entry after which to insert.
678 @param[in, out] NewEntry The new entry to insert.
684 IN OUT LIST_ENTRY
*PrevEntry
,
685 IN OUT LIST_ENTRY
*NewEntry
689 Insert a new node entry before a designated node entry of a doubly linked list.
691 Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry
692 of the doubly linked list.
694 @param[in, out] PostEntry The entry to insert before.
695 @param[in, out] NewEntry The new entry to insert.
700 NetListInsertBefore (
701 IN OUT LIST_ENTRY
*PostEntry
,
702 IN OUT LIST_ENTRY
*NewEntry
706 Callback function which provided by user to remove one node in NetDestroyLinkList process.
708 @param[in] Entry The entry to be removed.
709 @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.
711 @retval EFI_SUCCESS The entry has been removed successfully.
712 @retval Others Fail to remove the entry.
717 (EFIAPI
*NET_DESTROY_LINK_LIST_CALLBACK
) (
718 IN LIST_ENTRY
*Entry
,
719 IN VOID
*Context OPTIONAL
723 Safe destroy nodes in a linked list, and return the length of the list after all possible operations finished.
725 Destroy network children list by list traversals is not safe due to graph dependencies between nodes.
726 This function performs a safe traversal to destroy these nodes by checking to see if the node being destroyed
727 has been removed from the list or not.
728 If it has been removed, then restart the traversal from the head.
729 If it hasn't been removed, then continue with the next node directly.
730 This function will end the iterate and return the CallBack's last return value if error happens,
731 or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.
733 @param[in] List The head of the list.
734 @param[in] CallBack Pointer to the callback function to destroy one node in the list.
735 @param[in] Context Pointer to the callback function's context: corresponds to the
736 parameter Context in NET_DESTROY_LINK_LIST_CALLBACK.
737 @param[out] ListLength The length of the link list if the function returns successfully.
739 @retval EFI_SUCCESS Two complete passes are made with no changes in the number of children.
740 @retval EFI_INVALID_PARAMETER The input parameter is invalid.
741 @retval Others Return the CallBack's last return value.
748 IN NET_DESTROY_LINK_LIST_CALLBACK CallBack
,
749 IN VOID
*Context
, OPTIONAL
750 OUT UINTN
*ListLength OPTIONAL
754 This function checks the input Handle to see if it's one of these handles in ChildHandleBuffer.
756 @param[in] Handle Handle to be checked.
757 @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer.
758 @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
759 if NumberOfChildren is 0.
761 @retval TRUE Found the input Handle in ChildHandleBuffer.
762 @retval FALSE Can't find the input Handle in ChildHandleBuffer.
767 NetIsInHandleBuffer (
768 IN EFI_HANDLE Handle
,
769 IN UINTN NumberOfChildren
,
770 IN EFI_HANDLE
*ChildHandleBuffer OPTIONAL
774 // Object container: EFI network stack spec defines various kinds of
775 // tokens. The drivers can share code to manage those objects.
789 #define NET_MAP_INCREAMENT 64
792 Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.
794 Initialize the forward and backward links of two head nodes donated by Map->Used
795 and Map->Recycled of two doubly linked lists.
796 Initializes the count of the <Key, Value> pairs in the netmap to zero.
798 If Map is NULL, then ASSERT().
799 If the address of Map->Used is NULL, then ASSERT().
800 If the address of Map->Recycled is NULl, then ASSERT().
802 @param[in, out] Map The netmap to initialize.
812 To clean up the netmap, that is, release allocated memories.
814 Removes all nodes of the Used doubly linked list and frees memory of all related netmap items.
815 Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.
816 The number of the <Key, Value> pairs in the netmap is set to zero.
818 If Map is NULL, then ASSERT().
820 @param[in, out] Map The netmap to clean up.
830 Test whether the netmap is empty and return true if it is.
832 If the number of the <Key, Value> pairs in the netmap is zero, return TRUE.
834 If Map is NULL, then ASSERT().
837 @param[in] Map The net map to test.
839 @return TRUE if the netmap is empty, otherwise FALSE.
849 Return the number of the <Key, Value> pairs in the netmap.
851 @param[in] Map The netmap to get the entry number.
853 @return The entry number in the netmap.
863 Allocate an item to save the <Key, Value> pair to the head of the netmap.
865 Allocate an item to save the <Key, Value> pair and add corresponding node entry
866 to the beginning of the Used doubly linked list. The number of the <Key, Value>
867 pairs in the netmap increase by 1.
869 If Map is NULL, then ASSERT().
871 @param[in, out] Map The netmap to insert into.
872 @param[in] Key The user's key.
873 @param[in] Value The user's value for the key.
875 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
876 @retval EFI_SUCCESS The item is inserted to the head.
884 IN VOID
*Value OPTIONAL
888 Allocate an item to save the <Key, Value> pair to the tail of the netmap.
890 Allocate an item to save the <Key, Value> pair and add corresponding node entry
891 to the tail of the Used doubly linked list. The number of the <Key, Value>
892 pairs in the netmap increase by 1.
894 If Map is NULL, then ASSERT().
896 @param[in, out] Map The netmap to insert into.
897 @param[in] Key The user's key.
898 @param[in] Value The user's value for the key.
900 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
901 @retval EFI_SUCCESS The item is inserted to the tail.
909 IN VOID
*Value OPTIONAL
913 Finds the key in the netmap and returns the point to the item containing the Key.
915 Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every
916 item with the key to search. It returns the point to the item contains the Key if found.
918 If Map is NULL, then ASSERT().
920 @param[in] Map The netmap to search within.
921 @param[in] Key The key to search.
923 @return The point to the item contains the Key, or NULL if Key isn't in the map.
934 Remove the node entry of the item from the netmap and return the key of the removed item.
936 Remove the node entry of the item from the Used doubly linked list of the netmap.
937 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
938 entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL,
939 Value will point to the value of the item. It returns the key of the removed item.
941 If Map is NULL, then ASSERT().
942 If Item is NULL, then ASSERT().
943 if item in not in the netmap, then ASSERT().
945 @param[in, out] Map The netmap to remove the item from.
946 @param[in, out] Item The item to remove.
947 @param[out] Value The variable to receive the value if not NULL.
949 @return The key of the removed item.
956 IN OUT NET_MAP_ITEM
*Item
,
957 OUT VOID
**Value OPTIONAL
961 Remove the first node entry on the netmap and return the key of the removed item.
963 Remove the first node entry from the Used doubly linked list of the netmap.
964 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
965 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
966 parameter Value will point to the value of the item. It returns the key of the removed item.
968 If Map is NULL, then ASSERT().
969 If the Used doubly linked list is empty, then ASSERT().
971 @param[in, out] Map The netmap to remove the head from.
972 @param[out] Value The variable to receive the value if not NULL.
974 @return The key of the item removed.
981 OUT VOID
**Value OPTIONAL
985 Remove the last node entry on the netmap and return the key of the removed item.
987 Remove the last node entry from the Used doubly linked list of the netmap.
988 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
989 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
990 parameter Value will point to the value of the item. It returns the key of the removed item.
992 If Map is NULL, then ASSERT().
993 If the Used doubly linked list is empty, then ASSERT().
995 @param[in, out] Map The netmap to remove the tail from.
996 @param[out] Value The variable to receive the value if not NULL.
998 @return The key of the item removed.
1004 IN OUT NET_MAP
*Map
,
1005 OUT VOID
**Value OPTIONAL
1010 (EFIAPI
*NET_MAP_CALLBACK
) (
1012 IN NET_MAP_ITEM
*Item
,
1017 Iterate through the netmap and call CallBack for each item.
1019 It will continue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
1020 from the loop. It returns the CallBack's last return value. This function is
1021 delete safe for the current item.
1023 If Map is NULL, then ASSERT().
1024 If CallBack is NULL, then ASSERT().
1026 @param[in] Map The Map to iterate through.
1027 @param[in] CallBack The callback function to call for each item.
1028 @param[in] Arg The opaque parameter to the callback.
1030 @retval EFI_SUCCESS There is no item in the netmap, or CallBack for each item
1031 returns EFI_SUCCESS.
1032 @retval Others It returns the CallBack's last return value.
1039 IN NET_MAP_CALLBACK CallBack
,
1040 IN VOID
*Arg OPTIONAL
1045 // Helper functions to implement driver binding and service binding protocols.
1048 Create a child of the service that is identified by ServiceBindingGuid.
1050 Get the ServiceBinding Protocol first, then use it to create a child.
1052 If ServiceBindingGuid is NULL, then ASSERT().
1053 If ChildHandle is NULL, then ASSERT().
1055 @param[in] Controller The controller which has the service installed.
1056 @param[in] Image The image handle used to open service.
1057 @param[in] ServiceBindingGuid The service's Guid.
1058 @param[in, out] ChildHandle The handle to receive the created child.
1060 @retval EFI_SUCCESS The child was successfully created.
1061 @retval Others Failed to create the child.
1066 NetLibCreateServiceChild (
1067 IN EFI_HANDLE Controller
,
1068 IN EFI_HANDLE Image
,
1069 IN EFI_GUID
*ServiceBindingGuid
,
1070 IN OUT EFI_HANDLE
*ChildHandle
1074 Destroy a child of the service that is identified by ServiceBindingGuid.
1076 Get the ServiceBinding Protocol first, then use it to destroy a child.
1078 If ServiceBindingGuid is NULL, then ASSERT().
1080 @param[in] Controller The controller which has the service installed.
1081 @param[in] Image The image handle used to open service.
1082 @param[in] ServiceBindingGuid The service's Guid.
1083 @param[in] ChildHandle The child to destroy.
1085 @retval EFI_SUCCESS The child was destroyed.
1086 @retval Others Failed to destroy the child.
1091 NetLibDestroyServiceChild (
1092 IN EFI_HANDLE Controller
,
1093 IN EFI_HANDLE Image
,
1094 IN EFI_GUID
*ServiceBindingGuid
,
1095 IN EFI_HANDLE ChildHandle
1099 Get handle with Simple Network Protocol installed on it.
1101 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
1102 If Simple Network Protocol is already installed on the ServiceHandle, the
1103 ServiceHandle will be returned. If SNP is not installed on the ServiceHandle,
1104 try to find its parent handle with SNP installed.
1106 @param[in] ServiceHandle The handle where network service binding protocols are
1108 @param[out] Snp The pointer to store the address of the SNP instance.
1109 This is an optional parameter that may be NULL.
1111 @return The SNP handle, or NULL if not found.
1116 NetLibGetSnpHandle (
1117 IN EFI_HANDLE ServiceHandle
,
1118 OUT EFI_SIMPLE_NETWORK_PROTOCOL
**Snp OPTIONAL
1122 Retrieve VLAN ID of a VLAN device handle.
1124 Search VLAN device path node in Device Path of specified ServiceHandle and
1125 return its VLAN ID. If no VLAN device path node found, then this ServiceHandle
1126 is not a VLAN device handle, and 0 will be returned.
1128 @param[in] ServiceHandle The handle where network service binding protocols are
1131 @return VLAN ID of the device handle, or 0 if not a VLAN device.
1137 IN EFI_HANDLE ServiceHandle
1141 Find VLAN device handle with specified VLAN ID.
1143 The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle.
1144 This function will append VLAN device path node to the parent device path,
1145 and then use LocateDevicePath() to find the correct VLAN device handle.
1147 @param[in] ControllerHandle The handle where network service binding protocols are
1149 @param[in] VlanId The configured VLAN ID for the VLAN device.
1151 @return The VLAN device handle, or NULL if not found.
1156 NetLibGetVlanHandle (
1157 IN EFI_HANDLE ControllerHandle
,
1162 Get MAC address associated with the network service handle.
1164 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
1165 If SNP is installed on the ServiceHandle or its parent handle, MAC address will
1166 be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.
1168 @param[in] ServiceHandle The handle where network service binding protocols are
1170 @param[out] MacAddress The pointer to store the returned MAC address.
1171 @param[out] AddressSize The length of returned MAC address.
1173 @retval EFI_SUCCESS MAC address was returned successfully.
1174 @retval Others Failed to get SNP mode data.
1179 NetLibGetMacAddress (
1180 IN EFI_HANDLE ServiceHandle
,
1181 OUT EFI_MAC_ADDRESS
*MacAddress
,
1182 OUT UINTN
*AddressSize
1186 Convert MAC address of the NIC associated with specified Service Binding Handle
1187 to a unicode string. Callers are responsible for freeing the string storage.
1189 Locate simple network protocol associated with the Service Binding Handle and
1190 get the mac address from SNP. Then convert the mac address into a unicode
1191 string. It takes 2 unicode characters to represent a 1 byte binary buffer.
1192 Plus one unicode character for the null-terminator.
1194 @param[in] ServiceHandle The handle where network service binding protocol is
1196 @param[in] ImageHandle The image handle used to act as the agent handle to
1197 get the simple network protocol. This parameter is
1198 optional and may be NULL.
1199 @param[out] MacString The pointer to store the address of the string
1200 representation of the mac address.
1202 @retval EFI_SUCCESS Converted the mac address a unicode string successfully.
1203 @retval EFI_OUT_OF_RESOURCES There are not enough memory resources.
1204 @retval Others Failed to open the simple network protocol.
1209 NetLibGetMacString (
1210 IN EFI_HANDLE ServiceHandle
,
1211 IN EFI_HANDLE ImageHandle
, OPTIONAL
1212 OUT CHAR16
**MacString
1216 Detect media status for specified network device.
1218 The underlying UNDI driver may or may not support reporting media status from
1219 GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine
1220 will try to invoke Snp->GetStatus() to get the media status. If media is already
1221 present, it returns directly. If media is not present, it will stop SNP and then
1222 restart SNP to get the latest media status. This provides an opportunity to get
1223 the correct media status for old UNDI driver, which doesn't support reporting
1224 media status from GET_STATUS command.
1225 Note: there are two limitations for the current algorithm:
1226 1) For UNDI with this capability, when the cable is not attached, there will
1227 be an redundant Stop/Start() process.
1228 2) for UNDI without this capability, in case that network cable is attached when
1229 Snp->Initialize() is invoked while network cable is unattached later,
1230 NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer
1231 apps to wait for timeout time.
1233 @param[in] ServiceHandle The handle where network service binding protocols are
1235 @param[out] MediaPresent The pointer to store the media status.
1237 @retval EFI_SUCCESS Media detection success.
1238 @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle.
1239 @retval EFI_UNSUPPORTED The network device does not support media detection.
1240 @retval EFI_DEVICE_ERROR SNP is in an unknown state.
1246 IN EFI_HANDLE ServiceHandle
,
1247 OUT BOOLEAN
*MediaPresent
1251 Create an IPv4 device path node.
1253 The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.
1254 The header subtype of IPv4 device path node is MSG_IPv4_DP.
1255 The length of the IPv4 device path node in bytes is 19.
1256 Get other information from parameters to make up the whole IPv4 device path node.
1258 @param[in, out] Node The pointer to the IPv4 device path node.
1259 @param[in] Controller The controller handle.
1260 @param[in] LocalIp The local IPv4 address.
1261 @param[in] LocalPort The local port.
1262 @param[in] RemoteIp The remote IPv4 address.
1263 @param[in] RemotePort The remote port.
1264 @param[in] Protocol The protocol type in the IP header.
1265 @param[in] UseDefaultAddress Whether this instance is using default address or not.
1270 NetLibCreateIPv4DPathNode (
1271 IN OUT IPv4_DEVICE_PATH
*Node
,
1272 IN EFI_HANDLE Controller
,
1273 IN IP4_ADDR LocalIp
,
1274 IN UINT16 LocalPort
,
1275 IN IP4_ADDR RemoteIp
,
1276 IN UINT16 RemotePort
,
1278 IN BOOLEAN UseDefaultAddress
1282 Create an IPv6 device path node.
1284 The header type of IPv6 device path node is MESSAGING_DEVICE_PATH.
1285 The header subtype of IPv6 device path node is MSG_IPv6_DP.
1286 The length of the IPv6 device path node in bytes is 43.
1287 Get other information from parameters to make up the whole IPv6 device path node.
1289 @param[in, out] Node The pointer to the IPv6 device path node.
1290 @param[in] Controller The controller handle.
1291 @param[in] LocalIp The local IPv6 address.
1292 @param[in] LocalPort The local port.
1293 @param[in] RemoteIp The remote IPv6 address.
1294 @param[in] RemotePort The remote port.
1295 @param[in] Protocol The protocol type in the IP header.
1300 NetLibCreateIPv6DPathNode (
1301 IN OUT IPv6_DEVICE_PATH
*Node
,
1302 IN EFI_HANDLE Controller
,
1303 IN EFI_IPv6_ADDRESS
*LocalIp
,
1304 IN UINT16 LocalPort
,
1305 IN EFI_IPv6_ADDRESS
*RemoteIp
,
1306 IN UINT16 RemotePort
,
1312 Find the UNDI/SNP handle from controller and protocol GUID.
1314 For example, IP will open an MNP child to transmit/receive
1315 packets. When MNP is stopped, IP should also be stopped. IP
1316 needs to find its own private data that is related the IP's
1317 service binding instance that is installed on the UNDI/SNP handle.
1318 The controller is then either an MNP or an ARP child handle. Note that
1319 IP opens these handles using BY_DRIVER. Use that information to get the
1322 @param[in] Controller The protocol handle to check.
1323 @param[in] ProtocolGuid The protocol that is related with the handle.
1325 @return The UNDI/SNP handle or NULL for errors.
1330 NetLibGetNicHandle (
1331 IN EFI_HANDLE Controller
,
1332 IN EFI_GUID
*ProtocolGuid
1336 This is the default unload handle for all the network drivers.
1338 Disconnect the driver specified by ImageHandle from all the devices in the handle database.
1339 Uninstall all the protocols installed in the driver entry point.
1341 @param[in] ImageHandle The drivers' driver image.
1343 @retval EFI_SUCCESS The image is unloaded.
1344 @retval Others Failed to unload the image.
1349 NetLibDefaultUnload (
1350 IN EFI_HANDLE ImageHandle
1354 Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.
1356 @param[in] String The pointer to the Ascii string.
1357 @param[out] Ip4Address The pointer to the converted IPv4 address.
1359 @retval EFI_SUCCESS Converted to an IPv4 address successfully.
1360 @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip4Address is NULL.
1365 NetLibAsciiStrToIp4 (
1366 IN CONST CHAR8
*String
,
1367 OUT EFI_IPv4_ADDRESS
*Ip4Address
1371 Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the
1372 string is defined in RFC 4291 - Text Representation of Addresses.
1374 @param[in] String The pointer to the Ascii string.
1375 @param[out] Ip6Address The pointer to the converted IPv6 address.
1377 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1378 @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip6Address is NULL.
1383 NetLibAsciiStrToIp6 (
1384 IN CONST CHAR8
*String
,
1385 OUT EFI_IPv6_ADDRESS
*Ip6Address
1389 Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.
1391 @param[in] String The pointer to the Ascii string.
1392 @param[out] Ip4Address The pointer to the converted IPv4 address.
1394 @retval EFI_SUCCESS Converted to an IPv4 address successfully.
1395 @retval EFI_INVALID_PARAMETER The string is mal-formatted or Ip4Address is NULL.
1401 IN CONST CHAR16
*String
,
1402 OUT EFI_IPv4_ADDRESS
*Ip4Address
1406 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of
1407 the string is defined in RFC 4291 - Text Representation of Addresses.
1409 @param[in] String The pointer to the Ascii string.
1410 @param[out] Ip6Address The pointer to the converted IPv6 address.
1412 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1413 @retval EFI_INVALID_PARAMETER The string is malformatted or Ip6Address is NULL.
1419 IN CONST CHAR16
*String
,
1420 OUT EFI_IPv6_ADDRESS
*Ip6Address
1424 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.
1425 The format of the string is defined in RFC 4291 - Text Representation of Addresses
1426 Prefixes: ipv6-address/prefix-length.
1428 @param[in] String The pointer to the Ascii string.
1429 @param[out] Ip6Address The pointer to the converted IPv6 address.
1430 @param[out] PrefixLength The pointer to the converted prefix length.
1432 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1433 @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip6Address is NULL.
1438 NetLibStrToIp6andPrefix (
1439 IN CONST CHAR16
*String
,
1440 OUT EFI_IPv6_ADDRESS
*Ip6Address
,
1441 OUT UINT8
*PrefixLength
1446 Convert one EFI_IPv6_ADDRESS to Null-terminated Unicode string.
1447 The text representation of address is defined in RFC 4291.
1449 @param[in] Ip6Address The pointer to the IPv6 address.
1450 @param[out] String The buffer to return the converted string.
1451 @param[in] StringSize The length in bytes of the input String.
1453 @retval EFI_SUCCESS Convert to string successfully.
1454 @retval EFI_INVALID_PARAMETER The input parameter is invalid.
1455 @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result. BufferSize has been
1456 updated with the size needed to complete the request.
1461 IN EFI_IPv6_ADDRESS
*Ip6Address
,
1467 // Various signatures
1469 #define NET_BUF_SIGNATURE SIGNATURE_32 ('n', 'b', 'u', 'f')
1470 #define NET_VECTOR_SIGNATURE SIGNATURE_32 ('n', 'v', 'e', 'c')
1471 #define NET_QUE_SIGNATURE SIGNATURE_32 ('n', 'b', 'q', 'u')
1474 #define NET_PROTO_DATA 64 // Opaque buffer for protocols
1475 #define NET_BUF_HEAD 1 // Trim or allocate space from head
1476 #define NET_BUF_TAIL 0 // Trim or allocate space from tail
1477 #define NET_VECTOR_OWN_FIRST 0x01 // We allocated the 1st block in the vector
1479 #define NET_CHECK_SIGNATURE(PData, SIGNATURE) \
1480 ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE)))
1483 // Single memory block in the vector.
1486 UINT32 Len
; // The block's length
1487 UINT8
*Bulk
; // The block's Data
1490 typedef VOID (EFIAPI
*NET_VECTOR_EXT_FREE
) (VOID
*Arg
);
1493 //NET_VECTOR contains several blocks to hold all packet's
1494 //fragments and other house-keeping stuff for sharing. It
1495 //doesn't specify the where actual packet fragment begins.
1499 INTN RefCnt
; // Reference count to share NET_VECTOR.
1500 NET_VECTOR_EXT_FREE Free
; // external function to free NET_VECTOR
1501 VOID
*Arg
; // opaque argument to Free
1502 UINT32 Flag
; // Flags, NET_VECTOR_OWN_FIRST
1503 UINT32 Len
; // Total length of the associated BLOCKs
1510 //NET_BLOCK_OP operates on the NET_BLOCK. It specifies
1511 //where the actual fragment begins and ends
1514 UINT8
*BlockHead
; // Block's head, or the smallest valid Head
1515 UINT8
*BlockTail
; // Block's tail. BlockTail-BlockHead=block length
1516 UINT8
*Head
; // 1st byte of the data in the block
1517 UINT8
*Tail
; // Tail of the data in the block, Tail-Head=Size
1518 UINT32 Size
; // The size of the data
1523 EFI_IP6_HEADER
*Ip6
;
1527 //NET_BUF is the buffer manage structure used by the
1528 //network stack. Every network packet may be fragmented. The Vector points to
1529 //memory blocks used by each fragment, and BlockOp
1530 //specifies where each fragment begins and ends.
1532 //It also contains an opaque area for the protocol to store
1533 //per-packet information. Protocol must be careful not
1534 //to overwrite the members after that.
1539 LIST_ENTRY List
; // The List this NET_BUF is on
1541 NET_IP_HEAD Ip
; // Network layer header, for fast access
1542 TCP_HEAD
*Tcp
; // Transport layer header, for fast access
1543 EFI_UDP_HEADER
*Udp
; // User Datagram Protocol header
1544 UINT8 ProtoData
[NET_PROTO_DATA
]; //Protocol specific data
1546 NET_VECTOR
*Vector
; // The vector containing the packet
1548 UINT32 BlockOpNum
; // Total number of BlockOp in the buffer
1549 UINT32 TotalSize
; // Total size of the actual packet
1550 NET_BLOCK_OP BlockOp
[1]; // Specify the position of actual packet
1554 //A queue of NET_BUFs. It is a thin extension of
1555 //NET_BUF functions.
1560 LIST_ENTRY List
; // The List this buffer queue is on
1562 LIST_ENTRY BufList
; // list of queued buffers
1563 UINT32 BufSize
; // total length of DATA in the buffers
1564 UINT32 BufNum
; // total number of buffers on the chain
1568 // Pseudo header for TCP and UDP checksum
1580 EFI_IPv6_ADDRESS SrcIp
;
1581 EFI_IPv6_ADDRESS DstIp
;
1584 UINT32 NextHeader
:8;
1585 } NET_IP6_PSEUDO_HDR
;
1589 // The fragment entry table used in network interfaces. This is
1590 // the same as NET_BLOCK now. Use two different to distinguish
1591 // the two in case that NET_BLOCK be enhanced later.
1598 #define NET_GET_REF(PData) ((PData)->RefCnt++)
1599 #define NET_PUT_REF(PData) ((PData)->RefCnt--)
1600 #define NETBUF_FROM_PROTODATA(Info) BASE_CR((Info), NET_BUF, ProtoData)
1602 #define NET_BUF_SHARED(Buf) \
1603 (((Buf)->RefCnt > 1) || ((Buf)->Vector->RefCnt > 1))
1605 #define NET_VECTOR_SIZE(BlockNum) \
1606 (sizeof (NET_VECTOR) + ((BlockNum) - 1) * sizeof (NET_BLOCK))
1608 #define NET_BUF_SIZE(BlockOpNum) \
1609 (sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))
1611 #define NET_HEADSPACE(BlockOp) \
1612 ((UINTN)((BlockOp)->Head) - (UINTN)((BlockOp)->BlockHead))
1614 #define NET_TAILSPACE(BlockOp) \
1615 ((UINTN)((BlockOp)->BlockTail) - (UINTN)((BlockOp)->Tail))
1618 Allocate a single block NET_BUF. Upon allocation, all the
1619 free space is in the tail room.
1621 @param[in] Len The length of the block.
1623 @return The pointer to the allocated NET_BUF, or NULL if the
1624 allocation failed due to resource limitations.
1634 Free the net buffer and its associated NET_VECTOR.
1636 Decrease the reference count of the net buffer by one. Free the associated net
1637 vector and itself if the reference count of the net buffer is decreased to 0.
1638 The net vector free operation decreases the reference count of the net
1639 vector by one, and performs the resource free operation when the reference count
1640 of the net vector is 0.
1642 @param[in] Nbuf The pointer to the NET_BUF to be freed.
1652 Get the index of NET_BLOCK_OP that contains the byte at Offset in the net
1655 For example, this function can be used to retrieve the IP header in the packet. It
1656 also can be used to get the fragment that contains the byte used
1657 mainly by the library implementation itself.
1659 @param[in] Nbuf The pointer to the net buffer.
1660 @param[in] Offset The offset of the byte.
1661 @param[out] Index Index of the NET_BLOCK_OP that contains the byte at
1664 @return The pointer to the Offset'th byte of data in the net buffer, or NULL
1665 if there is no such data in the net buffer.
1673 OUT UINT32
*Index OPTIONAL
1677 Create a copy of the net buffer that shares the associated net vector.
1679 The reference count of the newly created net buffer is set to 1. The reference
1680 count of the associated net vector is increased by one.
1682 @param[in] Nbuf The pointer to the net buffer to be cloned.
1684 @return The pointer to the cloned net buffer, or NULL if the
1685 allocation failed due to resource limitations.
1695 Create a duplicated copy of the net buffer with data copied and HeadSpace
1696 bytes of head space reserved.
1698 The duplicated net buffer will allocate its own memory to hold the data of the
1701 @param[in] Nbuf The pointer to the net buffer to be duplicated from.
1702 @param[in, out] Duplicate The pointer to the net buffer to duplicate to. If
1703 NULL, a new net buffer is allocated.
1704 @param[in] HeadSpace The length of the head space to reserve.
1706 @return The pointer to the duplicated net buffer, or NULL if
1707 the allocation failed due to resource limitations.
1714 IN OUT NET_BUF
*Duplicate OPTIONAL
,
1719 Create a NET_BUF structure which contains Len byte data of Nbuf starting from
1722 A new NET_BUF structure will be created but the associated data in NET_VECTOR
1723 is shared. This function exists to perform IP packet fragmentation.
1725 @param[in] Nbuf The pointer to the net buffer to be extracted.
1726 @param[in] Offset Starting point of the data to be included in the new
1728 @param[in] Len The bytes of data to be included in the new net buffer.
1729 @param[in] HeadSpace The bytes of the head space to reserve for the protocol header.
1731 @return The pointer to the cloned net buffer, or NULL if the
1732 allocation failed due to resource limitations.
1745 Reserve some space in the header room of the net buffer.
1747 Upon allocation, all the space is in the tail room of the buffer. Call this
1748 function to move space to the header room. This function is quite limited
1749 in that it can only reserve space from the first block of an empty NET_BUF not
1750 built from the external. However, it should be enough for the network stack.
1752 @param[in, out] Nbuf The pointer to the net buffer.
1753 @param[in] Len The length of buffer to be reserved from the header.
1759 IN OUT NET_BUF
*Nbuf
,
1764 Allocate Len bytes of space from the header or tail of the buffer.
1766 @param[in, out] Nbuf The pointer to the net buffer.
1767 @param[in] Len The length of the buffer to be allocated.
1768 @param[in] FromHead The flag to indicate whether to reserve the data
1769 from head (TRUE) or tail (FALSE).
1771 @return The pointer to the first byte of the allocated buffer,
1772 or NULL, if there is no sufficient space.
1778 IN OUT NET_BUF
*Nbuf
,
1784 Trim Len bytes from the header or the tail of the net buffer.
1786 @param[in, out] Nbuf The pointer to the net buffer.
1787 @param[in] Len The length of the data to be trimmed.
1788 @param[in] FromHead The flag to indicate whether trim data is from the
1789 head (TRUE) or the tail (FALSE).
1791 @return The length of the actual trimmed data, which may be less
1792 than Len if the TotalSize of Nbuf is less than Len.
1798 IN OUT NET_BUF
*Nbuf
,
1804 Copy Len bytes of data from the specific offset of the net buffer to the
1807 The Len bytes of data may cross several fragments of the net buffer.
1809 @param[in] Nbuf The pointer to the net buffer.
1810 @param[in] Offset The sequence number of the first byte to copy.
1811 @param[in] Len The length of the data to copy.
1812 @param[in] Dest The destination of the data to copy to.
1814 @return The length of the actual copied data, or 0 if the offset
1815 specified exceeds the total size of net buffer.
1828 Build a NET_BUF from external blocks.
1830 A new NET_BUF structure will be created from external blocks. An additional block
1831 of memory will be allocated to hold reserved HeadSpace bytes of header room
1832 and existing HeadLen bytes of header, but the external blocks are shared by the
1833 net buffer to avoid data copying.
1835 @param[in] ExtFragment The pointer to the data block.
1836 @param[in] ExtNum The number of the data blocks.
1837 @param[in] HeadSpace The head space to be reserved.
1838 @param[in] HeadLen The length of the protocol header. The function
1839 pulls this amount of data into a linear block.
1840 @param[in] ExtFree The pointer to the caller-provided free function.
1841 @param[in] Arg The argument passed to ExtFree when ExtFree is
1844 @return The pointer to the net buffer built from the data blocks,
1845 or NULL if the allocation failed due to resource
1852 IN NET_FRAGMENT
*ExtFragment
,
1854 IN UINT32 HeadSpace
,
1856 IN NET_VECTOR_EXT_FREE ExtFree
,
1857 IN VOID
*Arg OPTIONAL
1861 Build a fragment table to contain the fragments in the net buffer. This is the
1862 opposite operation of the NetbufFromExt.
1864 @param[in] Nbuf Points to the net buffer.
1865 @param[in, out] ExtFragment The pointer to the data block.
1866 @param[in, out] ExtNum The number of the data blocks.
1868 @retval EFI_BUFFER_TOO_SMALL The number of non-empty blocks is bigger than
1870 @retval EFI_SUCCESS The fragment table was built successfully.
1877 IN OUT NET_FRAGMENT
*ExtFragment
,
1878 IN OUT UINT32
*ExtNum
1882 Build a net buffer from a list of net buffers.
1884 All the fragments will be collected from the list of NEW_BUF, and then a new
1885 net buffer will be created through NetbufFromExt.
1887 @param[in] BufList A List of the net buffer.
1888 @param[in] HeadSpace The head space to be reserved.
1889 @param[in] HeaderLen The length of the protocol header. The function
1890 pulls this amount of data into a linear block.
1891 @param[in] ExtFree The pointer to the caller provided free function.
1892 @param[in] Arg The argument passed to ExtFree when ExtFree is called.
1894 @return The pointer to the net buffer built from the list of net
1901 IN LIST_ENTRY
*BufList
,
1902 IN UINT32 HeadSpace
,
1903 IN UINT32 HeaderLen
,
1904 IN NET_VECTOR_EXT_FREE ExtFree
,
1905 IN VOID
*Arg OPTIONAL
1909 Free a list of net buffers.
1911 @param[in, out] Head The pointer to the head of linked net buffers.
1917 IN OUT LIST_ENTRY
*Head
1921 Initiate the net buffer queue.
1923 @param[in, out] NbufQue The pointer to the net buffer queue to be initialized.
1929 IN OUT NET_BUF_QUEUE
*NbufQue
1933 Allocate and initialize a net buffer queue.
1935 @return The pointer to the allocated net buffer queue, or NULL if the
1936 allocation failed due to resource limit.
1946 Free a net buffer queue.
1948 Decrease the reference count of the net buffer queue by one. The real resource
1949 free operation isn't performed until the reference count of the net buffer
1950 queue is decreased to 0.
1952 @param[in] NbufQue The pointer to the net buffer queue to be freed.
1958 IN NET_BUF_QUEUE
*NbufQue
1962 Remove a net buffer from the head in the specific queue and return it.
1964 @param[in, out] NbufQue The pointer to the net buffer queue.
1966 @return The pointer to the net buffer removed from the specific queue,
1967 or NULL if there is no net buffer in the specific queue.
1973 IN OUT NET_BUF_QUEUE
*NbufQue
1977 Append a net buffer to the net buffer queue.
1979 @param[in, out] NbufQue The pointer to the net buffer queue.
1980 @param[in, out] Nbuf The pointer to the net buffer to be appended.
1986 IN OUT NET_BUF_QUEUE
*NbufQue
,
1987 IN OUT NET_BUF
*Nbuf
1991 Copy Len bytes of data from the net buffer queue at the specific offset to the
1994 The copying operation is the same as NetbufCopy, but applies to the net buffer
1995 queue instead of the net buffer.
1997 @param[in] NbufQue The pointer to the net buffer queue.
1998 @param[in] Offset The sequence number of the first byte to copy.
1999 @param[in] Len The length of the data to copy.
2000 @param[out] Dest The destination of the data to copy to.
2002 @return The length of the actual copied data, or 0 if the offset
2003 specified exceeds the total size of net buffer queue.
2009 IN NET_BUF_QUEUE
*NbufQue
,
2016 Trim Len bytes of data from the buffer queue and free any net buffer
2017 that is completely trimmed.
2019 The trimming operation is the same as NetbufTrim but applies to the net buffer
2020 queue instead of the net buffer.
2022 @param[in, out] NbufQue The pointer to the net buffer queue.
2023 @param[in] Len The length of the data to trim.
2025 @return The actual length of the data trimmed.
2031 IN OUT NET_BUF_QUEUE
*NbufQue
,
2037 Flush the net buffer queue.
2039 @param[in, out] NbufQue The pointer to the queue to be flushed.
2045 IN OUT NET_BUF_QUEUE
*NbufQue
2049 Compute the checksum for a bulk of data.
2051 @param[in] Bulk The pointer to the data.
2052 @param[in] Len The length of the data, in bytes.
2054 @return The computed checksum.
2067 @param[in] Checksum1 The first checksum to be added.
2068 @param[in] Checksum2 The second checksum to be added.
2070 @return The new checksum.
2076 IN UINT16 Checksum1
,
2081 Compute the checksum for a NET_BUF.
2083 @param[in] Nbuf The pointer to the net buffer.
2085 @return The computed checksum.
2095 Compute the checksum for TCP/UDP pseudo header.
2097 Src and Dst are in network byte order, and Len is in host byte order.
2099 @param[in] Src The source address of the packet.
2100 @param[in] Dst The destination address of the packet.
2101 @param[in] Proto The protocol type of the packet.
2102 @param[in] Len The length of the packet.
2104 @return The computed checksum.
2109 NetPseudoHeadChecksum (
2117 Compute the checksum for the TCP6/UDP6 pseudo header.
2119 Src and Dst are in network byte order, and Len is in host byte order.
2121 @param[in] Src The source address of the packet.
2122 @param[in] Dst The destination address of the packet.
2123 @param[in] NextHeader The protocol type of the packet.
2124 @param[in] Len The length of the packet.
2126 @return The computed checksum.
2131 NetIp6PseudoHeadChecksum (
2132 IN EFI_IPv6_ADDRESS
*Src
,
2133 IN EFI_IPv6_ADDRESS
*Dst
,
2134 IN UINT8 NextHeader
,
2139 The function frees the net buffer which allocated by the IP protocol. It releases
2140 only the net buffer and doesn't call the external free function.
2142 This function should be called after finishing the process of mIpSec->ProcessExt()
2143 for outbound traffic. The (EFI_IPSEC2_PROTOCOL)->ProcessExt() allocates a new
2144 buffer for the ESP, so there needs a function to free the old net buffer.
2146 @param[in] Nbuf The network buffer to be freed.
2150 NetIpSecNetbufFree (
2155 This function obtains the system guid from the smbios table.
2157 @param[out] SystemGuid The pointer of the returned system guid.
2159 @retval EFI_SUCCESS Successfully obtained the system guid.
2160 @retval EFI_NOT_FOUND Did not find the SMBIOS table.
2165 NetLibGetSystemGuid (
2166 OUT EFI_GUID
*SystemGuid
2170 Create Dns QName according the queried domain name.
2171 QName is a domain name represented as a sequence of labels,
2172 where each label consists of a length octet followed by that
2173 number of octets. The QName terminates with the zero
2174 length octet for the null label of the root. Caller should
2175 take responsibility to free the buffer in returned pointer.
2177 @param DomainName The pointer to the queried domain name string.
2179 @retval NULL Failed to fill QName.
2180 @return QName filled successfully.
2185 NetLibCreateDnsQName (
2186 IN CHAR16
*DomainName