/** @file\r
+ Implementation of the command set of USB Mass Storage Specification\r
+ for Bootability, Revision 1.0.\r
\r
-Copyright (c) 2007, Intel Corporation\r
+Copyright (c) 2007 - 2010, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
-Module Name:\r
-\r
- UsbMassBoot.c\r
-\r
-Abstract:\r
-\r
- This file implement the command set of "USB Mass Storage Specification\r
- for Bootability".\r
-\r
-Revision History\r
-\r
-\r
**/\r
\r
#include "UsbMassImpl.h"\r
\r
-\r
-/**\r
- Read an UINT32 from the buffer to avoid byte alignment problems, then\r
- convert that to the little endia. The USB mass storage bootability spec\r
- use big endia\r
-\r
- @param Buf The buffer contains the first byte of the UINT32\r
- in big endia.\r
-\r
- @return The UINT32 value read from the buffer in little endia.\r
-\r
-**/\r
-STATIC\r
-UINT32\r
-UsbBootGetUint32 (\r
- IN UINT8 *Buf\r
- )\r
-{\r
- UINT32 Value;\r
-\r
- CopyMem (&Value, Buf, sizeof (UINT32));\r
- return USB_BOOT_SWAP32 (Value);\r
-}\r
-\r
-\r
/**\r
- Put an UINT32 in little endia to the buffer. The data is converted to\r
- big endia before writing.\r
+ Execute REQUEST SENSE Command to retrieve sense data from device.\r
\r
- @param Buf The buffer to write data to\r
- @param Data32 The data to write.\r
+ @param UsbMass The device whose sense data is requested.\r
\r
- @return None\r
-\r
-**/\r
-STATIC\r
-VOID\r
-UsbBootPutUint32 (\r
- IN UINT8 *Buf,\r
- IN UINT32 Data32\r
- )\r
-{\r
- Data32 = USB_BOOT_SWAP32 (Data32);\r
- CopyMem (Buf, &Data32, sizeof (UINT32));\r
-}\r
-\r
-\r
-/**\r
- Put an UINT16 in little endia to the buffer. The data is converted to\r
- big endia before writing.\r
-\r
- @param Buf The buffer to write data to\r
- @param Data16 The data to write\r
-\r
- @return None\r
-\r
-**/\r
-STATIC\r
-VOID\r
-UsbBootPutUint16 (\r
- IN UINT8 *Buf,\r
- IN UINT16 Data16\r
- )\r
-{\r
- Data16 = USB_BOOT_SWAP16 (Data16);\r
- CopyMem (Buf, &Data16, sizeof (UINT16));\r
-}\r
-\r
-\r
-/**\r
- Request sense information via sending Request Sense\r
- Packet Command.\r
-\r
- @param UsbMass The device to be requested sense data\r
-\r
- @retval EFI_DEVICE_ERROR Hardware error\r
- @retval EFI_SUCCESS Success\r
+ @retval EFI_SUCCESS The command is excuted successfully.\r
+ @retval EFI_DEVICE_ERROR Failed to request sense.\r
+ @retval EFI_NO_RESPONSE The device media doesn't response this request.\r
+ @retval EFI_INVALID_PARAMETER The command has some invalid parameters.\r
+ @retval EFI_WRITE_PROTECTED The device is write protected.\r
+ @retval EFI_MEDIA_CHANGED The device media has been changed.\r
\r
**/\r
EFI_STATUS\r
Transport = UsbMass->Transport;\r
\r
//\r
- // Request the sense data from the device if command failed\r
+ // Request the sense data from the device\r
//\r
ZeroMem (&SenseCmd, sizeof (USB_BOOT_REQUEST_SENSE_CMD));\r
ZeroMem (&SenseData, sizeof (USB_BOOT_REQUEST_SENSE_DATA));\r
\r
SenseCmd.OpCode = USB_BOOT_REQUEST_SENSE_OPCODE;\r
- SenseCmd.Lun = USB_BOOT_LUN (UsbMass->Lun);\r
+ SenseCmd.Lun = (UINT8) (USB_BOOT_LUN (UsbMass->Lun));\r
SenseCmd.AllocLen = sizeof (USB_BOOT_REQUEST_SENSE_DATA);\r
\r
Status = Transport->ExecCommand (\r
EfiUsbDataIn,\r
&SenseData,\r
sizeof (USB_BOOT_REQUEST_SENSE_DATA),\r
+ UsbMass->Lun,\r
USB_BOOT_GENERAL_CMD_TIMEOUT,\r
&CmdResult\r
);\r
if (EFI_ERROR (Status) || CmdResult != USB_MASS_CMD_SUCCESS) {\r
- DEBUG ((mUsbMscError, "UsbBootRequestSense: (%r) CmdResult=0x%x\n", Status, CmdResult));\r
- return EFI_DEVICE_ERROR;\r
+ DEBUG ((EFI_D_ERROR, "UsbBootRequestSense: (%r) CmdResult=0x%x\n", Status, CmdResult));\r
+ if (!EFI_ERROR (Status)) {\r
+ Status = EFI_DEVICE_ERROR;\r
+ }\r
+ return Status;\r
}\r
\r
//\r
- // Interpret the sense data and update the media status if necessary.\r
+ // If sense data is retrieved successfully, interpret the sense data\r
+ // and update the media status if necessary.\r
//\r
Media = &UsbMass->BlockIoMedia;\r
\r
switch (USB_BOOT_SENSE_KEY (SenseData.SenseKey)) {\r
\r
case USB_BOOT_SENSE_NO_SENSE:\r
+ Status = EFI_NO_RESPONSE;\r
+ break;\r
+\r
case USB_BOOT_SENSE_RECOVERED:\r
//\r
// Suppose hardware can handle this case, and recover later by itself\r
break;\r
\r
case USB_BOOT_SENSE_NOT_READY:\r
- switch (SenseData.ASC) {\r
- case USB_BOOT_ASC_NO_MEDIA:\r
- Status = EFI_NO_MEDIA;\r
- Media->MediaPresent = FALSE;\r
- break;\r
-\r
- case USB_BOOT_ASC_MEDIA_UPSIDE_DOWN:\r
- Status = EFI_DEVICE_ERROR;\r
+ Status = EFI_DEVICE_ERROR;\r
+ if (SenseData.Asc == USB_BOOT_ASC_NO_MEDIA) {\r
Media->MediaPresent = FALSE;\r
- break;\r
-\r
- case USB_BOOT_ASC_NOT_READY:\r
- if (SenseData.ASCQ == USB_BOOT_ASCQ_IN_PROGRESS ||\r
- SenseData.ASCQ == USB_BOOT_ASCQ_DEVICE_BUSY) {\r
- //\r
- // Regular timeout, and need retry once more\r
- //\r
- DEBUG ((mUsbMscInfo, "UsbBootRequestSense: Not ready and need retry once more\n"));\r
- Status = EFI_NOT_READY;\r
- }\r
+ Status = EFI_NO_MEDIA;\r
+ } else if (SenseData.Asc == USB_BOOT_ASC_NOT_READY) {\r
+ Status = EFI_NOT_READY;\r
}\r
break;\r
\r
\r
case USB_BOOT_SENSE_UNIT_ATTENTION:\r
Status = EFI_DEVICE_ERROR;\r
- if (SenseData.ASC == USB_BOOT_ASC_MEDIA_CHANGE) {\r
+ if (SenseData.Asc == USB_BOOT_ASC_MEDIA_CHANGE) {\r
+ //\r
+ // If MediaChange, reset ReadOnly and new MediaId\r
+ //\r
Status = EFI_MEDIA_CHANGED;\r
- UsbMass->BlockIoMedia.MediaId++;\r
+ Media->ReadOnly = FALSE;\r
+ Media->MediaId++;\r
}\r
break;\r
\r
- case USB_BOOT_SNESE_DATA_PROTECT:\r
- Status = EFI_WRITE_PROTECTED;\r
- UsbMass->BlockIoMedia.ReadOnly = TRUE;\r
+ case USB_BOOT_SENSE_DATA_PROTECT:\r
+ Status = EFI_WRITE_PROTECTED;\r
+ Media->ReadOnly = TRUE;\r
break;\r
\r
default:\r
break;\r
}\r
\r
- DEBUG ((mUsbMscInfo, "UsbBootRequestSense: (%r) with sense key %x/%x/%x\n",\r
+ DEBUG ((EFI_D_INFO, "UsbBootRequestSense: (%r) with sense key %x/%x/%x\n",\r
Status,\r
USB_BOOT_SENSE_KEY (SenseData.SenseKey),\r
- SenseData.ASC,\r
- SenseData.ASCQ\r
+ SenseData.Asc,\r
+ SenseData.Ascq\r
));\r
\r
return Status;\r
\r
\r
/**\r
- Execute the USB mass storage bootability commands. If execution\r
- failed, retrieve the error by REQUEST_SENSE then update the device's\r
- status, such as ReadyOnly.\r
+ Execute the USB mass storage bootability commands.\r
+\r
+ This function executes the USB mass storage bootability commands.\r
+ If execution failed, retrieve the error by REQUEST_SENSE, then\r
+ update the device's status, such as ReadyOnly.\r
\r
@param UsbMass The device to issue commands to\r
@param Cmd The command to execute\r
@param DataLen The length of expected data\r
@param Timeout The timeout used to transfer\r
\r
- @retval EFI_SUCCESS The command is excuted OK\r
- @retval EFI_DEVICE_ERROR Failed to request sense\r
- @retval EFI_INVALID_PARAMETER The command has some invalid parameters\r
- @retval EFI_WRITE_PROTECTED The device is write protected\r
- @retval EFI_MEDIA_CHANGED The device media has been changed\r
+ @retval EFI_SUCCESS Command is excuted successfully\r
+ @retval Others Command execution failed.\r
\r
**/\r
-STATIC\r
EFI_STATUS\r
UsbBootExecCmd (\r
IN USB_MASS_DEVICE *UsbMass,\r
DataDir,\r
Data,\r
DataLen,\r
+ UsbMass->Lun,\r
Timeout,\r
&CmdResult\r
);\r
//\r
- // ExecCommand return success and get the right CmdResult means\r
- // the commnad transfer is OK.\r
+ // If ExecCommand() returns no error and CmdResult is success,\r
+ // then the commnad transfer is successful.\r
//\r
- if ((CmdResult == USB_MASS_CMD_SUCCESS) && !EFI_ERROR(Status)) {\r
+ if ((CmdResult == USB_MASS_CMD_SUCCESS) && !EFI_ERROR (Status)) {\r
return EFI_SUCCESS;\r
}\r
\r
+ DEBUG ((EFI_D_INFO, "UsbBootExecCmd: Fail to Exec 0x%x Cmd /w %r\n",\r
+ *(UINT8 *)Cmd ,Status));\r
+\r
+ //\r
+ // If command execution failed, then retrieve error info via sense request.\r
+ //\r
return UsbBootRequestSense (UsbMass);\r
}\r
\r
\r
/**\r
- Execute the USB mass storage bootability commands. If execution\r
- failed, retrieve the error by REQUEST_SENSE then update the device's\r
- status, such as ReadyOnly.\r
+ Execute the USB mass storage bootability commands with retrial.\r
\r
+ This function executes USB mass storage bootability commands.\r
+ If the device isn't ready, wait for it. If the device is ready\r
+ and error occurs, retry the command again until it exceeds the\r
+ limit of retrial times.\r
+ \r
@param UsbMass The device to issue commands to\r
@param Cmd The command to execute\r
@param CmdLen The length of the command\r
@param DataDir The direction of data transfer\r
@param Data The buffer to hold the data\r
@param DataLen The length of expected data\r
+ @param Timeout The timeout used to transfer\r
\r
- @retval EFI_SUCCESS The command is excuted OK\r
- @retval EFI_DEVICE_ERROR Failed to request sense\r
- @retval EFI_INVALID_PARAMETER The command has some invalid parameters\r
- @retval EFI_WRITE_PROTECTED The device is write protected\r
- @retval EFI_MEDIA_CHANGED The device media has been changed\r
+ @retval EFI_SUCCESS The command is executed successfully.\r
+ @retval EFI_MEDIA_CHANGED The device media has been changed.\r
+ @retval Others Command execution failed after retrial.\r
\r
**/\r
-STATIC\r
EFI_STATUS\r
UsbBootExecCmdWithRetry (\r
IN USB_MASS_DEVICE *UsbMass,\r
)\r
{\r
EFI_STATUS Status;\r
- INT16 Index;\r
+ UINTN Retry;\r
+ UINT8 Terminate;\r
\r
- //\r
- // If the device isn't ready, wait some time. If the device is ready,\r
- // retry the command again.\r
- //\r
Status = EFI_SUCCESS;\r
\r
- for (Index = 0; Index < USB_BOOT_COMMAND_RETRY; Index++) {\r
- //\r
- // Execute the command with an increasingly larger timeout value.\r
- //\r
+ for (Retry = 0, Terminate = 0; Retry < USB_BOOT_COMMAND_RETRY; Retry++) {\r
Status = UsbBootExecCmd (\r
UsbMass,\r
Cmd,\r
DataDir,\r
Data,\r
DataLen,\r
- Timeout * (Index + 1)\r
+ Timeout\r
);\r
- if (Status == EFI_SUCCESS ||\r
- Status == EFI_MEDIA_CHANGED) {\r
+ if (Status == EFI_SUCCESS || Status == EFI_MEDIA_CHANGED) {\r
break;\r
}\r
//\r
- // Need retry once more, so reset index\r
+ // If the device isn't ready, just wait for it without limit on retrial times.\r
//\r
- if (Status == EFI_NOT_READY) {\r
- Index = 0;\r
+ if (Status == EFI_NOT_READY && Terminate < 3) {\r
+ Retry = 0;\r
+ Terminate++;\r
}\r
}\r
\r
}\r
\r
\r
-\r
/**\r
- Use the TEST UNIT READY command to check whether it is ready.\r
- If it is ready, update the parameters.\r
+ Execute TEST UNIT READY command to check if the device is ready.\r
\r
@param UsbMass The device to test\r
\r
- @retval EFI_SUCCESS The device is ready and parameters are updated.\r
+ @retval EFI_SUCCESS The device is ready.\r
@retval Others Device not ready.\r
\r
**/\r
ZeroMem (&TestCmd, sizeof (USB_BOOT_TEST_UNIT_READY_CMD));\r
\r
TestCmd.OpCode = USB_BOOT_TEST_UNIT_READY_OPCODE;\r
- TestCmd.Lun = USB_BOOT_LUN (UsbMass->Lun);\r
+ TestCmd.Lun = (UINT8) (USB_BOOT_LUN (UsbMass->Lun));\r
\r
return UsbBootExecCmdWithRetry (\r
UsbMass,\r
\r
\r
/**\r
- Inquiry Command requests that information regrarding parameters of\r
- the Device be sent to the Host.\r
+ Execute INQUIRY Command to request information regarding parameters of\r
+ the device be sent to the host computer.\r
\r
- @param UsbMass The device to inquiry.\r
+ @param UsbMass The device to inquire.\r
\r
- @retval EFI_SUCCESS The device is ready and parameters are updated.\r
- @retval Others Device not ready.\r
+ @retval EFI_SUCCESS INQUIRY Command is executed successfully.\r
+ @retval Others INQUIRY Command is not executed successfully.\r
\r
**/\r
EFI_STATUS\r
\r
Media = &(UsbMass->BlockIoMedia);\r
\r
- //\r
- // Use the Inquiry command to get the RemovableMedia setting.\r
- //\r
ZeroMem (&InquiryCmd, sizeof (USB_BOOT_INQUIRY_CMD));\r
ZeroMem (&InquiryData, sizeof (USB_BOOT_INQUIRY_DATA));\r
\r
InquiryCmd.OpCode = USB_BOOT_INQUIRY_OPCODE;\r
- InquiryCmd.Lun = USB_BOOT_LUN (UsbMass->Lun);\r
+ InquiryCmd.Lun = (UINT8) (USB_BOOT_LUN (UsbMass->Lun));\r
InquiryCmd.AllocLen = sizeof (InquiryData);\r
\r
Status = UsbBootExecCmdWithRetry (\r
EfiUsbDataIn,\r
&InquiryData,\r
sizeof (USB_BOOT_INQUIRY_DATA),\r
- USB_BOOT_INQUIRY_CMD_TIMEOUT\r
+ USB_BOOT_GENERAL_CMD_TIMEOUT\r
);\r
if (EFI_ERROR (Status)) {\r
return Status;\r
}\r
\r
- UsbMass->Pdt = USB_BOOT_PDT (InquiryData.Pdt);\r
- Media->RemovableMedia = USB_BOOT_REMOVABLE (InquiryData.Removable);\r
//\r
- // Default value 512 Bytes, in case no media present at first time\r
+ // Get information from PDT (Peripheral Device Type) field and Removable Medium Bit\r
+ // from the inquiry data.\r
+ //\r
+ UsbMass->Pdt = (UINT8) (USB_BOOT_PDT (InquiryData.Pdt));\r
+ Media->RemovableMedia = (BOOLEAN) (USB_BOOT_REMOVABLE (InquiryData.Removable));\r
+ //\r
+ // Set block size to the default value of 512 Bytes, in case no media is present at first time.\r
//\r
Media->BlockSize = 0x0200;\r
\r
\r
\r
/**\r
- Get the capacity of the USB mass storage media, including\r
- the presentation, block size, and last block number. This\r
- function is used to get the disk parameters at the start if\r
- it is a non-removable media or to detect the media if it is\r
- removable.\r
+ Execute READ CAPACITY command to request information regarding\r
+ the capacity of the installed medium of the device.\r
\r
- @param UsbMass The device to retireve disk gemotric.\r
+ This function executes READ CAPACITY command to get the capacity\r
+ of the USB mass storage media, including the presence, block size,\r
+ and last block number.\r
\r
- @retval EFI_SUCCESS The disk gemotric is successfully retrieved.\r
- @retval EFI_DEVICE_ERROR Something is inconsistent with the disk gemotric.\r
+ @param UsbMass The device to retireve disk gemotric.\r
\r
+ @retval EFI_SUCCESS The disk geometry is successfully retrieved.\r
+ @retval EFI_NOT_READY The returned block size is zero.\r
+ @retval Other READ CAPACITY command execution failed.\r
+ \r
**/\r
EFI_STATUS\r
UsbBootReadCapacity (\r
USB_BOOT_READ_CAPACITY_DATA CapacityData;\r
EFI_BLOCK_IO_MEDIA *Media;\r
EFI_STATUS Status;\r
+ UINT32 BlockSize;\r
\r
Media = &UsbMass->BlockIoMedia;\r
\r
- //\r
- // Use the READ CAPACITY command to get the block length and last blockno\r
- //\r
ZeroMem (&CapacityCmd, sizeof (USB_BOOT_READ_CAPACITY_CMD));\r
ZeroMem (&CapacityData, sizeof (USB_BOOT_READ_CAPACITY_DATA));\r
\r
CapacityCmd.OpCode = USB_BOOT_READ_CAPACITY_OPCODE;\r
- CapacityCmd.Lun = USB_BOOT_LUN (UsbMass->Lun);\r
+ CapacityCmd.Lun = (UINT8) (USB_BOOT_LUN (UsbMass->Lun));\r
\r
Status = UsbBootExecCmdWithRetry (\r
UsbMass,\r
return Status;\r
}\r
\r
+ //\r
+ // Get the information on media presence, block size, and last block number\r
+ // from READ CAPACITY data.\r
+ //\r
Media->MediaPresent = TRUE;\r
- Media->LastBlock = UsbBootGetUint32 (CapacityData.LastLba);\r
- Media->BlockSize = UsbBootGetUint32 (CapacityData.BlockLen);\r
+ Media->LastBlock = SwapBytes32 (ReadUnaligned32 ((CONST UINT32 *) CapacityData.LastLba));\r
+\r
+ BlockSize = SwapBytes32 (ReadUnaligned32 ((CONST UINT32 *) CapacityData.BlockLen));\r
+ if (BlockSize == 0) {\r
+ //\r
+ // Get sense data \r
+ //\r
+ return UsbBootRequestSense (UsbMass);\r
+ } else {\r
+ Media->BlockSize = BlockSize;\r
+ }\r
\r
- DEBUG ((mUsbMscInfo, "UsbBootReadCapacity Success LBA=%d BlockSize=%d\n",\r
- Media->LastBlock, Media->BlockSize));\r
+ DEBUG ((EFI_D_INFO, "UsbBootReadCapacity Success LBA=%ld BlockSize=%d\n",\r
+ Media->LastBlock, Media->BlockSize));\r
\r
- return EFI_SUCCESS;\r
+ return Status;\r
}\r
\r
-\r
/**\r
- Retrieves mode sense information via sending Mode Sense\r
- Packet Command.\r
+ Retrieves SCSI mode sense information via MODE SENSE(6) command.\r
\r
- @param UsbMass The USB_FLOPPY_DEV instance.\r
+ @param UsbMass The device whose sense data is requested.\r
\r
- @retval EFI_DEVICE_ERROR Hardware error\r
- @retval EFI_SUCCESS Success\r
+ @retval EFI_SUCCESS SCSI mode sense information retrieved successfully.\r
+ @retval Other Command execution failed.\r
\r
**/\r
EFI_STATUS\r
-UsbBootModeSense (\r
+UsbScsiModeSense (\r
IN USB_MASS_DEVICE *UsbMass\r
)\r
{\r
- EFI_STATUS Status;\r
- USB_BOOT_MODE_SENSE_CMD ModeSenseCmd;\r
- USB_BOOT_MODE_PARA_HEADER ModeParaHeader;\r
- UINT8 CommandSet;\r
+ EFI_STATUS Status;\r
+ USB_SCSI_MODE_SENSE6_CMD ModeSenseCmd;\r
+ USB_SCSI_MODE_SENSE6_PARA_HEADER ModeParaHeader;\r
+ EFI_BLOCK_IO_MEDIA *Media;\r
+\r
+ Media = &UsbMass->BlockIoMedia;\r
\r
- ZeroMem (&ModeSenseCmd, sizeof (USB_BOOT_MODE_SENSE_CMD));\r
- ZeroMem (&ModeParaHeader, sizeof (USB_BOOT_MODE_PARA_HEADER));\r
+ ZeroMem (&ModeSenseCmd, sizeof (USB_SCSI_MODE_SENSE6_CMD));\r
+ ZeroMem (&ModeParaHeader, sizeof (USB_SCSI_MODE_SENSE6_PARA_HEADER));\r
\r
//\r
- // overuse Context Pointer, the first field of Bot or Cbi is EFI_USB_INTERFACE_DESCRIPTOR\r
+ // MODE SENSE(6) command is defined in Section 8.2.10 of SCSI-2 Spec\r
//\r
- CommandSet = ((EFI_USB_INTERFACE_DESCRIPTOR *) (UsbMass->Context))->InterfaceSubClass;\r
-\r
- if (CommandSet == USB_MASS_STORE_SCSI) {\r
- //\r
- // Not UFI Command Set, no ModeSense Command\r
- //\r
- return EFI_SUCCESS;\r
- }\r
-\r
- ModeSenseCmd.OpCode = USB_BOOT_MODE_SENSE10_OPCODE;\r
- ModeSenseCmd.PageCode = 0x3f;\r
- ModeSenseCmd.ParaListLenLsb = (UINT8) sizeof (USB_BOOT_MODE_PARA_HEADER);\r
+ ModeSenseCmd.OpCode = USB_SCSI_MODE_SENSE6_OPCODE;\r
+ ModeSenseCmd.Lun = (UINT8) USB_BOOT_LUN (UsbMass->Lun);\r
+ ModeSenseCmd.PageCode = 0x3F;\r
+ ModeSenseCmd.AllocateLen = (UINT8) sizeof (USB_SCSI_MODE_SENSE6_PARA_HEADER);\r
\r
Status = UsbBootExecCmdWithRetry (\r
UsbMass,\r
&ModeSenseCmd,\r
- sizeof (USB_BOOT_MODE_SENSE_CMD),\r
+ sizeof (USB_SCSI_MODE_SENSE6_CMD),\r
EfiUsbDataIn,\r
&ModeParaHeader,\r
- sizeof (USB_BOOT_MODE_PARA_HEADER),\r
+ sizeof (USB_SCSI_MODE_SENSE6_PARA_HEADER),\r
USB_BOOT_GENERAL_CMD_TIMEOUT\r
);\r
+\r
//\r
- // Did nothing with the Header here\r
- // But probably should\r
+ // Format of device-specific parameter byte of the mode parameter header is defined in\r
+ // Section 8.2.10 of SCSI-2 Spec.\r
+ // BIT7 of this byte is indicates whether the medium is write protected.\r
//\r
+ if (!EFI_ERROR (Status)) {\r
+ Media->ReadOnly = (BOOLEAN) ((ModeParaHeader.DevicePara & BIT7) != 0);\r
+ }\r
\r
return Status;\r
}\r
\r
\r
/**\r
- Get the parameters for the USB mass storage media, including\r
- the RemovableMedia, block size, and last block number. This\r
- function is used both to initialize the media during the\r
- DriverBindingStart and to re-initialize it when the media is\r
+ Get the parameters for the USB mass storage media.\r
+\r
+ This function get the parameters for the USB mass storage media,\r
+ It is used both to initialize the media during the Start() phase\r
+ of Driver Binding Protocol and to re-initialize it when the media is\r
changed. Althought the RemoveableMedia is unlikely to change,\r
- I include it here.\r
+ it is also included here.\r
\r
- @param UsbMass The device to retireve disk gemotric.\r
+ @param UsbMass The device to retrieve disk gemotric.\r
\r
@retval EFI_SUCCESS The disk gemotric is successfully retrieved.\r
- @retval EFI_DEVICE_ERROR Something is inconsistent with the disk gemotric.\r
+ @retval Other Failed to get the parameters.\r
\r
**/\r
EFI_STATUS\r
{\r
EFI_BLOCK_IO_MEDIA *Media;\r
EFI_STATUS Status;\r
+ UINT8 CmdSet;\r
+\r
+ Media = &(UsbMass->BlockIoMedia);\r
+ CmdSet = ((EFI_USB_INTERFACE_DESCRIPTOR *) (UsbMass->Context))->InterfaceSubClass;\r
\r
Status = UsbBootInquiry (UsbMass);\r
if (EFI_ERROR (Status)) {\r
- DEBUG ((mUsbMscError, "UsbBootGetParams: UsbBootInquiry (%r)\n", Status));\r
+ DEBUG ((EFI_D_ERROR, "UsbBootGetParams: UsbBootInquiry (%r)\n", Status));\r
return Status;\r
}\r
\r
- Media = &(UsbMass->BlockIoMedia);\r
//\r
- // Don't use the Removable bit in inquirydata to test whether the media\r
+ // Don't use the Removable bit in inquiry data to test whether the media\r
// is removable because many flash disks wrongly set this bit.\r
//\r
if ((UsbMass->Pdt == USB_PDT_CDROM) || (UsbMass->Pdt == USB_PDT_OPTICAL)) {\r
//\r
- // CD-Rom or Optical device\r
+ // CD-Rom device and Non-CD optical device\r
//\r
UsbMass->OpticalStorage = TRUE;\r
//\r
// Default value 2048 Bytes, in case no media present at first time\r
//\r
Media->BlockSize = 0x0800;\r
- } else {\r
+ }\r
+\r
+ if ((UsbMass->Pdt != USB_PDT_CDROM) && (CmdSet == USB_MASS_STORE_SCSI)) {\r
//\r
- // Non CD-Rom device need ModeSenseCmd between InquiryCmd and ReadCapacityCmd\r
+ // ModeSense is required for the device with PDT of 0x00/0x07/0x0E,\r
+ // which is from [MassStorageBootabilitySpec-Page7].\r
+ // ModeSense(10) is useless here, while ModeSense(6) defined in SCSI\r
+ // could get the information of WriteProtected.\r
+ // Since not all device support this command, so skip if fail.\r
//\r
- Status = UsbBootModeSense (UsbMass);\r
- if (EFI_ERROR (Status)) {\r
- DEBUG ((mUsbMscError, "UsbBootGetParams: UsbBootModeSense (%r)\n", Status));\r
- return Status;\r
- }\r
+ UsbScsiModeSense (UsbMass);\r
}\r
\r
return UsbBootReadCapacity (UsbMass);\r
\r
/**\r
Detect whether the removable media is present and whether it has changed.\r
- The Non-removable media doesn't need it.\r
\r
- @param UsbMass The device to retireve disk gemotric.\r
+ @param UsbMass The device to check.\r
\r
- @retval EFI_SUCCESS The disk gemotric is successfully retrieved.\r
- @retval EFI_DEVICE_ERROR Something is inconsistent with the disk gemotric.\r
+ @retval EFI_SUCCESS The media status is successfully checked.\r
+ @retval Other Failed to detect media.\r
\r
**/\r
EFI_STATUS\r
{\r
EFI_BLOCK_IO_MEDIA OldMedia;\r
EFI_BLOCK_IO_MEDIA *Media;\r
+ UINT8 CmdSet;\r
+ EFI_TPL OldTpl;\r
EFI_STATUS Status;\r
\r
Media = &UsbMass->BlockIoMedia;\r
- OldMedia = UsbMass->BlockIoMedia;\r
\r
- //\r
- // First test whether the device is ready and get status\r
- // If media changed or ready, need read the device's capacity\r
- //\r
+ CopyMem (&OldMedia, &(UsbMass->BlockIoMedia), sizeof (EFI_BLOCK_IO_MEDIA));\r
+\r
+ CmdSet = ((EFI_USB_INTERFACE_DESCRIPTOR *) (UsbMass->Context))->InterfaceSubClass;\r
+\r
Status = UsbBootIsUnitReady (UsbMass);\r
- if ((Status == EFI_SUCCESS && Media->MediaPresent) ||\r
- (Status == EFI_MEDIA_CHANGED)) {\r
- if ((UsbMass->Pdt != USB_PDT_CDROM) &&\r
- (UsbMass->Pdt != USB_PDT_OPTICAL)) {\r
- //\r
- // Non CD-Rom device need ModeSenseCmd between InquiryCmd and ReadCapacityCmd\r
- //\r
- UsbBootModeSense (UsbMass);\r
- }\r
- DEBUG ((mUsbMscInfo, "UsbBootDetectMedia: Need Read Capacity\n"));\r
- Status = UsbBootReadCapacity (UsbMass);\r
+ if (EFI_ERROR (Status)) {\r
+ goto ON_ERROR;\r
+ }\r
+\r
+ if ((UsbMass->Pdt != USB_PDT_CDROM) && (CmdSet == USB_MASS_STORE_SCSI)) {\r
+ //\r
+ // MODE SENSE is required for the device with PDT of 0x00/0x07/0x0E,\r
+ // according to Section 4 of USB Mass Storage Specification for Bootability.\r
+ // MODE SENSE(10) is useless here, while MODE SENSE(6) defined in SCSI\r
+ // could get the information of Write Protected.\r
+ // Since not all device support this command, skip if fail.\r
+ //\r
+ UsbScsiModeSense (UsbMass);\r
}\r
+\r
+ Status = UsbBootReadCapacity (UsbMass);\r
if (EFI_ERROR (Status)) {\r
- return Status;\r
+ DEBUG ((EFI_D_ERROR, "UsbBootDetectMedia: UsbBootReadCapacity (%r)\n", Status));\r
+ goto ON_ERROR;\r
}\r
\r
+ return EFI_SUCCESS;\r
+\r
+ON_ERROR:\r
+ //\r
+ // Detect whether it is necessary to reinstall the Block I/O Protocol.\r
//\r
- // Detect whether it is necessary to reinstall the BlockIO\r
+ // MediaId may change in RequestSense for MediaChanged\r
+ // MediaPresent may change in RequestSense for NoMedia\r
+ // MediaReadOnly may change in RequestSense for WriteProtected or MediaChanged\r
+ // MediaPresent/BlockSize/LastBlock may change in ReadCapacity\r
//\r
if ((Media->MediaId != OldMedia.MediaId) ||\r
(Media->MediaPresent != OldMedia.MediaPresent) ||\r
(Media->ReadOnly != OldMedia.ReadOnly) ||\r
(Media->BlockSize != OldMedia.BlockSize) ||\r
(Media->LastBlock != OldMedia.LastBlock)) {\r
- DEBUG ((mUsbMscInfo, "UsbBootDetectMedia: Need reinstall BlockIoProtocol\n"));\r
- Media->MediaId++;\r
+\r
+ //\r
+ // This function is called by Block I/O Protocol APIs, which run at TPL_NOTIFY.\r
+ // Here we temporarily restore TPL to TPL_CALLBACK to invoke ReinstallProtocolInterface().\r
+ //\r
+ OldTpl = EfiGetCurrentTpl ();\r
+ gBS->RestoreTPL (TPL_CALLBACK);\r
+\r
gBS->ReinstallProtocolInterface (\r
UsbMass->Controller,\r
&gEfiBlockIoProtocolGuid,\r
&UsbMass->BlockIo,\r
&UsbMass->BlockIo\r
);\r
+\r
+ ASSERT (EfiGetCurrentTpl () == TPL_CALLBACK);\r
+ gBS->RaiseTPL (OldTpl);\r
+\r
//\r
- // Check whether media present or media changed or write protected\r
+ // Update MediaId after reinstalling Block I/O Protocol.\r
//\r
- if (Media->MediaPresent == FALSE) {\r
- Status = EFI_NO_MEDIA;\r
- }\r
- if (Media->MediaId != OldMedia.MediaId) {\r
- Status = EFI_MEDIA_CHANGED;\r
+ if (Media->MediaPresent != OldMedia.MediaPresent) {\r
+ if (Media->MediaPresent) {\r
+ Media->MediaId = 1;\r
+ } else {\r
+ Media->MediaId = 0;\r
+ }\r
}\r
- if (Media->ReadOnly != OldMedia.ReadOnly) {\r
- Status = EFI_WRITE_PROTECTED;\r
+\r
+ if ((Media->ReadOnly != OldMedia.ReadOnly) ||\r
+ (Media->BlockSize != OldMedia.BlockSize) ||\r
+ (Media->LastBlock != OldMedia.LastBlock)) {\r
+ Media->MediaId++;\r
}\r
}\r
\r
ByteSize = (UINT32)Count * BlockSize;\r
\r
//\r
- // Optical device need longer timeout than other device\r
+ // USB command's upper limit timeout is 5s. [USB2.0-9.2.6.1]\r
//\r
- if (UsbMass->OpticalStorage == TRUE) {\r
- Timeout = (UINT32)Count * USB_BOOT_OPTICAL_BLOCK_TIMEOUT;\r
- } else {\r
- Timeout = (UINT32)Count * USB_BOOT_GENERAL_BLOCK_TIMEOUT;\r
- }\r
+ Timeout = (UINT32) USB_BOOT_GENERAL_CMD_TIMEOUT;\r
\r
//\r
// Fill in the command then execute\r
ZeroMem (&ReadCmd, sizeof (USB_BOOT_READ10_CMD));\r
\r
ReadCmd.OpCode = USB_BOOT_READ10_OPCODE;\r
- ReadCmd.Lun = USB_BOOT_LUN (UsbMass->Lun);\r
- UsbBootPutUint32 (ReadCmd.Lba, Lba);\r
- UsbBootPutUint16 (ReadCmd.TransferLen, Count);\r
+ ReadCmd.Lun = (UINT8) (USB_BOOT_LUN (UsbMass->Lun));\r
+ WriteUnaligned32 ((UINT32 *) ReadCmd.Lba, SwapBytes32 (Lba));\r
+ WriteUnaligned16 ((UINT16 *) ReadCmd.TransferLen, SwapBytes16 (Count));\r
\r
Status = UsbBootExecCmdWithRetry (\r
UsbMass,\r
@param UsbMass The USB mass storage device to write to\r
@param Lba The start block number\r
@param TotalBlock Total block number to write\r
- @param Buffer The buffer to write to\r
+ @param Buffer Pointer to the source buffer for the data.\r
\r
@retval EFI_SUCCESS Data are written into the buffer\r
@retval Others Failed to write all the data\r
IN USB_MASS_DEVICE *UsbMass,\r
IN UINT32 Lba,\r
IN UINTN TotalBlock,\r
- OUT UINT8 *Buffer\r
+ IN UINT8 *Buffer\r
)\r
{\r
USB_BOOT_WRITE10_CMD WriteCmd;\r
ByteSize = (UINT32)Count * BlockSize;\r
\r
//\r
- // Optical device need longer timeout than other device\r
+ // USB command's upper limit timeout is 5s. [USB2.0-9.2.6.1]\r
//\r
- if (UsbMass->OpticalStorage == TRUE) {\r
- Timeout = (UINT32)Count * USB_BOOT_OPTICAL_BLOCK_TIMEOUT;\r
- } else {\r
- Timeout = (UINT32)Count * USB_BOOT_GENERAL_BLOCK_TIMEOUT;\r
- }\r
+ Timeout = (UINT32) USB_BOOT_GENERAL_CMD_TIMEOUT;\r
\r
//\r
// Fill in the write10 command block\r
ZeroMem (&WriteCmd, sizeof (USB_BOOT_WRITE10_CMD));\r
\r
WriteCmd.OpCode = USB_BOOT_WRITE10_OPCODE;\r
- WriteCmd.Lun = USB_BOOT_LUN (UsbMass->Lun);\r
- UsbBootPutUint32 (WriteCmd.Lba, Lba);\r
- UsbBootPutUint16 (WriteCmd.TransferLen, Count);\r
+ WriteCmd.Lun = (UINT8) (USB_BOOT_LUN (UsbMass->Lun));\r
+ WriteUnaligned32 ((UINT32 *) WriteCmd.Lba, SwapBytes32 (Lba));\r
+ WriteUnaligned16 ((UINT16 *) WriteCmd.TransferLen, SwapBytes16 (Count));\r
\r
Status = UsbBootExecCmdWithRetry (\r
UsbMass,\r
return Status;\r
}\r
\r
-\r
/**\r
- Use the USB clear feature control transfer to clear the endpoint\r
- stall condition.\r
+ Use the USB clear feature control transfer to clear the endpoint stall condition.\r
\r
- @param UsbIo The USB IO protocol to use\r
+ @param UsbIo The USB I/O Protocol instance\r
@param EndpointAddr The endpoint to clear stall for\r
\r
- @retval EFI_SUCCESS The endpoint stall condtion is clear\r
- @retval Others Failed to clear the endpoint stall condtion\r
+ @retval EFI_SUCCESS The endpoint stall condition is cleared.\r
+ @retval Others Failed to clear the endpoint stall condition.\r
\r
**/\r
EFI_STATUS\r
Request.Value = USB_FEATURE_ENDPOINT_HALT;\r
Request.Index = EndpointAddr;\r
Request.Length = 0;\r
- Timeout = USB_BOOT_GENERAL_CMD_TIMEOUT / USB_MASS_STALL_1_MS;\r
+ Timeout = USB_BOOT_GENERAL_CMD_TIMEOUT / USB_MASS_1_MILLISECOND;\r
\r
Status = UsbIo->UsbControlTransfer (\r
UsbIo,\r
projects / mirror_edk2.git / blobdiff