HID Parser API

#include "src/btstack_hid_parser.h"

Single-pass HID Report Parser: HID Report is directly parsed without preprocessing HID Descriptor to minimize memory.

// HID Descriptor Iterator

btstack_hid_descriptor_iterator_init

void btstack_hid_descriptor_iterator_init(btstack_hid_descriptor_iterator_t * iterator, const uint8_t * hid_descriptor, uint16_t hid_descriptor_len);

Init HID Descriptor iterator

Parameters

Source


btstack_hid_descriptor_iterator_has_more

bool btstack_hid_descriptor_iterator_has_more(btstack_hid_descriptor_iterator_t * iterator);

Check if HID Descriptor Items are available

Parameters

Returns

Source


btstack_hid_descriptor_iterator_get_item

const hid_descriptor_item_t * btstack_hid_descriptor_iterator_get_item(btstack_hid_descriptor_iterator_t * iterator);

Get next HID Descriptor Item

Parameters

Returns

Source


btstack_hid_descriptor_iterator_valid

bool btstack_hid_descriptor_iterator_valid(btstack_hid_descriptor_iterator_t * iterator);

Returns if HID Descriptor was well formed

Parameters

Returns

Source


// HID Descriptor Usage Iterator

btstack_hid_usage_iterator_init

void btstack_hid_usage_iterator_init(btstack_hid_usage_iterator_t * iterator, const uint8_t * hid_descriptor, uint16_t hid_descriptor_len, hid_report_type_t hid_report_type);

Initialize usages iterator for HID Descriptor and report type

Parameters

Source


btstack_hid_usage_iterator_has_more

bool btstack_hid_usage_iterator_has_more(btstack_hid_usage_iterator_t * iterator);

Checks if more usages are available

Parameters

Returns

Source


btstack_hid_usage_iterator_get_item

void btstack_hid_usage_iterator_get_item(btstack_hid_usage_iterator_t * iterator, btstack_hid_usage_item_t * item);

Get current usage item

Parameters

Source


// HID Report Iterator

btstack_hid_parser_init

void btstack_hid_parser_init(btstack_hid_parser_t * parser, const uint8_t * hid_descriptor, uint16_t hid_descriptor_len, hid_report_type_t hid_report_type, const uint8_t * hid_report, uint16_t hid_report_len);

Initialize HID Parser.

Parameters

Source


btstack_hid_parser_has_more

bool btstack_hid_parser_has_more(btstack_hid_parser_t * parser);

Checks if more fields are available

Parameters

Returns

Source


btstack_hid_parser_get_field

void btstack_hid_parser_get_field(btstack_hid_parser_t * parser, uint16_t * usage_page, uint16_t * usage, int32_t * value);

Get next field

Parameters

Source


btstack_hid_get_report_size_for_id

int btstack_hid_get_report_size_for_id(uint16_t report_id, hid_report_type_t report_type, const uint8_t *hid_descriptor,
uint16_t hid_descriptor_len);

Parses descriptor and returns report size for given report ID and report type

Parameters

Returns

Source


btstack_hid_report_id_valid

hid_report_id_status_t btstack_hid_report_id_valid(uint16_t report_id, const uint8_t * hid_descriptor, uint16_t hid_descriptor_len);

Parses descriptor and returns status for given report ID

Parameters

Returns

Source


btstack_hid_report_id_declared

bool btstack_hid_report_id_declared(const uint8_t *hid_descriptor, uint16_t hid_descriptor_len);

Parses descriptor and returns true if report ID found

Parameters

Returns

Source