2 Definition of the command set of USB Mass Storage Specification
3 for Bootability, Revision 1.0.
5 Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
6 This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #ifndef _EFI_USB_MASS_BOOT_H_
17 #define _EFI_USB_MASS_BOOT_H_
20 // The opcodes of various USB boot commands:
21 // INQUIRY/REQUEST_SENSE are "No Timeout Commands" as specified
22 // by Multi-Media Commands (MMC) set.
23 // Others are "Group 1 Timeout Commands". That is,
24 // they should be retried if driver is ready.
26 #define USB_BOOT_INQUIRY_OPCODE 0x12
27 #define USB_BOOT_REQUEST_SENSE_OPCODE 0x03
28 #define USB_BOOT_MODE_SENSE10_OPCODE 0x5A
29 #define USB_BOOT_READ_CAPACITY_OPCODE 0x25
30 #define USB_BOOT_TEST_UNIT_READY_OPCODE 0x00
31 #define USB_BOOT_READ10_OPCODE 0x28
32 #define USB_BOOT_WRITE10_OPCODE 0x2A
34 #define USB_SCSI_MODE_SENSE6_OPCODE 0x1A
37 // The Sense Key part of the sense data. Sense data has three levels:
38 // Sense key, Additional Sense Code and Additional Sense Code Qualifier
40 #define USB_BOOT_SENSE_NO_SENSE 0x00 ///< No sense key
41 #define USB_BOOT_SENSE_RECOVERED 0x01 ///< Last command succeed with recovery actions
42 #define USB_BOOT_SENSE_NOT_READY 0x02 ///< Device not ready
43 #define USB_BOOT_SNESE_MEDIUM_ERROR 0X03 ///< Failed probably because flaw in the media
44 #define USB_BOOT_SENSE_HARDWARE_ERROR 0X04 ///< Non-recoverable hardware failure
45 #define USB_BOOT_SENSE_ILLEGAL_REQUEST 0X05 ///< Illegal parameters in the request
46 #define USB_BOOT_SENSE_UNIT_ATTENTION 0X06 ///< Removable medium may have been changed
47 #define USB_BOOT_SENSE_DATA_PROTECT 0X07 ///< Write protected
48 #define USB_BOOT_SENSE_BLANK_CHECK 0X08 ///< Blank/non-blank medium while reading/writing
49 #define USB_BOOT_SENSE_VENDOR 0X09 ///< Vendor specific sense key
50 #define USB_BOOT_SENSE_ABORTED 0X0B ///< Command aborted by the device
51 #define USB_BOOT_SENSE_VOLUME_OVERFLOW 0x0D ///< Partition overflow
52 #define USB_BOOT_SENSE_MISCOMPARE 0x0E ///< Source data mis-match while verfying.
54 #define USB_BOOT_ASC_NO_ADDITIONAL_SENSE_INFORMATION 0x00
55 #define USB_BOOT_ASC_NOT_READY 0x04
56 #define USB_BOOT_ASC_NO_MEDIA 0x3A
57 #define USB_BOOT_ASC_MEDIA_CHANGE 0x28
60 // Supported PDT codes, or Peripheral Device Type
62 #define USB_PDT_DIRECT_ACCESS 0x00 ///< Direct access device
63 #define USB_PDT_CDROM 0x05 ///< CDROM
64 #define USB_PDT_OPTICAL 0x07 ///< Non-CD optical disks
65 #define USB_PDT_SIMPLE_DIRECT 0x0E ///< Simplified direct access device
68 // Other parameters, Max carried size is 64KB.
70 #define USB_BOOT_MAX_CARRY_SIZE SIZE_64KB
73 // Retry mass command times, set by experience
75 #define USB_BOOT_COMMAND_RETRY 5
78 // Wait for unit ready command, set by experience
80 #define USB_BOOT_RETRY_UNIT_READY_STALL (500 * USB_MASS_1_MILLISECOND)
83 // Mass command timeout, refers to specification[USB20-9.2.6.1]
85 // USB2.0 Spec define the up-limit timeout 5s for all command. USB floppy,
86 // USB CD-Rom and iPod devices are much slower than USB key when reponse
87 // most of commands, So we set 5s as timeout here.
89 #define USB_BOOT_GENERAL_CMD_TIMEOUT (5 * USB_MASS_1_SECOND)
92 // The required commands are INQUIRY, READ CAPACITY, TEST UNIT READY,
93 // READ10, WRITE10, and REQUEST SENSE. The BLOCK_IO protocol uses LBA
94 // so it isn't necessary to issue MODE SENSE / READ FORMAT CAPACITY
95 // command to retrieve the disk gemotrics.
100 UINT8 Lun
; ///< Lun (high 3 bits)
105 } USB_BOOT_INQUIRY_CMD
;
108 UINT8 Pdt
; ///< Peripheral Device Type (low 5 bits)
109 UINT8 Removable
; ///< Removable Media (highest bit)
111 UINT8 AddLen
; ///< Additional length
115 UINT8 ProductRevision
[4];
116 } USB_BOOT_INQUIRY_DATA
;
123 } USB_BOOT_READ_CAPACITY_CMD
;
128 } USB_BOOT_READ_CAPACITY_DATA
;
135 } USB_BOOT_TEST_UNIT_READY_CMD
;
142 UINT8 ParaListLenMsb
;
143 UINT8 ParaListLenLsb
;
146 } USB_BOOT_MODE_SENSE10_CMD
;
149 UINT8 ModeDataLenMsb
;
150 UINT8 ModeDataLenLsb
;
154 } USB_BOOT_MODE_SENSE10_PARA_HEADER
;
158 UINT8 Lun
; ///< Lun (High 3 bits)
159 UINT8 Lba
[4]; ///< Logical block address
161 UINT8 TransferLen
[2]; ///< Transfer length
164 } USB_BOOT_READ10_CMD
;
171 UINT8 TransferLen
[2];
174 } USB_BOOT_WRITE10_CMD
;
178 UINT8 Lun
; ///< Lun (High 3 bits)
180 UINT8 AllocLen
; ///< Allocation length
183 } USB_BOOT_REQUEST_SENSE_CMD
;
188 UINT8 SenseKey
; ///< Sense key (low 4 bits)
190 UINT8 AddLen
; ///< Additional Sense length, 10
192 UINT8 Asc
; ///< Additional Sense Code
193 UINT8 Ascq
; ///< Additional Sense Code Qualifier
195 } USB_BOOT_REQUEST_SENSE_DATA
;
204 } USB_SCSI_MODE_SENSE6_CMD
;
211 } USB_SCSI_MODE_SENSE6_PARA_HEADER
;
215 // Convert a LUN number to that in the command
217 #define USB_BOOT_LUN(Lun) ((Lun) << 5)
220 // Get the removable, PDT, and sense key bits from the command data
222 #define USB_BOOT_REMOVABLE(RmbByte) (((RmbByte) & BIT7) != 0)
223 #define USB_BOOT_PDT(Pdt) ((Pdt) & 0x1f)
224 #define USB_BOOT_SENSE_KEY(Key) ((Key) & 0x0f)
227 Get the parameters for the USB mass storage media.
229 This function get the parameters for the USB mass storage media,
230 It is used both to initialize the media during the Start() phase
231 of Driver Binding Protocol and to re-initialize it when the media is
232 changed. Althought the RemoveableMedia is unlikely to change,
233 it is also included here.
235 @param UsbMass The device to retrieve disk gemotric.
237 @retval EFI_SUCCESS The disk gemotric is successfully retrieved.
238 @retval Other Failed to get the parameters.
243 IN USB_MASS_DEVICE
*UsbMass
247 Execute TEST UNIT READY command to check if the device is ready.
249 @param UsbMass The device to test
251 @retval EFI_SUCCESS The device is ready.
252 @retval Others Device not ready.
257 IN USB_MASS_DEVICE
*UsbMass
261 Detect whether the removable media is present and whether it has changed.
263 @param UsbMass The device to check.
265 @retval EFI_SUCCESS The media status is successfully checked.
266 @retval Other Failed to detect media.
271 IN USB_MASS_DEVICE
*UsbMass
275 Read some blocks from the device.
277 @param UsbMass The USB mass storage device to read from
278 @param Lba The start block number
279 @param TotalBlock Total block number to read
280 @param Buffer The buffer to read to
282 @retval EFI_SUCCESS Data are read into the buffer
283 @retval Others Failed to read all the data
288 IN USB_MASS_DEVICE
*UsbMass
,
295 Write some blocks to the device.
297 @param UsbMass The USB mass storage device to write to
298 @param Lba The start block number
299 @param TotalBlock Total block number to write
300 @param Buffer Pointer to the source buffer for the data.
302 @retval EFI_SUCCESS Data are written into the buffer
303 @retval Others Failed to write all the data
308 IN USB_MASS_DEVICE
*UsbMass
,
315 Read some blocks from the device by SCSI 16 byte cmd.
317 @param UsbMass The USB mass storage device to read from
318 @param Lba The start block number
319 @param TotalBlock Total block number to read
320 @param Buffer The buffer to read to
322 @retval EFI_SUCCESS Data are read into the buffer
323 @retval Others Failed to read all the data
327 UsbBootReadBlocks16 (
328 IN USB_MASS_DEVICE
*UsbMass
,
335 Write some blocks to the device by SCSI 16 byte cmd.
337 @param UsbMass The USB mass storage device to write to
338 @param Lba The start block number
339 @param TotalBlock Total block number to write
340 @param Buffer Pointer to the source buffer for the data.
342 @retval EFI_SUCCESS Data are written into the buffer
343 @retval Others Failed to write all the data
347 UsbBootWriteBlocks16 (
348 IN USB_MASS_DEVICE
*UsbMass
,
356 Use the USB clear feature control transfer to clear the endpoint stall condition.
358 @param UsbIo The USB I/O Protocol instance
359 @param EndpointAddr The endpoint to clear stall for
361 @retval EFI_SUCCESS The endpoint stall condition is cleared.
362 @retval Others Failed to clear the endpoint stall condition.
366 UsbClearEndpointStall (
367 IN EFI_USB_IO_PROTOCOL
*UsbIo
,
368 IN UINT8 EndpointAddr