USB_CONFIG_ATTR_BUSPOWERED constant renamed to USB_CONFIG_ATTR_RESERVED, as this...

[pub/USBasp.git] / LUFA / Drivers / USB / Class / Common / HIDParser.h

diff --git a/LUFA/Drivers/USB/Class/Common/HIDParser.h b/LUFA/Drivers/USB/Class/Common/HIDParser.h
index e0df87e..25e201b 100644 (file)
--- a/LUFA/Drivers/USB/Class/Common/HIDParser.h
+++ b/LUFA/Drivers/USB/Class/Common/HIDParser.h
@@ -70,8 +70,8 @@
                #include "../../../../Common/Common.h"
 
                #include "HIDReportData.h"
                #include "../../../../Common/Common.h"
 
                #include "HIDReportData.h"

-               #include "../Common/HID.h"
-               
+               #include "HIDClassCommon.h"
+

        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        extern "C" {
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
                        extern "C" {


@@ -284,8 +284,8 @@
                        /** Extracts the given report item's value out of the given HID report and places it into the Value
                         *  member of the report item's \ref HID_ReportItem_t structure.
                         *
                        /** Extracts the given report item's value out of the given HID report and places it into the Value
                         *  member of the report item's \ref HID_ReportItem_t structure.
                         *

-                        *  When called on a report with an item that exists in that report, this copies the report item's Value
-                        *  to it's PreviousValue element for easy checking to see if an item's value has changed before processing
+                        *  When called on a report with an item that exists in that report, this copies the report item's \c Value
+                        *  to its \c PreviousValue element for easy checking to see if an item's value has changed before processing

                         *  a report. If the given item does not exist in the report, the function does not modify the report item's
                         *  data.
                         *
                         *  a report. If the given item does not exist in the report, the function does not modify the report item's
                         *  data.
                         *


@@ -295,14 +295,14 @@
                         *  \returns Boolean \c true if the item to retrieve was located in the given report, \c false otherwise.
                         */
                        bool USB_GetHIDReportItemInfo(const uint8_t* ReportData,
                         *  \returns Boolean \c true if the item to retrieve was located in the given report, \c false otherwise.
                         */
                        bool USB_GetHIDReportItemInfo(const uint8_t* ReportData,

-                                                     HID_ReportItem_t* const ReportItem) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
+                                                     HID_ReportItem_t* const ReportItem) ATTR_NON_NULL_PTR_ARG(1);

 
 

-                       /** Retrieves the given report item's value out of the Value member of the report item's
+                       /** Retrieves the given report item's value out of the \c Value member of the report item's

                         *  \ref HID_ReportItem_t structure and places it into the correct position in the HID report
                         *  buffer. The report buffer is assumed to have the appropriate bits cleared before calling
                         *  this function (i.e., the buffer should be explicitly cleared before report values are added).
                         *
                         *  \ref HID_ReportItem_t structure and places it into the correct position in the HID report
                         *  buffer. The report buffer is assumed to have the appropriate bits cleared before calling
                         *  this function (i.e., the buffer should be explicitly cleared before report values are added).
                         *

-                        *  When called, this copies the report item's Value element to it's PreviousValue element for easy
+                        *  When called, this copies the report item's \c Value element to its \c PreviousValue element for easy

                         *  checking to see if an item's value has changed before sending a report.
                         *
                         *  If the device has multiple HID reports, the first byte in the report is set to the report ID of the given item.
                         *  checking to see if an item's value has changed before sending a report.
                         *
                         *  If the device has multiple HID reports, the first byte in the report is set to the report ID of the given item.


@@ -311,16 +311,16 @@
                         *  \param[in]  ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array.
                         */
                        void USB_SetHIDReportItemInfo(uint8_t* ReportData,
                         *  \param[in]  ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array.
                         */
                        void USB_SetHIDReportItemInfo(uint8_t* ReportData,

-                                                     HID_ReportItem_t* const ReportItem) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
+                                                     HID_ReportItem_t* const ReportItem) ATTR_NON_NULL_PTR_ARG(1);

 
 

-                       /** Retrieves the size of a given HID report in bytes from it's Report ID.
+                       /** Retrieves the size of a given HID report in bytes from its Report ID.

                         *
                         *  \param[in] ParserData  Pointer to a \ref HID_ReportInfo_t instance containing the parser output.
                         *
                         *  \param[in] ParserData  Pointer to a \ref HID_ReportInfo_t instance containing the parser output.

-                        *  \param[in] ReportID    Report ID of the report whose size is to be retrieved.
-                        *  \param[in] ReportType  Type of the report whose size is to be determined, a valued from the
+                        *  \param[in] ReportID    Report ID of the report whose size is to be determined.
+                        *  \param[in] ReportType  Type of the report whose size is to be determined, a value from the

                         *                         \ref HID_ReportItemTypes_t enum.
                         *
                         *                         \ref HID_ReportItemTypes_t enum.
                         *

-                        *  \return Size of the report in bytes, or 0 if the report does not exist.
+                        *  \return Size of the report in bytes, or \c 0 if the report does not exist.

                         */
                        uint16_t USB_GetHIDReportSize(HID_ReportInfo_t* const ParserData,
                                                      const uint8_t ReportID,
                         */
                        uint16_t USB_GetHIDReportSize(HID_ReportInfo_t* const ParserData,
                                                      const uint8_t ReportID,


@@ -331,6 +331,10 @@
                         *  \ref HID_ReportInfo_t structure. This can be used to filter only those items the application will be using, so that
                         *  no RAM is wasted storing the attributes for report items which will never be referenced by the application.
                         *
                         *  \ref HID_ReportInfo_t structure. This can be used to filter only those items the application will be using, so that
                         *  no RAM is wasted storing the attributes for report items which will never be referenced by the application.
                         *

+                        *  Report item pointers passed to this callback function may be cached by the user application for later use
+                        *  when processing report items. This provides faster report processing in the user application than would
+                        *  a search of the entire parsed report item table for each received or sent report.
+                        *

                         *  \param[in] CurrentItem  Pointer to the current report item for user checking.
                         *
                         *  \return Boolean \c true if the item should be stored into the \ref HID_ReportInfo_t structure, \c false if
                         *  \param[in] CurrentItem  Pointer to the current report item for user checking.
                         *
                         *  \return Boolean \c true if the item should be stored into the \ref HID_ReportInfo_t structure, \c false if