+++ /dev/null
-/*\r
- LUFA Library\r
- Copyright (C) Dean Camera, 2012.\r
-\r
- dean [at] fourwalledcubicle [dot] com\r
- www.lufa-lib.org\r
-*/\r
-\r
-/*\r
- Copyright 2012 Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
- Permission to use, copy, modify, distribute, and sell this\r
- software and its documentation for any purpose is hereby granted\r
- without fee, provided that the above copyright notice appear in\r
- all 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
- * \brief USB Human Interface Device (HID) Class report descriptor parser.\r
- *\r
- * This file allows for the easy parsing of complex HID report descriptors, which describes the data that\r
- * a HID device transmits to the host. It also provides an easy API for extracting and processing the data\r
- * elements inside a HID report sent from an attached HID device.\r
- */\r
-\r
-/** \ingroup Group_USB\r
- * \defgroup Group_HIDParser HID Report Parser\r
- * \brief USB Human Interface Device (HID) Class report descriptor parser.\r
- *\r
- * \section Sec_Dependencies Module Source Dependencies\r
- * The following files must be built with any user project that uses this module:\r
- * - LUFA/Drivers/USB/Class/Host/HIDParser.c <i>(Makefile source module name: LUFA_SRC_USB)</i>\r
- *\r
- * \section Sec_ModDescription Module Description\r
- * Human Interface Device (HID) class report descriptor parser. This module implements a parser than is\r
- * capable of processing a complete HID report descriptor, and outputting a flat structure containing the\r
- * contents of the report in an a more friendly format. The parsed data may then be further processed and used\r
- * within an application to process sent and received HID reports to and from an attached HID device.\r
- *\r
- * A HID report descriptor consists of a set of HID report items, which describe the function and layout\r
- * of data exchanged between a HID device and a host, including both the physical encoding of each item\r
- * (such as a button, key press or joystick axis) in the sent and received data packets - known as "reports" -\r
- * as well as other information about each item such as the usages, data range, physical location and other\r
- * characteristics. In this way a HID device can retain a high degree of flexibility in its capabilities, as it\r
- * is not forced to comply with a given report layout or feature-set.\r
- *\r
- * This module also contains routines for the processing of data in an actual HID report, using the parsed report\r
- * descriptor data as a guide for the encoding.\r
- *\r
- * @{\r
- */\r
-\r
-#ifndef __HIDPARSER_H__\r
-#define __HIDPARSER_H__\r
-\r
- /* Includes: */\r
- #include "../../../../Common/Common.h"\r
-\r
- #include "HIDReportData.h"\r
- #include "HIDClassCommon.h"\r
-\r
- /* Enable C linkage for C++ Compilers: */\r
- #if defined(__cplusplus)\r
- extern "C" {\r
- #endif\r
-\r
- /* Macros: */\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 2 levels (allowing non-nested PUSH items) but this can be overridden by\r
- * defining \c 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 2\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 \c 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 10 collections, but this can be\r
- * overridden by defining \c 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 10\r
- #endif\r
-\r
- #if !defined(HID_MAX_REPORTITEMS) || defined(__DOXYGEN__)\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 \c 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 10 items, but this can be overridden by defining \c 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
- #define HID_MAX_REPORT_IDS 10\r
- #endif\r
-\r
- /** Returns the value a given HID report item (once its value has been fetched via \ref USB_GetHIDReportItemInfo())\r
- * left-aligned to the given data type. This allows for signed data to be interpreted correctly, by shifting the data\r
- * leftwards until the data's sign bit is in the correct position.\r
- *\r
- * \param[in] ReportItem HID Report Item whose retrieved value is to be aligned.\r
- * \param[in] Type Data type to align the HID report item's value to.\r
- *\r
- * \return Left-aligned data of the given report item's pre-retrieved value for the given datatype.\r
- */\r
- #define HID_ALIGN_DATA(ReportItem, Type) ((Type)(ReportItem->Value << ((8 * sizeof(Type)) - ReportItem->Attributes.BitSize)))\r
-\r
- /* Public Interface - May be used in end-application: */\r
- /* Enums: */\r
- /** Enum for the possible error codes in the return value of the \ref USB_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 \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, /**< 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_UsageListOverflow = 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
- HID_PARSE_NoUnfilteredReportItems = 8, /**< All report items from the device were filtered by the filtering callback routine. */\r
- };\r
-\r
- /* Type Defines: */\r
- /** \brief HID Parser Report Item Min/Max Structure.\r
- *\r
- * Type define for an attribute with both minimum and maximum values (e.g. Logical Min/Max).\r
- */\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
- /** \brief HID Parser Report Item Unit Structure.\r
- *\r
- * Type define for the Unit attributes of a report item.\r
- */\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
- /** \brief HID Parser Report Item Usage Structure.\r
- *\r
- * Type define for the Usage attributes of a report item.\r
- */\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_Usage_t;\r
-\r
- /** \brief HID Parser Report Item Collection Path Structure.\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 HID_CollectionPath\r
- {\r
- uint8_t Type; /**< Collection type (e.g. "Generic Desktop"). */\r
- HID_Usage_t Usage; /**< Collection usage. */\r
- struct HID_CollectionPath* Parent; /**< Reference to parent collection, or \c NULL if root collection. */\r
- } HID_CollectionPath_t;\r
-\r
- /** \brief HID Parser Report Item Attributes Structure.\r
- *\r
- * Type define for all the data attributes of a report item, except flags.\r
- */\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
- /** \brief HID Parser Report Item Details Structure.\r
- *\r
- * Type define for a report item (IN, OUT or FEATURE) layout attributes and other details.\r
- */\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 \ref HID_ReportItemTypes_t. */\r
- uint16_t ItemFlags; /**< Item data flags, a mask of \c HID_IOF_* constants. */\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 - use \ref HID_ALIGN_DATA() when processing\r
- * a retrieved value so that it is aligned to a specific type.\r
- */\r
- uint32_t PreviousValue; /**< Previous value of the report item. */\r
- } HID_ReportItem_t;\r
-\r
- /** \brief HID Parser Report Size Structure.\r
- *\r
- * Type define for a report item size information structure, to retain the size of a device's reports by ID.\r
- */\r
- typedef struct\r
- {\r
- uint8_t ReportID; /**< Report ID of the report within the HID interface. */\r
- uint16_t ReportSizeBits[3]; /**< Total number of bits in each report type for the given Report ID,\r
- * indexed by the \ref HID_ReportItemTypes_t enum.\r
- */\r
- } HID_ReportSizeInfo_t;\r
-\r
- /** \brief HID Parser State Structure.\r
- *\r
- * Type define for a complete processed HID report, including all report item data and collections.\r
- */\r
- typedef struct\r
- {\r
- uint8_t TotalReportItems; /**< Total number of report items stored in the \c ReportItems array. */\r
- HID_ReportItem_t ReportItems[HID_MAX_REPORTITEMS]; /**< Report items array, including all IN, OUT\r
- * and FEATURE items.\r
- */\r
- HID_CollectionPath_t CollectionPaths[HID_MAX_COLLECTIONS]; /**< All collection items, referenced\r
- * by the report items.\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
- uint16_t LargestReportSizeBits; /**< Largest report that the attached device will generate, in bits */\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
- /** Function to process a given HID report returned from an attached device, and store it into a given\r
- * \ref HID_ReportInfo_t structure.\r
- *\r
- * \param[in] ReportData Buffer containing the device's HID report table.\r
- * \param[in] ReportSize Size in bytes of the HID report table.\r
- * \param[out] ParserData Pointer to a \ref HID_ReportInfo_t instance for the parser output.\r
- *\r
- * \return A value in the \ref HID_Parse_ErrorCodes_t enum.\r
- */\r
- uint8_t USB_ProcessHIDReport(const uint8_t* ReportData,\r
- uint16_t ReportSize,\r
- HID_ReportInfo_t* const ParserData) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(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 \ref HID_ReportItem_t structure.\r
- *\r
- * When called on a report with an item that exists in that report, this copies the report item's \c Value\r
- * to its \c PreviousValue element for easy checking to see if an item's value has changed before processing\r
- * a report. If the given item does not exist in the report, the function does not modify the report item's\r
- * data.\r
- *\r
- * \param[in] ReportData Buffer containing an IN or FEATURE report from an attached device.\r
- * \param[in,out] ReportItem Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array.\r
- *\r
- * \returns Boolean \c true if the item to retrieve was located in the given report, \c false otherwise.\r
- */\r
- bool USB_GetHIDReportItemInfo(const uint8_t* ReportData,\r
- HID_ReportItem_t* const ReportItem) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** Retrieves the given report item's value out of the \c Value member of the report item's\r
- * \ref 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
- * When called, this copies the report item's \c Value element to its \c PreviousValue element for easy\r
- * checking to see if an item's value has changed before sending a report.\r
- *\r
- * If the device has multiple HID reports, the first byte in the report is set to the report ID of the given item.\r
- *\r
- * \param[out] ReportData Buffer holding the current OUT or FEATURE report data.\r
- * \param[in] ReportItem Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array.\r
- */\r
- void USB_SetHIDReportItemInfo(uint8_t* ReportData,\r
- HID_ReportItem_t* const ReportItem) ATTR_NON_NULL_PTR_ARG(1);\r
-\r
- /** Retrieves the size of a given HID report in bytes from its Report ID.\r
- *\r
- * \param[in] ParserData Pointer to a \ref HID_ReportInfo_t instance containing the parser output.\r
- * \param[in] ReportID Report ID of the report whose size is to be determined.\r
- * \param[in] ReportType Type of the report whose size is to be determined, a value from the\r
- * \ref HID_ReportItemTypes_t enum.\r
- *\r
- * \return Size of the report in bytes, or \c 0 if the report does not exist.\r
- */\r
- uint16_t USB_GetHIDReportSize(HID_ReportInfo_t* const ParserData,\r
- const uint8_t ReportID,\r
- const uint8_t ReportType) ATTR_CONST ATTR_NON_NULL_PTR_ARG(1);\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
- * \ref 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
- * Report item pointers passed to this callback function may be cached by the user application for later use\r
- * when processing report items. This provides faster report processing in the user application than would\r
- * a search of the entire parsed report item table for each received or sent report.\r
- *\r
- * \param[in] CurrentItem Pointer to the current report item for user checking.\r
- *\r
- * \return Boolean \c true if the item should be stored into the \ref HID_ReportInfo_t structure, \c false if\r
- * it should be ignored.\r
- */\r
- bool CALLBACK_HIDParser_FilterHIDReportItem(HID_ReportItem_t* const CurrentItem);\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
-\r
-/** @} */\r
-\r
projects / qmk_firmware.git / blobdiff