Fix LUFA event list generation rule in the main LUFA makefile (thanks to Thomas Bleeker).

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

diff --git a/LUFA/Drivers/USB/Class/Host/HIDParser.h b/LUFA/Drivers/USB/Class/Host/HIDParser.h
index ec7ff53..d9adae3 100644 (file)
--- a/LUFA/Drivers/USB/Class/Host/HIDParser.h
+++ b/LUFA/Drivers/USB/Class/Host/HIDParser.h
@@ -46,16 +46,11 @@
  *  Functions, macros, variables, enums and types related to the parsing of HID class device report descriptors.\r
  *\r
  *  The processed HID report is presented back to the user application as a flat structure containing each report\r
  *  Functions, macros, variables, enums and types related to the parsing of HID class device report descriptors.\r
  *\r
  *  The processed HID report is presented back to the user application as a flat structure containing each report\r

- *  item's IN, OUT and FEATURE (if desired) items along with each item's attributes.\r
+ *  item's IN, OUT and FEATURE items along with each item's attributes.\r

  *\r
  *  This library portion also allows for easy setting and retrieval of data from a HID report, including devices\r
  *  with multiple reports on the one HID interface.\r
  *\r
  *\r
  *  This library portion also allows for easy setting and retrieval of data from a HID report, including devices\r
  *  with multiple reports on the one HID interface.\r
  *\r

- *  By default, FEATURE reports and IN/OUT reports with constant data are ignored in the HID report when processed\r
- *  to save on memory. This can be overridden by defining the HID_ENABLE_FEATURE_PROCESSING or\r
- *  HID_INCLUDE_CONSTANT_DATA_ITEMS tokens in the user project makefile, passing them to the compiler via the -D\r
- *  switch.\r
- *\r

  *  @{\r
  */\r
 \r
  *  @{\r
  */\r
 \r


@@ -108,13 +103,24 @@
                #endif\r
                \r
                #if !defined(HID_MAX_REPORTITEMS) || defined(__DOXYGEN__)\r
                #endif\r
                \r
                #if !defined(HID_MAX_REPORTITEMS) || defined(__DOXYGEN__)\r

-                       /** Constant indicating the maximum number of report items (IN, OUT or FEATURE if enabled) that can be\r
-                        *  processed in the report item descriptor. A large value allows for more report items to be\r
-                        *  processed, but consumes more memory. By default this is set to 30 items, but this can be\r
-                        *  overridden by defining HID_MAX_REPORTITEMS to another value in the user project makefile, passing\r
-                        *  the define to the compiler using the -D compiler switch.\r
+                       /** Constant indicating the maximum number of report items (IN, OUT or FEATURE) that can be processed \r
+                        *  in the report item descriptor and stored in the user HID Report Info structure. A large value allows\r
+                        *  for more report items to be stored, but consumes more memory. By default this is set to 20 items, \r
+                        *  but this can be overridden by defining HID_MAX_REPORTITEMS to another value in the user project\r
+                        *  makefile, and passing the define to the compiler using the -D compiler switch.\r
+                        */\r
+                       #define HID_MAX_REPORTITEMS           20\r
+               #endif\r
+               \r
+               #if !defined(HID_MAX_REPORT_IDS) || defined(__DOXYGEN__)\r
+                       /** Constant indicating the maximum number of unique report IDs that can be processed in the report item\r
+                        *  descriptor for the report size information array in the user HID Report Info structure. A large value\r
+                        *  allows for more report ID report sizes to be stored, but consumes more memory. By default this is set\r
+                        *  to 5 items, but this can be overridden by defining HID_MAX_REPORT_IDS to another value in the user project\r
+                        *  makefile, and passing the define to the compiler using the -D compiler switch. Note that IN, OUT and FEATURE\r
+                        *  items sharing the same report ID consume only one size item in the array.\r

                         */\r
                         */\r

-                       #define HID_MAX_REPORTITEMS           30\r
+                       #define HID_MAX_REPORT_IDS  5\r

                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r
                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r


@@ -137,6 +143,7 @@
                                HID_PARSE_UnexpectedEndCollection     = 4, /**< An END COLLECTION item found without matching COLLECTION item. */\r
                                HID_PARSE_InsufficientCollectionPaths = 5, /**< More than \ref HID_MAX_COLLECTIONS collections in the report. */\r
                                HID_PARSE_UsageStackOverflow          = 6, /**< More than \ref HID_USAGE_STACK_DEPTH usages listed in a row. */\r
                                HID_PARSE_UnexpectedEndCollection     = 4, /**< An END COLLECTION item found without matching COLLECTION item. */\r
                                HID_PARSE_InsufficientCollectionPaths = 5, /**< More than \ref HID_MAX_COLLECTIONS collections in the report. */\r
                                HID_PARSE_UsageStackOverflow          = 6, /**< More than \ref HID_USAGE_STACK_DEPTH usages listed in a row. */\r

+                               HID_PARSE_InsufficientReportIDItems   = 7, /**< More than \ref HID_MAX_REPORT_IDS report IDs in the device. */\r

                        };\r
                \r
                /* Type Defines: */             \r
                        };\r
                \r
                /* Type Defines: */             \r


