zephyr,hid-device

Vendor: Zephyr-specific binding

Description

Bindings for HID device

Properties

Properties not inherited from the base binding file.

Name

Type

Details

interface-name

string

 
HID device name. When this property is present, a USB device will use it
as the string descriptor of the interface.

protocol-code

string

 
This property corresponds to the protocol codes defined in Chapter 4.3
of the HID specification. Only boot devices are required to set one of
the protocols, keyboard or mouse. For non-boot devices, this property is
not required or can be set to none.
- none:     Device does not support the boot interface
- keyboard: Device supports boot interface and keyboard protocol
- mouse:    Device supports boot interface and mouse protocol

Legal values: 'none', 'keyboard', 'mouse'

in-report-size

int

 
The size of the longest input report that the HID device can generate.
This property is used to determine the buffer length used for transfers.

This property is required.

in-polling-period-us

int

 
Input or output type reports polling period in microseconds. For USB full
speed this could be clamped to 1ms or 255ms depending on the value.

This property is required.

out-report-size

int

 
The size of the longest output report that the HID device can generate.
When this property is present, a USB device will use out pipe for output
reports, otherwise control pipe will be used for output reports.

out-polling-period-us

int

 
Output type reports polling period in microseconds. For USB full
speed this could be clamped to 1ms or 255ms depending on the value.
This option is only effective if the out-report-size property is defined.