MdeModulePkg/Bus/Usb/UsbMassStorageDxe/UsbMass.h

   1 /** @file
   2   Definition of USB Mass Storage Class and its value, USB Mass Transport Protocol,
   3   and other common definitions.
   4
   5 Copyright (c) 2007 - 2008, Intel Corporation
   6 All rights reserved. This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef _EFI_USBMASS_H_
  17 #define _EFI_USBMASS_H_
  18
  19
  20 #include <Uefi.h>
  21
  22 #include <Protocol/BlockIo.h>
  23 #include <Protocol/UsbIo.h>
  24 #include <Protocol/DevicePath.h>
  25
  26 #include <Library/DebugLib.h>
  27 #include <Library/BaseMemoryLib.h>
  28 #include <Library/UefiDriverEntryPoint.h>
  29 #include <Library/UefiBootServicesTableLib.h>
  30 #include <Library/UefiLib.h>
  31 #include <Library/MemoryAllocationLib.h>
  32 #include <Library/DevicePathLib.h>
  33
  34 #define USB_IS_IN_ENDPOINT(EndPointAddr)      (((EndPointAddr) & BIT7) == BIT7)
  35 #define USB_IS_OUT_ENDPOINT(EndPointAddr)     (((EndPointAddr) & BIT7) == 0)
  36 #define USB_IS_BULK_ENDPOINT(Attribute)       (((Attribute) & (BIT0 | BIT1)) == USB_ENDPOINT_BULK)
  37 #define USB_IS_INTERRUPT_ENDPOINT(Attribute)  (((Attribute) & (BIT0 | BIT1)) == USB_ENDPOINT_INTERRUPT)
  38 #define USB_IS_ERROR(Result, Error)           (((Result) & (Error)) != 0)
  39
  40 typedef enum {
  41   //
  42   // Usb mass storage class code
  43   //
  44   USB_MASS_STORE_CLASS    = 0x08,
  45
  46   //
  47   // Usb mass storage subclass code, specify the command set used.
  48   //
  49   USB_MASS_STORE_RBC      = 0x01, ///< Reduced Block Commands
  50   USB_MASS_STORE_8020I    = 0x02, ///< SFF-8020i, typically a CD/DVD device
  51   USB_MASS_STORE_QIC      = 0x03, ///< Typically a tape device
  52   USB_MASS_STORE_UFI      = 0x04, ///< Typically a floppy disk driver device
  53   USB_MASS_STORE_8070I    = 0x05, ///< SFF-8070i, typically a floppy disk driver device.
  54   USB_MASS_STORE_SCSI     = 0x06, ///< SCSI transparent command set
  55
  56   //
  57   // Usb mass storage protocol code, specify the transport protocol
  58   //
  59   USB_MASS_STORE_CBI0     = 0x00, ///< CBI protocol with command completion interrupt
  60   USB_MASS_STORE_CBI1     = 0x01, ///< CBI protocol without command completion interrupt
  61   USB_MASS_STORE_BOT      = 0x50, ///< Bulk-Only Transport
  62
  63   USB_MASS_1_MILLISECOND  = 1000,
  64   USB_MASS_1_SECOND       = 1000 * USB_MASS_1_MILLISECOND,
  65
  66   USB_MASS_CMD_SUCCESS    = 0,
  67   USB_MASS_CMD_FAIL,
  68   USB_MASS_CMD_PERSISTENT
  69 } USB_MASS_DEV_CLASS_AND_VALUE;
  70
  71 /**
  72   Initializes USB transport protocol.
  73
  74   This function initializes the USB mass storage class transport protocol.
  75   It will save its context in the Context if Context isn't NULL.
  76
  77   @param  UsbIo                 The USB I/O Protocol instance
  78   @param  Context               The buffer to save the context to
  79
  80   @retval EFI_SUCCESS           The device is successfully initialized.
  81   @retval EFI_UNSUPPORTED       The transport protocol doesn't support the device.
  82   @retval Other                 The USB transport initialization fails.
  83
  84 **/
  85 typedef
  86 EFI_STATUS
  87 (*USB_MASS_INIT_TRANSPORT) (
  88   IN  EFI_USB_IO_PROTOCOL     *Usb,
  89   OUT VOID                    **Context    OPTIONAL
  90   );
  91
  92 /**
  93   Execute USB mass storage command through the transport protocol.
  94
  95   @param  Context               The USB Transport Protocol.
  96   @param  Cmd                   The command to transfer to device
  97   @param  CmdLen                The length of the command
  98   @param  DataDir               The direction of data transfer
  99   @param  Data                  The buffer to hold the data
 100   @param  DataLen               The length of the buffer
 101   @param  Lun                   Should be 0, this field for bot only
 102   @param  Timeout               The time to wait
 103   @param  CmdStatus             The result of the command execution
 104
 105   @retval EFI_SUCCESS           The command is executed successfully.
 106   @retval Other                 Failed to execute the command
 107
 108 **/
 109 typedef
 110 EFI_STATUS
 111 (*USB_MASS_EXEC_COMMAND) (
 112   IN  VOID                    *Context,
 113   IN  VOID                    *Cmd,
 114   IN  UINT8                   CmdLen,
 115   IN  EFI_USB_DATA_DIRECTION  DataDir,
 116   IN  VOID                    *Data,
 117   IN  UINT32                  DataLen,
 118   IN  UINT8                   Lun,
 119   IN  UINT32                  Timeout,
 120   OUT UINT32                  *CmdStatus
 121   );
 122
 123 /**
 124   Reset the USB mass storage device by Transport protocol.
 125
 126   @param  Context               The USB Transport Protocol
 127   @param  ExtendedVerification  The flag controlling the rule of reset.
 128                                 Not used here.
 129
 130   @retval EFI_SUCCESS           The device is reset.
 131   @retval Others                Failed to reset the device.
 132
 133 **/
 134 typedef
 135 EFI_STATUS
 136 (*USB_MASS_RESET) (
 137   IN  VOID                    *Context,
 138   IN  BOOLEAN                 ExtendedVerification
 139   );
 140
 141 /**
 142   Get the max LUN (Logical Unit Number) of USB mass storage device.
 143
 144   @param  Context          The context of the transport protocol.
 145   @param  MaxLun           Return pointer to the max number of LUN. (e.g. MaxLun=1 means LUN0 and
 146                            LUN1 in all.)
 147
 148   @retval EFI_SUCCESS      Max LUN is got successfully.
 149   @retval Others           Fail to execute this request.
 150
 151 **/
 152 typedef
 153 EFI_STATUS
 154 (*USB_MASS_GET_MAX_LUN) (
 155   IN  VOID                    *Context,
 156   IN  UINT8                   *MaxLun
 157   );
 158
 159 /**
 160   Clean up the transport protocol's resource.
 161
 162   @param  Context               The instance of transport protocol.
 163
 164   @retval EFI_SUCCESS           The resource is cleaned up.
 165
 166 **/
 167 typedef
 168 EFI_STATUS
 169 (*USB_MASS_CLEAN_UP) (
 170   IN  VOID                    *Context
 171   );
 172
 173 ///
 174 /// This structure contains information necessary to select the
 175 /// proper transport protocol. The mass storage class defines
 176 /// two transport protocols. One is the CBI, and the other is BOT.
 177 /// CBI is being obseleted. The design is made modular by this
 178 /// structure so that the CBI protocol can be easily removed when
 179 /// it is no longer necessary.
 180 ///
 181 typedef struct {
 182   UINT8                   Protocol;
 183   USB_MASS_INIT_TRANSPORT Init;        ///< Initialize the mass storage transport protocol
 184   USB_MASS_EXEC_COMMAND   ExecCommand; ///< Transport command to the device then get result
 185   USB_MASS_RESET          Reset;       ///< Reset the device
 186   USB_MASS_GET_MAX_LUN    GetMaxLun;   ///< Get max lun, only for bot
 187   USB_MASS_CLEAN_UP       CleanUp;     ///< Clean up the resources.
 188 } USB_MASS_TRANSPORT;
 189
 190 typedef struct {
 191   UINT32                    Signature;
 192   EFI_HANDLE                Controller;
 193   EFI_USB_IO_PROTOCOL       *UsbIo;
 194   EFI_DEVICE_PATH_PROTOCOL  *DevicePath;
 195   EFI_BLOCK_IO_PROTOCOL     BlockIo;
 196   EFI_BLOCK_IO_MEDIA        BlockIoMedia;
 197   BOOLEAN                   OpticalStorage;
 198   UINT8                     Lun;          ///< Logical Unit Number
 199   UINT8                     Pdt;          ///< Peripheral Device Type
 200   USB_MASS_TRANSPORT        *Transport;   ///< USB mass storage transport protocol
 201   VOID                      *Context;
 202 } USB_MASS_DEVICE;
 203
 204 #endif