1*83d290c5STom Rini // SPDX-License-Identifier: GPL-2.0+
2713cb680SHung-ying Tyan /*
3713cb680SHung-ying Tyan * Chromium OS Matrix Keyboard
4713cb680SHung-ying Tyan *
5713cb680SHung-ying Tyan * Copyright (c) 2012 The Chromium OS Authors.
6713cb680SHung-ying Tyan */
7713cb680SHung-ying Tyan
8713cb680SHung-ying Tyan #include <common.h>
9713cb680SHung-ying Tyan #include <cros_ec.h>
101fa4bfdeSSimon Glass #include <dm.h>
11e0dd81e3SSimon Glass #include <errno.h>
12713cb680SHung-ying Tyan #include <input.h>
131fa4bfdeSSimon Glass #include <keyboard.h>
14713cb680SHung-ying Tyan #include <key_matrix.h>
15713cb680SHung-ying Tyan #include <stdio_dev.h>
16713cb680SHung-ying Tyan
17713cb680SHung-ying Tyan enum {
18713cb680SHung-ying Tyan KBC_MAX_KEYS = 8, /* Maximum keys held down at once */
1993322749SSjoerd Simons KBC_REPEAT_RATE_MS = 30,
2093322749SSjoerd Simons KBC_REPEAT_DELAY_MS = 240,
21713cb680SHung-ying Tyan };
22713cb680SHung-ying Tyan
231fa4bfdeSSimon Glass struct cros_ec_keyb_priv {
241fa4bfdeSSimon Glass struct input_config *input; /* The input layer */
25713cb680SHung-ying Tyan struct key_matrix matrix; /* The key matrix layer */
26713cb680SHung-ying Tyan int key_rows; /* Number of keyboard rows */
27713cb680SHung-ying Tyan int key_cols; /* Number of keyboard columns */
28713cb680SHung-ying Tyan int ghost_filter; /* 1 to enable ghost filter, else 0 */
291fa4bfdeSSimon Glass };
30713cb680SHung-ying Tyan
31713cb680SHung-ying Tyan
32713cb680SHung-ying Tyan /**
33713cb680SHung-ying Tyan * Check the keyboard controller and return a list of key matrix positions
34713cb680SHung-ying Tyan * for which a key is pressed
35713cb680SHung-ying Tyan *
361fa4bfdeSSimon Glass * @param dev Keyboard device
37713cb680SHung-ying Tyan * @param keys List of keys that we have detected
38713cb680SHung-ying Tyan * @param max_count Maximum number of keys to return
39e0dd81e3SSimon Glass * @param samep Set to true if this scan repeats the last, else false
40e0dd81e3SSimon Glass * @return number of pressed keys, 0 for none, -EIO on error
41713cb680SHung-ying Tyan */
check_for_keys(struct udevice * dev,struct key_matrix_key * keys,int max_count,bool * samep)421fa4bfdeSSimon Glass static int check_for_keys(struct udevice *dev, struct key_matrix_key *keys,
431fa4bfdeSSimon Glass int max_count, bool *samep)
44713cb680SHung-ying Tyan {
451fa4bfdeSSimon Glass struct cros_ec_keyb_priv *priv = dev_get_priv(dev);
46713cb680SHung-ying Tyan struct key_matrix_key *key;
47e0dd81e3SSimon Glass static struct mbkp_keyscan last_scan;
48e0dd81e3SSimon Glass static bool last_scan_valid;
49713cb680SHung-ying Tyan struct mbkp_keyscan scan;
50713cb680SHung-ying Tyan unsigned int row, col, bit, data;
51713cb680SHung-ying Tyan int num_keys;
52713cb680SHung-ying Tyan
531fa4bfdeSSimon Glass if (cros_ec_scan_keyboard(dev->parent, &scan)) {
54713cb680SHung-ying Tyan debug("%s: keyboard scan failed\n", __func__);
55e0dd81e3SSimon Glass return -EIO;
56713cb680SHung-ying Tyan }
57e0dd81e3SSimon Glass *samep = last_scan_valid && !memcmp(&last_scan, &scan, sizeof(scan));
58e0dd81e3SSimon Glass
59e0dd81e3SSimon Glass /*
60e0dd81e3SSimon Glass * This is a bit odd. The EC has no way to tell us that it has run
61e0dd81e3SSimon Glass * out of key scans. It just returns the same scan over and over
62e0dd81e3SSimon Glass * again. So the only way to detect that we have run out is to detect
63e0dd81e3SSimon Glass * that this scan is the same as the last.
64e0dd81e3SSimon Glass */
65e0dd81e3SSimon Glass last_scan_valid = true;
66e0dd81e3SSimon Glass memcpy(&last_scan, &scan, sizeof(last_scan));
67713cb680SHung-ying Tyan
681fa4bfdeSSimon Glass for (col = num_keys = bit = 0; col < priv->matrix.num_cols;
69713cb680SHung-ying Tyan col++) {
701fa4bfdeSSimon Glass for (row = 0; row < priv->matrix.num_rows; row++) {
71713cb680SHung-ying Tyan unsigned int mask = 1 << (bit & 7);
72713cb680SHung-ying Tyan
73713cb680SHung-ying Tyan data = scan.data[bit / 8];
74713cb680SHung-ying Tyan if ((data & mask) && num_keys < max_count) {
75713cb680SHung-ying Tyan key = keys + num_keys++;
76713cb680SHung-ying Tyan key->row = row;
77713cb680SHung-ying Tyan key->col = col;
78713cb680SHung-ying Tyan key->valid = 1;
79713cb680SHung-ying Tyan }
80713cb680SHung-ying Tyan bit++;
81713cb680SHung-ying Tyan }
82713cb680SHung-ying Tyan }
83713cb680SHung-ying Tyan
84713cb680SHung-ying Tyan return num_keys;
85713cb680SHung-ying Tyan }
86713cb680SHung-ying Tyan
87713cb680SHung-ying Tyan /**
88713cb680SHung-ying Tyan * Check the keyboard, and send any keys that are pressed.
89713cb680SHung-ying Tyan *
90713cb680SHung-ying Tyan * This is called by input_tstc() and input_getc() when they need more
91713cb680SHung-ying Tyan * characters
92713cb680SHung-ying Tyan *
93713cb680SHung-ying Tyan * @param input Input configuration
94713cb680SHung-ying Tyan * @return 1, to indicate that we have something to look at
95713cb680SHung-ying Tyan */
cros_ec_kbc_check(struct input_config * input)96713cb680SHung-ying Tyan int cros_ec_kbc_check(struct input_config *input)
97713cb680SHung-ying Tyan {
981fa4bfdeSSimon Glass struct udevice *dev = input->dev;
991fa4bfdeSSimon Glass struct cros_ec_keyb_priv *priv = dev_get_priv(dev);
100713cb680SHung-ying Tyan static struct key_matrix_key last_keys[KBC_MAX_KEYS];
101713cb680SHung-ying Tyan static int last_num_keys;
102713cb680SHung-ying Tyan struct key_matrix_key keys[KBC_MAX_KEYS];
103713cb680SHung-ying Tyan int keycodes[KBC_MAX_KEYS];
104713cb680SHung-ying Tyan int num_keys, num_keycodes;
105713cb680SHung-ying Tyan int irq_pending, sent;
106e0dd81e3SSimon Glass bool same = false;
107713cb680SHung-ying Tyan
108713cb680SHung-ying Tyan /*
109713cb680SHung-ying Tyan * Loop until the EC has no more keyscan records, or we have
110713cb680SHung-ying Tyan * received at least one character. This means we know that tstc()
111713cb680SHung-ying Tyan * will always return non-zero if keys have been pressed.
112713cb680SHung-ying Tyan *
113713cb680SHung-ying Tyan * Without this loop, a key release (which generates no new ascii
114713cb680SHung-ying Tyan * characters) will cause us to exit this function, and just tstc()
115713cb680SHung-ying Tyan * may return 0 before all keys have been read from the EC.
116713cb680SHung-ying Tyan */
117713cb680SHung-ying Tyan do {
1181fa4bfdeSSimon Glass irq_pending = cros_ec_interrupt_pending(dev->parent);
119713cb680SHung-ying Tyan if (irq_pending) {
1201fa4bfdeSSimon Glass num_keys = check_for_keys(dev, keys, KBC_MAX_KEYS,
121e0dd81e3SSimon Glass &same);
122e0dd81e3SSimon Glass if (num_keys < 0)
123e0dd81e3SSimon Glass return 0;
124713cb680SHung-ying Tyan last_num_keys = num_keys;
125713cb680SHung-ying Tyan memcpy(last_keys, keys, sizeof(keys));
126713cb680SHung-ying Tyan } else {
127713cb680SHung-ying Tyan /*
128713cb680SHung-ying Tyan * EC doesn't want to be asked, so use keys from last
129713cb680SHung-ying Tyan * time.
130713cb680SHung-ying Tyan */
131713cb680SHung-ying Tyan num_keys = last_num_keys;
132713cb680SHung-ying Tyan memcpy(keys, last_keys, sizeof(keys));
133713cb680SHung-ying Tyan }
134713cb680SHung-ying Tyan
135713cb680SHung-ying Tyan if (num_keys < 0)
136713cb680SHung-ying Tyan return -1;
1371fa4bfdeSSimon Glass num_keycodes = key_matrix_decode(&priv->matrix, keys,
138713cb680SHung-ying Tyan num_keys, keycodes, KBC_MAX_KEYS);
139713cb680SHung-ying Tyan sent = input_send_keycodes(input, keycodes, num_keycodes);
140e0dd81e3SSimon Glass
141e0dd81e3SSimon Glass /*
142e0dd81e3SSimon Glass * For those ECs without an interrupt, stop scanning when we
143e0dd81e3SSimon Glass * see that the scan is the same as last time.
144e0dd81e3SSimon Glass */
145e0dd81e3SSimon Glass if ((irq_pending < 0) && same)
146e0dd81e3SSimon Glass break;
147713cb680SHung-ying Tyan } while (irq_pending && !sent);
148713cb680SHung-ying Tyan
149713cb680SHung-ying Tyan return 1;
150713cb680SHung-ying Tyan }
151713cb680SHung-ying Tyan
152713cb680SHung-ying Tyan /**
153713cb680SHung-ying Tyan * Decode MBKP keyboard details from the device tree
154713cb680SHung-ying Tyan *
155713cb680SHung-ying Tyan * @param blob Device tree blob
156713cb680SHung-ying Tyan * @param node Node to decode from
157713cb680SHung-ying Tyan * @param config Configuration data read from fdt
158713cb680SHung-ying Tyan * @return 0 if ok, -1 on error
159713cb680SHung-ying Tyan */
cros_ec_keyb_decode_fdt(struct udevice * dev,struct cros_ec_keyb_priv * config)1608327d41bSSimon Glass static int cros_ec_keyb_decode_fdt(struct udevice *dev,
1611fa4bfdeSSimon Glass struct cros_ec_keyb_priv *config)
162713cb680SHung-ying Tyan {
163713cb680SHung-ying Tyan /*
164713cb680SHung-ying Tyan * Get keyboard rows and columns - at present we are limited to
165713cb680SHung-ying Tyan * 8 columns by the protocol (one byte per row scan)
166713cb680SHung-ying Tyan */
1678327d41bSSimon Glass config->key_rows = dev_read_u32_default(dev, "keypad,num-rows", 0);
1688327d41bSSimon Glass config->key_cols = dev_read_u32_default(dev, "keypad,num-columns", 0);
169713cb680SHung-ying Tyan if (!config->key_rows || !config->key_cols ||
170713cb680SHung-ying Tyan config->key_rows * config->key_cols / 8
171713cb680SHung-ying Tyan > CROS_EC_KEYSCAN_COLS) {
172713cb680SHung-ying Tyan debug("%s: Invalid key matrix size %d x %d\n", __func__,
173713cb680SHung-ying Tyan config->key_rows, config->key_cols);
174713cb680SHung-ying Tyan return -1;
175713cb680SHung-ying Tyan }
1768327d41bSSimon Glass config->ghost_filter = dev_read_bool(dev, "google,needs-ghost-filter");
1778327d41bSSimon Glass
178713cb680SHung-ying Tyan return 0;
179713cb680SHung-ying Tyan }
180713cb680SHung-ying Tyan
cros_ec_kbd_probe(struct udevice * dev)1811fa4bfdeSSimon Glass static int cros_ec_kbd_probe(struct udevice *dev)
182713cb680SHung-ying Tyan {
1831fa4bfdeSSimon Glass struct cros_ec_keyb_priv *priv = dev_get_priv(dev);
1841fa4bfdeSSimon Glass struct keyboard_priv *uc_priv = dev_get_uclass_priv(dev);
1851fa4bfdeSSimon Glass struct stdio_dev *sdev = &uc_priv->sdev;
1861fa4bfdeSSimon Glass struct input_config *input = &uc_priv->input;
1871fa4bfdeSSimon Glass int ret;
188713cb680SHung-ying Tyan
1898327d41bSSimon Glass ret = cros_ec_keyb_decode_fdt(dev, priv);
1908327d41bSSimon Glass if (ret) {
1918327d41bSSimon Glass debug("%s: Cannot decode node (ret=%d)\n", __func__, ret);
1928327d41bSSimon Glass return -EINVAL;
1938327d41bSSimon Glass }
1941fa4bfdeSSimon Glass input_set_delays(input, KBC_REPEAT_DELAY_MS, KBC_REPEAT_RATE_MS);
1951fa4bfdeSSimon Glass ret = key_matrix_init(&priv->matrix, priv->key_rows, priv->key_cols,
1961fa4bfdeSSimon Glass priv->ghost_filter);
1971fa4bfdeSSimon Glass if (ret) {
198713cb680SHung-ying Tyan debug("%s: cannot init key matrix\n", __func__);
1991fa4bfdeSSimon Glass return ret;
200713cb680SHung-ying Tyan }
2018327d41bSSimon Glass ret = key_matrix_decode_fdt(dev, &priv->matrix);
2021fa4bfdeSSimon Glass if (ret) {
203713cb680SHung-ying Tyan debug("%s: Could not decode key matrix from fdt\n", __func__);
2041fa4bfdeSSimon Glass return ret;
205713cb680SHung-ying Tyan }
2061fa4bfdeSSimon Glass debug("%s: Matrix keyboard %dx%d ready\n", __func__, priv->key_rows,
2071fa4bfdeSSimon Glass priv->key_cols);
208713cb680SHung-ying Tyan
2091fa4bfdeSSimon Glass priv->input = input;
2101fa4bfdeSSimon Glass input->dev = dev;
211b1d7a187SSimon Glass input_add_tables(input, false);
2121fa4bfdeSSimon Glass input->read_keys = cros_ec_kbc_check;
2131fa4bfdeSSimon Glass strcpy(sdev->name, "cros-ec-keyb");
214713cb680SHung-ying Tyan
215713cb680SHung-ying Tyan /* Register the device. cros_ec_init_keyboard() will be called soon */
2161fa4bfdeSSimon Glass return input_stdio_register(sdev);
217713cb680SHung-ying Tyan }
2181fa4bfdeSSimon Glass
2191fa4bfdeSSimon Glass static const struct keyboard_ops cros_ec_kbd_ops = {
2201fa4bfdeSSimon Glass };
2211fa4bfdeSSimon Glass
2221fa4bfdeSSimon Glass static const struct udevice_id cros_ec_kbd_ids[] = {
2231fa4bfdeSSimon Glass { .compatible = "google,cros-ec-keyb" },
2241fa4bfdeSSimon Glass { }
2251fa4bfdeSSimon Glass };
2261fa4bfdeSSimon Glass
2271fa4bfdeSSimon Glass U_BOOT_DRIVER(cros_ec_kbd) = {
2281fa4bfdeSSimon Glass .name = "cros_ec_kbd",
2291fa4bfdeSSimon Glass .id = UCLASS_KEYBOARD,
2301fa4bfdeSSimon Glass .of_match = cros_ec_kbd_ids,
2311fa4bfdeSSimon Glass .probe = cros_ec_kbd_probe,
2321fa4bfdeSSimon Glass .ops = &cros_ec_kbd_ops,
2331fa4bfdeSSimon Glass .priv_auto_alloc_size = sizeof(struct cros_ec_keyb_priv),
2341fa4bfdeSSimon Glass };
235