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