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 - 2018, 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
99 // Number of 100ns units time Interval for network media state detect
101 #define MEDIA_STATE_DETECT_TIME_INTERVAL 1000000U
107 // Ethernet head definition
110 UINT8 DstMac
[NET_ETHER_ADDR_LEN
];
111 UINT8 SrcMac
[NET_ETHER_ADDR_LEN
];
116 // 802.1Q VLAN Tag Control Information
120 UINT16 Vid
: 12; // Unique VLAN identifier (0 to 4094)
121 UINT16 Cfi
: 1; // Canonical Format Indicator
122 UINT16 Priority
: 3; // 802.1Q priority level (0 to 7)
127 #define VLAN_TCI_CFI_CANONICAL_MAC 0
128 #define VLAN_TCI_CFI_NON_CANONICAL_MAC 1
131 // The EFI_IP4_HEADER is hard to use because the source and
132 // destination address are defined as EFI_IPv4_ADDRESS, which
133 // is a structure. Two structures can't be compared or masked
134 // directly. This is why there is an internal representation.
152 // ICMP head definition. Each ICMP message is categorized as either an error
153 // message or query message. Two message types have their own head format.
163 UINT32 Fourth
; // 4th filed of the head, it depends on Type.
165 } IP4_ICMP_ERROR_HEAD
;
171 } IP4_ICMP_QUERY_HEAD
;
182 EFI_IP6_HEADER IpHead
;
183 } IP6_ICMP_ERROR_HEAD
;
188 } IP6_ICMP_INFORMATION_HEAD
;
191 // UDP header definition
201 // TCP header definition
218 #define NET_MAC_EQUAL(pMac1, pMac2, Len) \
219 (CompareMem ((pMac1), (pMac2), Len) == 0)
221 #define NET_MAC_IS_MULTICAST(Mac, BMac, Len) \
222 (((*((UINT8 *) Mac) & 0x01) == 0x01) && (!NET_MAC_EQUAL (Mac, BMac, Len)))
224 #define NTOHL(x) SwapBytes32 (x)
226 #define HTONL(x) NTOHL(x)
228 #define NTOHS(x) SwapBytes16 (x)
230 #define HTONS(x) NTOHS(x)
231 #define NTOHLL(x) SwapBytes64 (x)
232 #define HTONLL(x) NTOHLL(x)
233 #define NTOHLLL(x) Ip6Swap128 (x)
234 #define HTONLLL(x) NTOHLLL(x)
237 // Test the IP's attribute, All the IPs are in host byte order.
239 #define IP4_IS_MULTICAST(Ip) (((Ip) & 0xF0000000) == 0xE0000000)
240 #define IP4_IS_UNSPECIFIED(Ip) ((Ip) == 0)
241 #define IP4_IS_LOCAL_BROADCAST(Ip) ((Ip) == 0xFFFFFFFF)
242 #define IP4_NET_EQUAL(Ip1, Ip2, NetMask) (((Ip1) & (NetMask)) == ((Ip2) & (NetMask)))
243 #define IP4_IS_VALID_NETMASK(Ip) (NetGetMaskLength (Ip) != (IP4_MASK_MAX + 1))
245 #define IP6_IS_MULTICAST(Ip6) (((Ip6)->Addr[0]) == 0xFF)
248 // Convert the EFI_IP4_ADDRESS to plain UINT32 IP4 address.
250 #define EFI_IP4(EfiIpAddr) (*(IP4_ADDR *) ((EfiIpAddr).Addr))
251 #define EFI_NTOHL(EfiIp) (NTOHL (EFI_IP4 ((EfiIp))))
252 #define EFI_IP4_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv4_ADDRESS)) == 0)
254 #define EFI_IP6_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv6_ADDRESS)) == 0)
256 #define IP4_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv4_ADDRESS)))
257 #define IP6_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv6_ADDRESS)))
258 #define IP6_COPY_LINK_ADDRESS(Mac1, Mac2) (CopyMem ((Mac1), (Mac2), sizeof (EFI_MAC_ADDRESS)))
261 // The debug level definition. This value is also used as the
262 // syslog's severity level. Don't change it.
264 #define NETDEBUG_LEVEL_TRACE 5
265 #define NETDEBUG_LEVEL_WARNING 4
266 #define NETDEBUG_LEVEL_ERROR 3
269 // Network debug message is sent out as syslog packet.
271 #define NET_SYSLOG_FACILITY 16 // Syslog local facility local use
272 #define NET_SYSLOG_PACKET_LEN 512
273 #define NET_SYSLOG_TX_TIMEOUT (500 * 1000 * 10) // 500ms
274 #define NET_DEBUG_MSG_LEN 470 // 512 - (ether+ip4+udp4 head length)
277 // The debug output expects the ASCII format string, Use %a to print ASCII
278 // string, and %s to print UNICODE string. PrintArg must be enclosed in ().
279 // For example: NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name));
281 #define NET_DEBUG_TRACE(Module, PrintArg) \
283 NETDEBUG_LEVEL_TRACE, \
287 NetDebugASPrint PrintArg \
290 #define NET_DEBUG_WARNING(Module, PrintArg) \
292 NETDEBUG_LEVEL_WARNING, \
296 NetDebugASPrint PrintArg \
299 #define NET_DEBUG_ERROR(Module, PrintArg) \
301 NETDEBUG_LEVEL_ERROR, \
305 NetDebugASPrint PrintArg \
309 Allocate a buffer, then format the message to it. This is a
310 help function for the NET_DEBUG_XXX macros. The PrintArg of
311 these macros treats the variable length print parameters as a
312 single parameter, and pass it to the NetDebugASPrint. For
313 example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name))
317 NETDEBUG_LEVEL_TRACE,
321 NetDebugASPrint ("State transit to %a\n", Name)
324 @param Format The ASCII format string.
325 @param ... The variable length parameter whose format is determined
326 by the Format string.
328 @return The buffer containing the formatted message,
329 or NULL if memory allocation failed.
340 Builds an UDP4 syslog packet and send it using SNP.
342 This function will locate a instance of SNP then send the message through it.
343 Because it isn't open the SNP BY_DRIVER, apply caution when using it.
345 @param Level The severity level of the message.
346 @param Module The Module that generates the log.
347 @param File The file that contains the log.
348 @param Line The exact line that contains the log.
349 @param Message The user message to log.
351 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
352 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet
353 @retval EFI_SUCCESS The log is discard because that it is more verbose
354 than the mNetDebugLevelMax. Or, it has been sent out.
368 Return the length of the mask.
370 Return the length of the mask. Valid values are 0 to 32.
371 If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM.
372 NetMask is in the host byte order.
374 @param[in] NetMask The netmask to get the length from.
376 @return The length of the netmask, or IP4_MASK_NUM (33) if the mask is invalid.
386 Return the class of the IP address, such as class A, B, C.
387 Addr is in host byte order.
390 Classful addressing (IP class A/B/C) has been deprecated according to RFC4632.
391 Caller of this function could only check the returned value against
392 IP4_ADDR_CLASSD (multicast) or IP4_ADDR_CLASSE (reserved) now.
394 The address of class A starts with 0.
395 If the address belong to class A, return IP4_ADDR_CLASSA.
396 The address of class B starts with 10.
397 If the address belong to class B, return IP4_ADDR_CLASSB.
398 The address of class C starts with 110.
399 If the address belong to class C, return IP4_ADDR_CLASSC.
400 The address of class D starts with 1110.
401 If the address belong to class D, return IP4_ADDR_CLASSD.
402 The address of class E starts with 1111.
403 If the address belong to class E, return IP4_ADDR_CLASSE.
406 @param[in] Addr The address to get the class from.
408 @return IP address class, such as IP4_ADDR_CLASSA.
418 Check whether the IP is a valid unicast address according to
421 ASSERT if NetMask is zero.
423 If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address,
424 except when the originator is one of the endpoints of a point-to-point link with a 31-bit
427 @param[in] Ip The IP to check against.
428 @param[in] NetMask The mask of the IP.
430 @return TRUE if IP is a valid unicast address on the network, otherwise FALSE.
441 Check whether the incoming IPv6 address is a valid unicast address.
443 ASSERT if Ip6 is NULL.
445 If the address is a multicast address has binary 0xFF at the start, it is not
446 a valid unicast address. If the address is unspecified ::, it is not a valid
447 unicast address to be assigned to any node. If the address is loopback address
448 ::1, it is also not a valid unicast address to be assigned to any physical
451 @param[in] Ip6 The IPv6 address to check against.
453 @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE.
458 NetIp6IsValidUnicast (
459 IN EFI_IPv6_ADDRESS
*Ip6
464 Check whether the incoming Ipv6 address is the unspecified address or not.
466 ASSERT if Ip6 is NULL.
468 @param[in] Ip6 - Ip6 address, in network order.
470 @retval TRUE - Yes, incoming Ipv6 address is the unspecified address.
471 @retval FALSE - The incoming Ipv6 address is not the unspecified address
476 NetIp6IsUnspecifiedAddr (
477 IN EFI_IPv6_ADDRESS
*Ip6
481 Check whether the incoming Ipv6 address is a link-local address.
483 ASSERT if Ip6 is NULL.
485 @param[in] Ip6 - Ip6 address, in network order.
487 @retval TRUE - The incoming Ipv6 address is a link-local address.
488 @retval FALSE - The incoming Ipv6 address is not a link-local address.
493 NetIp6IsLinkLocalAddr (
494 IN EFI_IPv6_ADDRESS
*Ip6
498 Check whether the Ipv6 address1 and address2 are on the connected network.
500 ASSERT if Ip1 or Ip2 is NULL.
501 ASSERT if PrefixLength exceeds or equals to IP6_PREFIX_MAX.
503 @param[in] Ip1 - Ip6 address1, in network order.
504 @param[in] Ip2 - Ip6 address2, in network order.
505 @param[in] PrefixLength - The prefix length of the checking net.
507 @retval TRUE - Yes, the Ipv6 address1 and address2 are connected.
508 @retval FALSE - No the Ipv6 address1 and address2 are not connected.
514 EFI_IPv6_ADDRESS
*Ip1
,
515 EFI_IPv6_ADDRESS
*Ip2
,
520 Switches the endianess of an IPv6 address.
522 ASSERT if Ip6 is NULL.
524 This function swaps the bytes in a 128-bit IPv6 address to switch the value
525 from little endian to big endian or vice versa. The byte swapped value is
528 @param Ip6 Points to an IPv6 address.
530 @return The byte swapped IPv6 address.
536 EFI_IPv6_ADDRESS
*Ip6
539 extern IP4_ADDR gIp4AllMasks
[IP4_MASK_NUM
];
542 extern EFI_IPv4_ADDRESS mZeroIp4Addr
;
544 #define NET_IS_DIGIT(Ch) (('0' <= (Ch)) && ((Ch) <= '9'))
545 #define NET_IS_HEX(Ch) ((('0' <= (Ch)) && ((Ch) <= '9')) || (('A' <= (Ch)) && ((Ch) <= 'F')) || (('a' <= (Ch)) && ((Ch) <= 'f')))
546 #define NET_ROUNDUP(size, unit) (((size) + (unit) - 1) & (~((unit) - 1)))
547 #define NET_IS_LOWER_CASE_CHAR(Ch) (('a' <= (Ch)) && ((Ch) <= 'z'))
548 #define NET_IS_UPPER_CASE_CHAR(Ch) (('A' <= (Ch)) && ((Ch) <= 'Z'))
550 #define TICKS_PER_MS 10000U
551 #define TICKS_PER_SECOND 10000000U
553 #define NET_RANDOM(Seed) ((UINT32) ((UINT32) (Seed) * 1103515245UL + 12345) % 4294967295UL)
556 Extract a UINT32 from a byte stream.
558 ASSERT if Buf is NULL.
560 This function copies a UINT32 from a byte stream, and then converts it from Network
561 byte order to host byte order. Use this function to avoid alignment error.
563 @param[in] Buf The buffer to extract the UINT32.
565 @return The UINT32 extracted.
575 Puts a UINT32 into the byte stream in network byte order.
577 ASSERT if Buf is NULL.
579 Converts a UINT32 from host byte order to network byte order, then copies it to the
582 @param[in, out] Buf The buffer in which to put the UINT32.
583 @param[in] Data The data to be converted and put into the byte stream.
594 Initialize a random seed using current time and monotonic count.
596 Get current time and monotonic count first. Then initialize a random seed
597 based on some basic mathematics operation on the hour, day, minute, second,
598 nanosecond and year of the current time and the monotonic count value.
600 @return The random seed initialized with current time.
610 #define NET_LIST_USER_STRUCT(Entry, Type, Field) \
611 BASE_CR(Entry, Type, Field)
613 #define NET_LIST_USER_STRUCT_S(Entry, Type, Field, Sig) \
614 CR(Entry, Type, Field, Sig)
617 // Iterate through the double linked list. It is NOT delete safe
619 #define NET_LIST_FOR_EACH(Entry, ListHead) \
620 for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)
623 // Iterate through the double linked list. This is delete-safe.
624 // Don't touch NextEntry. Also, don't use this macro if list
625 // entries other than the Entry may be deleted when processing
626 // the current Entry.
628 #define NET_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead) \
629 for(Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink; \
630 Entry != (ListHead); \
631 Entry = NextEntry, NextEntry = Entry->ForwardLink \
635 // Make sure the list isn't empty before getting the first/last record.
637 #define NET_LIST_HEAD(ListHead, Type, Field) \
638 NET_LIST_USER_STRUCT((ListHead)->ForwardLink, Type, Field)
640 #define NET_LIST_TAIL(ListHead, Type, Field) \
641 NET_LIST_USER_STRUCT((ListHead)->BackLink, Type, Field)
645 Remove the first node entry on the list, and return the removed node entry.
647 Removes the first node entry from a doubly linked list. It is up to the caller of
648 this function to release the memory used by the first node, if that is required. On
649 exit, the removed node is returned.
651 If Head is NULL, then ASSERT().
652 If Head was not initialized, then ASSERT().
653 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
654 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
657 @param[in, out] Head The list header.
659 @return The first node entry that is removed from the list, NULL if the list is empty.
665 IN OUT LIST_ENTRY
*Head
669 Remove the last node entry on the list and return the removed node entry.
671 Removes the last node entry from a doubly linked list. It is up to the caller of
672 this function to release the memory used by the first node, if that is required. On
673 exit, the removed node is returned.
675 If Head is NULL, then ASSERT().
676 If Head was not initialized, then ASSERT().
677 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
678 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
681 @param[in, out] Head The list head.
683 @return The last node entry that is removed from the list, NULL if the list is empty.
689 IN OUT LIST_ENTRY
*Head
693 Insert a new node entry after a designated node entry of a doubly linked list.
695 ASSERT if PrevEntry or NewEntry is NULL.
697 Inserts a new node entry designated by NewEntry after the node entry designated by PrevEntry
698 of the doubly linked list.
700 @param[in, out] PrevEntry The entry after which to insert.
701 @param[in, out] NewEntry The new entry to insert.
707 IN OUT LIST_ENTRY
*PrevEntry
,
708 IN OUT LIST_ENTRY
*NewEntry
712 Insert a new node entry before a designated node entry of a doubly linked list.
714 ASSERT if PostEntry or NewEntry is NULL.
716 Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry
717 of the doubly linked list.
719 @param[in, out] PostEntry The entry to insert before.
720 @param[in, out] NewEntry The new entry to insert.
725 NetListInsertBefore (
726 IN OUT LIST_ENTRY
*PostEntry
,
727 IN OUT LIST_ENTRY
*NewEntry
731 Callback function which provided by user to remove one node in NetDestroyLinkList process.
733 @param[in] Entry The entry to be removed.
734 @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.
736 @retval EFI_SUCCESS The entry has been removed successfully.
737 @retval Others Fail to remove the entry.
742 (EFIAPI
*NET_DESTROY_LINK_LIST_CALLBACK
) (
743 IN LIST_ENTRY
*Entry
,
744 IN VOID
*Context OPTIONAL
748 Safe destroy nodes in a linked list, and return the length of the list after all possible operations finished.
750 Destroy network children list by list traversals is not safe due to graph dependencies between nodes.
751 This function performs a safe traversal to destroy these nodes by checking to see if the node being destroyed
752 has been removed from the list or not.
753 If it has been removed, then restart the traversal from the head.
754 If it hasn't been removed, then continue with the next node directly.
755 This function will end the iterate and return the CallBack's last return value if error happens,
756 or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.
758 @param[in] List The head of the list.
759 @param[in] CallBack Pointer to the callback function to destroy one node in the list.
760 @param[in] Context Pointer to the callback function's context: corresponds to the
761 parameter Context in NET_DESTROY_LINK_LIST_CALLBACK.
762 @param[out] ListLength The length of the link list if the function returns successfully.
764 @retval EFI_SUCCESS Two complete passes are made with no changes in the number of children.
765 @retval EFI_INVALID_PARAMETER The input parameter is invalid.
766 @retval Others Return the CallBack's last return value.
773 IN NET_DESTROY_LINK_LIST_CALLBACK CallBack
,
774 IN VOID
*Context
, OPTIONAL
775 OUT UINTN
*ListLength OPTIONAL
779 This function checks the input Handle to see if it's one of these handles in ChildHandleBuffer.
781 @param[in] Handle Handle to be checked.
782 @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer.
783 @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
784 if NumberOfChildren is 0.
786 @retval TRUE Found the input Handle in ChildHandleBuffer.
787 @retval FALSE Can't find the input Handle in ChildHandleBuffer.
792 NetIsInHandleBuffer (
793 IN EFI_HANDLE Handle
,
794 IN UINTN NumberOfChildren
,
795 IN EFI_HANDLE
*ChildHandleBuffer OPTIONAL
799 // Object container: EFI network stack spec defines various kinds of
800 // tokens. The drivers can share code to manage those objects.
814 #define NET_MAP_INCREAMENT 64
817 Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.
819 Initialize the forward and backward links of two head nodes donated by Map->Used
820 and Map->Recycled of two doubly linked lists.
821 Initializes the count of the <Key, Value> pairs in the netmap to zero.
823 If Map is NULL, then ASSERT().
824 If the address of Map->Used is NULL, then ASSERT().
825 If the address of Map->Recycled is NULl, then ASSERT().
827 @param[in, out] Map The netmap to initialize.
837 To clean up the netmap, that is, release allocated memories.
839 Removes all nodes of the Used doubly linked list and frees memory of all related netmap items.
840 Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.
841 The number of the <Key, Value> pairs in the netmap is set to zero.
843 If Map is NULL, then ASSERT().
845 @param[in, out] Map The netmap to clean up.
855 Test whether the netmap is empty and return true if it is.
857 If the number of the <Key, Value> pairs in the netmap is zero, return TRUE.
859 If Map is NULL, then ASSERT().
861 @param[in] Map The net map to test.
863 @return TRUE if the netmap is empty, otherwise FALSE.
873 Return the number of the <Key, Value> pairs in the netmap.
875 If Map is NULL, then ASSERT().
877 @param[in] Map The netmap to get the entry number.
879 @return The entry number in the netmap.
889 Allocate an item to save the <Key, Value> pair to the head of the netmap.
891 Allocate an item to save the <Key, Value> pair and add corresponding node entry
892 to the beginning of the Used doubly linked list. The number of the <Key, Value>
893 pairs in the netmap increase by 1.
895 If Map is NULL, then ASSERT().
896 If Key is NULL, then ASSERT().
898 @param[in, out] Map The netmap to insert into.
899 @param[in] Key The user's key.
900 @param[in] Value The user's value for the key.
902 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
903 @retval EFI_SUCCESS The item is inserted to the head.
911 IN VOID
*Value OPTIONAL
915 Allocate an item to save the <Key, Value> pair to the tail of the netmap.
917 Allocate an item to save the <Key, Value> pair and add corresponding node entry
918 to the tail of the Used doubly linked list. The number of the <Key, Value>
919 pairs in the netmap increase by 1.
921 If Map is NULL, then ASSERT().
922 If Key is NULL, then ASSERT().
924 @param[in, out] Map The netmap to insert into.
925 @param[in] Key The user's key.
926 @param[in] Value The user's value for the key.
928 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
929 @retval EFI_SUCCESS The item is inserted to the tail.
937 IN VOID
*Value OPTIONAL
941 Finds the key in the netmap and returns the point to the item containing the Key.
943 Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every
944 item with the key to search. It returns the point to the item contains the Key if found.
946 If Map is NULL, then ASSERT().
947 If Key is NULL, then ASSERT().
949 @param[in] Map The netmap to search within.
950 @param[in] Key The key to search.
952 @return The point to the item contains the Key, or NULL if Key isn't in the map.
963 Remove the node entry of the item from the netmap and return the key of the removed item.
965 Remove the node entry of the item from the Used doubly linked list of the netmap.
966 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
967 entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL,
968 Value will point to the value of the item. It returns the key of the removed item.
970 If Map is NULL, then ASSERT().
971 If Item is NULL, then ASSERT().
972 if item in not in the netmap, then ASSERT().
974 @param[in, out] Map The netmap to remove the item from.
975 @param[in, out] Item The item to remove.
976 @param[out] Value The variable to receive the value if not NULL.
978 @return The key of the removed item.
985 IN OUT NET_MAP_ITEM
*Item
,
986 OUT VOID
**Value OPTIONAL
990 Remove the first node entry on the netmap and return the key of the removed item.
992 Remove the first node entry from the Used doubly linked list of the netmap.
993 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
994 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
995 parameter Value will point to the value of the item. It returns the key of the removed item.
997 If Map is NULL, then ASSERT().
998 If the Used doubly linked list is empty, then ASSERT().
1000 @param[in, out] Map The netmap to remove the head from.
1001 @param[out] Value The variable to receive the value if not NULL.
1003 @return The key of the item removed.
1009 IN OUT NET_MAP
*Map
,
1010 OUT VOID
**Value OPTIONAL
1014 Remove the last node entry on the netmap and return the key of the removed item.
1016 Remove the last node entry from the Used doubly linked list of the netmap.
1017 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
1018 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
1019 parameter Value will point to the value of the item. It returns the key of the removed item.
1021 If Map is NULL, then ASSERT().
1022 If the Used doubly linked list is empty, then ASSERT().
1024 @param[in, out] Map The netmap to remove the tail from.
1025 @param[out] Value The variable to receive the value if not NULL.
1027 @return The key of the item removed.
1033 IN OUT NET_MAP
*Map
,
1034 OUT VOID
**Value OPTIONAL
1039 (EFIAPI
*NET_MAP_CALLBACK
) (
1041 IN NET_MAP_ITEM
*Item
,
1046 Iterate through the netmap and call CallBack for each item.
1048 It will continue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
1049 from the loop. It returns the CallBack's last return value. This function is
1050 delete safe for the current item.
1052 If Map is NULL, then ASSERT().
1053 If CallBack is NULL, then ASSERT().
1055 @param[in] Map The Map to iterate through.
1056 @param[in] CallBack The callback function to call for each item.
1057 @param[in] Arg The opaque parameter to the callback.
1059 @retval EFI_SUCCESS There is no item in the netmap, or CallBack for each item
1060 returns EFI_SUCCESS.
1061 @retval Others It returns the CallBack's last return value.
1068 IN NET_MAP_CALLBACK CallBack
,
1069 IN VOID
*Arg OPTIONAL
1074 // Helper functions to implement driver binding and service binding protocols.
1077 Create a child of the service that is identified by ServiceBindingGuid.
1079 Get the ServiceBinding Protocol first, then use it to create a child.
1081 If ServiceBindingGuid is NULL, then ASSERT().
1082 If ChildHandle is NULL, then ASSERT().
1084 @param[in] Controller The controller which has the service installed.
1085 @param[in] Image The image handle used to open service.
1086 @param[in] ServiceBindingGuid The service's Guid.
1087 @param[in, out] ChildHandle The handle to receive the created child.
1089 @retval EFI_SUCCESS The child was successfully created.
1090 @retval Others Failed to create the child.
1095 NetLibCreateServiceChild (
1096 IN EFI_HANDLE Controller
,
1097 IN EFI_HANDLE Image
,
1098 IN EFI_GUID
*ServiceBindingGuid
,
1099 IN OUT EFI_HANDLE
*ChildHandle
1103 Destroy a child of the service that is identified by ServiceBindingGuid.
1105 Get the ServiceBinding Protocol first, then use it to destroy a child.
1107 If ServiceBindingGuid is NULL, then ASSERT().
1109 @param[in] Controller The controller which has the service installed.
1110 @param[in] Image The image handle used to open service.
1111 @param[in] ServiceBindingGuid The service's Guid.
1112 @param[in] ChildHandle The child to destroy.
1114 @retval EFI_SUCCESS The child was destroyed.
1115 @retval Others Failed to destroy the child.
1120 NetLibDestroyServiceChild (
1121 IN EFI_HANDLE Controller
,
1122 IN EFI_HANDLE Image
,
1123 IN EFI_GUID
*ServiceBindingGuid
,
1124 IN EFI_HANDLE ChildHandle
1128 Get handle with Simple Network Protocol installed on it.
1130 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
1131 If Simple Network Protocol is already installed on the ServiceHandle, the
1132 ServiceHandle will be returned. If SNP is not installed on the ServiceHandle,
1133 try to find its parent handle with SNP installed.
1135 @param[in] ServiceHandle The handle where network service binding protocols are
1137 @param[out] Snp The pointer to store the address of the SNP instance.
1138 This is an optional parameter that may be NULL.
1140 @return The SNP handle, or NULL if not found.
1145 NetLibGetSnpHandle (
1146 IN EFI_HANDLE ServiceHandle
,
1147 OUT EFI_SIMPLE_NETWORK_PROTOCOL
**Snp OPTIONAL
1151 Retrieve VLAN ID of a VLAN device handle.
1153 Search VLAN device path node in Device Path of specified ServiceHandle and
1154 return its VLAN ID. If no VLAN device path node found, then this ServiceHandle
1155 is not a VLAN device handle, and 0 will be returned.
1157 @param[in] ServiceHandle The handle where network service binding protocols are
1160 @return VLAN ID of the device handle, or 0 if not a VLAN device.
1166 IN EFI_HANDLE ServiceHandle
1170 Find VLAN device handle with specified VLAN ID.
1172 The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle.
1173 This function will append VLAN device path node to the parent device path,
1174 and then use LocateDevicePath() to find the correct VLAN device handle.
1176 @param[in] ControllerHandle The handle where network service binding protocols are
1178 @param[in] VlanId The configured VLAN ID for the VLAN device.
1180 @return The VLAN device handle, or NULL if not found.
1185 NetLibGetVlanHandle (
1186 IN EFI_HANDLE ControllerHandle
,
1191 Get MAC address associated with the network service handle.
1193 If MacAddress is NULL, then ASSERT().
1194 If AddressSize is NULL, then ASSERT().
1196 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
1197 If SNP is installed on the ServiceHandle or its parent handle, MAC address will
1198 be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.
1200 @param[in] ServiceHandle The handle where network service binding protocols are
1202 @param[out] MacAddress The pointer to store the returned MAC address.
1203 @param[out] AddressSize The length of returned MAC address.
1205 @retval EFI_SUCCESS MAC address was returned successfully.
1206 @retval Others Failed to get SNP mode data.
1211 NetLibGetMacAddress (
1212 IN EFI_HANDLE ServiceHandle
,
1213 OUT EFI_MAC_ADDRESS
*MacAddress
,
1214 OUT UINTN
*AddressSize
1218 Convert MAC address of the NIC associated with specified Service Binding Handle
1219 to a unicode string. Callers are responsible for freeing the string storage.
1221 If MacString is NULL, then ASSERT().
1223 Locate simple network protocol associated with the Service Binding Handle and
1224 get the mac address from SNP. Then convert the mac address into a unicode
1225 string. It takes 2 unicode characters to represent a 1 byte binary buffer.
1226 Plus one unicode character for the null-terminator.
1228 @param[in] ServiceHandle The handle where network service binding protocol is
1230 @param[in] ImageHandle The image handle used to act as the agent handle to
1231 get the simple network protocol. This parameter is
1232 optional and may be NULL.
1233 @param[out] MacString The pointer to store the address of the string
1234 representation of the mac address.
1236 @retval EFI_SUCCESS Converted the mac address a unicode string successfully.
1237 @retval EFI_OUT_OF_RESOURCES There are not enough memory resources.
1238 @retval Others Failed to open the simple network protocol.
1243 NetLibGetMacString (
1244 IN EFI_HANDLE ServiceHandle
,
1245 IN EFI_HANDLE ImageHandle
, OPTIONAL
1246 OUT CHAR16
**MacString
1250 Detect media status for specified network device.
1252 If MediaPresent is NULL, then ASSERT().
1254 The underlying UNDI driver may or may not support reporting media status from
1255 GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine
1256 will try to invoke Snp->GetStatus() to get the media status. If media is already
1257 present, it returns directly. If media is not present, it will stop SNP and then
1258 restart SNP to get the latest media status. This provides an opportunity to get
1259 the correct media status for old UNDI driver, which doesn't support reporting
1260 media status from GET_STATUS command.
1261 Note: there are two limitations for the current algorithm:
1262 1) For UNDI with this capability, when the cable is not attached, there will
1263 be an redundant Stop/Start() process.
1264 2) for UNDI without this capability, in case that network cable is attached when
1265 Snp->Initialize() is invoked while network cable is unattached later,
1266 NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer
1267 apps to wait for timeout time.
1269 @param[in] ServiceHandle The handle where network service binding protocols are
1271 @param[out] MediaPresent The pointer to store the media status.
1273 @retval EFI_SUCCESS Media detection success.
1274 @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle.
1275 @retval EFI_UNSUPPORTED The network device does not support media detection.
1276 @retval EFI_DEVICE_ERROR SNP is in an unknown state.
1282 IN EFI_HANDLE ServiceHandle
,
1283 OUT BOOLEAN
*MediaPresent
1287 Detect media state for a network device. This routine will wait for a period of time at
1288 a specified checking interval when a certain network is under connecting until connection
1289 process finishes or timeout. If Aip protocol is supported by low layer drivers, three kinds
1290 of media states can be detected: EFI_SUCCESS, EFI_NOT_READY and EFI_NO_MEDIA, represents
1291 connected state, connecting state and no media state respectively. When function detects
1292 the current state is EFI_NOT_READY, it will loop to wait for next time's check until state
1293 turns to be EFI_SUCCESS or EFI_NO_MEDIA. If Aip protocol is not supported, function will
1294 call NetLibDetectMedia() and return state directly.
1296 @param[in] ServiceHandle The handle where network service binding protocols are
1298 @param[in] Timeout The maximum number of 100ns units to wait when network
1299 is connecting. Zero value means detect once and return
1301 @param[out] MediaState The pointer to the detected media state.
1303 @retval EFI_SUCCESS Media detection success.
1304 @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle or
1305 MediaState pointer is NULL.
1306 @retval EFI_DEVICE_ERROR A device error occurred.
1307 @retval EFI_TIMEOUT Network is connecting but timeout.
1312 NetLibDetectMediaWaitTimeout (
1313 IN EFI_HANDLE ServiceHandle
,
1315 OUT EFI_STATUS
*MediaState
1320 Create an IPv4 device path node.
1322 If Node is NULL, then ASSERT().
1324 The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.
1325 The header subtype of IPv4 device path node is MSG_IPv4_DP.
1326 The length of the IPv4 device path node in bytes is 19.
1327 Get other information from parameters to make up the whole IPv4 device path node.
1329 @param[in, out] Node The pointer to the IPv4 device path node.
1330 @param[in] Controller The controller handle.
1331 @param[in] LocalIp The local IPv4 address.
1332 @param[in] LocalPort The local port.
1333 @param[in] RemoteIp The remote IPv4 address.
1334 @param[in] RemotePort The remote port.
1335 @param[in] Protocol The protocol type in the IP header.
1336 @param[in] UseDefaultAddress Whether this instance is using default address or not.
1341 NetLibCreateIPv4DPathNode (
1342 IN OUT IPv4_DEVICE_PATH
*Node
,
1343 IN EFI_HANDLE Controller
,
1344 IN IP4_ADDR LocalIp
,
1345 IN UINT16 LocalPort
,
1346 IN IP4_ADDR RemoteIp
,
1347 IN UINT16 RemotePort
,
1349 IN BOOLEAN UseDefaultAddress
1353 Create an IPv6 device path node.
1355 If Node is NULL, then ASSERT().
1356 If LocalIp is NULL, then ASSERT().
1357 If RemoteIp is NULL, then ASSERT().
1359 The header type of IPv6 device path node is MESSAGING_DEVICE_PATH.
1360 The header subtype of IPv6 device path node is MSG_IPv6_DP.
1361 The length of the IPv6 device path node in bytes is 43.
1362 Get other information from parameters to make up the whole IPv6 device path node.
1364 @param[in, out] Node The pointer to the IPv6 device path node.
1365 @param[in] Controller The controller handle.
1366 @param[in] LocalIp The local IPv6 address.
1367 @param[in] LocalPort The local port.
1368 @param[in] RemoteIp The remote IPv6 address.
1369 @param[in] RemotePort The remote port.
1370 @param[in] Protocol The protocol type in the IP header.
1375 NetLibCreateIPv6DPathNode (
1376 IN OUT IPv6_DEVICE_PATH
*Node
,
1377 IN EFI_HANDLE Controller
,
1378 IN EFI_IPv6_ADDRESS
*LocalIp
,
1379 IN UINT16 LocalPort
,
1380 IN EFI_IPv6_ADDRESS
*RemoteIp
,
1381 IN UINT16 RemotePort
,
1387 Find the UNDI/SNP handle from controller and protocol GUID.
1389 If ProtocolGuid is NULL, then ASSERT().
1391 For example, IP will open an MNP child to transmit/receive
1392 packets. When MNP is stopped, IP should also be stopped. IP
1393 needs to find its own private data that is related the IP's
1394 service binding instance that is installed on the UNDI/SNP handle.
1395 The controller is then either an MNP or an ARP child handle. Note that
1396 IP opens these handles using BY_DRIVER. Use that information to get the
1399 @param[in] Controller The protocol handle to check.
1400 @param[in] ProtocolGuid The protocol that is related with the handle.
1402 @return The UNDI/SNP handle or NULL for errors.
1407 NetLibGetNicHandle (
1408 IN EFI_HANDLE Controller
,
1409 IN EFI_GUID
*ProtocolGuid
1413 This is the default unload handle for all the network drivers.
1415 Disconnect the driver specified by ImageHandle from all the devices in the handle database.
1416 Uninstall all the protocols installed in the driver entry point.
1418 @param[in] ImageHandle The drivers' driver image.
1420 @retval EFI_SUCCESS The image is unloaded.
1421 @retval Others Failed to unload the image.
1426 NetLibDefaultUnload (
1427 IN EFI_HANDLE ImageHandle
1431 Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.
1433 @param[in] String The pointer to the Ascii string.
1434 @param[out] Ip4Address The pointer to the converted IPv4 address.
1436 @retval EFI_SUCCESS Converted to an IPv4 address successfully.
1437 @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip4Address is NULL.
1442 NetLibAsciiStrToIp4 (
1443 IN CONST CHAR8
*String
,
1444 OUT EFI_IPv4_ADDRESS
*Ip4Address
1448 Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the
1449 string is defined in RFC 4291 - Text Representation of Addresses.
1451 @param[in] String The pointer to the Ascii string.
1452 @param[out] Ip6Address The pointer to the converted IPv6 address.
1454 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1455 @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip6Address is NULL.
1460 NetLibAsciiStrToIp6 (
1461 IN CONST CHAR8
*String
,
1462 OUT EFI_IPv6_ADDRESS
*Ip6Address
1466 Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.
1468 @param[in] String The pointer to the Ascii string.
1469 @param[out] Ip4Address The pointer to the converted IPv4 address.
1471 @retval EFI_SUCCESS Converted to an IPv4 address successfully.
1472 @retval EFI_INVALID_PARAMETER The string is mal-formatted or Ip4Address is NULL.
1478 IN CONST CHAR16
*String
,
1479 OUT EFI_IPv4_ADDRESS
*Ip4Address
1483 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of
1484 the string is defined in RFC 4291 - Text Representation of Addresses.
1486 @param[in] String The pointer to the Ascii string.
1487 @param[out] Ip6Address The pointer to the converted IPv6 address.
1489 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1490 @retval EFI_INVALID_PARAMETER The string is malformatted or Ip6Address is NULL.
1496 IN CONST CHAR16
*String
,
1497 OUT EFI_IPv6_ADDRESS
*Ip6Address
1501 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.
1502 The format of the string is defined in RFC 4291 - Text Representation of Addresses
1503 Prefixes: ipv6-address/prefix-length.
1505 @param[in] String The pointer to the Ascii string.
1506 @param[out] Ip6Address The pointer to the converted IPv6 address.
1507 @param[out] PrefixLength The pointer to the converted prefix length.
1509 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1510 @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip6Address is NULL.
1515 NetLibStrToIp6andPrefix (
1516 IN CONST CHAR16
*String
,
1517 OUT EFI_IPv6_ADDRESS
*Ip6Address
,
1518 OUT UINT8
*PrefixLength
1523 Convert one EFI_IPv6_ADDRESS to Null-terminated Unicode string.
1524 The text representation of address is defined in RFC 4291.
1526 @param[in] Ip6Address The pointer to the IPv6 address.
1527 @param[out] String The buffer to return the converted string.
1528 @param[in] StringSize The length in bytes of the input String.
1530 @retval EFI_SUCCESS Convert to string successfully.
1531 @retval EFI_INVALID_PARAMETER The input parameter is invalid.
1532 @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result. BufferSize has been
1533 updated with the size needed to complete the request.
1538 IN EFI_IPv6_ADDRESS
*Ip6Address
,
1544 // Various signatures
1546 #define NET_BUF_SIGNATURE SIGNATURE_32 ('n', 'b', 'u', 'f')
1547 #define NET_VECTOR_SIGNATURE SIGNATURE_32 ('n', 'v', 'e', 'c')
1548 #define NET_QUE_SIGNATURE SIGNATURE_32 ('n', 'b', 'q', 'u')
1551 #define NET_PROTO_DATA 64 // Opaque buffer for protocols
1552 #define NET_BUF_HEAD 1 // Trim or allocate space from head
1553 #define NET_BUF_TAIL 0 // Trim or allocate space from tail
1554 #define NET_VECTOR_OWN_FIRST 0x01 // We allocated the 1st block in the vector
1556 #define NET_CHECK_SIGNATURE(PData, SIGNATURE) \
1557 ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE)))
1560 // Single memory block in the vector.
1563 UINT32 Len
; // The block's length
1564 UINT8
*Bulk
; // The block's Data
1567 typedef VOID (EFIAPI
*NET_VECTOR_EXT_FREE
) (VOID
*Arg
);
1570 //NET_VECTOR contains several blocks to hold all packet's
1571 //fragments and other house-keeping stuff for sharing. It
1572 //doesn't specify the where actual packet fragment begins.
1576 INTN RefCnt
; // Reference count to share NET_VECTOR.
1577 NET_VECTOR_EXT_FREE Free
; // external function to free NET_VECTOR
1578 VOID
*Arg
; // opaque argument to Free
1579 UINT32 Flag
; // Flags, NET_VECTOR_OWN_FIRST
1580 UINT32 Len
; // Total length of the associated BLOCKs
1587 //NET_BLOCK_OP operates on the NET_BLOCK. It specifies
1588 //where the actual fragment begins and ends
1591 UINT8
*BlockHead
; // Block's head, or the smallest valid Head
1592 UINT8
*BlockTail
; // Block's tail. BlockTail-BlockHead=block length
1593 UINT8
*Head
; // 1st byte of the data in the block
1594 UINT8
*Tail
; // Tail of the data in the block, Tail-Head=Size
1595 UINT32 Size
; // The size of the data
1600 EFI_IP6_HEADER
*Ip6
;
1604 //NET_BUF is the buffer manage structure used by the
1605 //network stack. Every network packet may be fragmented. The Vector points to
1606 //memory blocks used by each fragment, and BlockOp
1607 //specifies where each fragment begins and ends.
1609 //It also contains an opaque area for the protocol to store
1610 //per-packet information. Protocol must be careful not
1611 //to overwrite the members after that.
1616 LIST_ENTRY List
; // The List this NET_BUF is on
1618 NET_IP_HEAD Ip
; // Network layer header, for fast access
1619 TCP_HEAD
*Tcp
; // Transport layer header, for fast access
1620 EFI_UDP_HEADER
*Udp
; // User Datagram Protocol header
1621 UINT8 ProtoData
[NET_PROTO_DATA
]; //Protocol specific data
1623 NET_VECTOR
*Vector
; // The vector containing the packet
1625 UINT32 BlockOpNum
; // Total number of BlockOp in the buffer
1626 UINT32 TotalSize
; // Total size of the actual packet
1627 NET_BLOCK_OP BlockOp
[1]; // Specify the position of actual packet
1631 //A queue of NET_BUFs. It is a thin extension of
1632 //NET_BUF functions.
1637 LIST_ENTRY List
; // The List this buffer queue is on
1639 LIST_ENTRY BufList
; // list of queued buffers
1640 UINT32 BufSize
; // total length of DATA in the buffers
1641 UINT32 BufNum
; // total number of buffers on the chain
1645 // Pseudo header for TCP and UDP checksum
1657 EFI_IPv6_ADDRESS SrcIp
;
1658 EFI_IPv6_ADDRESS DstIp
;
1661 UINT32 NextHeader
:8;
1662 } NET_IP6_PSEUDO_HDR
;
1666 // The fragment entry table used in network interfaces. This is
1667 // the same as NET_BLOCK now. Use two different to distinguish
1668 // the two in case that NET_BLOCK be enhanced later.
1675 #define NET_GET_REF(PData) ((PData)->RefCnt++)
1676 #define NET_PUT_REF(PData) ((PData)->RefCnt--)
1677 #define NETBUF_FROM_PROTODATA(Info) BASE_CR((Info), NET_BUF, ProtoData)
1679 #define NET_BUF_SHARED(Buf) \
1680 (((Buf)->RefCnt > 1) || ((Buf)->Vector->RefCnt > 1))
1682 #define NET_VECTOR_SIZE(BlockNum) \
1683 (sizeof (NET_VECTOR) + ((BlockNum) - 1) * sizeof (NET_BLOCK))
1685 #define NET_BUF_SIZE(BlockOpNum) \
1686 (sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))
1688 #define NET_HEADSPACE(BlockOp) \
1689 ((UINTN)((BlockOp)->Head) - (UINTN)((BlockOp)->BlockHead))
1691 #define NET_TAILSPACE(BlockOp) \
1692 ((UINTN)((BlockOp)->BlockTail) - (UINTN)((BlockOp)->Tail))
1695 Allocate a single block NET_BUF. Upon allocation, all the
1696 free space is in the tail room.
1698 @param[in] Len The length of the block.
1700 @return The pointer to the allocated NET_BUF, or NULL if the
1701 allocation failed due to resource limitations.
1711 Free the net buffer and its associated NET_VECTOR.
1713 Decrease the reference count of the net buffer by one. Free the associated net
1714 vector and itself if the reference count of the net buffer is decreased to 0.
1715 The net vector free operation decreases the reference count of the net
1716 vector by one, and performs the resource free operation when the reference count
1717 of the net vector is 0.
1719 @param[in] Nbuf The pointer to the NET_BUF to be freed.
1729 Get the index of NET_BLOCK_OP that contains the byte at Offset in the net
1732 For example, this function can be used to retrieve the IP header in the packet. It
1733 also can be used to get the fragment that contains the byte used
1734 mainly by the library implementation itself.
1736 @param[in] Nbuf The pointer to the net buffer.
1737 @param[in] Offset The offset of the byte.
1738 @param[out] Index Index of the NET_BLOCK_OP that contains the byte at
1741 @return The pointer to the Offset'th byte of data in the net buffer, or NULL
1742 if there is no such data in the net buffer.
1750 OUT UINT32
*Index OPTIONAL
1754 Create a copy of the net buffer that shares the associated net vector.
1756 The reference count of the newly created net buffer is set to 1. The reference
1757 count of the associated net vector is increased by one.
1759 @param[in] Nbuf The pointer to the net buffer to be cloned.
1761 @return The pointer to the cloned net buffer, or NULL if the
1762 allocation failed due to resource limitations.
1772 Create a duplicated copy of the net buffer with data copied and HeadSpace
1773 bytes of head space reserved.
1775 The duplicated net buffer will allocate its own memory to hold the data of the
1778 @param[in] Nbuf The pointer to the net buffer to be duplicated from.
1779 @param[in, out] Duplicate The pointer to the net buffer to duplicate to. If
1780 NULL, a new net buffer is allocated.
1781 @param[in] HeadSpace The length of the head space to reserve.
1783 @return The pointer to the duplicated net buffer, or NULL if
1784 the allocation failed due to resource limitations.
1791 IN OUT NET_BUF
*Duplicate OPTIONAL
,
1796 Create a NET_BUF structure which contains Len byte data of Nbuf starting from
1799 A new NET_BUF structure will be created but the associated data in NET_VECTOR
1800 is shared. This function exists to perform IP packet fragmentation.
1802 @param[in] Nbuf The pointer to the net buffer to be extracted.
1803 @param[in] Offset Starting point of the data to be included in the new
1805 @param[in] Len The bytes of data to be included in the new net buffer.
1806 @param[in] HeadSpace The bytes of the head space to reserve for the protocol header.
1808 @return The pointer to the cloned net buffer, or NULL if the
1809 allocation failed due to resource limitations.
1822 Reserve some space in the header room of the net buffer.
1824 Upon allocation, all the space is in the tail room of the buffer. Call this
1825 function to move space to the header room. This function is quite limited
1826 in that it can only reserve space from the first block of an empty NET_BUF not
1827 built from the external. However, it should be enough for the network stack.
1829 @param[in, out] Nbuf The pointer to the net buffer.
1830 @param[in] Len The length of buffer to be reserved from the header.
1836 IN OUT NET_BUF
*Nbuf
,
1841 Allocate Len bytes of space from the header or tail of the buffer.
1843 @param[in, out] Nbuf The pointer to the net buffer.
1844 @param[in] Len The length of the buffer to be allocated.
1845 @param[in] FromHead The flag to indicate whether to reserve the data
1846 from head (TRUE) or tail (FALSE).
1848 @return The pointer to the first byte of the allocated buffer,
1849 or NULL, if there is no sufficient space.
1855 IN OUT NET_BUF
*Nbuf
,
1861 Trim Len bytes from the header or the tail of the net buffer.
1863 @param[in, out] Nbuf The pointer to the net buffer.
1864 @param[in] Len The length of the data to be trimmed.
1865 @param[in] FromHead The flag to indicate whether trim data is from the
1866 head (TRUE) or the tail (FALSE).
1868 @return The length of the actual trimmed data, which may be less
1869 than Len if the TotalSize of Nbuf is less than Len.
1875 IN OUT NET_BUF
*Nbuf
,
1881 Copy Len bytes of data from the specific offset of the net buffer to the
1884 The Len bytes of data may cross several fragments of the net buffer.
1886 @param[in] Nbuf The pointer to the net buffer.
1887 @param[in] Offset The sequence number of the first byte to copy.
1888 @param[in] Len The length of the data to copy.
1889 @param[in] Dest The destination of the data to copy to.
1891 @return The length of the actual copied data, or 0 if the offset
1892 specified exceeds the total size of net buffer.
1905 Build a NET_BUF from external blocks.
1907 A new NET_BUF structure will be created from external blocks. An additional block
1908 of memory will be allocated to hold reserved HeadSpace bytes of header room
1909 and existing HeadLen bytes of header, but the external blocks are shared by the
1910 net buffer to avoid data copying.
1912 @param[in] ExtFragment The pointer to the data block.
1913 @param[in] ExtNum The number of the data blocks.
1914 @param[in] HeadSpace The head space to be reserved.
1915 @param[in] HeadLen The length of the protocol header. The function
1916 pulls this amount of data into a linear block.
1917 @param[in] ExtFree The pointer to the caller-provided free function.
1918 @param[in] Arg The argument passed to ExtFree when ExtFree is
1921 @return The pointer to the net buffer built from the data blocks,
1922 or NULL if the allocation failed due to resource
1929 IN NET_FRAGMENT
*ExtFragment
,
1931 IN UINT32 HeadSpace
,
1933 IN NET_VECTOR_EXT_FREE ExtFree
,
1934 IN VOID
*Arg OPTIONAL
1938 Build a fragment table to contain the fragments in the net buffer. This is the
1939 opposite operation of the NetbufFromExt.
1941 @param[in] Nbuf Points to the net buffer.
1942 @param[in, out] ExtFragment The pointer to the data block.
1943 @param[in, out] ExtNum The number of the data blocks.
1945 @retval EFI_BUFFER_TOO_SMALL The number of non-empty blocks is bigger than
1947 @retval EFI_SUCCESS The fragment table was built successfully.
1954 IN OUT NET_FRAGMENT
*ExtFragment
,
1955 IN OUT UINT32
*ExtNum
1959 Build a net buffer from a list of net buffers.
1961 All the fragments will be collected from the list of NEW_BUF, and then a new
1962 net buffer will be created through NetbufFromExt.
1964 @param[in] BufList A List of the net buffer.
1965 @param[in] HeadSpace The head space to be reserved.
1966 @param[in] HeaderLen The length of the protocol header. The function
1967 pulls this amount of data into a linear block.
1968 @param[in] ExtFree The pointer to the caller provided free function.
1969 @param[in] Arg The argument passed to ExtFree when ExtFree is called.
1971 @return The pointer to the net buffer built from the list of net
1978 IN LIST_ENTRY
*BufList
,
1979 IN UINT32 HeadSpace
,
1980 IN UINT32 HeaderLen
,
1981 IN NET_VECTOR_EXT_FREE ExtFree
,
1982 IN VOID
*Arg OPTIONAL
1986 Free a list of net buffers.
1988 @param[in, out] Head The pointer to the head of linked net buffers.
1994 IN OUT LIST_ENTRY
*Head
1998 Initiate the net buffer queue.
2000 @param[in, out] NbufQue The pointer to the net buffer queue to be initialized.
2006 IN OUT NET_BUF_QUEUE
*NbufQue
2010 Allocate and initialize a net buffer queue.
2012 @return The pointer to the allocated net buffer queue, or NULL if the
2013 allocation failed due to resource limit.
2023 Free a net buffer queue.
2025 Decrease the reference count of the net buffer queue by one. The real resource
2026 free operation isn't performed until the reference count of the net buffer
2027 queue is decreased to 0.
2029 @param[in] NbufQue The pointer to the net buffer queue to be freed.
2035 IN NET_BUF_QUEUE
*NbufQue
2039 Remove a net buffer from the head in the specific queue and return it.
2041 @param[in, out] NbufQue The pointer to the net buffer queue.
2043 @return The pointer to the net buffer removed from the specific queue,
2044 or NULL if there is no net buffer in the specific queue.
2050 IN OUT NET_BUF_QUEUE
*NbufQue
2054 Append a net buffer to the net buffer queue.
2056 @param[in, out] NbufQue The pointer to the net buffer queue.
2057 @param[in, out] Nbuf The pointer to the net buffer to be appended.
2063 IN OUT NET_BUF_QUEUE
*NbufQue
,
2064 IN OUT NET_BUF
*Nbuf
2068 Copy Len bytes of data from the net buffer queue at the specific offset to the
2071 The copying operation is the same as NetbufCopy, but applies to the net buffer
2072 queue instead of the net buffer.
2074 @param[in] NbufQue The pointer to the net buffer queue.
2075 @param[in] Offset The sequence number of the first byte to copy.
2076 @param[in] Len The length of the data to copy.
2077 @param[out] Dest The destination of the data to copy to.
2079 @return The length of the actual copied data, or 0 if the offset
2080 specified exceeds the total size of net buffer queue.
2086 IN NET_BUF_QUEUE
*NbufQue
,
2093 Trim Len bytes of data from the buffer queue and free any net buffer
2094 that is completely trimmed.
2096 The trimming operation is the same as NetbufTrim but applies to the net buffer
2097 queue instead of the net buffer.
2099 @param[in, out] NbufQue The pointer to the net buffer queue.
2100 @param[in] Len The length of the data to trim.
2102 @return The actual length of the data trimmed.
2108 IN OUT NET_BUF_QUEUE
*NbufQue
,
2114 Flush the net buffer queue.
2116 @param[in, out] NbufQue The pointer to the queue to be flushed.
2122 IN OUT NET_BUF_QUEUE
*NbufQue
2126 Compute the checksum for a bulk of data.
2128 @param[in] Bulk The pointer to the data.
2129 @param[in] Len The length of the data, in bytes.
2131 @return The computed checksum.
2144 @param[in] Checksum1 The first checksum to be added.
2145 @param[in] Checksum2 The second checksum to be added.
2147 @return The new checksum.
2153 IN UINT16 Checksum1
,
2158 Compute the checksum for a NET_BUF.
2160 @param[in] Nbuf The pointer to the net buffer.
2162 @return The computed checksum.
2172 Compute the checksum for TCP/UDP pseudo header.
2174 Src and Dst are in network byte order, and Len is in host byte order.
2176 @param[in] Src The source address of the packet.
2177 @param[in] Dst The destination address of the packet.
2178 @param[in] Proto The protocol type of the packet.
2179 @param[in] Len The length of the packet.
2181 @return The computed checksum.
2186 NetPseudoHeadChecksum (
2194 Compute the checksum for the TCP6/UDP6 pseudo header.
2196 Src and Dst are in network byte order, and Len is in host byte order.
2198 @param[in] Src The source address of the packet.
2199 @param[in] Dst The destination address of the packet.
2200 @param[in] NextHeader The protocol type of the packet.
2201 @param[in] Len The length of the packet.
2203 @return The computed checksum.
2208 NetIp6PseudoHeadChecksum (
2209 IN EFI_IPv6_ADDRESS
*Src
,
2210 IN EFI_IPv6_ADDRESS
*Dst
,
2211 IN UINT8 NextHeader
,
2216 The function frees the net buffer which allocated by the IP protocol. It releases
2217 only the net buffer and doesn't call the external free function.
2219 This function should be called after finishing the process of mIpSec->ProcessExt()
2220 for outbound traffic. The (EFI_IPSEC2_PROTOCOL)->ProcessExt() allocates a new
2221 buffer for the ESP, so there needs a function to free the old net buffer.
2223 @param[in] Nbuf The network buffer to be freed.
2227 NetIpSecNetbufFree (
2232 This function obtains the system guid from the smbios table.
2234 If SystemGuid is NULL, then ASSERT().
2236 @param[out] SystemGuid The pointer of the returned system guid.
2238 @retval EFI_SUCCESS Successfully obtained the system guid.
2239 @retval EFI_NOT_FOUND Did not find the SMBIOS table.
2244 NetLibGetSystemGuid (
2245 OUT EFI_GUID
*SystemGuid
2249 Create Dns QName according the queried domain name.
2251 If DomainName is NULL, then ASSERT().
2253 QName is a domain name represented as a sequence of labels,
2254 where each label consists of a length octet followed by that
2255 number of octets. The QName terminates with the zero
2256 length octet for the null label of the root. Caller should
2257 take responsibility to free the buffer in returned pointer.
2259 @param DomainName The pointer to the queried domain name string.
2261 @retval NULL Failed to fill QName.
2262 @return QName filled successfully.
2267 NetLibCreateDnsQName (
2268 IN CHAR16
*DomainName