mirror of https://github.com/acidanthera/audk.git
update file header
update function header according to #include <Protocol/IScsiInitiatorName.h> #include <Protocol/ComponentName.h> git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6950 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
ywu21
parent
0c3437e043
commit
753f9e6948
|
|
@ -48,33 +48,33 @@ typedef struct _ISCSI_PRIVATE_PROTOCOL {
|
|||
UINT32 Reserved;
|
||||
} ISCSI_PRIVATE_PROTOCOL;
|
||||
|
||||
//
|
||||
// EFI Driver Binding Protocol for iSCSI driver.
|
||||
//
|
||||
///
|
||||
/// EFI Driver Binding Protocol for iSCSI driver.
|
||||
///
|
||||
|
||||
/**
|
||||
Tests to see if this driver supports a given controller. If a child device is provided,
|
||||
it further tests to see if this driver supports creating a handle for the specified child device.
|
||||
|
||||
@param This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
|
||||
@param ControllerHandle The handle of the controller to test. This handle
|
||||
must support a protocol interface that supplies
|
||||
an I/O abstraction to the driver.
|
||||
@param RemainingDevicePath A pointer to the remaining portion of a device path.
|
||||
This parameter is ignored by device drivers, and is optional for bus drivers.
|
||||
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
|
||||
@param[in] ControllerHandle The handle of the controller to test. This handle
|
||||
must support a protocol interface that supplies
|
||||
an I/O abstraction to the driver.
|
||||
@param[in] RemainingDevicePath A pointer to the remaining portion of a device path.
|
||||
This parameter is ignored by device drivers, and is optional for bus drivers.
|
||||
|
||||
|
||||
@retval EFI_SUCCESS The device specified by ControllerHandle and
|
||||
RemainingDevicePath is supported by the driver specified by This.
|
||||
@retval EFI_ALREADY_STARTED The device specified by ControllerHandle and
|
||||
RemainingDevicePath is already being managed by the driver
|
||||
specified by This.
|
||||
@retval EFI_ACCESS_DENIED The device specified by ControllerHandle and
|
||||
RemainingDevicePath is already being managed by a different
|
||||
driver or an application that requires exclusive acces.
|
||||
Currently not implemented.
|
||||
@retval EFI_UNSUPPORTED The device specified by ControllerHandle and
|
||||
RemainingDevicePath is not supported by the driver specified by This.
|
||||
@retval EFI_SUCCESS The device specified by ControllerHandle and
|
||||
RemainingDevicePath is supported by the driver specified by This.
|
||||
@retval EFI_ALREADY_STARTED The device specified by ControllerHandle and
|
||||
RemainingDevicePath is already being managed by the driver
|
||||
specified by This.
|
||||
@retval EFI_ACCESS_DENIED The device specified by ControllerHandle and
|
||||
RemainingDevicePath is already being managed by a different
|
||||
driver or an application that requires exclusive acces.
|
||||
Currently not implemented.
|
||||
@retval EFI_UNSUPPORTED The device specified by ControllerHandle and
|
||||
RemainingDevicePath is not supported by the driver specified by This.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
|
|
@ -96,17 +96,18 @@ IScsiDriverBindingSupported (
|
|||
3. Prior to calling Start(), the Supported() function for the driver specified by This must
|
||||
have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS.
|
||||
|
||||
@param This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
|
||||
@param ControllerHandle The handle of the controller to start. This handle
|
||||
must support a protocol interface that supplies
|
||||
an I/O abstraction to the driver.
|
||||
@param RemainingDevicePath A pointer to the remaining portion of a device path.
|
||||
This parameter is ignored by device drivers, and is optional for bus drivers.
|
||||
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
|
||||
@param[in] ControllerHandle The handle of the controller to start. This handle
|
||||
must support a protocol interface that supplies
|
||||
an I/O abstraction to the driver.
|
||||
@param[in] RemainingDevicePath A pointer to the remaining portion of a device path.
|
||||
This parameter is ignored by device drivers, and is optional for bus drivers.
|
||||
|
||||
@retval EFI_SUCCESS The device was started.
|
||||
@retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented.
|
||||
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
|
||||
@retval other The driver failded to start the device.
|
||||
@retval EFI_SUCCESS The device was started.
|
||||
@retval EFI_DEVICE_ERROR The device could not be started due to a device error.
|
||||
Currently not implemented.
|
||||
@retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.
|
||||
@retval Others The driver failded to start the device.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
|
|
@ -131,16 +132,16 @@ IScsiDriverBindingStart (
|
|||
Start() function, and the Start() function must have called OpenProtocol() on
|
||||
ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
|
||||
|
||||
@param This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
|
||||
@param ControllerHandle A handle to the device being stopped. The handle must
|
||||
support a bus specific I/O protocol for the driver
|
||||
to use to stop the device.
|
||||
@param NumberOfChildren The number of child device handles in ChildHandleBuffer.Not used.
|
||||
@param ChildHandleBuffer An array of child handles to be freed. May be NULL
|
||||
if NumberOfChildren is 0.Not used.
|
||||
@param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.
|
||||
@param[in] ControllerHandle A handle to the device being stopped. The handle must
|
||||
support a bus specific I/O protocol for the driver
|
||||
to use to stop the device.
|
||||
@param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.Not used.
|
||||
@param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL
|
||||
if NumberOfChildren is 0.Not used.
|
||||
|
||||
@retval EFI_SUCCESS The device was stopped.
|
||||
@retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
|
||||
@retval EFI_SUCCESS The device was stopped.
|
||||
@retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
|
|
@ -151,9 +152,10 @@ IScsiDriverBindingStop (
|
|||
IN EFI_HANDLE *ChildHandleBuffer
|
||||
);
|
||||
|
||||
//
|
||||
// EFI Component Name Protocol for IScsi driver.
|
||||
//
|
||||
///
|
||||
/// EFI Component Name Protocol for IScsi driver.
|
||||
///
|
||||
|
||||
/**
|
||||
Retrieves a Unicode string that is the user readable name of the EFI Driver.
|
||||
|
||||
|
|
@ -163,34 +165,24 @@ IScsiDriverBindingStop (
|
|||
returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
|
||||
by This does not support the language specified by Language,
|
||||
then EFI_UNSUPPORTED is returned.
|
||||
|
||||
@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.
|
||||
This is the language of the driver name that that the caller
|
||||
is requesting, and it must match one of the languages specified
|
||||
in SupportedLanguages. The number of languages supported by a
|
||||
driver is up to the driver writer.
|
||||
@param[out] DriverName A pointer to the Unicode string to return. This Unicode string
|
||||
is the name of the driver specified by This in the language
|
||||
specified by Language.
|
||||
|
||||
@param This[in] A pointer to the EFI_COMPONENT_NAME_PROTOCOL
|
||||
instance.
|
||||
|
||||
@param Language[in] A pointer to a three character ISO 639-2 language
|
||||
identifier.
|
||||
This is the language of the driver name that that
|
||||
the caller is requesting, and it must match one of
|
||||
the languages specified in SupportedLanguages.
|
||||
The number of languages supported by a driver is up
|
||||
to the driver writer.
|
||||
|
||||
@param DriverName[out] A pointer to the Unicode string to return.
|
||||
This Unicode string is the name of the
|
||||
driver specified by This in the language
|
||||
specified by Language.
|
||||
|
||||
@retval EFI_SUCCESS The Unicode string for the Driver specified by
|
||||
This and the language specified by Language was
|
||||
returned in DriverName.
|
||||
|
||||
@retval EFI_SUCCESS The Unicode string for the Driver specified by This
|
||||
and the language specified by Language was returned
|
||||
in DriverName.
|
||||
@retval EFI_INVALID_PARAMETER Language is NULL.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER DriverName is NULL.
|
||||
|
||||
@retval EFI_UNSUPPORTED The driver specified by This does not support
|
||||
the language specified by Language.
|
||||
|
||||
@retval EFI_UNSUPPORTED The driver specified by This does not support the
|
||||
language specified by Language.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
|
|
@ -202,52 +194,42 @@ IScsiComponentNameGetDriverName (
|
|||
|
||||
/**
|
||||
Retrieves a Unicode string that is the user readable name of the controller
|
||||
that is being managed by an EFI Driver.
|
||||
that is being managed by an EFI Driver.Currently not implemented.
|
||||
|
||||
@param This[in] A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
|
||||
|
||||
@param ControllerHandle[in] The handle of a controller that the driver specified by
|
||||
This is managing. This handle specifies the controller
|
||||
whose name is to be returned.
|
||||
|
||||
@param ChildHandle[in] The handle of the child controller to retrieve the name
|
||||
of. This is an optional parameter that may be NULL. It
|
||||
will be NULL for device drivers. It will also be NULL
|
||||
for a bus drivers that wish to retrieve the name of the
|
||||
bus controller. It will not be NULL for a bus driver
|
||||
that wishes to retrieve the name of a child controller.
|
||||
|
||||
@param Language[in] A pointer to a three character ISO 639-2 language
|
||||
identifier. This is the language of the controller name
|
||||
that that the caller is requesting, and it must match one
|
||||
of the languages specified in SupportedLanguages. The
|
||||
number of languages supported by a driver is up to the
|
||||
driver writer.
|
||||
|
||||
@param ControllerName[out] A pointer to the Unicode string to return. This Unicode
|
||||
string is the name of the controller specified by
|
||||
ControllerHandle and ChildHandle in the language
|
||||
specified by Language from the point of view of the
|
||||
driver specified by This.
|
||||
|
||||
@retval EFI_SUCCESS The Unicode string for the user readable name in the
|
||||
language specified by Language for the driver
|
||||
specified by This was returned in DriverName.
|
||||
@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
|
||||
This is managing. This handle specifies the controller
|
||||
whose name is to be returned.
|
||||
@param[in] ChildHandle The handle of the child controller to retrieve the name
|
||||
of. This is an optional parameter that may be NULL. It
|
||||
will be NULL for device drivers. It will also be NULL
|
||||
for a bus drivers that wish to retrieve the name of the
|
||||
bus controller. It will not be NULL for a bus driver
|
||||
that wishes to retrieve the name of a child controller.
|
||||
@param[in] Language A pointer to a three character ISO 639-2 language
|
||||
identifier. This is the language of the controller name
|
||||
that that the caller is requesting, and it must match one
|
||||
of the languages specified in SupportedLanguages. The
|
||||
number of languages supported by a driver is up to the
|
||||
driver writer.
|
||||
@param[out] ControllerName A pointer to the Unicode string to return. This Unicode
|
||||
string is the name of the controller specified by
|
||||
ControllerHandle and ChildHandle in the language specified
|
||||
by Language from the point of view of the driver specified
|
||||
by This.
|
||||
|
||||
@retval EFI_SUCCESS The Unicode string for the user readable name in the
|
||||
language specified by Language for the driver
|
||||
specified by This was returned in DriverName.
|
||||
@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER Language is NULL.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER ControllerName is NULL.
|
||||
|
||||
@retval EFI_UNSUPPORTED The driver specified by This is not currently managing
|
||||
the controller specified by ControllerHandle and ChildHandle.
|
||||
|
||||
@retval EFI_UNSUPPORTED The driver specified by This does not support the
|
||||
the controller specified by ControllerHandle and
|
||||
ChildHandle.
|
||||
@retval EFI_UNSUPPORTED The driver specified by This does not support the
|
||||
language specified by Language.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
|
|
@ -259,35 +241,24 @@ IScsiComponentNameGetControllerName (
|
|||
OUT CHAR16 **ControllerName
|
||||
);
|
||||
|
||||
//
|
||||
// EFI IScsi Initiator Name Protocol for IScsi driver.
|
||||
//
|
||||
///
|
||||
/// EFI IScsi Initiator Name Protocol for IScsi driver.
|
||||
///
|
||||
|
||||
/**
|
||||
Retrieves the current set value of iSCSI Initiator Name.
|
||||
Retrieves the current set value of iSCSI Initiator Name.
|
||||
|
||||
@param This[in] Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
|
||||
|
||||
@param BufferSize[in][out] Size of the buffer in bytes pointed to by Buffer / Actual
|
||||
size of the variable data buffer.
|
||||
|
||||
@param Buffer[out] Pointer to the buffer for data to be read.
|
||||
|
||||
@retval EFI_SUCCESS Data was successfully retrieved into the provided
|
||||
buffer and the BufferSize was sufficient to handle the
|
||||
iSCSI initiator name.
|
||||
@retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the result. BufferSize will
|
||||
be updated with the size required to complete the request.
|
||||
Buffer will not be affected.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER BufferSize is NULL. BufferSize and Buffer will not be
|
||||
affected.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER Buffer is NULL. BufferSize and Buffer will not be
|
||||
affected.
|
||||
|
||||
@retval EFI_DEVICE_ERROR The iSCSI initiator name could not be retrieved due to
|
||||
a hardware error.
|
||||
@param[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
|
||||
@param[in, out] BufferSize Size of the buffer in bytes pointed to by Buffer / Actual size of the
|
||||
variable data buffer.
|
||||
@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
|
||||
BufferSize was sufficient to handle the iSCSI initiator name
|
||||
@retval EFI_BUFFER_TOO_SMALL BufferSize is too small for the result.
|
||||
@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 Others Some unexpected error happened.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
|
|
@ -298,33 +269,21 @@ IScsiGetInitiatorName (
|
|||
);
|
||||
|
||||
/**
|
||||
Sets the iSCSI Initiator Name.
|
||||
Sets the iSCSI Initiator Name.
|
||||
|
||||
@param This[in] Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
|
||||
@param[in] This Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance.
|
||||
@param[in, out] BufferSize Size of the buffer in bytes pointed to by Buffer.
|
||||
@param[in] Buffer Pointer to the buffer for data to be written.
|
||||
|
||||
@param BufferSize[in][out] Size of the buffer in bytes pointed to by Buffer.
|
||||
|
||||
@param Buffer[out] Pointer to the buffer for data to be written.
|
||||
|
||||
@retval EFI_SUCCESS Data was successfully stored by the protocol.
|
||||
|
||||
@retval EFI_UNSUPPORTED Platform policies do not allow for data to be written.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER BufferSize exceeds the maximum allowed limit.
|
||||
BufferSize will be updated with the maximum size
|
||||
required to complete the request.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER Buffersize is NULL. BufferSize and Buffer will not be
|
||||
affected.
|
||||
|
||||
@retval EFI_INVALID_PARAMETER Buffer is NULL. BufferSize and Buffer will not be affected.
|
||||
|
||||
Currently not implemented.
|
||||
@retval EFI_INVALID_PARAMETER BufferSize or Buffer is NULL, or BufferSize exceeds the maximum allowed limit.
|
||||
@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_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)
|
||||
@retval Others Some unexpected error happened.
|
||||
**/
|
||||
EFI_STATUS
|
||||
EFIAPI
|
||||
|
|
|
|||
Loading…
Reference in New Issue