[Description]

change the old code style to comply with Doxgen format
[Impaction]
add comments for every function
[Reference Info]
add comments to achieve the highest standard of code quality matrix

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5079 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 188 insertions, 277 deletions

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c
index 985f02e..1699bfb 100644
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiMisc.c
@@ -1,6 +1,7 @@
-/*++

+/** @file

+  Miscellaneous routines for IScsi driver.

 

-Copyright (c) 2004 - 2007, Intel Corporation

+Copyright (c) 2004 - 2008, 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

@@ -15,35 +16,33 @@ Module Name:
 

 Abstract:

 

-  Miscellaneous routines for iSCSI driver.

+  Miscellaneous routines for IScsi driver.

 

---*/

+**/

 

 #include "IScsiImpl.h"

 

 STATIC CONST CHAR8  IScsiHexString[] = "0123456789ABCDEFabcdef";

 

+/**

+  Determines if a Unicode character is a hexadecimal digit.

+  The test is case insensitive.

+  

+  @param  Digit[out] Pointer to byte that receives the value of the hex character.

+

+  @param  Char[in]   Unicode character to test.

+

+  @retval TRUE       If the character is a hexadecimal digit.

+

+  @retval FALSE      Otherwise.

+

+**/

 static

 BOOLEAN

 IsHexDigit (

   OUT UINT8      *Digit,

   IN  CHAR16      Char

   )

-/*++

-

-  Routine Description:

-    Determines if a Unicode character is a hexadecimal digit.

-    The test is case insensitive.

-

-  Arguments:

-    Digit - Pointer to byte that receives the value of the hex character.

-    Char  - Unicode character to test.

-

-  Returns:

-    TRUE  - If the character is a hexadecimal digit.

-    FALSE - Otherwise.

-

---*/

 {

   if ((Char >= L'0') && (Char <= L'9')) {

     *Digit = (UINT8) (Char - L'0');

@@ -63,27 +62,23 @@ IsHexDigit (
   return FALSE;

 }

 

+/**

+  Removes (trims) specified leading and trailing characters from a string.

+

+  @param  str[in][out] Pointer to the null-terminated string to be trimmed. On return, 

+                       str will hold the trimmed string. 

+

+  @param  CharC[in]    Character will be trimmed from str.

+

+  @retval NONE.

+

+**/

 static

 VOID

 StrTrim (

   IN OUT CHAR16   *str,

   IN     CHAR16   CharC

   )

-/*++

-

-Routine Description:

-  

-  Removes (trims) specified leading and trailing characters from a string.

-  

-Arguments: 

-  

-  str     - Pointer to the null-terminated string to be trimmed. On return, 

-            str will hold the trimmed string. 

-  CharC       - Character will be trimmed from str.

-  

-Returns:

-

---*/

 {

   CHAR16  *p1;

   CHAR16  *p2;

@@ -123,25 +118,18 @@ Returns:
   }

 }

 

-UINT8

-IScsiGetSubnetMaskPrefixLength (

-  IN EFI_IPv4_ADDRESS  *SubnetMask

-  )

-/*++

-

-Routine Description:

-

+/**

   Calculate the prefix length of the IPv4 subnet mask.

 

-Arguments:

+  @param  SubnetMask[in] The IPv4 subnet mask.

 

-  SubnetMask - The IPv4 subnet mask.

+  @retval The prefix length of the subnet mask.

 

-Returns:

-

-  The prefix length of the subnet mask.

-

---*/

+**/

+UINT8

+IScsiGetSubnetMaskPrefixLength (

+  IN EFI_IPv4_ADDRESS  *SubnetMask

+  )

 {

   UINT8   Len;

   UINT32  ReverseMask;

@@ -170,28 +158,23 @@ Returns:
   return (UINT8) (32 - Len);

 }

 

-EFI_STATUS

-IScsiAsciiStrToLun (

-  IN  CHAR8  *Str,

-  OUT UINT8  *Lun

-  )

-/*++

-

-Routine Description:

-

+/**

   Convert the hexadecimal encoded LUN string into the 64-bit LUN. 

 

-Arguments:

+  @param  Str[in]               The hexadecimal encoded LUN string.

 

-  Str - The hexadecimal encoded LUN string.

-  Lun - Storage to return the 64-bit LUN.

+  @param  Lun[out]              Storage to return the 64-bit LUN.

 

-Returns:

+  @retval EFI_SUCCESS           The 64-bit LUN is stored in Lun.

 

-  EFI_SUCCESS           - The 64-bit LUN is stored in Lun.

-  EFI_INVALID_PARAMETER - The string is malformatted.

+  @retval EFI_INVALID_PARAMETER The string is malformatted.

 

---*/

+**/

+EFI_STATUS

+IScsiAsciiStrToLun (

+  IN  CHAR8  *Str,

+  OUT UINT8  *Lun

+  )

 {

   UINT32  Index;

   CHAR8   *LunUnitStr[4];

@@ -245,27 +228,21 @@ Returns:
   return EFI_SUCCESS;

 }

 

-VOID

-IScsiLunToUnicodeStr (

-  IN UINT8    *Lun,

-  OUT CHAR16  *Str

-  )

-/*++

-

-Routine Description:

-

+/**

   Convert the 64-bit LUN into the hexadecimal encoded LUN string.

 

-Arguments:

-

-  Lun - The 64-bit LUN.

-  Str - The storage to return the hexadecimal encoded LUN string.

+  @param  Lun[in]  The 64-bit LUN.

 

-Returns:

+  @param  Str[out] The storage to return the hexadecimal encoded LUN string.

 

-  None.

+  @retval None.

 

---*/

+**/

+VOID

+IScsiLunToUnicodeStr (

+  IN UINT8    *Lun,

+  OUT CHAR16  *Str

+  )

 {

   UINTN   Index;

   CHAR16  *TempStr;

@@ -301,27 +278,21 @@ Returns:
   }

 }

 

