[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 - 2018, 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 64KB.\r
//\r
#define USB_BOOT_MAX_CARRY_SIZE         SIZE_64KB\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_READ_WRITE_10_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
  Read or write some blocks from the device.\r
\r
  @param  UsbMass                The USB mass storage device to access\r
  @param  Write                  TRUE for write operation.\r
  @param  Lba                    The start block number\r
  @param  TotalBlock             Total block number to read or write\r
  @param  Buffer                 The buffer to read to or write from\r
\r
  @retval EFI_SUCCESS            Data are read into the buffer or writen into the device.\r
  @retval Others                 Failed to read or write all the data\r
\r
**/\r
EFI_STATUS\r
UsbBootReadWriteBlocks (\r
  IN  USB_MASS_DEVICE       *UsbMass,\r
  IN  BOOLEAN               Write,\r
  IN  UINT32                Lba,\r
  IN  UINTN                 TotalBlock,\r
  IN OUT UINT8              *Buffer\r
  );\r
\r
/**\r
  Read or write some blocks from the device by SCSI 16 byte cmd.\r
\r
  @param  UsbMass                The USB mass storage device to access\r
  @param  Write                  TRUE for write operation.\r
  @param  Lba                    The start block number\r
  @param  TotalBlock             Total block number to read or write\r
  @param  Buffer                 The buffer to read to or write from\r
\r
  @retval EFI_SUCCESS            Data are read into the buffer or writen into the device.\r
  @retval Others                 Failed to read or write all the data\r
**/\r
EFI_STATUS\r
UsbBootReadWriteBlocks16 (\r
  IN  USB_MASS_DEVICE       *UsbMass,\r
  IN  BOOLEAN               Write,\r
  IN  UINT64                Lba,\r
  IN  UINTN                 TotalBlock,\r
  IN OUT UINT8              *Buffer\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
d1102dba	5	Copyright (c) 2007 - 2018, 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
d1102dba	24	// they should be retried if driver is ready.\r
1ccdbf2a	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
824b6e3b	68	// Other parameters, Max carried size is 64KB.\r
1ccdbf2a	69	//\r
824b6e3b	70	#define USB_BOOT_MAX_CARRY_SIZE SIZE_64KB\r
1ccdbf2a	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
d1102dba LG	85	// USB2.0 Spec define the up-limit timeout 5s for all command. USB floppy,\r
d1102dba LG	86	// USB CD-Rom and iPod devices are much slower than USB key when reponse\r
1ccdbf2a	87	// most of commands, So we set 5s as timeout here.\r
d1102dba	88	//\r
1ccdbf2a	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
d1102dba	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
e237e7ae	163	UINT8 Pad[2];\r
e59db6a7	164	} USB_BOOT_READ_WRITE_10_CMD;\r
e237e7ae	165	\r
	166	typedef struct {\r
	167	UINT8 OpCode;\r
d80ed2a7	168	UINT8 Lun; ///< Lun (High 3 bits)\r
e237e7ae	169	UINT8 Reserved0[2];\r
d80ed2a7	170	UINT8 AllocLen; ///< Allocation length\r
e237e7ae	171	UINT8 Reserved1;\r
	172	UINT8 Pad[6];\r
	173	} USB_BOOT_REQUEST_SENSE_CMD;\r
	174	\r
	175	typedef struct {\r
	176	UINT8 ErrorCode;\r
	177	UINT8 Reserved0;\r
d80ed2a7	178	UINT8 SenseKey; ///< Sense key (low 4 bits)\r
e237e7ae	179	UINT8 Infor[4];\r
d80ed2a7	180	UINT8 AddLen; ///< Additional Sense length, 10\r
e237e7ae	181	UINT8 Reserved1[4];\r
1ccdbf2a	182	UINT8 Asc; ///< Additional Sense Code\r
1ccdbf2a	183	UINT8 Ascq; ///< Additional Sense Code Qualifier\r
e237e7ae	184	UINT8 Reserverd2[4];\r
e237e7ae	185	} USB_BOOT_REQUEST_SENSE_DATA;\r
50fa1b3a	186	\r
	187	typedef struct {\r
	188	UINT8 OpCode;\r
	189	UINT8 Lun;\r
	190	UINT8 PageCode;\r
	191	UINT8 Reserved0;\r
	192	UINT8 AllocateLen;\r
	193	UINT8 Control;\r
	194	} USB_SCSI_MODE_SENSE6_CMD;\r
	195	\r
	196	typedef struct {\r
	197	UINT8 ModeDataLen;\r
41e8ff27	198	UINT8 MediumType;\r
50fa1b3a	199	UINT8 DevicePara;\r
	200	UINT8 BlkDesLen;\r
	201	} USB_SCSI_MODE_SENSE6_PARA_HEADER;\r
e237e7ae	202	#pragma pack()\r
	203	\r
	204	//\r
	205	// Convert a LUN number to that in the command\r
	206	//\r
	207	#define USB_BOOT_LUN(Lun) ((Lun) << 5)\r
	208	\r
	209	//\r
	210	// Get the removable, PDT, and sense key bits from the command data\r
	211	//\r
d80ed2a7	212	#define USB_BOOT_REMOVABLE(RmbByte) (((RmbByte) & BIT7) != 0)\r
e237e7ae	213	#define USB_BOOT_PDT(Pdt) ((Pdt) & 0x1f)\r
	214	#define USB_BOOT_SENSE_KEY(Key) ((Key) & 0x0f)\r
	215	\r
cc5166ff	216	/**\r
3e03cb4d	217	Get the parameters for the USB mass storage media.\r
	218	\r
	219	This function get the parameters for the USB mass storage media,\r
	220	It is used both to initialize the media during the Start() phase\r
	221	of Driver Binding Protocol and to re-initialize it when the media is\r
cc5166ff	222	changed. Althought the RemoveableMedia is unlikely to change,\r
3e03cb4d	223	it is also included here.\r
cc5166ff	224	\r
3e03cb4d	225	@param UsbMass The device to retrieve disk gemotric.\r
cc5166ff	226	\r
cc5166ff	227	@retval EFI_SUCCESS The disk gemotric is successfully retrieved.\r
3e03cb4d	228	@retval Other Failed to get the parameters.\r
cc5166ff	229	\r
cc5166ff	230	**/\r
e237e7ae	231	EFI_STATUS\r
	232	UsbBootGetParams (\r
	233	IN USB_MASS_DEVICE *UsbMass\r
	234	);\r
	235	\r
cc5166ff	236	/**\r
3e03cb4d	237	Execute TEST UNIT READY command to check if the device is ready.\r
cc5166ff	238	\r
	239	@param UsbMass The device to test\r
	240	\r
3e03cb4d	241	@retval EFI_SUCCESS The device is ready.\r
cc5166ff	242	@retval Others Device not ready.\r
	243	\r
	244	**/\r
e237e7ae	245	EFI_STATUS\r
	246	UsbBootIsUnitReady (\r
	247	IN USB_MASS_DEVICE *UsbMass\r
	248	);\r
	249	\r
cc5166ff	250	/**\r
cc5166ff	251	Detect whether the removable media is present and whether it has changed.\r
cc5166ff	252	\r
3e03cb4d	253	@param UsbMass The device to check.\r
cc5166ff	254	\r
3e03cb4d	255	@retval EFI_SUCCESS The media status is successfully checked.\r
3e03cb4d	256	@retval Other Failed to detect media.\r
cc5166ff	257	\r
cc5166ff	258	**/\r
e237e7ae	259	EFI_STATUS\r
	260	UsbBootDetectMedia (\r
	261	IN USB_MASS_DEVICE *UsbMass\r
	262	);\r
	263	\r
cc5166ff	264	/**\r
	265	Read some blocks from the device.\r
	266	\r
	267	@param UsbMass The USB mass storage device to read from\r
	268	@param Lba The start block number\r
	269	@param TotalBlock Total block number to read\r
	270	@param Buffer The buffer to read to\r
	271	\r
	272	@retval EFI_SUCCESS Data are read into the buffer\r
	273	@retval Others Failed to read all the data\r
	274	\r
	275	**/\r
e237e7ae	276	EFI_STATUS\r
	277	UsbBootReadBlocks (\r
	278	IN USB_MASS_DEVICE *UsbMass,\r
	279	IN UINT32 Lba,\r
	280	IN UINTN TotalBlock,\r
	281	OUT UINT8 *Buffer\r
	282	);\r
	283	\r
cc5166ff	284	/**\r
e59db6a7	285	Read or write some blocks from the device.\r
cc5166ff	286	\r
e59db6a7 RN	287	@param UsbMass The USB mass storage device to access\r
e59db6a7 RN	288	@param Write TRUE for write operation.\r
cc5166ff	289	@param Lba The start block number\r
e59db6a7 RN	290	@param TotalBlock Total block number to read or write\r
e59db6a7 RN	291	@param Buffer The buffer to read to or write from\r
cc5166ff	292	\r
e59db6a7 RN	293	@retval EFI_SUCCESS Data are read into the buffer or writen into the device.\r
e59db6a7 RN	294	@retval Others Failed to read or write all the data\r
cc5166ff	295	\r
cc5166ff	296	**/\r
e237e7ae	297	EFI_STATUS\r
e59db6a7 RN	298	UsbBootReadWriteBlocks (\r
	299	IN USB_MASS_DEVICE *UsbMass,\r
	300	IN BOOLEAN Write,\r
	301	IN UINT32 Lba,\r
	302	IN UINTN TotalBlock,\r
	303	IN OUT UINT8 *Buffer\r
e237e7ae	304	);\r
3e03cb4d	305	\r
99c1725e	306	/**\r
e59db6a7	307	Read or write some blocks from the device by SCSI 16 byte cmd.\r
99c1725e	308	\r
e59db6a7 RN	309	@param UsbMass The USB mass storage device to access\r
e59db6a7 RN	310	@param Write TRUE for write operation.\r
99c1725e	311	@param Lba The start block number\r
e59db6a7 RN	312	@param TotalBlock Total block number to read or write\r
e59db6a7 RN	313	@param Buffer The buffer to read to or write from\r
99c1725e	314	\r
e59db6a7 RN	315	@retval EFI_SUCCESS Data are read into the buffer or writen into the device.\r
e59db6a7 RN	316	@retval Others Failed to read or write all the data\r
99c1725e	317	**/\r
99c1725e	318	EFI_STATUS\r
e59db6a7	319	UsbBootReadWriteBlocks16 (\r
99c1725e	320	IN USB_MASS_DEVICE *UsbMass,\r
e59db6a7	321	IN BOOLEAN Write,\r
99c1725e	322	IN UINT64 Lba,\r
99c1725e	323	IN UINTN TotalBlock,\r
e59db6a7	324	IN OUT UINT8 *Buffer\r
99c1725e	325	);\r
99c1725e	326	\r
3e03cb4d	327	/**\r
	328	Use the USB clear feature control transfer to clear the endpoint stall condition.\r
	329	\r
	330	@param UsbIo The USB I/O Protocol instance\r
	331	@param EndpointAddr The endpoint to clear stall for\r
	332	\r
	333	@retval EFI_SUCCESS The endpoint stall condition is cleared.\r
	334	@retval Others Failed to clear the endpoint stall condition.\r
	335	\r
	336	**/\r
	337	EFI_STATUS\r
	338	UsbClearEndpointStall (\r
	339	IN EFI_USB_IO_PROTOCOL *UsbIo,\r
	340	IN UINT8 EndpointAddr\r
	341	);\r
	342	\r
e237e7ae	343	#endif\r
e237e7ae	344	\r