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
+ *\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
+ *\r
+ * @{\r
+ */\r
+\r
#ifndef _MS_CLASS_H_\r
#define _MS_CLASS_H_\r
\r
\r
#include <string.h>\r
\r
+ /* Enable C linkage for C++ Compilers: */\r
+ #if defined(__cplusplus)\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
- /** Maximum length of a SCSI command which can be issued by the device or host in a Mass Storage bulk wrapper. */\r
- #define MAX_SCSI_COMMAND_LENGTH 16\r
\r
/** Magic signature for a Command Block Wrapper used in the Mass Storage Bulk-Only transport protocol. */\r
- #define CBW_SIGNATURE 0x43425355UL\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 CSW_SIGNATURE 0x53425355UL\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 COMMAND_DIRECTION_DATA_OUT (0 << 7)\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 COMMAND_DIRECTION_DATA_IN (1 << 7)\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
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[MAX_SCSI_COMMAND_LENGTH]; /**< Issued SCSI command in the Command Block */\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
/** Enum for the possible command status wrapper return status codes. */\r
enum MassStorage_CommandStatusCodes_t\r
{\r
- Command_Pass = 0, /**< Command completed with no error */\r
- Command_Fail = 1, /**< Command failed to complete - host may check the exact error via a SCSI REQUEST SENSE command */\r
- Phase_Error = 2 /**< Command failed due to being invalid in the current phase */\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
- /** Type define for the virtual serial port line encoding settings, for storing the current USART configuration\r
- * as set by the host via a class specific request.\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 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;\r
+ uint8_t TotalLUNs; /**< Total number of logical drives in the Mass Storage interface */\r
\r
- CommandBlockWrapper_t CommandBlock;\r
- CommandStatusWrapper_t CommandStatus;\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;\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
static uint8_t StreamCallback_AbortOnMassStoreReset(void);\r
#endif\r
\r
- void USB_MS_USBTask(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
+ /** Configures the endpoints of a given Mass Storage interface, ready for use. This should be linked to the library\r
+ * \ref EVENT_USB_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
+ * containing the given Mass Storage interface is selected.\r
+ *\r
+ * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state.\r
+ *\r
+ * \return Boolean true if the endpoints were sucessfully configured, false otherwise\r
+ */\r
bool USB_MS_ConfigureEndpoints(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
+ \r
+ /** Processes incomming control requests from the host, that are directed to the given Mass Storage class interface. This should be\r
+ * linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
+ *\r
+ * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state.\r
+ */ \r
void USB_MS_ProcessControlPacket(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
+\r
+ /** General management task for a given Mass Storage class interface, required for the correct operation of the interface. This should\r
+ * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
+ *\r
+ * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage configuration and state.\r
+ */\r
+ void USB_MS_USBTask(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
\r
+ /** Mass Storage class driver callback for the user processing of a received SCSI command. This callback will fire each time the\r
+ * host sends a SCSI command which requires processing by the user application. Inside this callback the user is responsible\r
+ * for the processing of the received SCSI command from the host. The SCSI command is available in the CommandBlock structure\r
+ * inside the Mass Storage class state structure passed as a parameter to the callback function.\r
+ *\r
+ * \param MSInterfaceInfo Pointer to a structure containing a Mass Storage Class configuration and state.\r
+ *\r
+ * \return Boolean true if the SCSI command was successfully processed, false otherwise\r
+ */\r
bool CALLBACK_USB_MS_SCSICommandReceived(USB_ClassInfo_MS_t* MSInterfaceInfo);\r
\r
+ /* Disable C linkage for C++ Compilers: */\r
+ #if defined(__cplusplus)\r
+ }\r
+ #endif\r
+ \r
#endif\r
+\r
+/** @} */\r
projects / pub / lufa.git / blobdiff