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 /** \file
  32  *  \brief Host mode driver for the library USB Mass Storage Class driver.
  33  *
  34  *  Host mode driver for the library USB Mass Storage Class driver.
  35  *
  36  *  \note This file should not be included directly. It is automatically included as needed by the class driver
  37  *        dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h.
  38  */
  39
  40 /** \ingroup Group_USBClassMS
  41  *  @defgroup Group_USBClassMassStorageHost Mass Storage Class Host Mode Driver
  42  *
  43  *  \section Sec_Dependencies Module Source Dependencies
  44  *  The following files must be built with any user project that uses this module:
  45  *    - LUFA/Drivers/USB/Class/Host/MassStorage.c
  46  *
  47  *  \section Module Description
  48  *  Host Mode USB Class driver framework interface, for the Mass Storage USB Class driver.
  49  *
  50  *  @{
  51  */
  52
  53 #ifndef __MS_CLASS_HOST_H__
  54 #define __MS_CLASS_HOST_H__
  55
  56         /* Includes: */
  57                 #include "../../USB.h"
  58                 #include "../Common/MassStorage.h"
  59
  60         /* Enable C linkage for C++ Compilers: */
  61                 #if defined(__cplusplus)
  62                         extern "C" {
  63                 #endif
  64
  65         /* Preprocessor Checks: */
  66                 #if !defined(__INCLUDE_FROM_MS_DRIVER)
  67                         #error Do not include this file directly. Include LUFA/Drivers/Class/MassStorage.h instead.
  68                 #endif
  69
  70         /* Public Interface - May be used in end-application: */
  71                 /* Macros: */
  72                         /** Error code for some Mass Storage Host functions, indicating a logical (and not hardware) error. */
  73                         #define MS_ERROR_LOGICAL_CMD_FAILED              0x80
  74
  75                 /* Type Defines: */
  76                         /** \brief Mass Storage Class Host Mode Configuration and State Structure.
  77                          *
  78                          *  Class state structure. An instance of this structure should be made within the user application,
  79                          *  and passed to each of the Mass Storage class driver functions as the MSInterfaceInfo parameter. This
  80                          *  stores each Mass Storage interface's configuration and state information.
  81                          */
  82                         typedef struct
  83                         {
  84                                 const struct
  85                                 {
  86                                         uint8_t  DataINPipeNumber; /**< Pipe number of the Mass Storage interface's IN data pipe */
  87                                         bool     DataINPipeDoubleBank; /**< Indicates if the Mass Storage interface's IN data pipe should use double banking */
  88
  89                                         uint8_t  DataOUTPipeNumber; /**< Pipe number of the Mass Storage interface's OUT data pipe */
  90                                         bool     DataOUTPipeDoubleBank; /**< Indicates if the Mass Storage interface's OUT data pipe should use double banking */
  91                                 } Config; /**< Config data for the USB class interface within the device. All elements in this section
  92                                            *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.
  93                                            */
  94                                 struct
  95                                 {
  96                                         bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid
  97                                                         *   after \ref MS_Host_ConfigurePipes() is called and the Host state machine is in the
  98                                                         *   Configured state
  99                                                         */
 100                                         uint8_t InterfaceNumber; /**< Interface index of the Mass Storage interface within the attached device */
 101
 102                                         uint16_t DataINPipeSize; /**< Size in bytes of the Mass Storage interface's IN data pipe */
 103                                         uint16_t DataOUTPipeSize;  /**< Size in bytes of the Mass Storage interface's OUT data pipe */
 104
 105                                         uint32_t TransactionTag; /**< Current transaction tag for data synchronizing of packets */
 106                                 } State; /**< State data for the USB class interface within the device. All elements in this section
 107                                                   *   <b>may</b> be set to initial values, but may also be ignored to default to sane values when
 108                                                   *   the interface is enumerated.
 109                                                   */
 110                         } USB_ClassInfo_MS_Host_t;
 111
 112                         /** \brief SCSI Device LUN Capacity Structure.
 113                          *
 114                          *  SCSI capacity structure, to hold the total capacity of the device in both the number
 115                          *  of blocks in the current LUN, and the size of each block. This structure is filled by
 116                          *  the device when the \ref MS_Host_ReadCapacity() function is called.
 117                          */
 118                         typedef struct
 119                         {
 120                                 uint32_t Blocks; /**< Number of blocks in the addressed LUN of the device */
 121                                 uint32_t BlockSize; /**< Number of bytes in each block in the addressed LUN */
 122                         } SCSI_Capacity_t;
 123
 124                 /* Enums: */
 125                         enum MSHost_EnumerationFailure_ErrorCodes_t
 126                         {
 127                                 MS_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */
 128                                 MS_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor */
 129                                 MS_ENUMERROR_NoMSInterfaceFound         = 2, /**< A compatible Mass Storage interface was not found in the device's Configuration Descriptor */
 130                                 MS_ENUMERROR_EndpointsNotFound          = 3, /**< Compatible Mass Storage endpoints were not found in the device's interfaces */
 131                         };
 132
 133                 /* Function Prototypes: */
 134                         /** Host interface configuration routine, to configure a given Mass Storage host interface instance using the
 135                          *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Mass
 136                          *  Storage Host instance's state values and configures the pipes required to communicate with the interface if it
 137                          *  is found within the device. This should be called once after the stack has enumerated the attached device, while
 138                          *  the host state machine is in the Addressed state.
 139                          *
 140                          *  \param[in,out] MSInterfaceInfo         Pointer to a structure containing an MS Class host configuration and state
 141                          *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor
 142                          *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor
 143                          *
 144                          *  \return A value from the \ref MSHost_EnumerationFailure_ErrorCodes_t enum
 145                          */
 146                         uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, uint16_t ConfigDescriptorSize,
 147                                                        void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 148
 149                         /** Sends a MASS STORAGE RESET control request to the attached device, resetting the Mass Storage Interface
 150                          *  and readying it for the next Mass Storage command.
 151                          *
 152                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 153                          *
 154                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 155                          */
 156                         uint8_t MS_Host_ResetMSInterface(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 157
 158                         /** Sends a GET MAX LUN control request to the attached device, retrieving the index of the highest LUN (Logical
 159                          *  UNit, a logical drive) in the device. This value can then be used in the other functions of the Mass Storage
 160                          *  Host mode Class driver to address a specific LUN within the device.
 161                          *
 162                          *  \note Some devices do not support this request, and will STALL it when issued. To get around this,
 163                          *        on unsupported devices the max LUN index will be reported as zero and no error will be returned
 164                          *        if the device STALLs the request.
 165                          *
 166                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 167                          *  \param[out]    MaxLUNIndex      Pointer to a location where the highest LUN index value should be stored
 168                          *
 169                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 170                          */
 171                         uint8_t MS_Host_GetMaxLUN(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, uint8_t* const MaxLUNIndex)
 172                                                   ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 173
 174                         /** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and
 175                          *  properties.
 176                          *
 177                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 178                          *        call will fail.
 179                          *
 180                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 181                          *  \param[in]     LUNIndex         LUN index within the device the command is being issued to
 182                          *  \param[out]    InquiryData      Location where the read inquiry data should be stored
 183                          *
 184                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED
 185                          */
 186                         uint8_t MS_Host_GetInquiryData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 187                                                        SCSI_Inquiry_Response_t* const InquiryData) ATTR_NON_NULL_PTR_ARG(1)
 188                                                        ATTR_NON_NULL_PTR_ARG(3);
 189
 190                         /** Sends a TEST UNIT READY command to the device, to determine if it is ready to accept other SCSI commands.
 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                          *
 195                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 196                          */
 197                         uint8_t MS_Host_TestUnitReady(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex)
 198                                                       ATTR_NON_NULL_PTR_ARG(1);
 199
 200                         /** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size.
 201                          *
 202                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 203                          *        call will fail.
 204                          *
 205                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 206                          *  \param[in]     LUNIndex         LUN index within the device the command is being issued to
 207                          *  \param[out]    DeviceCapacity   Pointer to the location where the capacity information should be stored
 208                          *
 209                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 210                          */
 211                         uint8_t MS_Host_ReadDeviceCapacity(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 212                                                            SCSI_Capacity_t* const DeviceCapacity) ATTR_NON_NULL_PTR_ARG(1)
 213                                                            ATTR_NON_NULL_PTR_ARG(3);
 214
 215                         /** Retrieves the device sense data, indicating the current device state and error codes for the previously
 216                          *  issued command.
 217                          *
 218                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 219                          *        call will fail.
 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]    SenseData        Pointer to the location where the sense information should be stored
 224                          *
 225                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 226                          */
 227                         uint8_t MS_Host_RequestSense(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 228                                                      SCSI_Request_Sense_Response_t* const SenseData) ATTR_NON_NULL_PTR_ARG(1)
 229                                                      ATTR_NON_NULL_PTR_ARG(3);
 230
 231                         /** Issues a PREVENT MEDIUM REMOVAL command, to logically (or, depending on the type of device, physically) lock
 232                          *  the device from removal so that blocks of data on the medium can be read or altered.
 233                          *
 234                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 235                          *        call will fail.
 236                          *
 237                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 238                          *  \param[in]     LUNIndex         LUN index within the device the command is being issued to
 239                          *  \param[in]     PreventRemoval   Boolean true if the device should be locked from removal, false otherwise
 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_PreventAllowMediumRemoval(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 244                                                                   const bool PreventRemoval) ATTR_NON_NULL_PTR_ARG(1);
 245
 246                         /** Reads blocks of data from the attached Mass Storage device's medium.
 247                          *
 248                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 249                          *        call will fail.
 250                          *
 251                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 252                          *  \param[in]     LUNIndex         LUN index within the device the command is being issued to
 253                          *  \param[in]     BlockAddress     Starting block address within the device to read from
 254                          *  \param[in]     Blocks           Total number of blocks to read
 255                          *  \param[in]     BlockSize        Size in bytes of each block within the device
 256                          *  \param[out]    BlockBuffer      Pointer to where the read data from the device 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_ReadDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 261                                                          const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,
 262                                                          void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
 263
 264                         /** Writes blocks of data to the attached Mass Storage device's medium.
 265                          *
 266                          *  \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the
 267                          *        call will fail.
 268                          *
 269                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 270                          *  \param[in]     LUNIndex         LUN index within the device the command is being issued to
 271                          *  \param[in]     BlockAddress     Starting block address within the device to write to
 272                          *  \param[in]     Blocks           Total number of blocks to read
 273                          *  \param[in]     BlockSize        Size in bytes of each block within the device
 274                          *  \param[in]     BlockBuffer      Pointer to where the data to write should be sourced from
 275                          *
 276                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready
 277                          */
 278                         uint8_t MS_Host_WriteDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,
 279                                                           const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,
 280                                                           const void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
 281
 282                 /* Inline Functions: */
 283                         /** General management task for a given Mass Storage host class interface, required for the correct operation of
 284                          *  the interface. This should be called frequently in the main program loop, before the master USB management task
 285                          *  \ref USB_USBTask().
 286                          *
 287                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing an MS Class host configuration and state
 288                          */
 289                         static inline void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo);
 290                         static inline void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo)
 291                         {
 292                                 (void)MSInterfaceInfo;
 293                         }
 294
 295         /* Private Interface - For use in library only: */
 296         #if !defined(__DOXYGEN__)
 297                 /* Macros: */
 298                         #define MASS_STORE_CLASS               0x08
 299                         #define MASS_STORE_SUBCLASS            0x06
 300                         #define MASS_STORE_PROTOCOL            0x50
 301
 302                         #define REQ_MassStorageReset           0xFF
 303                         #define REQ_GetMaxLUN                  0xFE
 304
 305                         #define CBW_SIGNATURE                  0x43425355UL
 306                         #define CSW_SIGNATURE                  0x53425355UL
 307
 308                         #define COMMAND_DIRECTION_DATA_OUT     (0 << 7)
 309                         #define COMMAND_DIRECTION_DATA_IN      (1 << 7)
 310
 311                         #define COMMAND_DATA_TIMEOUT_MS        10000
 312
 313                         #define MS_FOUND_DATAPIPE_IN           (1 << 0)
 314                         #define MS_FOUND_DATAPIPE_OUT          (1 << 1)
 315
 316                 /* Function Prototypes: */
 317                         #if defined(__INCLUDE_FROM_MS_CLASS_HOST_C)
 318                                 static uint8_t DCOMP_MS_NextMSInterface(void* const CurrentDescriptor);
 319                                 static uint8_t DCOMP_MS_NextMSInterfaceEndpoint(void* const CurrentDescriptor);
 320
 321                                 static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 322                                                                    MS_CommandBlockWrapper_t* const SCSICommandBlock,
 323                                                                    const void* const BufferPtr);
 324                                 static uint8_t MS_Host_WaitForDataReceived(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo);
 325                                 static uint8_t MS_Host_SendReceiveData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 326                                                        MS_CommandBlockWrapper_t* const SCSICommandBlock, void* BufferPtr);
 327                                 static uint8_t MS_Host_GetReturnedStatus(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 328                                                                          MS_CommandStatusWrapper_t* const SCSICommandStatus);
 329                         #endif
 330         #endif
 331
 332         /* Disable C linkage for C++ Compilers: */
 333                 #if defined(__cplusplus)
 334                         }
 335                 #endif
 336
 337 #endif
 338
 339 /** @} */