Added new Pipe_IsFrozen() macro to determine if the currently selected pipe is frozen.

[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 95c1334..230930a 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/HID.h
+++ b/LUFA/Drivers/USB/Class/Host/HID.h
@@ -73,8 +73,9 @@
                                        uint8_t  DataOUTPipeNumber; /**< Pipe number of the HID interface's OUT data pipe */\r
 \r
                                        uint8_t  HIDInterfaceProtocol; /**< HID interface protocol value to match against if a specific\r
                                        uint8_t  DataOUTPipeNumber; /**< Pipe number of the HID interface's OUT data pipe */\r
 \r
                                        uint8_t  HIDInterfaceProtocol; /**< HID interface protocol value to match against if a specific\r

-                                                                       *   boot subclass protocol is required (e.g. keyboard, mouse), or\r
-                                                                       *   leave as 0 to match against the first HID interface found\r
+                                                                       *   boot subclass protocol is required, either \ref HID_BOOT_MOUSE_PROTOCOL,\r
+                                                                                                       *   \ref HID_BOOT_KEYBOARD_PROTOCOL or \ref HID_NON_BOOT_PROTOCOL if any\r
+                                                                                                       *   HID device should be enumerated by the interface\r

                                                                        */\r
                                        HID_ReportInfo_t* HIDParserData; /**< HID parser data to store the parsed HID report data, when boot protocol\r
                                                                          *   is not used */\r
                                                                        */\r
                                        HID_ReportInfo_t* HIDParserData; /**< HID parser data to store the parsed HID report data, when boot protocol\r
                                                                          *   is not used */\r


@@ -95,6 +96,9 @@
                                        bool SupportsBootProtocol; /**< Indicates if the current interface instance supports the HID Boot\r
                                                                    *   Protocol when enabled via \ref USB_HID_Host_SetBootProtocol()\r
                                                                    */\r
                                        bool SupportsBootProtocol; /**< Indicates if the current interface instance supports the HID Boot\r
                                                                    *   Protocol when enabled via \ref USB_HID_Host_SetBootProtocol()\r
                                                                    */\r

+                                       bool DeviceUsesOUTPipe; /**< Indicates if the current interface instance uses a seperate OUT data pipe for\r
+                                                                *   OUT reports, or if OUT reports are sent via the control pipe instead.\r
+                                                                */\r

                                        bool UsingBootProtocol; /**< Indicates that the interface is currently initialised in Boot Protocol mode */\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
                                        bool UsingBootProtocol; /**< Indicates that the interface is currently initialised in Boot Protocol mode */\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


@@ -141,14 +145,43 @@
                        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
+                       /** 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
+                        *\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
+                        */\r
+                       uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* HIDInterfaceInfo, bool ControlRequest, 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
+                        *\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 report to send to the device, or 0 if the device does not use report IDs\r
+                        *  \param[in] Buffer  Buffer containing the report to send to the attached device\r
+                        *  \param[in] ReportSize  Report size in bytes to send to the attached device\r
+                        *\r
+                        *  \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* HIDInterfaceInfo, uint8_t ReportID,\r
+                                                   void* Buffer, 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
                         *  \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
                         *\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
+                       bool HID_Host_IsReportReceived(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 Boot Report protocol mode, on supported devices.\r
                         *\r
                        \r
                        /** Switches the attached HID device's reporting protocol over to the Boot Report protocol mode, on supported devices.\r
                         *\r