UsbMassBot.h

Go to the documentation of this file.

 
#ifndef _EFI_USBMASS_BOT_H_
#define _EFI_USBMASS_BOT_H_
 
extern USB_MASS_TRANSPORT  mUsbBotTransport;
 
//
// Usb Bulk-Only class specific request
//
#define USB_BOT_RESET_REQUEST   0xFF        
#define USB_BOT_GETLUN_REQUEST  0xFE        
#define USB_BOT_CBW_SIGNATURE   0x43425355  
#define USB_BOT_CSW_SIGNATURE   0x53425355  
#define USB_BOT_MAX_LUN         0x0F        
#define USB_BOT_MAX_CMDLEN      16          
 
//
// Usb BOT command block status values
//
#define USB_BOT_COMMAND_OK      0x00  
#define USB_BOT_COMMAND_FAILED  0x01  
#define USB_BOT_COMMAND_ERROR   0x02  
 
//
// Usb Bot retry to get CSW, refers to specification[BOT10-5.3, it says 2 times]
//
#define USB_BOT_RECV_CSW_RETRY  3
 
//
// Usb Bot wait device reset complete, set by experience
//
#define USB_BOT_RESET_DEVICE_STALL  (100 * USB_MASS_1_MILLISECOND)
 
//
// Usb Bot transport timeout, set by experience
//
#define USB_BOT_SEND_CBW_TIMEOUT      (3 * USB_MASS_1_SECOND)
#define USB_BOT_RECV_CSW_TIMEOUT      (3 * USB_MASS_1_SECOND)
#define USB_BOT_RESET_DEVICE_TIMEOUT  (3 * USB_MASS_1_SECOND)
 
#pragma pack(1)
typedef struct {
  UINT32    Signature;
  UINT32    Tag;
  UINT32    DataLen;            
  UINT8     Flag;               
  UINT8     Lun;                
  UINT8     CmdLen;             
  UINT8     CmdBlock[USB_BOT_MAX_CMDLEN];
} USB_BOT_CBW;
 
typedef struct {
  UINT32    Signature;
  UINT32    Tag;
  UINT32    DataResidue;
  UINT8     CmdStatus;
} USB_BOT_CSW;
#pragma pack()
 
typedef struct {
  //
  // Put Interface at the first field to make it easy to distinguish BOT/CBI Protocol instance
  //
  EFI_USB_INTERFACE_DESCRIPTOR    Interface;
  EFI_USB_ENDPOINT_DESCRIPTOR     *BulkInEndpoint;
  EFI_USB_ENDPOINT_DESCRIPTOR     *BulkOutEndpoint;
  UINT32                          CbwTag;
  EFI_USB_IO_PROTOCOL             *UsbIo;
} USB_BOT_PROTOCOL;
 
EFI_STATUS
UsbBotInit (
  IN  EFI_USB_IO_PROTOCOL  *UsbIo,
  OUT VOID                 **Context OPTIONAL
  );
 
EFI_STATUS
UsbBotExecCommand (
  IN  VOID                    *Context,
  IN  VOID                    *Cmd,
  IN  UINT8                   CmdLen,
  IN  EFI_USB_DATA_DIRECTION  DataDir,
  IN  VOID                    *Data,
  IN  UINT32                  DataLen,
  IN  UINT8                   Lun,
  IN  UINT32                  Timeout,
  OUT UINT32                  *CmdStatus
  );
 
EFI_STATUS
UsbBotResetDevice (
  IN  VOID     *Context,
  IN  BOOLEAN  ExtendedVerification
  );
 
EFI_STATUS
UsbBotGetMaxLun (
  IN  VOID   *Context,
  OUT UINT8  *MaxLun
  );
 
EFI_STATUS
UsbBotCleanUp (
  IN  VOID  *Context
  );
 
#endif