123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414 |
- /** @file
- The implementation of EFI_EXT_SCSI_PASS_THRU_PROTOCOL.
- Copyright (c) 2004 - 2018, Intel Corporation. All rights reserved.<BR>
- SPDX-License-Identifier: BSD-2-Clause-Patent
- **/
- #include "IScsiImpl.h"
- EFI_EXT_SCSI_PASS_THRU_PROTOCOL gIScsiExtScsiPassThruProtocolTemplate = {
- NULL,
- IScsiExtScsiPassThruFunction,
- IScsiExtScsiPassThruGetNextTargetLun,
- IScsiExtScsiPassThruBuildDevicePath,
- IScsiExtScsiPassThruGetTargetLun,
- IScsiExtScsiPassThruResetChannel,
- IScsiExtScsiPassThruResetTargetLun,
- IScsiExtScsiPassThruGetNextTarget
- };
- /**
- 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.
- @param[in] This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
- @param[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.
- @param[in] Lun The LUN of the SCSI device to send the SCSI Request Packet.
- @param[in, out] Packet A pointer to the SCSI Request Packet to send to the
- SCSI device specified by Target and Lun.
- @param[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.
- @retval 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.
- @retval 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.
- @retval 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.
- @retval EFI_DEVICE_ERROR A device error occurred while attempting to send
- the SCSI Request Packet.
- @retval EFI_INVALID_PARAMETER Target, Lun, or the contents of ScsiRequestPacket,
- are invalid.
- @retval 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.
- @retval EFI_TIMEOUT A timeout occurred while waiting for the SCSI
- Request Packet to execute.
- **/
- 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 OPTIONAL
- )
- {
- EFI_STATUS Status;
- ISCSI_DRIVER_DATA *Private;
- if (Target[0] != 0) {
- return EFI_INVALID_PARAMETER;
- }
- if ((Packet == NULL) || (Packet->Cdb == NULL)) {
- return EFI_INVALID_PARAMETER;
- }
- Status = IScsiExecuteScsiCommand (This, Target, Lun, Packet);
- if ((Status != EFI_SUCCESS) && (Status != EFI_NOT_READY)) {
- //
- // Try to reinstate the session and re-execute the Scsi command.
- //
- Private = ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (This);
- if (EFI_ERROR (IScsiSessionReinstatement (Private->Session))) {
- return EFI_DEVICE_ERROR;
- }
- Status = IScsiExecuteScsiCommand (This, Target, Lun, Packet);
- }
- return Status;
- }
- /**
- 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.
- @param[in] This The EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
- @param[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.
- @param[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.
- @retval EFI_SUCCESS The Target ID and Lun of the next SCSI device on
- the SCSI channel was returned in Target and Lun.
- @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI
- channel.
- @retval EFI_INVALID_PARAMETER Target is not 0xFFFFFFFF,and Target and Lun were
- not returned on a previous call to
- GetNextDevice().
- **/
- EFI_STATUS
- EFIAPI
- IScsiExtScsiPassThruGetNextTargetLun (
- IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
- IN OUT UINT8 **Target,
- IN OUT UINT64 *Lun
- )
- {
- ISCSI_DRIVER_DATA *Private;
- ISCSI_SESSION_CONFIG_NVDATA *ConfigNvData;
- UINT8 TargetId[TARGET_MAX_BYTES];
- Private = ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (This);
- ConfigNvData = &Private->Session->ConfigData->SessionConfigData;
- if (((*Target)[0] == 0) && (CompareMem (Lun, ConfigNvData->BootLun, sizeof (UINT64)) == 0)) {
- //
- // Only one <Target, Lun> pair per iSCSI Driver instance.
- //
- return EFI_NOT_FOUND;
- }
- SetMem (TargetId, TARGET_MAX_BYTES, 0xFF);
- if (CompareMem (*Target, TargetId, TARGET_MAX_BYTES) == 0) {
- (*Target)[0] = 0;
- CopyMem (Lun, ConfigNvData->BootLun, sizeof (UINT64));
- return EFI_SUCCESS;
- }
- return EFI_INVALID_PARAMETER;
- }
- /**
- Allocate and build a device path node for a SCSI device on a SCSI channel.
- @param[in] This Protocol instance pointer.
- @param[in] Target The Target ID of the SCSI device for which a
- device path node is to be allocated and built.
- @param[in] Lun The LUN of the SCSI device for which a device
- path node is to be allocated and built.
- @param[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.
- @retval EFI_SUCCESS The device path node that describes the SCSI
- device specified by Target and Lun was allocated
- and returned in DevicePath.
- @retval EFI_NOT_FOUND The SCSI devices specified by Target and Lun does
- not exist on the SCSI channel.
- @retval EFI_INVALID_PARAMETER DevicePath is NULL.
- @retval EFI_OUT_OF_RESOURCES There are not enough resources to allocate
- DevicePath.
- **/
- 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
- )
- {
- ISCSI_DRIVER_DATA *Private;
- ISCSI_SESSION *Session;
- ISCSI_SESSION_CONFIG_NVDATA *ConfigNvData;
- ISCSI_CHAP_AUTH_CONFIG_NVDATA *AuthConfig;
- EFI_DEV_PATH *Node;
- UINTN DevPathNodeLen;
- if (DevicePath == NULL) {
- return EFI_INVALID_PARAMETER;
- }
- if (Target[0] != 0) {
- return EFI_NOT_FOUND;
- }
- Private = ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (This);
- Session = Private->Session;
- ConfigNvData = &Session->ConfigData->SessionConfigData;
- AuthConfig = Session->AuthData.CHAP.AuthConfig;
- if (CompareMem (&Lun, ConfigNvData->BootLun, sizeof (UINT64)) != 0) {
- return EFI_NOT_FOUND;
- }
- DevPathNodeLen = sizeof (ISCSI_DEVICE_PATH) + AsciiStrLen (ConfigNvData->TargetName) + 1;
- Node = AllocateZeroPool (DevPathNodeLen);
- if (Node == NULL) {
- return EFI_OUT_OF_RESOURCES;
- }
- Node->DevPath.Type = MESSAGING_DEVICE_PATH;
- Node->DevPath.SubType = MSG_ISCSI_DP;
- SetDevicePathNodeLength (&Node->DevPath, DevPathNodeLen);
- //
- // 0 for TCP, others are reserved.
- //
- Node->Iscsi.NetworkProtocol = 0;
- Node->Iscsi.LoginOption = 0;
- switch (Session->AuthType) {
- case ISCSI_AUTH_TYPE_NONE:
- Node->Iscsi.LoginOption |= 0x0800;
- break;
- case ISCSI_AUTH_TYPE_CHAP:
- //
- // Bit12: 0=CHAP_BI, 1=CHAP_UNI
- //
- if (AuthConfig->CHAPType == ISCSI_CHAP_UNI) {
- Node->Iscsi.LoginOption |= 0x1000;
- }
- break;
- default:
- break;
- }
- CopyMem (&Node->Iscsi.Lun, ConfigNvData->BootLun, sizeof (UINT64));
- Node->Iscsi.TargetPortalGroupTag = Session->TargetPortalGroupTag;
- AsciiStrCpyS ((CHAR8 *)Node + sizeof (ISCSI_DEVICE_PATH), AsciiStrLen (ConfigNvData->TargetName) + 1, ConfigNvData->TargetName);
- *DevicePath = (EFI_DEVICE_PATH_PROTOCOL *)Node;
- return EFI_SUCCESS;
- }
- /**
- Translate a device path node to a Target ID and LUN.
- @param[in] This Protocol instance pointer.
- @param[in] DevicePath A pointer to the device path node that describes
- a SCSI device on the SCSI channel.
- @param[out] Target A pointer to the Target ID of a SCSI device on
- the SCSI channel.
- @param[out] Lun A pointer to the LUN of a SCSI device on the SCSI
- channel.
- @retval EFI_SUCCESS DevicePath was successfully translated to a
- Target ID and LUN, and they were returned in
- Target and Lun.
- @retval EFI_INVALID_PARAMETER DevicePath/Target/Lun is NULL.
- @retval EFI_UNSUPPORTED This driver does not support the device path node
- type in DevicePath.
- @retval EFI_NOT_FOUND A valid translation does not exist from DevicePath
- to a TargetID and LUN.
- **/
- EFI_STATUS
- EFIAPI
- IScsiExtScsiPassThruGetTargetLun (
- IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
- IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,
- OUT UINT8 **Target,
- OUT UINT64 *Lun
- )
- {
- ISCSI_DRIVER_DATA *Private;
- ISCSI_SESSION_CONFIG_NVDATA *ConfigNvData;
- if ((DevicePath == NULL) || (Target == NULL) || (Lun == NULL)) {
- return EFI_INVALID_PARAMETER;
- }
- if ((DevicePath->Type != MESSAGING_DEVICE_PATH) ||
- (DevicePath->SubType != MSG_ISCSI_DP) ||
- (DevicePathNodeLength (DevicePath) <= sizeof (ISCSI_DEVICE_PATH))
- )
- {
- return EFI_UNSUPPORTED;
- }
- Private = ISCSI_DRIVER_DATA_FROM_EXT_SCSI_PASS_THRU (This);
- ConfigNvData = &Private->Session->ConfigData->SessionConfigData;
- SetMem (*Target, TARGET_MAX_BYTES, 0xFF);
- (*Target)[0] = 0;
- if (AsciiStrCmp (ConfigNvData->TargetName, (CHAR8 *)DevicePath + sizeof (ISCSI_DEVICE_PATH)) != 0) {
- return EFI_UNSUPPORTED;
- }
- CopyMem (Lun, ConfigNvData->BootLun, sizeof (UINT64));
- return EFI_SUCCESS;
- }
- /**
- Resets a SCSI channel. This operation resets all the SCSI devices connected to
- the SCSI channel.
- @param[in] This Protocol instance pointer.
- @retval EFI_UNSUPPORTED It is not supported.
- **/
- EFI_STATUS
- EFIAPI
- IScsiExtScsiPassThruResetChannel (
- IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This
- )
- {
- return EFI_UNSUPPORTED;
- }
- /**
- Resets a SCSI device that is connected to a SCSI channel.
- @param[in] This Protocol instance pointer.
- @param[in] Target The Target ID of the SCSI device to reset.
- @param[in] Lun The LUN of the SCSI device to reset.
- @retval EFI_UNSUPPORTED It is not supported.
- **/
- EFI_STATUS
- EFIAPI
- IScsiExtScsiPassThruResetTargetLun (
- IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
- IN UINT8 *Target,
- IN UINT64 Lun
- )
- {
- return EFI_UNSUPPORTED;
- }
- /**
- Retrieve the list of legal Target IDs for SCSI devices on a SCSI channel.
- @param[in] This A pointer to the EFI_EXT_SCSI_PASS_THRU_PROTOCOL
- instance.
- @param[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.
- @retval EFI_SUCCESS The Target ID of the next SCSI device on the SCSI
- channel was returned in Target.
- @retval EFI_INVALID_PARAMETER Target or Lun is NULL.
- @retval EFI_TIMEOUT Target array is not all 0xF, and Target was not
- returned on a previous call to GetNextTarget().
- @retval EFI_NOT_FOUND There are no more SCSI devices on this SCSI channel.
- **/
- EFI_STATUS
- EFIAPI
- IScsiExtScsiPassThruGetNextTarget (
- IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,
- IN OUT UINT8 **Target
- )
- {
- UINT8 TargetId[TARGET_MAX_BYTES];
- SetMem (TargetId, TARGET_MAX_BYTES, 0xFF);
- if (CompareMem (*Target, TargetId, TARGET_MAX_BYTES) == 0) {
- (*Target)[0] = 0;
- return EFI_SUCCESS;
- } else if ((*Target)[0] == 0) {
- return EFI_NOT_FOUND;
- } else {
- return EFI_INVALID_PARAMETER;
- }
- }
|