Added multiple Report ID support to the HID class driver. Removed OUT endpoint suppor...

[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 9a56304..4fd6f2c 100644 (file)
--- a/LUFA/Drivers/USB/Class/Device/HID.h
+++ b/LUFA/Drivers/USB/Class/Device/HID.h
@@ -111,9 +111,6 @@
 \r
                        uint8_t  ReportINEndpointNumber; /**< Endpoint number of the HID interface's IN report endpoint */\r
                        uint16_t ReportINEndpointSize; /**< Size in bytes of the HID interface's IN report endpoint */\r
-\r
-                       uint8_t  ReportOUTEndpointNumber; /**< Endpoint number of the HID interface's OUT report endpoint, if used */\r
-                       uint16_t ReportOUTEndpointSize;  /**< Size in bytes of the HID interface's OUT report endpoint, if used */\r
                        \r
                        uint8_t  ReportINBufferSize;\r
 \r
@@ -127,8 +124,30 @@
                void USB_HID_ProcessControlPacket(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
                void USB_HID_USBTask(USB_ClassInfo_HID_t* HIDInterfaceInfo);\r
                \r
-               uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData);\r
-               void     CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, void* ReportData, uint16_t ReportSize);\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 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 HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
+                *  \param 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
+                *                   given HID interface, this parameter should be ignored.\r
+                *  \param ReportData  Pointer to a buffer where the generated HID report should be stored.\r
+                *\r
+                *  \return  Number of bytes in the generated input report, or zero if no report is to be sent\r
+                */\r
+               uint16_t CALLBACK_USB_HID_CreateNextHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t* ReportID, void* ReportData);\r
+\r
+               /** HID class driver callback for the user processing of a received HID input 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
+                *  \param HIDInterfaceInfo  Pointer to a structure containing a HID Class configuration and state.\r
+                *  \param ReportID  Report ID of the received output report. If multiple reports are not received via the given HID\r
+                *                   interface, this parameter should be ignored.\r
+                *  \param ReportData  Pointer to a buffer where the received HID report is stored.\r
+                */\r
+               void     CALLBACK_USB_HID_ProcessReceivedHIDReport(USB_ClassInfo_HID_t* HIDInterfaceInfo, uint8_t ReportID, void* ReportData, uint16_t ReportSize);\r
 \r
        /* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r