X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdeModulePkg%2FInclude%2FLibrary%2FNetLib.h;h=b9df46c50f63f73671654e246bdb37d8caf8d603;hp=1a0507b9e6f939a6d4b18c3b590e464f568309b7;hb=29788f178e48fa5ffe7d3262d73c9548e9285d2d;hpb=b45b45b2d248892930620c33a9d01d8457ae0e54
diff --git a/MdeModulePkg/Include/Library/NetLib.h b/MdeModulePkg/Include/Library/NetLib.h
index 1a0507b9e6..b9df46c50f 100644
--- a/MdeModulePkg/Include/Library/NetLib.h
+++ b/MdeModulePkg/Include/Library/NetLib.h
@@ -1,11 +1,11 @@
/** @file
- Ihis library is only intended to be used by UEFI network stack modules.
+ This library is only intended to be used by UEFI network stack modules.
It provides basic functions for the UEFI network stack.
-Copyright (c) 2005 - 2009, Intel Corporation
-All rights reserved. This program and the accompanying materials
+Copyright (c) 2005 - 2017, Intel Corporation. All rights reserved.
+This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
-which accompanies this distribution. The full text of the license may be found at
+which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
@@ -18,6 +18,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#include
+#include
+#include
+
typedef UINT32 IP4_ADDR;
typedef UINT32 TCP_SEQNO;
typedef UINT16 TCP_PORTNO;
@@ -26,29 +29,71 @@ typedef UINT16 TCP_PORTNO;
#define NET_ETHER_ADDR_LEN 6
#define NET_IFTYPE_ETHERNET 0x01
+#define NET_VLAN_TAG_LEN 4
+#define ETHER_TYPE_VLAN 0x8100
+
#define EFI_IP_PROTO_UDP 0x11
#define EFI_IP_PROTO_TCP 0x06
#define EFI_IP_PROTO_ICMP 0x01
+#define IP4_PROTO_IGMP 0x02
+#define IP6_ICMP 58
+#define DNS_MAX_NAME_SIZE 255
+#define DNS_MAX_MESSAGE_SIZE 512
//
// The address classification
//
-#define IP4_ADDR_CLASSA 1
-#define IP4_ADDR_CLASSB 2
-#define IP4_ADDR_CLASSC 3
+#define IP4_ADDR_CLASSA 1 // Deprecated
+#define IP4_ADDR_CLASSB 2 // Deprecated
+#define IP4_ADDR_CLASSC 3 // Deprecated
#define IP4_ADDR_CLASSD 4
#define IP4_ADDR_CLASSE 5
#define IP4_MASK_NUM 33
+#define IP6_PREFIX_NUM 129
+#define IP4_MASK_MAX 32
+#define IP6_PREFIX_MAX 128
#define IP6_HOP_BY_HOP 0
#define IP6_DESTINATION 60
+#define IP6_ROUTING 43
#define IP6_FRAGMENT 44
#define IP6_AH 51
#define IP6_ESP 50
#define IP6_NO_NEXT_HEADER 59
+#define IP_VERSION_4 4
+#define IP_VERSION_6 6
+
+#define IP6_PREFIX_LENGTH 64
+
+//
+// DNS QTYPE values
+//
+#define DNS_TYPE_A 1
+#define DNS_TYPE_NS 2
+#define DNS_TYPE_CNAME 5
+#define DNS_TYPE_SOA 6
+#define DNS_TYPE_WKS 11
+#define DNS_TYPE_PTR 12
+#define DNS_TYPE_HINFO 13
+#define DNS_TYPE_MINFO 14
+#define DNS_TYPE_MX 15
+#define DNS_TYPE_TXT 16
+#define DNS_TYPE_AAAA 28
+#define DNS_TYPE_SRV_RR 33
+#define DNS_TYPE_AXFR 252
+#define DNS_TYPE_MAILB 253
+#define DNS_TYPE_ANY 255
+
+//
+// DNS QCLASS values
+//
+#define DNS_CLASS_INET 1
+#define DNS_CLASS_CH 3
+#define DNS_CLASS_HS 4
+#define DNS_CLASS_ANY 255
#pragma pack(1)
@@ -61,6 +106,20 @@ typedef struct {
UINT16 EtherType;
} ETHER_HEAD;
+//
+// 802.1Q VLAN Tag Control Information
+//
+typedef union {
+ struct {
+ UINT16 Vid : 12; // Unique VLAN identifier (0 to 4094)
+ UINT16 Cfi : 1; // Canonical Format Indicator
+ UINT16 Priority : 3; // 802.1Q priority level (0 to 7)
+ } Bits;
+ UINT16 Uint16;
+} VLAN_TCI;
+
+#define VLAN_TCI_CFI_CANONICAL_MAC 0
+#define VLAN_TCI_CFI_NON_CANONICAL_MAC 1
//
// The EFI_IP4_HEADER is hard to use because the source and
@@ -156,25 +215,26 @@ typedef struct {
#define NET_MAC_IS_MULTICAST(Mac, BMac, Len) \
(((*((UINT8 *) Mac) & 0x01) == 0x01) && (!NET_MAC_EQUAL (Mac, BMac, Len)))
-#define NTOHL(x) (UINT32)((((UINT32) (x) & 0xff) << 24) | \
- (((UINT32) (x) & 0xff00) << 8) | \
- (((UINT32) (x) & 0xff0000) >> 8) | \
- (((UINT32) (x) & 0xff000000) >> 24))
+#define NTOHL(x) SwapBytes32 (x)
#define HTONL(x) NTOHL(x)
-#define NTOHS(x) (UINT16)((((UINT16) (x) & 0xff) << 8) | \
- (((UINT16) (x) & 0xff00) >> 8))
+#define NTOHS(x) SwapBytes16 (x)
-#define HTONS(x) NTOHS(x)
+#define HTONS(x) NTOHS(x)
+#define NTOHLL(x) SwapBytes64 (x)
+#define HTONLL(x) NTOHLL(x)
+#define NTOHLLL(x) Ip6Swap128 (x)
+#define HTONLLL(x) NTOHLLL(x)
//
// Test the IP's attribute, All the IPs are in host byte order.
//
#define IP4_IS_MULTICAST(Ip) (((Ip) & 0xF0000000) == 0xE0000000)
+#define IP4_IS_UNSPECIFIED(Ip) ((Ip) == 0)
#define IP4_IS_LOCAL_BROADCAST(Ip) ((Ip) == 0xFFFFFFFF)
#define IP4_NET_EQUAL(Ip1, Ip2, NetMask) (((Ip1) & (NetMask)) == ((Ip2) & (NetMask)))
-#define IP4_IS_VALID_NETMASK(Ip) (NetGetMaskLength (Ip) != IP4_MASK_NUM)
+#define IP4_IS_VALID_NETMASK(Ip) (NetGetMaskLength (Ip) != (IP4_MASK_MAX + 1))
#define IP6_IS_MULTICAST(Ip6) (((Ip6)->Addr[0]) == 0xFF)
@@ -187,10 +247,120 @@ typedef struct {
#define EFI_IP6_EQUAL(Ip1, Ip2) (CompareMem ((Ip1), (Ip2), sizeof (EFI_IPv6_ADDRESS)) == 0)
+#define IP4_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv4_ADDRESS)))
+#define IP6_COPY_ADDRESS(Dest, Src) (CopyMem ((Dest), (Src), sizeof (EFI_IPv6_ADDRESS)))
+#define IP6_COPY_LINK_ADDRESS(Mac1, Mac2) (CopyMem ((Mac1), (Mac2), sizeof (EFI_MAC_ADDRESS)))
+
+//
+// The debug level definition. This value is also used as the
+// syslog's severity level. Don't change it.
+//
+#define NETDEBUG_LEVEL_TRACE 5
+#define NETDEBUG_LEVEL_WARNING 4
+#define NETDEBUG_LEVEL_ERROR 3
+
+//
+// Network debug message is sent out as syslog packet.
+//
+#define NET_SYSLOG_FACILITY 16 // Syslog local facility local use
+#define NET_SYSLOG_PACKET_LEN 512
+#define NET_SYSLOG_TX_TIMEOUT (500 * 1000 * 10) // 500ms
+#define NET_DEBUG_MSG_LEN 470 // 512 - (ether+ip4+udp4 head length)
+
+//
+// The debug output expects the ASCII format string, Use %a to print ASCII
+// string, and %s to print UNICODE string. PrintArg must be enclosed in ().
+// For example: NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name));
+//
+#define NET_DEBUG_TRACE(Module, PrintArg) \
+ NetDebugOutput ( \
+ NETDEBUG_LEVEL_TRACE, \
+ Module, \
+ __FILE__, \
+ __LINE__, \
+ NetDebugASPrint PrintArg \
+ )
+
+#define NET_DEBUG_WARNING(Module, PrintArg) \
+ NetDebugOutput ( \
+ NETDEBUG_LEVEL_WARNING, \
+ Module, \
+ __FILE__, \
+ __LINE__, \
+ NetDebugASPrint PrintArg \
+ )
+
+#define NET_DEBUG_ERROR(Module, PrintArg) \
+ NetDebugOutput ( \
+ NETDEBUG_LEVEL_ERROR, \
+ Module, \
+ __FILE__, \
+ __LINE__, \
+ NetDebugASPrint PrintArg \
+ )
/**
- Return the length of the mask.
-
+ Allocate a buffer, then format the message to it. This is a
+ help function for the NET_DEBUG_XXX macros. The PrintArg of
+ these macros treats the variable length print parameters as a
+ single parameter, and pass it to the NetDebugASPrint. For
+ example, NET_DEBUG_TRACE ("Tcp", ("State transit to %a\n", Name))
+ if extracted to:
+
+ NetDebugOutput (
+ NETDEBUG_LEVEL_TRACE,
+ "Tcp",
+ __FILE__,
+ __LINE__,
+ NetDebugASPrint ("State transit to %a\n", Name)
+ )
+
+ @param Format The ASCII format string.
+ @param ... The variable length parameter whose format is determined
+ by the Format string.
+
+ @return The buffer containing the formatted message,
+ or NULL if memory allocation failed.
+
+**/
+CHAR8 *
+EFIAPI
+NetDebugASPrint (
+ IN CHAR8 *Format,
+ ...
+ );
+
+/**
+ Builds an UDP4 syslog packet and send it using SNP.
+
+ This function will locate a instance of SNP then send the message through it.
+ Because it isn't open the SNP BY_DRIVER, apply caution when using it.
+
+ @param Level The severity level of the message.
+ @param Module The Module that generates the log.
+ @param File The file that contains the log.
+ @param Line The exact line that contains the log.
+ @param Message The user message to log.
+
+ @retval EFI_INVALID_PARAMETER Any input parameter is invalid.
+ @retval EFI_OUT_OF_RESOURCES Failed to allocate memory for the packet
+ @retval EFI_SUCCESS The log is discard because that it is more verbose
+ than the mNetDebugLevelMax. Or, it has been sent out.
+**/
+EFI_STATUS
+EFIAPI
+NetDebugOutput (
+ IN UINT32 Level,
+ IN UINT8 *Module,
+ IN UINT8 *File,
+ IN UINT32 Line,
+ IN UINT8 *Message
+ );
+
+
+/**
+ Return the length of the mask.
+
Return the length of the mask. Valid values are 0 to 32.
If the mask is invalid, return the invalid length 33, which is IP4_MASK_NUM.
NetMask is in the host byte order.
@@ -198,7 +368,7 @@ typedef struct {
@param[in] NetMask The netmask to get the length from.
@return The length of the netmask, or IP4_MASK_NUM (33) if the mask is invalid.
-
+
**/
INTN
EFIAPI
@@ -209,19 +379,24 @@ NetGetMaskLength (
/**
Return the class of the IP address, such as class A, B, C.
Addr is in host byte order.
-
+
+ [ATTENTION]
+ Classful addressing (IP class A/B/C) has been deprecated according to RFC4632.
+ Caller of this function could only check the returned value against
+ IP4_ADDR_CLASSD (multicast) or IP4_ADDR_CLASSE (reserved) now.
+
The address of class A starts with 0.
If the address belong to class A, return IP4_ADDR_CLASSA.
- The address of class B starts with 10.
+ The address of class B starts with 10.
If the address belong to class B, return IP4_ADDR_CLASSB.
- The address of class C starts with 110.
+ The address of class C starts with 110.
If the address belong to class C, return IP4_ADDR_CLASSC.
- The address of class D starts with 1110.
+ The address of class D starts with 1110.
If the address belong to class D, return IP4_ADDR_CLASSD.
The address of class E starts with 1111.
If the address belong to class E, return IP4_ADDR_CLASSE.
-
+
@param[in] Addr The address to get the class from.
@return IP address class, such as IP4_ADDR_CLASSA.
@@ -235,22 +410,23 @@ NetGetIpClass (
/**
Check whether the IP is a valid unicast address according to
- the netmask. If NetMask is zero, use the IP address's class to get the default mask.
-
- If Ip is 0, IP is not a valid unicast address.
- Class D address is used for multicasting and class E address is reserved for future. If Ip
- belongs to class D or class E, Ip is not a valid unicast address.
- If all bits of the host address of Ip are 0 or 1, Ip is not a valid unicast address.
+ the netmask.
+ ASSERT if NetMask is zero.
+
+ If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address,
+ except when the originator is one of the endpoints of a point-to-point link with a 31-bit
+ mask (RFC3021).
+
@param[in] Ip The IP to check against.
@param[in] NetMask The mask of the IP.
- @return TRUE if Ip is a valid unicast address on the network, otherwise FALSE.
+ @return TRUE if IP is a valid unicast address on the network, otherwise FALSE.
**/
BOOLEAN
EFIAPI
-Ip4IsUnicast (
+NetIp4IsUnicast (
IN IP4_ADDR Ip,
IN IP4_ADDR NetMask
);
@@ -262,31 +438,83 @@ Ip4IsUnicast (
a valid unicast address. If the address is unspecified ::, it is not a valid
unicast address to be assigned to any node. If the address is loopback address
::1, it is also not a valid unicast address to be assigned to any physical
- interface.
+ interface.
@param[in] Ip6 The IPv6 address to check against.
@return TRUE if Ip6 is a valid unicast address on the network, otherwise FALSE.
-**/
+**/
BOOLEAN
-Ip6IsValidUnicast (
+EFIAPI
+NetIp6IsValidUnicast (
IN EFI_IPv6_ADDRESS *Ip6
);
+
+/**
+ Check whether the incoming Ipv6 address is the unspecified address or not.
+
+ @param[in] Ip6 - Ip6 address, in network order.
+
+ @retval TRUE - Yes, incoming Ipv6 address is the unspecified address.
+ @retval FALSE - The incoming Ipv6 address is not the unspecified address
+
+**/
+BOOLEAN
+EFIAPI
+NetIp6IsUnspecifiedAddr (
+ IN EFI_IPv6_ADDRESS *Ip6
+ );
+
+/**
+ Check whether the incoming Ipv6 address is a link-local address.
+
+ @param[in] Ip6 - Ip6 address, in network order.
+
+ @retval TRUE - The incoming Ipv6 address is a link-local address.
+ @retval FALSE - The incoming Ipv6 address is not a link-local address.
+
+**/
+BOOLEAN
+EFIAPI
+NetIp6IsLinkLocalAddr (
+ IN EFI_IPv6_ADDRESS *Ip6
+ );
+
+/**
+ Check whether the Ipv6 address1 and address2 are on the connected network.
+
+ @param[in] Ip1 - Ip6 address1, in network order.
+ @param[in] Ip2 - Ip6 address2, in network order.
+ @param[in] PrefixLength - The prefix length of the checking net.
+
+ @retval TRUE - Yes, the Ipv6 address1 and address2 are connected.
+ @retval FALSE - No the Ipv6 address1 and address2 are not connected.
+
+**/
+BOOLEAN
+EFIAPI
+NetIp6IsNetEqual (
+ EFI_IPv6_ADDRESS *Ip1,
+ EFI_IPv6_ADDRESS *Ip2,
+ UINT8 PrefixLength
+ );
+
/**
- Switches the endianess of an IPv6 address
+ Switches the endianess of an IPv6 address.
This function swaps the bytes in a 128-bit IPv6 address to switch the value
from little endian to big endian or vice versa. The byte swapped value is
returned.
- @param Ip6 Points to an IPv6 address
+ @param Ip6 Points to an IPv6 address.
@return The byte swapped IPv6 address.
**/
EFI_IPv6_ADDRESS *
+EFIAPI
Ip6Swap128 (
EFI_IPv6_ADDRESS *Ip6
);
@@ -297,6 +525,7 @@ extern IP4_ADDR gIp4AllMasks[IP4_MASK_NUM];
extern EFI_IPv4_ADDRESS mZeroIp4Addr;
#define NET_IS_DIGIT(Ch) (('0' <= (Ch)) && ((Ch) <= '9'))
+#define NET_IS_HEX(Ch) ((('0' <= (Ch)) && ((Ch) <= '9')) || (('A' <= (Ch)) && ((Ch) <= 'F')) || (('a' <= (Ch)) && ((Ch) <= 'f')))
#define NET_ROUNDUP(size, unit) (((size) + (unit) - 1) & (~((unit) - 1)))
#define NET_IS_LOWER_CASE_CHAR(Ch) (('a' <= (Ch)) && ((Ch) <= 'z'))
#define NET_IS_UPPER_CASE_CHAR(Ch) (('A' <= (Ch)) && ((Ch) <= 'Z'))
@@ -308,8 +537,8 @@ extern EFI_IPv4_ADDRESS mZeroIp4Addr;
/**
Extract a UINT32 from a byte stream.
-
- This function copies a UINT32 from a byte stream, and then converts it from Network
+
+ This function copies a UINT32 from a byte stream, and then converts it from Network
byte order to host byte order. Use this function to avoid alignment error.
@param[in] Buf The buffer to extract the UINT32.
@@ -324,14 +553,14 @@ NetGetUint32 (
);
/**
- Puts a UINT32 into the byte stream in network byte order.
-
- Converts a UINT32 from host byte order to network byte order, and then copies it to the
+ Puts a UINT32 into the byte stream in network byte order.
+
+ Converts a UINT32 from host byte order to network byte order, then copies it to the
byte stream.
- @param[in, out] Buf The buffer to put the UINT32.
- @param[in] Data The data to put.
-
+ @param[in, out] Buf The buffer in which to put the UINT32.
+ @param[in] Data The data to be converted and put into the byte stream.
+
**/
VOID
EFIAPI
@@ -341,13 +570,13 @@ NetPutUint32 (
);
/**
- Initialize a random seed using current time.
-
- Get current time first. Then initialize a random seed based on some basic
- mathematical operations on the hour, day, minute, second, nanosecond and year
- of the current time.
-
- @return The random seed, initialized with current time.
+ Initialize a random seed using current time and monotonic count.
+
+ Get current time and monotonic count first. Then initialize a random seed
+ based on some basic mathematics operation on the hour, day, minute, second,
+ nanosecond and year of the current time and the monotonic count value.
+
+ @return The random seed initialized with current time.
**/
UINT32
@@ -393,16 +622,16 @@ NetRandomInitSeed (
/**
Remove the first node entry on the list, and return the removed node entry.
-
+
Removes the first node entry from a doubly linked list. It is up to the caller of
this function to release the memory used by the first node, if that is required. On
- exit, the removed node is returned.
+ exit, the removed node is returned.
If Head is NULL, then ASSERT().
If Head was not initialized, then ASSERT().
If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
- then ASSERT().
+ then ASSERT().
@param[in, out] Head The list header.
@@ -420,14 +649,14 @@ NetListRemoveHead (
Removes the last node entry from a doubly linked list. It is up to the caller of
this function to release the memory used by the first node, if that is required. On
- exit, the removed node is returned.
+ exit, the removed node is returned.
If Head is NULL, then ASSERT().
If Head was not initialized, then ASSERT().
If PcdMaximumLinkedListLength is not zero, and the number of nodes in the
linked list including the head node is greater than or equal to PcdMaximumLinkedListLength,
- then ASSERT().
-
+ then ASSERT().
+
@param[in, out] Head The list head.
@return The last node entry that is removed from the list, NULL if the list is empty.
@@ -441,11 +670,11 @@ NetListRemoveTail (
/**
Insert a new node entry after a designated node entry of a doubly linked list.
-
+
Inserts a new node entry designated by NewEntry after the node entry designated by PrevEntry
of the doubly linked list.
-
- @param[in, out] PrevEntry The entry after which to insert.
+
+ @param[in, out] PrevEntry The entry after which to insert.
@param[in, out] NewEntry The new entry to insert.
**/
@@ -458,10 +687,10 @@ NetListInsertAfter (
/**
Insert a new node entry before a designated node entry of a doubly linked list.
-
+
Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry
of the doubly linked list.
-
+
@param[in, out] PostEntry The entry to insert before.
@param[in, out] NewEntry The new entry to insert.
@@ -473,6 +702,73 @@ NetListInsertBefore (
IN OUT LIST_ENTRY *NewEntry
);
+/**
+ Callback function which provided by user to remove one node in NetDestroyLinkList process.
+
+ @param[in] Entry The entry to be removed.
+ @param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.
+
+ @retval EFI_SUCCESS The entry has been removed successfully.
+ @retval Others Fail to remove the entry.
+
+**/
+typedef
+EFI_STATUS
+(EFIAPI *NET_DESTROY_LINK_LIST_CALLBACK) (
+ IN LIST_ENTRY *Entry,
+ IN VOID *Context OPTIONAL
+ );
+
+/**
+ Safe destroy nodes in a linked list, and return the length of the list after all possible operations finished.
+
+ Destroy network children list by list traversals is not safe due to graph dependencies between nodes.
+ This function performs a safe traversal to destroy these nodes by checking to see if the node being destroyed
+ has been removed from the list or not.
+ If it has been removed, then restart the traversal from the head.
+ If it hasn't been removed, then continue with the next node directly.
+ This function will end the iterate and return the CallBack's last return value if error happens,
+ or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.
+
+ @param[in] List The head of the list.
+ @param[in] CallBack Pointer to the callback function to destroy one node in the list.
+ @param[in] Context Pointer to the callback function's context: corresponds to the
+ parameter Context in NET_DESTROY_LINK_LIST_CALLBACK.
+ @param[out] ListLength The length of the link list if the function returns successfully.
+
+ @retval EFI_SUCCESS Two complete passes are made with no changes in the number of children.
+ @retval EFI_INVALID_PARAMETER The input parameter is invalid.
+ @retval Others Return the CallBack's last return value.
+
+**/
+EFI_STATUS
+EFIAPI
+NetDestroyLinkList (
+ IN LIST_ENTRY *List,
+ IN NET_DESTROY_LINK_LIST_CALLBACK CallBack,
+ IN VOID *Context, OPTIONAL
+ OUT UINTN *ListLength OPTIONAL
+ );
+
+/**
+ This function checks the input Handle to see if it's one of these handles in ChildHandleBuffer.
+
+ @param[in] Handle Handle to be checked.
+ @param[in] NumberOfChildren Number of Handles in ChildHandleBuffer.
+ @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
+ if NumberOfChildren is 0.
+
+ @retval TRUE Found the input Handle in ChildHandleBuffer.
+ @retval FALSE Can't find the input Handle in ChildHandleBuffer.
+
+**/
+BOOLEAN
+EFIAPI
+NetIsInHandleBuffer (
+ IN EFI_HANDLE Handle,
+ IN UINTN NumberOfChildren,
+ IN EFI_HANDLE *ChildHandleBuffer OPTIONAL
+ );
//
// Object container: EFI network stack spec defines various kinds of
@@ -494,15 +790,15 @@ typedef struct {
/**
Initialize the netmap. Netmap is a reposity to keep the pairs.
-
- Initialize the forward and backward links of two head nodes donated by Map->Used
+
+ Initialize the forward and backward links of two head nodes donated by Map->Used
and Map->Recycled of two doubly linked lists.
Initializes the count of the pairs in the netmap to zero.
-
+
If Map is NULL, then ASSERT().
If the address of Map->Used is NULL, then ASSERT().
If the address of Map->Recycled is NULl, then ASSERT().
-
+
@param[in, out] Map The netmap to initialize.
**/
@@ -514,13 +810,13 @@ NetMapInit (
/**
To clean up the netmap, that is, release allocated memories.
-
+
Removes all nodes of the Used doubly linked list and frees memory of all related netmap items.
Removes all nodes of the Recycled doubly linked list and free memory of all related netmap items.
The number of the pairs in the netmap is set to zero.
-
+
If Map is NULL, then ASSERT().
-
+
@param[in, out] Map The netmap to clean up.
**/
@@ -532,12 +828,12 @@ NetMapClean (
/**
Test whether the netmap is empty and return true if it is.
-
+
If the number of the pairs in the netmap is zero, return TRUE.
-
+
If Map is NULL, then ASSERT().
-
-
+
+
@param[in] Map The net map to test.
@return TRUE if the netmap is empty, otherwise FALSE.
@@ -565,13 +861,13 @@ NetMapGetCount (
/**
Allocate an item to save the pair to the head of the netmap.
-
+
Allocate an item to save the pair and add corresponding node entry
- to the beginning of the Used doubly linked list. The number of the
+ to the beginning of the Used doubly linked list. The number of the
pairs in the netmap increase by 1.
If Map is NULL, then ASSERT().
-
+
@param[in, out] Map The netmap to insert into.
@param[in] Key The user's key.
@param[in] Value The user's value for the key.
@@ -592,11 +888,11 @@ NetMapInsertHead (
Allocate an item to save the pair to the tail of the netmap.
Allocate an item to save the pair and add corresponding node entry
- to the tail of the Used doubly linked list. The number of the
+ to the tail of the Used doubly linked list. The number of the
pairs in the netmap increase by 1.
If Map is NULL, then ASSERT().
-
+
@param[in, out] Map The netmap to insert into.
@param[in] Key The user's key.
@param[in] Value The user's value for the key.
@@ -615,12 +911,12 @@ NetMapInsertTail (
/**
Finds the key in the netmap and returns the point to the item containing the Key.
-
- Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every
+
+ Iterate the Used doubly linked list of the netmap to get every item. Compare the key of every
item with the key to search. It returns the point to the item contains the Key if found.
If Map is NULL, then ASSERT().
-
+
@param[in] Map The netmap to search within.
@param[in] Key The key to search.
@@ -636,16 +932,16 @@ NetMapFindKey (
/**
Remove the node entry of the item from the netmap and return the key of the removed item.
-
- Remove the node entry of the item from the Used doubly linked list of the netmap.
- The number of the pairs in the netmap decrease by 1. Then add the node
+
+ Remove the node entry of the item from the Used doubly linked list of the netmap.
+ The number of the pairs in the netmap decrease by 1. Then add the node
entry of the item to the Recycled doubly linked list of the netmap. If Value is not NULL,
Value will point to the value of the item. It returns the key of the removed item.
-
+
If Map is NULL, then ASSERT().
If Item is NULL, then ASSERT().
if item in not in the netmap, then ASSERT().
-
+
@param[in, out] Map The netmap to remove the item from.
@param[in, out] Item The item to remove.
@param[out] Value The variable to receive the value if not NULL.
@@ -664,14 +960,14 @@ NetMapRemoveItem (
/**
Remove the first node entry on the netmap and return the key of the removed item.
- Remove the first node entry from the Used doubly linked list of the netmap.
- The number of the pairs in the netmap decrease by 1. Then add the node
+ Remove the first node entry from the Used doubly linked list of the netmap.
+ The number of the pairs in the netmap decrease by 1. Then add the node
entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
parameter Value will point to the value of the item. It returns the key of the removed item.
-
+
If Map is NULL, then ASSERT().
If the Used doubly linked list is empty, then ASSERT().
-
+
@param[in, out] Map The netmap to remove the head from.
@param[out] Value The variable to receive the value if not NULL.
@@ -688,14 +984,14 @@ NetMapRemoveHead (
/**
Remove the last node entry on the netmap and return the key of the removed item.
- Remove the last node entry from the Used doubly linked list of the netmap.
- The number of the pairs in the netmap decrease by 1. Then add the node
+ Remove the last node entry from the Used doubly linked list of the netmap.
+ The number of the pairs in the netmap decrease by 1. Then add the node
entry to the Recycled doubly linked list of the netmap. If parameter Value is not NULL,
parameter Value will point to the value of the item. It returns the key of the removed item.
-
+
If Map is NULL, then ASSERT().
If the Used doubly linked list is empty, then ASSERT().
-
+
@param[in, out] Map The netmap to remove the tail from.
@param[out] Value The variable to receive the value if not NULL.
@@ -711,7 +1007,7 @@ NetMapRemoveTail (
typedef
EFI_STATUS
-(*NET_MAP_CALLBACK) (
+(EFIAPI *NET_MAP_CALLBACK) (
IN NET_MAP *Map,
IN NET_MAP_ITEM *Item,
IN VOID *Arg
@@ -719,20 +1015,20 @@ EFI_STATUS
/**
Iterate through the netmap and call CallBack for each item.
-
- It will contiue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
- from the loop. It returns the CallBack's last return value. This function is
+
+ It will continue the traverse if CallBack returns EFI_SUCCESS, otherwise, break
+ from the loop. It returns the CallBack's last return value. This function is
delete safe for the current item.
If Map is NULL, then ASSERT().
If CallBack is NULL, then ASSERT().
-
+
@param[in] Map The Map to iterate through.
@param[in] CallBack The callback function to call for each item.
@param[in] Arg The opaque parameter to the callback.
- @retval EFI_SUCCESS There is no item in the netmap or CallBack for each item
- return EFI_SUCCESS.
+ @retval EFI_SUCCESS There is no item in the netmap, or CallBack for each item
+ returns EFI_SUCCESS.
@retval Others It returns the CallBack's last return value.
**/
@@ -741,7 +1037,7 @@ EFIAPI
NetMapIterate (
IN NET_MAP *Map,
IN NET_MAP_CALLBACK CallBack,
- IN VOID *Arg
+ IN VOID *Arg OPTIONAL
);
@@ -750,12 +1046,12 @@ NetMapIterate (
//
/**
Create a child of the service that is identified by ServiceBindingGuid.
-
+
Get the ServiceBinding Protocol first, then use it to create a child.
If ServiceBindingGuid is NULL, then ASSERT().
If ChildHandle is NULL, then ASSERT().
-
+
@param[in] Controller The controller which has the service installed.
@param[in] Image The image handle used to open service.
@param[in] ServiceBindingGuid The service's Guid.
@@ -776,17 +1072,17 @@ NetLibCreateServiceChild (
/**
Destroy a child of the service that is identified by ServiceBindingGuid.
-
+
Get the ServiceBinding Protocol first, then use it to destroy a child.
-
+
If ServiceBindingGuid is NULL, then ASSERT().
-
+
@param[in] Controller The controller which has the service installed.
@param[in] Image The image handle used to open service.
@param[in] ServiceBindingGuid The service's Guid.
@param[in] ChildHandle The child to destroy.
- @retval EFI_SUCCESS The child is successfully destroyed.
+ @retval EFI_SUCCESS The child was destroyed.
@retval Others Failed to destroy the child.
**/
@@ -800,22 +1096,109 @@ NetLibDestroyServiceChild (
);
/**
- Convert the mac address of the simple network protocol installed on
- SnpHandle to a unicode string. Callers are responsible for freeing the
- string storage.
+ Get handle with Simple Network Protocol installed on it.
+
+ There should be MNP Service Binding Protocol installed on the input ServiceHandle.
+ If Simple Network Protocol is already installed on the ServiceHandle, the
+ ServiceHandle will be returned. If SNP is not installed on the ServiceHandle,
+ try to find its parent handle with SNP installed.
+
+ @param[in] ServiceHandle The handle where network service binding protocols are
+ installed on.
+ @param[out] Snp The pointer to store the address of the SNP instance.
+ This is an optional parameter that may be NULL.
+
+ @return The SNP handle, or NULL if not found.
+
+**/
+EFI_HANDLE
+EFIAPI
+NetLibGetSnpHandle (
+ IN EFI_HANDLE ServiceHandle,
+ OUT EFI_SIMPLE_NETWORK_PROTOCOL **Snp OPTIONAL
+ );
+
+/**
+ Retrieve VLAN ID of a VLAN device handle.
+
+ Search VLAN device path node in Device Path of specified ServiceHandle and
+ return its VLAN ID. If no VLAN device path node found, then this ServiceHandle
+ is not a VLAN device handle, and 0 will be returned.
+
+ @param[in] ServiceHandle The handle where network service binding protocols are
+ installed on.
+
+ @return VLAN ID of the device handle, or 0 if not a VLAN device.
+
+**/
+UINT16
+EFIAPI
+NetLibGetVlanId (
+ IN EFI_HANDLE ServiceHandle
+ );
+
+/**
+ Find VLAN device handle with specified VLAN ID.
+
+ The VLAN child device handle is created by VLAN Config Protocol on ControllerHandle.
+ This function will append VLAN device path node to the parent device path,
+ and then use LocateDevicePath() to find the correct VLAN device handle.
+
+ @param[in] ControllerHandle The handle where network service binding protocols are
+ installed on.
+ @param[in] VlanId The configured VLAN ID for the VLAN device.
+
+ @return The VLAN device handle, or NULL if not found.
+
+**/
+EFI_HANDLE
+EFIAPI
+NetLibGetVlanHandle (
+ IN EFI_HANDLE ControllerHandle,
+ IN UINT16 VlanId
+ );
+
+/**
+ Get MAC address associated with the network service handle.
+
+ There should be MNP Service Binding Protocol installed on the input ServiceHandle.
+ If SNP is installed on the ServiceHandle or its parent handle, MAC address will
+ be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.
+
+ @param[in] ServiceHandle The handle where network service binding protocols are
+ installed on.
+ @param[out] MacAddress The pointer to store the returned MAC address.
+ @param[out] AddressSize The length of returned MAC address.
+
+ @retval EFI_SUCCESS MAC address was returned successfully.
+ @retval Others Failed to get SNP mode data.
+
+**/
+EFI_STATUS
+EFIAPI
+NetLibGetMacAddress (
+ IN EFI_HANDLE ServiceHandle,
+ OUT EFI_MAC_ADDRESS *MacAddress,
+ OUT UINTN *AddressSize
+ );
- Get the mac address of the Simple Network protocol from the SnpHandle. Then convert
- the mac address into a unicode string. It takes 2 unicode characters to represent
- a 1 byte binary buffer, plus one unicode character for the null terminator.
+/**
+ Convert MAC address of the NIC associated with specified Service Binding Handle
+ to a unicode string. Callers are responsible for freeing the string storage.
+ Locate simple network protocol associated with the Service Binding Handle and
+ get the mac address from SNP. Then convert the mac address into a unicode
+ string. It takes 2 unicode characters to represent a 1 byte binary buffer.
+ Plus one unicode character for the null-terminator.
- @param[in] SnpHandle The handle on which the simple network protocol is
+ @param[in] ServiceHandle The handle where network service binding protocol is
installed.
- @param[in] ImageHandle The image handle to act as the agent handle to
- get the simple network protocol.
+ @param[in] ImageHandle The image handle used to act as the agent handle to
+ get the simple network protocol. This parameter is
+ optional and may be NULL.
@param[out] MacString The pointer to store the address of the string
representation of the mac address.
-
+
@retval EFI_SUCCESS Converted the mac address a unicode string successfully.
@retval EFI_OUT_OF_RESOURCES There are not enough memory resources.
@retval Others Failed to open the simple network protocol.
@@ -824,21 +1207,56 @@ NetLibDestroyServiceChild (
EFI_STATUS
EFIAPI
NetLibGetMacString (
- IN EFI_HANDLE SnpHandle,
- IN EFI_HANDLE ImageHandle,
+ IN EFI_HANDLE ServiceHandle,
+ IN EFI_HANDLE ImageHandle, OPTIONAL
OUT CHAR16 **MacString
);
+/**
+ Detect media status for specified network device.
+
+ The underlying UNDI driver may or may not support reporting media status from
+ GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine
+ will try to invoke Snp->GetStatus() to get the media status. If media is already
+ present, it returns directly. If media is not present, it will stop SNP and then
+ restart SNP to get the latest media status. This provides an opportunity to get
+ the correct media status for old UNDI driver, which doesn't support reporting
+ media status from GET_STATUS command.
+ Note: there are two limitations for the current algorithm:
+ 1) For UNDI with this capability, when the cable is not attached, there will
+ be an redundant Stop/Start() process.
+ 2) for UNDI without this capability, in case that network cable is attached when
+ Snp->Initialize() is invoked while network cable is unattached later,
+ NetLibDetectMedia() will report MediaPresent as TRUE, causing upper layer
+ apps to wait for timeout time.
+
+ @param[in] ServiceHandle The handle where network service binding protocols are
+ installed.
+ @param[out] MediaPresent The pointer to store the media status.
+
+ @retval EFI_SUCCESS Media detection success.
+ @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle.
+ @retval EFI_UNSUPPORTED The network device does not support media detection.
+ @retval EFI_DEVICE_ERROR SNP is in an unknown state.
+
+**/
+EFI_STATUS
+EFIAPI
+NetLibDetectMedia (
+ IN EFI_HANDLE ServiceHandle,
+ OUT BOOLEAN *MediaPresent
+ );
+
/**
Create an IPv4 device path node.
-
+
The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.
The header subtype of IPv4 device path node is MSG_IPv4_DP.
The length of the IPv4 device path node in bytes is 19.
- Get other info from parameters to make up the whole IPv4 device path node.
+ Get other information from parameters to make up the whole IPv4 device path node.
- @param[in, out] Node Pointer to the IPv4 device path node.
- @param[in] Controller The handle where the NIC IP4 config protocol resides.
+ @param[in, out] Node The pointer to the IPv4 device path node.
+ @param[in] Controller The controller handle.
@param[in] LocalIp The local IPv4 address.
@param[in] LocalPort The local port.
@param[in] RemoteIp The remote IPv4 address.
@@ -860,18 +1278,48 @@ NetLibCreateIPv4DPathNode (
IN BOOLEAN UseDefaultAddress
);
+/**
+ Create an IPv6 device path node.
+
+ The header type of IPv6 device path node is MESSAGING_DEVICE_PATH.
+ The header subtype of IPv6 device path node is MSG_IPv6_DP.
+ The length of the IPv6 device path node in bytes is 43.
+ Get other information from parameters to make up the whole IPv6 device path node.
+
+ @param[in, out] Node The pointer to the IPv6 device path node.
+ @param[in] Controller The controller handle.
+ @param[in] LocalIp The local IPv6 address.
+ @param[in] LocalPort The local port.
+ @param[in] RemoteIp The remote IPv6 address.
+ @param[in] RemotePort The remote port.
+ @param[in] Protocol The protocol type in the IP header.
+
+**/
+VOID
+EFIAPI
+NetLibCreateIPv6DPathNode (
+ IN OUT IPv6_DEVICE_PATH *Node,
+ IN EFI_HANDLE Controller,
+ IN EFI_IPv6_ADDRESS *LocalIp,
+ IN UINT16 LocalPort,
+ IN EFI_IPv6_ADDRESS *RemoteIp,
+ IN UINT16 RemotePort,
+ IN UINT16 Protocol
+ );
+
+
/**
Find the UNDI/SNP handle from controller and protocol GUID.
-
+
For example, IP will open an MNP child to transmit/receive
packets. When MNP is stopped, IP should also be stopped. IP
- needs to find its own private data which is related the IP's
- service binding instance that is install on UNDI/SNP handle.
- Now, the controller is either a MNP or ARP child handle. But
- IP opens these handle BY_DRIVER, use that info, we can get the
+ needs to find its own private data that is related the IP's
+ service binding instance that is installed on the UNDI/SNP handle.
+ The controller is then either an MNP or an ARP child handle. Note that
+ IP opens these handles using BY_DRIVER. Use that information to get the
UNDI/SNP handle.
- @param[in] Controller Then protocol handle to check.
+ @param[in] Controller The protocol handle to check.
@param[in] ProtocolGuid The protocol that is related with the handle.
@return The UNDI/SNP handle or NULL for errors.
@@ -889,7 +1337,7 @@ NetLibGetNicHandle (
Disconnect the driver specified by ImageHandle from all the devices in the handle database.
Uninstall all the protocols installed in the driver entry point.
-
+
@param[in] ImageHandle The drivers' driver image.
@retval EFI_SUCCESS The image is unloaded.
@@ -902,9 +1350,121 @@ NetLibDefaultUnload (
IN EFI_HANDLE ImageHandle
);
+/**
+ Convert one Null-terminated ASCII string (decimal dotted) to EFI_IPv4_ADDRESS.
+
+ @param[in] String The pointer to the Ascii string.
+ @param[out] Ip4Address The pointer to the converted IPv4 address.
+
+ @retval EFI_SUCCESS Converted to an IPv4 address successfully.
+ @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip4Address is NULL.
+
+**/
+EFI_STATUS
+EFIAPI
+NetLibAsciiStrToIp4 (
+ IN CONST CHAR8 *String,
+ OUT EFI_IPv4_ADDRESS *Ip4Address
+ );
+
+/**
+ Convert one Null-terminated ASCII string to EFI_IPv6_ADDRESS. The format of the
+ string is defined in RFC 4291 - Text Representation of Addresses.
+
+ @param[in] String The pointer to the Ascii string.
+ @param[out] Ip6Address The pointer to the converted IPv6 address.
+
+ @retval EFI_SUCCESS Converted to an IPv6 address successfully.
+ @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip6Address is NULL.
+
+**/
+EFI_STATUS
+EFIAPI
+NetLibAsciiStrToIp6 (
+ IN CONST CHAR8 *String,
+ OUT EFI_IPv6_ADDRESS *Ip6Address
+ );
+
+/**
+ Convert one Null-terminated Unicode string (decimal dotted) to EFI_IPv4_ADDRESS.
+
+ @param[in] String The pointer to the Ascii string.
+ @param[out] Ip4Address The pointer to the converted IPv4 address.
+
+ @retval EFI_SUCCESS Converted to an IPv4 address successfully.
+ @retval EFI_INVALID_PARAMETER The string is mal-formatted or Ip4Address is NULL.
+
+**/
+EFI_STATUS
+EFIAPI
+NetLibStrToIp4 (
+ IN CONST CHAR16 *String,
+ OUT EFI_IPv4_ADDRESS *Ip4Address
+ );
+
+/**
+ Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS. The format of
+ the string is defined in RFC 4291 - Text Representation of Addresses.
+
+ @param[in] String The pointer to the Ascii string.
+ @param[out] Ip6Address The pointer to the converted IPv6 address.
+
+ @retval EFI_SUCCESS Converted to an IPv6 address successfully.
+ @retval EFI_INVALID_PARAMETER The string is malformatted or Ip6Address is NULL.
+
+**/
+EFI_STATUS
+EFIAPI
+NetLibStrToIp6 (
+ IN CONST CHAR16 *String,
+ OUT EFI_IPv6_ADDRESS *Ip6Address
+ );
+
+/**
+ Convert one Null-terminated Unicode string to EFI_IPv6_ADDRESS and prefix length.
+ The format of the string is defined in RFC 4291 - Text Representation of Addresses
+ Prefixes: ipv6-address/prefix-length.
+
+ @param[in] String The pointer to the Ascii string.
+ @param[out] Ip6Address The pointer to the converted IPv6 address.
+ @param[out] PrefixLength The pointer to the converted prefix length.
+
+ @retval EFI_SUCCESS Converted to an IPv6 address successfully.
+ @retval EFI_INVALID_PARAMETER The string is malformatted, or Ip6Address is NULL.
+
+**/
+EFI_STATUS
+EFIAPI
+NetLibStrToIp6andPrefix (
+ IN CONST CHAR16 *String,
+ OUT EFI_IPv6_ADDRESS *Ip6Address,
+ OUT UINT8 *PrefixLength
+ );
+
+/**
+
+ Convert one EFI_IPv6_ADDRESS to Null-terminated Unicode string.
+ The text representation of address is defined in RFC 4291.
+
+ @param[in] Ip6Address The pointer to the IPv6 address.
+ @param[out] String The buffer to return the converted string.
+ @param[in] StringSize The length in bytes of the input String.
+
+ @retval EFI_SUCCESS Convert to string successfully.
+ @retval EFI_INVALID_PARAMETER The input parameter is invalid.
+ @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result. BufferSize has been
+ updated with the size needed to complete the request.
+**/
+EFI_STATUS
+EFIAPI
+NetLibIp6ToStr (
+ IN EFI_IPv6_ADDRESS *Ip6Address,
+ OUT CHAR16 *String,
+ IN UINTN StringSize
+ );
//
-//Various signatures
+// Various signatures
//
#define NET_BUF_SIGNATURE SIGNATURE_32 ('n', 'b', 'u', 'f')
#define NET_VECTOR_SIGNATURE SIGNATURE_32 ('n', 'v', 'e', 'c')
@@ -919,9 +1479,6 @@ NetLibDefaultUnload (
#define NET_CHECK_SIGNATURE(PData, SIGNATURE) \
ASSERT (((PData) != NULL) && ((PData)->Signature == (SIGNATURE)))
-#define NET_SWAP_SHORT(Value) \
- ((((Value) & 0xff) << 8) | (((Value) >> 8) & 0xff))
-
//
// Single memory block in the vector.
//
@@ -930,7 +1487,7 @@ typedef struct {
UINT8 *Bulk; // The block's Data
} NET_BLOCK;
-typedef VOID (*NET_VECTOR_EXT_FREE) (VOID *Arg);
+typedef VOID (EFIAPI *NET_VECTOR_EXT_FREE) (VOID *Arg);
//
//NET_VECTOR contains several blocks to hold all packet's
@@ -941,9 +1498,9 @@ typedef struct {
UINT32 Signature;
INTN RefCnt; // Reference count to share NET_VECTOR.
NET_VECTOR_EXT_FREE Free; // external function to free NET_VECTOR
- VOID *Arg; // opeque argument to Free
+ VOID *Arg; // opaque argument to Free
UINT32 Flag; // Flags, NET_VECTOR_OWN_FIRST
- UINT32 Len; // Total length of the assocated BLOCKs
+ UINT32 Len; // Total length of the associated BLOCKs
UINT32 BlockNum;
NET_BLOCK Block[1];
@@ -961,6 +1518,10 @@ typedef struct {
UINT32 Size; // The size of the data
} NET_BLOCK_OP;
+typedef union {
+ IP4_HEAD *Ip4;
+ EFI_IP6_HEADER *Ip6;
+} NET_IP_HEAD;
//
//NET_BUF is the buffer manage structure used by the
@@ -973,22 +1534,22 @@ typedef struct {
//to overwrite the members after that.
//
typedef struct {
- UINT32 Signature;
- INTN RefCnt;
- LIST_ENTRY List; // The List this NET_BUF is on
+ UINT32 Signature;
+ INTN RefCnt;
+ LIST_ENTRY List; // The List this NET_BUF is on
- IP4_HEAD *Ip; // Network layer header, for fast access
- TCP_HEAD *Tcp; // Transport layer header, for fast access
- UINT8 ProtoData [NET_PROTO_DATA]; //Protocol specific data
+ NET_IP_HEAD Ip; // Network layer header, for fast access
+ TCP_HEAD *Tcp; // Transport layer header, for fast access
+ EFI_UDP_HEADER *Udp; // User Datagram Protocol header
+ UINT8 ProtoData [NET_PROTO_DATA]; //Protocol specific data
- NET_VECTOR *Vector; // The vector containing the packet
+ NET_VECTOR *Vector; // The vector containing the packet
- UINT32 BlockOpNum; // Total number of BlockOp in the buffer
- UINT32 TotalSize; // Total size of the actual packet
- NET_BLOCK_OP BlockOp[1]; // Specify the position of actual packet
+ UINT32 BlockOpNum; // Total number of BlockOp in the buffer
+ UINT32 TotalSize; // Total size of the actual packet
+ NET_BLOCK_OP BlockOp[1]; // Specify the position of actual packet
} NET_BUF;
-
//
//A queue of NET_BUFs. It is a thin extension of
//NET_BUF functions.
@@ -1014,6 +1575,14 @@ typedef struct {
UINT8 Protocol;
UINT16 Len;
} NET_PSEUDO_HDR;
+
+typedef struct {
+ EFI_IPv6_ADDRESS SrcIp;
+ EFI_IPv6_ADDRESS DstIp;
+ UINT32 Len;
+ UINT32 Reserved:24;
+ UINT32 NextHeader:8;
+} NET_IP6_PSEUDO_HDR;
#pragma pack()
//
@@ -1040,10 +1609,10 @@ typedef struct {
(sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))
#define NET_HEADSPACE(BlockOp) \
- (UINTN)((BlockOp)->Head - (BlockOp)->BlockHead)
+ ((UINTN)((BlockOp)->Head) - (UINTN)((BlockOp)->BlockHead))
#define NET_TAILSPACE(BlockOp) \
- (UINTN)((BlockOp)->BlockTail - (BlockOp)->Tail)
+ ((UINTN)((BlockOp)->BlockTail) - (UINTN)((BlockOp)->Tail))
/**
Allocate a single block NET_BUF. Upon allocation, all the
@@ -1051,8 +1620,8 @@ typedef struct {
@param[in] Len The length of the block.
- @return Pointer to the allocated NET_BUF, or NULL if the
- allocation failed due to resource limit.
+ @return The pointer to the allocated NET_BUF, or NULL if the
+ allocation failed due to resource limitations.
**/
NET_BUF *
@@ -1063,14 +1632,14 @@ NetbufAlloc (
/**
Free the net buffer and its associated NET_VECTOR.
-
+
Decrease the reference count of the net buffer by one. Free the associated net
- vector and itself if the reference count of the net buffer is decreased to 0.
- The net vector free operation decreases the reference count of the net
+ vector and itself if the reference count of the net buffer is decreased to 0.
+ The net vector free operation decreases the reference count of the net
vector by one, and performs the resource free operation when the reference count
- of the net vector is 0.
-
- @param[in] Nbuf Pointer to the NET_BUF to be freed.
+ of the net vector is 0.
+
+ @param[in] Nbuf The pointer to the NET_BUF to be freed.
**/
VOID
@@ -1080,19 +1649,19 @@ NetbufFree (
);
/**
- Get the index of NET_BLOCK_OP that contains the byte at Offset in the net
- buffer.
-
- For example, this function can be used to retrieve the IP header in the packet. It
- also can be used to get the fragment that contains the byte used
- mainly by the library implementation itself.
+ Get the index of NET_BLOCK_OP that contains the byte at Offset in the net
+ buffer.
- @param[in] Nbuf Pointer to the net buffer.
+ For example, this function can be used to retrieve the IP header in the packet. It
+ also can be used to get the fragment that contains the byte used
+ mainly by the library implementation itself.
+
+ @param[in] Nbuf The pointer to the net buffer.
@param[in] Offset The offset of the byte.
- @param[out] Index Index of the NET_BLOCK_OP that contains the byte at
+ @param[out] Index Index of the NET_BLOCK_OP that contains the byte at
Offset.
- @return Pointer to the Offset'th byte of data in the net buffer, or NULL
+ @return The pointer to the Offset'th byte of data in the net buffer, or NULL
if there is no such data in the net buffer.
**/
@@ -1105,15 +1674,15 @@ NetbufGetByte (
);
/**
- Create a copy of the net buffer that shares the associated net vector.
-
- The reference count of the newly created net buffer is set to 1. The reference
- count of the associated net vector is increased by one.
+ Create a copy of the net buffer that shares the associated net vector.
+
+ The reference count of the newly created net buffer is set to 1. The reference
+ count of the associated net vector is increased by one.
- @param[in] Nbuf Pointer to the net buffer to be cloned.
+ @param[in] Nbuf The pointer to the net buffer to be cloned.
- @return Pointer to the cloned net buffer, or NULL if the
- allocation failed due to resource limit.
+ @return The pointer to the cloned net buffer, or NULL if the
+ allocation failed due to resource limitations.
**/
NET_BUF *
@@ -1125,17 +1694,17 @@ NetbufClone (
/**
Create a duplicated copy of the net buffer with data copied and HeadSpace
bytes of head space reserved.
-
+
The duplicated net buffer will allocate its own memory to hold the data of the
source net buffer.
-
- @param[in] Nbuf Pointer to the net buffer to be duplicated from.
- @param[in, out] Duplicate Pointer to the net buffer to duplicate to, if
- NULL a new net buffer is allocated.
- @param[in] HeadSpace Length of the head space to reserve.
- @return Pointer to the duplicated net buffer, or NULL if
- the allocation failed due to resource limit.
+ @param[in] Nbuf The pointer to the net buffer to be duplicated from.
+ @param[in, out] Duplicate The pointer to the net buffer to duplicate to. If
+ NULL, a new net buffer is allocated.
+ @param[in] HeadSpace The length of the head space to reserve.
+
+ @return The pointer to the duplicated net buffer, or NULL if
+ the allocation failed due to resource limitations.
**/
NET_BUF *
@@ -1147,20 +1716,20 @@ NetbufDuplicate (
);
/**
- Create a NET_BUF structure which contains Len byte data of Nbuf starting from
- Offset.
-
- A new NET_BUF structure will be created but the associated data in NET_VECTOR
- is shared. This function exists to do IP packet fragmentation.
+ Create a NET_BUF structure which contains Len byte data of Nbuf starting from
+ Offset.
+
+ A new NET_BUF structure will be created but the associated data in NET_VECTOR
+ is shared. This function exists to perform IP packet fragmentation.
- @param[in] Nbuf Pointer to the net buffer to be extracted.
- @param[in] Offset Starting point of the data to be included in the new
+ @param[in] Nbuf The pointer to the net buffer to be extracted.
+ @param[in] Offset Starting point of the data to be included in the new
net buffer.
- @param[in] Len Bytes of data to be included in the new net buffer.
- @param[in] HeadSpace Bytes of head space to reserve for protocol header.
+ @param[in] Len The bytes of data to be included in the new net buffer.
+ @param[in] HeadSpace The bytes of the head space to reserve for the protocol header.
- @return Pointer to the cloned net buffer, or NULL if the
- allocation failed due to resource limit.
+ @return The pointer to the cloned net buffer, or NULL if the
+ allocation failed due to resource limitations.
**/
NET_BUF *
@@ -1175,12 +1744,12 @@ NetbufGetFragment (
/**
Reserve some space in the header room of the net buffer.
- Upon allocation, all the space is in the tail room of the buffer. Call this
- function to move some space to the header room. This function is quite limited
- in that it can only reserve space from the first block of an empty NET_BUF not
- built from the external. But it should be enough for the network stack.
+ Upon allocation, all the space is in the tail room of the buffer. Call this
+ function to move space to the header room. This function is quite limited
+ in that it can only reserve space from the first block of an empty NET_BUF not
+ built from the external. However, it should be enough for the network stack.
- @param[in, out] Nbuf Pointer to the net buffer.
+ @param[in, out] Nbuf The pointer to the net buffer.
@param[in] Len The length of buffer to be reserved from the header.
**/
@@ -1192,15 +1761,15 @@ NetbufReserve (
);
/**
- Allocate Len bytes of space from the header or tail of the buffer.
+ Allocate Len bytes of space from the header or tail of the buffer.
- @param[in, out] Nbuf Pointer to the net buffer.
+ @param[in, out] Nbuf The pointer to the net buffer.
@param[in] Len The length of the buffer to be allocated.
- @param[in] FromHead The flag to indicate whether reserve the data
+ @param[in] FromHead The flag to indicate whether to reserve the data
from head (TRUE) or tail (FALSE).
- @return Pointer to the first byte of the allocated buffer,
- or NULL if there is no sufficient space.
+ @return The pointer to the first byte of the allocated buffer,
+ or NULL, if there is no sufficient space.
**/
UINT8*
@@ -1212,14 +1781,14 @@ NetbufAllocSpace (
);
/**
- Trim Len bytes from the header or tail of the net buffer.
+ Trim Len bytes from the header or the tail of the net buffer.
- @param[in, out] Nbuf Pointer to the net buffer.
+ @param[in, out] Nbuf The pointer to the net buffer.
@param[in] Len The length of the data to be trimmed.
- @param[in] FromHead The flag to indicate whether trim data from head
- (TRUE) or tail (FALSE).
+ @param[in] FromHead The flag to indicate whether trim data is from the
+ head (TRUE) or the tail (FALSE).
- @return Length of the actually trimmed data, which may be less
+ @return The length of the actual trimmed data, which may be less
than Len if the TotalSize of Nbuf is less than Len.
**/
@@ -1232,14 +1801,14 @@ NetbufTrim (
);
/**
- Copy Len bytes of data from the specific offset of the net buffer to the
+ Copy Len bytes of data from the specific offset of the net buffer to the
destination memory.
-
+
The Len bytes of data may cross several fragments of the net buffer.
-
- @param[in] Nbuf Pointer to the net buffer.
+
+ @param[in] Nbuf The pointer to the net buffer.
@param[in] Offset The sequence number of the first byte to copy.
- @param[in] Len Length of the data to copy.
+ @param[in] Len The length of the data to copy.
@param[in] Dest The destination of the data to copy to.
@return The length of the actual copied data, or 0 if the offset
@@ -1256,23 +1825,23 @@ NetbufCopy (
);
/**
- Build a NET_BUF from external blocks.
-
+ Build a NET_BUF from external blocks.
+
A new NET_BUF structure will be created from external blocks. An additional block
of memory will be allocated to hold reserved HeadSpace bytes of header room
and existing HeadLen bytes of header, but the external blocks are shared by the
net buffer to avoid data copying.
- @param[in] ExtFragment Pointer to the data block.
+ @param[in] ExtFragment The pointer to the data block.
@param[in] ExtNum The number of the data blocks.
@param[in] HeadSpace The head space to be reserved.
@param[in] HeadLen The length of the protocol header. The function
pulls this amount of data into a linear block.
- @param[in] ExtFree Pointer to the caller-provided free function.
+ @param[in] ExtFree The pointer to the caller-provided free function.
@param[in] Arg The argument passed to ExtFree when ExtFree is
called.
- @return Pointer to the net buffer built from the data blocks,
+ @return The pointer to the net buffer built from the data blocks,
or NULL if the allocation failed due to resource
limit.
@@ -1290,15 +1859,15 @@ NetbufFromExt (
/**
Build a fragment table to contain the fragments in the net buffer. This is the
- opposite operation of the NetbufFromExt.
-
- @param[in] Nbuf Point to the net buffer.
- @param[in, out] ExtFragment Pointer to the data block.
+ opposite operation of the NetbufFromExt.
+
+ @param[in] Nbuf Points to the net buffer.
+ @param[in, out] ExtFragment The pointer to the data block.
@param[in, out] ExtNum The number of the data blocks.
- @retval EFI_BUFFER_TOO_SMALL The number of non-empty blocks is bigger than
+ @retval EFI_BUFFER_TOO_SMALL The number of non-empty blocks is bigger than
ExtNum.
- @retval EFI_SUCCESS Fragment table is built successfully.
+ @retval EFI_SUCCESS The fragment table was built successfully.
**/
EFI_STATUS
@@ -1311,18 +1880,18 @@ NetbufBuildExt (
/**
Build a net buffer from a list of net buffers.
-
- All the fragments will be collected from the list of NEW_BUF and then a new
- net buffer will be created through NetbufFromExt.
-
+
+ All the fragments will be collected from the list of NEW_BUF, and then a new
+ net buffer will be created through NetbufFromExt.
+
@param[in] BufList A List of the net buffer.
@param[in] HeadSpace The head space to be reserved.
@param[in] HeaderLen The length of the protocol header. The function
pulls this amount of data into a linear block.
- @param[in] ExtFree Pointer to the caller provided free function.
+ @param[in] ExtFree The pointer to the caller provided free function.
@param[in] Arg The argument passed to ExtFree when ExtFree is called.
- @return Pointer to the net buffer built from the list of net
+ @return The pointer to the net buffer built from the list of net
buffers.
**/
@@ -1339,7 +1908,7 @@ NetbufFromBufList (
/**
Free a list of net buffers.
- @param[in, out] Head Pointer to the head of linked net buffers.
+ @param[in, out] Head The pointer to the head of linked net buffers.
**/
VOID
@@ -1351,7 +1920,7 @@ NetbufFreeList (
/**
Initiate the net buffer queue.
- @param[in, out] NbufQue Pointer to the net buffer queue to be initialized.
+ @param[in, out] NbufQue The pointer to the net buffer queue to be initialized.
**/
VOID
@@ -1363,7 +1932,7 @@ NetbufQueInit (
/**
Allocate and initialize a net buffer queue.
- @return Pointer to the allocated net buffer queue, or NULL if the
+ @return The pointer to the allocated net buffer queue, or NULL if the
allocation failed due to resource limit.
**/
@@ -1374,13 +1943,13 @@ NetbufQueAlloc (
);
/**
- Free a net buffer queue.
-
+ Free a net buffer queue.
+
Decrease the reference count of the net buffer queue by one. The real resource
- free operation isn't performed until the reference count of the net buffer
+ free operation isn't performed until the reference count of the net buffer
queue is decreased to 0.
- @param[in] NbufQue Pointer to the net buffer queue to be freed.
+ @param[in] NbufQue The pointer to the net buffer queue to be freed.
**/
VOID
@@ -1392,9 +1961,9 @@ NetbufQueFree (
/**
Remove a net buffer from the head in the specific queue and return it.
- @param[in, out] NbufQue Pointer to the net buffer queue.
+ @param[in, out] NbufQue The pointer to the net buffer queue.
- @return Pointer to the net buffer removed from the specific queue,
+ @return The pointer to the net buffer removed from the specific queue,
or NULL if there is no net buffer in the specific queue.
**/
@@ -1407,8 +1976,8 @@ NetbufQueRemove (
/**
Append a net buffer to the net buffer queue.
- @param[in, out] NbufQue Pointer to the net buffer queue.
- @param[in, out] Nbuf Pointer to the net buffer to be appended.
+ @param[in, out] NbufQue The pointer to the net buffer queue.
+ @param[in, out] Nbuf The pointer to the net buffer to be appended.
**/
VOID
@@ -1421,16 +1990,16 @@ NetbufQueAppend (
/**
Copy Len bytes of data from the net buffer queue at the specific offset to the
destination memory.
-
- The copying operation is the same as NetbufCopy but applies to the net buffer
+
+ The copying operation is the same as NetbufCopy, but applies to the net buffer
queue instead of the net buffer.
-
- @param[in] NbufQue Pointer to the net buffer queue.
+
+ @param[in] NbufQue The pointer to the net buffer queue.
@param[in] Offset The sequence number of the first byte to copy.
- @param[in] Len Length of the data to copy.
+ @param[in] Len The length of the data to copy.
@param[out] Dest The destination of the data to copy to.
- @return The length of the actual copied data, or 0 if the offset
+ @return The length of the actual copied data, or 0 if the offset
specified exceeds the total size of net buffer queue.
**/
@@ -1444,14 +2013,14 @@ NetbufQueCopy (
);
/**
- Trim Len bytes of data from the queue header and release any net buffer
- that is trimmed wholely.
-
+ Trim Len bytes of data from the buffer queue and free any net buffer
+ that is completely trimmed.
+
The trimming operation is the same as NetbufTrim but applies to the net buffer
queue instead of the net buffer.
- @param[in, out] NbufQue Pointer to the net buffer queue.
- @param[in] Len Length of the data to trim.
+ @param[in, out] NbufQue The pointer to the net buffer queue.
+ @param[in] Len The length of the data to trim.
@return The actual length of the data trimmed.
@@ -1467,7 +2036,7 @@ NetbufQueTrim (
/**
Flush the net buffer queue.
- @param[in, out] NbufQue Pointer to the queue to be flushed.
+ @param[in, out] NbufQue The pointer to the queue to be flushed.
**/
VOID
@@ -1479,8 +2048,8 @@ NetbufQueFlush (
/**
Compute the checksum for a bulk of data.
- @param[in] Bulk Pointer to the data.
- @param[in] Len Length of the data, in bytes.
+ @param[in] Bulk The pointer to the data.
+ @param[in] Len The length of the data, in bytes.
@return The computed checksum.
@@ -1511,7 +2080,7 @@ NetAddChecksum (
/**
Compute the checksum for a NET_BUF.
- @param[in] Nbuf Pointer to the net buffer.
+ @param[in] Nbuf The pointer to the net buffer.
@return The computed checksum.
@@ -1523,8 +2092,8 @@ NetbufChecksum (
);
/**
- Compute the checksum for TCP/UDP pseudo header.
-
+ Compute the checksum for TCP/UDP pseudo header.
+
Src and Dst are in network byte order, and Len is in host byte order.
@param[in] Src The source address of the packet.
@@ -1544,4 +2113,77 @@ NetPseudoHeadChecksum (
IN UINT16 Len
);
+/**
+ Compute the checksum for the TCP6/UDP6 pseudo header.
+
+ Src and Dst are in network byte order, and Len is in host byte order.
+
+ @param[in] Src The source address of the packet.
+ @param[in] Dst The destination address of the packet.
+ @param[in] NextHeader The protocol type of the packet.
+ @param[in] Len The length of the packet.
+
+ @return The computed checksum.
+
+**/
+UINT16
+EFIAPI
+NetIp6PseudoHeadChecksum (
+ IN EFI_IPv6_ADDRESS *Src,
+ IN EFI_IPv6_ADDRESS *Dst,
+ IN UINT8 NextHeader,
+ IN UINT32 Len
+ );
+
+/**
+ The function frees the net buffer which allocated by the IP protocol. It releases
+ only the net buffer and doesn't call the external free function.
+
+ This function should be called after finishing the process of mIpSec->ProcessExt()
+ for outbound traffic. The (EFI_IPSEC2_PROTOCOL)->ProcessExt() allocates a new
+ buffer for the ESP, so there needs a function to free the old net buffer.
+
+ @param[in] Nbuf The network buffer to be freed.
+
+**/
+VOID
+NetIpSecNetbufFree (
+ NET_BUF *Nbuf
+ );
+
+/**
+ This function obtains the system guid from the smbios table.
+
+ @param[out] SystemGuid The pointer of the returned system guid.
+
+ @retval EFI_SUCCESS Successfully obtained the system guid.
+ @retval EFI_NOT_FOUND Did not find the SMBIOS table.
+
+**/
+EFI_STATUS
+EFIAPI
+NetLibGetSystemGuid (
+ OUT EFI_GUID *SystemGuid
+ );
+
+/**
+ Create Dns QName according the queried domain name.
+ QName is a domain name represented as a sequence of labels,
+ where each label consists of a length octet followed by that
+ number of octets. The QName terminates with the zero
+ length octet for the null label of the root. Caller should
+ take responsibility to free the buffer in returned pointer.
+
+ @param DomainName The pointer to the queried domain name string.
+
+ @retval NULL Failed to fill QName.
+ @return QName filled successfully.
+
+**/
+CHAR8 *
+EFIAPI
+NetLibCreateDnsQName (
+ IN CHAR16 *DomainName
+ );
+
#endif