X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/df29aa37c05ff0251bd17f54c750bac56d7279b7..1190652c0b210fe24320f8da9bfd5a0e169111d8:/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 942fe1177..8d3fbf212 100644
--- 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.
  *
  *  The processed HID report is presented back to the user application as a flat structure containing each report
- *  item's IN, OUT and FEATURE (if desired) items along with each item's attributes.
+ *  item's IN, OUT and FEATURE items along with each item's attributes.
  *
  *  This library portion also allows for easy setting and retrieval of data from a HID report, including devices
  *  with multiple reports on the one HID interface.
  *
- *  By default, FEATURE reports and IN/OUT reports with constant data are ignored in the HID report when processed
- *  to save on memory. This can be overridden by defining the HID_ENABLE_FEATURE_PROCESSING or
- *  HID_INCLUDE_CONSTANT_DATA_ITEMS tokens in the user project makefile, passing them to the compiler via the -D
- *  switch.
- *
  *  @{
  */
 
@@ -79,11 +74,11 @@
 		#if !defined(HID_STATETABLE_STACK_DEPTH) || defined(__DOXYGEN__)
 			/** Constant indicating the maximum stack depth of the state table. A larger state table
 			 *  allows for more PUSH/POP report items to be nested, but consumes more memory. By default
-			 *  this is set to 3 levels (allowing for two PUSHes to be nested) but this can be overridden by
+			 *  this is set to 2 levels (allowing non-nested PUSH items) but this can be overridden by
 			 *  defining HID_STATETABLE_STACK_DEPTH to another value in the user project makefile, passing the
 			 *  define to the compiler using the -D compiler switch.
 			 */
-			#define HID_STATETABLE_STACK_DEPTH    3
+			#define HID_STATETABLE_STACK_DEPTH    2
 		#endif
 		
 		#if !defined(HID_USAGE_STACK_DEPTH) || defined(__DOXYGEN__)
@@ -108,13 +103,13 @@
 		#endif
 		
 		#if !defined(HID_MAX_REPORTITEMS) || defined(__DOXYGEN__)
-			/** Constant indicating the maximum number of report items (IN, OUT or FEATURE if enabled) that can be
-			 *  processed in the report item descriptor. A large value allows for more report items to be
-			 *  processed, but consumes more memory. By default this is set to 30 items, but this can be
-			 *  overridden by defining HID_MAX_REPORTITEMS to another value in the user project makefile, passing
-			 *  the define to the compiler using the -D compiler switch.
+			/** Constant indicating the maximum number of report items (IN, OUT or FEATURE) that can be processed 
+			 *  in the report item descriptor and stored in the user HID Report Info structure. A large value allows
+			 *  for more report items to be stored, but consumes more memory. By default this is set to 20 items, 
+			 *  but this can be overridden by defining HID_MAX_REPORTITEMS to another value in the user project
+			 *  makefile, passing the define to the compiler using the -D compiler switch.
 			 */
-			#define HID_MAX_REPORTITEMS           30
+			#define HID_MAX_REPORTITEMS           20
 		#endif
 
 	/* Public Interface - May be used in end-application: */
@@ -134,7 +129,7 @@
 				HID_PARSE_HIDStackOverflow            = 1, /**< More than \ref HID_STATETABLE_STACK_DEPTH nested PUSHes in the report. */ 
 				HID_PARSE_HIDStackUnderflow           = 2, /**< A POP was found when the state table stack was empty. */
 				HID_PARSE_InsufficientReportItems     = 3, /**< More than \ref HID_MAX_REPORTITEMS report items in the report. */
-				HID_PARSE_UnexpectedEndCollection     = 4, /**< END COLLECTION found without matching COLLECTION item. */
+				HID_PARSE_UnexpectedEndCollection     = 4, /**< An END COLLECTION item found without matching COLLECTION item. */
 				HID_PARSE_InsufficientCollectionPaths = 5, /**< More than \ref HID_MAX_COLLECTIONS collections in the report. */
 				HID_PARSE_UsageStackOverflow          = 6, /**< More than \ref HID_USAGE_STACK_DEPTH usages listed in a row. */
 			};
@@ -250,6 +245,17 @@
 			 */
 			void USB_SetHIDReportItemInfo(uint8_t* ReportData, const HID_ReportItem_t* ReportItem)
 			                              ATTR_NON_NULL_PTR_ARG(1, 2);
+										  
+			/** Callback routine for the HID Report Parser. This callback <b>must</b> be implemented by the user code when
+			 *  the parser is used, to determine what report IN, OUT and FEATURE item's information is stored into the user
+			 *  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.
+			 *
+			 *  \param CurrentItemAttributes  Pointer to the current report item attributes for user checking
+			 *
+			 *  \return Boolean true if the item should be stored into the HID_ReportInfo_t structure, false if it should be ignored
+			 */
+			bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_Attributes_t* CurrentItemAttributes);
 
 	/* Private Interface - For use in library only: */
 	#if !defined(__DOXYGEN__)