2 * ChromeOS EC keyboard driver
4 * Copyright (C) 2012 Google, Inc
6 * This software is licensed under the terms of the GNU General Public
7 * License version 2, as published by the Free Software Foundation, and
8 * may be copied, distributed, and modified under those terms.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * This driver uses the Chrome OS EC byte-level message-based protocol for
16 * communicating the keyboard state (which keys are pressed) from a keyboard EC
17 * to the AP over some bus (such as i2c, lpc, spi). The EC does debouncing,
18 * but everything else (including deghosting) is done here. The main
19 * motivation for this is to keep the EC firmware as simple as possible, since
20 * it cannot be easily upgraded and EC flash/IRAM space is relatively
24 #include <linux/module.h>
25 #include <linux/bitops.h>
26 #include <linux/i2c.h>
27 #include <linux/input.h>
28 #include <linux/interrupt.h>
29 #include <linux/kernel.h>
30 #include <linux/notifier.h>
31 #include <linux/platform_device.h>
32 #include <linux/slab.h>
33 #include <linux/input/matrix_keypad.h>
34 #include <linux/mfd/cros_ec.h>
35 #include <linux/mfd/cros_ec_commands.h>
37 #include <asm/unaligned.h>
40 * @rows: Number of rows in the keypad
41 * @cols: Number of columns in the keypad
42 * @row_shift: log2 or number of rows, rounded up
43 * @keymap_data: Matrix keymap data used to convert to keyscan values
44 * @ghost_filter: true to enable the matrix key-ghosting filter
45 * @valid_keys: bitmap of existing keys for each matrix column
46 * @old_kb_state: bitmap of keys pressed last scan
47 * @dev: Device pointer
48 * @ec: Top level ChromeOS device to use to talk to EC
49 * @idev: The input device for the matrix keys.
50 * @bs_idev: The input device for non-matrix buttons and switches (or NULL).
51 * @notifier: interrupt event notifier for transport devices
57 const struct matrix_keymap_data *keymap_data;
60 uint8_t *old_kb_state;
63 struct cros_ec_device *ec;
65 struct input_dev *idev;
66 struct input_dev *bs_idev;
67 struct notifier_block notifier;
72 * cros_ec_bs_map - Struct mapping Linux keycodes to EC button/switch bitmap
75 * @ev_type: The type of the input event to generate (e.g., EV_KEY).
76 * @code: A linux keycode
77 * @bit: A #define like EC_MKBP_POWER_BUTTON or EC_MKBP_LID_OPEN
78 * @inverted: If the #define and EV_SW have opposite meanings, this is true.
79 * Only applicable to switches.
81 struct cros_ec_bs_map {
88 /* cros_ec_keyb_bs - Map EC button/switch #defines into kernel ones */
89 static const struct cros_ec_bs_map cros_ec_keyb_bs[] = {
94 .bit = EC_MKBP_POWER_BUTTON,
99 .bit = EC_MKBP_VOL_UP,
103 .code = KEY_VOLUMEDOWN,
104 .bit = EC_MKBP_VOL_DOWN,
111 .bit = EC_MKBP_LID_OPEN,
116 .code = SW_TABLET_MODE,
117 .bit = EC_MKBP_TABLET_MODE,
122 * Returns true when there is at least one combination of pressed keys that
123 * results in ghosting.
125 static bool cros_ec_keyb_has_ghosting(struct cros_ec_keyb *ckdev, uint8_t *buf)
127 int col1, col2, buf1, buf2;
128 struct device *dev = ckdev->dev;
129 uint8_t *valid_keys = ckdev->valid_keys;
132 * Ghosting happens if for any pressed key X there are other keys
133 * pressed both in the same row and column of X as, for instance,
134 * in the following diagram:
141 * In this case only X, Y, and Z are pressed, but g appears to be
142 * pressed too (see Wikipedia).
144 for (col1 = 0; col1 < ckdev->cols; col1++) {
145 buf1 = buf[col1] & valid_keys[col1];
146 for (col2 = col1 + 1; col2 < ckdev->cols; col2++) {
147 buf2 = buf[col2] & valid_keys[col2];
148 if (hweight8(buf1 & buf2) > 1) {
149 dev_dbg(dev, "ghost found at: B[%02d]:0x%02x & B[%02d]:0x%02x",
150 col1, buf1, col2, buf2);
161 * Compares the new keyboard state to the old one and produces key
162 * press/release events accordingly. The keyboard state is 13 bytes (one byte
165 static void cros_ec_keyb_process(struct cros_ec_keyb *ckdev,
166 uint8_t *kb_state, int len)
168 struct input_dev *idev = ckdev->idev;
176 if (ckdev->ghost_filter && cros_ec_keyb_has_ghosting(ckdev, kb_state)) {
178 * Simple-minded solution: ignore this state. The obvious
179 * improvement is to only ignore changes to keys involved in
180 * the ghosting, but process the other changes.
182 dev_dbg(ckdev->dev, "ghosting found\n");
186 for (col = 0; col < ckdev->cols; col++) {
187 for (row = 0; row < ckdev->rows; row++) {
188 int pos = MATRIX_SCAN_CODE(row, col, ckdev->row_shift);
189 const unsigned short *keycodes = idev->keycode;
191 new_state = kb_state[col] & (1 << row);
192 old_state = ckdev->old_kb_state[col] & (1 << row);
193 if (new_state != old_state) {
195 "changed: [r%d c%d]: byte %02x\n",
196 row, col, new_state);
198 input_report_key(idev, keycodes[pos],
202 ckdev->old_kb_state[col] = kb_state[col];
204 input_sync(ckdev->idev);
208 * cros_ec_keyb_report_bs - Report non-matrixed buttons or switches
210 * This takes a bitmap of buttons or switches from the EC and reports events,
211 * syncing at the end.
213 * @ckdev: The keyboard device.
214 * @ev_type: The input event type (e.g., EV_KEY).
215 * @mask: A bitmap of buttons from the EC.
217 static void cros_ec_keyb_report_bs(struct cros_ec_keyb *ckdev,
218 unsigned int ev_type, u32 mask)
221 struct input_dev *idev = ckdev->bs_idev;
224 for (i = 0; i < ARRAY_SIZE(cros_ec_keyb_bs); i++) {
225 const struct cros_ec_bs_map *map = &cros_ec_keyb_bs[i];
227 if (map->ev_type != ev_type)
230 input_event(idev, ev_type, map->code,
231 !!(mask & BIT(map->bit)) ^ map->inverted);
236 static int cros_ec_keyb_work(struct notifier_block *nb,
237 unsigned long queued_during_suspend, void *_notify)
239 struct cros_ec_keyb *ckdev = container_of(nb, struct cros_ec_keyb,
242 unsigned int ev_type;
244 switch (ckdev->ec->event_data.event_type) {
245 case EC_MKBP_EVENT_KEY_MATRIX:
247 * If EC is not the wake source, discard key state changes
250 if (queued_during_suspend)
253 if (ckdev->ec->event_size != ckdev->cols) {
255 "Discarded incomplete key matrix event.\n");
258 cros_ec_keyb_process(ckdev,
259 ckdev->ec->event_data.data.key_matrix,
260 ckdev->ec->event_size);
263 case EC_MKBP_EVENT_BUTTON:
264 case EC_MKBP_EVENT_SWITCH:
266 * If EC is not the wake source, discard key state
267 * changes during suspend. Switches will be re-checked in
268 * cros_ec_keyb_resume() to be sure nothing is lost.
270 if (queued_during_suspend)
273 if (ckdev->ec->event_data.event_type == EC_MKBP_EVENT_BUTTON) {
274 val = get_unaligned_le32(
275 &ckdev->ec->event_data.data.buttons);
278 val = get_unaligned_le32(
279 &ckdev->ec->event_data.data.switches);
282 cros_ec_keyb_report_bs(ckdev, ev_type, val);
293 * Walks keycodes flipping bit in buffer COLUMNS deep where bit is ROW. Used by
294 * ghosting logic to ignore NULL or virtual keys.
296 static void cros_ec_keyb_compute_valid_keys(struct cros_ec_keyb *ckdev)
299 int row_shift = ckdev->row_shift;
300 unsigned short *keymap = ckdev->idev->keycode;
303 BUG_ON(ckdev->idev->keycodesize != sizeof(*keymap));
305 for (col = 0; col < ckdev->cols; col++) {
306 for (row = 0; row < ckdev->rows; row++) {
307 code = keymap[MATRIX_SCAN_CODE(row, col, row_shift)];
308 if (code && (code != KEY_BATTERY))
309 ckdev->valid_keys[col] |= 1 << row;
311 dev_dbg(ckdev->dev, "valid_keys[%02d] = 0x%02x\n",
312 col, ckdev->valid_keys[col]);
317 * cros_ec_keyb_info - Wrap the EC command EC_CMD_MKBP_INFO
319 * This wraps the EC_CMD_MKBP_INFO, abstracting out all of the marshalling and
320 * unmarshalling and different version nonsense into something simple.
322 * @ec_dev: The EC device
323 * @info_type: Either EC_MKBP_INFO_SUPPORTED or EC_MKBP_INFO_CURRENT.
324 * @event_type: Either EC_MKBP_EVENT_BUTTON or EC_MKBP_EVENT_SWITCH. Actually
325 * in some cases this could be EC_MKBP_EVENT_KEY_MATRIX or
326 * EC_MKBP_EVENT_HOST_EVENT too but we don't use in this driver.
327 * @result: Where we'll store the result; a union
328 * @result_size: The size of the result. Expected to be the size of one of
329 * the elements in the union.
331 * Returns 0 if no error or -error upon error.
333 static int cros_ec_keyb_info(struct cros_ec_device *ec_dev,
334 enum ec_mkbp_info_type info_type,
335 enum ec_mkbp_event event_type,
336 union ec_response_get_next_data *result,
339 struct ec_params_mkbp_info *params;
340 struct cros_ec_command *msg;
343 msg = kzalloc(sizeof(*msg) + max_t(size_t, result_size,
344 sizeof(*params)), GFP_KERNEL);
348 msg->command = EC_CMD_MKBP_INFO;
350 msg->outsize = sizeof(*params);
351 msg->insize = result_size;
352 params = (struct ec_params_mkbp_info *)msg->data;
353 params->info_type = info_type;
354 params->event_type = event_type;
356 ret = cros_ec_cmd_xfer(ec_dev, msg);
358 dev_warn(ec_dev->dev, "Transfer error %d/%d: %d\n",
359 (int)info_type, (int)event_type, ret);
360 } else if (msg->result == EC_RES_INVALID_VERSION) {
361 /* With older ECs we just return 0 for everything */
362 memset(result, 0, result_size);
364 } else if (msg->result != EC_RES_SUCCESS) {
365 dev_warn(ec_dev->dev, "Error getting info %d/%d: %d\n",
366 (int)info_type, (int)event_type, msg->result);
368 } else if (ret != result_size) {
369 dev_warn(ec_dev->dev, "Wrong size %d/%d: %d != %zu\n",
370 (int)info_type, (int)event_type,
374 memcpy(result, msg->data, result_size);
384 * cros_ec_keyb_query_switches - Query the state of switches and report
386 * This will ask the EC about the current state of switches and report to the
387 * kernel. Note that we don't query for buttons because they are more
388 * transitory and we'll get an update on the next release / press.
390 * @ckdev: The keyboard device
392 * Returns 0 if no error or -error upon error.
394 static int cros_ec_keyb_query_switches(struct cros_ec_keyb *ckdev)
396 struct cros_ec_device *ec_dev = ckdev->ec;
397 union ec_response_get_next_data event_data = {};
400 ret = cros_ec_keyb_info(ec_dev, EC_MKBP_INFO_CURRENT,
401 EC_MKBP_EVENT_SWITCH, &event_data,
402 sizeof(event_data.switches));
406 cros_ec_keyb_report_bs(ckdev, EV_SW,
407 get_unaligned_le32(&event_data.switches));
413 * cros_ec_keyb_resume - Resume the keyboard
415 * We use the resume notification as a chance to query the EC for switches.
417 * @dev: The keyboard device
419 * Returns 0 if no error or -error upon error.
421 static __maybe_unused int cros_ec_keyb_resume(struct device *dev)
423 struct cros_ec_keyb *ckdev = dev_get_drvdata(dev);
426 return cros_ec_keyb_query_switches(ckdev);
432 * cros_ec_keyb_register_bs - Register non-matrix buttons/switches
434 * Handles all the bits of the keyboard driver related to non-matrix buttons
435 * and switches, including asking the EC about which are present and telling
436 * the kernel to expect them.
438 * If this device has no support for buttons and switches we'll return no error
439 * but the ckdev->bs_idev will remain NULL when this function exits.
441 * @ckdev: The keyboard device
443 * Returns 0 if no error or -error upon error.
445 static int cros_ec_keyb_register_bs(struct cros_ec_keyb *ckdev)
447 struct cros_ec_device *ec_dev = ckdev->ec;
448 struct device *dev = ckdev->dev;
449 struct input_dev *idev;
450 union ec_response_get_next_data event_data = {};
457 ret = cros_ec_keyb_info(ec_dev, EC_MKBP_INFO_SUPPORTED,
458 EC_MKBP_EVENT_BUTTON, &event_data,
459 sizeof(event_data.buttons));
462 buttons = get_unaligned_le32(&event_data.buttons);
464 ret = cros_ec_keyb_info(ec_dev, EC_MKBP_INFO_SUPPORTED,
465 EC_MKBP_EVENT_SWITCH, &event_data,
466 sizeof(event_data.switches));
469 switches = get_unaligned_le32(&event_data.switches);
471 if (!buttons && !switches)
475 * We call the non-matrix buttons/switches 'input1', if present.
476 * Allocate phys before input dev, to ensure correct tear-down
479 phys = devm_kasprintf(dev, GFP_KERNEL, "%s/input1", ec_dev->phys_name);
483 idev = devm_input_allocate_device(dev);
487 idev->name = "cros_ec_buttons";
489 __set_bit(EV_REP, idev->evbit);
491 idev->id.bustype = BUS_VIRTUAL;
492 idev->id.version = 1;
493 idev->id.product = 0;
494 idev->dev.parent = dev;
496 input_set_drvdata(idev, ckdev);
497 ckdev->bs_idev = idev;
499 for (i = 0; i < ARRAY_SIZE(cros_ec_keyb_bs); i++) {
500 const struct cros_ec_bs_map *map = &cros_ec_keyb_bs[i];
502 if (buttons & BIT(map->bit))
503 input_set_capability(idev, map->ev_type, map->code);
506 ret = cros_ec_keyb_query_switches(ckdev);
508 dev_err(dev, "cannot query switches\n");
512 ret = input_register_device(ckdev->bs_idev);
514 dev_err(dev, "cannot register input device\n");
522 * cros_ec_keyb_register_bs - Register matrix keys
524 * Handles all the bits of the keyboard driver related to matrix keys.
526 * @ckdev: The keyboard device
528 * Returns 0 if no error or -error upon error.
530 static int cros_ec_keyb_register_matrix(struct cros_ec_keyb *ckdev)
532 struct cros_ec_device *ec_dev = ckdev->ec;
533 struct device *dev = ckdev->dev;
534 struct input_dev *idev;
538 err = matrix_keypad_parse_properties(dev, &ckdev->rows, &ckdev->cols);
542 ckdev->valid_keys = devm_kzalloc(dev, ckdev->cols, GFP_KERNEL);
543 if (!ckdev->valid_keys)
546 ckdev->old_kb_state = devm_kzalloc(dev, ckdev->cols, GFP_KERNEL);
547 if (!ckdev->old_kb_state)
551 * We call the keyboard matrix 'input0'. Allocate phys before input
552 * dev, to ensure correct tear-down ordering.
554 phys = devm_kasprintf(dev, GFP_KERNEL, "%s/input0", ec_dev->phys_name);
558 idev = devm_input_allocate_device(dev);
562 idev->name = CROS_EC_DEV_NAME;
564 __set_bit(EV_REP, idev->evbit);
566 idev->id.bustype = BUS_VIRTUAL;
567 idev->id.version = 1;
568 idev->id.product = 0;
569 idev->dev.parent = dev;
571 ckdev->ghost_filter = of_property_read_bool(dev->of_node,
572 "google,needs-ghost-filter");
574 err = matrix_keypad_build_keymap(NULL, NULL, ckdev->rows, ckdev->cols,
577 dev_err(dev, "cannot build key matrix\n");
581 ckdev->row_shift = get_count_order(ckdev->cols);
583 input_set_capability(idev, EV_MSC, MSC_SCAN);
584 input_set_drvdata(idev, ckdev);
586 cros_ec_keyb_compute_valid_keys(ckdev);
588 err = input_register_device(ckdev->idev);
590 dev_err(dev, "cannot register input device\n");
597 static int cros_ec_keyb_probe(struct platform_device *pdev)
599 struct cros_ec_device *ec = dev_get_drvdata(pdev->dev.parent);
600 struct device *dev = &pdev->dev;
601 struct cros_ec_keyb *ckdev;
607 ckdev = devm_kzalloc(dev, sizeof(*ckdev), GFP_KERNEL);
613 dev_set_drvdata(dev, ckdev);
615 err = cros_ec_keyb_register_matrix(ckdev);
617 dev_err(dev, "cannot register matrix inputs: %d\n", err);
621 err = cros_ec_keyb_register_bs(ckdev);
623 dev_err(dev, "cannot register non-matrix inputs: %d\n", err);
627 ckdev->notifier.notifier_call = cros_ec_keyb_work;
628 err = blocking_notifier_chain_register(&ckdev->ec->event_notifier,
631 dev_err(dev, "cannot register notifier: %d\n", err);
638 static int cros_ec_keyb_remove(struct platform_device *pdev)
640 struct cros_ec_keyb *ckdev = dev_get_drvdata(&pdev->dev);
642 blocking_notifier_chain_unregister(&ckdev->ec->event_notifier,
649 static const struct of_device_id cros_ec_keyb_of_match[] = {
650 { .compatible = "google,cros-ec-keyb" },
653 MODULE_DEVICE_TABLE(of, cros_ec_keyb_of_match);
656 static const SIMPLE_DEV_PM_OPS(cros_ec_keyb_pm_ops, NULL, cros_ec_keyb_resume);
658 static struct platform_driver cros_ec_keyb_driver = {
659 .probe = cros_ec_keyb_probe,
660 .remove = cros_ec_keyb_remove,
662 .name = "cros-ec-keyb",
663 .of_match_table = of_match_ptr(cros_ec_keyb_of_match),
664 .pm = &cros_ec_keyb_pm_ops,
668 module_platform_driver(cros_ec_keyb_driver);
670 MODULE_LICENSE("GPL");
671 MODULE_DESCRIPTION("ChromeOS EC keyboard driver");
672 MODULE_ALIAS("platform:cros-ec-keyb");