xref: /freebsd/sys/contrib/device-tree/Bindings/input/input.yaml (revision 7ef62cebc2f965b0f640263e179276928885e33d)
1# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/input/input.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Common input schema binding
8
9maintainers:
10  - Dmitry Torokhov <dmitry.torokhov@gmail.com>
11
12properties:
13  autorepeat:
14    description: Enable autorepeat when key is pressed and held down.
15    type: boolean
16
17  linux,keycodes:
18    description:
19      Specifies an array of numeric keycode values to be used for reporting
20      button presses.
21    $ref: /schemas/types.yaml#/definitions/uint32-array
22    items:
23      minimum: 0
24      maximum: 0x2ff
25
26  linux,code:
27    description:
28      Specifies a single numeric keycode value to be used for reporting
29      button/switch events. Specify KEY_RESERVED (0) to opt out of event
30      reporting.
31    $ref: /schemas/types.yaml#/definitions/uint32
32    maximum: 0x2ff
33
34  linux,input-type:
35    $ref: /schemas/types.yaml#/definitions/uint32
36    enum:
37      - 1   # EV_KEY
38      - 2   # EV_REL
39      - 3   # EV_ABS
40      - 5   # EV_SW
41    description:
42      Specifies whether the event is to be interpreted as a key, relative,
43      absolute, or switch.
44
45  poll-interval:
46    description: Poll interval time in milliseconds.
47    $ref: /schemas/types.yaml#/definitions/uint32
48
49  power-off-time-sec:
50    description:
51      Duration in seconds which the key should be kept pressed for device to
52      power off automatically. Device with key pressed shutdown feature can
53      specify this property.
54
55  reset-time-sec:
56    description:
57      Duration in seconds which the key should be kept pressed for device to
58      reset automatically. Device with key pressed reset feature can specify
59      this property.
60
61dependencies:
62  linux,input-type: [ "linux,code" ]
63
64additionalProperties: true
65