xref: /freebsd/sys/contrib/device-tree/Bindings/input/cros-ec-keyb.txt (revision a90b9d0159070121c221b966469c3e36d912bf82)
1ChromeOS EC Keyboard
2
3Google's ChromeOS EC Keyboard is a simple matrix keyboard implemented on
4a separate EC (Embedded Controller) device. It provides a message for reading
5key scans from the EC. These are then converted into keycodes for processing
6by the kernel.
7
8This binding is based on matrix-keymap.txt and extends/modifies it as follows:
9
10Required properties:
11- compatible: "google,cros-ec-keyb"
12
13Optional properties:
14- google,needs-ghost-filter: True to enable a ghost filter for the matrix
15keyboard. This is recommended if the EC does not have its own logic or
16hardware for this.
17
18
19Example:
20
21cros-ec-keyb {
22	compatible = "google,cros-ec-keyb";
23	keypad,num-rows = <8>;
24	keypad,num-columns = <13>;
25	google,needs-ghost-filter;
26	/*
27	 * Keymap entries take the form of 0xRRCCKKKK where
28	 * RR=Row CC=Column KKKK=Key Code
29	 * The values below are for a US keyboard layout and
30	 * are taken from the Linux driver. Note that the
31	 * 102ND key is not used for US keyboards.
32	 */
33	linux,keymap = <
34		/* CAPSLCK F1         B          F10     */
35		0x0001003a 0x0002003b 0x00030030 0x00040044
36		/* N       =          R_ALT      ESC     */
37		0x00060031 0x0008000d 0x000a0064 0x01010001
38		/* F4      G          F7         H       */
39		0x0102003e 0x01030022 0x01040041 0x01060023
40		/* '       F9         BKSPACE    L_CTRL  */
41		0x01080028 0x01090043 0x010b000e 0x0200001d
42		/* TAB     F3         T          F6      */
43		0x0201000f 0x0202003d 0x02030014 0x02040040
44		/* ]       Y          102ND      [       */
45		0x0205001b 0x02060015 0x02070056 0x0208001a
46		/* F8      GRAVE      F2         5       */
47		0x02090042 0x03010029 0x0302003c 0x03030006
48		/* F5      6          -          \       */
49		0x0304003f 0x03060007 0x0308000c 0x030b002b
50		/* R_CTRL  A          D          F       */
51		0x04000061 0x0401001e 0x04020020 0x04030021
52		/* S       K          J          ;       */
53		0x0404001f 0x04050025 0x04060024 0x04080027
54		/* L       ENTER      Z          C       */
55		0x04090026 0x040b001c 0x0501002c 0x0502002e
56		/* V       X          ,          M       */
57		0x0503002f 0x0504002d 0x05050033 0x05060032
58		/* L_SHIFT /          .          SPACE   */
59		0x0507002a 0x05080035 0x05090034 0x050B0039
60		/* 1       3          4          2       */
61		0x06010002 0x06020004 0x06030005 0x06040003
62		/* 8       7          0          9       */
63		0x06050009 0x06060008 0x0608000b 0x0609000a
64		/* L_ALT   DOWN       RIGHT      Q       */
65		0x060a0038 0x060b006c 0x060c006a 0x07010010
66		/* E       R          W          I       */
67		0x07020012 0x07030013 0x07040011 0x07050017
68		/* U       R_SHIFT    P          O       */
69		0x07060016 0x07070036 0x07080019 0x07090018
70		/* UP      LEFT    */
71		0x070b0067 0x070c0069>;
72};
73