This library is only intended to be used by UEFI network stack modules.\r
It provides basic functions for the UEFI network stack.\r
\r
-Copyright (c) 2005 - 2017, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution. The full text of the license may be found at<BR>\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#define IP4_MASK_NUM 33\r
#define IP6_PREFIX_NUM 129\r
\r
-#define IP4_MASK_MAX 32 \r
+#define IP4_MASK_MAX 32\r
#define IP6_PREFIX_MAX 128\r
\r
#define IP6_HOP_BY_HOP 0\r
#define DNS_CLASS_HS 4\r
#define DNS_CLASS_ANY 255\r
\r
+//\r
+// Number of 100ns units time Interval for network media state detect\r
+//\r
+#define MEDIA_STATE_DETECT_TIME_INTERVAL 1000000U\r
+\r
+\r
#pragma pack(1)\r
\r
//\r
\r
/**\r
Check whether the IP is a valid unicast address according to\r
- the netmask. \r
+ the netmask.\r
\r
ASSERT if NetMask is zero.\r
- \r
- If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address.\r
+\r
+ If all bits of the host address of IP are 0 or 1, IP is also not a valid unicast address,\r
+ except when the originator is one of the endpoints of a point-to-point link with a 31-bit\r
+ mask (RFC3021), or a 32bit NetMask (all 0xFF) is used for special network environment (e.g.\r
+ PPP link).\r
\r
@param[in] Ip The IP to check against.\r
@param[in] NetMask The mask of the IP.\r
/**\r
Check whether the incoming IPv6 address is a valid unicast address.\r
\r
+ ASSERT if Ip6 is NULL.\r
+\r
If the address is a multicast address has binary 0xFF at the start, it is not\r
a valid unicast address. If the address is unspecified ::, it is not a valid\r
unicast address to be assigned to any node. If the address is loopback address\r
/**\r
Check whether the incoming Ipv6 address is the unspecified address or not.\r
\r
+ ASSERT if Ip6 is NULL.\r
+\r
@param[in] Ip6 - Ip6 address, in network order.\r
\r
@retval TRUE - Yes, incoming Ipv6 address is the unspecified address.\r
/**\r
Check whether the incoming Ipv6 address is a link-local address.\r
\r
+ ASSERT if Ip6 is NULL.\r
+\r
@param[in] Ip6 - Ip6 address, in network order.\r
\r
@retval TRUE - The incoming Ipv6 address is a link-local address.\r
/**\r
Check whether the Ipv6 address1 and address2 are on the connected network.\r
\r
+ ASSERT if Ip1 or Ip2 is NULL.\r
+ ASSERT if PrefixLength exceeds or equals to IP6_PREFIX_MAX.\r
+\r
@param[in] Ip1 - Ip6 address1, in network order.\r
@param[in] Ip2 - Ip6 address2, in network order.\r
@param[in] PrefixLength - The prefix length of the checking net.\r
/**\r
Switches the endianess of an IPv6 address.\r
\r
+ ASSERT if Ip6 is NULL.\r
+\r
This function swaps the bytes in a 128-bit IPv6 address to switch the value\r
from little endian to big endian or vice versa. The byte swapped value is\r
returned.\r
/**\r
Extract a UINT32 from a byte stream.\r
\r
+ ASSERT if Buf is NULL.\r
+\r
This function copies a UINT32 from a byte stream, and then converts it from Network\r
byte order to host byte order. Use this function to avoid alignment error.\r
\r
/**\r
Puts a UINT32 into the byte stream in network byte order.\r
\r
+ ASSERT if Buf is NULL.\r
+\r
Converts a UINT32 from host byte order to network byte order, then copies it to the\r
byte stream.\r
\r
/**\r
Initialize a random seed using current time and monotonic count.\r
\r
- Get current time and monotonic count first. Then initialize a random seed \r
+ Get current time and monotonic count first. Then initialize a random seed\r
based on some basic mathematics operation on the hour, day, minute, second,\r
nanosecond and year of the current time and the monotonic count value.\r
\r
/**\r
Insert a new node entry after a designated node entry of a doubly linked list.\r
\r
+ ASSERT if PrevEntry or NewEntry is NULL.\r
+\r
Inserts a new node entry designated by NewEntry after the node entry designated by PrevEntry\r
of the doubly linked list.\r
\r
/**\r
Insert a new node entry before a designated node entry of a doubly linked list.\r
\r
+ ASSERT if PostEntry or NewEntry is NULL.\r
+\r
Inserts a new node entry designated by NewEntry before the node entry designated by PostEntry\r
of the doubly linked list.\r
\r
\r
/**\r
Callback function which provided by user to remove one node in NetDestroyLinkList process.\r
- \r
+\r
@param[in] Entry The entry to be removed.\r
@param[in] Context Pointer to the callback context corresponds to the Context in NetDestroyLinkList.\r
\r
If it has been removed, then restart the traversal from the head.\r
If it hasn't been removed, then continue with the next node directly.\r
This function will end the iterate and return the CallBack's last return value if error happens,\r
- or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list. \r
+ or retrun EFI_SUCCESS if 2 complete passes are made with no changes in the number of children in the list.\r
\r
@param[in] List The head of the list.\r
@param[in] CallBack Pointer to the callback function to destroy one node in the list.\r
\r
If Map is NULL, then ASSERT().\r
\r
-\r
@param[in] Map The net map to test.\r
\r
@return TRUE if the netmap is empty, otherwise FALSE.\r
/**\r
Return the number of the <Key, Value> pairs in the netmap.\r
\r
+ If Map is NULL, then ASSERT().\r
+\r
@param[in] Map The netmap to get the entry number.\r
\r
@return The entry number in the netmap.\r
pairs in the netmap increase by 1.\r
\r
If Map is NULL, then ASSERT().\r
+ If Key is NULL, then ASSERT().\r
\r
@param[in, out] Map The netmap to insert into.\r
@param[in] Key The user's key.\r
pairs in the netmap increase by 1.\r
\r
If Map is NULL, then ASSERT().\r
+ If Key is NULL, then ASSERT().\r
\r
@param[in, out] Map The netmap to insert into.\r
@param[in] Key The user's key.\r
item with the key to search. It returns the point to the item contains the Key if found.\r
\r
If Map is NULL, then ASSERT().\r
+ If Key is NULL, then ASSERT().\r
\r
@param[in] Map The netmap to search within.\r
@param[in] Key The key to search.\r
/**\r
Get MAC address associated with the network service handle.\r
\r
+ If MacAddress is NULL, then ASSERT().\r
+ If AddressSize is NULL, then ASSERT().\r
+\r
There should be MNP Service Binding Protocol installed on the input ServiceHandle.\r
If SNP is installed on the ServiceHandle or its parent handle, MAC address will\r
be retrieved from SNP. If no SNP found, try to get SNP mode data use MNP.\r
Convert MAC address of the NIC associated with specified Service Binding Handle\r
to a unicode string. Callers are responsible for freeing the string storage.\r
\r
+ If MacString is NULL, then ASSERT().\r
+\r
Locate simple network protocol associated with the Service Binding Handle and\r
get the mac address from SNP. Then convert the mac address into a unicode\r
string. It takes 2 unicode characters to represent a 1 byte binary buffer.\r
/**\r
Detect media status for specified network device.\r
\r
+ If MediaPresent is NULL, then ASSERT().\r
+\r
The underlying UNDI driver may or may not support reporting media status from\r
GET_STATUS command (PXE_STATFLAGS_GET_STATUS_NO_MEDIA_SUPPORTED). This routine\r
will try to invoke Snp->GetStatus() to get the media status. If media is already\r
present, it returns directly. If media is not present, it will stop SNP and then\r
- restart SNP to get the latest media status. This provides an opportunity to get \r
- the correct media status for old UNDI driver, which doesn't support reporting \r
+ restart SNP to get the latest media status. This provides an opportunity to get\r
+ the correct media status for old UNDI driver, which doesn't support reporting\r
media status from GET_STATUS command.\r
Note: there are two limitations for the current algorithm:\r
1) For UNDI with this capability, when the cable is not attached, there will\r
OUT BOOLEAN *MediaPresent\r
);\r
\r
+/**\r
+ Detect media state for a network device. This routine will wait for a period of time at\r
+ a specified checking interval when a certain network is under connecting until connection\r
+ process finishes or timeout. If Aip protocol is supported by low layer drivers, three kinds\r
+ of media states can be detected: EFI_SUCCESS, EFI_NOT_READY and EFI_NO_MEDIA, represents\r
+ connected state, connecting state and no media state respectively. When function detects\r
+ the current state is EFI_NOT_READY, it will loop to wait for next time's check until state\r
+ turns to be EFI_SUCCESS or EFI_NO_MEDIA. If Aip protocol is not supported, function will\r
+ call NetLibDetectMedia() and return state directly.\r
+\r
+ @param[in] ServiceHandle The handle where network service binding protocols are\r
+ installed on.\r
+ @param[in] Timeout The maximum number of 100ns units to wait when network\r
+ is connecting. Zero value means detect once and return\r
+ immediately.\r
+ @param[out] MediaState The pointer to the detected media state.\r
+\r
+ @retval EFI_SUCCESS Media detection success.\r
+ @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle or\r
+ MediaState pointer is NULL.\r
+ @retval EFI_DEVICE_ERROR A device error occurred.\r
+ @retval EFI_TIMEOUT Network is connecting but timeout.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+NetLibDetectMediaWaitTimeout (\r
+ IN EFI_HANDLE ServiceHandle,\r
+ IN UINT64 Timeout,\r
+ OUT EFI_STATUS *MediaState\r
+ );\r
+\r
+\r
/**\r
Create an IPv4 device path node.\r
\r
+ If Node is NULL, then ASSERT().\r
+\r
The header type of IPv4 device path node is MESSAGING_DEVICE_PATH.\r
The header subtype of IPv4 device path node is MSG_IPv4_DP.\r
The length of the IPv4 device path node in bytes is 19.\r
/**\r
Create an IPv6 device path node.\r
\r
+ If Node is NULL, then ASSERT().\r
+ If LocalIp is NULL, then ASSERT().\r
+ If RemoteIp is NULL, then ASSERT().\r
+\r
The header type of IPv6 device path node is MESSAGING_DEVICE_PATH.\r
The header subtype of IPv6 device path node is MSG_IPv6_DP.\r
The length of the IPv6 device path node in bytes is 43.\r
/**\r
Find the UNDI/SNP handle from controller and protocol GUID.\r
\r
+ If ProtocolGuid is NULL, then ASSERT().\r
+\r
For example, IP will open an MNP child to transmit/receive\r
packets. When MNP is stopped, IP should also be stopped. IP\r
needs to find its own private data that is related the IP's\r
\r
Convert one EFI_IPv6_ADDRESS to Null-terminated Unicode string.\r
The text representation of address is defined in RFC 4291.\r
- \r
+\r
@param[in] Ip6Address The pointer to the IPv6 address.\r
@param[out] String The buffer to return the converted string.\r
@param[in] StringSize The length in bytes of the input String.\r
- \r
+\r
@retval EFI_SUCCESS Convert to string successfully.\r
@retval EFI_INVALID_PARAMETER The input parameter is invalid.\r
- @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result. BufferSize has been \r
+ @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result. BufferSize has been\r
updated with the size needed to complete the request.\r
**/\r
EFI_STATUS\r
(sizeof (NET_BUF) + ((BlockOpNum) - 1) * sizeof (NET_BLOCK_OP))\r
\r
#define NET_HEADSPACE(BlockOp) \\r
- (UINTN)((BlockOp)->Head - (BlockOp)->BlockHead)\r
+ ((UINTN)((BlockOp)->Head) - (UINTN)((BlockOp)->BlockHead))\r
\r
#define NET_TAILSPACE(BlockOp) \\r
- (UINTN)((BlockOp)->BlockTail - (BlockOp)->Tail)\r
+ ((UINTN)((BlockOp)->BlockTail) - (UINTN)((BlockOp)->Tail))\r
\r
/**\r
Allocate a single block NET_BUF. Upon allocation, all the\r
\r
@param[in, out] Nbuf The pointer to the net buffer.\r
@param[in] Len The length of the data to be trimmed.\r
- @param[in] FromHead The flag to indicate whether trim data is from the \r
+ @param[in] FromHead The flag to indicate whether trim data is from the\r
head (TRUE) or the tail (FALSE).\r
\r
@return The length of the actual trimmed data, which may be less\r
);\r
\r
/**\r
- The function frees the net buffer which allocated by the IP protocol. It releases \r
- only the net buffer and doesn't call the external free function. \r
+ The function frees the net buffer which allocated by the IP protocol. It releases\r
+ only the net buffer and doesn't call the external free function.\r
\r
- This function should be called after finishing the process of mIpSec->ProcessExt() \r
- for outbound traffic. The (EFI_IPSEC2_PROTOCOL)->ProcessExt() allocates a new \r
+ This function should be called after finishing the process of mIpSec->ProcessExt()\r
+ for outbound traffic. The (EFI_IPSEC2_PROTOCOL)->ProcessExt() allocates a new\r
buffer for the ESP, so there needs a function to free the old net buffer.\r
\r
@param[in] Nbuf The network buffer to be freed.\r
/**\r
This function obtains the system guid from the smbios table.\r
\r
+ If SystemGuid is NULL, then ASSERT().\r
+\r
@param[out] SystemGuid The pointer of the returned system guid.\r
\r
@retval EFI_SUCCESS Successfully obtained the system guid.\r
);\r
\r
/**\r
- Create Dns QName according the queried domain name. \r
- QName is a domain name represented as a sequence of labels, \r
- where each label consists of a length octet followed by that \r
- number of octets. The QName terminates with the zero \r
- length octet for the null label of the root. Caller should \r
+ Create Dns QName according the queried domain name.\r
+\r
+ If DomainName is NULL, then ASSERT().\r
+\r
+ QName is a domain name represented as a sequence of labels,\r
+ where each label consists of a length octet followed by that\r
+ number of octets. The QName terminates with the zero\r
+ length octet for the null label of the root. Caller should\r
take responsibility to free the buffer in returned pointer.\r
\r
- @param DomainName The pointer to the queried domain name string. \r
+ @param DomainName The pointer to the queried domain name string.\r
\r
@retval NULL Failed to fill QName.\r
@return QName filled successfully.\r
- \r
-**/ \r
+\r
+**/\r
CHAR8 *\r
EFIAPI\r
NetLibCreateDnsQName (\r
projects / mirror_edk2.git / blobdiff