#endif\r
\r
/* Public Interface - May be used in end-application: */\r
+ /* Macros: */\r
+ /** Error code for some Mass Storage Host functions, indicating a logical (and not hardware) error */\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
* and passed to each of the HID class driver functions as the HIDInterfaceInfo parameter. This\r
*/\r
struct\r
{\r
- bool Active; /**< Indicates if the current interface instance is connected to an attached device, valid\r
- * after \ref HID_Host_ConfigurePipes() is called and the Host state machine is in the\r
- * Configured state\r
- */\r
+ bool IsActive; /**< Indicates if the current interface instance is connected to an attached device, valid\r
+ * after \ref HID_Host_ConfigurePipes() is called and the Host state machine is in the\r
+ * Configured state\r
+ */\r
uint8_t InterfaceNumber; /**< Interface index of the HID interface within the attached device */\r
\r
uint16_t DataINPipeSize; /**< Size in bytes of the MS interface's IN data pipe */\r
*/\r
typedef struct\r
{\r
- uint8_t ReponseCode;\r
+ uint8_t ResponseCode;\r
\r
uint8_t SegmentNumber;\r
\r
} SCSI_Capacity_t;\r
\r
/* Enums: */\r
- enum\r
+ enum MSHost_EnumerationFailure_ErrorCodes_t\r
{\r
MS_ENUMERROR_NoError = 0, /**< Configuration Descriptor was processed successfully */\r
MS_ENUMERROR_InvalidConfigDescriptor = 1, /**< The device returned an invalid Configuration Descriptor */\r
MS_ENUMERROR_NoMSInterfaceFound = 2, /**< A compatible Mass Storage interface was not found in the device's Configuration Descriptor */\r
MS_ENUMERROR_EndpointsNotFound = 3, /**< Compatible Mass Storage endpoints were not found in the device's interfaces */\r
- } MSHost_EnumerationFailure_ErrorCodes_t;\r
+ };\r
\r
/* Function Prototypes: */\r
/** General management task for a given Mass Storage host class interface, required for the correct operation of\r
*\r
* \param[in,out] MSInterfaceInfo Pointer to a structure containing an MS Class host configuration and state\r
*/\r
- void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+ void MS_Host_USBTask(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Host interface configuration routine, to configure a given Mass Storage host interface instance using the\r
* Configuration Descriptor read from an attached USB device. This function automatically updates the given Mass\r
* the host state machine is in the Addressed state.\r
*\r
* \param[in,out] MSInterfaceInfo Pointer to a structure containing an MS Class host configuration and state\r
- * \param[in] ConfigDescriptorLength Length of the attached device's Configuration Descriptor\r
+ * \param[in] ConfigDescriptorSize Length of the attached device's Configuration Descriptor\r
* \param[in] DeviceConfigDescriptor Pointer to a buffer containing the attached device's Configuration Descriptor\r
+ *\r
+ * \return A value from the \ref MSHost_EnumerationFailure_ErrorCodes_t enum\r
*/\r
- uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint16_t ConfigDescriptorLength,\r
+ uint8_t MS_Host_ConfigurePipes(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, uint16_t ConfigDescriptorSize,\r
uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);\r
\r
/** Sends a MASS STORAGE RESET control request to the attached device, resetting the Mass Storage Interface\r
*\r
* \return A value from the \ref USB_Host_SendControlErrorCodes_t enum\r
*/\r
- uint8_t MS_Host_ResetMSInterface(USB_ClassInfo_MS_Host_t* MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+ uint8_t MS_Host_ResetMSInterface(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
- uint8_t MS_Host_GetMaxLUN(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t* MaxLUNIndex) ATTR_NON_NULL_PTR_ARG(1, 2);\r
+ /** Sends a GET MAX LUN control request to the attached device, retrieving the index of the highest LUN (Logical\r
+ * UNit, a logical drive) in the device. This value can then be used in the other functions of the Mass Storage\r
+ * Host mode Class driver to address a specific LUN within the device.\r
+ *\r
+ * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state\r
+ * \param[out] MaxLUNIndex Pointer to a location where the highest LUN index value should be stored\r
+ *\r
+ * \return A value from the \ref USB_Host_SendControlErrorCodes_t enum\r
+ */\r
+ uint8_t MS_Host_GetMaxLUN(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, uint8_t* const MaxLUNIndex) ATTR_NON_NULL_PTR_ARG(1, 2);\r
\r
- uint8_t MS_Host_GetInquiryData(USB_ClassInfo_MS_Host_t* MSInterfaceInfo,\r
- SCSI_Inquiry_Response_t* InquiryData) ATTR_NON_NULL_PTR_ARG(1, 2);\r
+ /** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and\r
+ * properties.\r
+ *\r
+ * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state\r
+ * \param[in] LUNIndex LUN index within the device the command is being issued to\r
+ * \param[out] InquiryData Location where the read inquiry data should be stored\r
+ *\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED\r
+ */\r
+ uint8_t MS_Host_GetInquiryData(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,\r
+ SCSI_Inquiry_Response_t* const InquiryData) ATTR_NON_NULL_PTR_ARG(1, 3);\r
\r
- uint8_t MS_Host_TestUnitReady(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t LUNIndex,\r
- bool* DeviceReady) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+ /** Sends a TEST UNIT READY command to the device, to determine if it is ready to accept other SCSI commands.\r
+ *\r
+ * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state\r
+ * \param[in] LUNIndex LUN index within the device the command is being issued to\r
+ *\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
+ */\r
+ uint8_t MS_Host_TestUnitReady(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex) ATTR_NON_NULL_PTR_ARG(1);\r
\r
- uint8_t MS_Host_ReadDeviceCapacity(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, uint8_t LUNIndex,\r
- SCSI_Capacity_t* DeviceCapacity) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+ /** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size.\r
+ *\r
+ * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state\r
+ * \param[in] LUNIndex LUN index within the device the command is being issued to\r
+ * \param[out] DeviceCapacity Pointer to the location where the capacity information should be stored\r
+ *\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
+ */\r
+ uint8_t MS_Host_ReadDeviceCapacity(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,\r
+ SCSI_Capacity_t* const DeviceCapacity) ATTR_NON_NULL_PTR_ARG(1, 3);\r
\r
+ /** Retrieves the device sense data, indicating the current device state and error codes for the previously\r
+ * issued command.\r
+ *\r
+ * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state\r
+ * \param[in] LUNIndex LUN index within the device the command is being issued to\r
+ * \param[out] SenseData Pointer to the location where the sense information should be stored\r
+ *\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
+ */\r
+ uint8_t MS_Host_RequestSense(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,\r
+ SCSI_Request_Sense_Response_t* const SenseData) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+ \r
+ /** Issues a PREVENT MEDIUM REMOVAL command, to logically (or, depending on the type of device, physically) lock\r
+ * the device from removal so that blocks of data on the medium can be read or altered.\r
+ *\r
+ * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state\r
+ * \param[in] LUNIndex LUN index within the device the command is being issued to\r
+ * \param[in] PreventRemoval Boolean true if the device should be locked from removal, false otherwise\r
+ *\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
+ */\r
+ uint8_t MS_Host_PreventAllowMediumRemoval(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo, const uint8_t LUNIndex,\r
+ const bool PreventRemoval) ATTR_NON_NULL_PTR_ARG(1);\r
+ \r
+ /** Reads blocks of data from the attached Mass Storage device's medium.\r
+ *\r
+ * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state\r
+ * \param[in] LUNIndex LUN index within the device the command is being issued to\r
+ * \param[in] BlockAddress Starting block address within the device to read from\r
+ * \param[in] Blocks Total number of blocks to read\r
+ * \param[in] BlockSize Size in bytes of each block within the device\r
+ * \param[out] BlockBuffer Pointer to where the read data from the device should be stored\r
+ *\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
+ */\r
+ uint8_t MS_Host_ReadDeviceBlocks(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, 6);\r
+ \r
+ /** Writes blocks of data to the attached Mass Storage device's medium.\r
+ *\r
+ * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state\r
+ * \param[in] LUNIndex LUN index within the device the command is being issued to\r
+ * \param[in] BlockAddress Starting block address within the device to write to\r
+ * \param[in] Blocks Total number of blocks to read\r
+ * \param[in] BlockSize Size in bytes of each block within the device\r
+ * \param[in] BlockBuffer Pointer to where the data to write should be sourced from\r
+ *\r
+ * \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\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, 6);\r
+\r
/* Private Interface - For use in library only: */\r
#if !defined(__DOXYGEN__)\r
/* Macros: */\r
\r
/* Function Prototypes: */\r
#if defined(INCLUDE_FROM_MS_CLASS_HOST_C) \r
- static uint8_t DComp_NextMassStorageInterface(void* CurrentDescriptor);\r
- static uint8_t DComp_NextInterfaceBulkDataEndpoint(void* CurrentDescriptor);\r
+ static uint8_t DComp_NextMSInterface(void* CurrentDescriptor);\r
+ static uint8_t DComp_NextMSInterfaceEndpoint(void* CurrentDescriptor);\r
\r
- static uint8_t MassStore_SendCommand(USB_ClassInfo_MS_Host_t* MSInterfaceInfo,\r
- MS_CommandBlockWrapper_t* SCSICommandBlock);\r
- static uint8_t MassStore_WaitForDataReceived(USB_ClassInfo_MS_Host_t* MSInterfaceInfo);\r
- static uint8_t MassStore_SendReceiveData(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, \r
- MS_CommandBlockWrapper_t* SCSICommandBlock, void* BufferPtr);\r
- static uint8_t MassStore_GetReturnedStatus(USB_ClassInfo_MS_Host_t* MSInterfaceInfo,\r
- MS_CommandStatusWrapper_t* SCSICommandStatus);\r
+ static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* MSInterfaceInfo,\r
+ MS_CommandBlockWrapper_t* SCSICommandBlock,\r
+ void* BufferPtr);\r
+ static uint8_t MS_Host_WaitForDataReceived(USB_ClassInfo_MS_Host_t* MSInterfaceInfo);\r
+ static uint8_t MS_Host_SendReceiveData(USB_ClassInfo_MS_Host_t* MSInterfaceInfo, \r
+ MS_CommandBlockWrapper_t* SCSICommandBlock, void* BufferPtr);\r
+ static uint8_t MS_Host_GetReturnedStatus(USB_ClassInfo_MS_Host_t* MSInterfaceInfo,\r
+ MS_CommandStatusWrapper_t* SCSICommandStatus);\r
#endif\r
#endif\r
\r
projects / pub / USBasp.git / blobdiff