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