UsbMassCbi.h

Go to the documentation of this file.

 
#ifndef _EFI_USBMASS_CBI_H_
#define _EFI_USBMASS_CBI_H_
 
extern USB_MASS_TRANSPORT  mUsbCbi0Transport;
extern USB_MASS_TRANSPORT  mUsbCbi1Transport;
 
#define USB_CBI_MAX_PACKET_NUM  16
#define USB_CBI_RESET_CMD_LEN   12
//
// USB CBI retry C/B/I transport times, set by experience
//
#define USB_CBI_MAX_RETRY  3
//
// Time to wait for USB CBI reset to complete, set by experience
//
#define USB_CBI_RESET_DEVICE_STALL  (50 * USB_MASS_1_MILLISECOND)
//
// USB CBI transport timeout, set by experience
//
#define USB_CBI_RESET_DEVICE_TIMEOUT  (1 * USB_MASS_1_SECOND)
 
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;
  EFI_USB_ENDPOINT_DESCRIPTOR     *InterruptEndpoint;
  EFI_USB_IO_PROTOCOL             *UsbIo;
} USB_CBI_PROTOCOL;
 
#pragma pack(1)
typedef struct {
  UINT8    Type;
  UINT8    Value;
} USB_CBI_STATUS;
#pragma pack()
 
EFI_STATUS
UsbCbiInit (
  IN  EFI_USB_IO_PROTOCOL  *UsbIo,
  OUT VOID                 **Context       OPTIONAL
  );
 
EFI_STATUS
UsbCbiExecCommand (
  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
UsbCbiResetDevice (
  IN  VOID     *Context,
  IN  BOOLEAN  ExtendedVerification
  );
 
EFI_STATUS
UsbCbiCleanUp (
  IN  VOID  *Context
  );
 
#endif