]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Include/Library/NetLib.h
MdeModulePkg: Clean up source files
[mirror_edk2.git] / MdeModulePkg / Include / Library / NetLib.h
index b0bbaf22a7732896878c059e2183a6978b97fec8..ef7bc429c13826c94b3a39a842e9718948af3b75 100644 (file)
@@ -52,7 +52,7 @@ typedef UINT16          TCP_PORTNO;
 #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
@@ -416,14 +416,14 @@ NetGetIpClass (
 \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
+\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).\r
-  \r
+\r
   @param[in]  Ip                    The IP to check against.\r
   @param[in]  NetMask               The mask of the IP.\r
 \r
@@ -593,7 +593,7 @@ NetPutUint32 (
 /**\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
@@ -729,7 +729,7 @@ NetListInsertBefore (
 \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
@@ -753,7 +753,7 @@ EFI_STATUS
   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
@@ -1255,8 +1255,8 @@ NetLibGetMacString (
   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
@@ -1284,13 +1284,13 @@ NetLibDetectMedia (
   );\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
+  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
+  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
@@ -1301,7 +1301,7 @@ NetLibDetectMedia (
   @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
+  @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
@@ -1522,14 +1522,14 @@ NetLibStrToIp6andPrefix (
 \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
@@ -1862,7 +1862,7 @@ NetbufAllocSpace (
 \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
@@ -2213,11 +2213,11 @@ NetIp6PseudoHeadChecksum (
   );\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
@@ -2250,18 +2250,18 @@ NetLibGetSystemGuid (
 \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
+  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