Fix Mass Storage Host Class driver GetMaxLUN command - incorrect function return...

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

diff --git a/LUFA/Drivers/USB/Class/Host/HID.h b/LUFA/Drivers/USB/Class/Host/HID.h
index c1a68f8..c0f67e7 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/HID.h
+++ b/LUFA/Drivers/USB/Class/Host/HID.h
@@ -34,6 +34,7 @@
  *  \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/Host/HID.c\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/Host/HID.c\r

+ *    - LUFA/Drivers/USB/Class/Host/HIDParser.c\r

  *\r
  *  \section Module Description\r
  *  Host Mode USB Class driver framework interface, for the HID USB Class driver.\r
  *\r
  *  \section Module Description\r
  *  Host Mode USB Class driver framework interface, for the HID USB Class driver.\r


@@ -57,7 +58,7 @@
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
                        /** Error code for some HID Host functions, indicating a logical (and not hardware) error */\r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
                        /** Error code for some HID Host functions, indicating a logical (and not hardware) error */\r

-                       #define MS_ERROR_UNSUPPORTED              0xC0\r
+                       #define HID_ERROR_LOGICAL              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


@@ -92,7 +93,7 @@
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the HID interface's OUT data pipe */\r
                                        \r
                                        bool SupportsBootSubClass; /**< Indicates if the current interface instance supports the HID Boot\r
                                        uint16_t DataOUTPipeSize;  /**< Size in bytes of the HID interface's OUT data pipe */\r
                                        \r
                                        bool SupportsBootSubClass; /**< Indicates if the current interface instance supports the HID Boot\r

-                                                                   *   Protocol when enabled via \ref USB_HID_Host_SetProtocol()\r
+                                                                   *   Protocol when enabled via \ref USB_HID_Host_SetBootProtocol()\r

                                                                    */\r
                                        uint16_t HIDReportSize; /**< Size in bytes of the HID report descriptor in the device */\r
                                } State; /**< State data for the USB class interface within the device. All elements in this section\r
                                                                    */\r
                                        uint16_t HIDReportSize; /**< Size in bytes of the HID report descriptor in the device */\r
                                } State; /**< State data for the USB class interface within the device. All elements in this section\r


@@ -102,6 +103,7 @@
                        } USB_ClassInfo_HID_Host_t;\r
 \r
                /* Enums: */\r
                        } USB_ClassInfo_HID_Host_t;\r
 \r
                /* Enums: */\r

+                       /** Enum for the possible error codes returned by the \ref HID_Host_ConfigurePipes() function. */\r

                        enum HIDHost_EnumerationFailure_ErrorCodes_t\r
                        {\r
                                HID_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */\r
                        enum HIDHost_EnumerationFailure_ErrorCodes_t\r
                        {\r
                                HID_ENUMERROR_NoError                    = 0, /**< Configuration Descriptor was processed successfully */\r


@@ -112,13 +114,64 @@
                        };\r
        \r
                /* Function Prototypes: */\r
                        };\r
        \r
                /* Function Prototypes: */\r

+                       /** General management task for a given Human Interface Class host class interface, required for the correct operation of\r
+                        *  the interface. This should be called frequently in the main program loop, before the master USB management task\r
+                        *  \ref USB_USBTask().\r
+                        *\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state\r
+                        */\r

                        void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
                        void HID_Host_USBTask(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

+\r
+                       /** Host interface configuration routine, to configure a given HID host interface instance using the Configuration\r
+                        *  Descriptor read from an attached USB device. This function automatically updates the given HID Host instance's\r
+                        *  state values and configures the pipes required to communicate with the interface if it is found within the\r
+                        *  device. This should be called once after the stack has enumerated the attached device, while the host state\r
+                        *  machine is in the Addressed state.\r
+                        *\r
+                        *  \note Once the device pipes are configured, the HID device's reporting protocol <b>must</b> be set via a call\r
+                        *        to either the \ref USB_HID_Host_SetBootProtocol() or \ref USB_HID_Host_SetReportProtocol() function.\r
+                        *\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state\r
+                        *  \param[in] ConfigDescriptorLength  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 HIDHost_EnumerationFailure_ErrorCodes_t enum\r
+                        */\r

                        uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint16_t ConfigDescriptorLength,\r
                                                        uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);\r
 \r
                        uint8_t HID_Host_ConfigurePipes(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, uint16_t ConfigDescriptorLength,\r
                                                        uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);\r
 \r

+                       /** Determines if a report has been received on the HID interface's IN report pipe, when the device is initialized\r
+                        *  into Report Protocol mode.\r
+                        *\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state\r
+                        *\r
+                        *  \return Boolean true if a report has been received, false otherwise\r
+                        */\r

                        bool    HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
                        \r
                        bool    HID_Host_IsReportReceived(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
                        \r

-                       uint8_t USB_HID_Host_SetProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, bool UseReportProtocol) ATTR_NON_NULL_PTR_ARG(1);\r
+                       /** Switches the attached HID device's reporting protocol over to the Boot Report protocol mode, on supported devices.\r
+                        *\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state\r
+                        *\r
+                        *  \return \ref HID_ERROR_LOGICAL if the device does not support Boot Protocol mode, a value from the\r
+                        *          \ref USB_Host_SendControlErrorCodes_t enum otherwise\r
+                        */\r
+                       uint8_t USB_HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
+\r
+                       /** Switches the attached HID device's reporting protocol over to the standard Report protocol mode. This also retrieves\r
+                        *  and parses the device's HID report descriptor, so that the size of each report can be determined in advance.\r
+                        *\r
+                        *  \note Whether this function is used or not, the \ref CALLBACK_HIDParser_FilterHIDReportItem() callback from the HID\r
+                        *        Report Parser this function references <b>must</b> be implemented in the user code.\r
+                        *\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state\r
+                        *\r
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum if an error occurs while retrieving the HID\r
+                        *          Report descriptor or the setting of the Report protocol, \ref HID_ERROR_LOGICAL if the HID interface does\r
+                        *          not have a valid \ref HID_ReportInfo_t structure set in its configuration, a mask of \ref HID_ERROR_LOGICAL\r
+                        *          and a value from the \ref HID_Parse_ErrorCodes_t otherwise\r
+                        */\r
+                       uint8_t USB_HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\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