LUFA/Drivers/USB/Class/Host/MassStorage.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \ingroup Group_USBClassMS
  32  *  @defgroup Group_USBClassMassStorageHost Mass Storage Class Host Mode Driver
  33  *
  34  *  \section Sec_Dependencies Module Source Dependencies
  35  *  The following files must be built with any user project that uses this module:
  36  *    - LUFA/Drivers/USB/Class/Host/MassStorage.c
  37  *
  38  *  \section Module Description
  39  *  Host Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
  40  *
  41  *  @{
  42  */
  43
  44 #ifndef __MS_CLASS_HOST_H__
  45 #define __MS_CLASS_HOST_H__
  46
  47         /* Includes: */
  48                 #include "../../USB.h"
  49                 #include "../Common/MassStorage.h"
  50
  51         /* Enable C linkage for C++ Compilers: */
  52                 #if defined(__cplusplus)
  53                         extern "C" {
  54                 #endif
  55
  56         /* Public Interface - May be used in end-application: */
  57                 /* Macros: */
  58                         /** Error code for some Mass Storage Host functions, indicating a logical (and not hardware) error */
  59                         #define MS_ERROR_LOGICAL_CMD_FAILED              0x80
  60
  61                 /* Type Defines: */
  62                         /** Class state structure. An instance of this structure should be made within the user application,
  63                          *  and passed to each of the Mass Storage class driver functions as the MSInterfaceInfo parameter. This
  64                          *  stores each Mass Storage interface's configuration and state information.
  65                          */
  66                         typedef struct
  67                         {
  68                                 const struct
  69                                 {
  70                                         uint8_t  DataINPipeNumber; /**< Pipe number of the Mass Storage interface's IN data pipe */
  71                                         bool     DataINPipeDoubleBank; /** Indicates if the Mass Storage interface's IN data pipe should use double banking */
  72
  73                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the Mass Storage interface's OUT data pipe */
  74                                         bool     DataOUTPipeDoubleBank; /** Indicates if the Mass Storage interface's OUT data pipe should use double banking */
  75                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  76                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  77                                            */
  78                                 struct
  79                                 {
  80                                         bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
  81                                                         *   after \ref MS_Host_ConfigurePipes() is called and the Host state machine is in the
  82                                                         *   Configured state
  83                                                         */
  84                                         uint8_t InterfaceNumber; /**< Interface index of the Mass Storage interface within the attached device */
  85
  86                                         uint16_t DataINPipeSize; /**< Size in bytes of the Mass Storage interface's IN data pipe */
  87                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the Mass Storage interface's OUT data pipe */
  88
  89                                         uint32_t TransactionTag; /**< Current transaction tag for data synchronizing of packets */
  90                                 } State; /**< State data for the USB class interface within the device. All elements in this section
  91                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
  92                                                   *   the interface is enumerated.
  93                                                   */
  94                         } USB_ClassInfo_MS_Host_t;
  95
  96                         /** SCSI capacity structure, to hold the total capacity of the device in both the number
  97                          *  of blocks in the current LUN, and the size of each block. This structure is filled by
  98                          *  the device when the MassStore_ReadCapacity() function is called.
  99                          */
 100                         typedef struct
 101                         {
 102                                 uint32_t Blocks; /**< Number of blocks in the addressed LUN of the device */
 103                                 uint32_t BlockSize; /**< Number of bytes in each block in the addressed LUN */
 104                         } SCSI_Capacity_t;
 105
 106                 /* Enums: */
 107                         enum MSHost_EnumerationFailure_ErrorCodes_t
 108                         {
 109                                 MS_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
 110                                 MS_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */
 111                                 MS_ENUMERROR_NoMSInterfaceFound         = 2, /**< A compatible Mass Storage interface was not found in the device's Configuration Descriptor */
 112                                 MS_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Mass Storage endpoints were not found in the device's interfaces */
 113                         };
 114
 115                 /* Function Prototypes: */
 116                         /** General management task for a given Mass Storage host class interface, required for the correct operation of
 117                          *  the interface. This should be called frequently in the main program loop, before the master USB management task
 118                          *  \ref USB_USBTask().
 119                          *
 120                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing an MS Class host configuration and state
 121                          */
 122                         void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 123
 124                         /** Host interface configuration routine, to configure a given Mass Storage host interface instance using the
 125                          *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Mass
 126                          *  Storage Host instance's state values and configures the pipes required to communicate with the interface if it
 127                          *  is found within the device. This should be called once after the stack has enumerated the attached device, while
 128                          *  the host state machine is in the Addressed state.
 129                          *
 130                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing an MS Class host configuration and state
 131                          *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
 132                          *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
 133                          *
 134                          *  \return A value from the \ref MSHost_EnumerationFailure_ErrorCodes_t enum
 135                          */
 136                         uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, uint16_t ConfigDescriptorSize,
 137                                                        void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 138
 139                         /** Sends a MASS STORAGE RESET control request to the attached device, resetting the Mass Storage Interface
 140                          *  and readying it for the next Mass Storage command.
 141                          *
 142                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 143                          *
 144                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 145                          */
 146                         uint8_t MS_Host_ResetMSInterface(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 147
 148                         /** Sends a GET MAX LUN control request to the attached device, retrieving the index of the highest LUN (Logical
 149                          *  UNit, a logical drive) in the device. This value can then be used in the other functions of the Mass Storage
 150                          *  Host mode Class driver to address a specific LUN within the device.
 151                          *
 152                          *  \note Some devices do not support this request, and will STALL it when issued. To get around this,
 153                          *        on unsupported devices the max LUN index will be reported as zero and no error will be returned
 154                          *        if the device STALLs the request.
 155                          *
 156                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 157                          *  \param[out] MaxLUNIndex  Pointer to a location where the highest LUN index value should be stored
 158                          *
 159                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 160                          */
 161                         uint8_t MS_Host_GetMaxLUN(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, uint8_t* const MaxLUNIndex)
 162                                                   ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 163
 164                         /** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and
 165                          *  properties.
 166                          *
 167                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 168                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 169                          *  \param[out] InquiryData  Location where the read inquiry data should be stored
 170                          *
 171                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED
 172                          */
 173                         uint8_t MS_Host_GetInquiryData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 174                                                        SCSI_Inquiry_Response_t* const InquiryData) ATTR_NON_NULL_PTR_ARG(1)
 175                                                        ATTR_NON_NULL_PTR_ARG(3);
 176
 177                         /** Sends a TEST UNIT READY command to the device, to determine if it is ready to accept other SCSI commands.
 178                          *
 179                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 180                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 181                          *
 182                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 183                          */
 184                         uint8_t MS_Host_TestUnitReady(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex)
 185                                                       ATTR_NON_NULL_PTR_ARG(1);
 186
 187                         /** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size.
 188                          *
 189                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 190                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 191                          *  \param[out] DeviceCapacity  Pointer to the location where the capacity information should be stored
 192                          *
 193                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 194                          */
 195                         uint8_t MS_Host_ReadDeviceCapacity(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 196                                                            SCSI_Capacity_t* const DeviceCapacity) ATTR_NON_NULL_PTR_ARG(1)
 197                                                            ATTR_NON_NULL_PTR_ARG(3);
 198
 199                         /** Retrieves the device sense data, indicating the current device state and error codes for the previously
 200                          *  issued command.
 201                          *
 202                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 203                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 204                          *  \param[out] SenseData  Pointer to the location where the sense information should be stored
 205                          *
 206                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 207                          */
 208                         uint8_t MS_Host_RequestSense(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 209                                                      SCSI_Request_Sense_Response_t* const SenseData) ATTR_NON_NULL_PTR_ARG(1)
 210                                                      ATTR_NON_NULL_PTR_ARG(3);
 211
 212                         /** Issues a PREVENT MEDIUM REMOVAL command, to logically (or, depending on the type of device, physically) lock
 213                          *  the device from removal so that blocks of data on the medium can be read or altered.
 214                          *
 215                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 216                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 217                          *  \param[in] PreventRemoval  Boolean true if the device should be locked from removal, false otherwise
 218                          *
 219                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 220                          */
 221                         uint8_t MS_Host_PreventAllowMediumRemoval(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 222                                                                   const bool PreventRemoval) ATTR_NON_NULL_PTR_ARG(1);
 223
 224                         /** Reads blocks of data from the attached Mass Storage device's medium.
 225                          *
 226                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 227                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 228                          *  \param[in] BlockAddress  Starting block address within the device to read from
 229                          *  \param[in] Blocks  Total number of blocks to read
 230                          *  \param[in] BlockSize  Size in bytes of each block within the device
 231                          *  \param[out] BlockBuffer  Pointer to where the read data from the device should be stored
 232                          *
 233                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 234                          */
 235                         uint8_t MS_Host_ReadDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 236                                                          const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,
 237                                                          void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
 238
 239                         /** Writes blocks of data to the attached Mass Storage device's medium.
 240                          *
 241                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 242                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 243                          *  \param[in] BlockAddress  Starting block address within the device to write to
 244                          *  \param[in] Blocks  Total number of blocks to read
 245                          *  \param[in] BlockSize  Size in bytes of each block within the device
 246                          *  \param[in] BlockBuffer  Pointer to where the data to write should be sourced from
 247                          *
 248                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 249                          */
 250                         uint8_t MS_Host_WriteDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 251                                                           const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,
 252                                                           void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
 253
 254         /* Private Interface - For use in library only: */
 255         #if !defined(__DOXYGEN__)
 256                 /* Macros: */
 257                         #define MASS_STORE_CLASS               0x08
 258                         #define MASS_STORE_SUBCLASS            0x06
 259                         #define MASS_STORE_PROTOCOL            0x50
 260
 261                         #define REQ_MassStorageReset           0xFF
 262                         #define REQ_GetMaxLUN                  0xFE
 263
 264                         #define CBW_SIGNATURE                  0x43425355UL
 265                         #define CSW_SIGNATURE                  0x53425355UL
 266
 267                         #define COMMAND_DIRECTION_DATA_OUT     (0 << 7)
 268                         #define COMMAND_DIRECTION_DATA_IN      (1 << 7)
 269
 270                         #define COMMAND_DATA_TIMEOUT_MS        2000
 271
 272                         #define MS_FOUND_DATAPIPE_IN           (1 << 0)
 273                         #define MS_FOUND_DATAPIPE_OUT          (1 << 1)
 274
 275                 /* Function Prototypes: */
 276                         #if defined(INCLUDE_FROM_MS_CLASS_HOST_C)
 277                                 static uint8_t DComp_NextMSInterface(void* const CurrentDescriptor);
 278                                 static uint8_t DComp_NextMSInterfaceEndpoint(void* const CurrentDescriptor);
 279
 280                                 static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 281                                                                    MS_CommandBlockWrapper_t* const SCSICommandBlock,
 282                                                                    void* BufferPtr);
 283                                 static uint8_t MS_Host_WaitForDataReceived(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo);
 284                                 static uint8_t MS_Host_SendReceiveData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 285                                                        MS_CommandBlockWrapper_t* const SCSICommandBlock, void* BufferPtr);
 286                                 static uint8_t MS_Host_GetReturnedStatus(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 287                                                                          MS_CommandStatusWrapper_t* const SCSICommandStatus);
 288                         #endif
 289         #endif
 290
 291         /* Disable C linkage for C++ Compilers: */
 292                 #if defined(__cplusplus)
 293                         }
 294                 #endif
 295
 296 #endif
 297
 298 /** @} */