UsbMassBoot.h

Go to the documentation of this file.

 
#ifndef _EFI_USB_MASS_BOOT_H_
#define _EFI_USB_MASS_BOOT_H_
 
//
// The opcodes of various USB boot commands:
// INQUIRY/REQUEST_SENSE are "No Timeout Commands" as specified
// by Multi-Media Commands (MMC) set.
// Others are "Group 1 Timeout Commands". That is,
// they should be retried if driver is ready.
//
#define USB_BOOT_INQUIRY_OPCODE          0x12
#define USB_BOOT_REQUEST_SENSE_OPCODE    0x03
#define USB_BOOT_MODE_SENSE10_OPCODE     0x5A
#define USB_BOOT_READ_CAPACITY_OPCODE    0x25
#define USB_BOOT_TEST_UNIT_READY_OPCODE  0x00
#define USB_BOOT_READ10_OPCODE           0x28
#define USB_BOOT_WRITE10_OPCODE          0x2A
 
#define USB_SCSI_MODE_SENSE6_OPCODE  0x1A
 
//
// The Sense Key part of the sense data. Sense data has three levels:
// Sense key, Additional Sense Code and Additional Sense Code Qualifier
//
#define USB_BOOT_SENSE_NO_SENSE         0x00 
#define USB_BOOT_SENSE_RECOVERED        0x01 
#define USB_BOOT_SENSE_NOT_READY        0x02 
#define USB_BOOT_SNESE_MEDIUM_ERROR     0X03 
#define USB_BOOT_SENSE_HARDWARE_ERROR   0X04 
#define USB_BOOT_SENSE_ILLEGAL_REQUEST  0X05 
#define USB_BOOT_SENSE_UNIT_ATTENTION   0X06 
#define USB_BOOT_SENSE_DATA_PROTECT     0X07 
#define USB_BOOT_SENSE_BLANK_CHECK      0X08 
#define USB_BOOT_SENSE_VENDOR           0X09 
#define USB_BOOT_SENSE_ABORTED          0X0B 
#define USB_BOOT_SENSE_VOLUME_OVERFLOW  0x0D 
#define USB_BOOT_SENSE_MISCOMPARE       0x0E 
 
#define USB_BOOT_ASC_NO_ADDITIONAL_SENSE_INFORMATION  0x00
#define USB_BOOT_ASC_NOT_READY                        0x04
#define USB_BOOT_ASC_NO_MEDIA                         0x3A
#define USB_BOOT_ASC_MEDIA_CHANGE                     0x28
 
//
// Supported PDT codes, or Peripheral Device Type
//
#define USB_PDT_DIRECT_ACCESS  0x00                
#define USB_PDT_CDROM          0x05                
#define USB_PDT_OPTICAL        0x07                
#define USB_PDT_SIMPLE_DIRECT  0x0E                
 
//
// Other parameters, Max carried size is 64KB.
//
#define USB_BOOT_MAX_CARRY_SIZE  SIZE_64KB
 
//
// Retry mass command times, set by experience
//
#define USB_BOOT_COMMAND_RETRY  5
 
//
// Wait for unit ready command, set by experience
//
#define USB_BOOT_RETRY_UNIT_READY_STALL  (500 * USB_MASS_1_MILLISECOND)
 
//
// Mass command timeout, refers to specification[USB20-9.2.6.1]
//
// USB2.0 Spec define the up-limit timeout 5s for all command. USB floppy,
// USB CD-Rom and iPod devices are much slower than USB key when response
// most of commands, So we set 5s as timeout here.
//
#define USB_BOOT_GENERAL_CMD_TIMEOUT  (5 * USB_MASS_1_SECOND)
 
//
// The required commands are INQUIRY, READ CAPACITY, TEST UNIT READY,
// READ10, WRITE10, and REQUEST SENSE. The BLOCK_IO protocol uses LBA
// so it isn't necessary to issue MODE SENSE / READ FORMAT CAPACITY
// command to retrieve the disk gemotrics.
//
#pragma pack(1)
typedef struct {
  UINT8    OpCode;
  UINT8    Lun;                     
  UINT8    Reserved0[2];
  UINT8    AllocLen;
  UINT8    Reserved1;
  UINT8    Pad[6];
} USB_BOOT_INQUIRY_CMD;
 
typedef struct {
  UINT8    Pdt;                     
  UINT8    Removable;               
  UINT8    Reserved0[2];
  UINT8    AddLen;                  
  UINT8    Reserved1[3];
  UINT8    VendorID[8];
  UINT8    ProductID[16];
  UINT8    ProductRevision[4];
} USB_BOOT_INQUIRY_DATA;
 
