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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all 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         /* Preprocessor Checks: */
  57                 #if !defined(__INCLUDE_FROM_MS_DRIVER)
  58                         #error Do not include this file directly. Include LUFA/Drivers/Class/MassStorage.h instead.
  59                 #endif
  60
  61         /* Public Interface - May be used in end-application: */
  62                 /* Macros: */
  63                         /** Error code for some Mass Storage Host functions, indicating a logical (and not hardware) error */
  64                         #define MS_ERROR_LOGICAL_CMD_FAILED              0x80
  65
  66                 /* Type Defines: */
  67                         /** Class state structure. An instance of this structure should be made within the user application,
  68                          *  and passed to each of the Mass Storage class driver functions as the MSInterfaceInfo parameter. This
  69                          *  stores each Mass Storage interface's configuration and state information.
  70                          */
  71                         typedef struct
  72                         {
  73                                 const struct
  74                                 {
  75                                         uint8_t  DataINPipeNumber; /**< Pipe number of the Mass Storage interface's IN data pipe */
  76                                         bool     DataINPipeDoubleBank; /** Indicates if the Mass Storage interface's IN data pipe should use double banking */
  77
  78                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the Mass Storage interface's OUT data pipe */
  79                                         bool     DataOUTPipeDoubleBank; /** Indicates if the Mass Storage interface's OUT data pipe should use double banking */
  80                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  81                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  82                                            */
  83                                 struct
  84                                 {
  85                                         bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
  86                                                         *   after \ref MS_Host_ConfigurePipes() is called and the Host state machine is in the
  87                                                         *   Configured state
  88                                                         */
  89                                         uint8_t InterfaceNumber; /**< Interface index of the Mass Storage interface within the attached device */
  90
  91                                         uint16_t DataINPipeSize; /**< Size in bytes of the Mass Storage interface's IN data pipe */
  92                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the Mass Storage interface's OUT data pipe */
  93
  94                                         uint32_t TransactionTag; /**< Current transaction tag for data synchronizing of packets */
  95                                 } State; /**< State data for the USB class interface within the device. All elements in this section
  96                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
  97                                                   *   the interface is enumerated.
  98                                                   */
  99                         } USB_ClassInfo_MS_Host_t;
 100
 101                         /** SCSI capacity structure, to hold the total capacity of the device in both the number
 102                          *  of blocks in the current LUN, and the size of each block. This structure is filled by
 103                          *  the device when the MassStore_ReadCapacity() function is called.
 104                          */
 105                         typedef struct
 106                         {
 107                                 uint32_t Blocks; /**< Number of blocks in the addressed LUN of the device */
 108                                 uint32_t BlockSize; /**< Number of bytes in each block in the addressed LUN */
 109                         } SCSI_Capacity_t;
 110
 111                 /* Enums: */
 112                         enum MSHost_EnumerationFailure_ErrorCodes_t
 113                         {
 114                                 MS_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
 115                                 MS_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */
 116                                 MS_ENUMERROR_NoMSInterfaceFound         = 2, /**< A compatible Mass Storage interface was not found in the device's Configuration Descriptor */
 117                                 MS_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Mass Storage endpoints were not found in the device's interfaces */
 118                         };
 119
 120                 /* Function Prototypes: */
 121                         /** Host interface configuration routine, to configure a given Mass Storage host interface instance using the
 122                          *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Mass
 123                          *  Storage Host instance's state values and configures the pipes required to communicate with the interface if it
 124                          *  is found within the device. This should be called once after the stack has enumerated the attached device, while
 125                          *  the host state machine is in the Addressed state.
 126                          *
 127                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing an MS Class host configuration and state
 128                          *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
 129                          *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
 130                          *
 131                          *  \return A value from the \ref MSHost_EnumerationFailure_ErrorCodes_t enum
 132                          */
 133                         uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, uint16_t ConfigDescriptorSize,
 134                                                        void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 135
 136                         /** Sends a MASS STORAGE RESET control request to the attached device, resetting the Mass Storage Interface
 137                          *  and readying it for the next Mass Storage command.
 138                          *
 139                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 140                          *
 141                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 142                          */
 143                         uint8_t MS_Host_ResetMSInterface(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 144
 145                         /** Sends a GET MAX LUN control request to the attached device, retrieving the index of the highest LUN (Logical
 146                          *  UNit, a logical drive) in the device. This value can then be used in the other functions of the Mass Storage
 147                          *  Host mode Class driver to address a specific LUN within the device.
 148                          *
 149                          *  \note Some devices do not support this request, and will STALL it when issued. To get around this,
 150                          *        on unsupported devices the max LUN index will be reported as zero and no error will be returned
 151                          *        if the device STALLs the request.
 152                          *
 153                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 154                          *  \param[out] MaxLUNIndex  Pointer to a location where the highest LUN index value should be stored
 155                          *
 156                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 157                          */
 158                         uint8_t MS_Host_GetMaxLUN(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, uint8_t* const MaxLUNIndex)
 159                                                   ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 160
 161                         /** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and
 162                          *  properties.
 163                          *
 164                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 165                          *        call will fail.
 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                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 190                          *        call will fail.
 191                          *
 192                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 193                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 194                          *  \param[out] DeviceCapacity  Pointer to the location where the capacity information should be stored
 195                          *
 196                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 197                          */
 198                         uint8_t MS_Host_ReadDeviceCapacity(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 199                                                            SCSI_Capacity_t* const DeviceCapacity) ATTR_NON_NULL_PTR_ARG(1)
 200                                                            ATTR_NON_NULL_PTR_ARG(3);
 201
 202                         /** Retrieves the device sense data, indicating the current device state and error codes for the previously
 203                          *  issued command.
 204                          *
 205                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 206                          *        call will fail.
 207                          *
 208                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 209                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 210                          *  \param[out] SenseData  Pointer to the location where the sense information should be stored
 211                          *
 212                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 213                          */
 214                         uint8_t MS_Host_RequestSense(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 215                                                      SCSI_Request_Sense_Response_t* const SenseData) ATTR_NON_NULL_PTR_ARG(1)
 216                                                      ATTR_NON_NULL_PTR_ARG(3);
 217
 218                         /** Issues a PREVENT MEDIUM REMOVAL command, to logically (or, depending on the type of device, physically) lock
 219                          *  the device from removal so that blocks of data on the medium can be read or altered.
 220                          *
 221                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 222                          *        call will fail.
 223                          *
 224                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 225                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 226                          *  \param[in] PreventRemoval  Boolean true if the device should be locked from removal, false otherwise
 227                          *
 228                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 229                          */
 230                         uint8_t MS_Host_PreventAllowMediumRemoval(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 231                                                                   const bool PreventRemoval) ATTR_NON_NULL_PTR_ARG(1);
 232
 233                         /** Reads blocks of data from the attached Mass Storage device's medium.
 234                          *
 235                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 236                          *        call will fail.
 237                          *
 238                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 239                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 240                          *  \param[in] BlockAddress  Starting block address within the device to read from
 241                          *  \param[in] Blocks  Total number of blocks to read
 242                          *  \param[in] BlockSize  Size in bytes of each block within the device
 243                          *  \param[out] BlockBuffer  Pointer to where the read data from the device should be stored
 244                          *
 245                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 246                          */
 247                         uint8_t MS_Host_ReadDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 248                                                          const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,
 249                                                          void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
 250
 251                         /** Writes blocks of data to the attached Mass Storage device's medium.
 252                          *
 253                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 254                          *        call will fail.
 255                          *
 256                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 257                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 258                          *  \param[in] BlockAddress  Starting block address within the device to write to
 259                          *  \param[in] Blocks  Total number of blocks to read
 260                          *  \param[in] BlockSize  Size in bytes of each block within the device
 261                          *  \param[in] BlockBuffer  Pointer to where the data to write should be sourced from
 262                          *
 263                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 264                          */
 265                         uint8_t MS_Host_WriteDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 266                                                           const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,
 267                                                           void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
 268
 269                 /* Inline Functions: */
 270                         /** General management task for a given Mass Storage host class interface, required for the correct operation of
 271                          *  the interface. This should be called frequently in the main program loop, before the master USB management task
 272                          *  \ref USB_USBTask().
 273                          *
 274                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing an MS Class host configuration and state
 275                          */
 276                         static inline void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo);
 277                         static inline void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo)
 278                         {
 279                                 (void)MSInterfaceInfo;
 280                         }
 281
 282         /* Private Interface - For use in library only: */
 283         #if !defined(__DOXYGEN__)
 284                 /* Macros: */
 285                         #define MASS_STORE_CLASS               0x08
 286                         #define MASS_STORE_SUBCLASS            0x06
 287                         #define MASS_STORE_PROTOCOL            0x50
 288
 289                         #define REQ_MassStorageReset           0xFF
 290                         #define REQ_GetMaxLUN                  0xFE
 291
 292                         #define CBW_SIGNATURE                  0x43425355UL
 293                         #define CSW_SIGNATURE                  0x53425355UL
 294
 295                         #define COMMAND_DIRECTION_DATA_OUT     (0 << 7)
 296                         #define COMMAND_DIRECTION_DATA_IN      (1 << 7)
 297
 298                         #define COMMAND_DATA_TIMEOUT_MS        10000
 299
 300                         #define MS_FOUND_DATAPIPE_IN           (1 << 0)
 301                         #define MS_FOUND_DATAPIPE_OUT          (1 << 1)
 302
 303                 /* Function Prototypes: */
 304                         #if defined(__INCLUDE_FROM_MS_CLASS_HOST_C)
 305                                 static uint8_t DComp_NextMSInterface(void* const CurrentDescriptor);
 306                                 static uint8_t DComp_NextMSInterfaceEndpoint(void* const CurrentDescriptor);
 307
 308                                 static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 309                                                                    MS_CommandBlockWrapper_t* const SCSICommandBlock,
 310                                                                    void* BufferPtr);
 311                                 static uint8_t MS_Host_WaitForDataReceived(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo);
 312                                 static uint8_t MS_Host_SendReceiveData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 313                                                        MS_CommandBlockWrapper_t* const SCSICommandBlock, void* BufferPtr);
 314                                 static uint8_t MS_Host_GetReturnedStatus(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 315                                                                          MS_CommandStatusWrapper_t* const SCSICommandStatus);
 316                         #endif
 317         #endif
 318
 319         /* Disable C linkage for C++ Compilers: */
 320                 #if defined(__cplusplus)
 321                         }
 322                 #endif
 323
 324 #endif
 325
 326 /** @} */