Finish initial draft of the Host Mode HID Class driver.

[pub/lufa.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 a8865a5..8f80ea8 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/HID.h
+++ b/LUFA/Drivers/USB/Class/Host/HID.h
@@ -146,20 +146,25 @@
                                                        uint8_t* DeviceConfigDescriptor) ATTR_NON_NULL_PTR_ARG(1, 3);\r
 \r
 \r
-                       /** Receives a HID IN report from the attached HID device, either the next report from the device's IN data pipe,\r
-                        *  or a given report (by Report ID) if a specific report is desired.\r
+                       /** Receives a HID IN report from the attached HID device, when a report has been received on the HID IN Data pipe.\r
                         *\r
                         *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state\r
-                        *  \param[in] ControlRequest  Set to true if the report should be requested by a control request, false otherwise\r
-                        *  \param[in,out] ReportID  Report ID of the received report if ControlRequest is false, set by the to the Report ID\r
-                        *                           to fetch if ControlRequest is true\r
                         *  \param[in] Buffer  Buffer to store the received report into\r
                         *\r
-                        *  \return An error code from the \ref USB_Host_SendControlErrorCodes_t enum if the ControlRequest flag is set,\r
-                        *          a value from the \ref Pipe_Stream_RW_ErrorCodes_t enum otherwise\r
+                        *  \return An error code from the \ref Pipe_Stream_RW_ErrorCodes_t enum\r
                         */\r
-                       uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const bool ControlRequest, uint8_t* ReportID,\r
-                                                      void* Buffer) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+                       uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, void* Buffer) ATTR_NON_NULL_PTR_ARG(1, 2);\r
+\r
+                       /** Received a HID IN report from the attached device, by the report ID.\r
+                        *\r
+                        *  \param[in,out] HIDInterfaceInfo  Pointer to a structure containing a HID Class host configuration and state\r
+                        *  \param[in] ReportID  Report ID of the received report if ControlRequest is false, set by the to the Report ID to fetch\r
+                        *  \param[in] Buffer  Buffer to store the received report into\r
+                        *\r
+                        *  \return A value from the \ref USB_Host_SendControlErrorCodes_t enum\r
+                        */\r
+                       uint8_t HID_Host_ReceiveReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const uint8_t ReportID,\r
+                                                          void* Buffer) ATTR_NON_NULL_PTR_ARG(1, 3);\r
 \r
                        /** Sends an OUT report to the currently attached HID device, using the device's OUT pipe if available or the device's\r
                         *  Control pipe if not.\r
@@ -172,8 +177,8 @@
                         *  \return An error code from the \ref USB_Host_SendControlErrorCodes_t enum if the DeviceUsesOUTPipe flag is set in\r
                         *          the interface's state structure, a value from the \ref Pipe_Stream_RW_ErrorCodes_t enum otherwise\r
                         */\r
-                       uint8_t HID_Host_SendReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const uint8_t ReportID,\r
-                                                   void* Buffer, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1, 3);\r
+                       uint8_t HID_Host_SendReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, const uint8_t ReportID,\r
+                                                       void* Buffer, const uint16_t ReportSize) ATTR_NON_NULL_PTR_ARG(1, 3);\r
 \r
                        /** Determines if a HID IN report has been received from the attached device on the data IN pipe.\r
                         *\r