this software.\r
*/\r
\r
+/** \file\r
+ * \brief Host mode driver for the library USB Mass Storage Class driver.\r
+ *\r
+ * Host mode driver for the library USB Mass Storage Class driver.\r
+ *\r
+ * \note This file should not be included directly. It is automatically included as needed by the class driver\r
+ * dispatch header located in LUFA/Drivers/USB/Class/MassStorage.h.\r
+ */\r
+\r
/** \ingroup Group_USBClassMS\r
* @defgroup Group_USBClassMassStorageHost Mass Storage Class Host Mode Driver\r
*\r
#define MS_ERROR_LOGICAL_CMD_FAILED 0x80\r
\r
/* Type Defines: */\r
- /** Class state structure. An instance of this structure should be made within the user application,\r
+ /** \brief Mass Storage Class Host Mode Configuration and State Structure.\r
+ *\r
+ * Class state structure. An instance of this structure should be made within the user application,\r
* and passed to each of the Mass Storage class driver functions as the MSInterfaceInfo parameter. This\r
* stores each Mass Storage interface's configuration and state information.\r
*/\r
*/\r
} USB_ClassInfo_MS_Host_t;\r
\r
- /** SCSI capacity structure, to hold the total capacity of the device in both the number\r
+ /** \brief SCSI Device LUN Capacity Structure.\r
+ *\r
+ * SCSI capacity structure, to hold the total capacity of the device in both the number\r
* of blocks in the current LUN, and the size of each block. This structure is filled by\r
* the device when the MassStore_ReadCapacity() function is called.\r
*/\r
*/\r
uint8_t MS_Host_WriteDeviceBlocks(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,\r
const uint32_t BlockAddress, const uint8_t Blocks, const uint16_t BlockSize,\r
- void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);\r
+ const void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(6);\r
\r
/* Inline Functions: */\r
/** General management task for a given Mass Storage host class interface, required for the correct operation of\r
\r
static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,\r
MS_CommandBlockWrapper_t* const SCSICommandBlock,\r
- void* BufferPtr);\r
+ const void* const BufferPtr);\r
static uint8_t MS_Host_WaitForDataReceived(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo);\r
static uint8_t MS_Host_SendReceiveData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, \r
MS_CommandBlockWrapper_t* const SCSICommandBlock, void* BufferPtr);\r