typedef struct {
  UINT8    OpCode;
  UINT8    Lun;
  UINT8    Reserved0[8];
  UINT8    Pad[2];
} USB_BOOT_READ_CAPACITY_CMD;
 
typedef struct {
  UINT8    LastLba[4];
  UINT8    BlockLen[4];
} USB_BOOT_READ_CAPACITY_DATA;
 
typedef struct {
  UINT8    OpCode;
  UINT8    Lun;
  UINT8    Reserved[4];
  UINT8    Pad[6];
} USB_BOOT_TEST_UNIT_READY_CMD;
 
typedef struct {
  UINT8    OpCode;
  UINT8    Lun;
  UINT8    PageCode;
  UINT8    Reserved0[4];
  UINT8    ParaListLenMsb;
  UINT8    ParaListLenLsb;
  UINT8    Reserved1;
  UINT8    Pad[2];
} USB_BOOT_MODE_SENSE10_CMD;
 
typedef struct {
  UINT8    ModeDataLenMsb;
  UINT8    ModeDataLenLsb;
  UINT8    Reserved0[4];
  UINT8    BlkDesLenMsb;
  UINT8    BlkDesLenLsb;
} USB_BOOT_MODE_SENSE10_PARA_HEADER;
 
typedef struct {
  UINT8    OpCode;
  UINT8    Lun;                     
  UINT8    Lba[4];                  
  UINT8    Reserved0;
  UINT8    TransferLen[2];          
  UINT8    Reserverd1;
  UINT8    Pad[2];
} USB_BOOT_READ_WRITE_10_CMD;
 
typedef struct {
  UINT8    OpCode;
  UINT8    Lun;                     
  UINT8    Reserved0[2];
  UINT8    AllocLen;                
  UINT8    Reserved1;
  UINT8    Pad[6];
} USB_BOOT_REQUEST_SENSE_CMD;
 
typedef struct {
  UINT8    ErrorCode;
  UINT8    Reserved0;
  UINT8    SenseKey;                
  UINT8    Infor[4];
  UINT8    AddLen;                  
  UINT8    Reserved1[4];
  UINT8    Asc;                     
  UINT8    Ascq;                    
  UINT8    Reserverd2[4];
} USB_BOOT_REQUEST_SENSE_DATA;
 
typedef struct {
  UINT8    OpCode;
  UINT8    Lun;
  UINT8    PageCode;
  UINT8    Reserved0;
  UINT8    AllocateLen;
  UINT8    Control;
} USB_SCSI_MODE_SENSE6_CMD;
 
typedef struct {
  UINT8    ModeDataLen;
  UINT8    MediumType;
  UINT8    DevicePara;
  UINT8    BlkDesLen;
} USB_SCSI_MODE_SENSE6_PARA_HEADER;
#pragma pack()
 
//
// Convert a LUN number to that in the command
//
#define USB_BOOT_LUN(Lun)  ((Lun) << 5)
 
//
// Get the removable, PDT, and sense key bits from the command data
//
#define USB_BOOT_REMOVABLE(RmbByte)  (((RmbByte) & BIT7) != 0)
#define USB_BOOT_PDT(Pdt)            ((Pdt) & 0x1f)
#define USB_BOOT_SENSE_KEY(Key)      ((Key) & 0x0f)
 
EFI_STATUS
UsbBootGetParams (
  IN USB_MASS_DEVICE  *UsbMass
  );
 
EFI_STATUS
UsbBootIsUnitReady (
  IN USB_MASS_DEVICE  *UsbMass
  );
 
EFI_STATUS
UsbBootDetectMedia (
  IN  USB_MASS_DEVICE  *UsbMass
  );
 
EFI_STATUS
UsbBootReadBlocks (
  IN  USB_MASS_DEVICE  *UsbMass,
  IN  UINT32           Lba,
  IN  UINTN            TotalBlock,
  OUT UINT8            *Buffer
  );
 
EFI_STATUS
UsbBootReadWriteBlocks (
  IN  USB_MASS_DEVICE  *UsbMass,
  IN  BOOLEAN          Write,
  IN  UINT32           Lba,
  IN  UINTN            TotalBlock,
  IN OUT UINT8         *Buffer
  );
 
EFI_STATUS
UsbBootReadWriteBlocks16 (
  IN  USB_MASS_DEVICE  *UsbMass,
  IN  BOOLEAN          Write,
  IN  UINT64           Lba,
  IN  UINTN            TotalBlock,
  IN OUT UINT8         *Buffer
  );
 
EFI_STATUS
UsbClearEndpointStall (
  IN EFI_USB_IO_PROTOCOL  *UsbIo,
  IN UINT8                EndpointAddr
  );
 
#endif