-CHAR16 *

-IScsiAsciiStrToUnicodeStr (

-  IN  CHAR8   *Source,

-  OUT CHAR16  *Destination

-  )

-/*++

-

-Routine Description:

-

+/**

   Convert the ASCII string into a UNICODE string.

 

-Arguments:

+  @param  Source[out]      The ASCII string.

 

-  Source      - The ASCII string.

-  Destination - The storage to return the UNICODE string.

+  @param  Destination[out] The storage to return the UNICODE string.

 

-Returns:

+  @retval CHAR16 *         Pointer to the UNICODE string.

 

-  Pointer to the UNICODE string.

-

---*/

+**/

+CHAR16 *

+IScsiAsciiStrToUnicodeStr (

+  IN  CHAR8   *Source,

+  OUT CHAR16  *Destination

+  )

 {

   ASSERT (Destination != NULL);

   ASSERT (Source != NULL);

@@ -335,27 +306,21 @@ Returns:
   return Destination;

 }

 

-CHAR8 *

-IScsiUnicodeStrToAsciiStr (

-  IN  CHAR16  *Source,

-  OUT CHAR8   *Destination

-  )

-/*++

-

-Routine Description:

-

+/**

   Convert the UNICODE string into an ASCII string.

 

-Arguments:

+  @param  Source[in]       The UNICODE string.

 

-  Source      - The UNICODE string.

-  Destination - The storage to return the ASCII string.

+  @param  Destination[out] The storage to return the ASCII string.

 

-Returns:

+  @retval CHAR8 *          Pointer to the ASCII string.

 

-  Pointer to the ASCII string.

-

---*/

+**/

+CHAR8 *

+IScsiUnicodeStrToAsciiStr (

+  IN  CHAR16  *Source,

+  OUT CHAR8   *Destination

+  )

 {

   ASSERT (Destination != NULL);

   ASSERT (Source != NULL);

@@ -374,28 +339,23 @@ Returns:
   return Destination;

 }

 

-EFI_STATUS

-IScsiAsciiStrToIp (

-  IN  CHAR8             *Str,

-  OUT EFI_IPv4_ADDRESS  *Ip

-  )

-/*++

-

-Routine Description:

-

+/**

   Convert the decimal dotted IPv4 address into the binary IPv4 address.

 

-Arguments:

+  @param  Str[in]               The UNICODE string.

 

-  Str - The UNICODE string.

-  Ip  - The storage to return the ASCII string.

+  @param  Ip[out]               The storage to return the ASCII string.

 

-Returns:

+  @retval EFI_SUCCESS           The binary IP address is returned in Ip.

 

-  EFI_SUCCESS           - The binary IP address is returned in Ip.

-  EFI_INVALID_PARAMETER - The IP string is malformatted.

+  @retval EFI_INVALID_PARAMETER The IP string is malformatted.

 

---*/

+**/

+EFI_STATUS

+IScsiAsciiStrToIp (

+  IN  CHAR8             *Str,

+  OUT EFI_IPv4_ADDRESS  *Ip

+  )

 {

   UINTN Index;

   UINTN Number;

@@ -445,29 +405,24 @@ Returns:
   return EFI_SUCCESS;

 }

 

-VOID

