[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbMassStorageDxe / UsbMassBoot.h

/** @file\r
  Definition of the command set of USB Mass Storage Specification\r
  for Bootability, Revision 1.0.\r
\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
\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
**/\r
\r
#ifndef _EFI_USB_MASS_BOOT_H_\r
#define _EFI_USB_MASS_BOOT_H_\r
\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
#define 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
#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
// Other parameters, Max carried size is 512B * 128 = 64KB\r
//\r
#define USB_BOOT_IO_BLOCKS              128\r
\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
//\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
//\r
#pragma pack(1)\r
typedef struct {\r
  UINT8             OpCode;\r
  UINT8             Lun;            ///< Lun (high 3 bits)\r
  UINT8             Reserved0[2];\r
  UINT8             AllocLen;\r
  UINT8             Reserved1;\r
  UINT8             Pad[6];\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             Reserved0[2];\r
  UINT8             AddLen;         ///< Additional length\r
  UINT8             Reserved1[3];\r
  UINT8             VendorID[8];\r
  UINT8             ProductID[16];\r
  UINT8             ProductRevision[4];\r
} USB_BOOT_INQUIRY_DATA;\r
\r
typedef struct {\r
  UINT8             OpCode;\r
  UINT8             Lun;\r
  UINT8             Reserved0[8];\r
  UINT8             Pad[2];\r
} USB_BOOT_READ_CAPACITY_CMD;\r
\r
typedef struct {\r
  UINT8             LastLba[4];\r
  UINT8             BlockLen[4];\r
} USB_BOOT_READ_CAPACITY_DATA;\r
\r
typedef struct {\r
  UINT8             OpCode;\r
  UINT8             Lun;\r
  UINT8             Reserved[4];\r
  UINT8             Pad[6];\r
} USB_BOOT_TEST_UNIT_READY_CMD;\r
\r
typedef struct {\r
  UINT8             OpCode;\r
  UINT8             Lun;\r
  UINT8             PageCode;\r
  UINT8             Reserved0[4];\r
  UINT8             ParaListLenMsb;\r
  UINT8             ParaListLenLsb;\r
  UINT8             Reserved1;\r
  UINT8             Pad[2];\r
} USB_BOOT_MODE_SENSE10_CMD;\r
\r
typedef struct {\r
  UINT8             ModeDataLenMsb;\r
  UINT8             ModeDataLenLsb;\r
  UINT8             Reserved0[4];\r
  UINT8             BlkDesLenMsb;\r
  UINT8             BlkDesLenLsb;\r
} USB_BOOT_MODE_SENSE10_PARA_HEADER;\r
\r
typedef struct {\r
  UINT8             OpCode;\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             Reserverd1;\r
  UINT8             Pad[2];\r
} USB_BOOT_READ10_CMD;\r
\r
typedef struct {\r
  UINT8             OpCode;\r
  UINT8             Lun;\r
  UINT8             Lba[4];\r
  UINT8             Reserved0;\r
  UINT8             TransferLen[2];\r
  UINT8             Reserverd1;\r
  UINT8             Pad[2];\r
} USB_BOOT_WRITE10_CMD;\r
\r
typedef struct {\r
  UINT8             OpCode;\r
  UINT8             Lun;            ///< Lun (High 3 bits)\r
  UINT8             Reserved0[2];\r
  UINT8             AllocLen;       ///< Allocation length\r
  UINT8             Reserved1;\r
  UINT8             Pad[6];\r
} USB_BOOT_REQUEST_SENSE_CMD;\r
\r
typedef struct {\r
  UINT8             ErrorCode;\r
  UINT8             Reserved0;\r
  UINT8             SenseKey;       ///< Sense key (low 4 bits)\r
  UINT8             Infor[4];\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             Reserverd2[4];\r
} USB_BOOT_REQUEST_SENSE_DATA;\r
\r
typedef struct {\r
  UINT8             OpCode;\r
  UINT8             Lun;\r
  UINT8             PageCode;\r
  UINT8             Reserved0;\r
  UINT8             AllocateLen;\r
  UINT8             Control;\r
} USB_SCSI_MODE_SENSE6_CMD;\r
\r
typedef struct {\r
  UINT8             ModeDataLen;\r
  UINT8             MediumType;\r
  UINT8             DevicePara;\r
  UINT8             BlkDesLen;\r
} USB_SCSI_MODE_SENSE6_PARA_HEADER;\r
#pragma pack()\r
\r
//\r
// Convert a LUN number to that in the command\r
//\r
#define USB_BOOT_LUN(Lun) ((Lun) << 5)\r
\r
//\r
// Get the removable, PDT, and sense key bits from the command data\r
//\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
  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
  @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
  IN  UINT32                  Lba,\r
  IN  UINTN                   TotalBlock,\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
  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
Commit	Line	Data
e237e7ae	1	/** @file\r
d80ed2a7	2	Definition of the command set of USB Mass Storage Specification\r
d80ed2a7	3	for Bootability, Revision 1.0.\r
e237e7ae	4	\r
275b96da	5	Copyright (c) 2007 - 2017, Intel Corporation. All rights reserved.<BR>\r
cd5ebaa0	6	This program and the accompanying materials\r
e237e7ae	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
e237e7ae	14	**/\r
	15	\r
	16	#ifndef _EFI_USB_MASS_BOOT_H_\r
	17	#define _EFI_USB_MASS_BOOT_H_\r
	18	\r
1ccdbf2a	19	//\r
	20	// The opcodes of various USB boot commands:\r
	21	// INQUIRY/REQUEST_SENSE are "No Timeout Commands" as specified\r
	22	// by Multi-Media Commands (MMC) set.\r
	23	// Others are "Group 1 Timeout Commands". That is,\r
	24	// they should be retried if driver is ready. \r
	25	//\r
	26	#define USB_BOOT_INQUIRY_OPCODE 0x12\r
	27	#define USB_BOOT_REQUEST_SENSE_OPCODE 0x03\r
	28	#define USB_BOOT_MODE_SENSE10_OPCODE 0x5A\r
	29	#define USB_BOOT_READ_CAPACITY_OPCODE 0x25\r
	30	#define USB_BOOT_TEST_UNIT_READY_OPCODE 0x00\r
	31	#define USB_BOOT_READ10_OPCODE 0x28\r
	32	#define USB_BOOT_WRITE10_OPCODE 0x2A\r
	33	\r
	34	#define USB_SCSI_MODE_SENSE6_OPCODE 0x1A\r
	35	\r
	36	//\r
	37	// The Sense Key part of the sense data. Sense data has three levels:\r
	38	// Sense key, Additional Sense Code and Additional Sense Code Qualifier\r
	39	//\r
	40	#define USB_BOOT_SENSE_NO_SENSE 0x00 ///< No sense key\r
	41	#define USB_BOOT_SENSE_RECOVERED 0x01 ///< Last command succeed with recovery actions\r
	42	#define USB_BOOT_SENSE_NOT_READY 0x02 ///< Device not ready\r
	43	#define USB_BOOT_SNESE_MEDIUM_ERROR 0X03 ///< Failed probably because flaw in the media\r
	44	#define USB_BOOT_SENSE_HARDWARE_ERROR 0X04 ///< Non-recoverable hardware failure\r
	45	#define USB_BOOT_SENSE_ILLEGAL_REQUEST 0X05 ///< Illegal parameters in the request\r
	46	#define USB_BOOT_SENSE_UNIT_ATTENTION 0X06 ///< Removable medium may have been changed\r
	47	#define USB_BOOT_SENSE_DATA_PROTECT 0X07 ///< Write protected\r
	48	#define USB_BOOT_SENSE_BLANK_CHECK 0X08 ///< Blank/non-blank medium while reading/writing\r
	49	#define USB_BOOT_SENSE_VENDOR 0X09 ///< Vendor specific sense key\r
	50	#define USB_BOOT_SENSE_ABORTED 0X0B ///< Command aborted by the device\r
	51	#define USB_BOOT_SENSE_VOLUME_OVERFLOW 0x0D ///< Partition overflow\r
	52	#define USB_BOOT_SENSE_MISCOMPARE 0x0E ///< Source data mis-match while verfying.\r
	53	\r
275b96da MK	54	#define USB_BOOT_ASC_NO_ADDITIONAL_SENSE_INFORMATION 0x00\r
	55	#define USB_BOOT_ASC_NOT_READY 0x04\r
	56	#define USB_BOOT_ASC_NO_MEDIA 0x3A\r
	57	#define USB_BOOT_ASC_MEDIA_CHANGE 0x28\r
1ccdbf2a	58	\r
	59	//\r
	60	// Supported PDT codes, or Peripheral Device Type\r
	61	//\r
	62	#define USB_PDT_DIRECT_ACCESS 0x00 ///< Direct access device\r
	63	#define USB_PDT_CDROM 0x05 ///< CDROM\r
	64	#define USB_PDT_OPTICAL 0x07 ///< Non-CD optical disks\r
	65	#define USB_PDT_SIMPLE_DIRECT 0x0E ///< Simplified direct access device\r
	66	\r
	67	//\r
	68	// Other parameters, Max carried size is 512B * 128 = 64KB\r
	69	//\r
	70	#define USB_BOOT_IO_BLOCKS 128\r
	71	\r
	72	//\r
	73	// Retry mass command times, set by experience\r
	74	//\r
	75	#define USB_BOOT_COMMAND_RETRY 5\r
1ccdbf2a	76	\r
	77	//\r
	78	// Wait for unit ready command, set by experience\r
	79	//\r
	80	#define USB_BOOT_RETRY_UNIT_READY_STALL (500 * USB_MASS_1_MILLISECOND)\r
	81	\r
	82	//\r
	83	// Mass command timeout, refers to specification[USB20-9.2.6.1]\r
	84	//\r
	85	// USB2.0 Spec define the up-limit timeout 5s for all command. USB floppy, \r
	86	// USB CD-Rom and iPod devices are much slower than USB key when reponse \r
	87	// most of commands, So we set 5s as timeout here.\r
	88	// \r
	89	#define USB_BOOT_GENERAL_CMD_TIMEOUT (5 * USB_MASS_1_SECOND)\r
e237e7ae	90	\r
	91	//\r
	92	// The required commands are INQUIRY, READ CAPACITY, TEST UNIT READY,\r
	93	// READ10, WRITE10, and REQUEST SENSE. The BLOCK_IO protocol uses LBA\r
	94	// so it isn't necessary to issue MODE SENSE / READ FORMAT CAPACITY\r
41e8ff27	95	// command to retrieve the disk gemotrics. \r
e237e7ae	96	//\r
	97	#pragma pack(1)\r
	98	typedef struct {\r
	99	UINT8 OpCode;\r
d80ed2a7	100	UINT8 Lun; ///< Lun (high 3 bits)\r
e237e7ae	101	UINT8 Reserved0[2];\r
	102	UINT8 AllocLen;\r
	103	UINT8 Reserved1;\r
	104	UINT8 Pad[6];\r
	105	} USB_BOOT_INQUIRY_CMD;\r
	106	\r
	107	typedef struct {\r
d80ed2a7	108	UINT8 Pdt; ///< Peripheral Device Type (low 5 bits)\r
d80ed2a7	109	UINT8 Removable; ///< Removable Media (highest bit)\r
e237e7ae	110	UINT8 Reserved0[2];\r
d80ed2a7	111	UINT8 AddLen; ///< Additional length\r
e237e7ae	112	UINT8 Reserved1[3];\r
	113	UINT8 VendorID[8];\r
	114	UINT8 ProductID[16];\r
	115	UINT8 ProductRevision[4];\r
	116	} USB_BOOT_INQUIRY_DATA;\r
	117	\r
	118	typedef struct {\r
	119	UINT8 OpCode;\r
	120	UINT8 Lun;\r
	121	UINT8 Reserved0[8];\r
	122	UINT8 Pad[2];\r
	123	} USB_BOOT_READ_CAPACITY_CMD;\r
	124	\r
	125	typedef struct {\r
	126	UINT8 LastLba[4];\r
	127	UINT8 BlockLen[4];\r
	128	} USB_BOOT_READ_CAPACITY_DATA;\r
	129	\r
	130	typedef struct {\r
	131	UINT8 OpCode;\r
	132	UINT8 Lun;\r
	133	UINT8 Reserved[4];\r
	134	UINT8 Pad[6];\r
	135	} USB_BOOT_TEST_UNIT_READY_CMD;\r
	136	\r
	137	typedef struct {\r
	138	UINT8 OpCode;\r
	139	UINT8 Lun;\r
	140	UINT8 PageCode;\r
	141	UINT8 Reserved0[4];\r
	142	UINT8 ParaListLenMsb;\r
	143	UINT8 ParaListLenLsb;\r
	144	UINT8 Reserved1;\r
	145	UINT8 Pad[2];\r
50fa1b3a	146	} USB_BOOT_MODE_SENSE10_CMD;\r
e237e7ae	147	\r
	148	typedef struct {\r
	149	UINT8 ModeDataLenMsb;\r
	150	UINT8 ModeDataLenLsb;\r
	151	UINT8 Reserved0[4];\r
	152	UINT8 BlkDesLenMsb;\r
	153	UINT8 BlkDesLenLsb;\r
50fa1b3a	154	} USB_BOOT_MODE_SENSE10_PARA_HEADER;\r
e237e7ae	155	\r
	156	typedef struct {\r
	157	UINT8 OpCode;\r
d80ed2a7	158	UINT8 Lun; ///< Lun (High 3 bits)\r
d80ed2a7	159	UINT8 Lba[4]; ///< Logical block address\r
e237e7ae	160	UINT8 Reserved0;\r
d80ed2a7	161	UINT8 TransferLen[2]; ///< Transfer length\r
e237e7ae	162	UINT8 Reserverd1;\r
	163	UINT8 Pad[2];\r
	164	} USB_BOOT_READ10_CMD;\r
	165	\r
	166	typedef struct {\r
	167	UINT8 OpCode;\r
	168	UINT8 Lun;\r
	169	UINT8 Lba[4];\r
	170	UINT8 Reserved0;\r
	171	UINT8 TransferLen[2];\r
	172	UINT8 Reserverd1;\r
	173	UINT8 Pad[2];\r
	174	} USB_BOOT_WRITE10_CMD;\r
	175	\r
	176	typedef struct {\r
	177	UINT8 OpCode;\r
d80ed2a7	178	UINT8 Lun; ///< Lun (High 3 bits)\r
e237e7ae	179	UINT8 Reserved0[2];\r
d80ed2a7	180	UINT8 AllocLen; ///< Allocation length\r
e237e7ae	181	UINT8 Reserved1;\r
	182	UINT8 Pad[6];\r
	183	} USB_BOOT_REQUEST_SENSE_CMD;\r
	184	\r
	185	typedef struct {\r
	186	UINT8 ErrorCode;\r
	187	UINT8 Reserved0;\r
d80ed2a7	188	UINT8 SenseKey; ///< Sense key (low 4 bits)\r
e237e7ae	189	UINT8 Infor[4];\r
d80ed2a7	190	UINT8 AddLen; ///< Additional Sense length, 10\r
e237e7ae	191	UINT8 Reserved1[4];\r
1ccdbf2a	192	UINT8 Asc; ///< Additional Sense Code\r
1ccdbf2a	193	UINT8 Ascq; ///< Additional Sense Code Qualifier\r
e237e7ae	194	UINT8 Reserverd2[4];\r
e237e7ae	195	} USB_BOOT_REQUEST_SENSE_DATA;\r
50fa1b3a	196	\r
	197	typedef struct {\r
	198	UINT8 OpCode;\r
	199	UINT8 Lun;\r
	200	UINT8 PageCode;\r
	201	UINT8 Reserved0;\r
	202	UINT8 AllocateLen;\r
	203	UINT8 Control;\r
	204	} USB_SCSI_MODE_SENSE6_CMD;\r
	205	\r
	206	typedef struct {\r
	207	UINT8 ModeDataLen;\r
41e8ff27	208	UINT8 MediumType;\r
50fa1b3a	209	UINT8 DevicePara;\r
	210	UINT8 BlkDesLen;\r
	211	} USB_SCSI_MODE_SENSE6_PARA_HEADER;\r
e237e7ae	212	#pragma pack()\r
	213	\r
	214	//\r
	215	// Convert a LUN number to that in the command\r
	216	//\r
	217	#define USB_BOOT_LUN(Lun) ((Lun) << 5)\r
	218	\r
	219	//\r
	220	// Get the removable, PDT, and sense key bits from the command data\r
	221	//\r
d80ed2a7	222	#define USB_BOOT_REMOVABLE(RmbByte) (((RmbByte) & BIT7) != 0)\r
e237e7ae	223	#define USB_BOOT_PDT(Pdt) ((Pdt) & 0x1f)\r
	224	#define USB_BOOT_SENSE_KEY(Key) ((Key) & 0x0f)\r
	225	\r
cc5166ff	226	/**\r
3e03cb4d	227	Get the parameters for the USB mass storage media.\r
	228	\r
	229	This function get the parameters for the USB mass storage media,\r
	230	It is used both to initialize the media during the Start() phase\r
	231	of Driver Binding Protocol and to re-initialize it when the media is\r
cc5166ff	232	changed. Althought the RemoveableMedia is unlikely to change,\r
3e03cb4d	233	it is also included here.\r
cc5166ff	234	\r
3e03cb4d	235	@param UsbMass The device to retrieve disk gemotric.\r
cc5166ff	236	\r
cc5166ff	237	@retval EFI_SUCCESS The disk gemotric is successfully retrieved.\r
3e03cb4d	238	@retval Other Failed to get the parameters.\r
cc5166ff	239	\r
cc5166ff	240	**/\r
e237e7ae	241	EFI_STATUS\r
	242	UsbBootGetParams (\r
	243	IN USB_MASS_DEVICE *UsbMass\r
	244	);\r
	245	\r
cc5166ff	246	/**\r
3e03cb4d	247	Execute TEST UNIT READY command to check if the device is ready.\r
cc5166ff	248	\r
	249	@param UsbMass The device to test\r
	250	\r
3e03cb4d	251	@retval EFI_SUCCESS The device is ready.\r
cc5166ff	252	@retval Others Device not ready.\r
	253	\r
	254	**/\r
e237e7ae	255	EFI_STATUS\r
	256	UsbBootIsUnitReady (\r
	257	IN USB_MASS_DEVICE *UsbMass\r
	258	);\r
	259	\r
cc5166ff	260	/**\r
cc5166ff	261	Detect whether the removable media is present and whether it has changed.\r
cc5166ff	262	\r
3e03cb4d	263	@param UsbMass The device to check.\r
cc5166ff	264	\r
3e03cb4d	265	@retval EFI_SUCCESS The media status is successfully checked.\r
3e03cb4d	266	@retval Other Failed to detect media.\r
cc5166ff	267	\r
cc5166ff	268	**/\r
e237e7ae	269	EFI_STATUS\r
	270	UsbBootDetectMedia (\r
	271	IN USB_MASS_DEVICE *UsbMass\r
	272	);\r
	273	\r
cc5166ff	274	/**\r
	275	Read some blocks from the device.\r
	276	\r
	277	@param UsbMass The USB mass storage device to read from\r
	278	@param Lba The start block number\r
	279	@param TotalBlock Total block number to read\r
	280	@param Buffer The buffer to read to\r
	281	\r
	282	@retval EFI_SUCCESS Data are read into the buffer\r
	283	@retval Others Failed to read all the data\r
	284	\r
	285	**/\r
e237e7ae	286	EFI_STATUS\r
	287	UsbBootReadBlocks (\r
	288	IN USB_MASS_DEVICE *UsbMass,\r
	289	IN UINT32 Lba,\r
	290	IN UINTN TotalBlock,\r
	291	OUT UINT8 *Buffer\r
	292	);\r
	293	\r
cc5166ff	294	/**\r
	295	Write some blocks to the device.\r
	296	\r
	297	@param UsbMass The USB mass storage device to write to\r
	298	@param Lba The start block number\r
	299	@param TotalBlock Total block number to write\r
3e03cb4d	300	@param Buffer Pointer to the source buffer for the data.\r
cc5166ff	301	\r
	302	@retval EFI_SUCCESS Data are written into the buffer\r
	303	@retval Others Failed to write all the data\r
	304	\r
	305	**/\r
e237e7ae	306	EFI_STATUS\r
	307	UsbBootWriteBlocks (\r
	308	IN USB_MASS_DEVICE *UsbMass,\r
	309	IN UINT32 Lba,\r
	310	IN UINTN TotalBlock,\r
3e03cb4d	311	IN UINT8 *Buffer\r
e237e7ae	312	);\r
3e03cb4d	313	\r
99c1725e	314	/**\r
	315	Read some blocks from the device by SCSI 16 byte cmd.\r
	316	\r
	317	@param UsbMass The USB mass storage device to read from\r
	318	@param Lba The start block number\r
	319	@param TotalBlock Total block number to read\r
	320	@param Buffer The buffer to read to\r
	321	\r
	322	@retval EFI_SUCCESS Data are read into the buffer\r
	323	@retval Others Failed to read all the data\r
	324	\r
	325	**/\r
	326	EFI_STATUS\r
	327	UsbBootReadBlocks16 (\r
	328	IN USB_MASS_DEVICE *UsbMass,\r
	329	IN UINT64 Lba,\r
	330	IN UINTN TotalBlock,\r
	331	OUT UINT8 *Buffer\r
	332	);\r
	333	\r
	334	/**\r
	335	Write some blocks to the device by SCSI 16 byte cmd.\r
	336	\r
	337	@param UsbMass The USB mass storage device to write to\r
	338	@param Lba The start block number\r
	339	@param TotalBlock Total block number to write\r
	340	@param Buffer Pointer to the source buffer for the data.\r
	341	\r
	342	@retval EFI_SUCCESS Data are written into the buffer\r
	343	@retval Others Failed to write all the data\r
	344	\r
	345	**/\r
	346	EFI_STATUS\r
	347	UsbBootWriteBlocks16 (\r
	348	IN USB_MASS_DEVICE *UsbMass,\r
	349	IN UINT64 Lba,\r
	350	IN UINTN TotalBlock,\r
	351	IN UINT8 *Buffer\r
	352	);\r
	353	\r
	354	\r
3e03cb4d	355	/**\r
	356	Use the USB clear feature control transfer to clear the endpoint stall condition.\r
	357	\r
	358	@param UsbIo The USB I/O Protocol instance\r
	359	@param EndpointAddr The endpoint to clear stall for\r
	360	\r
	361	@retval EFI_SUCCESS The endpoint stall condition is cleared.\r
	362	@retval Others Failed to clear the endpoint stall condition.\r
	363	\r
	364	**/\r
	365	EFI_STATUS\r
	366	UsbClearEndpointStall (\r
	367	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
	368	IN UINT8 EndpointAddr\r
	369	);\r
	370	\r
e237e7ae	371	#endif\r
e237e7ae	372	\r