this software.\r
*/\r
\r
-/** \ingroup Group_USBDeviceClassDrivers\r
- * @defgroup Group_USBClassMSDevice Mass Storage Device Class Driver - LUFA/Drivers/Class/Device/MassStorage.h\r
- *\r
- * \section Sec_Dependencies Module Source Dependencies\r
- * The following files must be built with any user project that uses this module:\r
- * - LUFA/Drivers/USB/Class/Device/MassStorage.c\r
+/** \ingroup Group_USBClassMS\r
+ * @defgroup Group_USBClassMSDevice Mass Storage Class Device Mode Driver\r
*\r
* \section Module Description\r
- * Functions, macros, variables, enums and types related to the management of USB Mass Storage Class interfaces\r
- * within a USB device.\r
+ * Device Mode USB Class driver framework interface, for the Mass Storage USB Class driver.\r
*\r
* @{\r
*/\r
\r
-#ifndef _MS_CLASS_H_\r
-#define _MS_CLASS_H_\r
+#ifndef _MS_CLASS_DEVICE_H_\r
+#define _MS_CLASS_DEVICE_H_\r
\r
/* Includes: */\r
#include "../../USB.h"\r
+ #include "../Common/MassStorage.h"\r
\r
#include <string.h>\r
\r
extern "C" {\r
#endif\r
\r
- /* Macros: */\r
- /** Mass Storage Class specific request to reset the Mass Storage interface, ready for the next command. */\r
- #define REQ_MassStorageReset 0xFF\r
-\r
- /** Mass Storage Class specific request to retrieve the total number of Logical Units (drives) in the SCSI device. */\r
- #define REQ_GetMaxLUN 0xFE\r
- \r
- /** Magic signature for a Command Block Wrapper used in the Mass Storage Bulk-Only transport protocol. */\r
- #define MS_CBW_SIGNATURE 0x43425355UL\r
-\r
- /** Magic signature for a Command Status Wrapper used in the Mass Storage Bulk-Only transport protocol. */\r
- #define MS_CSW_SIGNATURE 0x53425355UL\r
- \r
- /** Mask for a Command Block Wrapper's flags attribute to specify a command with data sent from host-to-device. */\r
- #define MS_COMMAND_DIR_DATA_OUT (0 << 7)\r
-\r
- /** Mask for a Command Block Wrapper's flags attribute to specify a command with data sent from device-to-host. */\r
- #define MS_COMMAND_DIR_DATA_IN (1 << 7)\r
-\r
- /* Type defines: */\r
- /** Type define for a Command Block Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */\r
- typedef struct\r
- {\r
- uint32_t Signature; /**< Command block signature, must be CBW_SIGNATURE to indicate a valid Command Block */\r
- uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper */\r
- uint32_t DataTransferLength; /** Length of the optional data portion of the issued command, in bytes */\r
- uint8_t Flags; /**< Command block flags, indicating command data direction */\r
- uint8_t LUN; /**< Logical Unit number this command is issued to */\r
- uint8_t SCSICommandLength; /**< Length of the issued SCSI command within the SCSI command data array */\r
- uint8_t SCSICommandData[16]; /**< Issued SCSI command in the Command Block */\r
- } CommandBlockWrapper_t;\r
- \r
- /** Type define for a Command Status Wrapper, used in the Mass Storage Bulk-Only Transport protocol. */\r
- typedef struct\r
- {\r
- uint32_t Signature; /**< Status block signature, must be CSW_SIGNATURE to indicate a valid Command Status */\r
- uint32_t Tag; /**< Unique command ID value, to associate a command block wrapper with its command status wrapper */\r
- uint32_t DataTransferResidue; /**< Number of bytes of data not processed in the SCSI command */\r
- uint8_t Status; /**< Status code of the issued command - a value from the MassStorage_CommandStatusCodes_t enum */\r
- } CommandStatusWrapper_t;\r
- \r
- /* Enums: */\r
- /** Enum for the possible command status wrapper return status codes. */\r
- enum MassStorage_CommandStatusCodes_t\r
- {\r
- SCSI_Command_Pass = 0, /**< Command completed with no error */\r
- SCSI_Command_Fail = 1, /**< Command failed to complete - host may check the exact error via a SCSI REQUEST SENSE command */\r
- SCSI_Phase_Error = 2 /**< Command failed due to being invalid in the current phase */\r
- };\r
- \r
- /* Type Defines: */\r
- /** Class state structure. An instance of this structure should be made for each Mass Storage interface\r
- * within the user application, and passed to each of the Mass Storage class driver functions as the\r
- * MSInterfaceInfo parameter. The contents of this structure should be set to their correct\r
- * values when used, or ommitted to force the library to use default values.\r
- */\r
- typedef struct\r
- {\r
- uint8_t InterfaceNumber; /**< Interface number of the Mass Storage interface within the device */\r
-\r
- uint8_t DataINEndpointNumber; /**< Endpoint number of the Mass Storage interface's IN data endpoint */\r
- uint16_t DataINEndpointSize; /**< Size in bytes of the Mass Storage interface's IN data endpoint */\r
-\r
- uint8_t DataOUTEndpointNumber; /**< Endpoint number of the Mass Storage interface's OUT data endpoint */\r
- uint16_t DataOUTEndpointSize; /**< Size in bytes of the Mass Storage interface's OUT data endpoint */\r
-\r
- uint8_t TotalLUNs; /**< Total number of logical drives in the Mass Storage interface */\r
-\r
- CommandBlockWrapper_t CommandBlock; /**< Mass Storage class command block structure, used internally\r
- * by the class driver\r
- */\r
- CommandStatusWrapper_t CommandStatus; /**< Mass Storage class command status structure, used internally\r
- * by the class driver\r
- */\r
-\r
- bool IsMassStoreReset; /**< Flag indicating that the host has requested that the Mass Storage interface be reset\r
- * and that all current Mass Storage operations should immediately abort\r
- */\r
- } USB_ClassInfo_MS_t;\r
- \r
/* Function Prototypes: */\r
- #if defined(INCLUDE_FROM_MS_CLASS_C)\r
+ #if defined(INCLUDE_FROM_MS_CLASS_DEVICE_C)\r
static void MS_Device_ReturnCommandStatus(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
static bool MS_Device_ReadInCommandBlock(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
static uint8_t StreamCallback_MS_Device_AbortOnMassStoreReset(void);\r
projects / pub / USBasp.git / blobdiff