-IScsiMacAddrToStr (

-  IN  EFI_MAC_ADDRESS  *Mac,

-  IN  UINT32           Len,

-  OUT CHAR16           *Str

-  )

-/*++

-

-Routine Description:

-

+/**

   Convert the mac address into a hexadecimal encoded "-" seperated string.

 

-Arguments:

+  @param  Mac[in]  The mac address.

 

-  Mac - The mac address.

-  Len - Length in bytes of the mac address.

-  Str - The storage to return the mac string.

+  @param  Len[in]  Length in bytes of the mac address.

 

-Returns:

+  @param  Str[out] The storage to return the mac string.

 

-  None.

+  @retval None.

 

---*/

+**/

+VOID

+IScsiMacAddrToStr (

+  IN  EFI_MAC_ADDRESS  *Mac,

+  IN  UINT32           Len,

+  OUT CHAR16           *Str

+  )

 {

   UINT32  Index;

 

@@ -480,33 +435,30 @@ Returns:
   Str[3 * Index - 1] = L'\0';

 }

 

-EFI_STATUS

-IScsiBinToHex (

-  IN     UINT8  *BinBuffer,

-  IN     UINT32 BinLength,

-  IN OUT CHAR8  *HexStr,

-  IN OUT UINT32 *HexLength

-  )

-/*++

+/**

+  Convert the binary encoded buffer into a hexadecimal encoded string.

 

-Routine Description:

+  @param  BinBuffer[in]        The buffer containing the binary data.

 

-  Convert the binary encoded buffer into a hexadecimal encoded string.

+  @param  BinLength[in]        Length of the binary buffer.

 

-Arguments:

+  @param  HexStr[in][out]      Pointer to the string.

 

-  BinBuffer - The buffer containing the binary data.

-  BinLength - Length of the binary buffer.

-  HexStr    - Pointer to the string.

-  HexLength - The length of the string.

+  @param  HexLength[in][out]   The length of the string.

 

-Returns:

+  @retval EFI_SUCCESS          The binary data is converted to the hexadecimal string 

+                               and the length of the string is updated.

 

-  EFI_SUCCESS          - The binary data is converted to the hexadecimal string 

-                         and the length of the string is updated.

-  EFI_BUFFER_TOO_SMALL - The string is too small.

+  @retval EFI_BUFFER_TOO_SMALL The string is too small.

 

---*/

+**/

+EFI_STATUS

+IScsiBinToHex (

+  IN     UINT8  *BinBuffer,

+  IN     UINT32 BinLength,

+  IN OUT CHAR8  *HexStr,

+  IN OUT UINT32 *HexLength

+  )

 {

   UINTN Index;

 

@@ -536,31 +488,27 @@ Returns:
   return EFI_SUCCESS;

 }

 

-EFI_STATUS

-IScsiHexToBin (

-  IN OUT UINT8  *BinBuffer,

-  IN OUT UINT32 *BinLength,

-  IN     CHAR8  *HexStr

-  )

-/*++

-

-Routine Description:

-

+/**

   Convert the hexadecimal string into a binary encoded buffer.

 

-Arguments:

+  @param  BinBuffer[in][out]   The binary buffer.

 

-  BinBuffer - The binary buffer.

-  BinLength - Length of the binary buffer.

-  HexStr    - The hexadecimal string.

+  @param  BinLength[in][out]   Length of the binary buffer.

 

-Returns:

+  @param  HexStr[in]           The hexadecimal string.

 

-  EFI_SUCCESS          - The hexadecimal string is converted into a binary 

-                         encoded buffer.

-  EFI_BUFFER_TOO_SMALL - The binary buffer is too small to hold the converted data.s

+  @retval EFI_SUCCESS          The hexadecimal string is converted into a binary

+                               encoded buffer.

 

---*/

+  @retval EFI_BUFFER_TOO_SMALL The binary buffer is too small to hold the converted data.s

+

+**/

+EFI_STATUS

+IScsiHexToBin (

+  IN OUT UINT8  *BinBuffer,

+  IN OUT UINT32 *BinLength,

+  IN     CHAR8  *HexStr

+  )

 {

   UINTN   Index;

   UINT32  HexCount;

@@ -613,27 +561,21 @@ Returns:
   return EFI_SUCCESS;

 }

 

-VOID

-IScsiGenRandom (

-  IN OUT UINT8  *Rand,

-  IN     UINTN  RandLength

-  )

-/*++

-

-Routine Description:

-

+/**

   Generate random numbers.

 

-Arguments:

+  @param  Rand[in][out]  The buffer to contain random numbers.

 

-  Rand       - The buffer to contain random numbers.

-  RandLength - The length of the Rand buffer.

+  @param  RandLength[in] The length of the Rand buffer.

 

-Returns:

+  @retval None.

 

-  None.

-

---*/

