Added new HID_HOST_BOOT_PROTOCOL_ONLY compile time token to reduce the size of the...

[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 95afbb4..5cac00e 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/HID.h
+++ b/LUFA/Drivers/USB/Class/Host/HID.h
@@ -77,8 +77,14 @@
                                                                                                        *   \ref HID_BOOT_KEYBOARD_PROTOCOL or \ref HID_NON_BOOT_PROTOCOL if any\r
                                                                                                        *   HID device should be enumerated by the interface\r
                                                                        */\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

+                                       #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r

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

-                                                                         *   is not used */\r
+                                                                         *   is not used\r
+                                                                                                         *\r
+                                                                         *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined,\r
+                                                                         *        this method is unavailable.\r
+                                                                         */\r
+                                       #endif\r

                                } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
                                           */\r
                                } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
                                           *   <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
                                           */\r


@@ -157,8 +163,11 @@
                         */\r
                        uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, void* Buffer) ATTR_NON_NULL_PTR_ARG(1, 2);\r
 \r
                         */\r
                        uint8_t HID_Host_ReceiveReport(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo, void* Buffer) ATTR_NON_NULL_PTR_ARG(1, 2);\r
 \r

+                       #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r

                        /** Received a HID IN report from the attached device, by the report ID.\r
                         *\r
                        /** Received a HID IN report from the attached device, by the report ID.\r
                         *\r

+                        *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.\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
                         *  \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


@@ -167,10 +176,14 @@
                         */\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
                        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
+                       #endif\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
                        /** 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

+                        *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, the ReportID parameter is removed\r
+                        *        from the parameter list of this function.\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,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


@@ -179,8 +192,16 @@
                         *  \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
                         *  \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_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
+                       uint8_t HID_Host_SendReportByID(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo,\r
+                       #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+                                                       const uint8_t ReportID,\r
+                       #endif\r
+                                                       void* Buffer, const uint16_t ReportSize)\r
+                       #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\r
+                                                       ATTR_NON_NULL_PTR_ARG(1, 3);\r
+                       #else\r
+                                                       ATTR_NON_NULL_PTR_ARG(1, 2);\r
+                       #endif\r

 \r
                        /** Determines if a HID IN report has been received from the attached device on the data IN pipe.\r
                         *\r
 \r
                        /** Determines if a HID IN report has been received from the attached device on the data IN pipe.\r
                         *\r


@@ -192,6 +213,9 @@
                        \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

+                        *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method must still be called\r
+                        *        to explicitly place the attached device into boot protocol mode before use.\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
                         *  \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


@@ -199,12 +223,15 @@
                         */\r
                        uint8_t HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
 \r
                         */\r
                        uint8_t HID_Host_SetBootProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
 \r

+                       #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY)\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
                        /** 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

+                        *  \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable.\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
                         *  \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


@@ -213,7 +240,8 @@
                         *          and a value from the \ref HID_Parse_ErrorCodes_t otherwise\r
                         */\r
                        uint8_t HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
                         *          and a value from the \ref HID_Parse_ErrorCodes_t otherwise\r
                         */\r
                        uint8_t HID_Host_SetReportProtocol(USB_ClassInfo_HID_Host_t* const HIDInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r

-               \r
+                       #endif\r
+                       \r

        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r
        /* Private Interface - For use in library only: */\r
        #if !defined(__DOXYGEN__)\r
                /* Macros: */\r