NetworkPkg/IScsiDxe: reformat IScsiHexToBin() leading comment block

[mirror_edk2.git] / NetworkPkg / IScsiDxe / IScsiMisc.h

diff --git a/NetworkPkg/IScsiDxe/IScsiMisc.h b/NetworkPkg/IScsiDxe/IScsiMisc.h
index 92f42e140ace0e4f449fa19f8c7d11d612ae7a52..28cf408cd5c58b00bc1d1bcc09c0637d2ac41f7a 100644 (file)
--- a/NetworkPkg/IScsiDxe/IScsiMisc.h
+++ b/NetworkPkg/IScsiDxe/IScsiMisc.h
@@ -46,7 +46,7 @@ typedef struct _ISCSI_SESSION_CONFIG_NVDATA {
   UINT8             PrefixLength;\r
   UINT8             BootLun[8];\r
 \r
-  UINT16            ConnectTimeout; ///< timout value in milliseconds.\r
+  UINT16            ConnectTimeout; ///< timeout value in milliseconds.\r
   UINT8             ConnectRetryCount;\r
   UINT8             IsId[6];\r
 \r
@@ -104,7 +104,7 @@ IScsiLunToUnicodeStr (
   );\r
 \r
 /**\r
-  Convert the mac address into a hexadecimal encoded "-" seperated string.\r
+  Convert the mac address into a hexadecimal encoded "-" separated string.\r
 \r
   @param[in]  Mac     The mac address.\r
   @param[in]  Len     Length in bytes of the mac address.\r
@@ -150,6 +150,7 @@ IScsiAsciiStrToIp (
   @retval EFI_SUCCESS          The binary data is converted to the hexadecimal string\r
                                and the length of the string is updated.\r
   @retval EFI_BUFFER_TOO_SMALL The string is too small.\r
+  @retval EFI_BAD_BUFFER_SIZE  BinLength is too large for hex encoding.\r
   @retval EFI_INVALID_PARAMETER The IP string is malformatted.\r
 \r
 **/\r
@@ -164,14 +165,14 @@ IScsiBinToHex (
 /**\r
   Convert the hexadecimal string into a binary encoded buffer.\r
 \r
-  @param[in, out]  BinBuffer   The binary buffer.\r
-  @param[in, out]  BinLength   Length of the binary buffer.\r
-  @param[in]       HexStr      The hexadecimal string.\r
-\r
-  @retval EFI_SUCCESS          The hexadecimal string is converted into a binary\r
-                               encoded buffer.\r
-  @retval EFI_BUFFER_TOO_SMALL The binary buffer is too small to hold the converted data.\r
+  @param[in, out]  BinBuffer    The binary buffer.\r
+  @param[in, out]  BinLength    Length of the binary buffer.\r
+  @param[in]       HexStr       The hexadecimal string.\r
 \r
+  @retval EFI_SUCCESS           The hexadecimal string is converted into a\r
+                                binary encoded buffer.\r
+  @retval EFI_BUFFER_TOO_SMALL  The binary buffer is too small to hold the\r
+                                converted data.\r
 **/\r
 EFI_STATUS\r
 IScsiHexToBin (\r
@@ -352,7 +353,7 @@ IScsiCreateDriverData (
 \r
   @param[in]              Private The iSCSI driver data.\r
 \r
-  @retval EFI_SUCCES      The clean operation is successful.\r
+  @retval EFI_SUCCESS     The clean operation is successful.\r
   @retval Others          Other errors as indicated.\r
 \r
 **/\r
@@ -439,7 +440,7 @@ IScsiOnExitBootService (
 \r
   This function tests whether the driver specified by DriverBindingHandle is\r
   currently managing the controller specified by ControllerHandle.  This test\r
-  is performed by evaluating if the the protocol specified by ProtocolGuid is\r
+  is performed by evaluating if the protocol specified by ProtocolGuid is\r
   present on ControllerHandle and is was opened by DriverBindingHandle and Nic\r
   Device handle with an attribute of EFI_OPEN_PROTOCOL_BY_DRIVER.\r
   If ProtocolGuid is NULL, then ASSERT().\r