/** @file
SCSI Bus driver that layers on every SCSI Pass Thru and
Extended SCSI Pass Thru protocol in the system.
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
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
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "ScsiBus.h"
0xa,
NULL,
};
/**
Convert EFI_SCSI_IO_SCSI_REQUEST_PACKET packet to EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET packet.
@param Packet The pointer of EFI_SCSI_IO_SCSI_REQUEST_PACKET
@param CommandPacket The pointer of EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
**/
);
/**
Convert EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET packet to EFI_SCSI_IO_SCSI_REQUEST_PACKET packet.
@param ScsiPacket The pointer of EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
@param Packet The pointer of EFI_SCSI_IO_SCSI_REQUEST_PACKET
**/
);
/**
Notify Function in which convert EFI1.0 PassThru Packet back to UEF2.0
SCSI IO Packet.
@param Event The instance of EFI_EVENT.
@param Context The parameter passed in.
**/
);
/**
Allocates an aligned buffer for SCSI device.
This function allocates an aligned buffer for the SCSI device to perform
SCSI pass through operations. The alignment requirement is from SCSI pass
through interface.
@param ScsiIoDevice The SCSI child device involved for the operation.
@param BufferSize The request buffer size.
@return A pointer to the aligned buffer or NULL if the allocation fails.
**/
VOID *
)
{
}
/**
Frees an aligned buffer for SCSI device.
This function frees an aligned buffer for the SCSI device to perform
SCSI pass through operations.
@param Buffer The aligned buffer to be freed.
@param BufferSize The request buffer size.
**/
)
{
}
}
/**
The user Entry Point for module ScsiBus. The user code starts with this function.
@param ImageHandle The firmware allocated handle for the EFI image.
@param SystemTable A pointer to the EFI System Table.
@retval EFI_SUCCESS The entry point is executed successfully.
@retval other Some error occurs when executing this entry point.
**/
)
{
//
// Install driver model protocol(s).
//
);
return Status;
}
/**
Test to see if this driver supports ControllerHandle.
This service is called by the EFI boot service ConnectController(). In order
to make drivers as small as possible, there are a few calling restrictions for
this service. ConnectController() must follow these calling restrictions. If
any other agent wishes to call Supported() it must also follow these calling
restrictions.
@param This Protocol instance pointer.
@param ControllerHandle Handle of device to test
@param RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver supports this device
@retval EFI_ALREADY_STARTED This driver is already running on this device
@retval other This driver does not support this device
**/
)
{
//
// To keep backward compatibility, UEFI ExtPassThru Protocol is supported as well as
// EFI PassThru Protocol. From priority perspective, ExtPassThru Protocol is firstly
// tried to open on host controller handle. If fails, then PassThru Protocol is tried instead.
//
(VOID **)&ExtPassThru,
);
if (Status == EFI_ALREADY_STARTED) {
return EFI_SUCCESS;
//
// Check if RemainingDevicePath is NULL or the End of Device Path Node,
// if yes, return EFI_SUCCESS.
//
//
// Close protocol regardless of RemainingDevicePath validation
//
gBS->CloseProtocol (
);
return EFI_SUCCESS;
} else {
//
// If RemainingDevicePath isn't the End of Device Path Node, check its validation
//
//
// Close protocol regardless of RemainingDevicePath validation
//
gBS->CloseProtocol (
);
return EFI_SUCCESS;
}
}
}
//
// Come here in 2 condition:
// 1. ExtPassThru doesn't exist.
// 2. ExtPassThru exists but RemainingDevicePath is invalid.
//
);
if (Status == EFI_ALREADY_STARTED) {
return EFI_SUCCESS;
}
return Status;
}
//
// Test RemainingDevicePath is valid or not.
//
}
gBS->CloseProtocol (
);
return Status;
}
/**
Start this driver on ControllerHandle.
This service is called by the EFI boot service ConnectController(). In order
to make drivers as small as possible, there are a few calling restrictions for
this service. ConnectController() must follow these calling restrictions. If
any other agent wishes to call Start() it must also follow these calling
restrictions.
@param This Protocol instance pointer.
@param ControllerHandle Handle of device to bind driver to
@param RemainingDevicePath Optional parameter use to pick a specific child
device to start.
@retval EFI_SUCCESS This driver is added to ControllerHandle
@retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
@retval other This driver does not support this device
**/
)
{
(VOID **) &ParentDevicePath,
);
return DevicePathStatus;
}
//
// To keep backward compatibility, UEFI ExtPassThru Protocol is supported as well as
// EFI PassThru Protocol. From priority perspective, ExtPassThru Protocol is firstly
// tried to open on host controller handle. If fails, then PassThru Protocol is tried instead.
//
(VOID **) &ExtScsiInterface,
);
//
// Fail to open UEFI ExtendPassThru Protocol, then try to open EFI PassThru Protocol instead.
//
(VOID **) &ScsiInterface,
);
//
// Fail to open EFI PassThru Protocol, Close the DevicePathProtocol if it is opened by this time.
//
if (!EFI_ERROR(DevicePathStatus)) {
gBS->CloseProtocol (
);
}
return Status;
}
} else {
//
// Succeed to open ExtPassThru Protocol, and meanwhile open PassThru Protocol
// with BY_DRIVER if it is also present on the handle. The intent is to prevent
// another SCSI Bus Driver to work on the same host handle.
//
(VOID **) &ScsiInterface,
);
}
if (Status != EFI_ALREADY_STARTED) {
//
// Go through here means either ExtPassThru or PassThru Protocol is successfully opened
// on this handle for this time. Then construct Host controller private data.
//
ScsiBusDev = NULL;
if (ScsiBusDev == NULL) {
goto ErrorExit;
}
if (ScsiBusDev->ExtScsiSupport) {
} else {
}
//
// Install EFI_SCSI_BUS_PROTOCOL to the controller handle, So ScsiBusDev could be
// retrieved on this controller handle. With ScsiBusDev, we can know which PassThru
// Protocol is present on the handle, UEFI ExtPassThru Protocol or EFI PassThru Protocol.
//
);
goto ErrorExit;
}
} else {
//
// Go through here means Start() is re-invoked again, nothing special is required to do except
// picking up Host controller private information.
//
(VOID **) &BusIdentify,
);
return Status;
}
}
Lun = 0;
if (RemainingDevicePath == NULL) {
//
// If RemainingDevicePath is NULL,
// must enumerate all SCSI devices anyway
//
} else if (!IsDevicePathEnd (RemainingDevicePath)) {
//
// If RemainingDevicePath isn't the End of Device Path Node,
// only scan the specified device by RemainingDevicePath
//
if (ScsiBusDev->ExtScsiSupport) {
Status = ScsiBusDev->ExtScsiInterface->GetTargetLun (ScsiBusDev->ExtScsiInterface, RemainingDevicePath, &TargetId, &Lun);
} else {
Status = ScsiBusDev->ScsiInterface->GetTargetLun (ScsiBusDev->ScsiInterface, RemainingDevicePath, &ScsiTargetId.ScsiId.Scsi, &Lun);
}
return Status;
}
} else {
//
// If RemainingDevicePath is the End of Device Path Node,
// skip enumerate any device and return EFI_SUCESSS
//
}
while(ScanOtherPuns) {
if (FromFirstTarget) {
//
// Remaining Device Path is NULL, scan all the possible Puns in the
// SCSI Channel.
//
if (ScsiBusDev->ExtScsiSupport) {
Status = ScsiBusDev->ExtScsiInterface->GetNextTargetLun (ScsiBusDev->ExtScsiInterface, &TargetId, &Lun);
} else {
Status = ScsiBusDev->ScsiInterface->GetNextDevice (ScsiBusDev->ScsiInterface, &ScsiTargetId.ScsiId.Scsi, &Lun);
}
//
// no legal Pun and Lun found any more
//
break;
}
} else {
}
//
// Avoid creating handle for the host adapter.
//
if (ScsiBusDev->ExtScsiSupport) {
continue;
}
} else {
continue;
}
}
//
// Scan for the scsi device, if it attaches to the scsi bus,
// then create handle and install scsi i/o protocol.
//
}
return EFI_SUCCESS;
if (ScsiBusDev != NULL) {
}
if (ExtScsiSupport) {
gBS->CloseProtocol (
);
if (!EFI_ERROR (PassThruStatus)) {
gBS->CloseProtocol (
);
}
} else {
gBS->CloseProtocol (
);
}
return Status;
}
/**
Stop this driver on ControllerHandle.
This service is called by the EFI boot service DisconnectController().
In order to make drivers as small as possible, there are a few calling
restrictions for this service. DisconnectController() must follow these
calling restrictions. If any other agent wishes to call Stop() it must also
follow these calling restrictions.
@param This Protocol instance pointer.
@param ControllerHandle Handle of device to stop driver on
@param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
children is zero stop the entire bus driver.
@param ChildHandleBuffer List of Child Handles to Stop.
@retval EFI_SUCCESS This driver is removed ControllerHandle
@retval other This driver was not removed from this device
**/
)
{
if (NumberOfChildren == 0) {
//
// Get the SCSI_BUS_DEVICE
//
(VOID **) &Scsidentifier,
);
return EFI_DEVICE_ERROR;
}
//
// Uninstall SCSI Bus Protocol
//
);
//
// Close the bus driver
//
if (ScsiBusDev->ExtScsiSupport) {
//
// Close ExtPassThru Protocol from this controller handle
//
gBS->CloseProtocol (
);
//
// When Start() succeeds to open ExtPassThru, it always tries to open PassThru BY_DRIVER.
// Its intent is to prevent another SCSI Bus Driver from woking on the same host handle.
// So Stop() needs to try to close PassThru if present here.
//
gBS->CloseProtocol (
);
} else {
gBS->CloseProtocol (
);
}
gBS->CloseProtocol (
);
return EFI_SUCCESS;
}
);
continue;
}
//
// Close the child handle
//
if (ScsiIoDevice->ExtScsiSupport) {
);
} else {
);
}
);
if (ScsiIoDevice->ExtScsiSupport) {
gBS->OpenProtocol (
);
} else {
gBS->OpenProtocol (
);
}
} else {
}
}
if (!AllChildrenStopped) {
return EFI_DEVICE_ERROR;
}
return EFI_SUCCESS;
}
/**
Retrieves the device type information of the SCSI Controller.
@param This Protocol instance pointer.
@param DeviceType A pointer to the device type information retrieved from
the SCSI Controller.
@retval EFI_SUCCESS Retrieves the device type information successfully.
@retval EFI_INVALID_PARAMETER The DeviceType is NULL.
**/
)
{
if (DeviceType == NULL) {
return EFI_INVALID_PARAMETER;
}
return EFI_SUCCESS;
}
/**
Retrieves the device location in the SCSI channel.
@param This Protocol instance pointer.
@param Target A pointer to the Target ID of a SCSI device
on the SCSI channel.
@param Lun A pointer to the LUN of the SCSI device on
the SCSI channel.
@retval EFI_SUCCESS Retrieves the device location successfully.
@retval EFI_INVALID_PARAMETER The Target or Lun is NULL.
**/
)
{
return EFI_INVALID_PARAMETER;
}
return EFI_SUCCESS;
}
/**
Resets the SCSI Bus that the SCSI Controller is attached to.
@param This Protocol instance pointer.
@retval EFI_SUCCESS The SCSI bus is reset successfully.
@retval EFI_DEVICE_ERROR Errors encountered when resetting the SCSI bus.
@retval EFI_UNSUPPORTED The bus reset operation is not supported by the
SCSI Host Controller.
@retval EFI_TIMEOUT A timeout occurred while attempting to reset
the SCSI bus.
**/
)
{
if (ScsiIoDevice->ExtScsiSupport){
} else {
}
}
/**
Resets the SCSI Controller that the device handle specifies.
@param This Protocol instance pointer.
@retval EFI_SUCCESS Reset the SCSI controller successfully.
@retval EFI_DEVICE_ERROR Errors are encountered when resetting the SCSI Controller.
@retval EFI_UNSUPPORTED The SCSI bus does not support a device reset operation.
@retval EFI_TIMEOUT A timeout occurred while attempting to reset the
SCSI Controller.
**/
)
{
if (ScsiIoDevice->ExtScsiSupport) {
);
} else {
);
}
}
/**
Sends a SCSI Request Packet to the SCSI Controller for execution.
@param This Protocol instance pointer.
@param CommandPacket The SCSI request packet to send to the SCSI
Controller specified by the device handle.
@param Event If the SCSI bus where the SCSI device is attached
does not support non-blocking I/O, 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 non-blocking 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
successfully, and TransferLength bytes were
HostAdapterStatus, TargetStatus,
SenseDataLength, and SenseData in that order
for additional status information.
@retval EFI_BAD_BUFFER_SIZE The SCSI Request Packet was executed,
but the entire DataBuffer could not be transferred.
The actual number of bytes transferred is returned
in TransferLength. See HostAdapterStatus,
TargetStatus, SenseDataLength, and SenseData in
that order for additional status information.
@retval EFI_NOT_READY The SCSI Request Packet could not be sent because
there are too many SCSI Command Packets already
queued.The caller may retry again later.
@retval EFI_DEVICE_ERROR A device error occurred while attempting to send
the SCSI Request Packet. See HostAdapterStatus,
TargetStatus, SenseDataLength, and SenseData in
that order for additional status information.
@retval EFI_INVALID_PARAMETER The contents of CommandPacket are invalid.
The SCSI Request Packet was not sent, so no
additional status information is available.
@retval EFI_UNSUPPORTED The command described by the SCSI Request Packet
is not supported by the SCSI initiator(i.e., SCSI
Host Controller). 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. See HostAdapterStatus,
TargetStatus, SenseDataLength, and SenseData in
that order for additional status information.
**/
)
{
PacketEvent = NULL;
return EFI_INVALID_PARAMETER;
}
if (ScsiIoDevice->ExtScsiSupport) {
);
} else {
if (mWorkingBuffer == NULL) {
return EFI_DEVICE_ERROR;
}
//
// Convert package into EFI1.0, EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET.
//
return Status;
}
if (((ScsiIoDevice->ScsiPassThru->Mode->Attributes & EFI_SCSI_PASS_THRU_ATTRIBUTES_NONBLOCKIO) != 0) && (Event != NULL)) {
//
// Create Event
//
);
return Status;
}
);
return Status;
}
} else {
//
// If there's no event or SCSI Device doesn't support NON-BLOCKING, just convert
// EFI1.0 PassThru packet back to UEFI2.0 SCSI IO Packet.
//
);
return Status;
}
//
// After converting EFI1.0 PassThru Packet back to UEFI2.0 SCSI IO Packet,
// free mWorkingBuffer.
//
}
}
return Status;
}
/**
Scan SCSI Bus to discover the device, and attach ScsiIoProtocol to it.
@param This Protocol instance pointer
@param Controller Controller handle
@param TargetId Tartget to be scanned
@param Lun The Lun of the SCSI device on the SCSI channel.
@param ScsiBusDev The pointer of SCSI_BUS_DEVICE
@retval EFI_SUCCESS Successfully to discover the device and attach
ScsiIoProtocol to it.
@retval EFI_OUT_OF_RESOURCES Fail to discover the device.
**/
)
{
DevicePath = NULL;
ScsiIoDevice = NULL;
//
// Build Device Path
//
if (ScsiBusDev->ExtScsiSupport){
Lun,
);
} else {
Lun,
);
}
return Status;
}
);
if (DevicePath == NULL) {
goto ErrorExit;
}
DeviceHandle = NULL;
//
// The device has been started, directly return to fast boot.
//
goto ErrorExit;
}
if (ScsiIoDevice == NULL) {
goto ErrorExit;
}
if (ScsiBusDev->ExtScsiSupport) {
} else {
}
if (!DiscoverScsiDevice (ScsiIoDevice)) {
goto ErrorExit;
}
);
goto ErrorExit;
} else {
if (ScsiBusDev->ExtScsiSupport) {
gBS->OpenProtocol (
);
} else {
gBS->OpenProtocol (
);
}
}
return EFI_SUCCESS;
//
// The memory space for ScsiDevicePath is allocated in
// ScsiPassThru->BuildDevicePath() function; It is no longer used
// after AppendDevicePathNode,so free the memory it occupies.
//
if (DevicePath != NULL) {
}
if (ScsiIoDevice != NULL) {
}
return Status;
}
/**
Discovery SCSI Device
@param ScsiIoDevice The pointer of SCSI_IO_DEV
@retval TRUE Find SCSI Device and verify it.
@retval FALSE Unable to find SCSI Device.
**/
)
{
HostAdapterStatus = 0;
TargetStatus = 0;
if (InquiryData == NULL) {
goto Done;
}
//
// Using Inquiry command to scan for the device
//
InquiryDataLength = sizeof (EFI_SCSI_INQUIRY_DATA);
SenseDataLength = 0;
MaxRetry = 2;
NULL,
(VOID *) InquiryData,
);
break;
} else if ((Status == EFI_BAD_BUFFER_SIZE) ||
(Status == EFI_INVALID_PARAMETER) ||
(Status == EFI_UNSUPPORTED)) {
goto Done;
}
}
goto Done;
}
//
// Retrieved inquiry data successfully
//
if ((InquiryData->Peripheral_Qualifier != 0) &&
goto Done;
}
goto Done;
}
}
goto Done;
}
//
// valid device type and peripheral qualifier combination.
//
if (InquiryData->Version == 0) {
ScsiIoDevice->ScsiVersion = 0;
} else {
//
// ANSI-approved version
//
}
Done:
return ScsiDeviceFound;
}
/**
Convert EFI_SCSI_IO_SCSI_REQUEST_PACKET packet to EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET packet.
@param Packet The pointer of EFI_SCSI_IO_SCSI_REQUEST_PACKET
@param CommandPacket The pointer of EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
**/
)
{
//
//EFI 1.10 doesn't support Bi-Direction Command.
//
return EFI_UNSUPPORTED;
}
}
return EFI_SUCCESS;
}
/**
Convert EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET packet to EFI_SCSI_IO_SCSI_REQUEST_PACKET packet.
@param ScsiPacket The pointer of EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
@param Packet The pointer of EFI_SCSI_IO_SCSI_REQUEST_PACKET
**/
)
{
}
return EFI_SUCCESS;
}
/**
Notify Function in which convert EFI1.0 PassThru Packet back to UEF2.0
SCSI IO Packet.
@param Event The instance of EFI_EVENT.
@param Context The parameter passed in.
**/
)
{
//
// Convert EFI1.0 PassThru packet to UEFI2.0 SCSI IO Packet.
//
//
// After converting EFI1.0 PassThru Packet back to UEFI2.0 SCSI IO Packet,
// free mWorkingBuffer.
//
//
// Signal Event to tell caller to pick up UEFI2.0 SCSI IO Packet.
//
}