1)update function header coding style issue

[mirror_edk2.git] / MdeModulePkg / Universal / Network / IScsiDxe / IScsiCHAP.h

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiCHAP.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiCHAP.h
index 2889167b32b19f67a40a41ce3fee4d187ffcc220..ca8338d504c5edc7742a684e3b841b608a254a1a 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiCHAP.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiCHAP.h
@@ -1,6 +1,7 @@
-/*++\r
+/** @file\r
+  The header file of CHAP configuration.\r
 \r
-Copyright (c) 2004 - 2007, Intel Corporation\r
+Copyright (c) 2004 - 2007, Intel Corporation.<BR>\r
 All rights reserved. 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\r
@@ -9,13 +10,7 @@ http://opensource.org/licenses/bsd-license.php
 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
 \r
-Module Name:\r
-\r
-  IScsiCHAP.h\r
-\r
-Abstract:\r
-\r
---*/\r
+**/\r
 \r
 #ifndef _ISCSI_CHAP_H_\r
 #define _ISCSI_CHAP_H_\r
@@ -38,7 +33,10 @@ extern EFI_GUID mIScsiCHAPAuthInfoGuid;
 #define ISCSI_CHAP_ALGORITHM_MD5  5\r
 \r
 #define ISCSI_CHAP_AUTH_MAX_LEN   1024\r
-#define ISCSI_CHAP_RSP_LEN        16  // == MD5_HASHSIZE\r
+///\r
+/// MD5_HASHSIZE\r
+///\r
+#define ISCSI_CHAP_RSP_LEN        16  \r
 typedef enum {\r
   ISCSI_CHAP_INITIAL,\r
   ISCSI_CHAP_STEP_ONE,\r
@@ -59,9 +57,9 @@ typedef struct _ISCSI_CHAP_AUTH_CONFIG_NVDATA {
 \r
 #pragma pack()\r
 \r
-//\r
-// ISCSI CHAP Authentication Data\r
-//\r
+///\r
+/// ISCSI CHAP Authentication Data\r
+///\r
 typedef struct _ISCSI_CHAP_AUTH_DATA {\r
   ISCSI_CHAP_AUTH_CONFIG_NVDATA AuthConfig;\r
   UINT32                        InIdentifier;\r
@@ -80,12 +78,36 @@ typedef struct _ISCSI_CHAP_AUTH_DATA {
   UINT32                        OutChallengeLength;\r
 } ISCSI_CHAP_AUTH_DATA;\r
 \r
+/**\r
+  This function checks the received iSCSI Login Response during the security\r
+  negotiation stage.\r
+  \r
+  @param[in] Conn             The iSCSI connection.\r
+  @param[in] Transit          The transit flag of the latest iSCSI Login Response.\r
+\r
+  @retval EFI_SUCCESS          The Login Response passed the CHAP validation.\r
+  @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
+  @retval EFI_PROTOCOL_ERROR   Some kind of protocol error happend.\r
+  @retval Others               Other errors as indicated.\r
+**/\r
 EFI_STATUS\r
 IScsiCHAPOnRspReceived (\r
   IN ISCSI_CONNECTION  *Conn,\r
   IN BOOLEAN           Transit\r
   );\r
 \r
+/**\r
+  This function fills the CHAP authentication information into the login PDU\r
+  during the security negotiation stage in the iSCSI connection login.\r
+\r
+  @param[in]  Conn             The iSCSI connection.\r
+  @param[in]  Pdu              The PDU to send out.\r
+\r
+  @retval EFI_SUCCESS          All check passed and the phase-related CHAP\r
+                               authentication info is filled into the iSCSI PDU.\r
+  @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
+  @retval EFI_PROTOCOL_ERROR   Some kind of protocol error happend.\r
+**/\r
 EFI_STATUS\r
 IScsiCHAPToSendReq (\r
   IN ISCSI_CONNECTION  *Conn,\r