Add user-filtering to the HID report parser, so that the user code can decide which...

[pub/lufa.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..8d3fbf2 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
- *  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
- *  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
@@ -108,13 +103,13 @@
                #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, passing the define to the compiler using the -D compiler switch.\r
                         */\r
-                       #define HID_MAX_REPORTITEMS           30\r
+                       #define HID_MAX_REPORTITEMS           20\r
                #endif\r
 \r
        /* Public Interface - May be used in end-application: */\r
@@ -250,6 +245,17 @@
                         */\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