ScsiDisk.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
SCSI disk driver that layers on every SCSI IO protocol in the system.
Copyright (c) 2006 - 2012, 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 "ScsiDisk.h"
0xa,
NULL,
};
};
/**
Allocates an aligned buffer for SCSI disk.
This function allocates an aligned buffer for the SCSI disk to perform
SCSI IO operations. The alignment requirement is from SCSI IO interface.
@param ScsiDiskDevice The SCSI disk 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 disk.
This function frees an aligned buffer for the SCSI disk to perform
SCSI IO operations.
@param Buffer The aligned buffer to be freed.
@param BufferSize The request buffer size.
**/
)
{
}
}
/**
The user Entry Point for module ScsiDisk.
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
**/
)
{
);
return Status;
}
} else {
}
}
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
**/
)
{
if (ScsiDiskDevice == NULL) {
return EFI_OUT_OF_RESOURCES;
}
);
return Status;
}
switch (ScsiDiskDevice->DeviceType) {
case EFI_SCSI_TYPE_DISK:
break;
case EFI_SCSI_TYPE_CDROM:
break;
}
//
// The Sense Data Array's initial size is 6
//
);
gBS->CloseProtocol (
);
return EFI_OUT_OF_RESOURCES;
}
//
// Retrieve device information
//
MaxRetry = 2;
break;
}
if (!NeedRetry) {
gBS->CloseProtocol (
);
return EFI_DEVICE_ERROR;
}
}
//
// The second parameter "TRUE" means must
// retrieve media capacity
//
//
// Determine if Block IO should be produced on this controller handle
//
if (DetermineInstallBlockIo(Controller)) {
);
"eng",
L"SCSI Disk Device",
);
"en",
L"SCSI Disk Device",
);
return EFI_SUCCESS;
}
}
}
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
**/
)
{
);
return Status;
}
);
gBS->CloseProtocol (
);
return EFI_SUCCESS;
}
//
// errors met
//
return Status;
}
/**
Reset SCSI Disk.
@param This The pointer of EFI_BLOCK_IO_PROTOCOL
@param ExtendedVerification The flag about if extend verificate
@retval EFI_SUCCESS The device was reset.
@retval EFI_DEVICE_ERROR The device is not functioning properly and could
not be reset.
@return EFI_STATUS is returned from EFI_SCSI_IO_PROTOCOL.ResetDevice().
**/
)
{
goto Done;
}
if (!ExtendedVerification) {
goto Done;
}
goto Done;
}
Done:
return Status;
}
/**
The function is to Read Block from SCSI Disk.
@param This The pointer of EFI_BLOCK_IO_PROTOCOL.
@param MediaId The Id of Media detected
@param Lba The logic block address
@param BufferSize The size of Buffer
@param Buffer The buffer to fill the read out data
@retval EFI_SUCCESS Successfully to read out block.
@retval EFI_DEVICE_ERROR Fail to detect media.
@retval EFI_NO_MEDIA Media is not present.
@retval EFI_MEDIA_CHANGED Media has changed.
@retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.
@retval EFI_INVALID_PARAMETER Invalid parameter passed in.
**/
)
{
MediaChange = FALSE;
if (!IS_DEVICE_FIXED(ScsiDiskDevice)) {
goto Done;
}
if (MediaChange) {
);
goto Done;
}
}
//
// Get the intrinsic block size
//
if (!(Media->MediaPresent)) {
goto Done;
}
goto Done;
}
goto Done;
}
if (BufferSize == 0) {
goto Done;
}
if (BufferSize % BlockSize != 0) {
goto Done;
}
goto Done;
}
goto Done;
}
goto Done;
}
//
// If all the parameters are valid, then perform read sectors command
// to transfer data from device to host.
//
Done:
return Status;
}
/**
The function is to Write Block to SCSI Disk.
@param This The pointer of EFI_BLOCK_IO_PROTOCOL
@param MediaId The Id of Media detected
@param Lba The logic block address
@param BufferSize The size of Buffer
@param Buffer The buffer to fill the read out data
@retval EFI_SUCCESS Successfully to read out block.
@retval EFI_WRITE_PROTECTED The device can not be written to.
@retval EFI_DEVICE_ERROR Fail to detect media.
@retval EFI_NO_MEDIA Media is not present.
@retval EFI_MEDIA_CHNAGED Media has changed.
@retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.
@retval EFI_INVALID_PARAMETER Invalid parameter passed in.
**/
)
{
MediaChange = FALSE;
if (!IS_DEVICE_FIXED(ScsiDiskDevice)) {
goto Done;
}
if (MediaChange) {
);
goto Done;
}
}
//
// Get the intrinsic block size
//
if (!(Media->MediaPresent)) {
goto Done;
}
goto Done;
}
if (BufferSize == 0) {
goto Done;
}
goto Done;
}
if (BufferSize % BlockSize != 0) {
goto Done;
}
goto Done;
}
goto Done;
}
goto Done;
}
//
// if all the parameters are valid, then perform read sectors command
// to transfer data from device to host.
//
Done:
return Status;
}
/**
Flush Block to Disk.
EFI_SUCCESS is returned directly.
@param This The pointer of EFI_BLOCK_IO_PROTOCOL
@retval EFI_SUCCESS All outstanding data was written to the device
**/
)
{
//
// return directly
//
return EFI_SUCCESS;
}
/**
Detect Device and read out capacity ,if error occurs, parse the sense key.
@param ScsiDiskDevice The pointer of SCSI_DISK_DEV
@param MustReadCapacity The flag about reading device capacity
@param MediaChange The pointer of flag indicates if media has changed
@retval EFI_DEVICE_ERROR Indicates that error occurs
@retval EFI_SUCCESS Successfully to detect media
**/
)
{
NumberOfSenseKeys = 0;
Retry = 0;
MaxRetry = 3;
*MediaChange = FALSE;
TimeoutEvt = NULL;
NULL,
NULL,
);
return Status;
}
goto EXIT;
}
//
// Sending Test_Unit cmd to poll device status.
// If the sense data shows the drive is not ready or reset before, we need poll the device status again.
// We limit the upper boundary to 120 seconds.
//
);
);
goto EXIT;
} else if (Action == ACTION_RETRY_COMMAND_LATER) {
continue;
} else {
break;
}
} else {
Retry++;
goto EXIT;
}
}
}
goto EXIT;
}
//
// ACTION_NO_ACTION: need not read capacity
// other action code: need read capacity
//
if (Action == ACTION_READ_CAPACITY) {
}
//
// either NeedReadCapacity is TRUE, or MustReadCapacity is TRUE,
// retrieve capacity via Read Capacity command
//
if (NeedReadCapacity || MustReadCapacity) {
//
// retrieve media information
//
);
//
// analyze sense key to action
//
);
//
// if Status is error, it may indicate crisis error,
// so return without retry.
//
goto EXIT;
} else if (Action == ACTION_RETRY_COMMAND_LATER) {
Retry = 0;
continue;
} else {
break;
}
} else {
Retry++;
goto EXIT;
}
}
}
goto EXIT;
}
}
//
// Media change information got from the device
//
*MediaChange = TRUE;
}
*MediaChange = TRUE;
}
*MediaChange = TRUE;
}
*MediaChange = TRUE;
}
//
// when change from no media to media present, reset the MediaId to 1.
//
} else {
//
// when no media, reset the MediaId to zero.
//
}
*MediaChange = TRUE;
}
EXIT:
if (TimeoutEvt != NULL) {
}
return Status;
}
/**
Send out Inquiry command to Device.
@param ScsiDiskDevice The pointer of SCSI_DISK_DEV
@param NeedRetry Indicates if needs try again when error happens
@retval EFI_DEVICE_ERROR Indicates that error occurs
@retval EFI_SUCCESS Successfully to detect media
**/
)
{
InquiryDataLength = sizeof (EFI_SCSI_INQUIRY_DATA);
SenseDataLength = 0;
NULL,
);
//
// no need to check HostAdapterStatus and TargetStatus
//
//
// Check whether the device supports Block Limits VPD page (0xB0)
//
SupportedVpdPages = AllocateAlignedBuffer (ScsiDiskDevice, sizeof (EFI_SCSI_SUPPORTED_VPD_PAGES_VPD_PAGE));
if (SupportedVpdPages == NULL) {
return EFI_DEVICE_ERROR;
}
SenseDataLength = 0;
NULL,
(VOID *) SupportedVpdPages,
TRUE,
);
break;
}
}
//
// Query the Block Limits VPD page
//
if (Index < PageLength) {
if (BlockLimits == NULL) {
return EFI_DEVICE_ERROR;
}
InquiryDataLength = sizeof (EFI_SCSI_BLOCK_LIMITS_VPD_PAGE);
SenseDataLength = 0;
NULL,
(VOID *) BlockLimits,
TRUE,
);
}
}
}
}
}
return EFI_SUCCESS;
} else if (Status == EFI_NOT_READY) {
return EFI_DEVICE_ERROR;
return EFI_DEVICE_ERROR;
}
//
// go ahead to check HostAdapterStatus and TargetStatus
// (EFI_TIMEOUT, EFI_DEVICE_ERROR)
//
return EFI_DEVICE_ERROR;
} else if (Status == EFI_DEVICE_ERROR) {
//
// reset the scsi channel
//
return EFI_DEVICE_ERROR;
}
if (Status == EFI_NOT_READY) {
//
// reset the scsi device
//
return EFI_DEVICE_ERROR;
} else if (Status == EFI_DEVICE_ERROR) {
return EFI_DEVICE_ERROR;
}
//
// if goes here, meant ScsiInquiryCommand() failed.
// if ScsiDiskRequestSenseKeys() succeeds at last,
// better retry ScsiInquiryCommand(). (by setting *NeedRetry = TRUE)
//
MaxRetry = 3;
);
return EFI_DEVICE_ERROR;
}
if (!*NeedRetry) {
return EFI_DEVICE_ERROR;
}
}
//
// ScsiDiskRequestSenseKeys() failed after several rounds of retry.
// set *NeedRetry = FALSE to avoid the outside caller try again.
//
return EFI_DEVICE_ERROR;
}
/**
To test device.
When Test Unit Ready command succeeds, retrieve Sense Keys via Request Sense;
When Test Unit Ready command encounters any error caused by host adapter or
target, return error without retrieving Sense Keys.
@param ScsiDiskDevice The pointer of SCSI_DISK_DEV
@param NeedRetry The pointer of flag indicates try again
@param SenseDataArray The pointer of an array of sense data
@param NumberOfSenseKeys The pointer of the number of sense data array
@retval EFI_DEVICE_ERROR Indicates that error occurs
@retval EFI_SUCCESS Successfully to test unit
**/
)
{
SenseDataLength = 0;
*NumberOfSenseKeys = 0;
//
// Parameter 3 and 4: do not require sense data, retrieve it when needed.
//
NULL,
);
//
// no need to check HostAdapterStatus and TargetStatus
//
if (Status == EFI_NOT_READY) {
return EFI_DEVICE_ERROR;
return EFI_DEVICE_ERROR;
}
//
// go ahead to check HostAdapterStatus and TargetStatus(in case of EFI_DEVICE_ERROR)
//
return EFI_DEVICE_ERROR;
} else if (Status == EFI_DEVICE_ERROR) {
//
// reset the scsi channel
//
return EFI_DEVICE_ERROR;
}
if (Status == EFI_NOT_READY) {
//
// reset the scsi device
//
return EFI_DEVICE_ERROR;
} else if (Status == EFI_DEVICE_ERROR) {
return EFI_DEVICE_ERROR;
}
MaxRetry = 3;
);
return EFI_SUCCESS;
}
if (!*NeedRetry) {
return EFI_DEVICE_ERROR;
}
}
//
// ScsiDiskRequestSenseKeys() failed after several rounds of retry.
// set *NeedRetry = FALSE to avoid the outside caller try again.
//
return EFI_DEVICE_ERROR;
}
/**
Parsing Sense Keys which got from request sense command.
@param ScsiDiskDevice The pointer of SCSI_DISK_DEV
@param SenseData The pointer of EFI_SCSI_SENSE_DATA
@param NumberOfSenseKeys The number of sense key
@param Action The pointer of action which indicates what is need to do next
@retval EFI_DEVICE_ERROR Indicates that error occurs
@retval EFI_SUCCESS Successfully to complete the parsing
**/
)
{
//
// Default is to read capacity, unless..
//
if (NumberOfSenseKeys == 0) {
}
return EFI_SUCCESS;
}
//
// No Sense Key returned from last submitted command
//
}
return EFI_SUCCESS;
}
return EFI_SUCCESS;
}
return EFI_SUCCESS;
}
return EFI_SUCCESS;
}
return EFI_DEVICE_ERROR;
}
return EFI_DEVICE_ERROR;
}
if (RetryLater) {
return EFI_SUCCESS;
}
return EFI_DEVICE_ERROR;
}
return EFI_SUCCESS;
}
/**
Send read capacity command to device and get the device parameter.
@param ScsiDiskDevice The pointer of SCSI_DISK_DEV
@param NeedRetry The pointer of flag indicates if need a retry
@param SenseDataArray The pointer of an array of sense data
@param NumberOfSenseKeys The number of sense key
@retval EFI_DEVICE_ERROR Indicates that error occurs
@retval EFI_SUCCESS Successfully to read capacity or sense data is received.
**/
)
{
if (CapacityData10 == NULL) {
return EFI_DEVICE_ERROR;
}
if (CapacityData16 == NULL) {
return EFI_DEVICE_ERROR;
}
SenseDataLength = 0;
DataLength10 = sizeof (EFI_SCSI_DISK_CAPACITY_DATA);
DataLength16 = sizeof (EFI_SCSI_DISK_CAPACITY_DATA16);
*NumberOfSenseKeys = 0;
//
// submit Read Capacity(10) Command. If it returns capacity of FFFFFFFFh,
// 16 byte command should be used to access large hard disk >2TB
//
NULL,
(VOID *) CapacityData10,
);
if ((!EFI_ERROR (CommandStatus)) && (CapacityData10->LastLba3 == 0xff) && (CapacityData10->LastLba2 == 0xff) &&
//
// use Read Capacity (16), Read (16) and Write (16) next when hard disk size > 2TB
//
//
// submit Read Capacity(16) Command to get parameter LogicalBlocksPerPhysicalBlock
// and LowestAlignedLba
//
NULL,
(VOID *) CapacityData16,
);
}
//
// no need to check HostAdapterStatus and TargetStatus
//
if (CommandStatus == EFI_SUCCESS) {
return EFI_SUCCESS;
}
if (CommandStatus == EFI_NOT_READY) {
return EFI_DEVICE_ERROR;
return EFI_DEVICE_ERROR;
}
//
// go ahead to check HostAdapterStatus and TargetStatus
// (EFI_TIMEOUT, EFI_DEVICE_ERROR, EFI_WARN_BUFFER_TOO_SMALL)
//
return EFI_DEVICE_ERROR;
} else if (Status == EFI_DEVICE_ERROR) {
//
// reset the scsi channel
//
return EFI_DEVICE_ERROR;
}
if (Status == EFI_NOT_READY) {
//
// reset the scsi device
//
return EFI_DEVICE_ERROR;
} else if (Status == EFI_DEVICE_ERROR) {
return EFI_DEVICE_ERROR;
}
//
// if goes here, meant ScsiReadCapacityCommand() failed.
// if ScsiDiskRequestSenseKeys() succeeds at last,
// better retry ScsiReadCapacityCommand(). (by setting *NeedRetry = TRUE)
//
MaxRetry = 3;
);
return EFI_SUCCESS;
}
if (!*NeedRetry) {
return EFI_DEVICE_ERROR;
}
}
//
// ScsiDiskRequestSenseKeys() failed after several rounds of retry.
// set *NeedRetry = FALSE to avoid the outside caller try again.
//
return EFI_DEVICE_ERROR;
}
/**
Check the HostAdapter status and re-interpret it in EFI_STATUS.
@param HostAdapterStatus Host Adapter status
@retval EFI_SUCCESS Host adapter is OK.
@retval EFI_TIMEOUT Timeout.
@retval EFI_NOT_READY Adapter NOT ready.
@retval EFI_DEVICE_ERROR Adapter device error.
**/
)
{
switch (HostAdapterStatus) {
return EFI_SUCCESS;
return EFI_TIMEOUT;
return EFI_NOT_READY;
return EFI_DEVICE_ERROR;
default:
return EFI_SUCCESS;
}
}
/**
Check the target status and re-interpret it in EFI_STATUS.
@param TargetStatus Target status
@retval EFI_NOT_READY Device is NOT ready.
@retval EFI_DEVICE_ERROR
@retval EFI_SUCCESS
**/
)
{
switch (TargetStatus) {
return EFI_SUCCESS;
return EFI_NOT_READY;
return EFI_DEVICE_ERROR;
break;
default:
return EFI_SUCCESS;
}
}
/**
Retrieve all sense keys from the device.
When encountering error during the process, if retrieve sense keys before
error encountered, it returns the sense keys with return status set to EFI_SUCCESS,
and NeedRetry set to FALSE; otherwize, return the proper return status.
@param ScsiDiskDevice The pointer of SCSI_DISK_DEV
@param NeedRetry The pointer of flag indicates if need a retry
@param SenseDataArray The pointer of an array of sense data
@param NumberOfSenseKeys The number of sense key
@param AskResetIfError The flag indicates if need reset when error occurs
@retval EFI_DEVICE_ERROR Indicates that error occurs
@retval EFI_SUCCESS Successfully to request sense key
**/
)
{
ZeroMem (
);
*NumberOfSenseKeys = 0;
);
} else if (Status == EFI_DEVICE_ERROR) {
if (AskResetIfError) {
}
}
if (EFI_ERROR (FallStatus)) {
if (*NumberOfSenseKeys != 0) {
return EFI_SUCCESS;
} else {
return EFI_DEVICE_ERROR;
}
}
(*NumberOfSenseKeys) += 1;
//
// no more sense key or number of sense keys exceeds predefined,
// skip the loop.
//
}
PtrSenseData += 1;
}
return EFI_SUCCESS;
}
/**
Get information from media read capacity command.
@param ScsiDiskDevice The pointer of SCSI_DISK_DEV
@param Capacity10 The pointer of EFI_SCSI_DISK_CAPACITY_DATA
@param Capacity16 The pointer of EFI_SCSI_DISK_CAPACITY_DATA16
**/
)
{
if (!ScsiDiskDevice->Cdb16Byte) {
} else {
}
}
}
}
/**
Parse Inquiry data.
@param ScsiDiskDevice The pointer of SCSI_DISK_DEV
**/
)
{
}
/**
Read sector from SCSI Disk.
@param ScsiDiskDevice The pointer of SCSI_DISK_DEV
@param Buffer The buffer to fill in the read out data
@param Lba Logic block address
@param NumberOfBlocks The number of blocks to read
@retval EFI_DEVICE_ERROR Indicates a device error.
@retval EFI_SUCCESS Operation is successful.
**/
)
{
NumberOfSenseKeys = 0;
//
// limit the data bytes that can be transferred by one Read(10) or Read(16) Command
//
if (!ScsiDiskDevice->Cdb16Byte) {
MaxBlock = 0xFFFF;
} else {
MaxBlock = 0xFFFFFFFF;
}
while (BlocksRemaining > 0) {
if (BlocksRemaining <= MaxBlock) {
if (!ScsiDiskDevice->Cdb16Byte) {
} else {
}
} else {
}
MaxRetry = 2;
if (!ScsiDiskDevice->Cdb16Byte) {
Status = ScsiDiskRead10 (
);
} else {
Status = ScsiDiskRead16 (
Lba,
);
}
break;
}
if (!NeedRetry) {
return EFI_DEVICE_ERROR;
}
}
return EFI_DEVICE_ERROR;
}
//
// actual transferred sectors
//
Lba += SectorCount;
}
return EFI_SUCCESS;
}
/**
Write sector to SCSI Disk.
@param ScsiDiskDevice The pointer of SCSI_DISK_DEV
@param Buffer The buffer of data to be written into SCSI Disk
@param Lba Logic block address
@param NumberOfBlocks The number of blocks to read
@retval EFI_DEVICE_ERROR Indicates a device error.
@retval EFI_SUCCESS Operation is successful.
**/
)
{
NumberOfSenseKeys = 0;
//
// limit the data bytes that can be transferred by one Read(10) or Read(16) Command
//
if (!ScsiDiskDevice->Cdb16Byte) {
MaxBlock = 0xFFFF;
} else {
MaxBlock = 0xFFFFFFFF;
}
while (BlocksRemaining > 0) {
if (BlocksRemaining <= MaxBlock) {
if (!ScsiDiskDevice->Cdb16Byte) {
} else {
}
} else {
}
MaxRetry = 2;
if (!ScsiDiskDevice->Cdb16Byte) {
);
} else {
Lba,
);
}
break;
}
if (!NeedRetry) {
return EFI_DEVICE_ERROR;
}
}
return EFI_DEVICE_ERROR;
}
//
// actual transferred sectors
//
Lba += SectorCount;
}
return EFI_SUCCESS;
}
/**
Submit Read(10) command.
@param ScsiDiskDevice The pointer of ScsiDiskDevice
@param NeedRetry The pointer of flag indicates if needs retry if error happens
@param SenseDataArray NOT used yet in this function
@param NumberOfSenseKeys The number of sense key
@param Timeout The time to complete the command
@param DataBuffer The buffer to fill with the read out data
@param DataLength The length of buffer
@param StartLba The start logic block address
@param SectorSize The size of sector
@return EFI_STATUS is returned by calling ScsiRead10Command().
**/
)
{
*NumberOfSenseKeys = 0;
SenseDataLength = 0;
NULL,
);
return Status;
}
/**
Submit Write(10) Command.
@param ScsiDiskDevice The pointer of ScsiDiskDevice
@param NeedRetry The pointer of flag indicates if needs retry if error happens
@param SenseDataArray NOT used yet in this function
@param NumberOfSenseKeys The number of sense key
@param Timeout The time to complete the command
@param DataBuffer The buffer to fill with the read out data
@param DataLength The length of buffer
@param StartLba The start logic block address
@param SectorSize The size of sector
@return EFI_STATUS is returned by calling ScsiWrite10Command().
**/
)
{
*NumberOfSenseKeys = 0;
SenseDataLength = 0;
NULL,
);
return Status;
}
/**
Submit Read(16) command.
@param ScsiDiskDevice The pointer of ScsiDiskDevice
@param NeedRetry The pointer of flag indicates if needs retry if error happens
@param SenseDataArray NOT used yet in this function
@param NumberOfSenseKeys The number of sense key
@param Timeout The time to complete the command
@param DataBuffer The buffer to fill with the read out data
@param DataLength The length of buffer
@param StartLba The start logic block address
@param SectorSize The size of sector
@return EFI_STATUS is returned by calling ScsiRead10Command().
**/
)
{
*NumberOfSenseKeys = 0;
SenseDataLength = 0;
NULL,
);
return Status;
}
/**
Submit Write(16) Command.
@param ScsiDiskDevice The pointer of ScsiDiskDevice
@param NeedRetry The pointer of flag indicates if needs retry if error happens
@param SenseDataArray NOT used yet in this function
@param NumberOfSenseKeys The number of sense key
@param Timeout The time to complete the command
@param DataBuffer The buffer to fill with the read out data
@param DataLength The length of buffer
@param StartLba The start logic block address
@param SectorSize The size of sector
@return EFI_STATUS is returned by calling ScsiWrite10Command().
**/
)
{
*NumberOfSenseKeys = 0;
SenseDataLength = 0;
NULL,
);
return Status;
}
/**
Check sense key to find if media presents.
@param SenseData The pointer of EFI_SCSI_SENSE_DATA
@param SenseCounts The number of sense key
@retval TRUE NOT any media
@retval FALSE Media presents
**/
)
{
//
// Sense Key is EFI_SCSI_SK_NOT_READY (0x2),
// Additional Sense Code is ASC_NO_MEDIA (0x3A)
//
}
SensePtr++;
}
return IsNoMedia;
}
/**
Parse sense key.
@param SenseData The pointer of EFI_SCSI_SENSE_DATA
@param SenseCounts The number of sense key
@retval TRUE Error
@retval FALSE NOT error
**/
)
{
case EFI_SCSI_SK_MEDIUM_ERROR:
//
// Sense Key is EFI_SCSI_SK_MEDIUM_ERROR (0x3)
//
switch (SensePtr->Addnl_Sense_Code) {
//
// fall through
//
case EFI_SCSI_ASC_MEDIA_ERR1:
//
// fall through
//
case EFI_SCSI_ASC_MEDIA_ERR2:
//
// fall through
//
case EFI_SCSI_ASC_MEDIA_ERR3:
case EFI_SCSI_ASC_MEDIA_ERR4:
break;
default:
break;
}
break;
case EFI_SCSI_SK_NOT_READY:
//
// Sense Key is EFI_SCSI_SK_NOT_READY (0x2)
//
switch (SensePtr->Addnl_Sense_Code) {
//
// Additional Sense Code is ASC_MEDIA_UPSIDE_DOWN (0x6)
//
break;
default:
break;
}
break;
default:
break;
}
SensePtr++;
}
return IsError;
}
/**
Check sense key to find if hardware error happens.
@param SenseData The pointer of EFI_SCSI_SENSE_DATA
@param SenseCounts The number of sense key
@retval TRUE Hardware error exits.
@retval FALSE NO error.
**/
)
{
//
// Sense Key is EFI_SCSI_SK_HARDWARE_ERROR (0x4)
//
}
SensePtr++;
}
return IsError;
}
/**
Check sense key to find if media has changed.
@param SenseData The pointer of EFI_SCSI_SENSE_DATA
@param SenseCounts The number of sense key
@retval TRUE Media is changed.
@retval FALSE Media is NOT changed.
**/
)
{
//
// Sense Key is EFI_SCSI_SK_UNIT_ATTENTION (0x6),
// Additional sense code is EFI_SCSI_ASC_MEDIA_CHANGE (0x28)
//
}
SensePtr++;
}
return IsMediaChanged;
}
/**
Check sense key to find if reset happens.
@param SenseData The pointer of EFI_SCSI_SENSE_DATA
@param SenseCounts The number of sense key
@retval TRUE It is reset before.
@retval FALSE It is NOT reset before.
**/
)
{
//
// Sense Key is EFI_SCSI_SK_UNIT_ATTENTION (0x6)
// Additional Sense Code is EFI_SCSI_ASC_RESET (0x29)
//
}
SensePtr++;
}
return IsResetBefore;
}
/**
Check sense key to find if the drive is ready.
@param SenseData The pointer of EFI_SCSI_SENSE_DATA
@param SenseCounts The number of sense key
@param RetryLater The flag means if need a retry
@retval TRUE Drive is ready.
@retval FALSE Drive is NOT ready.
**/
)
{
*RetryLater = FALSE;
case EFI_SCSI_SK_NOT_READY:
//
// Sense Key is EFI_SCSI_SK_NOT_READY (0x2)
//
switch (SensePtr->Addnl_Sense_Code) {
case EFI_SCSI_ASC_NOT_READY:
//
// Additional Sense Code is EFI_SCSI_ASC_NOT_READY (0x4)
//
switch (SensePtr->Addnl_Sense_Code_Qualifier) {
//
// Additional Sense Code Qualifier is
// EFI_SCSI_ASCQ_IN_PROGRESS (0x1)
//
*RetryLater = TRUE;
break;
default:
*RetryLater = FALSE;
break;
}
break;
default:
break;
}
break;
default:
break;
}
SensePtr++;
}
return IsReady;
}
/**
Check sense key to find if it has sense key.
@param SenseData - The pointer of EFI_SCSI_SENSE_DATA
@param SenseCounts - The number of sense key
@retval TRUE It has sense key.
@retval FALSE It has NOT any sense key.
**/
)
{
if (SenseCounts == 0) {
} else {
HaveSenseKey = TRUE;
}
//
// Sense Key is SK_NO_SENSE (0x0)
//
(Index == 0)) {
}
SensePtr++;
}
return HaveSenseKey;
}
/**
Release resource about disk device.
@param ScsiDiskDevice The pointer of SCSI_DISK_DEV
**/
)
{
if (ScsiDiskDevice == NULL) {
return ;
}
}
}
}
/**
Determine if Block Io should be produced.
@param ChildHandle Child Handle to retrieve Parent information.
@retval TRUE Should produce Block Io.
@retval FALSE Should not produce Block Io.
**/
)
{
//
// Firstly, check if ExtScsiPassThru Protocol parent handle exists. If existence,
// check its attribute, logic or physical.
//
ExtScsiPassThru = (EFI_EXT_SCSI_PASS_THRU_PROTOCOL *)GetParentProtocol (&gEfiExtScsiPassThruProtocolGuid, ChildHandle);
if (ExtScsiPassThru != NULL) {
return TRUE;
}
}
//
// Secondly, check if ScsiPassThru Protocol parent handle exists. If existence,
// check its attribute, logic or physical.
//
ScsiPassThru = (EFI_SCSI_PASS_THRU_PROTOCOL *)GetParentProtocol (&gEfiScsiPassThruProtocolGuid, ChildHandle);
if (ScsiPassThru != NULL) {
return TRUE;
}
}
return FALSE;
}
/**
Search protocol database and check to see if the protocol
specified by ProtocolGuid is present on a ControllerHandle and opened by
ChildHandle with an attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.
If the ControllerHandle is found, then the protocol specified by ProtocolGuid
will be opened on it.
@param ProtocolGuid ProtocolGuid pointer.
@param ChildHandle Child Handle to retrieve Parent information.
**/
VOID *
)
{
//
// Retrieve the list of all handles from the handle database
//
NULL,
);
return NULL;
}
//
// Iterate to find who is parent handle that is opened with ProtocolGuid by ChildHandle
//
return Interface;
}
}
}
return NULL;
}
/**
Provides inquiry information for the controller type.
This function is used by the IDE bus driver to get inquiry data. Data format
of Identify data is defined by the Interface GUID.
@param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.
@param[in, out] InquiryData Pointer to a buffer for the inquiry data.
@param[in, out] InquiryDataSize Pointer to the value for the inquiry data size.
@retval EFI_SUCCESS The command was accepted without any errors.
@retval EFI_NOT_FOUND Device does not support this data class
@retval EFI_DEVICE_ERROR Error reading InquiryData from device
@retval EFI_BUFFER_TOO_SMALL InquiryDataSize not big enough
**/
)
{
}
return Status;
}
/**
Provides identify information for the controller type.
This function is used by the IDE bus driver to get identify data. Data format
of Identify data is defined by the Interface GUID.
@param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL
instance.
@param[in, out] IdentifyData Pointer to a buffer for the identify data.
@param[in, out] IdentifyDataSize Pointer to the value for the identify data
size.
@retval EFI_SUCCESS The command was accepted without any errors.
@retval EFI_NOT_FOUND Device does not support this data class
@retval EFI_DEVICE_ERROR Error reading IdentifyData from device
@retval EFI_BUFFER_TOO_SMALL IdentifyDataSize not big enough
**/
)
{
//
// Physical SCSI bus does not support this data class.
//
return EFI_NOT_FOUND;
}
}
return Status;
}
/**
Provides sense data information for the controller type.
This function is used by the IDE bus driver to get sense data.
Data format of Sense data is defined by the Interface GUID.
@param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.
@param[in, out] SenseData Pointer to the SenseData.
@param[in, out] SenseDataSize Size of SenseData in bytes.
@param[out] SenseDataNumber Pointer to the value for the sense data size.
@retval EFI_SUCCESS The command was accepted without any errors.
@retval EFI_NOT_FOUND Device does not support this data class.
@retval EFI_DEVICE_ERROR Error reading SenseData from device.
@retval EFI_BUFFER_TOO_SMALL SenseDataSize not big enough.
**/
)
{
return EFI_NOT_FOUND;
}
/**
This function is used by the IDE bus driver to get controller information.
@param[in] This Pointer to the EFI_DISK_INFO_PROTOCOL instance.
@param[out] IdeChannel Pointer to the Ide Channel number. Primary or secondary.
@param[out] IdeDevice Pointer to the Ide Device number. Master or slave.
@retval EFI_SUCCESS IdeChannel and IdeDevice are valid.
@retval EFI_UNSUPPORTED This is not an IDE device.
**/
)
{
//
// This is not an IDE physical device.
//
return EFI_UNSUPPORTED;
}
return EFI_SUCCESS;
}
/**
Issues ATA IDENTIFY DEVICE command to identify ATAPI device.
This function tries to fill 512-byte ATAPI_IDENTIFY_DATA for ATAPI device to
implement Identify() interface for DiskInfo protocol. The ATA command is sent
via SCSI Request Packet.
@param ScsiDiskDevice The pointer of SCSI_DISK_DEV
@retval EFI_SUCCESS The ATAPI device identify data were retrieved successfully.
@retval others Some error occurred during the identification that ATAPI device.
**/
)
{
//
// Initialize SCSI REQUEST_PACKET and 6-byte Cdb
//
Cdb[0] = ATA_CMD_IDENTIFY_DEVICE;
}
/**
Initialize the installation of DiskInfo protocol.
This function prepares for the installation of DiskInfo protocol on the child handle.
By default, it installs DiskInfo protocol with SCSI interface GUID. If it further
@param ScsiDiskDevice The pointer of SCSI_DISK_DEV.
@param ChildHandle Child handle to install DiskInfo protocol.
**/
)
{
//
// Device Path protocol must be installed on the device handle.
//
//
// Copy the DiskInfo protocol template.
//
CopyMem (&ScsiDiskDevice->DiskInfo, &gScsiDiskInfoProtocolTemplate, sizeof (gScsiDiskInfoProtocolTemplate));
while (!IsDevicePathEnd (DevicePathNode)) {
IdentifyRetry = 3;
do {
//
// Issue ATA Identify Device Command via SCSI command, which is required to publish DiskInfo protocol
//
//
// We find the valid ATAPI device path
//
//
// Update the DiskInfo.Interface to IDE interface GUID for the physical ATAPI device.
//
} else {
//
// We find the valid SATA device path
//
//
// Update the DiskInfo.Interface to AHCI interface GUID for the physical AHCI device.
//
}
return;
}
} while (--IdentifyRetry > 0);
}
}
return;
}