xref: /linux/Documentation/devicetree/bindings/input/input.yaml (revision 7a5f1cd22d47f8ca4b760b6334378ae42c1bd24b) 
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: Input Devices Common Properties
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  debounce-delay-ms:
18    description:
19      Debounce delay in milliseconds. This is the time during which the key
20      press or release signal must remain stable before it is considered valid.
21    minimum: 0
22    maximum: 999
23    default: 0
24
25  linux,keycodes:
26    description:
27      Specifies an array of numeric keycode values to be used for reporting
28      button presses.
29    $ref: /schemas/types.yaml#/definitions/uint32-array
30    items:
31      minimum: 0
32      maximum: 0x2ff
33
34  linux,code:
35    description:
36      Specifies a single numeric keycode value to be used for reporting
37      button/switch events. Specify KEY_RESERVED (0) to opt out of event
38      reporting.
39    $ref: /schemas/types.yaml#/definitions/uint32
40    maximum: 0x2ff
41
42  linux,input-type:
43    $ref: /schemas/types.yaml#/definitions/uint32
44    enum:
45      - 1   # EV_KEY
46      - 2   # EV_REL
47      - 3   # EV_ABS
48      - 5   # EV_SW
49    description:
50      Specifies whether the event is to be interpreted as a key, relative,
51      absolute, or switch.
52
53  poll-interval:
54    description: Poll interval time in milliseconds.
55    $ref: /schemas/types.yaml#/definitions/uint32
56
57  power-off-time-sec:
58    description:
59      Duration in seconds which the key should be kept pressed for device to
60      power off automatically. Device with key pressed shutdown feature can
61      specify this property.
62
63  reset-time-sec:
64    description:
65      Duration in seconds which the key should be kept pressed for device to
66      reset automatically. Device with key pressed reset feature can specify
67      this property.
68
69  settling-time-us:
70    description:
71      Delay, in microseconds, when activating an output line/col/row before
72      we can reliably read other input lines that maybe affected by this
73      output. This can be the case for an output with a RC circuit that affects
74      ramp-up/down times.
75    default: 0
76
77dependencies:
78  linux,input-type: [ "linux,code" ]
79
80additionalProperties: true
81