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                         /** Type define for a SCSI Sense structure. Structures of this type are filled out by the
  97                          *  device via the MassStore_RequestSense() function, indicating the current sense data of the
  98                          *  device (giving explicit error codes for the last issued command). For details of the
  99                          *  structure contents, refer to the SCSI specifications.
 100                          */
 101                         typedef struct
 102                         {
 103                                 uint8_t       ResponseCode;
 104
 105                                 uint8_t       SegmentNumber;
 106
 107                                 unsigned char SenseKey            : 4;
 108                                 unsigned char _RESERVED1          : 1;
 109                                 unsigned char ILI                 : 1;
 110                                 unsigned char EOM                 : 1;
 111                                 unsigned char FileMark            : 1;
 112
 113                                 uint8_t      Information[4];
 114                                 uint8_t      AdditionalLength;
 115                                 uint8_t      CmdSpecificInformation[4];
 116                                 uint8_t      AdditionalSenseCode;
 117                                 uint8_t      AdditionalSenseQualifier;
 118                                 uint8_t      FieldReplaceableUnitCode;
 119                                 uint8_t      SenseKeySpecific[3];
 120                         } SCSI_Request_Sense_Response_t;
 121
 122                         /** Type define for a SCSI Inquiry structure. Structures of this type are filled out by the
 123                          *  device via the MassStore_Inquiry() function, retrieving the attached device's information.
 124                          *  For details of the structure contents, refer to the SCSI specifications.
 125                          */
 126                         typedef struct
 127                         {
 128                                 unsigned char DeviceType          : 5;
 129                                 unsigned char PeripheralQualifier : 3;
 130
 131                                 unsigned char _RESERVED1          : 7;
 132                                 unsigned char Removable           : 1;
 133
 134                                 uint8_t      Version;
 135
 136                                 unsigned char ResponseDataFormat  : 4;
 137                                 unsigned char _RESERVED2          : 1;
 138                                 unsigned char NormACA             : 1;
 139                                 unsigned char TrmTsk              : 1;
 140                                 unsigned char AERC                : 1;
 141
 142                                 uint8_t      AdditionalLength;
 143                                 uint8_t      _RESERVED3[2];
 144
 145                                 unsigned char SoftReset           : 1;
 146                                 unsigned char CmdQue              : 1;
 147                                 unsigned char _RESERVED4          : 1;
 148                                 unsigned char Linked              : 1;
 149                                 unsigned char Sync                : 1;
 150                                 unsigned char WideBus16Bit        : 1;
 151                                 unsigned char WideBus32Bit        : 1;
 152                                 unsigned char RelAddr             : 1;
 153
 154                                 uint8_t      VendorID[8];
 155                                 uint8_t      ProductID[16];
 156                                 uint8_t      RevisionID[4];
 157                         } SCSI_Inquiry_Response_t;
 158
 159                         /** SCSI capacity structure, to hold the total capacity of the device in both the number
 160                          *  of blocks in the current LUN, and the size of each block. This structure is filled by
 161                          *  the device when the MassStore_ReadCapacity() function is called.
 162                          */
 163                         typedef struct
 164                         {
 165                                 uint32_t Blocks; /**< Number of blocks in the addressed LUN of the device */
 166                                 uint32_t BlockSize; /**< Number of bytes in each block in the addressed LUN */
 167                         } SCSI_Capacity_t;
 168
 169                 /* Enums: */
 170                         enum MSHost_EnumerationFailure_ErrorCodes_t
 171                         {
 172                                 MS_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
 173                                 MS_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */
 174                                 MS_ENUMERROR_NoMSInterfaceFound         = 2, /**< A compatible Mass Storage interface was not found in the device's Configuration Descriptor */
 175                                 MS_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Mass Storage endpoints were not found in the device's interfaces */
 176                         };
 177
 178                 /* Function Prototypes: */
 179                         /** General management task for a given Mass Storage host class interface, required for the correct operation of
 180                          *  the interface. This should be called frequently in the main program loop, before the master USB management task
 181                          *  \ref USB_USBTask().
 182                          *
 183                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing an MS Class host configuration and state
 184                          */
 185                         void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 186
 187                         /** Host interface configuration routine, to configure a given Mass Storage host interface instance using the
 188                          *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Mass
 189                          *  Storage Host instance's state values and configures the pipes required to communicate with the interface if it
 190                          *  is found within the device. This should be called once after the stack has enumerated the attached device, while
 191                          *  the host state machine is in the Addressed state.
 192                          *
 193                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing an MS Class host configuration and state
 194                          *  \param[in] ConfigDescriptorSize  Length of the attached device's Configuration Descriptor
 195                          *  \param[in] DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
 196                          *
 197                          *  \return A value from the \ref MSHost_EnumerationFailure_ErrorCodes_t enum
 198                          */
 199                         uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, uint16_t ConfigDescriptorSize,
 200                                                        void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 201
 202                         /** Sends a MASS STORAGE RESET control request to the attached device, resetting the Mass Storage Interface
 203                          *  and readying it for the next Mass Storage command.
 204                          *
 205                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 206                          *
 207                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 208                          */
 209                         uint8_t MS_Host_ResetMSInterface(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 210
 211                         /** Sends a GET MAX LUN control request to the attached device, retrieving the index of the highest LUN (Logical
 212                          *  UNit, a logical drive) in the device. This value can then be used in the other functions of the Mass Storage
 213                          *  Host mode Class driver to address a specific LUN within the device.
 214                          *
 215                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 216                          *  \param[out] MaxLUNIndex  Pointer to a location where the highest LUN index value should be stored
 217                          *
 218                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 219                          */
 220                         uint8_t MS_Host_GetMaxLUN(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, uint8_t* const MaxLUNIndex)
 221                                                   ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 222
 223                         /** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and
 224                          *  properties.
 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[out] InquiryData  Location where the read inquiry data should be stored
 229                          *
 230                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED
 231                          */
 232                         uint8_t MS_Host_GetInquiryData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 233                                                        SCSI_Inquiry_Response_t* const InquiryData) ATTR_NON_NULL_PTR_ARG(1)
 234                                                        ATTR_NON_NULL_PTR_ARG(3);
 235
 236                         /** Sends a TEST UNIT READY command to the device, to determine if it is ready to accept other SCSI commands.
 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                          *
 241                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 242                          */
 243                         uint8_t MS_Host_TestUnitReady(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex)
 244                                                       ATTR_NON_NULL_PTR_ARG(1);
 245
 246                         /** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size.
 247                          *
 248                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 249                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 250                          *  \param[out] DeviceCapacity  Pointer to the location where the capacity information should be stored
 251                          *
 252                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 253                          */
 254                         uint8_t MS_Host_ReadDeviceCapacity(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 255                                                            SCSI_Capacity_t* const DeviceCapacity) ATTR_NON_NULL_PTR_ARG(1)
 256                                                            ATTR_NON_NULL_PTR_ARG(3);
 257
 258                         /** Retrieves the device sense data, indicating the current device state and error codes for the previously
 259                          *  issued command.
 260                          *
 261                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 262                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 263                          *  \param[out] SenseData  Pointer to the location where the sense information should be stored
 264                          *
 265                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 266                          */
 267                         uint8_t MS_Host_RequestSense(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 268                                                      SCSI_Request_Sense_Response_t* const SenseData) ATTR_NON_NULL_PTR_ARG(1)
 269                                                      ATTR_NON_NULL_PTR_ARG(3);
 270
 271                         /** Issues a PREVENT MEDIUM REMOVAL command, to logically (or, depending on the type of device, physically) lock
 272                          *  the device from removal so that blocks of data on the medium can be read or altered.
 273                          *
 274                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 275                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 276                          *  \param[in] PreventRemoval  Boolean true if the device should be locked from removal, false otherwise
 277                          *
 278                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 279                          */
 280                         uint8_t MS_Host_PreventAllowMediumRemoval(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 281                                                                   const bool PreventRemoval) ATTR_NON_NULL_PTR_ARG(1);
 282
 283                         /** Reads blocks of data from the attached Mass Storage device's medium.
 284                          *
 285                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 286                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 287                          *  \param[in] BlockAddress  Starting block address within the device to read from
 288                          *  \param[in] Blocks  Total number of blocks to read
 289                          *  \param[in] BlockSize  Size in bytes of each block within the device
 290                          *  \param[out] BlockBuffer  Pointer to where the read data from the device should be stored
 291                          *
 292                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 293                          */
 294                         uint8_t MS_Host_ReadDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 295                                                          const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,
 296                                                          void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
 297
 298                         /** Writes blocks of data to the attached Mass Storage device's medium.
 299                          *
 300                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 301                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 302                          *  \param[in] BlockAddress  Starting block address within the device to write to
 303                          *  \param[in] Blocks  Total number of blocks to read
 304                          *  \param[in] BlockSize  Size in bytes of each block within the device
 305                          *  \param[in] BlockBuffer  Pointer to where the data to write should be sourced from
 306                          *
 307                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 308                          */
 309                         uint8_t MS_Host_WriteDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 310                                                           const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,
 311                                                           void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
 312
 313         /* Private Interface - For use in library only: */
 314         #if !defined(__DOXYGEN__)
 315                 /* Macros: */
 316                         #define MASS_STORE_CLASS               0x08
 317                         #define MASS_STORE_SUBCLASS            0x06
 318                         #define MASS_STORE_PROTOCOL            0x50
 319
 320                         #define REQ_MassStorageReset           0xFF
 321                         #define REQ_GetMaxLUN                  0xFE
 322
 323                         #define CBW_SIGNATURE                  0x43425355UL
 324                         #define CSW_SIGNATURE                  0x53425355UL
 325
 326                         #define COMMAND_DIRECTION_DATA_OUT     (0 << 7)
 327                         #define COMMAND_DIRECTION_DATA_IN      (1 << 7)
 328
 329                         #define COMMAND_DATA_TIMEOUT_MS        2000
 330
 331                         #define MS_FOUND_DATAPIPE_IN           (1 << 0)
 332                         #define MS_FOUND_DATAPIPE_OUT          (1 << 1)
 333
 334                 /* Function Prototypes: */
 335                         #if defined(INCLUDE_FROM_MS_CLASS_HOST_C)
 336                                 static uint8_t DComp_NextMSInterface(void* const CurrentDescriptor);
 337                                 static uint8_t DComp_NextMSInterfaceEndpoint(void* const CurrentDescriptor);
 338
 339                                 static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 340                                                                    MS_CommandBlockWrapper_t* const SCSICommandBlock,
 341                                                                    void* BufferPtr);
 342                                 static uint8_t MS_Host_WaitForDataReceived(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo);
 343                                 static uint8_t MS_Host_SendReceiveData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 344                                                        MS_CommandBlockWrapper_t* const SCSICommandBlock, void* BufferPtr);
 345                                 static uint8_t MS_Host_GetReturnedStatus(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 346                                                                          MS_CommandStatusWrapper_t* const SCSICommandStatus);
 347                         #endif
 348         #endif
 349
 350         /* Disable C linkage for C++ Compilers: */
 351                 #if defined(__cplusplus)
 352                         }
 353                 #endif
 354
 355 #endif
 356
 357 /** @} */