@@ -196,6 +203,15 @@
                                                        \r
                                uint32_t                     Value;          /**< Current value of the report item. */\r
                        } HID_ReportItem_t;\r
                                                        \r
                                uint32_t                     Value;          /**< Current value of the report item. */\r
                        } HID_ReportItem_t;\r

+                       \r
+                       /** Type define for a report item size information structure */\r
+                       typedef struct\r
+                       {\r
+                               uint8_t                      ReportID; /** Report ID of the report within the HID interface */\r
+                               uint8_t                      BitsIn; /** Total number of IN data bits in the current report ID */\r
+                               uint8_t                      BitsOut; /** Total number of OUT data bits in the current report ID */\r
+                               uint8_t                      BitsFeature; /** Total number of FEATURE data bits in the current report ID */\r
+                       } HID_ReportSizeInfo_t;\r

 \r
                        /** Type define for a complete processed HID report, including all report item data and collections. */\r
                        typedef struct\r
 \r
                        /** Type define for a complete processed HID report, including all report item data and collections. */\r
                        typedef struct\r


@@ -209,9 +225,11 @@
                                HID_CollectionPath_t         CollectionPaths[HID_MAX_COLLECTIONS]; /**< All collection items, referenced\r
                                                                                                    *   by the report items.\r
                                                                                                    */\r
                                HID_CollectionPath_t         CollectionPaths[HID_MAX_COLLECTIONS]; /**< All collection items, referenced\r
                                                                                                    *   by the report items.\r
                                                                                                    */\r

-                               bool                         UsingMultipleReports; /**< Indicates if the device has at least one REPORT ID\r
-                                                                                   *   element in its HID report descriptor.\r
-                                                                                   */\r
+                               uint8_t                      TotalDeviceReports; /** Number of reports within the HID interface */\r
+                               HID_ReportSizeInfo_t         ReportIDSizes[HID_MAX_REPORT_IDS]; /** Report sizes for each report in the interface */\r
+                               bool                         UsingReportIDs; /**< Indicates if the device has at least one REPORT ID\r
+                                                                             *   element in its HID report descriptor.\r
+                                                                             */\r

                        } HID_ReportInfo_t;\r
                        \r
                /* Function Prototypes: */\r
                        } HID_ReportInfo_t;\r
                        \r
                /* Function Prototypes: */\r


@@ -250,6 +268,17 @@
                         */\r
                        void USB_SetHIDReportItemInfo(uint8_t* ReportData, const HID_ReportItem_t* ReportItem)\r
                                                      ATTR_NON_NULL_PTR_ARG(1, 2);\r
                         */\r
                        void USB_SetHIDReportItemInfo(uint8_t* ReportData, const HID_ReportItem_t* ReportItem)\r
                                                      ATTR_NON_NULL_PTR_ARG(1, 2);\r

+                                                                                 \r
+                       /** Callback routine for the HID Report Parser. This callback <b>must</b> be implemented by the user code when\r
+                        *  the parser is used, to determine what report IN, OUT and FEATURE item's information is stored into the user\r
+                        *  HID_ReportInfo_t structure. This can be used to filter only those items the application will be using, so that\r
+                        *  no RAM is wasted storing the attributes for report items which will never be referenced by the application.\r
+                        *\r
+                        *  \param CurrentItemAttributes  Pointer to the current report item attributes for user checking\r
+                        *\r
+                        *  \return Boolean true if the item should be stored into the HID_ReportInfo_t structure, false if it should be ignored\r
+                        */\r
+                       bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_Attributes_t* CurrentItemAttributes);\r

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