summaryrefslogtreecommitdiff
path: root/cmds
diff options
context:
space:
mode:
author Harry Cutts <hcutts@google.com> 2024-10-01 17:19:42 +0000
committer Harry Cutts <hcutts@google.com> 2024-10-01 17:19:42 +0000
commit62fc6a9ffbd48786a0ce3688772de8f5c0ab32be (patch)
tree9927dbaca8ec62f884e9597bb0bd38903c4b416c /cmds
parent86f10baf008d0a59cfba4064601219c2931ea49f (diff)
uinput: note that UI_SET_EVBIT configuration is always needed
If you don't add a UI_SET_EVBIT configuration entry to a register command, the other configuration entries will just be silently ignored. This isn't very obvious to someone not familiar with the uinput Kernel API, so let's add a note about it in the README. Bug: 245989146 Test: check rendering in Gitiles Flag: DOCS_ONLY Change-Id: I290bafb276a8caf0639f062eff16aeff32bac8d0
Diffstat (limited to 'cmds')
-rw-r--r--cmds/uinput/README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/cmds/uinput/README.md b/cmds/uinput/README.md
index 5d3f12e0d59f..6138388b30c7 100644
--- a/cmds/uinput/README.md
+++ b/cmds/uinput/README.md
@@ -83,6 +83,11 @@ control values to be sent to the uinput device, which depends on the control cod
Due to the sequential nature in which this is parsed, the `type` field must be specified before
the `data` field in this JSON Object.
+Every `register` command will need a `"UI_SET_EVBIT"` configuration entry that lists what types of
+axes it declares. This entry should be the first in the list. For example, if the uinput device has
+`"UI_SET_KEYBIT"` and `"UI_SET_RELBIT"` configuration entries, it will also need a `"UI_SET_EVBIT"`
+entry with data of `["EV_KEY", "EV_REL"]` or the other configuration entries will be ignored.
+
`ff_effects_max` must be provided if `UI_SET_FFBIT` is used in `configuration`.
`abs_info` fields are provided to set the device axes information. It is an array of below objects: