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