mirror of https://github.com/acidanthera/audk.git
unified "iSCSI" in all comments
add . at the end of lines fix 2 file header issues and so on git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7256 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
parent
81464cf106
commit
55a64ae0f4
|
@ -22,7 +22,7 @@ extern EFI_COMPONENT_NAME2_PROTOCOL gIScsiComponentName2;
|
||||||
extern EFI_COMPONENT_NAME_PROTOCOL gIScsiComponentName;
|
extern EFI_COMPONENT_NAME_PROTOCOL gIScsiComponentName;
|
||||||
|
|
||||||
//
|
//
|
||||||
// EFI Component Name Protocol for IScsi driver.
|
// EFI Component Name Protocol for iSCSI driver.
|
||||||
//
|
//
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -36,7 +36,7 @@ extern EFI_COMPONENT_NAME_PROTOCOL gIScsiComponentName;
|
||||||
then EFI_UNSUPPORTED is returned.
|
then EFI_UNSUPPORTED is returned.
|
||||||
|
|
||||||
@param[in] This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
|
@param[in] This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
|
||||||
@param[in] Language A pointer to a three character ISO 639-2 language identifier.
|
@param[in] Language A pointer to a three characters ISO 639-2 language identifier.
|
||||||
This is the language of the driver name that that the caller
|
This is the language of the driver name that that the caller
|
||||||
is requesting, and it must match one of the languages specified
|
is requesting, and it must match one of the languages specified
|
||||||
in SupportedLanguages. The number of languages supported by a
|
in SupportedLanguages. The number of languages supported by a
|
||||||
|
@ -63,7 +63,7 @@ IScsiComponentNameGetDriverName (
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Retrieves a Unicode string that is the user readable name of the controller
|
Retrieves a Unicode string that is the user readable name of the controller
|
||||||
that is being managed by an EFI Driver.Currently not implemented.
|
that is being managed by an EFI Driver. Currently not implemented.
|
||||||
|
|
||||||
@param[in] This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
|
@param[in] This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
|
||||||
@param[in] ControllerHandle The handle of a controller that the driver specified by
|
@param[in] ControllerHandle The handle of a controller that the driver specified by
|
||||||
|
@ -75,7 +75,7 @@ IScsiComponentNameGetDriverName (
|
||||||
for a bus drivers that wish to retrieve the name of the
|
for a bus drivers that wish to retrieve the name of the
|
||||||
bus controller. It will not be NULL for a bus driver
|
bus controller. It will not be NULL for a bus driver
|
||||||
that wishes to retrieve the name of a child controller.
|
that wishes to retrieve the name of a child controller.
|
||||||
@param[in] Language A pointer to a three character ISO 639-2 language
|
@param[in] Language A pointer to a three characters ISO 639-2 language
|
||||||
identifier. This is the language of the controller name
|
identifier. This is the language of the controller name
|
||||||
that that the caller is requesting, and it must match one
|
that that the caller is requesting, and it must match one
|
||||||
of the languages specified in SupportedLanguages. The
|
of the languages specified in SupportedLanguages. The
|
||||||
|
@ -111,7 +111,7 @@ IScsiComponentNameGetControllerName (
|
||||||
);
|
);
|
||||||
|
|
||||||
//
|
//
|
||||||
// EFI IScsi Initiator Name Protocol for IScsi driver.
|
// EFI iSCSI Initiator Name Protocol for IScsi driver.
|
||||||
//
|
//
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -20,11 +20,11 @@ EFI_GUID mIScsiCHAPAuthInfoGuid = ISCSI_CHAP_AUTH_INFO_GUID;
|
||||||
/**
|
/**
|
||||||
Initator caculates its own expected hash value.
|
Initator caculates its own expected hash value.
|
||||||
|
|
||||||
@param[in] ChapIdentifier ISCSI CHAP identifier sent by authenticator.
|
@param[in] ChapIdentifier iSCSI CHAP identifier sent by authenticator.
|
||||||
@param[in] ChapSecret ISCSI CHAP secret of the authenticator.
|
@param[in] ChapSecret iSCSI CHAP secret of the authenticator.
|
||||||
@param[in] SecretLength The length of ISCSI CHAP secret.
|
@param[in] SecretLength The length of iSCSI CHAP secret.
|
||||||
@param[in] ChapChallenge The challenge message sent by authenticator.
|
@param[in] ChapChallenge The challenge message sent by authenticator.
|
||||||
@param[in] ChallengeLength The length of ISCSI CHAP challenge message.
|
@param[in] ChallengeLength The length of iSCSI CHAP challenge message.
|
||||||
@param[out] ChapResponse The calculation of the expected hash value.
|
@param[out] ChapResponse The calculation of the expected hash value.
|
||||||
|
|
||||||
@retval EFI_SUCCESS The expected hash value was caculatedly successfully.
|
@retval EFI_SUCCESS The expected hash value was caculatedly successfully.
|
||||||
|
@ -77,7 +77,7 @@ IScsiCHAPCalculateResponse (
|
||||||
The initator checks the CHAP response replied by target against its own
|
The initator checks the CHAP response replied by target against its own
|
||||||
calculation of the expected hash value.
|
calculation of the expected hash value.
|
||||||
|
|
||||||
@param[in] AuthData ISCSI CHAP authentication data.
|
@param[in] AuthData iSCSI CHAP authentication data.
|
||||||
@param[in] TargetResponse The response from target.
|
@param[in] TargetResponse The response from target.
|
||||||
|
|
||||||
@retval EFI_SUCCESS The response from target passed authentication.
|
@retval EFI_SUCCESS The response from target passed authentication.
|
||||||
|
|
|
@ -8,6 +8,7 @@ which accompanies this distribution. The full text of the license may be found
|
||||||
http://opensource.org/licenses/bsd-license.php
|
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.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/** @file
|
/** @file
|
||||||
Helper functions for configuring or getting the parameters relating to ISCSI.
|
Helper functions for configuring or getting the parameters relating to iSCSI.
|
||||||
|
|
||||||
Copyright (c) 2004 - 2008, Intel Corporation.<BR>
|
Copyright (c) 2004 - 2008, Intel Corporation.<BR>
|
||||||
All rights reserved. This program and the accompanying materials
|
All rights reserved. This program and the accompanying materials
|
||||||
|
@ -398,7 +398,7 @@ IScsiFormExtractConfig (
|
||||||
driver followed by name / value configuration pairs. The driver
|
driver followed by name / value configuration pairs. The driver
|
||||||
must apply those pairs to its configurable storage. If the
|
must apply those pairs to its configurable storage. If the
|
||||||
driver's configuration is stored in a linear block of data
|
driver's configuration is stored in a linear block of data
|
||||||
and the driver????s name / value pairs are in <BlockConfig>
|
and the driver's name / value pairs are in <BlockConfig>
|
||||||
format, it may use the ConfigToBlock helper function (above) to
|
format, it may use the ConfigToBlock helper function (above) to
|
||||||
simplify the job. Currently not implemented.
|
simplify the job. Currently not implemented.
|
||||||
|
|
||||||
|
|
|
@ -51,10 +51,10 @@ extern UINT8 IScsiDxeStrings[];
|
||||||
If ISCSI_FORM_CALLBACK_INFO_SIGNATURE does not contain a field called Signature,
|
If ISCSI_FORM_CALLBACK_INFO_SIGNATURE does not contain a field called Signature,
|
||||||
then the module will not compile.
|
then the module will not compile.
|
||||||
|
|
||||||
@param Callback Pointer to the specified field within the data
|
@param Callback Pointer to the specified field within the data
|
||||||
structure ISCSI_FORM_CALLBACK_INFO.
|
structure ISCSI_FORM_CALLBACK_INFO.
|
||||||
@return a pointer to the pointer to a data structure ISCSI_FORM_CALLBACK_INFO.
|
@return A pointer to the pointer to a data structure ISCSI_FORM_CALLBACK_INFO.
|
||||||
@return Others Some unexpected error happened.
|
@retval Others Some unexpected error happened.
|
||||||
**/
|
**/
|
||||||
|
|
||||||
#define ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK(Callback) \
|
#define ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK(Callback) \
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/** @file
|
/** @file
|
||||||
Vfr file for IScsi config.
|
Vfr file for iSCSI config.
|
||||||
|
|
||||||
Copyright (c) 2004 - 2008, Intel Corporation.<BR>
|
Copyright (c) 2004 - 2008, Intel Corporation.<BR>
|
||||||
All rights reserved. This program and the accompanying materials
|
All rights reserved. This program and the accompanying materials
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
/** @file
|
/** @file
|
||||||
Define NVData structures used by the iSCSI configuration component
|
Define NVData structures used by the iSCSI configuration component
|
||||||
|
|
||||||
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,14 +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:
|
|
||||||
|
|
||||||
IScsiConfigNVDataStruc.h
|
|
||||||
|
|
||||||
Abstract:
|
|
||||||
|
|
||||||
NVData structure used by the iSCSI configuration component.
|
|
||||||
|
|
||||||
**/
|
**/
|
||||||
|
|
||||||
#ifndef _ISCSI_NVDATASTRUC_H_
|
#ifndef _ISCSI_NVDATASTRUC_H_
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/** @file
|
/** @file
|
||||||
ISci DHCP related configuration routines.
|
iSCSI DHCP related configuration routines.
|
||||||
|
|
||||||
Copyright (c) 2004 - 2007, Intel Corporation.<BR>
|
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
|
||||||
|
|
|
@ -102,11 +102,12 @@ IScsiDriverBindingSupported (
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Start this driver on ControllerHandle. The Start() function is designed to be
|
Start this driver on ControllerHandle.
|
||||||
invoked from the EFI boot service ConnectController(). As a result, much of
|
|
||||||
the error checking on the parameters to Start() has been moved into this
|
The Start() function is designed to be invoked from the EFI boot service ConnectController().
|
||||||
common boot service. It is legal to call Start() from other locations,
|
As a result, much of the error checking on the parameters to Start() has been moved into this
|
||||||
but the following calling restrictions must be followed or the system behavior will not be deterministic.
|
common boot service. It is legal to call Start() from other locations, but the following calling
|
||||||
|
restrictions must be followed or the system behavior will not be deterministic.
|
||||||
1. ControllerHandle must be a valid EFI_HANDLE.
|
1. ControllerHandle must be a valid EFI_HANDLE.
|
||||||
2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned
|
2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned
|
||||||
EFI_DEVICE_PATH_PROTOCOL.
|
EFI_DEVICE_PATH_PROTOCOL.
|
||||||
|
|
|
@ -28,7 +28,7 @@ EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName = {
|
||||||
@param[out] Buffer Pointer to the buffer for data to be read.
|
@param[out] Buffer Pointer to the buffer for data to be read.
|
||||||
|
|
||||||
@retval EFI_SUCCESS Data was successfully retrieved into the provided buffer and the
|
@retval EFI_SUCCESS Data was successfully retrieved into the provided buffer and the
|
||||||
BufferSize was sufficient to handle the iSCSI initiator name
|
BufferSize was sufficient to handle the iSCSI initiator name.
|
||||||
@retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the result.
|
@retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the result.
|
||||||
@retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL.
|
@retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL.
|
||||||
@retval EFI_DEVICE_ERROR The iSCSI initiator name could not be retrieved due to a hardware error.
|
@retval EFI_DEVICE_ERROR The iSCSI initiator name could not be retrieved due to a hardware error.
|
||||||
|
@ -73,7 +73,7 @@ IScsiGetInitiatorName (
|
||||||
@retval EFI_DEVICE_ERROR The data could not be stored due to a hardware error.
|
@retval EFI_DEVICE_ERROR The data could not be stored due to a hardware error.
|
||||||
@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data.
|
@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data.
|
||||||
@retval EFI_PROTOCOL_ERROR Input iSCSI initiator name does not adhere to RFC 3720
|
@retval EFI_PROTOCOL_ERROR Input iSCSI initiator name does not adhere to RFC 3720
|
||||||
(and other related protocols)
|
(and other related protocols).
|
||||||
@retval Others Other errors as indicated.
|
@retval Others Other errors as indicated.
|
||||||
**/
|
**/
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
|
|
|
@ -20,7 +20,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
extern EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName;
|
extern EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName;
|
||||||
|
|
||||||
//
|
//
|
||||||
// EFI IScsi Initiator Name Protocol for IScsi driver.
|
// EFI iSCSI Initiator Name Protocol for IScsi driver.
|
||||||
//
|
//
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -32,7 +32,7 @@ extern EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName;
|
||||||
@param[out] Buffer Pointer to the buffer for data to be read.
|
@param[out] Buffer Pointer to the buffer for data to be read.
|
||||||
|
|
||||||
@retval EFI_SUCCESS Data was successfully retrieved into the provided buffer and the
|
@retval EFI_SUCCESS Data was successfully retrieved into the provided buffer and the
|
||||||
BufferSize was sufficient to handle the iSCSI initiator name
|
BufferSize was sufficient to handle the iSCSI initiator name.
|
||||||
@retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the result.
|
@retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the result.
|
||||||
@retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL.
|
@retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL.
|
||||||
@retval EFI_DEVICE_ERROR The iSCSI initiator name could not be retrieved due to a hardware error.
|
@retval EFI_DEVICE_ERROR The iSCSI initiator name could not be retrieved due to a hardware error.
|
||||||
|
@ -60,7 +60,7 @@ IScsiGetInitiatorName (
|
||||||
@retval EFI_DEVICE_ERROR The data could not be stored due to a hardware error.
|
@retval EFI_DEVICE_ERROR The data could not be stored due to a hardware error.
|
||||||
@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data.
|
@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the data.
|
||||||
@retval EFI_PROTOCOL_ERROR Input iSCSI initiator name does not adhere to RFC 3720
|
@retval EFI_PROTOCOL_ERROR Input iSCSI initiator name does not adhere to RFC 3720
|
||||||
(and other related protocols)
|
(and other related protocols).
|
||||||
@retval Others Other errors as indicated.
|
@retval Others Other errors as indicated.
|
||||||
**/
|
**/
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/** @file
|
/** @file
|
||||||
Miscellaneous routines for IScsi driver.
|
Miscellaneous routines for iSCSI driver.
|
||||||
|
|
||||||
Copyright (c) 2004 - 2008, Intel Corporation.<BR>
|
Copyright (c) 2004 - 2008, Intel Corporation.<BR>
|
||||||
All rights reserved. This program and the accompanying materials
|
All rights reserved. This program and the accompanying materials
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/** @file
|
/** @file
|
||||||
Miscellaneous definitions for IScsi driver.
|
Miscellaneous definitions for iSCSI driver.
|
||||||
|
|
||||||
Copyright (c) 2004 - 2008, Intel Corporation.<BR>
|
Copyright (c) 2004 - 2008, Intel Corporation.<BR>
|
||||||
All rights reserved. This program and the accompanying materials
|
All rights reserved. This program and the accompanying materials
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/** @file
|
/** @file
|
||||||
The implementation of IScsi protocol based on RFC3720.
|
The implementation of iSCSI protocol based on RFC3720.
|
||||||
|
|
||||||
Copyright (c) 2004 - 2008, Intel Corporation.<BR>
|
Copyright (c) 2004 - 2008, Intel Corporation.<BR>
|
||||||
All rights reserved. This program and the accompanying materials
|
All rights reserved. This program and the accompanying materials
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/** @file
|
/** @file
|
||||||
The header file of IScsi Protocol that defines many specific data structures.
|
The header file of iSCSI Protocol that defines many specific data structures.
|
||||||
|
|
||||||
Copyright (c) 2004 - 2008, Intel Corporation.<BR>
|
Copyright (c) 2004 - 2008, Intel Corporation.<BR>
|
||||||
All rights reserved. This program and the accompanying materials
|
All rights reserved. This program and the accompanying materials
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/** @file
|
/** @file
|
||||||
IScsi Tcp4 IO related definitions.
|
iSCSI Tcp4 IO related definitions.
|
||||||
|
|
||||||
Copyright (c) 2004 - 2008, Intel Corporation.<BR>
|
Copyright (c) 2004 - 2008, Intel Corporation.<BR>
|
||||||
All rights reserved. This program and the accompanying materials
|
All rights reserved. This program and the accompanying materials
|
||||||
|
|
Loading…
Reference in New Issue