Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 78fd834f authored by Treehugger Robot's avatar Treehugger Robot Committed by Android (Google) Code Review
Browse files

Merge "Update documentation for uinput command's bus values" into main

parents 3cf28edc 3c9ffd50
Loading
Loading
Loading
Loading
+7 −3
Original line number Diff line number Diff line
@@ -59,7 +59,7 @@ Register a new uinput device
| `name`           | string         | Device name                |
| `vid`            | 16-bit integer | Vendor ID                  |
| `pid`            | 16-bit integer | Product ID                 |
| `bus`            | string         | Bus that device should use |
| `bus`            | string         | The bus to report          |
| `port`           | string         | `phys` value to report     |
| `configuration`  | object array   | uinput device configuration|
| `ff_effects_max` | integer        | `ff_effects_max` value     |
@@ -68,8 +68,11 @@ Register a new uinput device
`id` is used for matching the subsequent commands to a specific device to avoid ambiguity when
multiple devices are registered.

`bus` is used to determine how the uinput device is connected to the host. The options are `"usb"`
and `"bluetooth"`.
`bus` specifies the bus that the kernel should report the device as being connected to. The most
common values are `"usb"` and `"bluetooth"`, but any bus with a `BUS_…` constant in the [Linux
kernel's input.h][input.h] can be specified using the part of its identifier after `BUS_`. For
example, to specify the SPI bus type (`BUS_SPI` in the kernel header), use `"spi"` (or `"SPI"`,
since it's case-insensitive).

Device configuration is used to configure the uinput device. The `type` field provides a `UI_SET_*`
control code as an integer value or a string label (e.g. `"UI_SET_EVBIT"`), and data is a vector of
@@ -137,6 +140,7 @@ Example:
}
```

[input.h]: https://source.chromium.org/chromiumos/chromiumos/codesearch/+/main:src/third_party/kernel/upstream/include/uapi/linux/input.h?q=BUS_
[struct input_absinfo]: https://cs.android.com/android/platform/superproject/main/+/main:bionic/libc/kernel/uapi/linux/input.h?q=%22struct%20input_absinfo%22

##### Waiting for registration