xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/input/google,cros-ec-keyb.yaml (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2*4882a593Smuzhiyun%YAML 1.2
3*4882a593Smuzhiyun---
4*4882a593Smuzhiyun
5*4882a593Smuzhiyun$id: http://devicetree.org/schemas/input/google,cros-ec-keyb.yaml#
6*4882a593Smuzhiyun$schema: http://devicetree.org/meta-schemas/core.yaml#
7*4882a593Smuzhiyun
8*4882a593Smuzhiyuntitle: ChromeOS EC Keyboard
9*4882a593Smuzhiyun
10*4882a593Smuzhiyunmaintainers:
11*4882a593Smuzhiyun  - Simon Glass <sjg@chromium.org>
12*4882a593Smuzhiyun  - Benson Leung <bleung@chromium.org>
13*4882a593Smuzhiyun  - Enric Balletbo i Serra <enric.balletbo@collabora.com>
14*4882a593Smuzhiyun
15*4882a593Smuzhiyundescription: |
16*4882a593Smuzhiyun  Google's ChromeOS EC Keyboard is a simple matrix keyboard
17*4882a593Smuzhiyun  implemented on a separate EC (Embedded Controller) device. It provides
18*4882a593Smuzhiyun  a message for reading key scans from the EC. These are then converted
19*4882a593Smuzhiyun  into keycodes for processing by the kernel.
20*4882a593Smuzhiyun
21*4882a593SmuzhiyunallOf:
22*4882a593Smuzhiyun  - $ref: "/schemas/input/matrix-keymap.yaml#"
23*4882a593Smuzhiyun
24*4882a593Smuzhiyunproperties:
25*4882a593Smuzhiyun  compatible:
26*4882a593Smuzhiyun    const: google,cros-ec-keyb
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun  google,needs-ghost-filter:
29*4882a593Smuzhiyun    description:
30*4882a593Smuzhiyun      Enable a ghost filter for the matrix keyboard. This is recommended
31*4882a593Smuzhiyun      if the EC does not have its own logic or hardware for this.
32*4882a593Smuzhiyun    type: boolean
33*4882a593Smuzhiyun
34*4882a593Smuzhiyunrequired:
35*4882a593Smuzhiyun  - compatible
36*4882a593Smuzhiyun
37*4882a593SmuzhiyununevaluatedProperties: false
38*4882a593Smuzhiyun
39*4882a593Smuzhiyunexamples:
40*4882a593Smuzhiyun  - |
41*4882a593Smuzhiyun    cros-ec-keyb {
42*4882a593Smuzhiyun        compatible = "google,cros-ec-keyb";
43*4882a593Smuzhiyun        keypad,num-rows = <8>;
44*4882a593Smuzhiyun        keypad,num-columns = <13>;
45*4882a593Smuzhiyun        google,needs-ghost-filter;
46*4882a593Smuzhiyun        /*
47*4882a593Smuzhiyun         * Keymap entries take the form of 0xRRCCKKKK where
48*4882a593Smuzhiyun         * RR=Row CC=Column KKKK=Key Code
49*4882a593Smuzhiyun         * The values below are for a US keyboard layout and
50*4882a593Smuzhiyun         * are taken from the Linux driver. Note that the
51*4882a593Smuzhiyun         * 102ND key is not used for US keyboards.
52*4882a593Smuzhiyun         */
53*4882a593Smuzhiyun        linux,keymap = <
54*4882a593Smuzhiyun            /* CAPSLCK F1         B          F10     */
55*4882a593Smuzhiyun            0x0001003a 0x0002003b 0x00030030 0x00040044
56*4882a593Smuzhiyun            /* N       =          R_ALT      ESC     */
57*4882a593Smuzhiyun            0x00060031 0x0008000d 0x000a0064 0x01010001
58*4882a593Smuzhiyun            /* F4      G          F7         H       */
59*4882a593Smuzhiyun            0x0102003e 0x01030022 0x01040041 0x01060023
60*4882a593Smuzhiyun            /* '       F9         BKSPACE    L_CTRL  */
61*4882a593Smuzhiyun            0x01080028 0x01090043 0x010b000e 0x0200001d
62*4882a593Smuzhiyun            /* TAB     F3         T          F6      */
63*4882a593Smuzhiyun            0x0201000f 0x0202003d 0x02030014 0x02040040
64*4882a593Smuzhiyun            /* ]       Y          102ND      [       */
65*4882a593Smuzhiyun            0x0205001b 0x02060015 0x02070056 0x0208001a
66*4882a593Smuzhiyun            /* F8      GRAVE      F2         5       */
67*4882a593Smuzhiyun            0x02090042 0x03010029 0x0302003c 0x03030006
68*4882a593Smuzhiyun            /* F5      6          -          \       */
69*4882a593Smuzhiyun            0x0304003f 0x03060007 0x0308000c 0x030b002b
70*4882a593Smuzhiyun            /* R_CTRL  A          D          F       */
71*4882a593Smuzhiyun            0x04000061 0x0401001e 0x04020020 0x04030021
72*4882a593Smuzhiyun            /* S       K          J          ;       */
73*4882a593Smuzhiyun            0x0404001f 0x04050025 0x04060024 0x04080027
74*4882a593Smuzhiyun            /* L       ENTER      Z          C       */
75*4882a593Smuzhiyun            0x04090026 0x040b001c 0x0501002c 0x0502002e
76*4882a593Smuzhiyun            /* V       X          ,          M       */
77*4882a593Smuzhiyun            0x0503002f 0x0504002d 0x05050033 0x05060032
78*4882a593Smuzhiyun            /* L_SHIFT /          .          SPACE   */
79*4882a593Smuzhiyun            0x0507002a 0x05080035 0x05090034 0x050B0039
80*4882a593Smuzhiyun            /* 1       3          4          2       */
81*4882a593Smuzhiyun            0x06010002 0x06020004 0x06030005 0x06040003
82*4882a593Smuzhiyun            /* 8       7          0          9       */
83*4882a593Smuzhiyun            0x06050009 0x06060008 0x0608000b 0x0609000a
84*4882a593Smuzhiyun            /* L_ALT   DOWN       RIGHT      Q       */
85*4882a593Smuzhiyun            0x060a0038 0x060b006c 0x060c006a 0x07010010
86*4882a593Smuzhiyun            /* E       R          W          I       */
87*4882a593Smuzhiyun            0x07020012 0x07030013 0x07040011 0x07050017
88*4882a593Smuzhiyun            /* U       R_SHIFT    P          O       */
89*4882a593Smuzhiyun            0x07060016 0x07070036 0x07080019 0x07090018
90*4882a593Smuzhiyun            /* UP      LEFT    */
91*4882a593Smuzhiyun            0x070b0067 0x070c0069>;
92*4882a593Smuzhiyun    };
93