xref: /freebsd/sys/contrib/device-tree/Bindings/input/google,cros-ec-keyb.yaml (revision e67e85659c0de33e617e5fbf1028c6e8b49eee53)
1# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2%YAML 1.2
3---
4
5$id: http://devicetree.org/schemas/input/google,cros-ec-keyb.yaml#
6$schema: http://devicetree.org/meta-schemas/core.yaml#
7
8title: ChromeOS EC Keyboard
9
10maintainers:
11  - Simon Glass <sjg@chromium.org>
12  - Benson Leung <bleung@chromium.org>
13
14description: |
15  Google's ChromeOS EC Keyboard is a simple matrix keyboard
16  implemented on a separate EC (Embedded Controller) device. It provides
17  a message for reading key scans from the EC. These are then converted
18  into keycodes for processing by the kernel.
19
20allOf:
21  - $ref: "/schemas/input/matrix-keymap.yaml#"
22
23properties:
24  compatible:
25    const: google,cros-ec-keyb
26
27  google,needs-ghost-filter:
28    description:
29      Enable a ghost filter for the matrix keyboard. This is recommended
30      if the EC does not have its own logic or hardware for this.
31    type: boolean
32
33  function-row-physmap:
34    minItems: 1
35    maxItems: 15
36    description: |
37      An ordered u32 array describing the rows/columns (in the scan matrix)
38      of top row keys from physical left (KEY_F1) to right. Each entry
39      encodes the row/column as:
40      (((row) & 0xFF) << 24) | (((column) & 0xFF) << 16)
41      where the lower 16 bits are reserved. This property is specified only
42      when the keyboard has a custom design for the top row keys.
43
44required:
45  - compatible
46
47unevaluatedProperties: false
48
49examples:
50  - |
51    #include <dt-bindings/input/input.h>
52    cros-ec-keyb {
53        compatible = "google,cros-ec-keyb";
54        keypad,num-rows = <8>;
55        keypad,num-columns = <13>;
56        google,needs-ghost-filter;
57        function-row-physmap = <
58            MATRIX_KEY(0x00, 0x02, 0)   /* T1 */
59            MATRIX_KEY(0x03, 0x02, 0)   /* T2 */
60            MATRIX_KEY(0x02, 0x02, 0)   /* T3 */
61            MATRIX_KEY(0x01, 0x02, 0)   /* T4 */
62            MATRIX_KEY(0x03, 0x04, 0)   /* T5 */
63            MATRIX_KEY(0x02, 0x04, 0)   /* T6 */
64            MATRIX_KEY(0x01, 0x04, 0)   /* T7 */
65            MATRIX_KEY(0x02, 0x09, 0)   /* T8 */
66            MATRIX_KEY(0x01, 0x09, 0)   /* T9 */
67            MATRIX_KEY(0x00, 0x04, 0)   /* T10 */
68        >;
69        /*
70         * Keymap entries take the form of 0xRRCCKKKK where
71         * RR=Row CC=Column KKKK=Key Code
72         * The values below are for a US keyboard layout and
73         * are taken from the Linux driver. Note that the
74         * 102ND key is not used for US keyboards.
75         */
76        linux,keymap = <
77            /* CAPSLCK F1         B          F10     */
78            0x0001003a 0x0002003b 0x00030030 0x00040044
79            /* N       =          R_ALT      ESC     */
80            0x00060031 0x0008000d 0x000a0064 0x01010001
81            /* F4      G          F7         H       */
82            0x0102003e 0x01030022 0x01040041 0x01060023
83            /* '       F9         BKSPACE    L_CTRL  */
84            0x01080028 0x01090043 0x010b000e 0x0200001d
85            /* TAB     F3         T          F6      */
86            0x0201000f 0x0202003d 0x02030014 0x02040040
87            /* ]       Y          102ND      [       */
88            0x0205001b 0x02060015 0x02070056 0x0208001a
89            /* F8      GRAVE      F2         5       */
90            0x02090042 0x03010029 0x0302003c 0x03030006
91            /* F5      6          -          \       */
92            0x0304003f 0x03060007 0x0308000c 0x030b002b
93            /* R_CTRL  A          D          F       */
94            0x04000061 0x0401001e 0x04020020 0x04030021
95            /* S       K          J          ;       */
96            0x0404001f 0x04050025 0x04060024 0x04080027
97            /* L       ENTER      Z          C       */
98            0x04090026 0x040b001c 0x0501002c 0x0502002e
99            /* V       X          ,          M       */
100            0x0503002f 0x0504002d 0x05050033 0x05060032
101            /* L_SHIFT /          .          SPACE   */
102            0x0507002a 0x05080035 0x05090034 0x050B0039
103            /* 1       3          4          2       */
104            0x06010002 0x06020004 0x06030005 0x06040003
105            /* 8       7          0          9       */
106            0x06050009 0x06060008 0x0608000b 0x0609000a
107            /* L_ALT   DOWN       RIGHT      Q       */
108            0x060a0038 0x060b006c 0x060c006a 0x07010010
109            /* E       R          W          I       */
110            0x07020012 0x07030013 0x07040011 0x07050017
111            /* U       R_SHIFT    P          O       */
112            0x07060016 0x07070036 0x07080019 0x07090018
113            /* UP      LEFT    */
114            0x070b0067 0x070c0069>;
115    };
116