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