UsbMass.h

Go to the documentation of this file.

 
#ifndef _EFI_USBMASS_H_
#define _EFI_USBMASS_H_
 
#include <Uefi.h>
#include <IndustryStandard/Scsi.h>
#include <Protocol/BlockIo.h>
#include <Protocol/UsbIo.h>
#include <Protocol/DevicePath.h>
#include <Protocol/DiskInfo.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/DevicePathLib.h>
 
typedef struct _USB_MASS_TRANSPORT  USB_MASS_TRANSPORT;
typedef struct _USB_MASS_DEVICE     USB_MASS_DEVICE;
 
#include "UsbMassBot.h"
#include "UsbMassCbi.h"
#include "UsbMassBoot.h"
#include "UsbMassDiskInfo.h"
#include "UsbMassImpl.h"
 
#define USB_IS_IN_ENDPOINT(EndPointAddr)      (((EndPointAddr) & BIT7) == BIT7)
#define USB_IS_OUT_ENDPOINT(EndPointAddr)     (((EndPointAddr) & BIT7) == 0)
#define USB_IS_BULK_ENDPOINT(Attribute)       (((Attribute) & (BIT0 | BIT1)) == USB_ENDPOINT_BULK)
#define USB_IS_INTERRUPT_ENDPOINT(Attribute)  (((Attribute) & (BIT0 | BIT1)) == USB_ENDPOINT_INTERRUPT)
#define USB_IS_ERROR(Result, Error)           (((Result) & (Error)) != 0)
 
#define USB_MASS_1_MILLISECOND  1000
#define USB_MASS_1_SECOND       (1000 * USB_MASS_1_MILLISECOND)
 
#define USB_MASS_CMD_SUCCESS     0
#define USB_MASS_CMD_FAIL        1
#define USB_MASS_CMD_PERSISTENT  2
 
typedef
EFI_STATUS
(*USB_MASS_INIT_TRANSPORT) (
  IN  EFI_USB_IO_PROTOCOL  *Usb,
  OUT VOID                 **Context    OPTIONAL
  );
 
typedef
EFI_STATUS
(*USB_MASS_EXEC_COMMAND) (
  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
  );
 
typedef
EFI_STATUS
(*USB_MASS_RESET) (
  IN  VOID     *Context,
  IN  BOOLEAN  ExtendedVerification
  );
 
typedef
EFI_STATUS
(*USB_MASS_GET_MAX_LUN) (
  IN  VOID   *Context,
  IN  UINT8  *MaxLun
  );
 
typedef
EFI_STATUS
(*USB_MASS_CLEAN_UP) (
  IN  VOID  *Context
  );
 
struct _USB_MASS_TRANSPORT {
  UINT8                      Protocol;
  USB_MASS_INIT_TRANSPORT    Init;        
  USB_MASS_EXEC_COMMAND      ExecCommand; 
  USB_MASS_RESET             Reset;       
  USB_MASS_GET_MAX_LUN       GetMaxLun;   
  USB_MASS_CLEAN_UP          CleanUp;     
};
 
struct _USB_MASS_DEVICE {
  UINT32                      Signature;
  EFI_HANDLE                  Controller;
  EFI_USB_IO_PROTOCOL         *UsbIo;
  EFI_DEVICE_PATH_PROTOCOL    *DevicePath;
  EFI_BLOCK_IO_PROTOCOL       BlockIo;
  EFI_BLOCK_IO_MEDIA          BlockIoMedia;
  BOOLEAN                     OpticalStorage;
  UINT8                       Lun;        
  UINT8                       Pdt;        
  USB_MASS_TRANSPORT          *Transport; 
  VOID                        *Context;
  EFI_DISK_INFO_PROTOCOL      DiskInfo;
  USB_BOOT_INQUIRY_DATA       InquiryData;
  BOOLEAN                     Cdb16Byte;
};
 
#endif