/** @file
Copyright (c) 2006, 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 "AtapiPassThru.h"
///
/// This table contains all the supported ATAPI commands.
///
{ OP_INQUIRY, DataIn },
{ OP_LOAD_UNLOAD_CD, NoData },
{ OP_MECHANISM_STATUS, DataIn },
{ OP_MODE_SELECT_10, DataOut },
{ OP_MODE_SENSE_10, DataIn },
{ OP_PAUSE_RESUME, NoData },
{ OP_PLAY_AUDIO_10, DataIn },
{ OP_PLAY_AUDIO_MSF, DataIn },
{ OP_PLAY_CD, DataIn },
{ OP_PLAY_CD_MSF, DataIn },
{ OP_READ_10, DataIn },
{ OP_READ_12, DataIn },
{ OP_READ_CAPACITY, DataIn },
{ OP_READ_CD, DataIn },
{ OP_READ_CD_MSF, DataIn },
{ OP_READ_HEADER, DataIn },
{ OP_READ_SUB_CHANNEL, DataIn },
{ OP_READ_TOC, DataIn },
{ OP_REQUEST_SENSE, DataIn },
{ OP_SEEK_10, NoData },
{ OP_SET_CD_SPEED, DataOut },
{ OP_STOPPLAY_SCAN, NoData },
{ OP_START_STOP_UNIT, NoData },
{ OP_TEST_UNIT_READY, NoData },
{ OP_FORMAT_UNIT, DataOut },
{ OP_WRITE_10, DataOut },
{ OP_WRITE_12, DataOut },
{ OP_WRITE_AND_VERIFY, DataOut },
};
L"ATAPI Controller",
L"ATAPI Channel",
4,
0
};
};
4,
0
};
};
0x10,
NULL,
};
)
/*++
Routine Description:
Test to see if this driver supports ControllerHandle. Any ControllerHandle
that has gEfiPciIoProtocolGuid installed and is IDE Controller it will be supported.
Arguments:
This - Protocol instance pointer.
Controller - Handle of device to test
RemainingDevicePath - Not used
Returns:
EFI_STATUS
--*/
{
//
// Open the IO Abstraction(s) needed to perform the supported test
//
);
return Status;
}
//
// Use the PCI I/O Protocol to see if Controller is a IDE Controller that
// can be managed by this driver. Read the PCI Configuration Header
// for this device.
//
0,
&Pci
);
gBS->CloseProtocol (
);
return EFI_UNSUPPORTED;
}
if (Pci.Hdr.ClassCode[2] != PCI_CLASS_MASS_STORAGE || Pci.Hdr.ClassCode[1] != PCI_CLASS_MASS_STORAGE_IDE) {
}
gBS->CloseProtocol (
);
return Status;
}
)
/*++
Routine Description:
Create handles for IDE channels specified by RemainingDevicePath.
Install SCSI Pass Thru Protocol onto each created handle.
Arguments:
This - Protocol instance pointer.
Controller - Handle of device to test
RemainingDevicePath - Not used
Returns:
EFI_STATUS
--*/
{
);
return Status;
}
//
// Save original PCI attributes
//
0,
);
goto Done;
}
0,
);
);
}
goto Done;
}
//
// Create SCSI Pass Thru instance for the IDE channel.
//
Done:
if (PciAttributesSaved == TRUE) {
//
// Restore original PCI attributes
//
PciIo->Attributes (
);
}
gBS->CloseProtocol (
);
}
return Status;
}
)
/*++
Routine Description:
Stop this driver on ControllerHandle. Support stoping any child handles
created by this driver.
Arguments:
This - Protocol instance pointer.
Controller - Handle of device to stop driver on
NumberOfChildren - Number of Children in the ChildHandleBuffer
ChildHandleBuffer - List of handles for the children we need to stop.
Returns:
EFI_STATUS
--*/
{
if (FeaturePcdGet (PcdSupportScsiPassThru)) {
(VOID **) &ScsiPassThru,
);
return Status;
}
if (FeaturePcdGet (PcdSupportExtScsiPassThru)) {
);
} else {
);
}
} else {
(VOID **) &ExtScsiPassThru,
);
return Status;
}
);
}
return Status;
}
//
// Restore original PCI attributes
//
);
gBS->CloseProtocol (
);
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Attaches SCSI Pass Thru Protocol for specified IDE channel.
Arguments:
This - Protocol instance pointer.
Controller - Parent device handle to the IDE channel.
PciIo - PCI I/O protocol attached on the "Controller".
Returns:
Always return EFI_SUCCESS unless installing SCSI Pass Thru Protocol failed.
--*/
{
if (AtapiScsiPrivate == NULL) {
return EFI_OUT_OF_RESOURCES;
}
//
// will reset the IoPort inside each API function.
//
//
// Obtain IDE IO port registers' base addresses
//
return Status;
}
//
// Initialize the LatestTargetId to MAX_TARGET_ID.
//
AtapiScsiPrivate->LatestLun = 0;
return Status;
}
)
/*++
Routine Description:
Implements EFI_SCSI_PASS_THRU_PROTOCOL.PassThru() function.
Arguments:
This: The EFI_SCSI_PASS_THRU_PROTOCOL instance.
Target: The Target ID of the ATAPI device to send the SCSI
Request Packet. To ATAPI devices attached on an IDE
Channel, Target ID 0 indicates Master device;Target
ID 1 indicates Slave device.
Lun: The LUN of the ATAPI device to send the SCSI Request
Packet. To the ATAPI device, Lun is always 0.
Packet: The SCSI Request Packet to send to the ATAPI device
specified by Target and Lun.
Event: If non-blocking 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 non-blocking I/O is performed, and Event will be signaled
when the SCSI Request Packet completes.
Returns:
EFI_STATUS
--*/
{
//
// Target is not allowed beyond MAX_TARGET_ID
//
return EFI_INVALID_PARAMETER;
}
//
// check the data fields in Packet parameter.
//
return Status;
}
//
// If Request Packet targets at the IDE channel itself,
// do nothing.
//
Packet->TransferLength = 0;
return EFI_SUCCESS;
}
//
// According to Target ID, reset the Atapi I/O Register mapping
// (Target Id in [0,1] area, using AtapiIoPortRegisters[0],
// Target Id in [2,3] area, using AtapiIoPortRegisters[1]
//
if ((Target / 2) == 0) {
} else {
}
//
// the ATAPI SCSI interface does not support non-blocking I/O
// ignore the Event parameter
//
// Performs blocking I/O.
//
return Status;
}
)
/*++
Routine Description:
Used to retrieve the list of legal Target IDs for SCSI devices
on a SCSI channel.
Arguments:
This - Protocol instance pointer.
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.
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.
Returns:
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().
--*/
{
//
// Retrieve Device Private Data Structure.
//
//
// Check whether Target is valid.
//
return EFI_INVALID_PARAMETER;
}
if ((*Target != 0xFFFFFFFF) &&
return EFI_INVALID_PARAMETER;
}
if (*Target == MAX_TARGET_ID) {
return EFI_NOT_FOUND;
}
if (*Target == 0xFFFFFFFF) {
*Target = 0;
} else {
}
*Lun = 0;
//
// Update the LatestTargetId.
//
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Used to allocate and build a device path node for a SCSI device
on a SCSI channel. Would not build device path for a SCSI Host Controller.
Arguments:
This - Protocol instance pointer.
Target - The Target ID of the SCSI device for which
a device path node is to be allocated and built.
Lun - The LUN of the SCSI device for which a device
path node is to be allocated and built.
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.
Returns:
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.
--*/
{
//
// Validate parameters passed in.
//
if (DevicePath == NULL) {
return EFI_INVALID_PARAMETER;
}
//
// can not build device path for the SCSI Host Controller.
//
return EFI_NOT_FOUND;
}
return EFI_OUT_OF_RESOURCES;
}
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Used to translate a device path node to a Target ID and LUN.
Arguments:
This - Protocol instance pointer.
DevicePath - A pointer to the device path node that
describes a SCSI device on the SCSI channel.
Target - A pointer to the Target ID of a SCSI device
on the SCSI channel.
Lun - A pointer to the LUN of a SCSI device on
the SCSI channel.
Returns:
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.
--*/
{
//
// Validate parameters passed in.
//
return EFI_INVALID_PARAMETER;
}
//
// Check whether the DevicePath belongs to SCSI_DEVICE_PATH
//
return EFI_UNSUPPORTED;
}
return EFI_NOT_FOUND;
}
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Resets a SCSI channel.This operation resets all the
SCSI devices connected to the SCSI channel.
Arguments:
This - Protocol instance pointer.
Returns:
EFI_SUCCESS - The SCSI channel was reset.
EFI_UNSUPPORTED - The SCSI channel does not support
a channel reset operation.
EFI_DEVICE_ERROR - A device error occurred while
attempting to reset the SCSI channel.
EFI_TIMEOUT - A timeout occurred while attempting
to reset the SCSI channel.
--*/
{
//
// Reset both Primary channel and Secondary channel.
// so, the IoPort pointer must point to the right I/O Register group
//
//
// Reset
//
DeviceControlValue = 0;
//
// set SRST bit to initiate soft reset
//
//
// disable Interrupt
//
);
//
// Wait 10us
//
//
// Clear SRST bit
// 0xfb:1111,1011
//
DeviceControlValue &= 0xfb;
WritePortB (AtapiScsiPrivate->PciIo, AtapiScsiPrivate->IoPort->Alt.DeviceControl, DeviceControlValue);
//
// slave device needs at most 31s to clear BSY
//
}
}
if (ResetFlag) {
return EFI_SUCCESS;
}
return EFI_TIMEOUT;
}
)
/*++
Routine Description:
Resets a SCSI device that is connected to a SCSI channel.
Arguments:
This - Protocol instance pointer.
Target - The Target ID of the SCSI device to reset.
Lun - The LUN of the SCSI device to reset.
Returns:
EFI_SUCCESS - The SCSI device specified by Target and
Lun was reset.
EFI_UNSUPPORTED - The SCSI channel does not support a target
reset operation.
EFI_INVALID_PARAMETER - Target or Lun are invalid.
EFI_DEVICE_ERROR - A device error occurred while attempting
to reset the SCSI device specified by Target
and Lun.
EFI_TIMEOUT - A timeout occurred while attempting to reset
the SCSI device specified by Target and Lun.
--*/
{
return EFI_INVALID_PARAMETER;
}
//
// Directly return EFI_SUCCESS if want to reset the host controller
//
return EFI_SUCCESS;
}
//
// According to Target ID, reset the Atapi I/O Register mapping
// (Target Id in [0,1] area, using AtapiIoPortRegisters[0],
// Target Id in [2,3] area, using AtapiIoPortRegisters[1]
//
if ((Target / 2) == 0) {
} else {
}
//
// for ATAPI device, no need to wait DRDY ready after device selecting.
//
// bit7 and bit5 are both set to 1 for backward compatibility
//
//
// BSY clear is the only status return to the host by the device
// when reset is complete.
// slave device needs at most 31s to clear BSY
//
return EFI_TIMEOUT;
}
//
// stall 5 seconds to make the device status stable
//
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Implements EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru() function.
Arguments:
This: The EFI_EXT_SCSI_PASS_THRU_PROTOCOL instance.
Target: The Target ID of the ATAPI device to send the SCSI
Request Packet. To ATAPI devices attached on an IDE
Channel, Target ID 0 indicates Master device;Target
ID 1 indicates Slave device.
Lun: The LUN of the ATAPI device to send the SCSI Request
Packet. To the ATAPI device, Lun is always 0.
Packet: The SCSI Request Packet to send to the ATAPI device
specified by Target and Lun.
Event: If non-blocking 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 non-blocking I/O is performed, and Event will be signaled
when the SCSI Request Packet completes.
Returns:
EFI_STATUS
--*/
{
//
// For ATAPI device, UINT8 is enough to represent the SCSI ID on channel.
//
//
// Target is not allowed beyond MAX_TARGET_ID
//
return EFI_INVALID_PARAMETER;
}
//
// check the data fields in Packet parameter.
//
return Status;
}
//
// If Request Packet targets at the IDE channel itself,
// do nothing.
//
return EFI_SUCCESS;
}
//
// According to Target ID, reset the Atapi I/O Register mapping
// (Target Id in [0,1] area, using AtapiIoPortRegisters[0],
// Target Id in [2,3] area, using AtapiIoPortRegisters[1]
//
if ((TargetId / 2) == 0) {
} else {
}
//
// the ATAPI SCSI interface does not support non-blocking I/O
// ignore the Event parameter
//
// Performs blocking I/O.
//
return Status;
}
)
/*++
Routine Description:
Used to retrieve the list of legal Target IDs for SCSI devices
on a SCSI channel.
Arguments:
This - Protocol instance pointer.
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.
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.
Returns:
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().
--*/
{
//
// Retrieve Device Private Data Structure.
//
//
// Check whether Target is valid.
//
return EFI_INVALID_PARAMETER;
}
//
// For ATAPI device, we use UINT8 to represent the SCSI ID on channel.
//
return EFI_INVALID_PARAMETER;
}
}
}
return EFI_INVALID_PARAMETER;
}
if (TargetId == MAX_TARGET_ID) {
return EFI_NOT_FOUND;
}
} else {
}
*Lun = 0;
//
// Update the LatestTargetId.
//
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Used to allocate and build a device path node for a SCSI device
on a SCSI channel. Would not build device path for a SCSI Host Controller.
Arguments:
This - Protocol instance pointer.
Target - The Target ID of the SCSI device for which
a device path node is to be allocated and built.
Lun - The LUN of the SCSI device for which a device
path node is to be allocated and built.
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.
Returns:
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.
--*/
{
//
// Validate parameters passed in.
//
if (DevicePath == NULL) {
return EFI_INVALID_PARAMETER;
}
//
// can not build device path for the SCSI Host Controller.
//
return EFI_NOT_FOUND;
}
return EFI_OUT_OF_RESOURCES;
}
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Used to translate a device path node to a Target ID and LUN.
Arguments:
This - Protocol instance pointer.
DevicePath - A pointer to the device path node that
describes a SCSI device on the SCSI channel.
Target - A pointer to the Target ID of a SCSI device
on the SCSI channel.
Lun - A pointer to the LUN of a SCSI device on
the SCSI channel.
Returns:
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.
--*/
{
//
// Validate parameters passed in.
//
return EFI_INVALID_PARAMETER;
}
//
// Check whether the DevicePath belongs to SCSI_DEVICE_PATH
//
return EFI_UNSUPPORTED;
}
return EFI_NOT_FOUND;
}
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Resets a SCSI channel.This operation resets all the
SCSI devices connected to the SCSI channel.
Arguments:
This - Protocol instance pointer.
Returns:
EFI_SUCCESS - The SCSI channel was reset.
EFI_UNSUPPORTED - The SCSI channel does not support
a channel reset operation.
EFI_DEVICE_ERROR - A device error occurred while
attempting to reset the SCSI channel.
EFI_TIMEOUT - A timeout occurred while attempting
to reset the SCSI channel.
--*/
{
//
// Reset both Primary channel and Secondary channel.
// so, the IoPort pointer must point to the right I/O Register group
// And if there is a channel reset successfully, return EFI_SUCCESS.
//
//
// Reset
//
DeviceControlValue = 0;
//
// set SRST bit to initiate soft reset
//
//
// disable Interrupt
//
);
//
// Wait 10us
//
//
// Clear SRST bit
// 0xfb:1111,1011
//
DeviceControlValue &= 0xfb;
WritePortB (AtapiScsiPrivate->PciIo, AtapiScsiPrivate->IoPort->Alt.DeviceControl, DeviceControlValue);
//
// slave device needs at most 31s to clear BSY
//
}
}
if (ResetFlag) {
return EFI_SUCCESS;
}
return EFI_TIMEOUT;
}
)
/*++
Routine Description:
Resets a SCSI device that is connected to a SCSI channel.
Arguments:
This - Protocol instance pointer.
Target - The Target ID of the SCSI device to reset.
Lun - The LUN of the SCSI device to reset.
Returns:
EFI_SUCCESS - The SCSI device specified by Target and
Lun was reset.
EFI_UNSUPPORTED - The SCSI channel does not support a target
reset operation.
EFI_INVALID_PARAMETER - Target or Lun are invalid.
EFI_DEVICE_ERROR - A device error occurred while attempting
to reset the SCSI device specified by Target
and Lun.
EFI_TIMEOUT - A timeout occurred while attempting to reset
the SCSI device specified by Target and Lun.
--*/
{
return EFI_INVALID_PARAMETER;
}
//
// Directly return EFI_SUCCESS if want to reset the host controller
//
return EFI_SUCCESS;
}
//
// According to Target ID, reset the Atapi I/O Register mapping
// (Target Id in [0,1] area, using AtapiIoPortRegisters[0],
// Target Id in [2,3] area, using AtapiIoPortRegisters[1]
//
if ((TargetId / 2) == 0) {
} else {
}
//
// for ATAPI device, no need to wait DRDY ready after device selecting.
//
// bit7 and bit5 are both set to 1 for backward compatibility
//
//
// BSY clear is the only status return to the host by the device
// when reset is complete.
// slave device needs at most 31s to clear BSY
//
return EFI_TIMEOUT;
}
//
// stall 5 seconds to make the device status stable
//
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Used to retrieve the list of legal Target IDs for SCSI devices
on a SCSI channel.
Arguments:
This - Protocol instance pointer.
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.
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.
Returns:
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().
--*/
{
//
// Retrieve Device Private Data Structure.
//
//
// Check whether Target is valid.
//
return EFI_INVALID_PARAMETER;
}
//
// For ATAPI device, we use UINT8 to represent the SCSI ID on channel.
//
return EFI_INVALID_PARAMETER;
}
}
}
if ((CompareMem(*Target, ScsiId, TARGET_MAX_BYTES) != 0) &&(TargetId != AtapiScsiPrivate->LatestTargetId)) {
return EFI_INVALID_PARAMETER;
}
if (TargetId == MAX_TARGET_ID) {
return EFI_NOT_FOUND;
}
} else {
}
//
// Update the LatestTargetId.
//
AtapiScsiPrivate->LatestLun = 0;
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Get IDE IO port registers' base addresses by mode. In 'Compatibility' mode,
use fixed addresses. In Native-PCI mode, get base addresses from BARs in
the PCI IDE controller's Configuration Space.
Arguments:
PciIo - Pointer to the EFI_PCI_IO_PROTOCOL instance
IdeRegsBaseAddr - Pointer to IDE_REGISTERS_BASE_ADDR to
receive IDE IO port registers' base addresses
Returns:
EFI_STATUS
--*/
{
0,
sizeof (PciData),
);
return Status;
}
} else {
//
// The BARs should be of IO type
//
return EFI_UNSUPPORTED;
}
}
} else {
//
// The BARs should be of IO type
//
return EFI_UNSUPPORTED;
}
}
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Initialize each Channel's Base Address of CommandBlock and ControlBlock.
Arguments:
AtapiScsiPrivate - The pointer of ATAPI_SCSI_PASS_THRU_DEV
IdeRegsBaseAddr - The pointer of IDE_REGISTERS_BASE_ADDR
Returns:
None
--*/
{
//
// Initialize IDE IO port addresses, including Command Block registers
// and Control Block registers
//
}
}
)
/*++
Routine Description:
Checks the parameters in the SCSI Request Packet to make sure
they are valid for a SCSI Pass Thru request.
Arguments:
Packet - The pointer of EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
Returns:
EFI_STATUS
--*/
{
return EFI_INVALID_PARAMETER;
}
return EFI_INVALID_PARAMETER;
}
return EFI_INVALID_PARAMETER;
}
//
// Checks whether the request command is supported.
//
if (!IsCommandValid (Packet)) {
return EFI_UNSUPPORTED;
}
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Checks the requested SCSI command:
Is it supported by this driver?
Is the Data transfer direction reasonable?
Arguments:
Packet - The pointer of EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
Returns:
EFI_STATUS
--*/
{
for (Index = 0; (Index < ArrayLen) && (CompareMem (&gSupportedATAPICommands[Index], &gEndTable, sizeof (SCSI_COMMAND_SET)) != 0); Index++) {
//
// Check whether the requested Command is supported by this driver
//
//
// Check whether the requested data direction conforms to
// what it should be.
//
return FALSE;
}
}
//
// Check whether the requested data direction conforms to
// what it should be.
//
return FALSE;
}
}
return TRUE;
}
}
return FALSE;
}
)
/*++
Routine Description:
Performs blocking I/O request.
Arguments:
AtapiScsiPrivate: Private data structure for the specified channel.
Target: The Target ID of the ATAPI device to send the SCSI
Request Packet. To ATAPI devices attached on an IDE
Channel, Target ID 0 indicates Master device;Target
ID 1 indicates Slave device.
Packet: The SCSI Request Packet to send to the ATAPI device
specified by Target.
Returns: EFI_STATUS
--*/
{
//
// Fill ATAPI Command Packet according to CDB
//
//
// Timeout is 100ns unit, convert it to 1000ns (1us) unit.
//
//
// Submit ATAPI Command Packet
//
&(Packet->TransferLength),
);
Packet->SenseDataLength = 0;
return PacketCommandStatus;
}
//
// Return SenseData if PacketCommandStatus matches
// the following return codes.
//
if ((PacketCommandStatus == EFI_BAD_BUFFER_SIZE) ||
(PacketCommandStatus == EFI_DEVICE_ERROR) ||
(PacketCommandStatus == EFI_TIMEOUT)) {
//
// avoid submit request sense command continuously.
//
if (PacketCommand[0] == OP_REQUEST_SENSE) {
Packet->SenseDataLength = 0;
return PacketCommandStatus;
}
);
}
return PacketCommandStatus;
}
)
/*++
Routine Description:
Sumbit request sense command
Arguments:
AtapiScsiPrivate - The pionter of ATAPI_SCSI_PASS_THRU_DEV
Target - The target ID
Timeout - The time to complete the command
SenseData - The buffer to fill in sense data
SenseDataLength - The length of buffer
Returns:
EFI_STATUS
--*/
{
Cdb[0] = OP_REQUEST_SENSE;
return Status;
}
)
/*++
Routine Description:
Checks the parameters in the SCSI Request Packet to make sure
they are valid for a SCSI Pass Thru request.
Arguments:
Packet - The pointer of EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
Returns:
EFI_STATUS
--*/
{
return EFI_INVALID_PARAMETER;
}
return EFI_INVALID_PARAMETER;
}
return EFI_INVALID_PARAMETER;
}
//
// Checks whether the request command is supported.
//
if (!IsExtCommandValid (Packet)) {
return EFI_UNSUPPORTED;
}
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Checks the requested SCSI command:
Is it supported by this driver?
Is the Data transfer direction reasonable?
Arguments:
Packet - The pointer of EFI_SCSI_PASS_THRU_SCSI_REQUEST_PACKET
Returns:
EFI_STATUS
--*/
{
for (Index = 0; (Index < ArrayLen) && (CompareMem (&gSupportedATAPICommands[Index], &gEndTable, sizeof (SCSI_COMMAND_SET)) != 0); Index++) {
//
// Check whether the requested Command is supported by this driver
//
//
// Check whether the requested data direction conforms to
// what it should be.
//
return FALSE;
}
}
//
// Check whether the requested data direction conforms to
// what it should be.
//
return FALSE;
}
}
return TRUE;
}
}
return FALSE;
}
)
/*++
Routine Description:
Performs blocking I/O request.
Arguments:
AtapiScsiPrivate: Private data structure for the specified channel.
Target: The Target ID of the ATAPI device to send the SCSI
Request Packet. To ATAPI devices attached on an IDE
Channel, Target ID 0 indicates Master device;Target
ID 1 indicates Slave device.
Packet: The SCSI Request Packet to send to the ATAPI device
specified by Target.
Returns: EFI_STATUS
--*/
{
//
// Fill ATAPI Command Packet according to CDB
//
//
// Timeout is 100ns unit, convert it to 1000ns (1us) unit.
//
//
// Submit ATAPI Command Packet
//
&(Packet->InTransferLength),
);
} else {
&(Packet->OutTransferLength),
);
}
Packet->SenseDataLength = 0;
return PacketCommandStatus;
}
//
// Return SenseData if PacketCommandStatus matches
// the following return codes.
//
if ((PacketCommandStatus == EFI_BAD_BUFFER_SIZE) ||
(PacketCommandStatus == EFI_DEVICE_ERROR) ||
(PacketCommandStatus == EFI_TIMEOUT)) {
//
// avoid submit request sense command continuously.
//
if (PacketCommand[0] == OP_REQUEST_SENSE) {
Packet->SenseDataLength = 0;
return PacketCommandStatus;
}
);
}
return PacketCommandStatus;
}
)
/*++
Routine Description:
Submits ATAPI command packet to the specified ATAPI device.
Arguments:
AtapiScsiPrivate: Private data structure for the specified channel.
Target: The Target ID of the ATAPI device to send the SCSI
Request Packet. To ATAPI devices attached on an IDE
Channel, Target ID 0 indicates Master device;Target
ID 1 indicates Slave device.
PacketCommand: Points to the ATAPI command packet.
Buffer: Points to the transferred data.
ByteCount: When input,indicates the buffer size; when output,
indicates the actually transferred data size.
Direction: Indicates the data transfer direction.
TimeoutInMicroSeconds:
The timeout, in micro second units, to use for the
execution of this ATAPI command.
A TimeoutInMicroSeconds value of 0 means that
this function will wait indefinitely for the ATAPI
command to execute.
If TimeoutInMicroSeconds is greater than zero, then
this function will return EFI_TIMEOUT if the time
required to execute the ATAPI command is greater
than TimeoutInMicroSeconds.
Returns:
EFI_STATUS
--*/
{
//
// Set all the command parameters by fill related registers.
// Before write to all the following registers, BSY must be 0.
//
return EFI_DEVICE_ERROR;
}
//
// "Target = 0" indicates device 0; "Target = 1" indicates device 1
//
);
//
// Set all the command parameters by fill related registers.
// Before write to all the following registers, BSY DRQ must be 0.
//
if (Status == EFI_ABORTED) {
}
*ByteCount = 0;
return Status;
}
//
// No OVL; No DMA (by setting feature register)
//
0x00
);
//
// set the transfersize to MAX_ATAPI_BYTE_COUNT to let the device
// determine how much data should be transfered.
//
);
);
//
// DEFAULT_CTL:0x0a (0000,1010)
// Disable interrupt
//
);
//
// Send Packet command to inform device
// that the following data bytes are command packet.
//
);
//
// Before data transfer, BSY should be 0 and DRQ should be 1.
// if they are not in specified time frame,
// retrieve Sense Key from Error Register before return.
//
if (Status == EFI_ABORTED) {
}
*ByteCount = 0;
return Status;
}
//
// Send out command packet
//
}
//
// call AtapiPassThruPioReadWriteData() function to get
// requested transfer data form device.
//
return AtapiPassThruPioReadWriteData (
);
}
)
/*++
Routine Description:
Performs data transfer between ATAPI device and host after the
ATAPI command packet is sent.
Arguments:
AtapiScsiPrivate: Private data structure for the specified channel.
Buffer: Points to the transferred data.
ByteCount: When input,indicates the buffer size; when output,
indicates the actually transferred data size.
Direction: Indicates the data transfer direction.
TimeoutInMicroSeconds:
The timeout, in micro second units, to use for the
execution of this ATAPI command.
A TimeoutInMicroSeconds value of 0 means that
this function will wait indefinitely for the ATAPI
command to execute.
If TimeoutInMicroSeconds is greater than zero, then
this function will return EFI_TIMEOUT if the time
required to execute the ATAPI command is greater
than TimeoutInMicroSeconds.
Returns:
EFI_STATUS
--*/
{
//
// Non Data transfer request is also supported.
//
*ByteCount = 0;
return EFI_DEVICE_ERROR;
}
}
//
// ActuralWordCount means the word count of data really transfered.
//
ActualWordCount = 0;
while (ActualWordCount < RequiredWordCount) {
//
// before each data transfer stream, the host should poll DRQ bit ready,
// which indicates device's ready for data transfer .
//
if (ActualWordCount == 0) {
return EFI_DEVICE_ERROR;
}
//
// ActualWordCount > 0
//
if (ActualWordCount < RequiredWordCount) {
return EFI_BAD_BUFFER_SIZE;
}
}
//
// get current data transfer size from Cylinder Registers.
//
WordCount /= 2;
//
//
for (Index = 0; (Index < WordCount) && (ActualWordCount < RequiredWordCount); Index++, ActualWordCount++) {
} else {
}
ptrBuffer++;
}
}
//
// After data transfer is completed, normally, DRQ bit should clear.
//
//
// read status register to check whether error happens.
//
return Status;
}
)
/*++
Routine Description:
Read one byte from a specified I/O port.
Arguments:
PciIo - The pointer of EFI_PCI_IO_PROTOCOL
Port - IO port
Returns:
A byte read out
--*/
{
Data = 0;
1,
&Data
);
return Data;
}
)
/*++
Routine Description:
Read one word from a specified I/O port.
Arguments:
PciIo - The pointer of EFI_PCI_IO_PROTOCOL
Port - IO port
Returns:
A word read out
--*/
{
Data = 0;
1,
&Data
);
return Data;
}
)
/*++
Routine Description:
Write one byte to a specified I/O port.
Arguments:
PciIo - The pointer of EFI_PCI_IO_PROTOCOL
Port - IO port
Data - The data to write
Returns:
NONE
--*/
{
1,
&Data
);
}
)
/*++
Routine Description:
Write one word to a specified I/O port.
Arguments:
PciIo - The pointer of EFI_PCI_IO_PROTOCOL
Port - IO port
Data - The data to write
Returns:
NONE
--*/
{
1,
&Data
);
}
)
/*++
Routine Description:
Check whether DRQ is clear in the Status Register. (BSY must also be cleared)
If TimeoutInMicroSeconds is zero, this routine should wait infinitely for
DRQ clear. Otherwise, it will return EFI_TIMEOUT when specified time is
elapsed.
Arguments:
AtapiScsiPrivate - The pointer of ATAPI_SCSI_PASS_THRU_DEV
TimeoutInMicroSeconds - The time to wait for
Returns:
EFI_STATUS
--*/
{
if (TimeoutInMicroSeconds == 0) {
Delay = 2;
} else {
}
do {
);
//
// wait for BSY == 0 and DRQ == 0
//
break;
}
//
// check whether the command is aborted by the device
//
ErrRegister = ReadPortB (
);
return EFI_ABORTED;
}
}
//
// Stall for 30 us
//
//
// Loop infinitely if not meeting expected condition
//
if (TimeoutInMicroSeconds == 0) {
Delay = 2;
}
Delay--;
} while (Delay);
if (Delay == 0) {
return EFI_TIMEOUT;
}
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Check whether DRQ is clear in the Alternate Status Register.
(BSY must also be cleared).If TimeoutInMicroSeconds is zero, this routine should
wait infinitely for DRQ clear. Otherwise, it will return EFI_TIMEOUT when specified time is
elapsed.
Arguments:
AtapiScsiPrivate - The pointer of ATAPI_SCSI_PASS_THRU_DEV
TimeoutInMicroSeconds - The time to wait for
Returns:
EFI_STATUS
--*/
{
if (TimeoutInMicroSeconds == 0) {
Delay = 2;
} else {
}
do {
);
//
// wait for BSY == 0 and DRQ == 0
//
break;
}
ErrRegister = ReadPortB (
);
return EFI_ABORTED;
}
}
//
// Stall for 30 us
//
//
// Loop infinitely if not meeting expected condition
//
if (TimeoutInMicroSeconds == 0) {
Delay = 2;
}
Delay--;
} while (Delay);
if (Delay == 0) {
return EFI_TIMEOUT;
}
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Check whether DRQ is ready in the Status Register. (BSY must also be cleared)
If TimeoutInMicroSeconds is zero, this routine should wait infinitely for
DRQ ready. Otherwise, it will return EFI_TIMEOUT when specified time is
elapsed.
Arguments:
AtapiScsiPrivate - The pointer of ATAPI_SCSI_PASS_THRU_DEV
TimeoutInMicroSeconds - The time to wait for
Returns:
EFI_STATUS
--*/
{
if (TimeoutInMicroSeconds == 0) {
Delay = 2;
} else {
}
do {
//
// read Status Register will clear interrupt
//
);
//
// BSY==0,DRQ==1
//
break;
}
ErrRegister = ReadPortB (
);
return EFI_ABORTED;
}
}
//
// Stall for 30 us
//
//
// Loop infinitely if not meeting expected condition
//
if (TimeoutInMicroSeconds == 0) {
Delay = 2;
}
Delay--;
} while (Delay);
if (Delay == 0) {
return EFI_TIMEOUT;
}
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Check whether DRQ is ready in the Alternate Status Register.
(BSY must also be cleared)
If TimeoutInMicroSeconds is zero, this routine should wait infinitely for
DRQ ready. Otherwise, it will return EFI_TIMEOUT when specified time is
elapsed.
Arguments:
AtapiScsiPrivate - The pointer of ATAPI_SCSI_PASS_THRU_DEV
TimeoutInMicroSeconds - The time to wait for
Returns:
EFI_STATUS
--*/
{
if (TimeoutInMicroSeconds == 0) {
Delay = 2;
} else {
}
do {
//
// read Status Register will clear interrupt
//
);
//
// BSY==0,DRQ==1
//
break;
}
ErrRegister = ReadPortB (
);
return EFI_ABORTED;
}
}
//
// Stall for 30 us
//
//
// Loop infinitely if not meeting expected condition
//
if (TimeoutInMicroSeconds == 0) {
Delay = 2;
}
Delay--;
} while (Delay);
if (Delay == 0) {
return EFI_TIMEOUT;
}
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Check whether BSY is clear in the Status Register.
If TimeoutInMicroSeconds is zero, this routine should wait infinitely for
BSY clear. Otherwise, it will return EFI_TIMEOUT when specified time is
elapsed.
Arguments:
AtapiScsiPrivate - The pointer of ATAPI_SCSI_PASS_THRU_DEV
TimeoutInMicroSeconds - The time to wait for
Returns:
EFI_STATUS
--*/
{
if (TimeoutInMicroSeconds == 0) {
Delay = 2;
} else {
}
do {
);
break;
}
//
// Stall for 30 us
//
//
// Loop infinitely if not meeting expected condition
//
if (TimeoutInMicroSeconds == 0) {
Delay = 2;
}
Delay--;
} while (Delay);
if (Delay == 0) {
return EFI_TIMEOUT;
}
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Check whether BSY is clear in the Alternate Status Register.
If TimeoutInMicroSeconds is zero, this routine should wait infinitely for
BSY clear. Otherwise, it will return EFI_TIMEOUT when specified time is
elapsed.
Arguments:
AtapiScsiPrivate - The pointer of ATAPI_SCSI_PASS_THRU_DEV
TimeoutInMicroSeconds - The time to wait for
Returns:
EFI_STATUS
--*/
{
if (TimeoutInMicroSeconds == 0) {
Delay = 2;
} else {
}
do {
);
break;
}
//
// Stall for 30 us
//
//
// Loop infinitely if not meeting expected condition
//
if (TimeoutInMicroSeconds == 0) {
Delay = 2;
}
Delay--;
} while (Delay);
if (Delay == 0) {
return EFI_TIMEOUT;
}
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Check whether DRDY is ready in the Status Register.
(BSY must also be cleared)
If TimeoutInMicroSeconds is zero, this routine should wait infinitely for
DRDY ready. Otherwise, it will return EFI_TIMEOUT when specified time is
elapsed.
Arguments:
AtapiScsiPrivate - The pointer of ATAPI_SCSI_PASS_THRU_DEV
TimeoutInMicroSeconds - The time to wait for
Returns:
EFI_STATUS
--*/
{
if (TimeoutInMicroSeconds == 0) {
Delay = 2;
} else {
}
do {
);
//
// BSY == 0 , DRDY == 1
//
break;
}
ErrRegister = ReadPortB (
);
return EFI_ABORTED;
}
}
//
// Stall for 30 us
//
//
// Loop infinitely if not meeting expected condition
//
if (TimeoutInMicroSeconds == 0) {
Delay = 2;
}
Delay--;
} while (Delay);
if (Delay == 0) {
return EFI_TIMEOUT;
}
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Check whether DRDY is ready in the Alternate Status Register.
(BSY must also be cleared)
If TimeoutInMicroSeconds is zero, this routine should wait infinitely for
DRDY ready. Otherwise, it will return EFI_TIMEOUT when specified time is
elapsed.
Arguments:
AtapiScsiPrivate - The pointer of ATAPI_SCSI_PASS_THRU_DEV
TimeoutInMicroSeconds - The time to wait for
Returns:
EFI_STATUS
--*/
{
if (TimeoutInMicroSeconds == 0) {
Delay = 2;
} else {
}
do {
);
//
// BSY == 0 , DRDY == 1
//
break;
}
ErrRegister = ReadPortB (
);
return EFI_ABORTED;
}
}
//
// Stall for 30 us
//
//
// Loop infinitely if not meeting expected condition
//
if (TimeoutInMicroSeconds == 0) {
Delay = 2;
}
Delay--;
} while (Delay);
if (Delay == 0) {
return EFI_TIMEOUT;
}
return EFI_SUCCESS;
}
)
/*++
Routine Description:
Check Error Register for Error Information.
Arguments:
AtapiScsiPrivate - The pointer of ATAPI_SCSI_PASS_THRU_DEV
Returns:
EFI_STATUS
--*/
{
);
DEBUG_CODE_BEGIN ();
if (StatusRegister & DWF) {
DEBUG (
"AtapiPassThruCheckErrorStatus()-- %02x : Error : Write Fault\n",
);
}
if (StatusRegister & CORR) {
DEBUG (
"AtapiPassThruCheckErrorStatus()-- %02x : Error : Corrected Data\n",
);
}
if (StatusRegister & ERR) {
if (ErrorRegister & BBK_ERR) {
DEBUG (
"AtapiPassThruCheckErrorStatus()-- %02x : Error : Bad Block Detected\n",
);
}
if (ErrorRegister & UNC_ERR) {
DEBUG (
"AtapiPassThruCheckErrorStatus()-- %02x : Error : Uncorrectable Data\n",
);
}
if (ErrorRegister & MC_ERR) {
DEBUG (
"AtapiPassThruCheckErrorStatus()-- %02x : Error : Media Change\n",
);
}
if (ErrorRegister & ABRT_ERR) {
DEBUG (
"AtapiPassThruCheckErrorStatus()-- %02x : Error : Abort\n",
);
}
if (ErrorRegister & TK0NF_ERR) {
DEBUG (
"AtapiPassThruCheckErrorStatus()-- %02x : Error : Track 0 Not Found\n",
);
}
if (ErrorRegister & AMNF_ERR) {
DEBUG (
"AtapiPassThruCheckErrorStatus()-- %02x : Error : Address Mark Not Found\n",
);
}
}
DEBUG_CODE_END ();
return EFI_SUCCESS;
}
return EFI_DEVICE_ERROR;
}
/**
protocols based on feature flags.
@param Controller The controller handle to
install these protocols on.
@param AtapiScsiPrivate A pointer to the protocol private
data structure.
@retval EFI_SUCCESS The installation succeeds.
@retval other The installation fails.
**/
)
{
if (FeaturePcdGet (PcdSupportScsiPassThru)) {
if (FeaturePcdGet (PcdSupportExtScsiPassThru)) {
ExtScsiPassThru = CopyMem (ExtScsiPassThru, &gExtScsiPassThruProtocolTemplate, sizeof (*ExtScsiPassThru));
);
} else {
);
}
} else {
if (FeaturePcdGet (PcdSupportExtScsiPassThru)) {
ExtScsiPassThru = CopyMem (ExtScsiPassThru, &gExtScsiPassThruProtocolTemplate, sizeof (*ExtScsiPassThru));
);
} else {
//
// This driver must support either ScsiPassThru or
// ExtScsiPassThru protocols
//
}
}
return Status;
}
/**
The user Entry Point for module AtapiPassThru. The user code starts with this function.
@param[in] ImageHandle The firmware allocated handle for the EFI image.
@param[in] 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).
//
);
//
// Install EFI Driver Supported EFI Version Protocol required for
// EFI drivers that are on PCI and other plug in cards.
//
gAtapiScsiPassThruDriverSupportedEfiVersion.FirmwareVersion = PcdGet32 (PcdDriverSupportedEfiVersion);
);
return Status;
}