+/*\r
+ LUFA Library\r
+ Copyright (C) Dean Camera, 2009.\r
+ \r
+ dean [at] fourwalledcubicle [dot] com\r
+ www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+ Copyright 2009 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+ Permission to use, copy, modify, and distribute this software\r
+ and its documentation for any purpose and without fee is hereby\r
+ granted, provided that the above copyright notice appear in all\r
+ copies and that both that the copyright notice and this\r
+ permission notice and warranty disclaimer appear in supporting\r
+ documentation, and that the name of the author not be used in\r
+ advertising or publicity pertaining to distribution of the\r
+ software without specific, written prior permission.\r
+\r
+ The author disclaim all warranties with regard to this\r
+ software, including all implied warranties of merchantability\r
+ and fitness. In no event shall the author be liable for any\r
+ special, indirect or consequential damages or any damages\r
+ whatsoever resulting from loss of use, data or profits, whether\r
+ in an action of contract, negligence or other tortious action,\r
+ arising out of or in connection with the use or performance of\r
+ this software.\r
+*/\r
+\r
+/** \file\r
+ *\r
+ * USB Human Interface Device (HID) Class report descriptor processing routines. This file allows for the easy\r
+ * parsing of the complex HID report descriptor, which describes the data that the device transmits to the host.\r
+ *\r
+ * The processed 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
+ *\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
+#ifndef __HIDPARSER_H__\r
+#define __HIDPARSER_H__\r
+\r
+ /* Includes: */\r
+ #include <string.h>\r
+ #include <stdbool.h>\r
+\r
+ #include "HIDReportData.h"\r
+\r
+ #include "../../../Common/Common.h"\r
+\r
+ /* Enable C linkage for C++ Compilers: */\r
+ #if defined(__cplusplus)\r
+ extern "C" {\r
+ #endif\r
+\r
+ /* Preprocessor checks and defines: */\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
+ * 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
+ #endif\r
+ \r
+ #if !defined(HID_USAGE_STACK_DEPTH) || defined(__DOXYGEN__)\r
+ /** Constant indicating the maximum stack depth of the usage table. A larger usage table\r
+ * allows for more USAGE items to be indicated sequentially for REPORT COUNT entries of more than\r
+ * one, but requires more stack space. By default this is set to 8 levels (allowing for a report\r
+ * item with a count of 8) but this can be overridden by defining HID_USAGE_STACK_DEPTH to another\r
+ * value in the user project makefile, passing the define to the compiler using the -D compiler\r
+ * switch.\r
+ */\r
+ #define HID_USAGE_STACK_DEPTH 8\r
+ #endif\r
+\r
+ #if !defined(HID_MAX_COLLECTIONS) || defined(__DOXYGEN__)\r
+ /** Constant indicating the maximum number of COLLECTION items (nested or unnested) that can be\r
+ * processed in the report item descriptor. A large value allows for more COLLECTION items to be\r
+ * processed, but consumes more memory. By default this is set to 5 collections, but this can be\r
+ * overridden by defining HID_MAX_COLLECTIONS to another value in the user project makefile, passing\r
+ * the define to the compiler using the -D compiler switch.\r
+ */\r
+ #define HID_MAX_COLLECTIONS 5\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
+ */\r
+ #define HID_MAX_REPORTITEMS 30\r
+ #endif\r
+\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Enums: */\r
+ /** Enum for indicating what type of report item an entry in a HID_ReportInfo_t ReportItem array is */\r
+ enum HID_ReportItemTypes_t\r
+ {\r
+ REPORT_ITEM_TYPE_In = 0, /**< Indicates that the item is an IN report type. */\r
+ REPORT_ITEM_TYPE_Out = 1, /**< Indicates that the item is an OUT report type. */\r
+ REPORT_ITEM_TYPE_Feature = 2, /**< Indicates that the item is a FEATURE report type. */\r
+ };\r
+ \r
+ /** Enum for the possible error codes in the return value of the ProcessHIDReport() function */\r
+ enum HID_Parse_ErrorCodes_t\r
+ {\r
+ HID_PARSE_Successful = 0, /**< Successful parse of the HID report descriptor, no error. */\r
+ HID_PARSE_HIDStackOverflow = 1, /**< More than 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 HID_MAX_REPORTITEMS report items in the report. */\r
+ HID_PARSE_UnexpectedEndCollection = 4, /**< END COLLECTION found without matching COLLECTION item. */\r
+ HID_PARSE_InsufficientCollectionPaths = 5, /**< More than HID_MAX_COLLECTIONS collections in the report. */\r
+ HID_PARSE_UsageStackOverflow = 6, /**< More than HID_USAGE_STACK_DEPTH usages listed in a row. */\r
+ };\r
+ \r
+ /* Type Defines: */ \r
+ /** Type define for an attribute with both minimum and maximum values (e.g. Logical Min/Max). */\r
+ typedef struct\r
+ {\r
+ uint32_t Minimum; /**< Minimum value for the attribute. */\r
+ uint32_t Maximum; /**< Maximum value for the attribute. */\r
+ } HID_MinMax_t;\r
+\r
+ /** Type define for the Unit attributes of a report item. */\r
+ typedef struct\r
+ {\r
+ uint32_t Type; /**< Unit type (refer to HID specifications for details). */\r
+ uint8_t Exponent; /**< Unit exponent (refer to HID specifications for details). */\r
+ } HID_Unit_t;\r
+ \r
+ /** Type define for the Usage attributes of a report item. */\r
+ typedef struct\r
+ {\r
+ uint16_t Page; /**< Usage page of the report item. */\r
+ uint16_t Usage; /**< Usage of the report item. */\r
+ HID_MinMax_t MinMax; /**< Usage minimum and maximum of the report item. */\r
+ } HID_Usage_t;\r
+\r
+ /** Type define for a COLLECTION object. Contains the collection attributes and a reference to the\r
+ * parent collection if any.\r
+ */\r
+ typedef struct CollectionPath\r
+ {\r
+ uint8_t Type; /**< Collection type (for example "Generic Desktop"). */\r
+ HID_Usage_t Usage; /**< Collection usage. */\r
+ struct CollectionPath* Parent; /**< Reference to parent collection, or NULL if root collection. */\r
+ } HID_CollectionPath_t;\r
+\r
+ /** Type define for all the data attributes of a report item, except flags. */\r
+ typedef struct\r
+ {\r
+ uint8_t BitSize; /**< Size in bits of the report item's data. */\r
+ \r
+ HID_Usage_t Usage; /**< Usage of the report item. */\r
+ HID_Unit_t Unit; /**< Unit type and exponent of the report item. */\r
+ HID_MinMax_t Logical; /**< Logical minimum and maximum of the report item. */\r
+ HID_MinMax_t Physical; /**< Physical minimum and maximum of the report item. */\r
+ } HID_ReportItem_Attributes_t;\r
+ \r
+ /** Type define for a report item (IN, OUT or FEATURE) attributes and other details. */\r
+ typedef struct\r
+ {\r
+ uint16_t BitOffset; /**< Bit offset in the IN, OUT or FEATURE report of the item. */\r
+ uint8_t ItemType; /**< Report item type, a value in HID_Types_t. */\r
+ uint16_t ItemFlags; /**< Item data flags, such as constant/variable, etc. */\r
+ uint8_t ReportID; /**< Report ID this item belongs to, or 0x00 if device has only one report */\r
+ HID_CollectionPath_t* CollectionPath; /**< Collection path of the item. */\r
+\r
+ HID_ReportItem_Attributes_t Attributes; /**< Report item attributes. */\r
+ \r
+ uint32_t Value; /**< Current value of the report item. */\r
+ } HID_ReportItem_t;\r
+\r
+ /** Type define for a complete processed HID report, including all report item data and collections. */\r
+ typedef struct\r
+ {\r
+ uint8_t TotalReportItems; /**< Total number of report items stored in the\r
+ * ReportItems array. */\r
+\r
+ HID_ReportItem_t ReportItems[HID_MAX_REPORTITEMS]; /**< Report items array, including\r
+ * all IN, OUT and FEATURE items. */\r
+\r
+ HID_CollectionPath_t CollectionPaths[HID_MAX_COLLECTIONS]; /**< All collection items, referenced\r
+ * by the report items. */\r
+ } HID_ReportInfo_t;\r
+ \r
+ /* Function Prototypes: */\r
+ /** Function to process a given HID report returned from an attached device, and store it into a given\r
+ * HID_ReportInfo_t structure.\r
+ *\r
+ * \param ReportData Buffer containing the device's HID report table\r
+ * \param ReportSize Size in bytes of the HID report table\r
+ * \param ParserData Pointer to a HID_ReportInfo_t instance for the parser output\r
+ *\r
+ * \return A value in the HID_Parse_ErrorCodes_t enum\r
+ */\r
+ uint8_t ProcessHIDReport(const uint8_t* ReportData, uint16_t ReportSize, HID_ReportInfo_t* const ParserData)\r
+ ATTR_NON_NULL_PTR_ARG(1, 3);\r
+\r
+ /** Extracts the given report item's value out of the given HID report and places it into the Value\r
+ * member of the report item's HID_ReportItem_t structure.\r
+ *\r
+ * \param ReportData Buffer containing an IN or FEATURE report from an attached device\r
+ * \param ReportItem Pointer to the report item of interest in a HID_ReportInfo_t ReportItem array\r
+ *\r
+ * \returns Boolean true if the item to retrieve was located in the given report, false otherwise\r
+ */\r
+ bool GetReportItemInfo(const uint8_t* ReportData, HID_ReportItem_t* const ReportItem)\r
+ ATTR_NON_NULL_PTR_ARG(1, 2);\r
+\r
+ /** Retreives the given report item's value out of the Value member of the report item's\r
+ * HID_ReportItem_t structure and places it into the correct position in the HID report\r
+ * buffer. The report buffer is assumed to have the appropriate bits cleared before calling\r
+ * this function (i.e., the buffer should be explicitly cleared before report values are added).\r
+ *\r
+ * If the device has multiple HID reports, the report ID is set to the report ID of the given item.\r
+ *\r
+ * \param ReportData Buffer holding the current OUT report data\r
+ * \param ReportItem Pointer to the report item of interest in a HID_ReportInfo_t ReportItem array\r
+ */\r
+ void SetReportItemInfo(uint8_t* ReportData, const HID_ReportItem_t* ReportItem)\r
+ ATTR_NON_NULL_PTR_ARG(1, 2);\r
+\r
+ /* Private Interface - For use in library only: */\r
+ #if !defined(__DOXYGEN__)\r
+ /* Type Defines: */\r
+ typedef struct\r
+ {\r
+ HID_ReportItem_Attributes_t Attributes;\r
+ uint8_t ReportCount;\r
+ uint8_t ReportID;\r
+ } HID_StateTable_t;\r
+ #endif\r
+ \r
+ /* Disable C linkage for C++ Compilers: */\r
+ #if defined(__cplusplus)\r
+ }\r
+ #endif\r
+\r
+#endif\r
projects / pub / lufa.git / blobdiff