diff options
Diffstat (limited to 'MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.h')
| -rw-r--r-- | MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.h | 197 |
1 files changed, 193 insertions, 4 deletions
diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.h index b6a43243a7..a66fc151e9 100644 --- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.h +++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDriver.h @@ -1,4 +1,5 @@ -/*++
+/** @file
+ The header file of IScsiDriver.c
Copyright (c) 2004 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
@@ -14,8 +15,9 @@ Module Name: IScsiDriver.h
Abstract:
+ The header file of IScsiDriver.c
---*/
+**/
#ifndef _ISCSI_DRIVER_H_
#define _ISCSI_DRIVER_H_
@@ -55,6 +57,22 @@ typedef struct _ISCSI_PRIVATE_PROTOCOL { //
// EFI Driver Binding Protocol for iSCSI driver.
//
+/**
+ Test to see if IScsi driver supports the given controller.
+
+ @param This[in] Protocol instance pointer.
+
+ @param ControllerHandle[in] Handle of controller to test.
+
+ @param RemainingDevicePath[in] Optional parameter use to pick a specific child device to start.
+
+ @retval EFI_SUCCES This driver supports the controller.
+
+ @retval EFI_ALREADY_STARTED This driver is already running on this device.
+
+ @retval EFI_UNSUPPORTED This driver doesn't support the controller.
+
+**/
EFI_STATUS
EFIAPI
IScsiDriverBindingSupported (
@@ -63,6 +81,20 @@ IScsiDriverBindingSupported ( IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
);
+/**
+ Start to manage the controller.
+
+ @param This[in] Protocol instance pointer.
+
+ @param ControllerHandle[in] Handle of the controller.
+
+ @param RemainingDevicePath[in] Optional parameter use to pick a specific child device to start.
+
+ @retval EFI_SUCCES This driver supports this device.
+
+ @retval EFI_ALREADY_STARTED This driver is already running on this device.
+
+**/
EFI_STATUS
EFIAPI
IScsiDriverBindingStart (
@@ -71,6 +103,20 @@ IScsiDriverBindingStart ( IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL
);
+/**
+ Release the control of this controller and remove the IScsi functions.
+
+ @param This[in] Protocol instance pointer.
+
+ @param ControllerHandle[in] Handle of controller to stop.
+
+ @param NumberOfChildren[in] Not used.
+
+ @param ChildHandleBuffer[in] Not used.
+
+ @retval EFI_SUCCES This driver supports this device.
+
+**/
EFI_STATUS
EFIAPI
IScsiDriverBindingStop (
@@ -81,8 +127,46 @@ IScsiDriverBindingStop ( );
//
-// 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.
+
+ This function retrieves the user readable name of a driver in the form of a
+ Unicode string. If the driver specified by This has a user readable name in
+ the language specified by Language, then a pointer to the driver name is
+ 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 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_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.
+
+**/
EFI_STATUS
EFIAPI
IScsiComponentNameGetDriverName (
@@ -91,6 +175,55 @@ IScsiComponentNameGetDriverName ( OUT CHAR16 **DriverName
);
+/**
+ Retrieves a Unicode string that is the user readable name of the controller
+ that is being managed by an EFI Driver.
+
+ @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.
+
+ @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
+ language specified by Language.
+
+**/
EFI_STATUS
EFIAPI
IScsiComponentNameGetControllerName (
@@ -102,8 +235,35 @@ IScsiComponentNameGetControllerName ( );
//
-// 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.
+
+ @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.
+
+**/
EFI_STATUS
EFIAPI
IScsiGetInitiatorName (
@@ -112,6 +272,35 @@ IScsiGetInitiatorName ( OUT VOID *Buffer
);
+/**
+ Sets the 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.
+
+ @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.
+
+ @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.
+
+**/
EFI_STATUS
EFIAPI
IScsiSetInitiatorName (
|