PROTOCOLS
Device
Defined in fuchsia.hardware.input/input.fidl
GetBootProtocol
Get the HID boot interface protocol this device supports
Request
Response
GetDeviceIds
Get the Device's IDs. If this is a real HID device, the IDs will come from the device.
If it is a mock HID decice, the IDs will either be 0's or user defined.
Request
Response
GetReportDescSize
Get the size of the report descriptor
Request
Response
GetReportDesc
Get the report descriptor
Request
Response
| Name | Type |
|---|
desc |
vector<uint8>[8192]
|
GetNumReports
Get the number of reports in the report descriptor
Request
Response
GetReportIds
Get the report ids that are used in the report descriptor
Request
Response
| Name | Type |
|---|
ids |
vector<uint8>[256]
|
GetReportSize
Get the size of a single report for the given (type, id) pair.
Request
Response
Get the maximum size of a single input report.
Request
Response
ReadReport
Read one report out of the report FIFO. Only a single report will be
returned in this API. time is the time the report was created, from
the view of the monotonic clock.
If status is ZX_ERR_SHOULD_WAIT the client can wait on the event
from GetReportsEvent.
Request
Response
ReadReports
Read up to MAX_REPORT_DATA bytes of reports that have been sent from a device.
This is the interface that is supposed to be used for continuous polling.
Multiple reports can be returned from this API at a time, it is up to the client
to do the parsing of the reports with the correct sizes and offset.
It is guaranteed that only whole reports will be sent.
If there are no reports, this will return ZX_ERR_SHOULD_WAIT, and the client can
wait on the event from |GetReportsEvent|.
Request
Response
| Name | Type |
|---|
status |
zx/status
|
data |
vector<uint8>[8192]
|
GetReportsEvent
Receive an event that will signal on ZX_USER_SIGNAL_0 when there are reports in the
Device's report FIFO. This signal will be de-asserted when there are no
reports in the Device's report FIFO. This event can be re-used each time
the client wishes to know if there are reports in the FIFO.
Request
Response
| Name | Type |
|---|
status |
zx/status
|
event |
handle<event>
|
GetReport
Send a request to the hardware for a given report described by type and id.
Returns the hardware's response. This interface is not intended
to be used for continuous polling of the reports.
Request
Response
| Name | Type |
|---|
status |
zx/status
|
report |
vector<uint8>[8192]
|
SetReport
Set a single report of the given (type, id) pair.
Request
Response
SetTraceId
Set the trace ID that is used for HID report flow events.
Request
STRUCTS
DeviceIds
Defined in fuchsia.hardware.input/input.fidl
DeviceIds lets a clients determine the vendor and product id for a device.
If the device is real HID device, then the id information
will come from the device itself. Mock HID devices may assign the
ids in the driver. If the mock HID driver does not assign ids, zeros
will be used instead.
| Name | Type | Description | Default |
|---|
vendor_id |
uint32
|
|
No default |
product_id |
uint32
|
|
No default |
version |
uint32
|
|
No default |
ENUMS
BootProtocol
Type: uint32
Defined in fuchsia.hardware.input/input.fidl
| Name | Value | Description |
|---|
NONE |
0 |
|
KBD |
1 |
|
MOUSE |
2 |
|
ReportType
Type: uint8
Defined in fuchsia.hardware.input/input.fidl
| Name | Value | Description |
|---|
INPUT |
1 |
|
OUTPUT |
2 |
|
FEATURE |
3 |
|
CONSTANTS
TYPE ALIASES
