Added new JoystickHostWithParser demos to the library.

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Host / MassStorage.h

diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.h b/LUFA/Drivers/USB/Class/Host/MassStorage.h
index ff2e901..192e478 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/MassStorage.h
+++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h
@@ -55,7 +55,8 @@
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
 \r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r

-                       #define MS_ERROR_LOGICAL_CMD_FAILED              0xC0\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
        \r
                /* Type Defines: */\r
                        /** Class state structure. An instance of this structure should be made within the user application,\r


@@ -96,7 +97,7 @@
                         */\r
                        typedef struct\r
                        {\r
                         */\r
                        typedef struct\r
                        {\r

-                               uint8_t       ReponseCode;\r
+                               uint8_t       ResponseCode;\r

 \r
                                uint8_t       SegmentNumber;\r
                                \r
 \r
                                uint8_t       SegmentNumber;\r
                                \r


@@ -178,7 +179,7 @@
                         *\r
                         *  \param[in,out] MSInterfaceInfo  Pointer to a structure containing an MS Class host configuration and state\r
                         */\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
                        \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


@@ -187,12 +188,12 @@
                         *  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
                         *  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
                         *  \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
                                                       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


@@ -202,7 +203,7 @@
                         *\r
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum\r
                         */\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
                        /** 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
 \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


@@ -213,7 +214,7 @@
                         *\r
                         *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum\r
                         */\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* MSInterfaceInfo, uint8_t* MaxLUNIndex) ATTR_NON_NULL_PTR_ARG(1, 2);\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
                        /** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and\r
                         *  properties.\r
 \r
                        /** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and\r
                         *  properties.\r


@@ -224,8 +225,8 @@
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED\r
                         */\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* MSInterfaceInfo, uint8_t LUNIndex,\r
-                                                      SCSI_Inquiry_Response_t* InquiryData) ATTR_NON_NULL_PTR_ARG(1, 3);\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
                        /** Sends a TEST UNIT READY command to the device, to determine if it is ready to accept other SCSI commands.\r
                         *\r
 \r
                        /** Sends a TEST UNIT READY command to the device, to determine if it is ready to accept other SCSI commands.\r
                         *\r


@@ -234,7 +235,7 @@
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
                         */\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* MSInterfaceInfo, uint8_t LUNIndex) ATTR_NON_NULL_PTR_ARG(1);\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
                        /** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size.\r
                         *\r
 \r
                        /** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size.\r
                         *\r


@@ -244,8 +245,8 @@
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
                         */\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* MSInterfaceInfo, uint8_t LUNIndex,\r
-                                                          SCSI_Capacity_t* DeviceCapacity) ATTR_NON_NULL_PTR_ARG(1, 3);\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
                        /** Retrieves the device sense data, indicating the current device state and error codes for the previously\r
                         *  issued command.\r


@@ -256,8 +257,8 @@
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
                         */\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* MSInterfaceInfo, uint8_t LUNIndex,\r
-                                                    SCSI_Request_Sense_Response_t* SenseData) ATTR_NON_NULL_PTR_ARG(1, 3);\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
                        /** 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


@@ -268,8 +269,8 @@
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
                         */\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* MSInterfaceInfo, uint8_t LUNIndex,\r
-                                                                 bool PreventRemoval) ATTR_NON_NULL_PTR_ARG(1);\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
                        \r
                        /** Reads blocks of data from the attached Mass Storage device's medium.\r
                         *\r


@@ -282,8 +283,9 @@
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
                         */\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* MSInterfaceInfo, uint8_t LUNIndex, uint32_t BlockAddress,\r
-                                                        uint8_t Blocks, uint16_t BlockSize, void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1, 6);\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
                \r
                        /** Writes blocks of data to the attached Mass Storage device's medium.\r
                         *\r


@@ -296,8 +298,9 @@
                         *\r
                         *  \return A value from the \ref Pipe_Stream_RW_ErrorCodes_t enum or MS_ERROR_LOGICAL_CMD_FAILED if not ready\r
                         */\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* MSInterfaceInfo, uint8_t LUNIndex, uint32_t BlockAddress,\r
-                                                         uint8_t Blocks, uint16_t BlockSize, void* BlockBuffer) ATTR_NON_NULL_PTR_ARG(1, 6);\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
 \r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r


@@ -322,17 +325,17 @@
                        \r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_MS_CLASS_HOST_C)               \r
                        \r
                /* Function Prototypes: */\r
                        #if defined(INCLUDE_FROM_MS_CLASS_HOST_C)               \r

-                               static uint8_t DComp_NextMSInterface(void* CurrentDescriptor);\r
-                               static uint8_t DComp_NextMSInterfaceEndpoint(void* CurrentDescriptor);\r
+                               static uint8_t DComp_NextMSInterface(void* const CurrentDescriptor);\r
+                               static uint8_t DComp_NextMSInterfaceEndpoint(void* const CurrentDescriptor);\r

                                \r
                                \r

-                               static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* MSInterfaceInfo,\r
-                                                                  MS_CommandBlockWrapper_t* SCSICommandBlock,\r
+                               static uint8_t MS_Host_SendCommand(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,\r
+                                                                  MS_CommandBlockWrapper_t* const SCSICommandBlock,\r

                                                                   void* BufferPtr);\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
+                               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
+                               static uint8_t MS_Host_GetReturnedStatus(USB_ClassInfo_MS_Host_t* const MSInterfaceInfo,\r
+                                                                        MS_CommandStatusWrapper_t* const SCSICommandStatus);\r

                        #endif\r
        #endif\r
        \r
                        #endif\r
        #endif\r
        \r