/** @file\r
+ Definition of the command set of USB Mass Storage Specification\r
+ for Bootability, Revision 1.0.\r
\r
-Copyright (c) 2007, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.<BR>\r
+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
http://opensource.org/licenses/bsd-license.php\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
\r
- UsbMassBoot.h\r
+#ifndef _EFI_USB_MASS_BOOT_H_\r
+#define _EFI_USB_MASS_BOOT_H_\r
\r
-Abstract:\r
+//\r
+// The opcodes of various USB boot commands:\r
+// INQUIRY/REQUEST_SENSE are "No Timeout Commands" as specified\r
+// by Multi-Media Commands (MMC) set.\r
+// Others are "Group 1 Timeout Commands". That is,\r
+// they should be retried if driver is ready. \r
+//\r
+#define USB_BOOT_INQUIRY_OPCODE 0x12\r
+#define USB_BOOT_REQUEST_SENSE_OPCODE 0x03\r
+#define USB_BOOT_MODE_SENSE10_OPCODE 0x5A\r
+#define USB_BOOT_READ_CAPACITY_OPCODE 0x25\r
+#define USB_BOOT_TEST_UNIT_READY_OPCODE 0x00\r
+#define USB_BOOT_READ10_OPCODE 0x28\r
+#define USB_BOOT_WRITE10_OPCODE 0x2A\r
\r
- The definition of command and data of the USB mass storage for\r
- bootability command set.\r
+#define USB_SCSI_MODE_SENSE6_OPCODE 0x1A\r
\r
-Revision History\r
+//\r
+// The Sense Key part of the sense data. Sense data has three levels:\r
+// Sense key, Additional Sense Code and Additional Sense Code Qualifier\r
+//\r
+#define USB_BOOT_SENSE_NO_SENSE 0x00 ///< No sense key\r
+#define USB_BOOT_SENSE_RECOVERED 0x01 ///< Last command succeed with recovery actions\r
+#define USB_BOOT_SENSE_NOT_READY 0x02 ///< Device not ready\r
+#define USB_BOOT_SNESE_MEDIUM_ERROR 0X03 ///< Failed probably because flaw in the media\r
+#define USB_BOOT_SENSE_HARDWARE_ERROR 0X04 ///< Non-recoverable hardware failure\r
+#define USB_BOOT_SENSE_ILLEGAL_REQUEST 0X05 ///< Illegal parameters in the request\r
+#define USB_BOOT_SENSE_UNIT_ATTENTION 0X06 ///< Removable medium may have been changed\r
+#define USB_BOOT_SENSE_DATA_PROTECT 0X07 ///< Write protected\r
+#define USB_BOOT_SENSE_BLANK_CHECK 0X08 ///< Blank/non-blank medium while reading/writing\r
+#define USB_BOOT_SENSE_VENDOR 0X09 ///< Vendor specific sense key\r
+#define USB_BOOT_SENSE_ABORTED 0X0B ///< Command aborted by the device\r
+#define USB_BOOT_SENSE_VOLUME_OVERFLOW 0x0D ///< Partition overflow\r
+#define USB_BOOT_SENSE_MISCOMPARE 0x0E ///< Source data mis-match while verfying.\r
+\r
+#define USB_BOOT_ASC_NO_ADDITIONAL_SENSE_INFORMATION 0x00\r
+#define USB_BOOT_ASC_NOT_READY 0x04\r
+#define USB_BOOT_ASC_NO_MEDIA 0x3A\r
+#define USB_BOOT_ASC_MEDIA_CHANGE 0x28\r
\r
+//\r
+// Supported PDT codes, or Peripheral Device Type\r
+//\r
+#define USB_PDT_DIRECT_ACCESS 0x00 ///< Direct access device\r
+#define USB_PDT_CDROM 0x05 ///< CDROM\r
+#define USB_PDT_OPTICAL 0x07 ///< Non-CD optical disks\r
+#define USB_PDT_SIMPLE_DIRECT 0x0E ///< Simplified direct access device\r
\r
-**/\r
+//\r
+// Other parameters, Max carried size is 512B * 128 = 64KB\r
+//\r
+#define USB_BOOT_IO_BLOCKS 128\r
\r
-#ifndef _EFI_USB_MASS_BOOT_H_\r
-#define _EFI_USB_MASS_BOOT_H_\r
+//\r
+// Retry mass command times, set by experience\r
+//\r
+#define USB_BOOT_COMMAND_RETRY 5\r
+\r
+//\r
+// Wait for unit ready command, set by experience\r
+//\r
+#define USB_BOOT_RETRY_UNIT_READY_STALL (500 * USB_MASS_1_MILLISECOND)\r
\r
-enum {\r
- //\r
- // The opcodes of various usb boot commands:\r
- // INQUIRY/REQUEST_SENSE are "No Timeout Commands" as specified\r
- // by MMC command set. Others are "Group 1 Timeout Commands". That\r
- // is they should be retried if driver is ready.\r
- // We can't use the Peripheral Device Type in Inquiry data to\r
- // determine the timeout used. For example, both floppy and flash\r
- // are likely set their PDT to 0, or Direct Access Device.\r
- //\r
- USB_BOOT_INQUIRY_OPCODE = 0x12,\r
- USB_BOOT_REQUEST_SENSE_OPCODE = 0x03,\r
-\r
- USB_BOOT_MODE_SENSE10_OPCODE = 0x5A,\r
- USB_BOOT_READ_CAPACITY_OPCODE = 0x25,\r
- USB_BOOT_TEST_UNIT_READY_OPCODE = 0x00,\r
- USB_BOOT_READ10_OPCODE = 0x28,\r
- USB_BOOT_WRITE10_OPCODE = 0x2A,\r
-\r
- USB_SCSI_MODE_SENSE6_OPCODE = 0x1A,\r
- \r
- //\r
- // The Sense Key part of the sense data. Sense data has three levels:\r
- // Sense key, Additional Sense Code and Additional Sense Code Qualifier\r
- //\r
- USB_BOOT_SENSE_NO_SENSE = 0x00, // No sense key\r
- USB_BOOT_SENSE_RECOVERED = 0x01, // Last command succeed with recovery actions\r
- USB_BOOT_SENSE_NOT_READY = 0x02, // Device not ready\r
- USB_BOOT_SNESE_MEDIUM_ERROR = 0X03, // Failed probably because flaw in the media\r
- USB_BOOT_SENSE_HARDWARE_ERROR = 0X04, // Non-recoverable hardware failure\r
- USB_BOOT_SENSE_ILLEGAL_REQUEST = 0X05, // Illegal parameters in the request\r
- USB_BOOT_SENSE_UNIT_ATTENTION = 0X06, // Removable medium may have been changed\r
- USB_BOOT_SNESE_DATA_PROTECT = 0X07, // Write protected\r
- USB_BOOT_SENSE_BLANK_CHECK = 0X08, // Blank/non-blank medium while reading/writing\r
- USB_BOOT_SENSE_VENDOR = 0X09, // Vendor specific sense key\r
- USB_BOOT_SENSE_ABORTED = 0X0B, // Command aborted by the device\r
- USB_BOOT_SENSE_VOLUME_OVERFLOW = 0x0D, // Partition overflow\r
- USB_BOOT_SENSE_MISCOMPARE = 0x0E, // Source data mis-match while verfying.\r
-\r
- USB_BOOT_ASC_NOT_READY = 0x04,\r
- USB_BOOT_ASC_NO_MEDIA = 0x3A,\r
- USB_BOOT_ASC_MEDIA_CHANGE = 0x28,\r
-\r
- //\r
- // Other parameters\r
- //\r
- USB_BOOT_IO_BLOCKS = 64,\r
-\r
- //\r
- // Boot Retry times\r
- //\r
- USB_BOOT_COMMAND_RETRY = 5,\r
- USB_BOOT_WAIT_RETRY = 5,\r
-\r
- //\r
- // Boot Stall time\r
- //\r
- USB_BOOT_UNIT_READY_STALL = 50 * USB_MASS_STALL_1_MS,\r
-\r
- //\r
- // Boot Transfer timeout\r
- //\r
- // USB2.0 Spec define the up-limit timeout 5s for all command. USB floppy, \r
- // USB CD-Rom and iPod devices are much slower than USB key when reponse \r
- // most of commands, So we set 5s as timeout here.\r
- // \r
- //\r
- USB_BOOT_GENERAL_CMD_TIMEOUT = 5 * USB_MASS_STALL_1_S,\r
- \r
- //\r
- // Supported PDT codes, or Peripheral Device Type\r
- //\r
- USB_PDT_DIRECT_ACCESS = 0x00, // Direct access device\r
- USB_PDT_CDROM = 0x05, // CDROM\r
- USB_PDT_OPTICAL = 0x07, // Non-CD optical disks\r
- USB_PDT_SIMPLE_DIRECT = 0x0E // Simplified direct access device\r
-};\r
+//\r
+// Mass command timeout, refers to specification[USB20-9.2.6.1]\r
+//\r
+// USB2.0 Spec define the up-limit timeout 5s for all command. USB floppy, \r
+// USB CD-Rom and iPod devices are much slower than USB key when reponse \r
+// most of commands, So we set 5s as timeout here.\r
+// \r
+#define USB_BOOT_GENERAL_CMD_TIMEOUT (5 * USB_MASS_1_SECOND)\r
\r
//\r
// The required commands are INQUIRY, READ CAPACITY, TEST UNIT READY,\r
// READ10, WRITE10, and REQUEST SENSE. The BLOCK_IO protocol uses LBA\r
// so it isn't necessary to issue MODE SENSE / READ FORMAT CAPACITY\r
-// command to retrieve the disk gemotrics.\r
+// command to retrieve the disk gemotrics. \r
//\r
#pragma pack(1)\r
typedef struct {\r
UINT8 OpCode;\r
- UINT8 Lun; // Lun (high 3 bits)\r
+ UINT8 Lun; ///< Lun (high 3 bits)\r
UINT8 Reserved0[2];\r
UINT8 AllocLen;\r
UINT8 Reserved1;\r
} USB_BOOT_INQUIRY_CMD;\r
\r
typedef struct {\r
- UINT8 Pdt; // Peripheral Device Type (low 5 bits)\r
- UINT8 Removable; // Removable Media (highest bit)\r
+ UINT8 Pdt; ///< Peripheral Device Type (low 5 bits)\r
+ UINT8 Removable; ///< Removable Media (highest bit)\r
UINT8 Reserved0[2];\r
- UINT8 AddLen; // Additional length\r
+ UINT8 AddLen; ///< Additional length\r
UINT8 Reserved1[3];\r
UINT8 VendorID[8];\r
UINT8 ProductID[16];\r
\r
typedef struct {\r
UINT8 OpCode;\r
- UINT8 Lun; // Lun (High 3 bits)\r
- UINT8 Lba[4]; // Logical block address\r
+ UINT8 Lun; ///< Lun (High 3 bits)\r
+ UINT8 Lba[4]; ///< Logical block address\r
UINT8 Reserved0;\r
- UINT8 TransferLen[2]; // Transfer length\r
+ UINT8 TransferLen[2]; ///< Transfer length\r
UINT8 Reserverd1;\r
UINT8 Pad[2];\r
} USB_BOOT_READ10_CMD;\r
\r
typedef struct {\r
UINT8 OpCode;\r
- UINT8 Lun; // Lun (High 3 bits)\r
+ UINT8 Lun; ///< Lun (High 3 bits)\r
UINT8 Reserved0[2];\r
- UINT8 AllocLen; // Allocation length\r
+ UINT8 AllocLen; ///< Allocation length\r
UINT8 Reserved1;\r
UINT8 Pad[6];\r
} USB_BOOT_REQUEST_SENSE_CMD;\r
typedef struct {\r
UINT8 ErrorCode;\r
UINT8 Reserved0;\r
- UINT8 SenseKey; // Sense key (low 4 bits)\r
+ UINT8 SenseKey; ///< Sense key (low 4 bits)\r
UINT8 Infor[4];\r
- UINT8 AddLen; // Additional Sense length, 10\r
+ UINT8 AddLen; ///< Additional Sense length, 10\r
UINT8 Reserved1[4];\r
- UINT8 ASC; // Additional Sense Code\r
- UINT8 ASCQ; // Additional Sense Code Qualifier\r
+ UINT8 Asc; ///< Additional Sense Code\r
+ UINT8 Ascq; ///< Additional Sense Code Qualifier\r
UINT8 Reserverd2[4];\r
} USB_BOOT_REQUEST_SENSE_DATA;\r
\r
\r
typedef struct {\r
UINT8 ModeDataLen;\r
- UINT8 MediumType;\r
+ UINT8 MediumType;\r
UINT8 DevicePara;\r
UINT8 BlkDesLen;\r
} USB_SCSI_MODE_SENSE6_PARA_HEADER;\r
//\r
// Get the removable, PDT, and sense key bits from the command data\r
//\r
-#define USB_BOOT_REMOVABLE(RmbByte) (((RmbByte) & 0x80) != 0)\r
+#define USB_BOOT_REMOVABLE(RmbByte) (((RmbByte) & BIT7) != 0)\r
#define USB_BOOT_PDT(Pdt) ((Pdt) & 0x1f)\r
#define USB_BOOT_SENSE_KEY(Key) ((Key) & 0x0f)\r
\r
-//\r
-// Swap the byte sequence of a UINT32. Intel CPU uses little endian\r
-// in UEFI environment, but USB boot uses big endian.\r
-//\r
-#define USB_BOOT_SWAP32(Data32) \\r
- ((((Data32) & 0x000000ff) << 24) | (((Data32) & 0xff000000) >> 24) | \\r
- (((Data32) & 0x0000ff00) << 8) | (((Data32) & 0x00ff0000) >> 8))\r
+/**\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
+ it is also included here.\r
\r
-#define USB_BOOT_SWAP16(Data16) \\r
- ((((Data16) & 0x00ff) << 8) | (((Data16) & 0xff00) >> 8))\r
+ @param UsbMass The device to retrieve disk gemotric.\r
\r
+ @retval EFI_SUCCESS The disk gemotric is successfully retrieved.\r
+ @retval Other Failed to get the parameters.\r
+\r
+**/\r
EFI_STATUS\r
UsbBootGetParams (\r
IN USB_MASS_DEVICE *UsbMass\r
);\r
\r
+/**\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.\r
+ @retval Others Device not ready.\r
+\r
+**/\r
EFI_STATUS\r
UsbBootIsUnitReady (\r
IN USB_MASS_DEVICE *UsbMass\r
);\r
\r
+/**\r
+ Detect whether the removable media is present and whether it has changed.\r
+\r
+ @param UsbMass The device to check.\r
+\r
+ @retval EFI_SUCCESS The media status is successfully checked.\r
+ @retval Other Failed to detect media.\r
+\r
+**/\r
EFI_STATUS\r
UsbBootDetectMedia (\r
IN USB_MASS_DEVICE *UsbMass\r
);\r
\r
+/**\r
+ Read some blocks from the device.\r
+\r
+ @param UsbMass The USB mass storage device to read from\r
+ @param Lba The start block number\r
+ @param TotalBlock Total block number to read\r
+ @param Buffer The buffer to read to\r
+\r
+ @retval EFI_SUCCESS Data are read into the buffer\r
+ @retval Others Failed to read all the data\r
+\r
+**/\r
EFI_STATUS\r
UsbBootReadBlocks (\r
IN USB_MASS_DEVICE *UsbMass,\r
OUT UINT8 *Buffer\r
);\r
\r
+/**\r
+ Write some blocks to the device.\r
+\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 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
+\r
+**/\r
EFI_STATUS\r
UsbBootWriteBlocks (\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
+/**\r
+ Read some blocks from the device by SCSI 16 byte cmd.\r
+\r
+ @param UsbMass The USB mass storage device to read from\r
+ @param Lba The start block number\r
+ @param TotalBlock Total block number to read\r
+ @param Buffer The buffer to read to\r
+\r
+ @retval EFI_SUCCESS Data are read into the buffer\r
+ @retval Others Failed to read all the data\r
+\r
+**/\r
+EFI_STATUS\r
+UsbBootReadBlocks16 (\r
+ IN USB_MASS_DEVICE *UsbMass,\r
+ IN UINT64 Lba,\r
+ IN UINTN TotalBlock,\r
+ OUT UINT8 *Buffer\r
+ );\r
+\r
+/**\r
+ Write some blocks to the device by SCSI 16 byte cmd.\r
+\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 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
+\r
+**/\r
+EFI_STATUS\r
+UsbBootWriteBlocks16 (\r
+ IN USB_MASS_DEVICE *UsbMass,\r
+ IN UINT64 Lba,\r
+ IN UINTN TotalBlock,\r
+ IN UINT8 *Buffer\r
);\r
+\r
+\r
+/**\r
+ Use the USB clear feature control transfer to clear the endpoint stall condition.\r
+\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 condition is cleared.\r
+ @retval Others Failed to clear the endpoint stall condition.\r
+\r
+**/\r
+EFI_STATUS\r
+UsbClearEndpointStall (\r
+ IN EFI_USB_IO_PROTOCOL *UsbIo,\r
+ IN UINT8 EndpointAddr\r
+ );\r
+\r
#endif\r
\r
projects / mirror_edk2.git / blobdiff