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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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 USB module driver
  37  *        dispatch header located in LUFA/Drivers/USB.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/MassStorageClassHost.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
  46  *
  47  *  \section Sec_ModDescription 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/MassStorageClassCommon.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/USB.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 \c 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_ReadDeviceCapacity() 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 for the possible error codes returned by the \ref MS_Host_ConfigurePipes() function. */
 126                         enum MS_Host_EnumerationFailure_ErrorCodes_t
 127                         {
 128                                 MS_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully. */
 129                                 MS_ENUMERROR_InvalidConfigDescriptor    = 1, /**< The device returned an invalid Configuration Descriptor. */
 130                                 MS_ENUMERROR_NoCompatibleInterfaceFound = 2, /**< A compatible Mass Storage interface was not found in the device's Configuration Descriptor. */
 131                                 MS_ENUMERROR_PipeConfigurationFailed    = 3, /**< One or more pipes for the specified interface could not be configured correctly. */
 132                         };
 133
 134                 /* Function Prototypes: */
 135                         /** Host interface configuration routine, to configure a given Mass Storage host interface instance using the
 136                          *  Configuration Descriptor read from an attached USB device. This function automatically updates the given Mass
 137                          *  Storage Host instance's state values and configures the pipes required to communicate with the interface if it
 138                          *  is found within the device. This should be called once after the stack has enumerated the attached device, while
 139                          *  the host state machine is in the Addressed state.
 140                          *
 141                          *  \param[in,out] MSInterfaceInfo         Pointer to a structure containing an MS Class host configuration and state.
 142                          *  \param[in]     ConfigDescriptorSize    Length of the attached device's Configuration Descriptor.
 143                          *  \param[in]     DeviceConfigDescriptor  Pointer to a buffer containing the attached device's Configuration Descriptor.
 144                          *
 145                          *  \return A value from the \ref MS_Host_EnumerationFailure_ErrorCodes_t enum.
 146                          */
 147                         uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 148                                                        uint16_t ConfigDescriptorSize,
 149                                                        void* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(3);
 150
 151                         /** Sends a MASS STORAGE RESET control request to the attached device, resetting the Mass Storage Interface
 152                          *  and readying it for the next Mass Storage command. This should be called after a failed SCSI request to
 153                          *  ensure the attached Mass Storage device is ready to receive the next command.
 154                          *
 155                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
 156                          *
 157                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
 158                          */
 159                         uint8_t MS_Host_ResetMSInterface(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 160
 161                         /** Sends a GET MAX LUN control request to the attached device, retrieving the index of the highest LUN (Logical
 162                          *  UNit, a logical drive) in the device. This value can then be used in the other functions of the Mass Storage
 163                          *  Host mode Class driver to address a specific LUN within the device.
 164                          *
 165                          *  \note Some devices do not support this request, and will STALL it when issued. To get around this,
 166                          *        on unsupported devices the max LUN index will be reported as zero and no error will be returned
 167                          *        if the device STALLs the request.
 168                          *
 169                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
 170                          *  \param[out]    MaxLUNIndex      Pointer to a location where the highest LUN index value should be stored.
 171                          *
 172                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum.
 173                          */
 174                         uint8_t MS_Host_GetMaxLUN(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 175                                                   uint8_t* const MaxLUNIndex) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 176
 177                         /** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and
 178                          *  properties.
 179                          *
 180                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 181                          *       call will fail.
 182                          *
 183                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
 184                          *  \param[in]     LUNIndex         LUN index within the device the command is being issued to.
 185                          *  \param[out]    InquiryData      Location where the read inquiry data should be stored.
 186                          *
 187                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or \ref MS_ERROR_LOGICAL_CMD_FAILED.
 188                          */
 189                         uint8_t MS_Host_GetInquiryData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 190                                                        const uint8_t LUNIndex,
 191                                                        SCSI_Inquiry_Response_t* const InquiryData) ATTR_NON_NULL_PTR_ARG(1)
 192                                                        ATTR_NON_NULL_PTR_ARG(3);
 193
 194                         /** Sends a TEST UNIT READY command to the device, to determine if it is ready to accept other SCSI commands.
 195                          *
 196                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
 197                          *  \param[in]     LUNIndex         LUN index within the device the command is being issued to.
 198                          *
 199                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or \ref MS_ERROR_LOGICAL_CMD_FAILED if not ready.
 200                          */
 201                         uint8_t MS_Host_TestUnitReady(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 202                                                       const uint8_t LUNIndex) ATTR_NON_NULL_PTR_ARG(1);
 203
 204                         /** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size.
 205                          *
 206                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 207                          *       call will fail.
 208                          *
 209                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
 210                          *  \param[in]     LUNIndex         LUN index within the device the command is being issued to.
 211                          *  \param[out]    DeviceCapacity   Pointer to the location where the capacity information should be stored.
 212                          *
 213                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or \ref MS_ERROR_LOGICAL_CMD_FAILED if not ready.
 214                          */
 215                         uint8_t MS_Host_ReadDeviceCapacity(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 216                                                            const uint8_t LUNIndex,
 217                                                            SCSI_Capacity_t* const DeviceCapacity) ATTR_NON_NULL_PTR_ARG(1)
 218                                                            ATTR_NON_NULL_PTR_ARG(3);
 219
 220                         /** Retrieves the device sense data, indicating the current device state and error codes for the previously
 221                          *  issued command.
 222                          *
 223                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 224                          *       call will fail.
 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]    SenseData        Pointer to the location where the sense information should be stored.
 229                          *
 230                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or \ref MS_ERROR_LOGICAL_CMD_FAILED if not ready.
 231                          */
 232                         uint8_t MS_Host_RequestSense(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 233                                                      const uint8_t LUNIndex,
 234                                                      SCSI_Request_Sense_Response_t* const SenseData) ATTR_NON_NULL_PTR_ARG(1)
 235                                                      ATTR_NON_NULL_PTR_ARG(3);
 236
 237                         /** Issues a PREVENT MEDIUM REMOVAL command, to logically (or, depending on the type of device, physically) lock
 238                          *  the device from removal so that blocks of data on the medium can be read or altered.
 239                          *
 240                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 241                          *       call will fail.
 242                          *
 243                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
 244                          *  \param[in]     LUNIndex         LUN index within the device the command is being issued to.
 245                          *  \param[in]     PreventRemoval   Boolean \c true if the device should be locked from removal, \c false otherwise.
 246                          *
 247                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or \ref MS_ERROR_LOGICAL_CMD_FAILED if not ready.
 248                          */
 249                         uint8_t MS_Host_PreventAllowMediumRemoval(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 250                                                                   const uint8_t LUNIndex,
 251                                                                   const bool PreventRemoval) ATTR_NON_NULL_PTR_ARG(1);
 252
 253                         /** Reads blocks of data from the attached Mass Storage device's medium.
 254                          *
 255                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 256                          *       call will fail.
 257                          *
 258                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
 259                          *  \param[in]     LUNIndex         LUN index within the device the command is being issued to.
 260                          *  \param[in]     BlockAddress     Starting block address within the device to read from.
 261                          *  \param[in]     Blocks           Total number of blocks to read.
 262                          *  \param[in]     BlockSize        Size in bytes of each block within the device.
 263                          *  \param[out]    BlockBuffer      Pointer to where the read data from the device should be stored.
 264                          *
 265                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or \ref MS_ERROR_LOGICAL_CMD_FAILED if not ready.
 266                          */
 267                         uint8_t MS_Host_ReadDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 268                                                          const uint8_t LUNIndex,
 269                                                          const uint32_t BlockAddress,
 270                                                          const uint8_t Blocks,
 271                                                          const uint16_t BlockSize,
 272                                                          void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
 273
 274                         /** Writes blocks of data to the attached Mass Storage device's medium.
 275                          *
 276                          *  \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
 277                          *       call will fail.
 278                          *
 279                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state.
 280                          *  \param[in]     LUNIndex         LUN index within the device the command is being issued to.
 281                          *  \param[in]     BlockAddress     Starting block address within the device to write to.
 282                          *  \param[in]     Blocks           Total number of blocks to read.
 283                          *  \param[in]     BlockSize        Size in bytes of each block within the device.
 284                          *  \param[in]     BlockBuffer      Pointer to where the data to write should be sourced from.
 285                          *
 286                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or \ref MS_ERROR_LOGICAL_CMD_FAILED if not ready.
 287                          */
 288                         uint8_t MS_Host_WriteDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 289                                                           const uint8_t LUNIndex,
 290                                                           const uint32_t BlockAddress,
 291                                                           const uint8_t Blocks,
 292                                                           const uint16_t BlockSize,
 293                                                           const void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);
 294
 295                 /* Inline Functions: */
 296                         /** General management task for a given Mass Storage host class interface, required for the correct operation of
 297                          *  the interface. This should be called frequently in the main program loop, before the master USB management task
 298                          *  \ref USB_USBTask().
 299                          *
 300                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing an Mass Storage Class host configuration and state.
 301                          */
 302                         static inline void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1) ATTR_ALWAYS_INLINE;
 303                         static inline void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo)
 304                         {
 305                                 (void)MSInterfaceInfo;
 306                         }
 307
 308         /* Private Interface - For use in library only: */
 309         #if !defined(__DOXYGEN__)
 310                 /* Macros: */
 311                         #define MS_COMMAND_DATA_TIMEOUT_MS        10000
 312
 313                 /* Function Prototypes: */
 314                         #if defined(__INCLUDE_FROM_MASSSTORAGE_HOST_C)
 315                                 static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 316                                                                    MS_CommandBlockWrapper_t* const SCSICommandBlock,
 317                                                                    const void* const BufferPtr) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 318                                 static uint8_t MS_Host_WaitForDataReceived(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 319                                 static uint8_t MS_Host_SendReceiveData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 320                                                                        MS_CommandBlockWrapper_t* const SCSICommandBlock,
 321                                                                        void* BufferPtr) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 322                                 static uint8_t MS_Host_GetReturnedStatus(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,
 323                                                                          MS_CommandStatusWrapper_t* const SCSICommandStatus)
 324                                                                          ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
 325
 326                                 static uint8_t DCOMP_MS_Host_NextMSInterface(void* const CurrentDescriptor)
 327                                                                              ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
 328                                 static uint8_t DCOMP_MS_Host_NextMSInterfaceEndpoint(void* const CurrentDescriptor)
 329                                                                                      ATTR_WARN_UNUSED_RESULT ATTR_NON_NULL_PTR_ARG(1);
 330                         #endif
 331         #endif
 332
 333         /* Disable C linkage for C++ Compilers: */
 334                 #if defined(__cplusplus)
 335                         }
 336                 #endif
 337
 338 #endif
 339
 340 /** @} */
 341