2 This library is only intended to be used by UEFI network stack modules.
3 It provides basic functions for the UEFI network stack.
5 Copyright (c) 2005 - 2017, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at<BR>
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
19 #include <Protocol/Ip6.h>
21 #include <Library/BaseLib.h>
22 #include <Library/BaseMemoryLib.h>
24 typedef UINT32 IP4_ADDR
;
25 typedef UINT32 TCP_SEQNO
;
26 typedef UINT16 TCP_PORTNO
;
29 #define NET_ETHER_ADDR_LEN 6
30 #define NET_IFTYPE_ETHERNET 0x01
32 #define NET_VLAN_TAG_LEN 4
33 #define ETHER_TYPE_VLAN 0x8100
35 #define EFI_IP_PROTO_UDP 0x11
36 #define EFI_IP_PROTO_TCP 0x06
37 #define EFI_IP_PROTO_ICMP 0x01
38 #define IP4_PROTO_IGMP 0x02
40 #define DNS_MAX_NAME_SIZE 255
41 #define DNS_MAX_MESSAGE_SIZE 512
44 // The address classification
46 #define IP4_ADDR_CLASSA 1 // Deprecated
47 #define IP4_ADDR_CLASSB 2 // Deprecated
48 #define IP4_ADDR_CLASSC 3 // Deprecated
49 #define IP4_ADDR_CLASSD 4
50 #define IP4_ADDR_CLASSE 5
52 #define IP4_MASK_NUM 33
53 #define IP6_PREFIX_NUM 129
55 #define IP4_MASK_MAX 32
56 #define IP6_PREFIX_MAX 128
58 #define IP6_HOP_BY_HOP 0
59 #define IP6_DESTINATION 60
60 #define IP6_ROUTING 43
61 #define IP6_FRAGMENT 44
64 #define IP6_NO_NEXT_HEADER 59
66 #define IP_VERSION_4 4
67 #define IP_VERSION_6 6
69 #define IP6_PREFIX_LENGTH 64
76 #define DNS_TYPE_CNAME 5
77 #define DNS_TYPE_SOA 6
78 #define DNS_TYPE_WKS 11
79 #define DNS_TYPE_PTR 12
80 #define DNS_TYPE_HINFO 13
81 #define DNS_TYPE_MINFO 14
82 #define DNS_TYPE_MX 15
83 #define DNS_TYPE_TXT 16
84 #define DNS_TYPE_AAAA 28
85 #define DNS_TYPE_SRV_RR 33
86 #define DNS_TYPE_AXFR 252
87 #define DNS_TYPE_MAILB 253
88 #define DNS_TYPE_ANY 255
93 #define DNS_CLASS_INET 1
94 #define DNS_CLASS_CH 3
95 #define DNS_CLASS_HS 4
96 #define DNS_CLASS_ANY 255
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 If the address is a multicast address has binary 0xFF at the start, it is not
444 a valid unicast address. If the address is unspecified ::, it is not a valid
445 unicast address to be assigned to any node. If the address is loopback address
446 ::1, it is also not a valid unicast address to be assigned to any physical
449 @param[in] Ip6 The IPv6 address to check against.
451 @return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE.
456 NetIp6IsValidUnicast (
457 IN EFI_IPv6_ADDRESS
*Ip6
462 Check whether the incoming Ipv6 address is the unspecified address or not.
464 @param[in] Ip6 - Ip6 address, in network order.
466 @retval TRUE - Yes, incoming Ipv6 address is the unspecified address.
467 @retval FALSE - The incoming Ipv6 address is not the unspecified address
472 NetIp6IsUnspecifiedAddr (
473 IN EFI_IPv6_ADDRESS
*Ip6
477 Check whether the incoming Ipv6 address is a link-local address.
479 @param[in] Ip6 - Ip6 address, in network order.
481 @retval TRUE - The incoming Ipv6 address is a link-local address.
482 @retval FALSE - The incoming Ipv6 address is not a link-local address.
487 NetIp6IsLinkLocalAddr (
488 IN EFI_IPv6_ADDRESS
*Ip6
492 Check whether the Ipv6 address1 and address2 are on the connected network.
494 @param[in] Ip1 - Ip6 address1, in network order.
495 @param[in] Ip2 - Ip6 address2, in network order.
496 @param[in] PrefixLength - The prefix length of the checking net.
498 @retval TRUE - Yes, the Ipv6 address1 and address2 are connected.
499 @retval FALSE - No the Ipv6 address1 and address2 are not connected.
505 EFI_IPv6_ADDRESS
*Ip1
,
506 EFI_IPv6_ADDRESS
*Ip2
,
511 Switches the endianess of an IPv6 address.
513 This function swaps the bytes in a 128-bit IPv6 address to switch the value
514 from little endian to big endian or vice versa. The byte swapped value is
517 @param Ip6 Points to an IPv6 address.
519 @return The byte swapped IPv6 address.
525 EFI_IPv6_ADDRESS
*Ip6
528 extern IP4_ADDR gIp4AllMasks
[IP4_MASK_NUM
];
531 extern EFI_IPv4_ADDRESS mZeroIp4Addr
;
533 #define NET_IS_DIGIT(Ch) (('0' <= (Ch)) && ((Ch) <= '9'))
534 #define NET_IS_HEX(Ch) ((('0' <= (Ch)) && ((Ch) <= '9')) || (('A' <= (Ch)) && ((Ch) <= 'F')) || (('a' <= (Ch)) && ((Ch) <= 'f')))
535 #define NET_ROUNDUP(size, unit) (((size) + (unit) - 1) & (~((unit) - 1)))
536 #define NET_IS_LOWER_CASE_CHAR(Ch) (('a' <= (Ch)) && ((Ch) <= 'z'))
537 #define NET_IS_UPPER_CASE_CHAR(Ch) (('A' <= (Ch)) && ((Ch) <= 'Z'))
539 #define TICKS_PER_MS 10000U
540 #define TICKS_PER_SECOND 10000000U
542 #define NET_RANDOM(Seed) ((UINT32) ((UINT32) (Seed) * 1103515245UL + 12345) % 4294967295UL)
545 Extract a UINT32 from a byte stream.
547 This function copies a UINT32 from a byte stream, and then converts it from Network
548 byte order to host byte order. Use this function to avoid alignment error.
550 @param[in] Buf The buffer to extract the UINT32.
552 @return The UINT32 extracted.
562 Puts a UINT32 into the byte stream in network byte order.
564 Converts a UINT32 from host byte order to network byte order, then copies it to the
567 @param[in, out] Buf The buffer in which to put the UINT32.
568 @param[in] Data The data to be converted and put into the byte stream.
579 Initialize a random seed using current time and monotonic count.
581 Get current time and monotonic count first. Then initialize a random seed
582 based on some basic mathematics operation on the hour, day, minute, second,
583 nanosecond and year of the current time and the monotonic count value.
585 @return The random seed initialized with current time.
595 #define NET_LIST_USER_STRUCT(Entry, Type, Field) \
596 BASE_CR(Entry, Type, Field)
598 #define NET_LIST_USER_STRUCT_S(Entry, Type, Field, Sig) \
599 CR(Entry, Type, Field, Sig)
602 // Iterate through the double linked list. It is NOT delete safe
604 #define NET_LIST_FOR_EACH(Entry, ListHead) \
605 for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink)
608 // Iterate through the double linked list. This is delete-safe.
609 // Don't touch NextEntry. Also, don't use this macro if list
610 // entries other than the Entry may be deleted when processing
611 // the current Entry.
613 #define NET_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead) \
614 for(Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink; \
615 Entry != (ListHead); \
616 Entry = NextEntry, NextEntry = Entry->ForwardLink \
620 // Make sure the list isn't empty before getting the first/last record.
622 #define NET_LIST_HEAD(ListHead, Type, Field) \
623 NET_LIST_USER_STRUCT((ListHead)->ForwardLink, Type, Field)
625 #define NET_LIST_TAIL(ListHead, Type, Field) \
626 NET_LIST_USER_STRUCT((ListHead)->BackLink, Type, Field)
630 Remove the first node entry on the list, and return the removed node entry.
632 Removes the first node entry from a doubly linked list. It is up to the caller of
633 this function to release the memory used by the first node, if that is required. On
634 exit, the removed node is returned.
636 If Head is NULL, then ASSERT().
637 If Head was not initialized, then ASSERT().
638 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
639 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
642 @param[in, out] Head The list header.
644 @return The first node entry that is removed from the list, NULL if the list is empty.
650 IN OUT LIST_ENTRY
*Head
654 Remove the last node entry on the list and return the removed node entry.
656 Removes the last node entry from a doubly linked list. It is up to the caller of
657 this function to release the memory used by the first node, if that is required. On
658 exit, the removed node is returned.
660 If Head is NULL, then ASSERT().
661 If Head was not initialized, then ASSERT().
662 If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
663 linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
666 @param[in, out] Head The list head.
668 @return The last node entry that is removed from the list, NULL if the list is empty.
674 IN OUT LIST_ENTRY
*Head
678 Insert a new node entry after a designated node entry of a doubly linked list.
680 Inserts a new node entry designated by NewEntry after the node entry designated by PrevEntry
681 of the doubly linked list.
683 @param[in, out] PrevEntry The entry after which to insert.
684 @param[in, out] NewEntry The new entry to insert.
690 IN OUT LIST_ENTRY
*PrevEntry
,
691 IN OUT LIST_ENTRY
*NewEntry
695 Insert a new node entry before a designated node entry of a doubly linked list.
697 Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry
698 of the doubly linked list.
700 @param[in, out] PostEntry The entry to insert before.
701 @param[in, out] NewEntry The new entry to insert.
706 NetListInsertBefore (
707 IN OUT LIST_ENTRY
*PostEntry
,
708 IN OUT LIST_ENTRY
*NewEntry
712 Callback function which provided by user to remove one node in NetDestroyLinkList process.
714 @param[in] Entry The entry to be removed.
715 @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.
717 @retval EFI_SUCCESS The entry has been removed successfully.
718 @retval Others Fail to remove the entry.
723 (EFIAPI
*NET_DESTROY_LINK_LIST_CALLBACK
) (
724 IN LIST_ENTRY
*Entry
,
725 IN VOID
*Context OPTIONAL
729 Safe destroy nodes in a linked list, and return the length of the list after all possible operations finished.
731 Destroy network children list by list traversals is not safe due to graph dependencies between nodes.
732 This function performs a safe traversal to destroy these nodes by checking to see if the node being destroyed
733 has been removed from the list or not.
734 If it has been removed, then restart the traversal from the head.
735 If it hasn't been removed, then continue with the next node directly.
736 This function will end the iterate and return the CallBack's last return value if error happens,
737 or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.
739 @param[in] List The head of the list.
740 @param[in] CallBack Pointer to the callback function to destroy one node in the list.
741 @param[in] Context Pointer to the callback function's context: corresponds to the
742 parameter Context in NET_DESTROY_LINK_LIST_CALLBACK.
743 @param[out] ListLength The length of the link list if the function returns successfully.
745 @retval EFI_SUCCESS Two complete passes are made with no changes in the number of children.
746 @retval EFI_INVALID_PARAMETER The input parameter is invalid.
747 @retval Others Return the CallBack's last return value.
754 IN NET_DESTROY_LINK_LIST_CALLBACK CallBack
,
755 IN VOID
*Context
, OPTIONAL
756 OUT UINTN
*ListLength OPTIONAL
760 This function checks the input Handle to see if it's one of these handles in ChildHandleBuffer.
762 @param[in] Handle Handle to be checked.
763 @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer.
764 @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
765 if NumberOfChildren is 0.
767 @retval TRUE Found the input Handle in ChildHandleBuffer.
768 @retval FALSE Can't find the input Handle in ChildHandleBuffer.
773 NetIsInHandleBuffer (
774 IN EFI_HANDLE Handle
,
775 IN UINTN NumberOfChildren
,
776 IN EFI_HANDLE
*ChildHandleBuffer OPTIONAL
780 // Object container: EFI network stack spec defines various kinds of
781 // tokens. The drivers can share code to manage those objects.
795 #define NET_MAP_INCREAMENT 64
798 Initialize the netmap. Netmap is a reposity to keep the <Key, Value> pairs.
800 Initialize the forward and backward links of two head nodes donated by Map->Used
801 and Map->Recycled of two doubly linked lists.
802 Initializes the count of the <Key, Value> pairs in the netmap to zero.
804 If Map is NULL, then ASSERT().
805 If the address of Map->Used is NULL, then ASSERT().
806 If the address of Map->Recycled is NULl, then ASSERT().
808 @param[in, out] Map The netmap to initialize.
818 To clean up the netmap, that is, release allocated memories.
820 Removes all nodes of the Used doubly linked list and frees memory of all related netmap items.
821 Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.
822 The number of the <Key, Value> pairs in the netmap is set to zero.
824 If Map is NULL, then ASSERT().
826 @param[in, out] Map The netmap to clean up.
836 Test whether the netmap is empty and return true if it is.
838 If the number of the <Key, Value> pairs in the netmap is zero, return TRUE.
840 If Map is NULL, then ASSERT().
843 @param[in] Map The net map to test.
845 @return TRUE if the netmap is empty, otherwise FALSE.
855 Return the number of the <Key, Value> pairs in the netmap.
857 @param[in] Map The netmap to get the entry number.
859 @return The entry number in the netmap.
869 Allocate an item to save the <Key, Value> pair to the head of the netmap.
871 Allocate an item to save the <Key, Value> pair and add corresponding node entry
872 to the beginning of the Used doubly linked list. The number of the <Key, Value>
873 pairs in the netmap increase by 1.
875 If Map is NULL, then ASSERT().
877 @param[in, out] Map The netmap to insert into.
878 @param[in] Key The user's key.
879 @param[in] Value The user's value for the key.
881 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
882 @retval EFI_SUCCESS The item is inserted to the head.
890 IN VOID
*Value OPTIONAL
894 Allocate an item to save the <Key, Value> pair to the tail of the netmap.
896 Allocate an item to save the <Key, Value> pair and add corresponding node entry
897 to the tail of the Used doubly linked list. The number of the <Key, Value>
898 pairs in the netmap increase by 1.
900 If Map is NULL, then ASSERT().
902 @param[in, out] Map The netmap to insert into.
903 @param[in] Key The user's key.
904 @param[in] Value The user's value for the key.
906 @retval EFI_OUT_OF_RESOURCES Failed to allocate the memory for the item.
907 @retval EFI_SUCCESS The item is inserted to the tail.
915 IN VOID
*Value OPTIONAL
919 Finds the key in the netmap and returns the point to the item containing the Key.
921 Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every
922 item with the key to search. It returns the point to the item contains the Key if found.
924 If Map is NULL, then ASSERT().
926 @param[in] Map The netmap to search within.
927 @param[in] Key The key to search.
929 @return The point to the item contains the Key, or NULL if Key isn't in the map.
940 Remove the node entry of the item from the netmap and return the key of the removed item.
942 Remove the node entry of the item from the Used doubly linked list of the netmap.
943 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
944 entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL,
945 Value will point to the value of the item. It returns the key of the removed item.
947 If Map is NULL, then ASSERT().
948 If Item is NULL, then ASSERT().
949 if item in not in the netmap, then ASSERT().
951 @param[in, out] Map The netmap to remove the item from.
952 @param[in, out] Item The item to remove.
953 @param[out] Value The variable to receive the value if not NULL.
955 @return The key of the removed item.
962 IN OUT NET_MAP_ITEM
*Item
,
963 OUT VOID
**Value OPTIONAL
967 Remove the first node entry on the netmap and return the key of the removed item.
969 Remove the first node entry from the Used doubly linked list of the netmap.
970 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
971 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
972 parameter Value will point to the value of the item. It returns the key of the removed item.
974 If Map is NULL, then ASSERT().
975 If the Used doubly linked list is empty, then ASSERT().
977 @param[in, out] Map The netmap to remove the head from.
978 @param[out] Value The variable to receive the value if not NULL.
980 @return The key of the item removed.
987 OUT VOID
**Value OPTIONAL
991 Remove the last node entry on the netmap and return the key of the removed item.
993 Remove the last node entry from the Used doubly linked list of the netmap.
994 The number of the <Key, Value> pairs in the netmap decrease by 1. Then add the node
995 entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
996 parameter Value will point to the value of the item. It returns the key of the removed item.
998 If Map is NULL, then ASSERT().
999 If the Used doubly linked list is empty, then ASSERT().
1001 @param[in, out] Map The netmap to remove the tail from.
1002 @param[out] Value The variable to receive the value if not NULL.
1004 @return The key of the item removed.
1010 IN OUT NET_MAP
*Map
,
1011 OUT VOID
**Value OPTIONAL
1016 (EFIAPI
*NET_MAP_CALLBACK
) (
1018 IN NET_MAP_ITEM
*Item
,
1023 Iterate through the netmap and call CallBack for each item.
1025 It will continue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
1026 from the loop. It returns the CallBack's last return value. This function is
1027 delete safe for the current item.
1029 If Map is NULL, then ASSERT().
1030 If CallBack is NULL, then ASSERT().
1032 @param[in] Map The Map to iterate through.
1033 @param[in] CallBack The callback function to call for each item.
1034 @param[in] Arg The opaque parameter to the callback.
1036 @retval EFI_SUCCESS There is no item in the netmap, or CallBack for each item
1037 returns EFI_SUCCESS.
1038 @retval Others It returns the CallBack's last return value.
1045 IN NET_MAP_CALLBACK CallBack
,
1046 IN VOID
*Arg OPTIONAL
1051 // Helper functions to implement driver binding and service binding protocols.
1054 Create a child of the service that is identified by ServiceBindingGuid.
1056 Get the ServiceBinding Protocol first, then use it to create a child.
1058 If ServiceBindingGuid is NULL, then ASSERT().
1059 If ChildHandle is NULL, then ASSERT().
1061 @param[in] Controller The controller which has the service installed.
1062 @param[in] Image The image handle used to open service.
1063 @param[in] ServiceBindingGuid The service's Guid.
1064 @param[in, out] ChildHandle The handle to receive the created child.
1066 @retval EFI_SUCCESS The child was successfully created.
1067 @retval Others Failed to create the child.
1072 NetLibCreateServiceChild (
1073 IN EFI_HANDLE Controller
,
1074 IN EFI_HANDLE Image
,
1075 IN EFI_GUID
*ServiceBindingGuid
,
1076 IN OUT EFI_HANDLE
*ChildHandle
1080 Destroy a child of the service that is identified by ServiceBindingGuid.
1082 Get the ServiceBinding Protocol first, then use it to destroy a child.
1084 If ServiceBindingGuid is NULL, then ASSERT().
1086 @param[in] Controller The controller which has the service installed.
1087 @param[in] Image The image handle used to open service.
1088 @param[in] ServiceBindingGuid The service's Guid.
1089 @param[in] ChildHandle The child to destroy.
1091 @retval EFI_SUCCESS The child was destroyed.
1092 @retval Others Failed to destroy the child.
1097 NetLibDestroyServiceChild (
1098 IN EFI_HANDLE Controller
,
1099 IN EFI_HANDLE Image
,
1100 IN EFI_GUID
*ServiceBindingGuid
,
1101 IN EFI_HANDLE ChildHandle
1105 Get handle with Simple Network Protocol installed on it.
1107 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
1108 If Simple Network Protocol is already installed on the ServiceHandle, the
1109 ServiceHandle will be returned. If SNP is not installed on the ServiceHandle,
1110 try to find its parent handle with SNP installed.
1112 @param[in] ServiceHandle The handle where network service binding protocols are
1114 @param[out] Snp The pointer to store the address of the SNP instance.
1115 This is an optional parameter that may be NULL.
1117 @return The SNP handle, or NULL if not found.
1122 NetLibGetSnpHandle (
1123 IN EFI_HANDLE ServiceHandle
,
1124 OUT EFI_SIMPLE_NETWORK_PROTOCOL
**Snp OPTIONAL
1128 Retrieve VLAN ID of a VLAN device handle.
1130 Search VLAN device path node in Device Path of specified ServiceHandle and
1131 return its VLAN ID. If no VLAN device path node found, then this ServiceHandle
1132 is not a VLAN device handle, and 0 will be returned.
1134 @param[in] ServiceHandle The handle where network service binding protocols are
1137 @return VLAN ID of the device handle, or 0 if not a VLAN device.
1143 IN EFI_HANDLE ServiceHandle
1147 Find VLAN device handle with specified VLAN ID.
1149 The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle.
1150 This function will append VLAN device path node to the parent device path,
1151 and then use LocateDevicePath() to find the correct VLAN device handle.
1153 @param[in] ControllerHandle The handle where network service binding protocols are
1155 @param[in] VlanId The configured VLAN ID for the VLAN device.
1157 @return The VLAN device handle, or NULL if not found.
1162 NetLibGetVlanHandle (
1163 IN EFI_HANDLE ControllerHandle
,
1168 Get MAC address associated with the network service handle.
1170 There should be MNP Service Binding Protocol installed on the input ServiceHandle.
1171 If SNP is installed on the ServiceHandle or its parent handle, MAC address will
1172 be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.
1174 @param[in] ServiceHandle The handle where network service binding protocols are
1176 @param[out] MacAddress The pointer to store the returned MAC address.
1177 @param[out] AddressSize The length of returned MAC address.
1179 @retval EFI_SUCCESS MAC address was returned successfully.
1180 @retval Others Failed to get SNP mode data.
1185 NetLibGetMacAddress (
1186 IN EFI_HANDLE ServiceHandle
,
1187 OUT EFI_MAC_ADDRESS
*MacAddress
,
1188 OUT UINTN
*AddressSize
1192 Convert MAC address of the NIC associated with specified Service Binding Handle
1193 to a unicode string. Callers are responsible for freeing the string storage.
1195 Locate simple network protocol associated with the Service Binding Handle and
1196 get the mac address from SNP. Then convert the mac address into a unicode
1197 string. It takes 2 unicode characters to represent a 1 byte binary buffer.
1198 Plus one unicode character for the null-terminator.
1200 @param[in] ServiceHandle The handle where network service binding protocol is
1202 @param[in] ImageHandle The image handle used to act as the agent handle to
1203 get the simple network protocol. This parameter is
1204 optional and may be NULL.
1205 @param[out] MacString The pointer to store the address of the string
1206 representation of the mac address.
1208 @retval EFI_SUCCESS Converted the mac address a unicode string successfully.
1209 @retval EFI_OUT_OF_RESOURCES There are not enough memory resources.
1210 @retval Others Failed to open the simple network protocol.
1215 NetLibGetMacString (
1216 IN EFI_HANDLE ServiceHandle
,
1217 IN EFI_HANDLE ImageHandle
, OPTIONAL
1218 OUT CHAR16
**MacString
1222 Detect media status for specified network device.
1224 The underlying UNDI driver may or may not support reporting media status from
1225 GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine
1226 will try to invoke Snp->GetStatus() to get the media status. If media is already
1227 present, it returns directly. If media is not present, it will stop SNP and then
1228 restart SNP to get the latest media status. This provides an opportunity to get
1229 the correct media status for old UNDI driver, which doesn't support reporting
1230 media status from GET_STATUS command.
1231 Note: there are two limitations for the current algorithm:
1232 1) For UNDI with this capability, when the cable is not attached, there will
1233 be an redundant Stop/Start() process.
1234 2) for UNDI without this capability, in case that network cable is attached when
1235 Snp->Initialize() is invoked while network cable is unattached later,
1236 NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer
1237 apps to wait for timeout time.
1239 @param[in] ServiceHandle The handle where network service binding protocols are
1241 @param[out] MediaPresent The pointer to store the media status.
1243 @retval EFI_SUCCESS Media detection success.
1244 @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle.
1245 @retval EFI_UNSUPPORTED The network device does not support media detection.
1246 @retval EFI_DEVICE_ERROR SNP is in an unknown state.
1252 IN EFI_HANDLE ServiceHandle
,
1253 OUT BOOLEAN
*MediaPresent
1258 Detect media state for a network device. This routine will wait for a period of time at
1259 a specified checking interval when a certain network is under connecting until connection
1260 process finishes or timeout. If Aip protocol is supported by low layer drivers, three kinds
1261 of media states can be detected: EFI_SUCCESS, EFI_NOT_READY and EFI_NO_MEDIA, represents
1262 connected state, connecting state and no media state respectively. When function detects
1263 the current state is EFI_NOT_READY, it will loop to wait for next time's check until state
1264 turns to be EFI_SUCCESS or EFI_NO_MEDIA. If Aip protocol is not supported, function will
1265 call NetLibDetectMedia() and return state directly.
1267 @param[in] ServiceHandle The handle where network service binding protocols are
1269 @param[in] Timeout The maximum number of 100ns units to wait when network
1270 is connecting. Zero value means detect once and return
1272 @param[out] MediaState The pointer to the detected media state.
1274 @retval EFI_SUCCESS Media detection success.
1275 @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle or
1276 MediaState pointer is NULL.
1277 @retval EFI_DEVICE_ERROR A device error occurred.
1278 @retval EFI_TIMEOUT Network is connecting but timeout.
1283 NetLibDetectMediaWaitTimeout (
1284 IN EFI_HANDLE ServiceHandle
,
1286 OUT EFI_STATUS
*MediaState
1291 Create an IPv4 device path node.
1293 The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.
1294 The header subtype of IPv4 device path node is MSG_IPv4_DP.
1295 The length of the IPv4 device path node in bytes is 19.
1296 Get other information from parameters to make up the whole IPv4 device path node.
1298 @param[in, out] Node The pointer to the IPv4 device path node.
1299 @param[in] Controller The controller handle.
1300 @param[in] LocalIp The local IPv4 address.
1301 @param[in] LocalPort The local port.
1302 @param[in] RemoteIp The remote IPv4 address.
1303 @param[in] RemotePort The remote port.
1304 @param[in] Protocol The protocol type in the IP header.
1305 @param[in] UseDefaultAddress Whether this instance is using default address or not.
1310 NetLibCreateIPv4DPathNode (
1311 IN OUT IPv4_DEVICE_PATH
*Node
,
1312 IN EFI_HANDLE Controller
,
1313 IN IP4_ADDR LocalIp
,
1314 IN UINT16 LocalPort
,
1315 IN IP4_ADDR RemoteIp
,
1316 IN UINT16 RemotePort
,
1318 IN BOOLEAN UseDefaultAddress
1322 Create an IPv6 device path node.
1324 The header type of IPv6 device path node is MESSAGING_DEVICE_PATH.
1325 The header subtype of IPv6 device path node is MSG_IPv6_DP.
1326 The length of the IPv6 device path node in bytes is 43.
1327 Get other information from parameters to make up the whole IPv6 device path node.
1329 @param[in, out] Node The pointer to the IPv6 device path node.
1330 @param[in] Controller The controller handle.
1331 @param[in] LocalIp The local IPv6 address.
1332 @param[in] LocalPort The local port.
1333 @param[in] RemoteIp The remote IPv6 address.
1334 @param[in] RemotePort The remote port.
1335 @param[in] Protocol The protocol type in the IP header.
1340 NetLibCreateIPv6DPathNode (
1341 IN OUT IPv6_DEVICE_PATH
*Node
,
1342 IN EFI_HANDLE Controller
,
1343 IN EFI_IPv6_ADDRESS
*LocalIp
,
1344 IN UINT16 LocalPort
,
1345 IN EFI_IPv6_ADDRESS
*RemoteIp
,
1346 IN UINT16 RemotePort
,
1352 Find the UNDI/SNP handle from controller and protocol GUID.
1354 For example, IP will open an MNP child to transmit/receive
1355 packets. When MNP is stopped, IP should also be stopped. IP
1356 needs to find its own private data that is related the IP's
1357 service binding instance that is installed on the UNDI/SNP handle.
1358 The controller is then either an MNP or an ARP child handle. Note that
1359 IP opens these handles using BY_DRIVER. Use that information to get the
1362 @param[in] Controller The protocol handle to check.
1363 @param[in] ProtocolGuid The protocol that is related with the handle.
1365 @return The UNDI/SNP handle or NULL for errors.
1370 NetLibGetNicHandle (
1371 IN EFI_HANDLE Controller
,
1372 IN EFI_GUID
*ProtocolGuid
1376 This is the default unload handle for all the network drivers.
1378 Disconnect the driver specified by ImageHandle from all the devices in the handle database.
1379 Uninstall all the protocols installed in the driver entry point.
1381 @param[in] ImageHandle The drivers' driver image.
1383 @retval EFI_SUCCESS The image is unloaded.
1384 @retval Others Failed to unload the image.
1389 NetLibDefaultUnload (
1390 IN EFI_HANDLE ImageHandle
1394 Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.
1396 @param[in] String The pointer to the Ascii string.
1397 @param[out] Ip4Address The pointer to the converted IPv4 address.
1399 @retval EFI_SUCCESS Converted to an IPv4 address successfully.
1400 @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip4Address is NULL.
1405 NetLibAsciiStrToIp4 (
1406 IN CONST CHAR8
*String
,
1407 OUT EFI_IPv4_ADDRESS
*Ip4Address
1411 Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the
1412 string is defined in RFC 4291 - Text Representation of Addresses.
1414 @param[in] String The pointer to the Ascii string.
1415 @param[out] Ip6Address The pointer to the converted IPv6 address.
1417 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1418 @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip6Address is NULL.
1423 NetLibAsciiStrToIp6 (
1424 IN CONST CHAR8
*String
,
1425 OUT EFI_IPv6_ADDRESS
*Ip6Address
1429 Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.
1431 @param[in] String The pointer to the Ascii string.
1432 @param[out] Ip4Address The pointer to the converted IPv4 address.
1434 @retval EFI_SUCCESS Converted to an IPv4 address successfully.
1435 @retval EFI_INVALID_PARAMETER The string is mal-formatted or Ip4Address is NULL.
1441 IN CONST CHAR16
*String
,
1442 OUT EFI_IPv4_ADDRESS
*Ip4Address
1446 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of
1447 the string is defined in RFC 4291 - Text Representation of Addresses.
1449 @param[in] String The pointer to the Ascii string.
1450 @param[out] Ip6Address The pointer to the converted IPv6 address.
1452 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1453 @retval EFI_INVALID_PARAMETER The string is malformatted or Ip6Address is NULL.
1459 IN CONST CHAR16
*String
,
1460 OUT EFI_IPv6_ADDRESS
*Ip6Address
1464 Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.
1465 The format of the string is defined in RFC 4291 - Text Representation of Addresses
1466 Prefixes: ipv6-address/prefix-length.
1468 @param[in] String The pointer to the Ascii string.
1469 @param[out] Ip6Address The pointer to the converted IPv6 address.
1470 @param[out] PrefixLength The pointer to the converted prefix length.
1472 @retval EFI_SUCCESS Converted to an IPv6 address successfully.
1473 @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip6Address is NULL.
1478 NetLibStrToIp6andPrefix (
1479 IN CONST CHAR16
*String
,
1480 OUT EFI_IPv6_ADDRESS
*Ip6Address
,
1481 OUT UINT8
*PrefixLength
1486 Convert one EFI_IPv6_ADDRESS to Null-terminated Unicode string.
1487 The text representation of address is defined in RFC 4291.
1489 @param[in] Ip6Address The pointer to the IPv6 address.
1490 @param[out] String The buffer to return the converted string.
1491 @param[in] StringSize The length in bytes of the input String.
1493 @retval EFI_SUCCESS Convert to string successfully.
1494 @retval EFI_INVALID_PARAMETER The input parameter is invalid.
1495 @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result. BufferSize has been
1496 updated with the size needed to complete the request.
1501 IN EFI_IPv6_ADDRESS
*Ip6Address
,
1507 // Various signatures
1509 #define NET_BUF_SIGNATURE SIGNATURE_32 ('n', 'b', 'u', 'f')
1510 #define NET_VECTOR_SIGNATURE SIGNATURE_32 ('n', 'v', 'e', 'c')
1511 #define NET_QUE_SIGNATURE SIGNATURE_32 ('n', 'b', 'q', 'u')
1514 #define NET_PROTO_DATA 64 // Opaque buffer for protocols
1515 #define NET_BUF_HEAD 1 // Trim or allocate space from head
1516 #define NET_BUF_TAIL 0 // Trim or allocate space from tail
1517 #define NET_VECTOR_OWN_FIRST 0x01 // We allocated the 1st block in the vector
1519 #define NET_CHECK_SIGNATURE(PData, SIGNATURE) \
1520 ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE)))
1523 // Single memory block in the vector.
1526 UINT32 Len
; // The block's length
1527 UINT8
*Bulk
; // The block's Data
1530 typedef VOID (EFIAPI
*NET_VECTOR_EXT_FREE
) (VOID
*Arg
);
1533 //NET_VECTOR contains several blocks to hold all packet's
1534 //fragments and other house-keeping stuff for sharing. It
1535 //doesn't specify the where actual packet fragment begins.
1539 INTN RefCnt
; // Reference count to share NET_VECTOR.
1540 NET_VECTOR_EXT_FREE Free
; // external function to free NET_VECTOR
1541 VOID
*Arg
; // opaque argument to Free
1542 UINT32 Flag
; // Flags, NET_VECTOR_OWN_FIRST
1543 UINT32 Len
; // Total length of the associated BLOCKs
1550 //NET_BLOCK_OP operates on the NET_BLOCK. It specifies
1551 //where the actual fragment begins and ends
1554 UINT8
*BlockHead
; // Block's head, or the smallest valid Head
1555 UINT8
*BlockTail
; // Block's tail. BlockTail-BlockHead=block length
1556 UINT8
*Head
; // 1st byte of the data in the block
1557 UINT8
*Tail
; // Tail of the data in the block, Tail-Head=Size
1558 UINT32 Size
; // The size of the data
1563 EFI_IP6_HEADER
*Ip6
;
1567 //NET_BUF is the buffer manage structure used by the
1568 //network stack. Every network packet may be fragmented. The Vector points to
1569 //memory blocks used by each fragment, and BlockOp
1570 //specifies where each fragment begins and ends.
1572 //It also contains an opaque area for the protocol to store
1573 //per-packet information. Protocol must be careful not
1574 //to overwrite the members after that.
1579 LIST_ENTRY List
; // The List this NET_BUF is on
1581 NET_IP_HEAD Ip
; // Network layer header, for fast access
1582 TCP_HEAD
*Tcp
; // Transport layer header, for fast access
1583 EFI_UDP_HEADER
*Udp
; // User Datagram Protocol header
1584 UINT8 ProtoData
[NET_PROTO_DATA
]; //Protocol specific data
1586 NET_VECTOR
*Vector
; // The vector containing the packet
1588 UINT32 BlockOpNum
; // Total number of BlockOp in the buffer
1589 UINT32 TotalSize
; // Total size of the actual packet
1590 NET_BLOCK_OP BlockOp
[1]; // Specify the position of actual packet
1594 //A queue of NET_BUFs. It is a thin extension of
1595 //NET_BUF functions.
1600 LIST_ENTRY List
; // The List this buffer queue is on
1602 LIST_ENTRY BufList
; // list of queued buffers
1603 UINT32 BufSize
; // total length of DATA in the buffers
1604 UINT32 BufNum
; // total number of buffers on the chain
1608 // Pseudo header for TCP and UDP checksum
1620 EFI_IPv6_ADDRESS SrcIp
;
1621 EFI_IPv6_ADDRESS DstIp
;
1624 UINT32 NextHeader
:8;
1625 } NET_IP6_PSEUDO_HDR
;
1629 // The fragment entry table used in network interfaces. This is
1630 // the same as NET_BLOCK now. Use two different to distinguish
1631 // the two in case that NET_BLOCK be enhanced later.
1638 #define NET_GET_REF(PData) ((PData)->RefCnt++)
1639 #define NET_PUT_REF(PData) ((PData)->RefCnt--)
1640 #define NETBUF_FROM_PROTODATA(Info) BASE_CR((Info), NET_BUF, ProtoData)
1642 #define NET_BUF_SHARED(Buf) \
1643 (((Buf)->RefCnt > 1) || ((Buf)->Vector->RefCnt > 1))
1645 #define NET_VECTOR_SIZE(BlockNum) \
1646 (sizeof (NET_VECTOR) + ((BlockNum) - 1) * sizeof (NET_BLOCK))
1648 #define NET_BUF_SIZE(BlockOpNum) \
1649 (sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))
1651 #define NET_HEADSPACE(BlockOp) \
1652 ((UINTN)((BlockOp)->Head) - (UINTN)((BlockOp)->BlockHead))
1654 #define NET_TAILSPACE(BlockOp) \
1655 ((UINTN)((BlockOp)->BlockTail) - (UINTN)((BlockOp)->Tail))
1658 Allocate a single block NET_BUF. Upon allocation, all the
1659 free space is in the tail room.
1661 @param[in] Len The length of the block.
1663 @return The pointer to the allocated NET_BUF, or NULL if the
1664 allocation failed due to resource limitations.
1674 Free the net buffer and its associated NET_VECTOR.
1676 Decrease the reference count of the net buffer by one. Free the associated net
1677 vector and itself if the reference count of the net buffer is decreased to 0.
1678 The net vector free operation decreases the reference count of the net
1679 vector by one, and performs the resource free operation when the reference count
1680 of the net vector is 0.
1682 @param[in] Nbuf The pointer to the NET_BUF to be freed.
1692 Get the index of NET_BLOCK_OP that contains the byte at Offset in the net
1695 For example, this function can be used to retrieve the IP header in the packet. It
1696 also can be used to get the fragment that contains the byte used
1697 mainly by the library implementation itself.
1699 @param[in] Nbuf The pointer to the net buffer.
1700 @param[in] Offset The offset of the byte.
1701 @param[out] Index Index of the NET_BLOCK_OP that contains the byte at
1704 @return The pointer to the Offset'th byte of data in the net buffer, or NULL
1705 if there is no such data in the net buffer.
1713 OUT UINT32
*Index OPTIONAL
1717 Create a copy of the net buffer that shares the associated net vector.
1719 The reference count of the newly created net buffer is set to 1. The reference
1720 count of the associated net vector is increased by one.
1722 @param[in] Nbuf The pointer to the net buffer to be cloned.
1724 @return The pointer to the cloned net buffer, or NULL if the
1725 allocation failed due to resource limitations.
1735 Create a duplicated copy of the net buffer with data copied and HeadSpace
1736 bytes of head space reserved.
1738 The duplicated net buffer will allocate its own memory to hold the data of the
1741 @param[in] Nbuf The pointer to the net buffer to be duplicated from.
1742 @param[in, out] Duplicate The pointer to the net buffer to duplicate to. If
1743 NULL, a new net buffer is allocated.
1744 @param[in] HeadSpace The length of the head space to reserve.
1746 @return The pointer to the duplicated net buffer, or NULL if
1747 the allocation failed due to resource limitations.
1754 IN OUT NET_BUF
*Duplicate OPTIONAL
,
1759 Create a NET_BUF structure which contains Len byte data of Nbuf starting from
1762 A new NET_BUF structure will be created but the associated data in NET_VECTOR
1763 is shared. This function exists to perform IP packet fragmentation.
1765 @param[in] Nbuf The pointer to the net buffer to be extracted.
1766 @param[in] Offset Starting point of the data to be included in the new
1768 @param[in] Len The bytes of data to be included in the new net buffer.
1769 @param[in] HeadSpace The bytes of the head space to reserve for the protocol header.
1771 @return The pointer to the cloned net buffer, or NULL if the
1772 allocation failed due to resource limitations.
1785 Reserve some space in the header room of the net buffer.
1787 Upon allocation, all the space is in the tail room of the buffer. Call this
1788 function to move space to the header room. This function is quite limited
1789 in that it can only reserve space from the first block of an empty NET_BUF not
1790 built from the external. However, it should be enough for the network stack.
1792 @param[in, out] Nbuf The pointer to the net buffer.
1793 @param[in] Len The length of buffer to be reserved from the header.
1799 IN OUT NET_BUF
*Nbuf
,
1804 Allocate Len bytes of space from the header or tail of the buffer.
1806 @param[in, out] Nbuf The pointer to the net buffer.
1807 @param[in] Len The length of the buffer to be allocated.
1808 @param[in] FromHead The flag to indicate whether to reserve the data
1809 from head (TRUE) or tail (FALSE).
1811 @return The pointer to the first byte of the allocated buffer,
1812 or NULL, if there is no sufficient space.
1818 IN OUT NET_BUF
*Nbuf
,
1824 Trim Len bytes from the header or the tail of the net buffer.
1826 @param[in, out] Nbuf The pointer to the net buffer.
1827 @param[in] Len The length of the data to be trimmed.
1828 @param[in] FromHead The flag to indicate whether trim data is from the
1829 head (TRUE) or the tail (FALSE).
1831 @return The length of the actual trimmed data, which may be less
1832 than Len if the TotalSize of Nbuf is less than Len.
1838 IN OUT NET_BUF
*Nbuf
,
1844 Copy Len bytes of data from the specific offset of the net buffer to the
1847 The Len bytes of data may cross several fragments of the net buffer.
1849 @param[in] Nbuf The pointer to the net buffer.
1850 @param[in] Offset The sequence number of the first byte to copy.
1851 @param[in] Len The length of the data to copy.
1852 @param[in] Dest The destination of the data to copy to.
1854 @return The length of the actual copied data, or 0 if the offset
1855 specified exceeds the total size of net buffer.
1868 Build a NET_BUF from external blocks.
1870 A new NET_BUF structure will be created from external blocks. An additional block
1871 of memory will be allocated to hold reserved HeadSpace bytes of header room
1872 and existing HeadLen bytes of header, but the external blocks are shared by the
1873 net buffer to avoid data copying.
1875 @param[in] ExtFragment The pointer to the data block.
1876 @param[in] ExtNum The number of the data blocks.
1877 @param[in] HeadSpace The head space to be reserved.
1878 @param[in] HeadLen The length of the protocol header. The function
1879 pulls this amount of data into a linear block.
1880 @param[in] ExtFree The pointer to the caller-provided free function.
1881 @param[in] Arg The argument passed to ExtFree when ExtFree is
1884 @return The pointer to the net buffer built from the data blocks,
1885 or NULL if the allocation failed due to resource
1892 IN NET_FRAGMENT
*ExtFragment
,
1894 IN UINT32 HeadSpace
,
1896 IN NET_VECTOR_EXT_FREE ExtFree
,
1897 IN VOID
*Arg OPTIONAL
1901 Build a fragment table to contain the fragments in the net buffer. This is the
1902 opposite operation of the NetbufFromExt.
1904 @param[in] Nbuf Points to the net buffer.
1905 @param[in, out] ExtFragment The pointer to the data block.
1906 @param[in, out] ExtNum The number of the data blocks.
1908 @retval EFI_BUFFER_TOO_SMALL The number of non-empty blocks is bigger than
1910 @retval EFI_SUCCESS The fragment table was built successfully.
1917 IN OUT NET_FRAGMENT
*ExtFragment
,
1918 IN OUT UINT32
*ExtNum
1922 Build a net buffer from a list of net buffers.
1924 All the fragments will be collected from the list of NEW_BUF, and then a new
1925 net buffer will be created through NetbufFromExt.
1927 @param[in] BufList A List of the net buffer.
1928 @param[in] HeadSpace The head space to be reserved.
1929 @param[in] HeaderLen The length of the protocol header. The function
1930 pulls this amount of data into a linear block.
1931 @param[in] ExtFree The pointer to the caller provided free function.
1932 @param[in] Arg The argument passed to ExtFree when ExtFree is called.
1934 @return The pointer to the net buffer built from the list of net
1941 IN LIST_ENTRY
*BufList
,
1942 IN UINT32 HeadSpace
,
1943 IN UINT32 HeaderLen
,
1944 IN NET_VECTOR_EXT_FREE ExtFree
,
1945 IN VOID
*Arg OPTIONAL
1949 Free a list of net buffers.
1951 @param[in, out] Head The pointer to the head of linked net buffers.
1957 IN OUT LIST_ENTRY
*Head
1961 Initiate the net buffer queue.
1963 @param[in, out] NbufQue The pointer to the net buffer queue to be initialized.
1969 IN OUT NET_BUF_QUEUE
*NbufQue
1973 Allocate and initialize a net buffer queue.
1975 @return The pointer to the allocated net buffer queue, or NULL if the
1976 allocation failed due to resource limit.
1986 Free a net buffer queue.
1988 Decrease the reference count of the net buffer queue by one. The real resource
1989 free operation isn't performed until the reference count of the net buffer
1990 queue is decreased to 0.
1992 @param[in] NbufQue The pointer to the net buffer queue to be freed.
1998 IN NET_BUF_QUEUE
*NbufQue
2002 Remove a net buffer from the head in the specific queue and return it.
2004 @param[in, out] NbufQue The pointer to the net buffer queue.
2006 @return The pointer to the net buffer removed from the specific queue,
2007 or NULL if there is no net buffer in the specific queue.
2013 IN OUT NET_BUF_QUEUE
*NbufQue
2017 Append a net buffer to the net buffer queue.
2019 @param[in, out] NbufQue The pointer to the net buffer queue.
2020 @param[in, out] Nbuf The pointer to the net buffer to be appended.
2026 IN OUT NET_BUF_QUEUE
*NbufQue
,
2027 IN OUT NET_BUF
*Nbuf
2031 Copy Len bytes of data from the net buffer queue at the specific offset to the
2034 The copying operation is the same as NetbufCopy, but applies to the net buffer
2035 queue instead of the net buffer.
2037 @param[in] NbufQue The pointer to the net buffer queue.
2038 @param[in] Offset The sequence number of the first byte to copy.
2039 @param[in] Len The length of the data to copy.
2040 @param[out] Dest The destination of the data to copy to.
2042 @return The length of the actual copied data, or 0 if the offset
2043 specified exceeds the total size of net buffer queue.
2049 IN NET_BUF_QUEUE
*NbufQue
,
2056 Trim Len bytes of data from the buffer queue and free any net buffer
2057 that is completely trimmed.
2059 The trimming operation is the same as NetbufTrim but applies to the net buffer
2060 queue instead of the net buffer.
2062 @param[in, out] NbufQue The pointer to the net buffer queue.
2063 @param[in] Len The length of the data to trim.
2065 @return The actual length of the data trimmed.
2071 IN OUT NET_BUF_QUEUE
*NbufQue
,
2077 Flush the net buffer queue.
2079 @param[in, out] NbufQue The pointer to the queue to be flushed.
2085 IN OUT NET_BUF_QUEUE
*NbufQue
2089 Compute the checksum for a bulk of data.
2091 @param[in] Bulk The pointer to the data.
2092 @param[in] Len The length of the data, in bytes.
2094 @return The computed checksum.
2107 @param[in] Checksum1 The first checksum to be added.
2108 @param[in] Checksum2 The second checksum to be added.
2110 @return The new checksum.
2116 IN UINT16 Checksum1
,
2121 Compute the checksum for a NET_BUF.
2123 @param[in] Nbuf The pointer to the net buffer.
2125 @return The computed checksum.
2135 Compute the checksum for TCP/UDP pseudo header.
2137 Src and Dst are in network byte order, and Len is in host byte order.
2139 @param[in] Src The source address of the packet.
2140 @param[in] Dst The destination address of the packet.
2141 @param[in] Proto The protocol type of the packet.
2142 @param[in] Len The length of the packet.
2144 @return The computed checksum.
2149 NetPseudoHeadChecksum (
2157 Compute the checksum for the TCP6/UDP6 pseudo header.
2159 Src and Dst are in network byte order, and Len is in host byte order.
2161 @param[in] Src The source address of the packet.
2162 @param[in] Dst The destination address of the packet.
2163 @param[in] NextHeader The protocol type of the packet.
2164 @param[in] Len The length of the packet.
2166 @return The computed checksum.
2171 NetIp6PseudoHeadChecksum (
2172 IN EFI_IPv6_ADDRESS
*Src
,
2173 IN EFI_IPv6_ADDRESS
*Dst
,
2174 IN UINT8 NextHeader
,
2179 The function frees the net buffer which allocated by the IP protocol. It releases
2180 only the net buffer and doesn't call the external free function.
2182 This function should be called after finishing the process of mIpSec->ProcessExt()
2183 for outbound traffic. The (EFI_IPSEC2_PROTOCOL)->ProcessExt() allocates a new
2184 buffer for the ESP, so there needs a function to free the old net buffer.
2186 @param[in] Nbuf The network buffer to be freed.
2190 NetIpSecNetbufFree (
2195 This function obtains the system guid from the smbios table.
2197 @param[out] SystemGuid The pointer of the returned system guid.
2199 @retval EFI_SUCCESS Successfully obtained the system guid.
2200 @retval EFI_NOT_FOUND Did not find the SMBIOS table.
2205 NetLibGetSystemGuid (
2206 OUT EFI_GUID
*SystemGuid
2210 Create Dns QName according the queried domain name.
2211 QName is a domain name represented as a sequence of labels,
2212 where each label consists of a length octet followed by that
2213 number of octets. The QName terminates with the zero
2214 length octet for the null label of the root. Caller should
2215 take responsibility to free the buffer in returned pointer.
2217 @param DomainName The pointer to the queried domain name string.
2219 @retval NULL Failed to fill QName.
2220 @return QName filled successfully.
2225 NetLibCreateDnsQName (
2226 IN CHAR16
*DomainName