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