Lines Matching +full:cros +full:- +full:ec +full:- +full:keyb
1 // SPDX-License-Identifier: GPL-2.0
2 // ChromeOS EC keyboard driver
6 // This driver uses the ChromeOS EC byte-level message-based protocol for
7 // communicating the keyboard state (which keys are pressed) from a keyboard EC
8 // to the AP over some bus (such as i2c, lpc, spi). The EC does debouncing,
10 // motivation for this is to keep the EC firmware as simple as possible, since
11 // it cannot be easily upgraded and EC flash/IRAM space is relatively
19 #include <linux/input/vivaldi-fmap.h>
33 * struct cros_ec_keyb - Structure representing EC keyboard device
39 * @ghost_filter: true to enable the matrix key-ghosting filter
43 * @ec: Top level ChromeOS device to use to talk to EC
45 * @bs_idev: The input device for non-matrix buttons and switches (or NULL).
59 struct cros_ec_device *ec; member
69 * struct cros_ec_bs_map - Mapping between Linux keycodes and EC button/switch
85 /* cros_ec_keyb_bs - Map EC button/switch #defines into kernel ones */
140 struct device *dev = ckdev->dev; in cros_ec_keyb_has_ghosting()
141 uint8_t *valid_keys = ckdev->valid_keys; in cros_ec_keyb_has_ghosting()
156 for (col1 = 0; col1 < ckdev->cols; col1++) { in cros_ec_keyb_has_ghosting()
158 for (col2 = col1 + 1; col2 < ckdev->cols; col2++) { in cros_ec_keyb_has_ghosting()
180 struct input_dev *idev = ckdev->idev; in cros_ec_keyb_process()
185 if (ckdev->ghost_filter && cros_ec_keyb_has_ghosting(ckdev, kb_state)) { in cros_ec_keyb_process()
187 * Simple-minded solution: ignore this state. The obvious in cros_ec_keyb_process()
191 dev_dbg(ckdev->dev, "ghosting found\n"); in cros_ec_keyb_process()
195 for (col = 0; col < ckdev->cols; col++) { in cros_ec_keyb_process()
196 for (row = 0; row < ckdev->rows; row++) { in cros_ec_keyb_process()
197 int pos = MATRIX_SCAN_CODE(row, col, ckdev->row_shift); in cros_ec_keyb_process()
198 const unsigned short *keycodes = idev->keycode; in cros_ec_keyb_process()
201 old_state = ckdev->old_kb_state[col] & (1 << row); in cros_ec_keyb_process()
203 dev_dbg(ckdev->dev, in cros_ec_keyb_process()
212 ckdev->old_kb_state[col] = kb_state[col]; in cros_ec_keyb_process()
214 input_sync(ckdev->idev); in cros_ec_keyb_process()
218 * cros_ec_keyb_report_bs - Report non-matrixed buttons or switches
220 * This takes a bitmap of buttons or switches from the EC and reports events,
225 * @mask: A bitmap of buttons from the EC.
231 struct input_dev *idev = ckdev->bs_idev; in cros_ec_keyb_report_bs()
237 if (map->ev_type != ev_type) in cros_ec_keyb_report_bs()
240 input_event(idev, ev_type, map->code, in cros_ec_keyb_report_bs()
241 !!(mask & BIT(map->bit)) ^ map->inverted); in cros_ec_keyb_report_bs()
256 * suspend. Switches will be re-checked in in cros_ec_keyb_work()
259 if (queued_during_suspend && !device_may_wakeup(ckdev->dev)) in cros_ec_keyb_work()
262 switch (ckdev->ec->event_data.event_type) { in cros_ec_keyb_work()
264 pm_wakeup_event(ckdev->dev, 0); in cros_ec_keyb_work()
266 if (ckdev->ec->event_size != ckdev->cols) { in cros_ec_keyb_work()
267 dev_err(ckdev->dev, in cros_ec_keyb_work()
273 ckdev->ec->event_data.data.key_matrix, in cros_ec_keyb_work()
274 ckdev->ec->event_size); in cros_ec_keyb_work()
278 pm_wakeup_event(ckdev->dev, 0); in cros_ec_keyb_work()
280 val = get_unaligned_le32(&ckdev->ec->event_data.data.sysrq); in cros_ec_keyb_work()
281 dev_dbg(ckdev->dev, "sysrq code from EC: %#x\n", val); in cros_ec_keyb_work()
287 pm_wakeup_event(ckdev->dev, 0); in cros_ec_keyb_work()
289 if (ckdev->ec->event_data.event_type == EC_MKBP_EVENT_BUTTON) { in cros_ec_keyb_work()
291 &ckdev->ec->event_data.data.buttons); in cros_ec_keyb_work()
295 &ckdev->ec->event_data.data.switches); in cros_ec_keyb_work()
315 int row_shift = ckdev->row_shift; in cros_ec_keyb_compute_valid_keys()
316 unsigned short *keymap = ckdev->idev->keycode; in cros_ec_keyb_compute_valid_keys()
319 BUG_ON(ckdev->idev->keycodesize != sizeof(*keymap)); in cros_ec_keyb_compute_valid_keys()
321 for (col = 0; col < ckdev->cols; col++) { in cros_ec_keyb_compute_valid_keys()
322 for (row = 0; row < ckdev->rows; row++) { in cros_ec_keyb_compute_valid_keys()
325 ckdev->valid_keys[col] |= 1 << row; in cros_ec_keyb_compute_valid_keys()
327 dev_dbg(ckdev->dev, "valid_keys[%02d] = 0x%02x\n", in cros_ec_keyb_compute_valid_keys()
328 col, ckdev->valid_keys[col]); in cros_ec_keyb_compute_valid_keys()
333 * cros_ec_keyb_info - Wrap the EC command EC_CMD_MKBP_INFO
338 * @ec_dev: The EC device
347 * Returns 0 if no error or -error upon error.
362 return -ENOMEM; in cros_ec_keyb_info()
364 msg->command = EC_CMD_MKBP_INFO; in cros_ec_keyb_info()
365 msg->version = 1; in cros_ec_keyb_info()
366 msg->outsize = sizeof(*params); in cros_ec_keyb_info()
367 msg->insize = result_size; in cros_ec_keyb_info()
368 params = (struct ec_params_mkbp_info *)msg->data; in cros_ec_keyb_info()
369 params->info_type = info_type; in cros_ec_keyb_info()
370 params->event_type = event_type; in cros_ec_keyb_info()
373 if (ret == -ENOPROTOOPT) { in cros_ec_keyb_info()
378 dev_warn(ec_dev->dev, "Transfer error %d/%d: %d\n", in cros_ec_keyb_info()
381 dev_warn(ec_dev->dev, "Wrong size %d/%d: %d != %zu\n", in cros_ec_keyb_info()
384 ret = -EPROTO; in cros_ec_keyb_info()
386 memcpy(result, msg->data, result_size); in cros_ec_keyb_info()
396 * cros_ec_keyb_query_switches - Query the state of switches and report
398 * This will ask the EC about the current state of switches and report to the
404 * Returns 0 if no error or -error upon error.
408 struct cros_ec_device *ec_dev = ckdev->ec; in cros_ec_keyb_query_switches()
425 * cros_ec_keyb_resume - Resume the keyboard
427 * We use the resume notification as a chance to query the EC for switches.
431 * Returns 0 if no error or -error upon error.
437 if (ckdev->bs_idev) in cros_ec_keyb_resume()
444 * cros_ec_keyb_register_bs - Register non-matrix buttons/switches
446 * Handles all the bits of the keyboard driver related to non-matrix buttons
447 * and switches, including asking the EC about which are present and telling
451 * but the ckdev->bs_idev will remain NULL when this function exits.
454 * @expect_buttons_switches: Indicates that EC must report button and/or
457 * Returns 0 if no error or -error upon error.
462 struct cros_ec_device *ec_dev = ckdev->ec; in cros_ec_keyb_register_bs()
463 struct device *dev = ckdev->dev; in cros_ec_keyb_register_bs()
487 return expect_buttons_switches ? -EINVAL : 0; in cros_ec_keyb_register_bs()
490 * We call the non-matrix buttons/switches 'input1', if present. in cros_ec_keyb_register_bs()
491 * Allocate phys before input dev, to ensure correct tear-down in cros_ec_keyb_register_bs()
494 phys = devm_kasprintf(dev, GFP_KERNEL, "%s/input1", ec_dev->phys_name); in cros_ec_keyb_register_bs()
496 return -ENOMEM; in cros_ec_keyb_register_bs()
500 return -ENOMEM; in cros_ec_keyb_register_bs()
502 idev->name = "cros_ec_buttons"; in cros_ec_keyb_register_bs()
503 idev->phys = phys; in cros_ec_keyb_register_bs()
504 __set_bit(EV_REP, idev->evbit); in cros_ec_keyb_register_bs()
506 idev->id.bustype = BUS_VIRTUAL; in cros_ec_keyb_register_bs()
507 idev->id.version = 1; in cros_ec_keyb_register_bs()
508 idev->id.product = 0; in cros_ec_keyb_register_bs()
509 idev->dev.parent = dev; in cros_ec_keyb_register_bs()
512 ckdev->bs_idev = idev; in cros_ec_keyb_register_bs()
517 if ((map->ev_type == EV_KEY && (buttons & BIT(map->bit))) || in cros_ec_keyb_register_bs()
518 (map->ev_type == EV_SW && (switches & BIT(map->bit)))) in cros_ec_keyb_register_bs()
519 input_set_capability(idev, map->ev_type, map->code); in cros_ec_keyb_register_bs()
528 ret = input_register_device(ckdev->bs_idev); in cros_ec_keyb_register_bs()
539 u32 *physmap = ckdev->vdata.function_row_physmap; in cros_ec_keyb_parse_vivaldi_physmap()
545 n_physmap = device_property_count_u32(ckdev->dev, in cros_ec_keyb_parse_vivaldi_physmap()
546 "function-row-physmap"); in cros_ec_keyb_parse_vivaldi_physmap()
551 dev_warn(ckdev->dev, in cros_ec_keyb_parse_vivaldi_physmap()
557 error = device_property_read_u32_array(ckdev->dev, in cros_ec_keyb_parse_vivaldi_physmap()
558 "function-row-physmap", in cros_ec_keyb_parse_vivaldi_physmap()
561 dev_warn(ckdev->dev, in cros_ec_keyb_parse_vivaldi_physmap()
562 "failed to parse function-row-physmap property: %d\n", in cros_ec_keyb_parse_vivaldi_physmap()
574 scancode = MATRIX_SCAN_CODE(row, col, ckdev->row_shift); in cros_ec_keyb_parse_vivaldi_physmap()
578 ckdev->vdata.num_function_row_keys = n_physmap; in cros_ec_keyb_parse_vivaldi_physmap()
582 * cros_ec_keyb_register_matrix - Register matrix keys
588 * Returns 0 if no error or -error upon error.
592 struct cros_ec_device *ec_dev = ckdev->ec; in cros_ec_keyb_register_matrix()
593 struct device *dev = ckdev->dev; in cros_ec_keyb_register_matrix()
598 err = matrix_keypad_parse_properties(dev, &ckdev->rows, &ckdev->cols); in cros_ec_keyb_register_matrix()
602 ckdev->valid_keys = devm_kzalloc(dev, ckdev->cols, GFP_KERNEL); in cros_ec_keyb_register_matrix()
603 if (!ckdev->valid_keys) in cros_ec_keyb_register_matrix()
604 return -ENOMEM; in cros_ec_keyb_register_matrix()
606 ckdev->old_kb_state = devm_kzalloc(dev, ckdev->cols, GFP_KERNEL); in cros_ec_keyb_register_matrix()
607 if (!ckdev->old_kb_state) in cros_ec_keyb_register_matrix()
608 return -ENOMEM; in cros_ec_keyb_register_matrix()
612 * dev, to ensure correct tear-down ordering. in cros_ec_keyb_register_matrix()
614 phys = devm_kasprintf(dev, GFP_KERNEL, "%s/input0", ec_dev->phys_name); in cros_ec_keyb_register_matrix()
616 return -ENOMEM; in cros_ec_keyb_register_matrix()
620 return -ENOMEM; in cros_ec_keyb_register_matrix()
622 idev->name = CROS_EC_DEV_NAME; in cros_ec_keyb_register_matrix()
623 idev->phys = phys; in cros_ec_keyb_register_matrix()
624 __set_bit(EV_REP, idev->evbit); in cros_ec_keyb_register_matrix()
626 idev->id.bustype = BUS_VIRTUAL; in cros_ec_keyb_register_matrix()
627 idev->id.version = 1; in cros_ec_keyb_register_matrix()
628 idev->id.product = 0; in cros_ec_keyb_register_matrix()
629 idev->dev.parent = dev; in cros_ec_keyb_register_matrix()
631 ckdev->ghost_filter = device_property_read_bool(dev, in cros_ec_keyb_register_matrix()
632 "google,needs-ghost-filter"); in cros_ec_keyb_register_matrix()
634 err = matrix_keypad_build_keymap(NULL, NULL, ckdev->rows, ckdev->cols, in cros_ec_keyb_register_matrix()
641 ckdev->row_shift = get_count_order(ckdev->cols); in cros_ec_keyb_register_matrix()
645 ckdev->idev = idev; in cros_ec_keyb_register_matrix()
649 err = input_register_device(ckdev->idev); in cros_ec_keyb_register_matrix()
663 const struct vivaldi_data *data = &ckdev->vdata; in function_row_physmap_show()
683 !ckdev->vdata.num_function_row_keys) in cros_ec_keyb_attr_is_visible()
686 return attr->mode; in cros_ec_keyb_attr_is_visible()
696 struct cros_ec_device *ec; in cros_ec_keyb_probe() local
697 struct device *dev = &pdev->dev; in cros_ec_keyb_probe()
703 * If the parent ec device has not been probed yet, defer the probe of in cros_ec_keyb_probe()
706 ec = dev_get_drvdata(pdev->dev.parent); in cros_ec_keyb_probe()
707 if (!ec) in cros_ec_keyb_probe()
708 return -EPROBE_DEFER; in cros_ec_keyb_probe()
712 return -ENOMEM; in cros_ec_keyb_probe()
714 ckdev->ec = ec; in cros_ec_keyb_probe()
715 ckdev->dev = dev; in cros_ec_keyb_probe()
729 dev_err(dev, "cannot register non-matrix inputs: %d\n", err); in cros_ec_keyb_probe()
739 ckdev->notifier.notifier_call = cros_ec_keyb_work; in cros_ec_keyb_probe()
740 err = blocking_notifier_chain_register(&ckdev->ec->event_notifier, in cros_ec_keyb_probe()
741 &ckdev->notifier); in cros_ec_keyb_probe()
747 device_init_wakeup(ckdev->dev, true); in cros_ec_keyb_probe()
753 struct cros_ec_keyb *ckdev = dev_get_drvdata(&pdev->dev); in cros_ec_keyb_remove()
755 blocking_notifier_chain_unregister(&ckdev->ec->event_notifier, in cros_ec_keyb_remove()
756 &ckdev->notifier); in cros_ec_keyb_remove()
771 { .compatible = "google,cros-ec-keyb" },
772 { .compatible = "google,cros-ec-keyb-switches", .data = (void *)true },
784 .name = "cros-ec-keyb",
794 MODULE_DESCRIPTION("ChromeOS EC keyboard driver");
795 MODULE_ALIAS("platform:cros-ec-keyb");