X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdeModulePkg%2FInclude%2FLibrary%2FNetLib.h;h=ef7bc429c13826c94b3a39a842e9718948af3b75;hp=b0bbaf22a7732896878c059e2183a6978b97fec8;hb=d1102dba7210b95e41d06c2338a22ba6af248645;hpb=ca79bab7af4770c5eb578f6d495af01705aedb79 diff --git a/MdeModulePkg/Include/Library/NetLib.h b/MdeModulePkg/Include/Library/NetLib.h index b0bbaf22a7..ef7bc429c1 100644 --- a/MdeModulePkg/Include/Library/NetLib.h +++ b/MdeModulePkg/Include/Library/NetLib.h @@ -52,7 +52,7 @@ typedef UINT16 TCP_PORTNO; #define IP4_MASK_NUM 33 #define IP6_PREFIX_NUM 129 -#define IP4_MASK_MAX 32 +#define IP4_MASK_MAX 32 #define IP6_PREFIX_MAX 128 #define IP6_HOP_BY_HOP 0 @@ -416,14 +416,14 @@ NetGetIpClass ( /** Check whether the IP is a valid unicast address according to - the netmask. + 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. @@ -593,7 +593,7 @@ NetPutUint32 ( /** Initialize a random seed using current time and monotonic count. - Get current time and monotonic count first. Then initialize a random seed + 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. @@ -729,7 +729,7 @@ NetListInsertBefore ( /** 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. @@ -753,7 +753,7 @@ EFI_STATUS 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. + 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. @@ -1255,8 +1255,8 @@ NetLibGetMacString ( 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 + 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 @@ -1284,13 +1284,13 @@ NetLibDetectMedia ( ); /** - Detect media state for a network device. This routine will wait for a period of time at - a specified checking interval when a certain network is under connecting until connection + Detect media state for a network device. This routine will wait for a period of time at + a specified checking interval when a certain network is under connecting until connection process finishes or timeout. If Aip protocol is supported by low layer drivers, three kinds of media states can be detected: EFI_SUCCESS, EFI_NOT_READY and EFI_NO_MEDIA, represents - connected state, connecting state and no media state respectively. When function detects - the current state is EFI_NOT_READY, it will loop to wait for next time's check until state - turns to be EFI_SUCCESS or EFI_NO_MEDIA. If Aip protocol is not supported, function will + connected state, connecting state and no media state respectively. When function detects + the current state is EFI_NOT_READY, it will loop to wait for next time's check until state + turns to be EFI_SUCCESS or EFI_NO_MEDIA. If Aip protocol is not supported, function will call NetLibDetectMedia() and return state directly. @param[in] ServiceHandle The handle where network service binding protocols are @@ -1301,7 +1301,7 @@ NetLibDetectMedia ( @param[out] MediaState The pointer to the detected media state. @retval EFI_SUCCESS Media detection success. - @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle or + @retval EFI_INVALID_PARAMETER ServiceHandle is not a valid network device handle or MediaState pointer is NULL. @retval EFI_DEVICE_ERROR A device error occurred. @retval EFI_TIMEOUT Network is connecting but timeout. @@ -1522,14 +1522,14 @@ NetLibStrToIp6andPrefix ( 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 + @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 @@ -1862,7 +1862,7 @@ NetbufAllocSpace ( @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 is from the + @param[in] FromHead The flag to indicate whether trim data is from the head (TRUE) or the tail (FALSE). @return The length of the actual trimmed data, which may be less @@ -2213,11 +2213,11 @@ NetIp6PseudoHeadChecksum ( ); /** - 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. + 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 + 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. @@ -2250,18 +2250,18 @@ NetLibGetSystemGuid ( If DomainName is NULL, then ASSERT(). - 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 + 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. + @param DomainName The pointer to the queried domain name string. @retval NULL Failed to fill QName. @return QName filled successfully. - -**/ + +**/ CHAR8 * EFIAPI NetLibCreateDnsQName (