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                 #include "../Common/SCSICodes.h"
  51
  52         /* Enable C linkage for C++ Compilers: */
  53                 #if defined(__cplusplus)
  54                         extern "C" {
  55                 #endif
  56
  57         /* Public Interface - May be used in end-application: */
  58                 /* Macros: */
  59                         #define MS_ERROR_LOGICAL_CMD_FAILED              0xC0
  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 Active; /**< 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       ReponseCode;
 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
 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                         } MSHost_EnumerationFailure_ErrorCodes_t;
 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* 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] ConfigDescriptorLength  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                         uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint16_t ConfigDescriptorLength,
 195                                                        uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);
 196
 197                         /** Sends a MASS STORAGE RESET control request to the attached device, resetting the Mass Storage Interface
 198                          *  and readying it for the next Mass Storage command.
 199                          *
 200                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 201                          *
 202                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 203                          */
 204                         uint8_t MS_Host_ResetMSInterface(USB_ClassInfo_MS_Host_t* MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
 205
 206                         /** Sends a GET MAX LUN control request to the attached device, retrieving the index of the highest LUN (Logical
 207                          *  UNit, a logical drive) in the device. This value can then be used in the other functions of the Mass Storage
 208                          *  Host mode Class driver to address a specific LUN within the device.
 209                          *
 210                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 211                          *  \param[out] MaxLUNIndex  Pointer to a location where the highest LUN index value should be stored
 212                          *
 213                          *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum
 214                          */
 215                         uint8_t MS_Host_GetMaxLUN(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t* MaxLUNIndex) ATTR_NON_NULL_PTR_ARG(1, 2);
 216
 217                         /** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and
 218                          *  properties.
 219                          *
 220                          *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing a MS Class host configuration and state
 221                          *  \param[in] LUNIndex  LUN index within the device the command is being issued to
 222                          *  \param[out] InquiryData  Location where the read inquiry data should be stored
 223                          *
 224                          *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED
 225                          */
 226                         uint8_t MS_Host_GetInquiryData(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t LUNIndex,
 227                                                        SCSI_Inquiry_Response_t* InquiryData) ATTR_NON_NULL_PTR_ARG(1, 3);
 228
 229                         uint8_t MS_Host_TestUnitReady(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t LUNIndex) ATTR_NON_NULL_PTR_ARG(1);
 230
 231                         uint8_t MS_Host_ReadDeviceCapacity(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t LUNIndex,
 232                                                            SCSI_Capacity_t* DeviceCapacity) ATTR_NON_NULL_PTR_ARG(1, 3);
 233
 234                         uint8_t MS_Host_RequestSense(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t LUNIndex,
 235                                                      SCSI_Request_Sense_Response_t* SenseData) ATTR_NON_NULL_PTR_ARG(1, 3);
 236
 237                         uint8_t MS_Host_PreventAllowMediumRemoval(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t LUNIndex,
 238                                                                   bool PreventRemoval) ATTR_NON_NULL_PTR_ARG(1);
 239
 240                         uint8_t MS_Host_ReadDeviceBlocks(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t LUNIndex, uint32_t BlockAddr,
 241                                                          uint8_t Blocks, uint16_t BlockSize, void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1, 6);
 242
 243                         uint8_t MS_Host_WriteDeviceBlocks(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t LUNIndex, uint32_t BlockAddr,
 244                                                           uint8_t Blocks, uint16_t BlockSize, void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1, 6);
 245
 246         /* Private Interface - For use in library only: */
 247         #if !defined(__DOXYGEN__)
 248                 /* Macros: */
 249                         #define MASS_STORE_CLASS               0x08
 250                         #define MASS_STORE_SUBCLASS            0x06
 251                         #define MASS_STORE_PROTOCOL            0x50
 252
 253                         #define REQ_MassStorageReset           0xFF
 254                         #define REQ_GetMaxLUN                  0xFE
 255
 256                         #define CBW_SIGNATURE                  0x43425355UL
 257                         #define CSW_SIGNATURE                  0x53425355UL
 258
 259                         #define COMMAND_DIRECTION_DATA_OUT     (0 << 7)
 260                         #define COMMAND_DIRECTION_DATA_IN      (1 << 7)
 261
 262                         #define COMMAND_DATA_TIMEOUT_MS        2000
 263
 264                         #define MS_FOUND_DATAPIPE_IN           (1 << 0)
 265                         #define MS_FOUND_DATAPIPE_OUT          (1 << 1)
 266
 267                 /* Function Prototypes: */
 268                         #if defined(INCLUDE_FROM_MS_CLASS_HOST_C)
 269                                 static uint8_t DComp_NextMassStorageInterface(void* CurrentDescriptor);
 270                                 static uint8_t DComp_NextInterfaceBulkDataEndpoint(void* CurrentDescriptor);
 271
 272                                 static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* MSInterfaceInfo,
 273                                                                    MS_CommandBlockWrapper_t* SCSICommandBlock);
 274                                 static uint8_t MS_Host_WaitForDataReceived(USB_ClassInfo_MS_Host_t* MSInterfaceInfo);
 275                                 static uint8_t MS_Host_SendReceiveData(USB_ClassInfo_MS_Host_t* MSInterfaceInfo,
 276                                                        MS_CommandBlockWrapper_t* SCSICommandBlock, void* BufferPtr);
 277                                 static uint8_t MS_Host_GetReturnedStatus(USB_ClassInfo_MS_Host_t* MSInterfaceInfo,
 278                                                                          MS_CommandStatusWrapper_t* SCSICommandStatus);
 279                         #endif
 280         #endif
 281
 282         /* Disable C linkage for C++ Compilers: */
 283                 #if defined(__cplusplus)
 284                         }
 285                 #endif
 286
 287 #endif
 288
 289 /** @} */