[Description]

[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..bd5b13c00c180581519b09a6b452025354a1ae31 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiCHAP.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiCHAP.h
@@ -1,4 +1,5 @@
-/*++\r
+/** @file\r
+  The header file of CHAP configuration\r
 \r
 Copyright (c) 2004 - 2007, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
@@ -14,8 +15,8 @@ Module Name:
   IScsiCHAP.h\r
 \r
 Abstract:\r
-\r
---*/\r
+  the header file for CHAP\r
+**/\r
 \r
 #ifndef _ISCSI_CHAP_H_\r
 #define _ISCSI_CHAP_H_\r
@@ -80,12 +81,43 @@ 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  Conn[in]             The iSCSI connection.\r
+\r
+  @param  Transit[in]          The transit flag of the latest iSCSI Login Response.\r
+\r
+  @retval EFI_SUCCESS          The Login Response passed the CHAP validation.\r
+\r
+  @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
+\r
+  @retval EFI_PROTOCOL_ERROR   Some kind of protocol error happend.\r
+\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  Conn[in]             The iSCSI connection.\r
+\r
+  @param  Pdu[in]              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
+\r
+  @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.\r
+\r
+  @retval EFI_PROTOCOL_ERROR   Some kind of protocol error happend.\r
+\r
+**/\r
 EFI_STATUS\r
 IScsiCHAPToSendReq (\r
   IN ISCSI_CONNECTION  *Conn,\r