#include <string.h>
#include <stdbool.h>
#include "HIDReportData.h"
#include "../../../Common/Common.h"
The processed 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.
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.
#define HID_MAX_COLLECTIONS 5 |
Constant indicating the maximum number of COLLECTION items (nested or unnested) that can be processed in the report item descriptor. A large value allows for more COLLECTION items to be processed, but consumes more memory. By default this is set to 5 collections, but this can be overridden by defining HID_MAX_COLLECTIONS to another value in the user project makefile, passing the define to the compiler using the -D compiler switch.
#define HID_MAX_REPORTITEMS 30 |
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.
#define HID_STATETABLE_STACK_DEPTH 3 |
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 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_USAGE_STACK_DEPTH 8 |
Constant indicating the maximum stack depth of the usage table. A larger usage table allows for more USAGE items to be indicated sequentially for REPORT COUNT entries of more than one, but requires more stack space. By default this is set to 8 levels (allowing for a report item with a count of 8) but this can be overridden by defining HID_USAGE_STACK_DEPTH to another value in the user project makefile, passing the define to the compiler using the -D compiler switch.
typedef struct CollectionPath HID_CollectionPath_t |
Type define for a COLLECTION object. Contains the collection attributes and a reference to the parent collection if any.
Enum for the possible error codes in the return value of the ProcessHIDReport() function
Enum for indicating what type of report item an entry in a HID_ReportInfo_t ReportItem array is
uint8_t bool GetReportItemInfo | ( | const uint8_t * | ReportData, | |
HID_ReportItem_t *const | ReportItem | |||
) |
Extracts the given report item's value out of the given HID report and places it into the Value member of the report item's HID_ReportItem_t structure.
ReportData | Buffer containing an IN or FEATURE report from an attached device | |
ReportItem | Pointer to the report item of interest in a HID_ReportInfo_t ReportItem array |
uint8_t ProcessHIDReport | ( | const uint8_t * | ReportData, | |
uint16_t | ReportSize, | |||
HID_ReportInfo_t *const | ParserData | |||
) |
Function to process a given HID report returned from an attached device, and store it into a given HID_ReportInfo_t structure.
ReportData | Buffer containing the device's HID report table | |
ReportSize | Size in bytes of the HID report table | |
ParserData | Pointer to a HID_ReportInfo_t instance for the parser output |
uint8_t bool void SetReportItemInfo | ( | uint8_t * | ReportData, | |
const HID_ReportItem_t * | ReportItem | |||
) |
Retreives the given report item's value out of the Value member of the report item's HID_ReportItem_t structure and places it into the correct position in the HID report buffer. The report buffer is assumed to have the appropriate bits cleared before calling this function (i.e., the buffer should be explicitly cleared before report values are added).
If the device has multiple HID reports, the report ID is set to the report ID of the given item.
ReportData | Buffer holding the current OUT report data | |
ReportItem | Pointer to the report item of interest in a HID_ReportInfo_t ReportItem array |