* 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
#if !defined(HID_STATETABLE_STACK_DEPTH) || defined(__DOXYGEN__)\r
/** Constant indicating the maximum stack depth of the state table. A larger state table\r
* allows for more PUSH/POP report items to be nested, but consumes more memory. By default\r
- * this is set to 3 levels (allowing for two PUSHes to be nested) but this can be overridden by\r
+ * this is set to 2 levels (allowing non-nested PUSH items) but this can be overridden by\r
* defining HID_STATETABLE_STACK_DEPTH to another value in the user project makefile, passing the\r
* define to the compiler using the -D compiler switch.\r
*/\r
- #define HID_STATETABLE_STACK_DEPTH 3\r
+ #define HID_STATETABLE_STACK_DEPTH 2\r
#endif\r
\r
#if !defined(HID_USAGE_STACK_DEPTH) || 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, 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
HID_PARSE_HIDStackOverflow = 1, /**< More than \ref HID_STATETABLE_STACK_DEPTH nested PUSHes in the report. */ \r
HID_PARSE_HIDStackUnderflow = 2, /**< A POP was found when the state table stack was empty. */\r
HID_PARSE_InsufficientReportItems = 3, /**< More than \ref HID_MAX_REPORTITEMS report items in the report. */\r
- HID_PARSE_UnexpectedEndCollection = 4, /**< END COLLECTION found without matching COLLECTION item. */\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
};\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
projects / pub / USBasp.git / blobdiff