+**/

+VOID

+IScsiGenRandom (

+  IN OUT UINT8  *Rand,

+  IN     UINTN  RandLength

+  )

 {

   UINT32  Random;

 

@@ -644,27 +586,21 @@ Returns:
   }

 }

 

-ISCSI_DRIVER_DATA *

-IScsiCreateDriverData (

-  IN EFI_HANDLE  Image,

-  IN EFI_HANDLE  Controller

-  )

-/*++

-

-Routine Description:

-

+/**

   Create the iSCSI driver data..

 

-Arguments:

+  @param  Image[in]      The handle of the driver image.

 

-  Image      - The handle of the driver image.

-  Controller - The handle of the controller.

+  @param  Controller[in] The handle of the controller.

 

-Returns:

+  @retval The iSCSI driver data created.

 

-  The iSCSI driver data created.

-

---*/

+**/

+ISCSI_DRIVER_DATA *

+IScsiCreateDriverData (

+  IN EFI_HANDLE  Image,

+  IN EFI_HANDLE  Controller

+  )

 {

   ISCSI_DRIVER_DATA *Private;

   EFI_STATUS        Status;

@@ -725,25 +661,18 @@ Returns:
   return Private;

 }

 

-VOID

-IScsiCleanDriverData (

-  IN ISCSI_DRIVER_DATA  *Private

-  )

-/*++

-

-Routine Description:

-

+/**

   Clean the iSCSI driver data.

 

-Arguments:

-

-  Private - The iSCSI driver data.

-

-Returns:

+  @param  Private[in] The iSCSI driver data.

 

- None.

+  @retval None.

 

---*/

+**/

+VOID

+IScsiCleanDriverData (

+  IN ISCSI_DRIVER_DATA  *Private

+  )

 {

   if (Private->DevicePath != NULL) {

     gBS->UninstallProtocolInterface (

@@ -768,26 +697,21 @@ Returns:
   gBS->FreePool (Private);

 }

 

-EFI_STATUS

-IScsiGetConfigData (

-  IN ISCSI_DRIVER_DATA  *Private

-  )

-/*++

-

-Routine Description:

+/**

 

   Get the various configuration data of this iSCSI instance.

 

-Arguments:

-

-  Private - The iSCSI driver data.

+  @param  Private[in]   The iSCSI driver data.

 

-Returns:

+  @retval EFI_SUCCESS   The configuration of this instance is got.

 

-  EFI_SUCCESS   - The configuration of this instance is got.

-  EFI_NOT_FOUND - This iSCSI instance is not configured yet.

+  @retval EFI_NOT_FOUND This iSCSI instance is not configured yet.

 

---*/

+**/

+EFI_STATUS

+IScsiGetConfigData (

+  IN ISCSI_DRIVER_DATA  *Private

+  )

 {

   EFI_STATUS                  Status;

   ISCSI_SESSION               *Session;

@@ -866,25 +790,18 @@ Returns:
   return Status;

 }

 

-EFI_DEVICE_PATH_PROTOCOL *

-IScsiGetTcpConnDevicePath (

-  IN ISCSI_DRIVER_DATA  *Private

-  )

-/*++

-

-Routine Description:

-

+/**

   Get the device path of the iSCSI tcp connection and update it.

 

-Arguments:

+  @param  Private[in] The iSCSI driver data.

 

-  Private - The iSCSI driver data.

+  @retval The updated device path.

 

-Returns:

-

-  The updated device path.

-

---*/

+**/

+EFI_DEVICE_PATH_PROTOCOL *

+IScsiGetTcpConnDevicePath (

+  IN ISCSI_DRIVER_DATA  *Private

+  )

 {

   ISCSI_SESSION             *Session;

   ISCSI_CONNECTION          *Conn;

@@ -937,28 +854,22 @@ Returns:
   return DevicePath;

 }

 

+/**

+  Abort the session when the transition from BS to RT is initiated.

+

+  @param  Event[in]   The event signaled.

+

+  @param  Context[in] The iSCSI driver data.

+

+  @retval None.

+

+**/

 VOID

 EFIAPI

 IScsiOnExitBootService (

   IN EFI_EVENT  Event,

   IN VOID       *Context

   )

-/*++

-

-Routine Description:

-

-  Abort the session when the transition from BS to RT is initiated.

-

-Arguments:

-

-  Event   - The event signaled.

-  Context - The iSCSI driver data.

-

-Returns:

-

-  None.

-

---*/

 {

   ISCSI_DRIVER_DATA *Private;