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 - 2016, 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
47 #define IP4_ADDR_CLASSB 2
48 #define IP4_ADDR_CLASSC 3
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 IP6_HOP_BY_HOP 0
56 #define IP6_DESTINATION 60
57 #define IP6_ROUTING 43
58 #define IP6_FRAGMENT 44
61 #define IP6_NO_NEXT_HEADER 59
63 #define IP_VERSION_4 4
64 #define IP_VERSION_6 6
66 #define IP6_PREFIX_LENGTH 64
73 #define DNS_TYPE_CNAME 5
74 #define DNS_TYPE_SOA 6
75 #define DNS_TYPE_WKS 11
76 #define DNS_TYPE_PTR 12
77 #define DNS_TYPE_HINFO 13
78 #define DNS_TYPE_MINFO 14
79 #define DNS_TYPE_MX 15
80 #define DNS_TYPE_TXT 16
81 #define DNS_TYPE_AAAA 28
82 #define DNS_TYPE_SRV_RR 33
83 #define DNS_TYPE_AXFR 252
84 #define DNS_TYPE_MAILB 253
85 #define DNS_TYPE_ANY 255
90 #define DNS_CLASS_INET 1
91 #define DNS_CLASS_CH 3
92 #define DNS_CLASS_HS 4
93 #define DNS_CLASS_ANY 255
98 // Ethernet head definition
101 UINT8 DstMac
[NET_ETHER_ADDR_LEN
];
102 UINT8 SrcMac
[NET_ETHER_ADDR_LEN
];
107 // 802.1Q VLAN Tag Control Information
111 UINT16 Vid
: 12; // Unique VLAN identifier (0 to 4094)
112 UINT16 Cfi
: 1; // Canonical Format Indicator
113 UINT16 Priority
: 3; // 802.1Q priority level (0 to 7)
118 #define VLAN_TCI_CFI_CANONICAL_MAC 0
119 #define VLAN_TCI_CFI_NON_CANONICAL_MAC 1
122 // The EFI_IP4_HEADER is hard to use because the source and
123 // destination address are defined as EFI_IPv4_ADDRESS, which
124 // is a structure. Two structures can't be compared or masked
125 // directly. This is why there is an internal representation.
143 // ICMP head definition. Each ICMP message is categorized as either an error
144 // message or query message. Two message types have their own head format.
154 UINT32 Fourth
; // 4th filed of the head, it depends on Type.
156 } IP4_ICMP_ERROR_HEAD
;
162 } IP4_ICMP_QUERY_HEAD
;
173 EFI_IP6_HEADER IpHead
;
174 } IP6_ICMP_ERROR_HEAD
;
179 } IP6_ICMP_INFORMATION_HEAD
;
182 // UDP header definition
192 // TCP header definition
209 #define NET_MAC_EQUAL(pMac1, pMac2, Len) \
210 (CompareMem ((pMac1), (pMac2), Len) == 0)
212 #define NET_MAC_IS_MULTICAST(Mac, BMac, Len) \
213 (((*((UINT8 *) Mac) & 0x01) == 0x01) && (!NET_MAC_EQUAL (Mac, BMac, Len)))
215 #define NTOHL(x) SwapBytes32 (x)
217 #define HTONL(x) NTOHL(x)
219 #define NTOHS(x) SwapBytes16 (x)
221 #define HTONS(x) NTOHS(x)
222 #define NTOHLL(x) SwapBytes64 (x)
223 #define HTONLL(x) NTOHLL(x)
224 #define NTOHLLL(x) Ip6Swap128 (x)
225 #define HTONLLL(x) NTOHLLL(x)
228 // Test the IP's attribute, All the IPs are in host byte order.
230 #define IP4_IS_MULTICAST(Ip) (((Ip) & 0xF0000000) == 0xE0000000)
231 #define IP4_IS_LOCAL_BROADCAST(Ip) ((Ip) == 0xFFFFFFFF)
232 #define IP4_NET_EQUAL(Ip1, Ip2, NetMask) (((Ip1) & (NetMask)) == ((Ip2) & (NetMask)))
233 #define IP4_IS_VALID_NETMASK(Ip) (NetGetMaskLength (Ip) != IP4_MASK_NUM)
235 #define IP6_IS_MULTICAST(Ip6) (((Ip6)->Addr[0]) == 0xFF)
238 // Convert the EFI_IP4_ADDRESS to plain UINT32 IP4 address.
240 #define EFI_IP4(EfiIpAddr) (*(IP4_ADDR *) ((EfiIpAddr).Addr))
241 #define EFI_NTOHL(EfiIp) (NTOHL (EFI_IP4 ((EfiIp))))
242 #define EFI_IP4_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv4_ADDRESS)) == 0)
244 #define EFI_IP6_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv6_ADDRESS)) == 0)
246 #define IP4_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv4_ADDRESS)))
247 #define IP6_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv6_ADDRESS)))
248 #define IP6_COPY_LINK_ADDRESS(Mac1, Mac2) (CopyMem ((Mac1), (Mac2), sizeof (EFI_MAC_ADDRESS)))
251 // The debug level definition. This value is also used as the
252 // syslog's servity level. Don't change it.
254 #define NETDEBUG_LEVEL_TRACE 5
255 #define NETDEBUG_LEVEL_WARNING 4
256 #define NETDEBUG_LEVEL_ERROR 3
259 // Network debug message is sent out as syslog packet.
261 #define NET_SYSLOG_FACILITY 16 // Syslog local facility local use
262 #define NET_SYSLOG_PACKET_LEN 512
263 #define NET_SYSLOG_TX_TIMEOUT (500 * 1000 * 10) // 500ms
264 #define NET_DEBUG_MSG_LEN 470 // 512 - (ether+ip4+udp4 head length)
267 // The debug output expects the ASCII format string, Use %a to print ASCII
268 // string, and %s to print UNICODE string. PrintArg must be enclosed in ().
269 // For example: NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name));
271 #define NET_DEBUG_TRACE(Module, PrintArg) \
273 NETDEBUG_LEVEL_TRACE, \
277 NetDebugASPrint PrintArg \
280 #define NET_DEBUG_WARNING(Module, PrintArg) \
282 NETDEBUG_LEVEL_WARNING, \
286 NetDebugASPrint PrintArg \
289 #define NET_DEBUG_ERROR(Module, PrintArg) \
291 NETDEBUG_LEVEL_ERROR, \
295 NetDebugASPrint PrintArg \
299 Allocate a buffer, then format the message to it. This is a
300 help function for the NET_DEBUG_XXX macros. The PrintArg of
301 these macros treats the variable length print parameters as a
302 single parameter, and pass it to the NetDebugASPrint. For
303 example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name))
307 NETDEBUG_LEVEL_TRACE,
311 NetDebugASPrint ("State transit to %a\n", Name)
314 @param Format The ASCII format string.
315 @param ... The variable length parameter whose format is determined
316 by the Format string.
318 @return The buffer containing the formatted message,
319 or NULL if memory allocation failed.
330 Builds an UDP4 syslog packet and send it using SNP.
332 This function will locate a instance of SNP then send the message through it.
333 Because it isn't open the SNP BY_DRIVER, apply caution when using it.
335 @param Level The servity level of the message.
336 @param Module The Moudle that generates the log.
337 @param File The file that contains the log.
338 @param Line The exact line that contains the log.
339 @param Message The user message to log.
341 @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
342 @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet
343 @retval EFI_SUCCESS The log is discard because that it is more verbose
344 than the mNetDebugLevelMax. Or, it has been sent out.
358 Return the length of the mask.
360 Return the length of the mask. Valid values are 0 to 32.
361 If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM.
362 NetMask is in the host byte order.
364 @param[in] NetMask The netmask to get the length from.
366 @return The length of the netmask, or IP4_MASK_NUM (33) if the mask is invalid.
376 Return the class of the IP address, such as class A, B, C.
377 Addr is in host byte order.
379 The address of class A starts with 0.
380 If the address belong to class A, return IP4_ADDR_CLASSA.
381 The address of class B starts with 10.
382 If the address belong to class B, return IP4_ADDR_CLASSB.
383 The address of class C starts with 110.
384 If the address belong to class C, return IP4_ADDR_CLASSC.
385 The address of class D starts with 1110.
386 If the address belong to class D, return IP4_ADDR_CLASSD.
387 The address of class E starts with 1111.
388 If the address belong to class E, return IP4_ADDR_CLASSE.
391 @param[in] Addr The address to get the class from.
393 @return IP address class, such as IP4_ADDR_CLASSA.
403 Check whether the IP is a valid unicast address according to
404 the netmask. If NetMask is zero, use the IP address's class to get the default mask.
406 If Ip is 0, IP is not a valid unicast address.
407 Class D address is used for multicasting and class E address is reserved for future. If Ip
408 belongs to class D or class E, Ip is not a valid unicast address.
409 If all bits of the host address of Ip are 0 or 1, Ip is not a valid unicast address.
411 @param[in] Ip The IP to check against.
412 @param[in] NetMask The mask of the IP.
414 @return TRUE if Ip is a valid unicast address on the network, otherwise FALSE.
425 Check whether the incoming IPv6 address is a valid unicast address.
427 If the address is a multicast address has binary 0xFF at the start, it is not
428 a valid unicast address. If the address is unspecified ::, it is not a valid
429 unicast address to be assigned to any node. If the address is loopback address
430 ::1, it is also not a valid unicast address to be assigned to any physical
433 @param[in] Ip6 The IPv6 address to check against.
435 @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE.
440 NetIp6IsValidUnicast (
441 IN EFI_IPv6_ADDRESS
*Ip6
446 Check whether the incoming Ipv6 address is the unspecified address or not.
448 @param[in] Ip6 - Ip6 address, in network order.
450 @retval TRUE - Yes, incoming Ipv6 address is the unspecified address.
451 @retval FALSE - The incoming Ipv6 address is not the unspecified address
456 NetIp6IsUnspecifiedAddr (
457 IN EFI_IPv6_ADDRESS
*Ip6
461 Check whether the incoming Ipv6 address is a link-local address.
463 @param[in] Ip6 - Ip6 address, in network order.
465 @retval TRUE - The incoming Ipv6 address is a link-local address.
466 @retval FALSE - The incoming Ipv6 address is not a link-local address.
471 NetIp6IsLinkLocalAddr (
472 IN EFI_IPv6_ADDRESS
*Ip6
476 Check whether the Ipv6 address1 and address2 are on the connected network.
478 @param[in] Ip1 - Ip6 address1, in network order.
479 @param[in] Ip2 - Ip6 address2, in network order.
480 @param[in] PrefixLength - The prefix length of the checking net.
482 @retval TRUE - Yes, the Ipv6 address1 and address2 are connected.
483 @retval FALSE - No the Ipv6 address1 and address2 are not connected.
489 EFI_IPv6_ADDRESS
*Ip1
,
490 EFI_IPv6_ADDRESS
*Ip2
,
495 Switches the endianess of an IPv6 address.
497 This function swaps the bytes in a 128-bit IPv6 address to switch the value
498 from little endian to big endian or vice versa. The byte swapped value is
501 @param Ip6 Points to an IPv6 address.
503 @return The byte swapped IPv6 address.
509 EFI_IPv6_ADDRESS
*Ip6
512 extern IP4_ADDR gIp4AllMasks
[IP4_MASK_NUM
];
515 extern EFI_IPv4_ADDRESS mZeroIp4Addr
;
517 #define NET_IS_DIGIT(Ch) (('0' <= (Ch)) && ((Ch) <= '9'))
518 #define NET_ROUNDUP(size, unit) (((size) + (unit) - 1) & (~((unit) - 1)))
519 #define NET_IS_LOWER_CASE_CHAR(Ch) (('a' <= (Ch)) && ((Ch) <= 'z'))
520 #define NET_IS_UPPER_CASE_CHAR(Ch) (('A' <= (Ch)) && ((Ch) <= 'Z'))
522 #define TICKS_PER_MS 10000U
523 #define TICKS_PER_SECOND 10000000U
525 #define NET_RANDOM(Seed) ((UINT32) ((UINT32) (Seed) * 1103515245UL + 12345) % 4294967295UL)
528 Extract a UINT32 from a byte stream.
530 This function copies a UINT32 from a byte stream, and then converts it from Network
531 byte order to host byte order. Use this function to avoid alignment error.
533 @param[in] Buf The buffer to extract the UINT32.
535 @return The UINT32 extracted.
545 Puts a UINT32 into the byte stream in network byte order.
547 Converts a UINT32 from host byte order to network byte order, then copies it to the
550 @param[in, out] Buf The buffer in which to put the UINT32.
551 @param[in] Data The data to be converted and put into the byte stream.
562 Initialize a random seed using current time and monotonic count.
564 Get current time and monotonic count first. Then initialize a random seed
565 based on some basic mathematics operation on the hour, day, minute, second,
566 nanosecond and year of the current time and the monotonic count value.
568 @return The random seed initialized with current time.
578 #define NET_LIST_USER_STRUCT(Entry, Type, Field) \
579 BASE_CR(Entry, Type, Field)
581 #define NET_LIST_USER_STRUCT_S(Entry, Type, Field, Sig) \
582 CR(Entry, Type, Field, Sig)
585 // Iterate through the double linked list. It is NOT delete safe
587 #define NET_LIST_FOR_EACH(Entry, ListHead) \
588 for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)
591 // Iterate through the double linked list. This is delete-safe.
592 // Don't touch NextEntry. Also, don't use this macro if list
593 // entries other than the Entry may be deleted when processing
594 // the current Entry.
596 #define NET_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead) \
597 for(Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink; \
598 Entry != (ListHead); \
599 Entry = NextEntry, NextEntry = Entry->ForwardLink \
603 // Make sure the list isn't empty before getting the first/last record.
605 #define NET_LIST_HEAD(ListHead, Type, Field) \
606 NET_LIST_USER_STRUCT((ListHead)->ForwardLink, Type, Field)
608 #define NET_LIST_TAIL(ListHead, Type, Field) \
609 NET_LIST_USER_STRUCT((ListHead)->BackLink, Type, Field)
613 Remove the first node entry on the list, and return the removed node entry.
615 Removes the first node entry from a doubly linked list. It is up to the caller of
616 this function to release the memory used by the first node, if that is required. On
617 exit, the removed node is returned.
619 If Head is NULL, then ASSERT().
620 If Head was not initialized, then ASSERT().
621 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
622 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
625 @param[in, out] Head The list header.
627 @return The first node entry that is removed from the list, NULL if the list is empty.
633 IN OUT LIST_ENTRY
*Head
637 Remove the last node entry on the list and return the removed node entry.
639 Removes the last node entry from a doubly linked list. It is up to the caller of
640 this function to release the memory used by the first node, if that is required. On
641 exit, the removed node is returned.
643 If Head is NULL, then ASSERT().
644 If Head was not initialized, then ASSERT().
645 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
646 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
649 @param[in, out] Head The list head.
651 @return The last node entry that is removed from the list, NULL if the list is empty.
657 IN OUT LIST_ENTRY
*Head
661 Insert a new node entry after a designated node entry of a doubly linked list.
663 Inserts a new node entry designated by NewEntry after the node entry designated by PrevEntry
664 of the doubly linked list.
666 @param[in, out] PrevEntry The entry after which to insert.
667 @param[in, out] NewEntry The new entry to insert.
673 IN OUT LIST_ENTRY
*PrevEntry
,
674 IN OUT LIST_ENTRY
*NewEntry
678 Insert a new node entry before a designated node entry of a doubly linked list.
680 Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry
681 of the doubly linked list.
683 @param[in, out] PostEntry The entry to insert before.
684 @param[in, out] NewEntry The new entry to insert.
689 NetListInsertBefore (
690 IN OUT LIST_ENTRY
*PostEntry
,
691 IN OUT LIST_ENTRY
*NewEntry
695 Callback function which provided by user to remove one node in NetDestroyLinkList process.
697 @param[in] Entry The entry to be removed.
698 @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.
700 @retval EFI_SUCCESS The entry has been removed successfully.
701 @retval Others Fail to remove the entry.
706 (EFIAPI
*NET_DESTROY_LINK_LIST_CALLBACK
) (
707 IN LIST_ENTRY
*Entry
,
708 IN VOID
*Context OPTIONAL
712 Safe destroy nodes in a linked list, and return the length of the list after all possible operations finished.
714 Destroy network children list by list traversals is not safe due to graph dependencies between nodes.
715 This function performs a safe traversal to destroy these nodes by checking to see if the node being destroyed
716 has been removed from the list or not.
717 If it has been removed, then restart the traversal from the head.
718 If it hasn't been removed, then continue with the next node directly.
719 This function will end the iterate and return the CallBack's last return value if error happens,
720 or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.
722 @param[in] List The head of the list.
723 @param[in] CallBack Pointer to the callback function to destroy one node in the list.
724 @param[in] Context Pointer to the callback function's context: corresponds to the
725 parameter Context in NET_DESTROY_LINK_LIST_CALLBACK.
726 @param[out] ListLength The length of the link list if the function returns successfully.
728 @retval EFI_SUCCESS Two complete passes are made with no changes in the number of children.
729 @retval EFI_INVALID_PARAMETER The input parameter is invalid.
730 @retval Others Return the CallBack's last return value.
737 IN NET_DESTROY_LINK_LIST_CALLBACK CallBack
,
738 IN VOID
*Context
, OPTIONAL
739 OUT UINTN
*ListLength OPTIONAL
743 This function checks the input Handle to see if it's one of these handles in ChildHandleBuffer.
745 @param[in] Handle Handle to be checked.
746 @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer.
747 @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
748 if NumberOfChildren is 0.
750 @retval TURE Found the input Handle in ChildHandleBuffer.
751 @retval FALSE Can't find the input Handle in ChildHandleBuffer.
756 NetIsInHandleBuffer (
757 IN EFI_HANDLE Handle
,
758 IN UINTN NumberOfChildren
,
759 IN EFI_HANDLE
*ChildHandleBuffer OPTIONAL
763 // Object container: EFI network stack spec defines various kinds of
764 // tokens. The drivers can share code to manage those objects.
778 #define NET_MAP_INCREAMENT 64
781 Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.
783 Initialize the forward and backward links of two head nodes donated by Map->Used
784 and Map->Recycled of two doubly linked lists.
785 Initializes the count of the <Key, Value> pairs in the netmap to zero.
787 If Map is NULL, then ASSERT().
788 If the address of Map->Used is NULL, then ASSERT().
789 If the address of Map->Recycled is NULl, then ASSERT().
791 @param[in, out] Map The netmap to initialize.
801 To clean up the netmap, that is, release allocated memories.
803 Removes all nodes of the Used doubly linked list and frees memory of all related netmap items.
804 Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.
805 The number of the <Key, Value> pairs in the netmap is set to zero.
807 If Map is NULL, then ASSERT().
809 @param[in, out] Map The netmap to clean up.
819 Test whether the netmap is empty and return true if it is.
821 If the number of the <Key, Value> pairs in the netmap is zero, return TRUE.
823 If Map is NULL, then ASSERT().
826 @param[in] Map The net map to test.
828 @return TRUE if the netmap is empty, otherwise FALSE.
838 Return the number of the <Key, Value> pairs in the netmap.
840 @param[in] Map The netmap to get the entry number.
842 @return The entry number in the netmap.
852 Allocate an item to save the <Key, Value> pair to the head of the netmap.
854 Allocate an item to save the <Key, Value> pair and add corresponding node entry
855 to the beginning of the Used doubly linked list. The number of the <Key, Value>
856 pairs in the netmap increase by 1.
858 If Map is NULL, then ASSERT().
860 @param[in, out] Map The netmap to insert into.
861 @param[in] Key The user's key.
862 @param[in] Value The user's value for the key.
864 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
865 @retval EFI_SUCCESS The item is inserted to the head.
873 IN VOID
*Value OPTIONAL
877 Allocate an item to save the <Key, Value> pair to the tail of the netmap.
879 Allocate an item to save the <Key, Value> pair and add corresponding node entry
880 to the tail of the Used doubly linked list. The number of the <Key, Value>
881 pairs in the netmap increase by 1.
883 If Map is NULL, then ASSERT().
885 @param[in, out] Map The netmap to insert into.
886 @param[in] Key The user's key.
887 @param[in] Value The user's value for the key.
889 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
890 @retval EFI_SUCCESS The item is inserted to the tail.
898 IN VOID
*Value OPTIONAL
902 Finds the key in the netmap and returns the point to the item containing the Key.
904 Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every
905 item with the key to search. It returns the point to the item contains the Key if found.
907 If Map is NULL, then ASSERT().
909 @param[in] Map The netmap to search within.
910 @param[in] Key The key to search.
912 @return The point to the item contains the Key, or NULL if Key isn't in the map.
923 Remove the node entry of the item from the netmap and return the key of the removed item.
925 Remove the node entry of the item from the Used doubly linked list of the netmap.
926 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
927 entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL,
928 Value will point to the value of the item. It returns the key of the removed item.
930 If Map is NULL, then ASSERT().
931 If Item is NULL, then ASSERT().
932 if item in not in the netmap, then ASSERT().
934 @param[in, out] Map The netmap to remove the item from.
935 @param[in, out] Item The item to remove.
936 @param[out] Value The variable to receive the value if not NULL.
938 @return The key of the removed item.
945 IN OUT NET_MAP_ITEM
*Item
,
946 OUT VOID
**Value OPTIONAL
950 Remove the first node entry on the netmap and return the key of the removed item.
952 Remove the first node entry from the Used doubly linked list of the netmap.
953 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
954 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
955 parameter Value will point to the value of the item. It returns the key of the removed item.
957 If Map is NULL, then ASSERT().
958 If the Used doubly linked list is empty, then ASSERT().
960 @param[in, out] Map The netmap to remove the head from.
961 @param[out] Value The variable to receive the value if not NULL.
963 @return The key of the item removed.
970 OUT VOID
**Value OPTIONAL
974 Remove the last node entry on the netmap and return the key of the removed item.
976 Remove the last node entry from the Used doubly linked list of the netmap.
977 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
978 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
979 parameter Value will point to the value of the item. It returns the key of the removed item.
981 If Map is NULL, then ASSERT().
982 If the Used doubly linked list is empty, then ASSERT().
984 @param[in, out] Map The netmap to remove the tail from.
985 @param[out] Value The variable to receive the value if not NULL.
987 @return The key of the item removed.
994 OUT VOID
**Value OPTIONAL
999 (EFIAPI
*NET_MAP_CALLBACK
) (
1001 IN NET_MAP_ITEM
*Item
,
1006 Iterate through the netmap and call CallBack for each item.
1008 It will contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
1009 from the loop. It returns the CallBack's last return value. This function is
1010 delete safe for the current item.
1012 If Map is NULL, then ASSERT().
1013 If CallBack is NULL, then ASSERT().
1015 @param[in] Map The Map to iterate through.
1016 @param[in] CallBack The callback function to call for each item.
1017 @param[in] Arg The opaque parameter to the callback.
1019 @retval EFI_SUCCESS There is no item in the netmap, or CallBack for each item
1020 returns EFI_SUCCESS.
1021 @retval Others It returns the CallBack's last return value.
1028 IN NET_MAP_CALLBACK CallBack
,
1029 IN VOID
*Arg OPTIONAL
1034 // Helper functions to implement driver binding and service binding protocols.
1037 Create a child of the service that is identified by ServiceBindingGuid.
1039 Get the ServiceBinding Protocol first, then use it to create a child.
1041 If ServiceBindingGuid is NULL, then ASSERT().
1042 If ChildHandle is NULL, then ASSERT().
1044 @param[in] Controller The controller which has the service installed.
1045 @param[in] Image The image handle used to open service.
1046 @param[in] ServiceBindingGuid The service's Guid.
1047 @param[in, out] ChildHandle The handle to receive the created child.
1049 @retval EFI_SUCCESS The child was successfully created.
1050 @retval Others Failed to create the child.
1055 NetLibCreateServiceChild (
1056 IN EFI_HANDLE Controller
,
1057 IN EFI_HANDLE Image
,
1058 IN EFI_GUID
*ServiceBindingGuid
,
1059 IN OUT EFI_HANDLE
*ChildHandle
1063 Destroy a child of the service that is identified by ServiceBindingGuid.
1065 Get the ServiceBinding Protocol first, then use it to destroy a child.
1067 If ServiceBindingGuid is NULL, then ASSERT().
1069 @param[in] Controller The controller which has the service installed.
1070 @param[in] Image The image handle used to open service.
1071 @param[in] ServiceBindingGuid The service's Guid.
1072 @param[in] ChildHandle The child to destroy.
1074 @retval EFI_SUCCESS The child was destroyed.
1075 @retval Others Failed to destroy the child.
1080 NetLibDestroyServiceChild (
1081 IN EFI_HANDLE Controller
,
1082 IN EFI_HANDLE Image
,
1083 IN EFI_GUID
*ServiceBindingGuid
,
1084 IN EFI_HANDLE ChildHandle
1088 Get handle with Simple Network Protocol installed on it.
1090 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
1091 If Simple Network Protocol is already installed on the ServiceHandle, the
1092 ServiceHandle will be returned. If SNP is not installed on the ServiceHandle,
1093 try to find its parent handle with SNP installed.
1095 @param[in] ServiceHandle The handle where network service binding protocols are
1097 @param[out] Snp The pointer to store the address of the SNP instance.
1098 This is an optional parameter that may be NULL.
1100 @return The SNP handle, or NULL if not found.
1105 NetLibGetSnpHandle (
1106 IN EFI_HANDLE ServiceHandle
,
1107 OUT EFI_SIMPLE_NETWORK_PROTOCOL
**Snp OPTIONAL
1111 Retrieve VLAN ID of a VLAN device handle.
1113 Search VLAN device path node in Device Path of specified ServiceHandle and
1114 return its VLAN ID. If no VLAN device path node found, then this ServiceHandle
1115 is not a VLAN device handle, and 0 will be returned.
1117 @param[in] ServiceHandle The handle where network service binding protocols are
1120 @return VLAN ID of the device handle, or 0 if not a VLAN device.
1126 IN EFI_HANDLE ServiceHandle
1130 Find VLAN device handle with specified VLAN ID.
1132 The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle.
1133 This function will append VLAN device path node to the parent device path,
1134 and then use LocateDevicePath() to find the correct VLAN device handle.
1136 @param[in] ControllerHandle The handle where network service binding protocols are
1138 @param[in] VlanId The configured VLAN ID for the VLAN device.
1140 @return The VLAN device handle, or NULL if not found.
1145 NetLibGetVlanHandle (
1146 IN EFI_HANDLE ControllerHandle
,
1151 Get MAC address associated with the network service handle.
1153 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
1154 If SNP is installed on the ServiceHandle or its parent handle, MAC address will
1155 be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.
1157 @param[in] ServiceHandle The handle where network service binding protocols are
1159 @param[out] MacAddress The pointer to store the returned MAC address.
1160 @param[out] AddressSize The length of returned MAC address.
1162 @retval EFI_SUCCESS MAC address was returned successfully.
1163 @retval Others Failed to get SNP mode data.
1168 NetLibGetMacAddress (
1169 IN EFI_HANDLE ServiceHandle
,
1170 OUT EFI_MAC_ADDRESS
*MacAddress
,
1171 OUT UINTN
*AddressSize
1175 Convert MAC address of the NIC associated with specified Service Binding Handle
1176 to a unicode string. Callers are responsible for freeing the string storage.
1178 Locate simple network protocol associated with the Service Binding Handle and
1179 get the mac address from SNP. Then convert the mac address into a unicode
1180 string. It takes 2 unicode characters to represent a 1 byte binary buffer.
1181 Plus one unicode character for the null-terminator.
1183 @param[in] ServiceHandle The handle where network service binding protocol is
1185 @param[in] ImageHandle The image handle used to act as the agent handle to
1186 get the simple network protocol. This parameter is
1187 optional and may be NULL.
1188 @param[out] MacString The pointer to store the address of the string
1189 representation of the mac address.
1191 @retval EFI_SUCCESS Converted the mac address a unicode string successfully.
1192 @retval EFI_OUT_OF_RESOURCES There are not enough memory resources.
1193 @retval Others Failed to open the simple network protocol.
1198 NetLibGetMacString (
1199 IN EFI_HANDLE ServiceHandle
,
1200 IN EFI_HANDLE ImageHandle
, OPTIONAL
1201 OUT CHAR16
**MacString
1205 Detect media status for specified network device.
1207 The underlying UNDI driver may or may not support reporting media status from
1208 GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine
1209 will try to invoke Snp->GetStatus() to get the media status. If media is already
1210 present, it returns directly. If media is not present, it will stop SNP and then
1211 restart SNP to get the latest media status. This provides an opportunity to get
1212 the correct media status for old UNDI driver, which doesn't support reporting
1213 media status from GET_STATUS command.
1214 Note: there are two limitations for the current algorithm:
1215 1) For UNDI with this capability, when the cable is not attached, there will
1216 be an redundant Stop/Start() process.
1217 2) for UNDI without this capability, in case that network cable is attached when
1218 Snp->Initialize() is invoked while network cable is unattached later,
1219 NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer
1220 apps to wait for timeout time.
1222 @param[in] ServiceHandle The handle where network service binding protocols are
1224 @param[out] MediaPresent The pointer to store the media status.
1226 @retval EFI_SUCCESS Media detection success.
1227 @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle.
1228 @retval EFI_UNSUPPORTED The network device does not support media detection.
1229 @retval EFI_DEVICE_ERROR SNP is in an unknown state.
1235 IN EFI_HANDLE ServiceHandle
,
1236 OUT BOOLEAN
*MediaPresent
1240 Create an IPv4 device path node.
1242 The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.
1243 The header subtype of IPv4 device path node is MSG_IPv4_DP.
1244 The length of the IPv4 device path node in bytes is 19.
1245 Get other information from parameters to make up the whole IPv4 device path node.
1247 @param[in, out] Node The pointer to the IPv4 device path node.
1248 @param[in] Controller The controller handle.
1249 @param[in] LocalIp The local IPv4 address.
1250 @param[in] LocalPort The local port.
1251 @param[in] RemoteIp The remote IPv4 address.
1252 @param[in] RemotePort The remote port.
1253 @param[in] Protocol The protocol type in the IP header.
1254 @param[in] UseDefaultAddress Whether this instance is using default address or not.
1259 NetLibCreateIPv4DPathNode (
1260 IN OUT IPv4_DEVICE_PATH
*Node
,
1261 IN EFI_HANDLE Controller
,
1262 IN IP4_ADDR LocalIp
,
1263 IN UINT16 LocalPort
,
1264 IN IP4_ADDR RemoteIp
,
1265 IN UINT16 RemotePort
,
1267 IN BOOLEAN UseDefaultAddress
1271 Create an IPv6 device path node.
1273 The header type of IPv6 device path node is MESSAGING_DEVICE_PATH.
1274 The header subtype of IPv6 device path node is MSG_IPv6_DP.
1275 The length of the IPv6 device path node in bytes is 43.
1276 Get other information from parameters to make up the whole IPv6 device path node.
1278 @param[in, out] Node The pointer to the IPv6 device path node.
1279 @param[in] Controller The controller handle.
1280 @param[in] LocalIp The local IPv6 address.
1281 @param[in] LocalPort The local port.
1282 @param[in] RemoteIp The remote IPv6 address.
1283 @param[in] RemotePort The remote port.
1284 @param[in] Protocol The protocol type in the IP header.
1289 NetLibCreateIPv6DPathNode (
1290 IN OUT IPv6_DEVICE_PATH
*Node
,
1291 IN EFI_HANDLE Controller
,
1292 IN EFI_IPv6_ADDRESS
*LocalIp
,
1293 IN UINT16 LocalPort
,
1294 IN EFI_IPv6_ADDRESS
*RemoteIp
,
1295 IN UINT16 RemotePort
,
1301 Find the UNDI/SNP handle from controller and protocol GUID.
1303 For example, IP will open an MNP child to transmit/receive
1304 packets. When MNP is stopped, IP should also be stopped. IP
1305 needs to find its own private data that is related the IP's
1306 service binding instance that is installed on the UNDI/SNP handle.
1307 The controller is then either an MNP or an ARP child handle. Note that
1308 IP opens these handles using BY_DRIVER. Use that infomation to get the
1311 @param[in] Controller The protocol handle to check.
1312 @param[in] ProtocolGuid The protocol that is related with the handle.
1314 @return The UNDI/SNP handle or NULL for errors.
1319 NetLibGetNicHandle (
1320 IN EFI_HANDLE Controller
,
1321 IN EFI_GUID
*ProtocolGuid
1325 This is the default unload handle for all the network drivers.
1327 Disconnect the driver specified by ImageHandle from all the devices in the handle database.
1328 Uninstall all the protocols installed in the driver entry point.
1330 @param[in] ImageHandle The drivers' driver image.
1332 @retval EFI_SUCCESS The image is unloaded.
1333 @retval Others Failed to unload the image.
1338 NetLibDefaultUnload (
1339 IN EFI_HANDLE ImageHandle
1343 Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.
1345 @param[in] String The pointer to the Ascii string.
1346 @param[out] Ip4Address The pointer to the converted IPv4 address.
1348 @retval EFI_SUCCESS Converted to an IPv4 address successfully.
1349 @retval EFI_INVALID_PARAMETER The string is malformated, or Ip4Address is NULL.
1354 NetLibAsciiStrToIp4 (
1355 IN CONST CHAR8
*String
,
1356 OUT EFI_IPv4_ADDRESS
*Ip4Address
1360 Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the
1361 string is defined in RFC 4291 - Text Pepresentation of Addresses.
1363 @param[in] String The pointer to the Ascii string.
1364 @param[out] Ip6Address The pointer to the converted IPv6 address.
1366 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1367 @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.
1372 NetLibAsciiStrToIp6 (
1373 IN CONST CHAR8
*String
,
1374 OUT EFI_IPv6_ADDRESS
*Ip6Address
1378 Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.
1380 @param[in] String The pointer to the Ascii string.
1381 @param[out] Ip4Address The pointer to the converted IPv4 address.
1383 @retval EFI_SUCCESS Converted to an IPv4 address successfully.
1384 @retval EFI_INVALID_PARAMETER The string is mal-formated or Ip4Address is NULL.
1385 @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to lack of resources.
1391 IN CONST CHAR16
*String
,
1392 OUT EFI_IPv4_ADDRESS
*Ip4Address
1396 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of
1397 the string is defined in RFC 4291 - Text Pepresentation of Addresses.
1399 @param[in] String The pointer to the Ascii string.
1400 @param[out] Ip6Address The pointer to the converted IPv6 address.
1402 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1403 @retval EFI_INVALID_PARAMETER The string is malformated or Ip6Address is NULL.
1404 @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.
1410 IN CONST CHAR16
*String
,
1411 OUT EFI_IPv6_ADDRESS
*Ip6Address
1415 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.
1416 The format of the string is defined in RFC 4291 - Text Pepresentation of Addresses
1417 Prefixes: ipv6-address/prefix-length.
1419 @param[in] String The pointer to the Ascii string.
1420 @param[out] Ip6Address The pointer to the converted IPv6 address.
1421 @param[out] PrefixLength The pointer to the converted prefix length.
1423 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1424 @retval EFI_INVALID_PARAMETER The string is malformated, or Ip6Address is NULL.
1425 @retval EFI_OUT_OF_RESOURCES Failed to perform the operation due to a lack of resources.
1430 NetLibStrToIp6andPrefix (
1431 IN CONST CHAR16
*String
,
1432 OUT EFI_IPv6_ADDRESS
*Ip6Address
,
1433 OUT UINT8
*PrefixLength
1438 Convert one EFI_IPv6_ADDRESS to Null-terminated Unicode string.
1439 The text representation of address is defined in RFC 4291.
1441 @param[in] Ip6Address The pointer to the IPv6 address.
1442 @param[out] String The buffer to return the converted string.
1443 @param[in] StringSize The length in bytes of the input String.
1445 @retval EFI_SUCCESS Convert to string successfully.
1446 @retval EFI_INVALID_PARAMETER The input parameter is invalid.
1447 @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result. BufferSize has been
1448 updated with the size needed to complete the request.
1453 IN EFI_IPv6_ADDRESS
*Ip6Address
,
1459 // Various signatures
1461 #define NET_BUF_SIGNATURE SIGNATURE_32 ('n', 'b', 'u', 'f')
1462 #define NET_VECTOR_SIGNATURE SIGNATURE_32 ('n', 'v', 'e', 'c')
1463 #define NET_QUE_SIGNATURE SIGNATURE_32 ('n', 'b', 'q', 'u')
1466 #define NET_PROTO_DATA 64 // Opaque buffer for protocols
1467 #define NET_BUF_HEAD 1 // Trim or allocate space from head
1468 #define NET_BUF_TAIL 0 // Trim or allocate space from tail
1469 #define NET_VECTOR_OWN_FIRST 0x01 // We allocated the 1st block in the vector
1471 #define NET_CHECK_SIGNATURE(PData, SIGNATURE) \
1472 ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE)))
1475 // Single memory block in the vector.
1478 UINT32 Len
; // The block's length
1479 UINT8
*Bulk
; // The block's Data
1482 typedef VOID (EFIAPI
*NET_VECTOR_EXT_FREE
) (VOID
*Arg
);
1485 //NET_VECTOR contains several blocks to hold all packet's
1486 //fragments and other house-keeping stuff for sharing. It
1487 //doesn't specify the where actual packet fragment begins.
1491 INTN RefCnt
; // Reference count to share NET_VECTOR.
1492 NET_VECTOR_EXT_FREE Free
; // external function to free NET_VECTOR
1493 VOID
*Arg
; // opeque argument to Free
1494 UINT32 Flag
; // Flags, NET_VECTOR_OWN_FIRST
1495 UINT32 Len
; // Total length of the assocated BLOCKs
1502 //NET_BLOCK_OP operates on the NET_BLOCK. It specifies
1503 //where the actual fragment begins and ends
1506 UINT8
*BlockHead
; // Block's head, or the smallest valid Head
1507 UINT8
*BlockTail
; // Block's tail. BlockTail-BlockHead=block length
1508 UINT8
*Head
; // 1st byte of the data in the block
1509 UINT8
*Tail
; // Tail of the data in the block, Tail-Head=Size
1510 UINT32 Size
; // The size of the data
1515 EFI_IP6_HEADER
*Ip6
;
1519 //NET_BUF is the buffer manage structure used by the
1520 //network stack. Every network packet may be fragmented. The Vector points to
1521 //memory blocks used by each fragment, and BlockOp
1522 //specifies where each fragment begins and ends.
1524 //It also contains an opaque area for the protocol to store
1525 //per-packet information. Protocol must be careful not
1526 //to overwrite the members after that.
1531 LIST_ENTRY List
; // The List this NET_BUF is on
1533 NET_IP_HEAD Ip
; // Network layer header, for fast access
1534 TCP_HEAD
*Tcp
; // Transport layer header, for fast access
1535 EFI_UDP_HEADER
*Udp
; // User Datagram Protocol header
1536 UINT8 ProtoData
[NET_PROTO_DATA
]; //Protocol specific data
1538 NET_VECTOR
*Vector
; // The vector containing the packet
1540 UINT32 BlockOpNum
; // Total number of BlockOp in the buffer
1541 UINT32 TotalSize
; // Total size of the actual packet
1542 NET_BLOCK_OP BlockOp
[1]; // Specify the position of actual packet
1546 //A queue of NET_BUFs. It is a thin extension of
1547 //NET_BUF functions.
1552 LIST_ENTRY List
; // The List this buffer queue is on
1554 LIST_ENTRY BufList
; // list of queued buffers
1555 UINT32 BufSize
; // total length of DATA in the buffers
1556 UINT32 BufNum
; // total number of buffers on the chain
1560 // Pseudo header for TCP and UDP checksum
1572 EFI_IPv6_ADDRESS SrcIp
;
1573 EFI_IPv6_ADDRESS DstIp
;
1576 UINT32 NextHeader
:8;
1577 } NET_IP6_PSEUDO_HDR
;
1581 // The fragment entry table used in network interfaces. This is
1582 // the same as NET_BLOCK now. Use two different to distinguish
1583 // the two in case that NET_BLOCK be enhanced later.
1590 #define NET_GET_REF(PData) ((PData)->RefCnt++)
1591 #define NET_PUT_REF(PData) ((PData)->RefCnt--)
1592 #define NETBUF_FROM_PROTODATA(Info) BASE_CR((Info), NET_BUF, ProtoData)
1594 #define NET_BUF_SHARED(Buf) \
1595 (((Buf)->RefCnt > 1) || ((Buf)->Vector->RefCnt > 1))
1597 #define NET_VECTOR_SIZE(BlockNum) \
1598 (sizeof (NET_VECTOR) + ((BlockNum) - 1) * sizeof (NET_BLOCK))
1600 #define NET_BUF_SIZE(BlockOpNum) \
1601 (sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))
1603 #define NET_HEADSPACE(BlockOp) \
1604 (UINTN)((BlockOp)->Head - (BlockOp)->BlockHead)
1606 #define NET_TAILSPACE(BlockOp) \
1607 (UINTN)((BlockOp)->BlockTail - (BlockOp)->Tail)
1610 Allocate a single block NET_BUF. Upon allocation, all the
1611 free space is in the tail room.
1613 @param[in] Len The length of the block.
1615 @return The pointer to the allocated NET_BUF, or NULL if the
1616 allocation failed due to resource limitations.
1626 Free the net buffer and its associated NET_VECTOR.
1628 Decrease the reference count of the net buffer by one. Free the associated net
1629 vector and itself if the reference count of the net buffer is decreased to 0.
1630 The net vector free operation decreases the reference count of the net
1631 vector by one, and performs the resource free operation when the reference count
1632 of the net vector is 0.
1634 @param[in] Nbuf The pointer to the NET_BUF to be freed.
1644 Get the index of NET_BLOCK_OP that contains the byte at Offset in the net
1647 For example, this function can be used to retrieve the IP header in the packet. It
1648 also can be used to get the fragment that contains the byte used
1649 mainly by the library implementation itself.
1651 @param[in] Nbuf The pointer to the net buffer.
1652 @param[in] Offset The offset of the byte.
1653 @param[out] Index Index of the NET_BLOCK_OP that contains the byte at
1656 @return The pointer to the Offset'th byte of data in the net buffer, or NULL
1657 if there is no such data in the net buffer.
1665 OUT UINT32
*Index OPTIONAL
1669 Create a copy of the net buffer that shares the associated net vector.
1671 The reference count of the newly created net buffer is set to 1. The reference
1672 count of the associated net vector is increased by one.
1674 @param[in] Nbuf The pointer to the net buffer to be cloned.
1676 @return The pointer to the cloned net buffer, or NULL if the
1677 allocation failed due to resource limitations.
1687 Create a duplicated copy of the net buffer with data copied and HeadSpace
1688 bytes of head space reserved.
1690 The duplicated net buffer will allocate its own memory to hold the data of the
1693 @param[in] Nbuf The pointer to the net buffer to be duplicated from.
1694 @param[in, out] Duplicate The pointer to the net buffer to duplicate to. If
1695 NULL, a new net buffer is allocated.
1696 @param[in] HeadSpace The length of the head space to reserve.
1698 @return The pointer to the duplicated net buffer, or NULL if
1699 the allocation failed due to resource limitations.
1706 IN OUT NET_BUF
*Duplicate OPTIONAL
,
1711 Create a NET_BUF structure which contains Len byte data of Nbuf starting from
1714 A new NET_BUF structure will be created but the associated data in NET_VECTOR
1715 is shared. This function exists to perform IP packet fragmentation.
1717 @param[in] Nbuf The pointer to the net buffer to be extracted.
1718 @param[in] Offset Starting point of the data to be included in the new
1720 @param[in] Len The bytes of data to be included in the new net buffer.
1721 @param[in] HeadSpace The bytes of the head space to reserve for the protocol header.
1723 @return The pointer to the cloned net buffer, or NULL if the
1724 allocation failed due to resource limitations.
1737 Reserve some space in the header room of the net buffer.
1739 Upon allocation, all the space is in the tail room of the buffer. Call this
1740 function to move space to the header room. This function is quite limited
1741 in that it can only reserve space from the first block of an empty NET_BUF not
1742 built from the external. However, it should be enough for the network stack.
1744 @param[in, out] Nbuf The pointer to the net buffer.
1745 @param[in] Len The length of buffer to be reserved from the header.
1751 IN OUT NET_BUF
*Nbuf
,
1756 Allocate Len bytes of space from the header or tail of the buffer.
1758 @param[in, out] Nbuf The pointer to the net buffer.
1759 @param[in] Len The length of the buffer to be allocated.
1760 @param[in] FromHead The flag to indicate whether to reserve the data
1761 from head (TRUE) or tail (FALSE).
1763 @return The pointer to the first byte of the allocated buffer,
1764 or NULL, if there is no sufficient space.
1770 IN OUT NET_BUF
*Nbuf
,
1776 Trim Len bytes from the header or the tail of the net buffer.
1778 @param[in, out] Nbuf The pointer to the net buffer.
1779 @param[in] Len The length of the data to be trimmed.
1780 @param[in] FromHead The flag to indicate whether trim data is from the
1781 head (TRUE) or the tail (FALSE).
1783 @return The length of the actual trimmed data, which may be less
1784 than Len if the TotalSize of Nbuf is less than Len.
1790 IN OUT NET_BUF
*Nbuf
,
1796 Copy Len bytes of data from the specific offset of the net buffer to the
1799 The Len bytes of data may cross several fragments of the net buffer.
1801 @param[in] Nbuf The pointer to the net buffer.
1802 @param[in] Offset The sequence number of the first byte to copy.
1803 @param[in] Len The length of the data to copy.
1804 @param[in] Dest The destination of the data to copy to.
1806 @return The length of the actual copied data, or 0 if the offset
1807 specified exceeds the total size of net buffer.
1820 Build a NET_BUF from external blocks.
1822 A new NET_BUF structure will be created from external blocks. An additional block
1823 of memory will be allocated to hold reserved HeadSpace bytes of header room
1824 and existing HeadLen bytes of header, but the external blocks are shared by the
1825 net buffer to avoid data copying.
1827 @param[in] ExtFragment The pointer to the data block.
1828 @param[in] ExtNum The number of the data blocks.
1829 @param[in] HeadSpace The head space to be reserved.
1830 @param[in] HeadLen The length of the protocol header. The function
1831 pulls this amount of data into a linear block.
1832 @param[in] ExtFree The pointer to the caller-provided free function.
1833 @param[in] Arg The argument passed to ExtFree when ExtFree is
1836 @return The pointer to the net buffer built from the data blocks,
1837 or NULL if the allocation failed due to resource
1844 IN NET_FRAGMENT
*ExtFragment
,
1846 IN UINT32 HeadSpace
,
1848 IN NET_VECTOR_EXT_FREE ExtFree
,
1849 IN VOID
*Arg OPTIONAL
1853 Build a fragment table to contain the fragments in the net buffer. This is the
1854 opposite operation of the NetbufFromExt.
1856 @param[in] Nbuf Points to the net buffer.
1857 @param[in, out] ExtFragment The pointer to the data block.
1858 @param[in, out] ExtNum The number of the data blocks.
1860 @retval EFI_BUFFER_TOO_SMALL The number of non-empty blocks is bigger than
1862 @retval EFI_SUCCESS The fragment table was built successfully.
1869 IN OUT NET_FRAGMENT
*ExtFragment
,
1870 IN OUT UINT32
*ExtNum
1874 Build a net buffer from a list of net buffers.
1876 All the fragments will be collected from the list of NEW_BUF, and then a new
1877 net buffer will be created through NetbufFromExt.
1879 @param[in] BufList A List of the net buffer.
1880 @param[in] HeadSpace The head space to be reserved.
1881 @param[in] HeaderLen The length of the protocol header. The function
1882 pulls this amount of data into a linear block.
1883 @param[in] ExtFree The pointer to the caller provided free function.
1884 @param[in] Arg The argument passed to ExtFree when ExtFree is called.
1886 @return The pointer to the net buffer built from the list of net
1893 IN LIST_ENTRY
*BufList
,
1894 IN UINT32 HeadSpace
,
1895 IN UINT32 HeaderLen
,
1896 IN NET_VECTOR_EXT_FREE ExtFree
,
1897 IN VOID
*Arg OPTIONAL
1901 Free a list of net buffers.
1903 @param[in, out] Head The pointer to the head of linked net buffers.
1909 IN OUT LIST_ENTRY
*Head
1913 Initiate the net buffer queue.
1915 @param[in, out] NbufQue The pointer to the net buffer queue to be initialized.
1921 IN OUT NET_BUF_QUEUE
*NbufQue
1925 Allocate and initialize a net buffer queue.
1927 @return The pointer to the allocated net buffer queue, or NULL if the
1928 allocation failed due to resource limit.
1938 Free a net buffer queue.
1940 Decrease the reference count of the net buffer queue by one. The real resource
1941 free operation isn't performed until the reference count of the net buffer
1942 queue is decreased to 0.
1944 @param[in] NbufQue The pointer to the net buffer queue to be freed.
1950 IN NET_BUF_QUEUE
*NbufQue
1954 Remove a net buffer from the head in the specific queue and return it.
1956 @param[in, out] NbufQue The pointer to the net buffer queue.
1958 @return The pointer to the net buffer removed from the specific queue,
1959 or NULL if there is no net buffer in the specific queue.
1965 IN OUT NET_BUF_QUEUE
*NbufQue
1969 Append a net buffer to the net buffer queue.
1971 @param[in, out] NbufQue The pointer to the net buffer queue.
1972 @param[in, out] Nbuf The pointer to the net buffer to be appended.
1978 IN OUT NET_BUF_QUEUE
*NbufQue
,
1979 IN OUT NET_BUF
*Nbuf
1983 Copy Len bytes of data from the net buffer queue at the specific offset to the
1986 The copying operation is the same as NetbufCopy, but applies to the net buffer
1987 queue instead of the net buffer.
1989 @param[in] NbufQue The pointer to the net buffer queue.
1990 @param[in] Offset The sequence number of the first byte to copy.
1991 @param[in] Len The length of the data to copy.
1992 @param[out] Dest The destination of the data to copy to.
1994 @return The length of the actual copied data, or 0 if the offset
1995 specified exceeds the total size of net buffer queue.
2001 IN NET_BUF_QUEUE
*NbufQue
,
2008 Trim Len bytes of data from the buffer queue and free any net buffer
2009 that is completely trimmed.
2011 The trimming operation is the same as NetbufTrim but applies to the net buffer
2012 queue instead of the net buffer.
2014 @param[in, out] NbufQue The pointer to the net buffer queue.
2015 @param[in] Len The length of the data to trim.
2017 @return The actual length of the data trimmed.
2023 IN OUT NET_BUF_QUEUE
*NbufQue
,
2029 Flush the net buffer queue.
2031 @param[in, out] NbufQue The pointer to the queue to be flushed.
2037 IN OUT NET_BUF_QUEUE
*NbufQue
2041 Compute the checksum for a bulk of data.
2043 @param[in] Bulk The pointer to the data.
2044 @param[in] Len The length of the data, in bytes.
2046 @return The computed checksum.
2059 @param[in] Checksum1 The first checksum to be added.
2060 @param[in] Checksum2 The second checksum to be added.
2062 @return The new checksum.
2068 IN UINT16 Checksum1
,
2073 Compute the checksum for a NET_BUF.
2075 @param[in] Nbuf The pointer to the net buffer.
2077 @return The computed checksum.
2087 Compute the checksum for TCP/UDP pseudo header.
2089 Src and Dst are in network byte order, and Len is in host byte order.
2091 @param[in] Src The source address of the packet.
2092 @param[in] Dst The destination address of the packet.
2093 @param[in] Proto The protocol type of the packet.
2094 @param[in] Len The length of the packet.
2096 @return The computed checksum.
2101 NetPseudoHeadChecksum (
2109 Compute the checksum for the TCP6/UDP6 pseudo header.
2111 Src and Dst are in network byte order, and Len is in host byte order.
2113 @param[in] Src The source address of the packet.
2114 @param[in] Dst The destination address of the packet.
2115 @param[in] NextHeader The protocol type of the packet.
2116 @param[in] Len The length of the packet.
2118 @return The computed checksum.
2123 NetIp6PseudoHeadChecksum (
2124 IN EFI_IPv6_ADDRESS
*Src
,
2125 IN EFI_IPv6_ADDRESS
*Dst
,
2126 IN UINT8 NextHeader
,
2131 The function frees the net buffer which allocated by the IP protocol. It releases
2132 only the net buffer and doesn't call the external free function.
2134 This function should be called after finishing the process of mIpSec->ProcessExt()
2135 for outbound traffic. The (EFI_IPSEC2_PROTOCOL)->ProcessExt() allocates a new
2136 buffer for the ESP, so there needs a function to free the old net buffer.
2138 @param[in] Nbuf The network buffer to be freed.
2142 NetIpSecNetbufFree (
2147 This function obtains the system guid from the smbios table.
2149 @param[out] SystemGuid The pointer of the returned system guid.
2151 @retval EFI_SUCCESS Successfully obtained the system guid.
2152 @retval EFI_NOT_FOUND Did not find the SMBIOS table.
2157 NetLibGetSystemGuid (
2158 OUT EFI_GUID
*SystemGuid
2162 Create Dns QName according the queried domain name.
2163 QName is a domain name represented as a sequence of labels,
2164 where each label consists of a length octet followed by that
2165 number of octets. The QName terminates with the zero
2166 length octet for the null label of the root. Caller should
2167 take responsibility to free the buffer in returned pointer.
2169 @param DomainName The pointer to the queried domain name string.
2171 @retval NULL Failed to fill QName.
2172 @return QName filled successfully.
2177 NetLibCreateDnsQName (
2178 IN CHAR16
*DomainName