Data Structures | |
struct | ISCSI_PRIVATE_DATA |
struct | ISCSI_NIC_INFO |
struct | _ISCSI_PRIVATE_PROTOCOL |
Defines | |
#define | ISCSI_V4_PRIVATE_GUID |
#define | ISCSI_V6_PRIVATE_GUID |
#define | ISCSI_INITIATOR_NAME_VAR_NAME L"I_NAME" |
#define | IP_MODE_AUTOCONFIG_IP4 3 |
#define | IP_MODE_AUTOCONFIG_IP6 4 |
Typedefs | |
typedef struct _ISCSI_PRIVATE_PROTOCOL | ISCSI_PRIVATE_PROTOCOL |
Functions | |
EFI_STATUS EFIAPI | IScsiIp4DriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath) |
EFI_STATUS EFIAPI | IScsiIp4DriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath) |
EFI_STATUS EFIAPI | IScsiIp4DriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN UINTN NumberOfChildren, IN EFI_HANDLE *ChildHandleBuffer) |
EFI_STATUS EFIAPI | IScsiIp6DriverBindingSupported (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath) |
EFI_STATUS EFIAPI | IScsiIp6DriverBindingStart (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath) |
EFI_STATUS EFIAPI | IScsiIp6DriverBindingStop (IN EFI_DRIVER_BINDING_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN UINTN NumberOfChildren, IN EFI_HANDLE *ChildHandleBuffer) |
EFI_STATUS EFIAPI | IScsiComponentNameGetDriverName (IN EFI_COMPONENT_NAME_PROTOCOL *This, IN CHAR8 *Language, OUT CHAR16 **DriverName) |
EFI_STATUS EFIAPI | IScsiComponentNameGetControllerName (IN EFI_COMPONENT_NAME_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN EFI_HANDLE ChildHandle, IN CHAR8 *Language, OUT CHAR16 **ControllerName) |
EFI_STATUS EFIAPI | IScsiGetInitiatorName (IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This, IN OUT UINTN *BufferSize, OUT VOID *Buffer) |
EFI_STATUS EFIAPI | IScsiSetInitiatorName (IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL *This, IN OUT UINTN *BufferSize, IN VOID *Buffer) |
EFI_STATUS EFIAPI | IScsiGetAuthenticationInfo (IN EFI_AUTHENTICATION_INFO_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, OUT VOID **Buffer) |
EFI_STATUS EFIAPI | IScsiSetAuthenticationInfo (IN EFI_AUTHENTICATION_INFO_PROTOCOL *This, IN EFI_HANDLE ControllerHandle, IN VOID *Buffer) |
EFI_STATUS EFIAPI | IScsiExtScsiPassThruFunction (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN UINT8 *Target, IN UINT64 Lun, IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet, IN EFI_EVENT Event) |
EFI_STATUS EFIAPI | IScsiExtScsiPassThruGetNextTargetLun (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN OUT UINT8 **Target, IN OUT UINT64 *Lun) |
EFI_STATUS EFIAPI | IScsiExtScsiPassThruBuildDevicePath (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN UINT8 *Target, IN UINT64 Lun, IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath) |
EFI_STATUS EFIAPI | IScsiExtScsiPassThruGetTargetLun (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN EFI_DEVICE_PATH_PROTOCOL *DevicePath, OUT UINT8 **Target, OUT UINT64 *Lun) |
EFI_STATUS EFIAPI | IScsiExtScsiPassThruResetChannel (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This) |
EFI_STATUS EFIAPI | IScsiExtScsiPassThruResetTargetLun (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN UINT8 *Target, IN UINT64 Lun) |
EFI_STATUS EFIAPI | IScsiExtScsiPassThruGetNextTarget (IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This, IN OUT UINT8 **Target) |
Variables | |
EFI_COMPONENT_NAME2_PROTOCOL | gIScsiComponentName2 |
EFI_COMPONENT_NAME_PROTOCOL | gIScsiComponentName |
EFI_UNICODE_STRING_TABLE * | gIScsiControllerNameTable |
EFI_ISCSI_INITIATOR_NAME_PROTOCOL | gIScsiInitiatorName |
EFI_AUTHENTICATION_INFO_PROTOCOL | gIScsiAuthenticationInfo |
EFI_EXT_SCSI_PASS_THRU_PROTOCOL | gIScsiExtScsiPassThruProtocolTemplate |
EFI_GUID | gIScsiV4PrivateGuid |
EFI_GUID | gIScsiV6PrivateGuid |
ISCSI_PRIVATE_DATA * | mPrivate |
Copyright (c) 2004 - 2015, Intel Corporation. All rights reserved.
This program and the accompanying materials 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 http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define IP_MODE_AUTOCONFIG_IP4 3 |
Referenced by IScsiAsciiStrToIp(), IScsiGetConfigData(), and IScsiStart().
#define IP_MODE_AUTOCONFIG_IP6 4 |
Referenced by IScsiAsciiStrToIp(), IScsiCreateConnection(), IScsiGetConfigData(), and IScsiStart().
#define ISCSI_INITIATOR_NAME_VAR_NAME L"I_NAME" |
Referenced by IScsiGetInitiatorName(), and IScsiSetInitiatorName().
#define ISCSI_V4_PRIVATE_GUID |
Value:
{ \ 0xfa3cde4c, 0x87c2, 0x427d, { 0xae, 0xde, 0x7d, 0xd0, 0x96, 0xc8, 0x8c, 0x58 } \ }
#define ISCSI_V6_PRIVATE_GUID |
Value:
{ \ 0x28be27e5, 0x66cc, 0x4a31, { 0xa3, 0x15, 0xdb, 0x14, 0xc3, 0x74, 0x4d, 0x85 } \ }
typedef struct _ISCSI_PRIVATE_PROTOCOL ISCSI_PRIVATE_PROTOCOL |
EFI_STATUS EFIAPI IScsiComponentNameGetControllerName | ( | IN EFI_COMPONENT_NAME_PROTOCOL * | This, | |
IN EFI_HANDLE | ControllerHandle, | |||
IN EFI_HANDLE | ChildHandle, | |||
IN CHAR8 * | Language, | |||
OUT CHAR16 ** | ControllerName | |||
) |
Retrieves a Unicode string that is the user readable name of the controller that is being managed by a driver.
This function retrieves the user readable name of the controller specified by ControllerHandle and ChildHandle 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 controller name is returned in ControllerName, and EFI_SUCCESS is returned. If the driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle, then EFI_UNSUPPORTED is returned. If the driver specified by This does not support the language specified by Language, then EFI_UNSUPPORTED is returned.
[in] | This | A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance. |
[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. |
[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. |
[in] | Language | A pointer to a Null-terminated ASCII string array indicating the language. This is the language of the driver name 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 determined by the driver writer. Language is specified inRFC 4646 or ISO 639-2 language code format. |
[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. |
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. | |
EFI_INVALID_PARAMETER | ControllerHandle is NULL. | |
EFI_INVALID_PARAMETER | ChildHandle is not NULL and it is not a valid EFI_HANDLE. | |
EFI_INVALID_PARAMETER | Language is NULL. | |
EFI_INVALID_PARAMETER | ControllerName is NULL. | |
EFI_UNSUPPORTED | The driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle. | |
EFI_UNSUPPORTED | The driver specified by This does not support the language specified by Language. |
This function retrieves the user readable name of the controller specified by ControllerHandle and ChildHandle 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 controller name is returned in ControllerName, and EFI_SUCCESS is returned. If the driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle, then EFI_UNSUPPORTED is returned. If the driver specified by This does not support the language specified by Language, then EFI_UNSUPPORTED is returned.
[in] | This | A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance. |
[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. |
[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. |
[in] | Language | A pointer to a Null-terminated ASCII string array indicating the language. This is the language of the driver name 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. Language is specified in RFC 4646 or ISO 639-2 language code format. |
[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. |
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. | |
EFI_INVALID_PARAMETER | ControllerHandle is NULL. | |
EFI_INVALID_PARAMETER | ChildHandle is not NULL, and it is not a valid EFI_HANDLE. | |
EFI_INVALID_PARAMETER | Language is NULL. | |
EFI_INVALID_PARAMETER | ControllerName is NULL. | |
EFI_UNSUPPORTED | The driver specified by This is not currently managing the controller specified by ControllerHandle and ChildHandle. | |
EFI_UNSUPPORTED | The driver specified by This does not support the language specified by Language. |
References gIScsiComponentName, gIScsiControllerNameTable, gIScsiV4PrivateGuid, gIScsiV6PrivateGuid, and UpdateName().
EFI_STATUS EFIAPI IScsiComponentNameGetDriverName | ( | IN EFI_COMPONENT_NAME_PROTOCOL * | This, | |
IN CHAR8 * | Language, | |||
OUT CHAR16 ** | DriverName | |||
) |
Retrieves a Unicode string that is the user readable name of the 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.
[in] | This | A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or EFI_COMPONENT_NAME_PROTOCOL instance. |
[in] | Language | A pointer to a Null-terminated ASCII string array indicating the language. This is the language of the driver name 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. Language is specified in RFC 4646 or ISO 639-2 language code format. |
[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. |
EFI_SUCCESS | The Unicode string for the Driver specified by This and the language specified by Language was returned in DriverName. | |
EFI_INVALID_PARAMETER | Language is NULL. | |
EFI_INVALID_PARAMETER | DriverName is NULL. | |
EFI_UNSUPPORTED | The driver specified by This does not support the language specified by Language. |
References gIScsiComponentName, and mIScsiDriverNameTable.
EFI_STATUS EFIAPI IScsiExtScsiPassThruBuildDevicePath | ( | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL * | This, | |
IN UINT8 * | Target, | |||
IN UINT64 | Lun, | |||
IN OUT EFI_DEVICE_PATH_PROTOCOL ** | DevicePath | |||
) |
Allocate and build a device path node for a SCSI device on a SCSI channel.
[in] | This | Protocol instance pointer. |
[in] | Target | The Target ID of the SCSI device for which a device path node is to be allocated and built. |
[in] | Lun | The LUN of the SCSI device for which a device path node is to be allocated and built. |
[in,out] | DevicePath | A pointer to a single device path node that describes the SCSI device specified by Target and Lun. This function is responsible for allocating the buffer DevicePath with the boot service AllocatePool(). It is the caller's responsibility to free DevicePath when the caller is finished with DevicePath. |
EFI_SUCCESS | The device path node that describes the SCSI device specified by Target and Lun was allocated and returned in DevicePath. | |
EFI_NOT_FOUND | The SCSI devices specified by Target and Lun does not exist on the SCSI channel. | |
EFI_INVALID_PARAMETER | DevicePath is NULL. | |
EFI_OUT_OF_RESOURCES | There are not enough resources to allocate DevicePath. |
References _ISCSI_CHAP_AUTH_DATA::AuthConfig, _ISCSI_SESSION::AuthData, _ISCSI_SESSION::AuthType, _ISCSI_SESSION_CONFIG_NVDATA::BootLun, _ISCSI_SESSION::CHAP, _ISCSI_CHAP_AUTH_CONFIG_NVDATA::CHAPType, _ISCSI_SESSION::ConfigData, ISCSI_AUTH_TYPE_CHAP, ISCSI_AUTH_TYPE_NONE, ISCSI_CHAP_UNI, ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU, _ISCSI_DRIVER_DATA::Session, _ISCSI_ATTEMPT_CONFIG_NVDATA::SessionConfigData, _ISCSI_SESSION_CONFIG_NVDATA::TargetName, and _ISCSI_SESSION::TargetPortalGroupTag.
EFI_STATUS EFIAPI IScsiExtScsiPassThruFunction | ( | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL * | This, | |
IN UINT8 * | Target, | |||
IN UINT64 | Lun, | |||
IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET * | Packet, | |||
IN EFI_EVENT | Event | |||
) |
Sends a SCSI Request Packet to a SCSI device that is attached to the SCSI channel. This function supports both blocking I/O and nonblocking I/O. The blocking I/O functionality is required, and the nonblocking I/O functionality is optional.
[in] | This | A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. |
[in] | Target | The Target is an array of size TARGET_MAX_BYTES and it represents the id of the SCSI device to send the SCSI Request Packet. Each transport driver may choose to utilize a subset of this size to suit the needs of transport target representation. For example, a Fibre Channel driver may use only 8 bytes (WWN) to represent an FC target. |
[in] | Lun | The LUN of the SCSI device to send the SCSI Request Packet. |
[in,out] | Packet | A pointer to the SCSI Request Packet to send to the SCSI device specified by Target and Lun. |
[in] | Event | If nonblocking I/O is not supported then Event is ignored, and blocking I/O is performed. If Event is NULL, then blocking I/O is performed. If Event is not NULL and non blocking I/O is supported, then nonblocking I/O is performed, and Event will be signaled when the SCSI Request Packet completes. |
EFI_SUCCESS | The SCSI Request Packet was sent by the host. For bi-directional commands, InTransferLength bytes were transferred from InDataBuffer. For write and bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer. | |
EFI_BAD_BUFFER_SIZE | The SCSI Request Packet was not executed. The number of bytes that could be transferred is returned in InTransferLength. For write and bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer. | |
EFI_NOT_READY | The SCSI Request Packet could not be sent because there are too many SCSI Request Packets already queued. The caller may retry later. | |
EFI_DEVICE_ERROR | A device error occurred while attempting to send the SCSI Request Packet. | |
EFI_INVALID_PARAMETER | Target, Lun, or the contents of ScsiRequestPacket are invalid. | |
EFI_UNSUPPORTED | The command described by the SCSI Request Packet is not supported by the host adapter. This includes the case of Bi-directional SCSI commands not supported by the implementation. The SCSI Request Packet was not sent, so no additional status information is available. | |
EFI_TIMEOUT | A timeout occurred while waiting for the SCSI Request Packet to execute. |
[in] | This | A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. |
[in] | Target | The Target is an array of size TARGET_MAX_BYTES and it represents the id of the SCSI device to send the SCSI Request Packet. Each transport driver may choose to utilize a subset of this size to suit the needs of transport target representation. For example, a Fibre Channel driver may use only 8 bytes (WWN) to represent an FC target. |
[in] | Lun | The LUN of the SCSI device to send the SCSI Request Packet. |
[in,out] | Packet | A pointer to the SCSI Request Packet to send to the SCSI device specified by Target and Lun. |
[in] | Event | If nonblocking I/O is not supported then Event is ignored, and blocking I/O is performed. If Event is NULL, then blocking I/O is performed. If Event is not NULL and non blocking I/O is supported, then nonblocking I/O is performed, and Event will be signaled when the SCSI Request Packet completes. |
EFI_SUCCESS | The SCSI Request Packet was sent by the host. For bi-directional commands, InTransferLength bytes were transferred from InDataBuffer. For write and bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer. | |
EFI_BAD_BUFFER_SIZE | The SCSI Request Packet was not executed. The number of bytes that could be transferred is returned in InTransferLength. For write and bi-directional commands, OutTransferLength bytes were transferred by OutDataBuffer. | |
EFI_NOT_READY | The SCSI Request Packet could not be sent because there are too many SCSI Request Packets already queued. The caller may retry later. | |
EFI_DEVICE_ERROR | A device error occurred while attempting to send the SCSI Request Packet. | |
EFI_INVALID_PARAMETER | Target, Lun, or the contents of ScsiRequestPacket, are invalid. | |
EFI_UNSUPPORTED | The command described by the SCSI Request Packet is not supported by the host adapter. This includes the case of Bi-directional SCSI commands not supported by the implementation. The SCSI Request Packet was not sent, so no additional status information is available. | |
EFI_TIMEOUT | A timeout occurred while waiting for the SCSI Request Packet to execute. |
References ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU, IScsiExecuteScsiCommand(), IScsiSessionReinstatement(), and _ISCSI_DRIVER_DATA::Session.
EFI_STATUS EFIAPI IScsiExtScsiPassThruGetNextTarget | ( | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL * | This, | |
IN OUT UINT8 ** | Target | |||
) |
Retrieve the list of legal Target IDs for SCSI devices on a SCSI channel.
[in] | This | A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. |
[in,out] | Target | (TARGET_MAX_BYTES) of a SCSI device present on the SCSI channel. On output, a pointer to the Target ID (an array of TARGET_MAX_BYTES) of the next SCSI device present on a SCSI channel. An input value of 0xF(all bytes in the array are 0xF) in the Target array retrieves the Target ID of the first SCSI device present on a SCSI channel. |
EFI_SUCCESS | The Target ID of the next SCSI device on the SCSI channel was returned in Target. | |
EFI_INVALID_PARAMETER | Target or Lun is NULL. | |
EFI_TIMEOUT | Target array is not all 0xF, and Target was not returned on a previous call to GetNextTarget(). | |
EFI_NOT_FOUND | There are no more SCSI devices on this SCSI channel. |
EFI_STATUS EFIAPI IScsiExtScsiPassThruGetNextTargetLun | ( | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL * | This, | |
IN OUT UINT8 ** | Target, | |||
IN OUT UINT64 * | Lun | |||
) |
Used to retrieve the list of legal Target IDs and LUNs for SCSI devices on a SCSI channel. These can either be the list SCSI devices that are actually present on the SCSI channel, or the list of legal Target Ids and LUNs for the SCSI channel. Regardless, the caller of this function must probe the Target ID and LUN returned to see if a SCSI device is actually present at that location on the SCSI channel.
[in] | This | The EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. |
[in,out] | Target | On input, a pointer to the Target ID of a SCSI device present on the SCSI channel. On output, a pointer to the Target ID of the next SCSI device present on a SCSI channel. An input value of 0xFFFFFFFF retrieves the Target ID of the first SCSI device present on a SCSI channel. |
[in,out] | Lun | On input, a pointer to the LUN of a SCSI device present on the SCSI channel. On output, a pointer to the LUN of the next SCSI device present on a SCSI channel. |
EFI_SUCCESS | The Target ID and Lun of the next SCSI device on the SCSI channel was returned in Target and Lun. | |
EFI_NOT_FOUND | There are no more SCSI devices on this SCSI channel. | |
EFI_INVALID_PARAMETER | Target is not 0xFFFFFFFF,and Target and Lun were not returned on a previous call to GetNextDevice(). |
[in] | This | The EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance. |
[in,out] | Target | On input, a pointer to the Target ID of a SCSI device present on the SCSI channel. On output, a pointer to the Target ID of the next SCSI device present on a SCSI channel. An input value of 0xFFFFFFFF retrieves the Target ID of the first SCSI device present on a SCSI channel. |
[in,out] | Lun | On input, a pointer to the LUN of a SCSI device present on the SCSI channel. On output, a pointer to the LUN of the next SCSI device present on a SCSI channel. |
EFI_SUCCESS | The Target ID and Lun of the next SCSI device on the SCSI channel was returned in Target and Lun. | |
EFI_NOT_FOUND | There are no more SCSI devices on this SCSI channel. | |
EFI_INVALID_PARAMETER | Target is not 0xFFFFFFFF,and Target and Lun were not returned on a previous call to GetNextDevice(). |
References _ISCSI_SESSION_CONFIG_NVDATA::BootLun, _ISCSI_SESSION::ConfigData, ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU, _ISCSI_DRIVER_DATA::Session, and _ISCSI_ATTEMPT_CONFIG_NVDATA::SessionConfigData.
EFI_STATUS EFIAPI IScsiExtScsiPassThruGetTargetLun | ( | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL * | This, | |
IN EFI_DEVICE_PATH_PROTOCOL * | DevicePath, | |||
OUT UINT8 ** | Target, | |||
OUT UINT64 * | Lun | |||
) |
Translate a device path node to a Target ID and LUN.
[in] | This | Protocol instance pointer. |
[in] | DevicePath | A pointer to the device path node that describes a SCSI device on the SCSI channel. |
[out] | Target | A pointer to the Target ID of a SCSI device on the SCSI channel. |
[out] | Lun | A pointer to the LUN of a SCSI device on the SCSI channel. |
EFI_SUCCESS | DevicePath was successfully translated to a Target ID and LUN, and they were returned in Target and Lun. | |
EFI_INVALID_PARAMETER | DevicePath/Target/Lun is NULL. | |
EFI_UNSUPPORTED | This driver does not support the device path node type in DevicePath. | |
EFI_NOT_FOUND | A valid translation from DevicePath to a Target ID and LUN does not exist. |
[in] | This | Protocol instance pointer. |
[in] | DevicePath | A pointer to the device path node that describes a SCSI device on the SCSI channel. |
[out] | Target | A pointer to the Target ID of a SCSI device on the SCSI channel. |
[out] | Lun | A pointer to the LUN of a SCSI device on the SCSI channel. |
EFI_SUCCESS | DevicePath was successfully translated to a Target ID and LUN, and they were returned in Target and Lun. | |
EFI_INVALID_PARAMETER | DevicePath/Target/Lun is NULL. | |
EFI_UNSUPPORTED | This driver does not support the device path node type in DevicePath. | |
EFI_NOT_FOUND | A valid translation does not exist from DevicePath to a TargetID and LUN. |
References _ISCSI_SESSION_CONFIG_NVDATA::BootLun, _ISCSI_SESSION::ConfigData, ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU, _ISCSI_DRIVER_DATA::Session, _ISCSI_ATTEMPT_CONFIG_NVDATA::SessionConfigData, and _ISCSI_SESSION_CONFIG_NVDATA::TargetName.
EFI_STATUS EFIAPI IScsiExtScsiPassThruResetChannel | ( | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL * | This | ) |
Resets a SCSI channel.This operation resets all the SCSI devices connected to the SCSI channel.
[in] | This | Protocol instance pointer. |
EFI_UNSUPPORTED | It is not supported. |
[in] | This | Protocol instance pointer. |
EFI_UNSUPPORTED | It is not supported. |
EFI_STATUS EFIAPI IScsiExtScsiPassThruResetTargetLun | ( | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL * | This, | |
IN UINT8 * | Target, | |||
IN UINT64 | Lun | |||
) |
Resets a SCSI device that is connected to a SCSI channel.
[in] | This | Protocol instance pointer. |
[in] | Target | The Target ID of the SCSI device to reset. |
[in] | Lun | The LUN of the SCSI device to reset. |
EFI_UNSUPPORTED | It is not supported. |
EFI_STATUS EFIAPI IScsiGetAuthenticationInfo | ( | IN EFI_AUTHENTICATION_INFO_PROTOCOL * | This, | |
IN EFI_HANDLE | ControllerHandle, | |||
OUT VOID ** | Buffer | |||
) |
Retrieves the authentication information associated with a particular controller handle.
[in] | This | Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL. |
[in] | ControllerHandle | Handle to the Controller. |
[out] | Buffer | Pointer to the authentication information. This function is responsible for allocating the buffer and it is the caller's responsibility to free buffer when the caller is finished with buffer. |
EFI_DEVICE_ERROR | The authentication information could not be retrieved due to a hardware error. |
EFI_STATUS EFIAPI IScsiGetInitiatorName | ( | IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL * | This, | |
IN OUT UINTN * | BufferSize, | |||
OUT VOID * | Buffer | |||
) |
Retrieves the current set value of iSCSI Initiator Name.
[in] | This | Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance. |
[in,out] | BufferSize | Size of the buffer in bytes pointed to by Buffer / Actual size of the variable data buffer. |
[out] | Buffer | Pointer to the buffer for data to be read. |
EFI_SUCCESS | Data was successfully retrieved into the provided buffer and the BufferSize was sufficient to handle the iSCSI initiator name. | |
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. | |
EFI_INVALID_PARAMETER | BufferSize is NULL. BufferSize and Buffer will not be affected. | |
EFI_INVALID_PARAMETER | Buffer is NULL. BufferSize and Buffer will not be affected. | |
EFI_DEVICE_ERROR | The iSCSI initiator name could not be retrieved due to a hardware error. |
[in] | This | Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance. |
[in,out] | BufferSize | Size of the buffer in bytes pointed to by Buffer / Actual size of the variable data buffer. |
[out] | Buffer | Pointer to the buffer for data to be read. The data is a null-terminated UTF-8 encoded string. The maximum length is 223 characters, including the null-terminator. |
EFI_SUCCESS | Data was successfully retrieved into the provided buffer and the BufferSize was sufficient to handle the iSCSI initiator name. | |
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. | |
EFI_INVALID_PARAMETER | BufferSize is NULL. BufferSize and Buffer will not be affected. | |
EFI_INVALID_PARAMETER | Buffer is NULL. BufferSize and Buffer will not be affected. | |
EFI_DEVICE_ERROR | The iSCSI initiator name could not be retrieved due to a hardware error. |
References ISCSI_INITIATOR_NAME_VAR_NAME.
EFI_STATUS EFIAPI IScsiIp4DriverBindingStart | ( | IN EFI_DRIVER_BINDING_PROTOCOL * | This, | |
IN EFI_HANDLE | ControllerHandle, | |||
IN EFI_DEVICE_PATH_PROTOCOL * | RemainingDevicePath | |||
) |
Starts a device controller or a bus controller.
The Start() function is designed to be 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 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. 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned EFI_DEVICE_PATH_PROTOCOL. 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.
[in] | This | A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. |
[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. |
[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. For a bus driver, if this parameter is NULL, then handles for all the children of Controller are created by this driver. If this parameter is not NULL and the first Device Path Node is not the End of Device Path Node, then only the handle for the child device specified by the first Device Path Node of RemainingDevicePath is created by this driver. If the first Device Path Node of RemainingDevicePath is the End of Device Path Node, no child handle is created by this driver. |
EFI_SUCCESS | The device was started. | |
EFI_DEVICE_ERROR | The device could not be started due to a device error. Currently not implemented. | |
EFI_OUT_OF_RESOURCES | The request could not be completed due to a lack of resources. | |
Others | The driver failed to start the device. |
References IScsiStart().
EFI_STATUS EFIAPI IScsiIp4DriverBindingStop | ( | IN EFI_DRIVER_BINDING_PROTOCOL * | This, | |
IN EFI_HANDLE | ControllerHandle, | |||
IN UINTN | NumberOfChildren, | |||
IN EFI_HANDLE * | ChildHandleBuffer | |||
) |
Stops a device controller or a bus controller.
The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). As a result, much of the error checking on the parameters to Stop() has been moved into this common boot service. It is legal to call Stop() 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 that was used on a previous call to this same driver's Start() function. 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid EFI_HANDLE. In addition, all of these handles must have been created in this driver's Start() function, and the Start() function must have called OpenProtocol() on ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
[in] | This | A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. |
[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. |
[in] | NumberOfChildren | The number of child device handles in ChildHandleBuffer. |
[in] | ChildHandleBuffer | An array of child handles to be freed. May be NULL if NumberOfChildren is 0. |
EFI_SUCCESS | The device was stopped. | |
EFI_DEVICE_ERROR | The device could not be stopped due to a device error. |
References IScsiStop().
EFI_STATUS EFIAPI IScsiIp4DriverBindingSupported | ( | IN EFI_DRIVER_BINDING_PROTOCOL * | This, | |
IN EFI_HANDLE | ControllerHandle, | |||
IN EFI_DEVICE_PATH_PROTOCOL * | RemainingDevicePath | |||
) |
Tests to see if this driver supports a given controller. If a child device is provided, it tests to see if this driver supports creating a handle for the specified child device.
This function checks to see if the driver specified by This supports the device specified by ControllerHandle. Drivers typically use the device path attached to ControllerHandle and/or the services from the bus I/O abstraction attached to ControllerHandle to determine if the driver supports ControllerHandle. This function may be called many times during platform initialization. In order to reduce boot times, the tests performed by this function must be very small and take as little time as possible to execute. This function must not change the state of any hardware devices, and this function must be aware that the device specified by ControllerHandle may already be managed by the same driver or a different driver. This function must match its calls to AllocatePages() with FreePages(), AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). Since ControllerHandle may have been previously started by the same driver, if a protocol is already in the opened state, then it must not be closed with CloseProtocol(). This is required to guarantee the state of ControllerHandle is not modified by this function.
[in] | This | A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. |
[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. |
[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. For bus drivers, if this parameter is not NULL, then the bus driver must determine if the bus controller specified by ControllerHandle and the child controller specified by RemainingDevicePath are both supported by this bus driver. |
EFI_SUCCESS | The device specified by ControllerHandle and RemainingDevicePath is supported by the driver specified by This. | |
EFI_ALREADY_STARTED | The device specified by ControllerHandle and RemainingDevicePath is already managed by the driver specified by This. | |
EFI_ACCESS_DENIED | The device specified by ControllerHandle and RemainingDevicePath is already managed by a different driver or an application that requires exclusive access. Currently not implemented. | |
EFI_UNSUPPORTED | The device specified by ControllerHandle and RemainingDevicePath is not supported by the driver specified by This. |
References IScsiSupported().
EFI_STATUS EFIAPI IScsiIp6DriverBindingStart | ( | IN EFI_DRIVER_BINDING_PROTOCOL * | This, | |
IN EFI_HANDLE | ControllerHandle, | |||
IN EFI_DEVICE_PATH_PROTOCOL * | RemainingDevicePath | |||
) |
Starts a device controller or a bus controller.
The Start() function is designed to be 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 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. 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned EFI_DEVICE_PATH_PROTOCOL. 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.
[in] | This | A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. |
[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. |
[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. For a bus driver, if this parameter is NULL, then handles for all the children of Controller are created by this driver. If this parameter is not NULL and the first Device Path Node is not the End of Device Path Node, then only the handle for the child device specified by the first Device Path Node of RemainingDevicePath is created by this driver. If the first Device Path Node of RemainingDevicePath is the End of Device Path Node, no child handle is created by this driver. |
EFI_SUCCESS | The device was started. | |
EFI_DEVICE_ERROR | The device could not be started due to a device error. Currently not implemented. | |
EFI_OUT_OF_RESOURCES | The request could not be completed due to a lack of resources. | |
Others | The driver failed to start the device. |
References IScsiStart().
EFI_STATUS EFIAPI IScsiIp6DriverBindingStop | ( | IN EFI_DRIVER_BINDING_PROTOCOL * | This, | |
IN EFI_HANDLE | ControllerHandle, | |||
IN UINTN | NumberOfChildren, | |||
IN EFI_HANDLE * | ChildHandleBuffer | |||
) |
Stops a device controller or a bus controller.
The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). As a result, much of the error checking on the parameters to Stop() has been moved into this common boot service. It is legal to call Stop() 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 that was used on a previous call to this same driver's Start() function. 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid EFI_HANDLE. In addition, all of these handles must have been created in this driver's Start() function, and the Start() function must have called OpenProtocol() on ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
[in] | This | A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. |
[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. |
[in] | NumberOfChildren | The number of child device handles in ChildHandleBuffer. |
[in] | ChildHandleBuffer | An array of child handles to be freed. May be NULL if NumberOfChildren is 0. |
EFI_SUCCESS | The device was stopped. | |
EFI_DEVICE_ERROR | The device could not be stopped due to a device error. |
References IScsiStop().
EFI_STATUS EFIAPI IScsiIp6DriverBindingSupported | ( | IN EFI_DRIVER_BINDING_PROTOCOL * | This, | |
IN EFI_HANDLE | ControllerHandle, | |||
IN EFI_DEVICE_PATH_PROTOCOL * | RemainingDevicePath | |||
) |
Tests to see if this driver supports a given controller. If a child device is provided, it tests to see if this driver supports creating a handle for the specified child device.
This function checks to see if the driver specified by This supports the device specified by ControllerHandle. Drivers typically use the device path attached to ControllerHandle and/or the services from the bus I/O abstraction attached to ControllerHandle to determine if the driver supports ControllerHandle. This function may be called many times during platform initialization. In order to reduce boot times, the tests performed by this function must be very small and take as little time as possible to execute. This function must not change the state of any hardware devices, and this function must be aware that the device specified by ControllerHandle may already be managed by the same driver or a different driver. This function must match its calls to AllocatePages() with FreePages(), AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). Since ControllerHandle may have been previously started by the same driver, if a protocol is already in the opened state, then it must not be closed with CloseProtocol(). This is required to guarantee the state of ControllerHandle is not modified by this function.
[in] | This | A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. |
[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. |
[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. For bus drivers, if this parameter is not NULL, then the bus driver must determine if the bus controller specified by ControllerHandle and the child controller specified by RemainingDevicePath are both supported by this bus driver. |
EFI_SUCCESS | The device specified by ControllerHandle and RemainingDevicePath is supported by the driver specified by This. | |
EFI_ALREADY_STARTED | The device specified by ControllerHandle and RemainingDevicePath is already managed by the driver specified by This. | |
EFI_ACCESS_DENIED | The device specified by ControllerHandle and RemainingDevicePath is already managed by a different driver or an application that requires exclusive access. Currently not implemented. | |
EFI_UNSUPPORTED | The device specified by ControllerHandle and RemainingDevicePath is not supported by the driver specified by This. |
References IScsiSupported().
EFI_STATUS EFIAPI IScsiSetAuthenticationInfo | ( | IN EFI_AUTHENTICATION_INFO_PROTOCOL * | This, | |
IN EFI_HANDLE | ControllerHandle, | |||
IN VOID * | Buffer | |||
) |
Set the authentication information for a given controller handle.
[in] | This | Pointer to the EFI_AUTHENTICATION_INFO_PROTOCOL. |
[in] | ControllerHandle | Handle to the Controller. |
[in] | Buffer | Pointer to the authentication information. |
EFI_UNSUPPORTED | If the platform policies do not allow setting of the authentication information. |
EFI_STATUS EFIAPI IScsiSetInitiatorName | ( | IN EFI_ISCSI_INITIATOR_NAME_PROTOCOL * | This, | |
IN OUT UINTN * | BufferSize, | |||
IN VOID * | Buffer | |||
) |
Sets the iSSI Initiator Name.
[in] | This | Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance. |
[in,out] | BufferSize | Size of the buffer in bytes pointed to by Buffer. |
[in] | Buffer | Pointer to the buffer for data to be written. |
EFI_SUCCESS | Data was successfully stored by the protocol. | |
EFI_UNSUPPORTED | Platform policies do not allow for data to be written. | |
EFI_INVALID_PARAMETER | BufferSize exceeds the maximum allowed limit. BufferSize will be updated with the maximum size required to complete the request. | |
EFI_INVALID_PARAMETER | Buffersize is NULL. BufferSize and Buffer will not be affected. | |
EFI_INVALID_PARAMETER | Buffer is NULL. BufferSize and Buffer will not be affected. | |
EFI_DEVICE_ERROR | The data could not be stored due to a hardware error. | |
EFI_OUT_OF_RESOURCES | Not enough storage is available to hold the data | |
EFI_PROTOCOL_ERROR | Input iSCSI initiator name does not adhere to RFC 3720 |
[in] | This | Pointer to the EFI_ISCSI_INITIATOR_NAME_PROTOCOL instance. |
[in,out] | BufferSize | Size of the buffer in bytes pointed to by Buffer. |
[in] | Buffer | Pointer to the buffer for data to be written. The data is a null-terminated UTF-8 encoded string. The maximum length is 223 characters, including the null-terminator. |
EFI_SUCCESS | Data was successfully stored by the protocol. | |
EFI_UNSUPPORTED | Platform policies do not allow for data to be written. | |
EFI_INVALID_PARAMETER | BufferSize exceeds the maximum allowed limit. BufferSize will be updated with the maximum size required to complete the request. | |
EFI_INVALID_PARAMETER | Buffersize is NULL. BufferSize and Buffer will not be affected. | |
EFI_INVALID_PARAMETER | Buffer is NULL. BufferSize and Buffer will not be affected. | |
EFI_DEVICE_ERROR | The data could not be stored due to a hardware error. | |
EFI_OUT_OF_RESOURCES | Not enough storage is available to hold the data | |
EFI_PROTOCOL_ERROR | Input iSCSI initiator name does not adhere to RFC 3720 |
References ISCSI_INITIATOR_NAME_VAR_NAME, ISCSI_NAME_MAX_SIZE, and IScsiNormalizeName().
EFI_AUTHENTICATION_INFO_PROTOCOL gIScsiAuthenticationInfo |
Referenced by IScsiDriverEntryPoint(), and IScsiUnload().
EFI_COMPONENT_NAME_PROTOCOL gIScsiComponentName |
EFI_COMPONENT_NAME2_PROTOCOL gIScsiComponentName2 |
Referenced by IScsiDriverEntryPoint(), and UpdateName().
EFI_UNICODE_STRING_TABLE* gIScsiControllerNameTable |
Referenced by IScsiComponentNameGetControllerName(), IScsiUnload(), and UpdateName().
EFI_EXT_SCSI_PASS_THRU_PROTOCOL gIScsiExtScsiPassThruProtocolTemplate |
Referenced by IScsiCreateDriverData().
EFI_ISCSI_INITIATOR_NAME_PROTOCOL gIScsiInitiatorName |
Referenced by IScsiDriverEntryPoint(), IScsiFormCallback(), IScsiFormExtractConfig(), IScsiGetConfigData(), and IScsiUnload().
EFI_GUID gIScsiV4PrivateGuid |
Referenced by IScsiComponentNameGetControllerName(), IScsiStart(), IScsiStop(), and IScsiSupported().
EFI_GUID gIScsiV6PrivateGuid |
Referenced by IScsiComponentNameGetControllerName(), IScsiStart(), IScsiStop(), and IScsiSupported().
Referenced by IScsiAddNic(), IScsiCHAPToSendReq(), IScsiCleanDriverData(), IScsiConfigAddAttempt(), IScsiConfigDeleteAttempts(), IScsiConfigDisplayDeleteAttempts(), IScsiConfigDisplayOrderAttempts(), IScsiConfigFormUnload(), IScsiConfigGetAttemptByConfigIndex(), IScsiConfigGetAttemptByNic(), IScsiConfigOrderAttempts(), IScsiConfigProcessDefault(), IScsiConfigUpdateAttempt(), IScsiConvertIfrNvDataToAttemptConfigData(), IScsiFillInitiatorSection(), IScsiFillNICAndTargetSections(), IScsiFormCallback(), IScsiGetConfigData(), IScsiGetNicInfoByIndex(), IScsiInitControlSection(), IScsiPublishIbft(), and IScsiRemoveNic().