UsbMassBoot.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/** @file
Implementation of the command set of USB Mass Storage Specification
for Bootability, Revision 1.0.
Copyright (c) 2007 - 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 "UsbMass.h"
/**
Execute REQUEST SENSE Command to retrieve sense data from device.
@param UsbMass The device whose sense data is requested.
@retval EFI_SUCCESS The command is excuted successfully.
@retval EFI_DEVICE_ERROR Failed to request sense.
@retval EFI_NO_RESPONSE The device media doesn't response this request.
@retval EFI_INVALID_PARAMETER The command has some invalid parameters.
@retval EFI_WRITE_PROTECTED The device is write protected.
@retval EFI_MEDIA_CHANGED The device media has been changed.
**/
)
{
//
// Request the sense data from the device
//
&SenseCmd,
sizeof (USB_BOOT_REQUEST_SENSE_CMD),
sizeof (USB_BOOT_REQUEST_SENSE_DATA),
);
}
return Status;
}
//
// If sense data is retrieved successfully, interpret the sense data
// and update the media status if necessary.
//
case USB_BOOT_SENSE_NO_SENSE:
break;
case USB_BOOT_SENSE_RECOVERED:
//
// Suppose hardware can handle this case, and recover later by itself
//
break;
case USB_BOOT_SENSE_NOT_READY:
}
break;
break;
//
// If MediaChange, reset ReadOnly and new MediaId
//
}
break;
break;
default:
break;
}
));
return Status;
}
/**
Execute the USB mass storage bootability commands.
This function executes the USB mass storage bootability commands.
If execution failed, retrieve the error by REQUEST_SENSE, then
update the device's status, such as ReadyOnly.
@param UsbMass The device to issue commands to
@param Cmd The command to execute
@param CmdLen The length of the command
@param DataDir The direction of data transfer
@param Data The buffer to hold the data
@param DataLen The length of expected data
@param Timeout The timeout used to transfer
@retval EFI_SUCCESS Command is excuted successfully
@retval Others Command execution failed.
**/
)
{
Cmd,
Data,
);
if (Status == EFI_TIMEOUT) {
return EFI_TIMEOUT;
}
//
// If ExecCommand() returns no error and CmdResult is success,
// then the commnad transfer is successful.
//
return EFI_SUCCESS;
}
//
// If command execution failed, then retrieve error info via sense request.
//
return UsbBootRequestSense (UsbMass);
}
/**
Execute the USB mass storage bootability commands with retrial.
This function executes USB mass storage bootability commands.
If the device isn't ready, wait for it. If the device is ready
and error occurs, retry the command again until it exceeds the
limit of retrial times.
@param UsbMass The device to issue commands to
@param Cmd The command to execute
@param CmdLen The length of the command
@param DataDir The direction of data transfer
@param Data The buffer to hold the data
@param DataLen The length of expected data
@param Timeout The timeout used to transfer
@retval EFI_SUCCESS The command is executed successfully.
@retval EFI_MEDIA_CHANGED The device media has been changed.
@retval Others Command execution failed after retrial.
**/
)
{
Retry = 0;
NULL,
NULL,
);
return Status;
}
goto EXIT;
}
//
// Execute the cmd and retry if it fails.
//
Status = UsbBootExecCmd (
Cmd,
Data,
);
break;
}
//
// If the sense data shows the drive is not ready, we need execute the cmd again.
// We limit the upper boundary to 60 seconds.
//
if (Status == EFI_NOT_READY) {
continue;
}
//
// If the status is other error, then just retry 5 times.
//
if (Retry++ >= USB_BOOT_COMMAND_RETRY) {
break;
}
}
EXIT:
if (TimeoutEvt != NULL) {
}
return Status;
}
/**
Execute TEST UNIT READY command to check if the device is ready.
@param UsbMass The device to test
@retval EFI_SUCCESS The device is ready.
@retval Others Device not ready.
**/
)
{
return UsbBootExecCmdWithRetry (
&TestCmd,
(UINT8) sizeof (USB_BOOT_TEST_UNIT_READY_CMD),
NULL,
0,
);
}
/**
Execute INQUIRY Command to request information regarding parameters of
the device be sent to the host computer.
@param UsbMass The device to inquire.
@retval EFI_SUCCESS INQUIRY Command is executed successfully.
@retval Others INQUIRY Command is not executed successfully.
**/
)
{
(UINT8) sizeof (USB_BOOT_INQUIRY_CMD),
sizeof (USB_BOOT_INQUIRY_DATA),
);
return Status;
}
//
// Get information from PDT (Peripheral Device Type) field and Removable Medium Bit
// from the inquiry data.
//
//
// Set block size to the default value of 512 Bytes, in case no media is present at first time.
//
return Status;
}
/**
Execute READ CAPACITY 16 bytes command to request information regarding
the capacity of the installed medium of the device.
This function executes READ CAPACITY 16 bytes command to get the capacity
of the USB mass storage media, including the presence, block size,
and last block number.
@param UsbMass The device to retireve disk gemotric.
@retval EFI_SUCCESS The disk geometry is successfully retrieved.
@retval EFI_NOT_READY The returned block size is zero.
@retval Other READ CAPACITY 16 bytes command execution failed.
**/
)
{
//
// Partial medium indicator, set the bytes 2 ~ 9 of the Cdb as ZERO.
//
(UINT8) sizeof (CapacityCmd),
sizeof (CapacityData),
);
return Status;
}
//
// Get the information on media presence, block size, and last block number
// from READ CAPACITY data.
//
if (BlockSize == 0) {
//
// Get sense data
//
return UsbBootRequestSense (UsbMass);
} else {
}
return Status;
}
/**
Execute READ CAPACITY command to request information regarding
the capacity of the installed medium of the device.
This function executes READ CAPACITY command to get the capacity
of the USB mass storage media, including the presence, block size,
and last block number.
@param UsbMass The device to retireve disk gemotric.
@retval EFI_SUCCESS The disk geometry is successfully retrieved.
@retval EFI_NOT_READY The returned block size is zero.
@retval Other READ CAPACITY command execution failed.
**/
)
{
(UINT8) sizeof (USB_BOOT_READ_CAPACITY_CMD),
sizeof (USB_BOOT_READ_CAPACITY_DATA),
);
return Status;
}
//
// Get the information on media presence, block size, and last block number
// from READ CAPACITY data.
//
if (BlockSize == 0) {
//
// Get sense data
//
return UsbBootRequestSense (UsbMass);
} else {
}
}
}
return Status;
}
/**
Retrieves SCSI mode sense information via MODE SENSE(6) command.
@param UsbMass The device whose sense data is requested.
@retval EFI_SUCCESS SCSI mode sense information retrieved successfully.
@retval Other Command execution failed.
**/
)
{
//
// MODE SENSE(6) command is defined in Section 8.2.10 of SCSI-2 Spec
//
(UINT8) sizeof (USB_SCSI_MODE_SENSE6_CMD),
sizeof (USB_SCSI_MODE_SENSE6_PARA_HEADER),
);
//
// Format of device-specific parameter byte of the mode parameter header is defined in
// Section 8.2.10 of SCSI-2 Spec.
// BIT7 of this byte is indicates whether the medium is write protected.
//
}
return Status;
}
/**
Get the parameters for the USB mass storage media.
This function get the parameters for the USB mass storage media,
It is used both to initialize the media during the Start() phase
of Driver Binding Protocol and to re-initialize it when the media is
changed. Althought the RemoveableMedia is unlikely to change,
it is also included here.
@param UsbMass The device to retrieve disk gemotric.
@retval EFI_SUCCESS The disk gemotric is successfully retrieved.
@retval Other Failed to get the parameters.
**/
)
{
return Status;
}
//
// Don't use the Removable bit in inquiry data to test whether the media
// is removable because many flash disks wrongly set this bit.
//
//
// CD-Rom device and Non-CD optical device
//
//
// Default value 2048 Bytes, in case no media present at first time
//
}
return Status;
}
/**
Detect whether the removable media is present and whether it has changed.
@param UsbMass The device to check.
@retval EFI_SUCCESS The media status is successfully checked.
@retval Other Failed to detect media.
**/
)
{
goto ON_ERROR;
}
//
// MODE SENSE is required for the device with PDT of 0x00/0x07/0x0E,
// according to Section 4 of USB Mass Storage Specification for Bootability.
// MODE SENSE(10) is useless here, while MODE SENSE(6) defined in SCSI
// could get the information of Write Protected.
// Since not all device support this command, skip if fail.
//
}
goto ON_ERROR;
}
return EFI_SUCCESS;
//
// Detect whether it is necessary to reinstall the Block I/O Protocol.
//
// MediaId may change in RequestSense for MediaChanged
// MediaPresent may change in RequestSense for NoMedia
// MediaReadOnly may change in RequestSense for WriteProtected or MediaChanged
// MediaPresent/BlockSize/LastBlock may change in ReadCapacity
//
//
// This function is called by Block I/O Protocol APIs, which run at TPL_NOTIFY.
// Here we temporarily restore TPL to TPL_CALLBACK to invoke ReinstallProtocolInterface().
//
OldTpl = EfiGetCurrentTpl ();
);
//
// Update MediaId after reinstalling Block I/O Protocol.
//
if (Media->MediaPresent) {
} else {
}
}
}
}
return Status;
}
/**
Read some blocks from the device.
@param UsbMass The USB mass storage device to read from
@param Lba The start block number
@param TotalBlock Total block number to read
@param Buffer The buffer to read to
@retval EFI_SUCCESS Data are read into the buffer
@retval Others Failed to read all the data
**/
)
{
while (TotalBlock > 0) {
//
// Split the total blocks into smaller pieces to ease the pressure
// on the device. We must split the total block because the READ10
// command only has 16 bit transfer length (in the unit of block).
//
//
// USB command's upper limit timeout is 5s. [USB2.0-9.2.6.1]
//
//
// Fill in the command then execute
//
&ReadCmd,
(UINT8) sizeof (USB_BOOT_READ10_CMD),
);
return Status;
}
TotalBlock -= Count;
}
return Status;
}
/**
Write some blocks to the device.
@param UsbMass The USB mass storage device to write to
@param Lba The start block number
@param TotalBlock Total block number to write
@param Buffer Pointer to the source buffer for the data.
@retval EFI_SUCCESS Data are written into the buffer
@retval Others Failed to write all the data
**/
)
{
while (TotalBlock > 0) {
//
// Split the total blocks into smaller pieces to ease the pressure
// on the device. We must split the total block because the WRITE10
// command only has 16 bit transfer length (in the unit of block).
//
//
// USB command's upper limit timeout is 5s. [USB2.0-9.2.6.1]
//
//
// Fill in the write10 command block
//
&WriteCmd,
(UINT8) sizeof (USB_BOOT_WRITE10_CMD),
);
return Status;
}
TotalBlock -= Count;
}
return Status;
}
/**
Read some blocks from the device by SCSI 16 byte cmd.
@param UsbMass The USB mass storage device to read from
@param Lba The start block number
@param TotalBlock Total block number to read
@param Buffer The buffer to read to
@retval EFI_SUCCESS Data are read into the buffer
@retval Others Failed to read all the data
**/
)
{
while (TotalBlock > 0) {
//
// Split the total blocks into smaller pieces.
//
//
// USB command's upper limit timeout is 5s. [USB2.0-9.2.6.1]
//
//
// Fill in the command then execute
//
ReadCmd[0] = EFI_SCSI_OP_READ16;
);
return Status;
}
TotalBlock -= Count;
}
return Status;
}
/**
Write some blocks to the device by SCSI 16 byte cmd.
@param UsbMass The USB mass storage device to write to
@param Lba The start block number
@param TotalBlock Total block number to write
@param Buffer Pointer to the source buffer for the data.
@retval EFI_SUCCESS Data are written into the buffer
@retval Others Failed to write all the data
**/
)
{
while (TotalBlock > 0) {
//
// Split the total blocks into smaller pieces.
//
//
// USB command's upper limit timeout is 5s. [USB2.0-9.2.6.1]
//
//
// Fill in the write16 command block
//
WriteCmd[0] = EFI_SCSI_OP_WRITE16;
);
return Status;
}
TotalBlock -= Count;
}
return Status;
}
/**
Use the USB clear feature control transfer to clear the endpoint stall condition.
@param UsbIo The USB I/O Protocol instance
@param EndpointAddr The endpoint to clear stall for
@retval EFI_SUCCESS The endpoint stall condition is cleared.
@retval Others Failed to clear the endpoint stall condition.
**/
)
{
&Request,
NULL,
0,
);
return Status;
}