MassStorage.h 9.16 KB
 Dean Camera committed Jun 01, 2009 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 /* LUFA Library Copyright (C) Dean Camera, 2009. dean [at] fourwalledcubicle [dot] com www.fourwalledcubicle.com */ /* Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com) Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that the copyright notice and this permission notice and warranty disclaimer appear in supporting documentation, and that the name of the author not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. The author disclaim all warranties with regard to this software, including all implied warranties of merchantability and fitness. In no event shall the author be liable for any special, indirect or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of this software. */  Dean Camera committed Jun 04, 2009 31 32 33 34 35 36 37 38 39 40 41 42 43 44 /** \ingroup Group_USBDeviceClassDrivers * @defgroup Group_USBClassMSDevice Mass Storage Device Class Driver - LUFA/Drivers/Class/Device/MassStorage.h * * \section Sec_Dependencies Module Source Dependencies * The following files must be built with any user project that uses this module: * - LUFA/Drivers/USB/Class/Device/MassStorage.c * * \section Module Description * Functions, macros, variables, enums and types related to the management of USB Mass Storage Class interfaces * within a USB device. * * @{ */  Dean Camera committed Jun 01, 2009 45 46 47 48 49 50 51 52 #ifndef _MS_CLASS_H_ #define _MS_CLASS_H_ /* Includes: */ #include "../../USB.h" #include  Dean Camera committed Jun 04, 2009 53 54 55 56 57  /* Enable C linkage for C++ Compilers: */ #if defined(__cplusplus) extern "C" { #endif  Dean Camera committed Jun 01, 2009 58 59 60 61 62 63 64 65  /* Macros: */ /** Mass Storage Class specific request to reset the Mass Storage interface, ready for the next command. */ #define REQ_MassStorageReset 0xFF /** Mass Storage Class specific request to retrieve the total number of Logical Units (drives) in the SCSI device. */ #define REQ_GetMaxLUN 0xFE /** Magic signature for a Command Block Wrapper used in the Mass Storage Bulk-Only transport protocol. */  Dean Camera committed Jun 04, 2009 66  #define MS_CBW_SIGNATURE 0x43425355UL  Dean Camera committed Jun 01, 2009 67 68  /** Magic signature for a Command Status Wrapper used in the Mass Storage Bulk-Only transport protocol. */  Dean Camera committed Jun 04, 2009 69  #define MS_CSW_SIGNATURE 0x53425355UL  Dean Camera committed Jun 01, 2009 70 71  /** Mask for a Command Block Wrapper's flags attribute to specify a command with data sent from host-to-device. */  Dean Camera committed Jun 04, 2009 72  #define MS_COMMAND_DIR_DATA_OUT (0 << 7)  Dean Camera committed Jun 01, 2009 73 74  /** Mask for a Command Block Wrapper's flags attribute to specify a command with data sent from device-to-host. */  Dean Camera committed Jun 04, 2009 75  #define MS_COMMAND_DIR_DATA_IN (1 << 7)  Dean Camera committed Jun 01, 2009 76 77 78 79 80 81 82 83 84 85 86  /* Type defines: */ /** Type define for a Command Block Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */ typedef struct { uint32_t Signature; /**< Command block signature, must be CBW_SIGNATURE to indicate a valid Command Block */ uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper */ uint32_t DataTransferLength; /** Length of the optional data portion of the issued command, in bytes */ uint8_t Flags; /**< Command block flags, indicating command data direction */ uint8_t LUN; /**< Logical Unit number this command is issued to */ uint8_t SCSICommandLength; /**< Length of the issued SCSI command within the SCSI command data array */  Dean Camera committed Jun 04, 2009 87  uint8_t SCSICommandData[16]; /**< Issued SCSI command in the Command Block */  Dean Camera committed Jun 01, 2009 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102  } CommandBlockWrapper_t; /** Type define for a Command Status Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */ typedef struct { uint32_t Signature; /**< Status block signature, must be CSW_SIGNATURE to indicate a valid Command Status */ uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper */ uint32_t DataTransferResidue; /**< Number of bytes of data not processed in the SCSI command */ uint8_t Status; /**< Status code of the issued command - a value from the MassStorage_CommandStatusCodes_t enum */ } CommandStatusWrapper_t; /* Enums: */ /** Enum for the possible command status wrapper return status codes. */ enum MassStorage_CommandStatusCodes_t {  Dean Camera committed Jun 04, 2009 103 104 105  SCSI_Command_Pass = 0, /**< Command completed with no error */ SCSI_Command_Fail = 1, /**< Command failed to complete - host may check the exact error via a SCSI REQUEST SENSE command */ SCSI_Phase_Error = 2 /**< Command failed due to being invalid in the current phase */  Dean Camera committed Jun 01, 2009 106 107 108  }; /* Type Defines: */  Dean Camera committed Jun 08, 2009 109 110 111 112  /** Class state structure. An instance of this structure should be made for each Mass Storage interface * within the user application, and passed to each of the Mass Storage class driver functions as the * MSInterfaceInfo parameter. The contents of this structure should be set to their correct * values when used, or ommitted to force the library to use default values.  Dean Camera committed Jun 01, 2009 113 114 115 116 117 118 119 120 121 122 123  */ typedef struct { uint8_t InterfaceNumber; /**< Interface number of the Mass Storage interface within the device */ uint8_t DataINEndpointNumber; /**< Endpoint number of the Mass Storage interface's IN data endpoint */ uint16_t DataINEndpointSize; /**< Size in bytes of the Mass Storage interface's IN data endpoint */ uint8_t DataOUTEndpointNumber; /**< Endpoint number of the Mass Storage interface's OUT data endpoint */ uint16_t DataOUTEndpointSize; /**< Size in bytes of the Mass Storage interface's OUT data endpoint */  Dean Camera committed Jun 08, 2009 124  uint8_t TotalLUNs; /**< Total number of logical drives in the Mass Storage interface */  Dean Camera committed Jun 01, 2009 125   Dean Camera committed Jun 08, 2009 126 127 128 129 130 131  CommandBlockWrapper_t CommandBlock; /**< Mass Storage class command block structure, used internally * by the class driver */ CommandStatusWrapper_t CommandStatus; /**< Mass Storage class command status structure, used internally * by the class driver */  Dean Camera committed Jun 01, 2009 132   Dean Camera committed Jun 08, 2009 133 134 135  bool IsMassStoreReset; /**< Flag indicating that the host has requested that the Mass Storage interface be reset * and that all current Mass Storage operations should immediately abort */  Dean Camera committed Jun 01, 2009 136 137 138 139  } USB_ClassInfo_MS_t; /* Function Prototypes: */ #if defined(INCLUDE_FROM_MS_CLASS_C)  Dean Camera committed Jun 11, 2009 140 141 142  static void MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_t* MSInterfaceInfo); static bool MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_t* MSInterfaceInfo); static uint8_t StreamCallback_MS_Device_AbortOnMassStoreReset(void);  Dean Camera committed Jun 01, 2009 143 144  #endif  Dean Camera committed Jun 08, 2009 145 146 147 148 149 150 151 152  /** Configures the endpoints of a given Mass Storage interface, ready for use. This should be linked to the library * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration * containing the given Mass Storage interface is selected. * * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state. * * \return Boolean true if the endpoints were sucessfully configured, false otherwise */  Dean Camera committed Jun 11, 2009 153  bool MS_Device_ConfigureEndpoints(USB_ClassInfo_MS_t* MSInterfaceInfo);  Dean Camera committed Jun 08, 2009 154 155 156 157 158 159  /** Processes incomming control requests from the host, that are directed to the given Mass Storage class interface. This should be * linked to the library \ref EVENT_USB_UnhandledControlPacket() event. * * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state. */  Dean Camera committed Jun 11, 2009 160  void MS_Device_ProcessControlPacket(USB_ClassInfo_MS_t* MSInterfaceInfo);  Dean Camera committed Jun 08, 2009 161 162 163 164 165 166  /** General management task for a given Mass Storage class interface, required for the correct operation of the interface. This should * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask(). * * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage configuration and state. */  Dean Camera committed Jun 11, 2009 167  void MS_Device_USBTask(USB_ClassInfo_MS_t* MSInterfaceInfo);  Dean Camera committed Jun 01, 2009 168   Dean Camera committed Jun 08, 2009 169 170 171 172 173 174 175 176 177  /** Mass Storage class driver callback for the user processing of a received SCSI command. This callback will fire each time the * host sends a SCSI command which requires processing by the user application. Inside this callback the user is responsible * for the processing of the received SCSI command from the host. The SCSI command is available in the CommandBlock structure * inside the Mass Storage class state structure passed as a parameter to the callback function. * * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state. * * \return Boolean true if the SCSI command was successfully processed, false otherwise */  Dean Camera committed Jun 11, 2009 178  bool CALLBACK_MS_Device_SCSICommandReceived(USB_ClassInfo_MS_t* MSInterfaceInfo);  Dean Camera committed Jun 01, 2009 179   Dean Camera committed Jun 04, 2009 180 181 182 183 184  /* Disable C linkage for C++ Compilers: */ #if defined(__cplusplus) } #endif  Dean Camera committed Jun 01, 2009 185 #endif  Dean Camera committed Jun 04, 2009 186 187  /** @} */