update file header

update function header
update comments for one macro

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6941 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
ywu21 2008-12-10 02:02:38 +00:00
parent 11e0ec6b3c
commit fab4bd0444
1 changed files with 14 additions and 24 deletions

View File

@ -1,7 +1,7 @@
/** @file /** @file
The header file of CHAP configuration The header file of CHAP configuration.
Copyright (c) 2004 - 2007, Intel Corporation Copyright (c) 2004 - 2007, Intel Corporation.<BR>
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -10,12 +10,6 @@ http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Module Name:
IScsiCHAP.h
Abstract:
the header file for CHAP
**/ **/
#ifndef _ISCSI_CHAP_H_ #ifndef _ISCSI_CHAP_H_
@ -39,7 +33,10 @@ extern EFI_GUID mIScsiCHAPAuthInfoGuid;
#define ISCSI_CHAP_ALGORITHM_MD5 5 #define ISCSI_CHAP_ALGORITHM_MD5 5
#define ISCSI_CHAP_AUTH_MAX_LEN 1024 #define ISCSI_CHAP_AUTH_MAX_LEN 1024
#define ISCSI_CHAP_RSP_LEN 16 // == MD5_HASHSIZE ///
/// MD5_HASHSIZE
///
#define ISCSI_CHAP_RSP_LEN 16
typedef enum { typedef enum {
ISCSI_CHAP_INITIAL, ISCSI_CHAP_INITIAL,
ISCSI_CHAP_STEP_ONE, ISCSI_CHAP_STEP_ONE,
@ -60,9 +57,9 @@ typedef struct _ISCSI_CHAP_AUTH_CONFIG_NVDATA {
#pragma pack() #pragma pack()
// ///
// ISCSI CHAP Authentication Data /// ISCSI CHAP Authentication Data
// ///
typedef struct _ISCSI_CHAP_AUTH_DATA { typedef struct _ISCSI_CHAP_AUTH_DATA {
ISCSI_CHAP_AUTH_CONFIG_NVDATA AuthConfig; ISCSI_CHAP_AUTH_CONFIG_NVDATA AuthConfig;
UINT32 InIdentifier; UINT32 InIdentifier;
@ -85,16 +82,13 @@ typedef struct _ISCSI_CHAP_AUTH_DATA {
This function checks the received iSCSI Login Response during the security This function checks the received iSCSI Login Response during the security
negotiation stage. negotiation stage.
@param Conn[in] The iSCSI connection. @param[in] Conn The iSCSI connection.
@param[in] Transit The transit flag of the latest iSCSI Login Response.
@param Transit[in] The transit flag of the latest iSCSI Login Response.
@retval EFI_SUCCESS The Login Response passed the CHAP validation. @retval EFI_SUCCESS The Login Response passed the CHAP validation.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory. @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
@retval EFI_PROTOCOL_ERROR Some kind of protocol error happend. @retval EFI_PROTOCOL_ERROR Some kind of protocol error happend.
@retval Others Some unexpected error happend.
**/ **/
EFI_STATUS EFI_STATUS
IScsiCHAPOnRspReceived ( IScsiCHAPOnRspReceived (
@ -106,17 +100,13 @@ IScsiCHAPOnRspReceived (
This function fills the CHAP authentication information into the login PDU This function fills the CHAP authentication information into the login PDU
during the security negotiation stage in the iSCSI connection login. during the security negotiation stage in the iSCSI connection login.
@param Conn[in] The iSCSI connection. @param[in] Conn The iSCSI connection.
@param[in] Pdu The PDU to send out.
@param Pdu[in] The PDU to send out.
@retval EFI_SUCCESS All check passed and the phase-related CHAP @retval EFI_SUCCESS All check passed and the phase-related CHAP
authentication info is filled into the iSCSI PDU. authentication info is filled into the iSCSI PDU.
@retval EFI_OUT_OF_RESOURCES Failed to allocate memory. @retval EFI_OUT_OF_RESOURCES Failed to allocate memory.
@retval EFI_PROTOCOL_ERROR Some kind of protocol error happend. @retval EFI_PROTOCOL_ERROR Some kind of protocol error happend.
**/ **/
EFI_STATUS EFI_STATUS
IScsiCHAPToSendReq ( IScsiCHAPToSendReq (