Fixed PrinterHost demo returning invalid Device ID data when the attached device...

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

diff --git a/LUFA/Drivers/USB/Class/Device/HID.h b/LUFA/Drivers/USB/Class/Device/HID.h
index e3f091b..a3e3b85 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -60,6 +60,10 @@
                        /** Class state structure. An instance of this structure should be made for each HID interface\r
                         *  within the user application, and passed to each of the HID class driver functions as the\r
                         *  HIDInterfaceInfo parameter. This stores each HID interface's configuration and state information.\r
+                        *\r
+                        *  \note Due to technical limitations, the HID device class driver does not utilize a seperate OUT\r
+                        *        endpoint for host->device communications. Instead, the host->device data (if any) is sent to\r
+                        *        the device via the control endpoint.\r
                         */\r
                        typedef struct\r
                        {\r
@@ -127,13 +131,13 @@
                         */\r
                        void HID_Device_MillisecondElapsed(USB_ClassInfo_HID_Device_t* HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
                        \r
-                       /** HID class driver callback for the user creation of a HID input report. This callback may fire in response to either\r
+                       /** HID class driver callback for the user creation of a HID IN report. This callback may fire in response to either\r
                         *  HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback the\r
                         *  user is responsible for the creation of the next HID input report to be sent to the host.\r
                         *\r
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
                         *  \param[in,out] ReportID  If preset to a non-zero value, this is the report ID being requested by the host. If zero, this should\r
-                        *                 be set to the report ID of the generated HID input report. If multiple reports are not sent via the\r
+                        *                 be set to the report ID of the generated HID input report (if any). If multiple reports are not sent via the\r
                         *                 given HID interface, this parameter should be ignored.\r
                         *  \param[out] ReportData  Pointer to a buffer where the generated HID report should be stored.\r
                         *  \param[out] ReportSize  Number of bytes in the generated input report, or zero if no report is to be sent\r
@@ -144,7 +148,7 @@
                        bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo, uint8_t* const ReportID,\r
                                                      void* ReportData, uint16_t* ReportSize) ATTR_NON_NULL_PTR_ARG(1, 2, 3, 4);\r
                        \r
-                       /** HID class driver callback for the user processing of a received HID input report. This callback may fire in response to\r
+                       /** HID class driver callback for the user processing of a received HID OUT report. This callback may fire in response to\r
                         *  either HID class control requests from the host, or by the normal HID endpoint polling procedure. Inside this callback\r
                         *  the user is responsible for the processing of the received HID output report from the host.\r
                         *\r