GNU Linux-libre 4.19.211-gnu1
[releases.git] / drivers / input / keyboard / cros_ec_keyb.c
1 // SPDX-License-Identifier: GPL-2.0
2 // ChromeOS EC keyboard driver
3 //
4 // Copyright (C) 2012 Google, Inc.
5 //
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,
9 // but everything else (including deghosting) is done here.  The main
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
12 // expensive.
13
14 #include <linux/module.h>
15 #include <linux/bitops.h>
16 #include <linux/i2c.h>
17 #include <linux/input.h>
18 #include <linux/interrupt.h>
19 #include <linux/kernel.h>
20 #include <linux/notifier.h>
21 #include <linux/platform_device.h>
22 #include <linux/slab.h>
23 #include <linux/sysrq.h>
24 #include <linux/input/matrix_keypad.h>
25 #include <linux/mfd/cros_ec.h>
26 #include <linux/mfd/cros_ec_commands.h>
27
28 #include <asm/unaligned.h>
29
30 /*
31  * @rows: Number of rows in the keypad
32  * @cols: Number of columns in the keypad
33  * @row_shift: log2 or number of rows, rounded up
34  * @keymap_data: Matrix keymap data used to convert to keyscan values
35  * @ghost_filter: true to enable the matrix key-ghosting filter
36  * @valid_keys: bitmap of existing keys for each matrix column
37  * @old_kb_state: bitmap of keys pressed last scan
38  * @dev: Device pointer
39  * @ec: Top level ChromeOS device to use to talk to EC
40  * @idev: The input device for the matrix keys.
41  * @bs_idev: The input device for non-matrix buttons and switches (or NULL).
42  * @notifier: interrupt event notifier for transport devices
43  */
44 struct cros_ec_keyb {
45         unsigned int rows;
46         unsigned int cols;
47         int row_shift;
48         const struct matrix_keymap_data *keymap_data;
49         bool ghost_filter;
50         uint8_t *valid_keys;
51         uint8_t *old_kb_state;
52
53         struct device *dev;
54         struct cros_ec_device *ec;
55
56         struct input_dev *idev;
57         struct input_dev *bs_idev;
58         struct notifier_block notifier;
59 };
60
61
62 /**
63  * cros_ec_bs_map - Struct mapping Linux keycodes to EC button/switch bitmap
64  * #defines
65  *
66  * @ev_type: The type of the input event to generate (e.g., EV_KEY).
67  * @code: A linux keycode
68  * @bit: A #define like EC_MKBP_POWER_BUTTON or EC_MKBP_LID_OPEN
69  * @inverted: If the #define and EV_SW have opposite meanings, this is true.
70  *            Only applicable to switches.
71  */
72 struct cros_ec_bs_map {
73         unsigned int ev_type;
74         unsigned int code;
75         u8 bit;
76         bool inverted;
77 };
78
79 /* cros_ec_keyb_bs - Map EC button/switch #defines into kernel ones */
80 static const struct cros_ec_bs_map cros_ec_keyb_bs[] = {
81         /* Buttons */
82         {
83                 .ev_type        = EV_KEY,
84                 .code           = KEY_POWER,
85                 .bit            = EC_MKBP_POWER_BUTTON,
86         },
87         {
88                 .ev_type        = EV_KEY,
89                 .code           = KEY_VOLUMEUP,
90                 .bit            = EC_MKBP_VOL_UP,
91         },
92         {
93                 .ev_type        = EV_KEY,
94                 .code           = KEY_VOLUMEDOWN,
95                 .bit            = EC_MKBP_VOL_DOWN,
96         },
97
98         /* Switches */
99         {
100                 .ev_type        = EV_SW,
101                 .code           = SW_LID,
102                 .bit            = EC_MKBP_LID_OPEN,
103                 .inverted       = true,
104         },
105         {
106                 .ev_type        = EV_SW,
107                 .code           = SW_TABLET_MODE,
108                 .bit            = EC_MKBP_TABLET_MODE,
109         },
110 };
111
112 /*
113  * Returns true when there is at least one combination of pressed keys that
114  * results in ghosting.
115  */
116 static bool cros_ec_keyb_has_ghosting(struct cros_ec_keyb *ckdev, uint8_t *buf)
117 {
118         int col1, col2, buf1, buf2;
119         struct device *dev = ckdev->dev;
120         uint8_t *valid_keys = ckdev->valid_keys;
121
122         /*
123          * Ghosting happens if for any pressed key X there are other keys
124          * pressed both in the same row and column of X as, for instance,
125          * in the following diagram:
126          *
127          * . . Y . g .
128          * . . . . . .
129          * . . . . . .
130          * . . X . Z .
131          *
132          * In this case only X, Y, and Z are pressed, but g appears to be
133          * pressed too (see Wikipedia).
134          */
135         for (col1 = 0; col1 < ckdev->cols; col1++) {
136                 buf1 = buf[col1] & valid_keys[col1];
137                 for (col2 = col1 + 1; col2 < ckdev->cols; col2++) {
138                         buf2 = buf[col2] & valid_keys[col2];
139                         if (hweight8(buf1 & buf2) > 1) {
140                                 dev_dbg(dev, "ghost found at: B[%02d]:0x%02x & B[%02d]:0x%02x",
141                                         col1, buf1, col2, buf2);
142                                 return true;
143                         }
144                 }
145         }
146
147         return false;
148 }
149
150
151 /*
152  * Compares the new keyboard state to the old one and produces key
153  * press/release events accordingly.  The keyboard state is 13 bytes (one byte
154  * per column)
155  */
156 static void cros_ec_keyb_process(struct cros_ec_keyb *ckdev,
157                          uint8_t *kb_state, int len)
158 {
159         struct input_dev *idev = ckdev->idev;
160         int col, row;
161         int new_state;
162         int old_state;
163
164         if (ckdev->ghost_filter && cros_ec_keyb_has_ghosting(ckdev, kb_state)) {
165                 /*
166                  * Simple-minded solution: ignore this state. The obvious
167                  * improvement is to only ignore changes to keys involved in
168                  * the ghosting, but process the other changes.
169                  */
170                 dev_dbg(ckdev->dev, "ghosting found\n");
171                 return;
172         }
173
174         for (col = 0; col < ckdev->cols; col++) {
175                 for (row = 0; row < ckdev->rows; row++) {
176                         int pos = MATRIX_SCAN_CODE(row, col, ckdev->row_shift);
177                         const unsigned short *keycodes = idev->keycode;
178
179                         new_state = kb_state[col] & (1 << row);
180                         old_state = ckdev->old_kb_state[col] & (1 << row);
181                         if (new_state != old_state) {
182                                 dev_dbg(ckdev->dev,
183                                         "changed: [r%d c%d]: byte %02x\n",
184                                         row, col, new_state);
185
186                                 input_event(idev, EV_MSC, MSC_SCAN, pos);
187                                 input_report_key(idev, keycodes[pos],
188                                                  new_state);
189                         }
190                 }
191                 ckdev->old_kb_state[col] = kb_state[col];
192         }
193         input_sync(ckdev->idev);
194 }
195
196 /**
197  * cros_ec_keyb_report_bs - Report non-matrixed buttons or switches
198  *
199  * This takes a bitmap of buttons or switches from the EC and reports events,
200  * syncing at the end.
201  *
202  * @ckdev: The keyboard device.
203  * @ev_type: The input event type (e.g., EV_KEY).
204  * @mask: A bitmap of buttons from the EC.
205  */
206 static void cros_ec_keyb_report_bs(struct cros_ec_keyb *ckdev,
207                                    unsigned int ev_type, u32 mask)
208
209 {
210         struct input_dev *idev = ckdev->bs_idev;
211         int i;
212
213         for (i = 0; i < ARRAY_SIZE(cros_ec_keyb_bs); i++) {
214                 const struct cros_ec_bs_map *map = &cros_ec_keyb_bs[i];
215
216                 if (map->ev_type != ev_type)
217                         continue;
218
219                 input_event(idev, ev_type, map->code,
220                             !!(mask & BIT(map->bit)) ^ map->inverted);
221         }
222         input_sync(idev);
223 }
224
225 static int cros_ec_keyb_work(struct notifier_block *nb,
226                              unsigned long queued_during_suspend, void *_notify)
227 {
228         struct cros_ec_keyb *ckdev = container_of(nb, struct cros_ec_keyb,
229                                                   notifier);
230         u32 val;
231         unsigned int ev_type;
232
233         /*
234          * If not wake enabled, discard key state changes during
235          * suspend. Switches will be re-checked in
236          * cros_ec_keyb_resume() to be sure nothing is lost.
237          */
238         if (queued_during_suspend && !device_may_wakeup(ckdev->dev))
239                 return NOTIFY_OK;
240
241         switch (ckdev->ec->event_data.event_type) {
242         case EC_MKBP_EVENT_KEY_MATRIX:
243                 pm_wakeup_event(ckdev->dev, 0);
244
245                 if (ckdev->ec->event_size != ckdev->cols) {
246                         dev_err(ckdev->dev,
247                                 "Discarded incomplete key matrix event.\n");
248                         return NOTIFY_OK;
249                 }
250
251                 cros_ec_keyb_process(ckdev,
252                                      ckdev->ec->event_data.data.key_matrix,
253                                      ckdev->ec->event_size);
254                 break;
255
256         case EC_MKBP_EVENT_SYSRQ:
257                 pm_wakeup_event(ckdev->dev, 0);
258
259                 val = get_unaligned_le32(&ckdev->ec->event_data.data.sysrq);
260                 dev_dbg(ckdev->dev, "sysrq code from EC: %#x\n", val);
261                 handle_sysrq(val);
262                 break;
263
264         case EC_MKBP_EVENT_BUTTON:
265         case EC_MKBP_EVENT_SWITCH:
266                 pm_wakeup_event(ckdev->dev, 0);
267
268                 if (ckdev->ec->event_data.event_type == EC_MKBP_EVENT_BUTTON) {
269                         val = get_unaligned_le32(
270                                         &ckdev->ec->event_data.data.buttons);
271                         ev_type = EV_KEY;
272                 } else {
273                         val = get_unaligned_le32(
274                                         &ckdev->ec->event_data.data.switches);
275                         ev_type = EV_SW;
276                 }
277                 cros_ec_keyb_report_bs(ckdev, ev_type, val);
278                 break;
279
280         default:
281                 return NOTIFY_DONE;
282         }
283
284         return NOTIFY_OK;
285 }
286
287 /*
288  * Walks keycodes flipping bit in buffer COLUMNS deep where bit is ROW.  Used by
289  * ghosting logic to ignore NULL or virtual keys.
290  */
291 static void cros_ec_keyb_compute_valid_keys(struct cros_ec_keyb *ckdev)
292 {
293         int row, col;
294         int row_shift = ckdev->row_shift;
295         unsigned short *keymap = ckdev->idev->keycode;
296         unsigned short code;
297
298         BUG_ON(ckdev->idev->keycodesize != sizeof(*keymap));
299
300         for (col = 0; col < ckdev->cols; col++) {
301                 for (row = 0; row < ckdev->rows; row++) {
302                         code = keymap[MATRIX_SCAN_CODE(row, col, row_shift)];
303                         if (code && (code != KEY_BATTERY))
304                                 ckdev->valid_keys[col] |= 1 << row;
305                 }
306                 dev_dbg(ckdev->dev, "valid_keys[%02d] = 0x%02x\n",
307                         col, ckdev->valid_keys[col]);
308         }
309 }
310
311 /**
312  * cros_ec_keyb_info - Wrap the EC command EC_CMD_MKBP_INFO
313  *
314  * This wraps the EC_CMD_MKBP_INFO, abstracting out all of the marshalling and
315  * unmarshalling and different version nonsense into something simple.
316  *
317  * @ec_dev: The EC device
318  * @info_type: Either EC_MKBP_INFO_SUPPORTED or EC_MKBP_INFO_CURRENT.
319  * @event_type: Either EC_MKBP_EVENT_BUTTON or EC_MKBP_EVENT_SWITCH.  Actually
320  *              in some cases this could be EC_MKBP_EVENT_KEY_MATRIX or
321  *              EC_MKBP_EVENT_HOST_EVENT too but we don't use in this driver.
322  * @result: Where we'll store the result; a union
323  * @result_size: The size of the result.  Expected to be the size of one of
324  *               the elements in the union.
325  *
326  * Returns 0 if no error or -error upon error.
327  */
328 static int cros_ec_keyb_info(struct cros_ec_device *ec_dev,
329                              enum ec_mkbp_info_type info_type,
330                              enum ec_mkbp_event event_type,
331                              union ec_response_get_next_data *result,
332                              size_t result_size)
333 {
334         struct ec_params_mkbp_info *params;
335         struct cros_ec_command *msg;
336         int ret;
337
338         msg = kzalloc(sizeof(*msg) + max_t(size_t, result_size,
339                                            sizeof(*params)), GFP_KERNEL);
340         if (!msg)
341                 return -ENOMEM;
342
343         msg->command = EC_CMD_MKBP_INFO;
344         msg->version = 1;
345         msg->outsize = sizeof(*params);
346         msg->insize = result_size;
347         params = (struct ec_params_mkbp_info *)msg->data;
348         params->info_type = info_type;
349         params->event_type = event_type;
350
351         ret = cros_ec_cmd_xfer(ec_dev, msg);
352         if (ret < 0) {
353                 dev_warn(ec_dev->dev, "Transfer error %d/%d: %d\n",
354                          (int)info_type, (int)event_type, ret);
355         } else if (msg->result == EC_RES_INVALID_VERSION) {
356                 /* With older ECs we just return 0 for everything */
357                 memset(result, 0, result_size);
358                 ret = 0;
359         } else if (msg->result != EC_RES_SUCCESS) {
360                 dev_warn(ec_dev->dev, "Error getting info %d/%d: %d\n",
361                          (int)info_type, (int)event_type, msg->result);
362                 ret = -EPROTO;
363         } else if (ret != result_size) {
364                 dev_warn(ec_dev->dev, "Wrong size %d/%d: %d != %zu\n",
365                          (int)info_type, (int)event_type,
366                          ret, result_size);
367                 ret = -EPROTO;
368         } else {
369                 memcpy(result, msg->data, result_size);
370                 ret = 0;
371         }
372
373         kfree(msg);
374
375         return ret;
376 }
377
378 /**
379  * cros_ec_keyb_query_switches - Query the state of switches and report
380  *
381  * This will ask the EC about the current state of switches and report to the
382  * kernel.  Note that we don't query for buttons because they are more
383  * transitory and we'll get an update on the next release / press.
384  *
385  * @ckdev: The keyboard device
386  *
387  * Returns 0 if no error or -error upon error.
388  */
389 static int cros_ec_keyb_query_switches(struct cros_ec_keyb *ckdev)
390 {
391         struct cros_ec_device *ec_dev = ckdev->ec;
392         union ec_response_get_next_data event_data = {};
393         int ret;
394
395         ret = cros_ec_keyb_info(ec_dev, EC_MKBP_INFO_CURRENT,
396                                 EC_MKBP_EVENT_SWITCH, &event_data,
397                                 sizeof(event_data.switches));
398         if (ret)
399                 return ret;
400
401         cros_ec_keyb_report_bs(ckdev, EV_SW,
402                                get_unaligned_le32(&event_data.switches));
403
404         return 0;
405 }
406
407 /**
408  * cros_ec_keyb_resume - Resume the keyboard
409  *
410  * We use the resume notification as a chance to query the EC for switches.
411  *
412  * @dev: The keyboard device
413  *
414  * Returns 0 if no error or -error upon error.
415  */
416 static __maybe_unused int cros_ec_keyb_resume(struct device *dev)
417 {
418         struct cros_ec_keyb *ckdev = dev_get_drvdata(dev);
419
420         if (ckdev->bs_idev)
421                 return cros_ec_keyb_query_switches(ckdev);
422
423         return 0;
424 }
425
426 /**
427  * cros_ec_keyb_register_bs - Register non-matrix buttons/switches
428  *
429  * Handles all the bits of the keyboard driver related to non-matrix buttons
430  * and switches, including asking the EC about which are present and telling
431  * the kernel to expect them.
432  *
433  * If this device has no support for buttons and switches we'll return no error
434  * but the ckdev->bs_idev will remain NULL when this function exits.
435  *
436  * @ckdev: The keyboard device
437  *
438  * Returns 0 if no error or -error upon error.
439  */
440 static int cros_ec_keyb_register_bs(struct cros_ec_keyb *ckdev)
441 {
442         struct cros_ec_device *ec_dev = ckdev->ec;
443         struct device *dev = ckdev->dev;
444         struct input_dev *idev;
445         union ec_response_get_next_data event_data = {};
446         const char *phys;
447         u32 buttons;
448         u32 switches;
449         int ret;
450         int i;
451
452         ret = cros_ec_keyb_info(ec_dev, EC_MKBP_INFO_SUPPORTED,
453                                 EC_MKBP_EVENT_BUTTON, &event_data,
454                                 sizeof(event_data.buttons));
455         if (ret)
456                 return ret;
457         buttons = get_unaligned_le32(&event_data.buttons);
458
459         ret = cros_ec_keyb_info(ec_dev, EC_MKBP_INFO_SUPPORTED,
460                                 EC_MKBP_EVENT_SWITCH, &event_data,
461                                 sizeof(event_data.switches));
462         if (ret)
463                 return ret;
464         switches = get_unaligned_le32(&event_data.switches);
465
466         if (!buttons && !switches)
467                 return 0;
468
469         /*
470          * We call the non-matrix buttons/switches 'input1', if present.
471          * Allocate phys before input dev, to ensure correct tear-down
472          * ordering.
473          */
474         phys = devm_kasprintf(dev, GFP_KERNEL, "%s/input1", ec_dev->phys_name);
475         if (!phys)
476                 return -ENOMEM;
477
478         idev = devm_input_allocate_device(dev);
479         if (!idev)
480                 return -ENOMEM;
481
482         idev->name = "cros_ec_buttons";
483         idev->phys = phys;
484         __set_bit(EV_REP, idev->evbit);
485
486         idev->id.bustype = BUS_VIRTUAL;
487         idev->id.version = 1;
488         idev->id.product = 0;
489         idev->dev.parent = dev;
490
491         input_set_drvdata(idev, ckdev);
492         ckdev->bs_idev = idev;
493
494         for (i = 0; i < ARRAY_SIZE(cros_ec_keyb_bs); i++) {
495                 const struct cros_ec_bs_map *map = &cros_ec_keyb_bs[i];
496
497                 if ((map->ev_type == EV_KEY && (buttons & BIT(map->bit))) ||
498                     (map->ev_type == EV_SW && (switches & BIT(map->bit))))
499                         input_set_capability(idev, map->ev_type, map->code);
500         }
501
502         ret = cros_ec_keyb_query_switches(ckdev);
503         if (ret) {
504                 dev_err(dev, "cannot query switches\n");
505                 return ret;
506         }
507
508         ret = input_register_device(ckdev->bs_idev);
509         if (ret) {
510                 dev_err(dev, "cannot register input device\n");
511                 return ret;
512         }
513
514         return 0;
515 }
516
517 /**
518  * cros_ec_keyb_register_bs - Register matrix keys
519  *
520  * Handles all the bits of the keyboard driver related to matrix keys.
521  *
522  * @ckdev: The keyboard device
523  *
524  * Returns 0 if no error or -error upon error.
525  */
526 static int cros_ec_keyb_register_matrix(struct cros_ec_keyb *ckdev)
527 {
528         struct cros_ec_device *ec_dev = ckdev->ec;
529         struct device *dev = ckdev->dev;
530         struct input_dev *idev;
531         const char *phys;
532         int err;
533
534         err = matrix_keypad_parse_properties(dev, &ckdev->rows, &ckdev->cols);
535         if (err)
536                 return err;
537
538         ckdev->valid_keys = devm_kzalloc(dev, ckdev->cols, GFP_KERNEL);
539         if (!ckdev->valid_keys)
540                 return -ENOMEM;
541
542         ckdev->old_kb_state = devm_kzalloc(dev, ckdev->cols, GFP_KERNEL);
543         if (!ckdev->old_kb_state)
544                 return -ENOMEM;
545
546         /*
547          * We call the keyboard matrix 'input0'. Allocate phys before input
548          * dev, to ensure correct tear-down ordering.
549          */
550         phys = devm_kasprintf(dev, GFP_KERNEL, "%s/input0", ec_dev->phys_name);
551         if (!phys)
552                 return -ENOMEM;
553
554         idev = devm_input_allocate_device(dev);
555         if (!idev)
556                 return -ENOMEM;
557
558         idev->name = CROS_EC_DEV_NAME;
559         idev->phys = phys;
560         __set_bit(EV_REP, idev->evbit);
561
562         idev->id.bustype = BUS_VIRTUAL;
563         idev->id.version = 1;
564         idev->id.product = 0;
565         idev->dev.parent = dev;
566
567         ckdev->ghost_filter = of_property_read_bool(dev->of_node,
568                                         "google,needs-ghost-filter");
569
570         err = matrix_keypad_build_keymap(NULL, NULL, ckdev->rows, ckdev->cols,
571                                          NULL, idev);
572         if (err) {
573                 dev_err(dev, "cannot build key matrix\n");
574                 return err;
575         }
576
577         ckdev->row_shift = get_count_order(ckdev->cols);
578
579         input_set_capability(idev, EV_MSC, MSC_SCAN);
580         input_set_drvdata(idev, ckdev);
581         ckdev->idev = idev;
582         cros_ec_keyb_compute_valid_keys(ckdev);
583
584         err = input_register_device(ckdev->idev);
585         if (err) {
586                 dev_err(dev, "cannot register input device\n");
587                 return err;
588         }
589
590         return 0;
591 }
592
593 static int cros_ec_keyb_probe(struct platform_device *pdev)
594 {
595         struct cros_ec_device *ec = dev_get_drvdata(pdev->dev.parent);
596         struct device *dev = &pdev->dev;
597         struct cros_ec_keyb *ckdev;
598         int err;
599
600         if (!dev->of_node)
601                 return -ENODEV;
602
603         ckdev = devm_kzalloc(dev, sizeof(*ckdev), GFP_KERNEL);
604         if (!ckdev)
605                 return -ENOMEM;
606
607         ckdev->ec = ec;
608         ckdev->dev = dev;
609         dev_set_drvdata(dev, ckdev);
610
611         err = cros_ec_keyb_register_matrix(ckdev);
612         if (err) {
613                 dev_err(dev, "cannot register matrix inputs: %d\n", err);
614                 return err;
615         }
616
617         err = cros_ec_keyb_register_bs(ckdev);
618         if (err) {
619                 dev_err(dev, "cannot register non-matrix inputs: %d\n", err);
620                 return err;
621         }
622
623         ckdev->notifier.notifier_call = cros_ec_keyb_work;
624         err = blocking_notifier_chain_register(&ckdev->ec->event_notifier,
625                                                &ckdev->notifier);
626         if (err) {
627                 dev_err(dev, "cannot register notifier: %d\n", err);
628                 return err;
629         }
630
631         device_init_wakeup(ckdev->dev, true);
632         return 0;
633 }
634
635 static int cros_ec_keyb_remove(struct platform_device *pdev)
636 {
637         struct cros_ec_keyb *ckdev = dev_get_drvdata(&pdev->dev);
638
639         blocking_notifier_chain_unregister(&ckdev->ec->event_notifier,
640                                            &ckdev->notifier);
641
642         return 0;
643 }
644
645 #ifdef CONFIG_OF
646 static const struct of_device_id cros_ec_keyb_of_match[] = {
647         { .compatible = "google,cros-ec-keyb" },
648         {},
649 };
650 MODULE_DEVICE_TABLE(of, cros_ec_keyb_of_match);
651 #endif
652
653 static SIMPLE_DEV_PM_OPS(cros_ec_keyb_pm_ops, NULL, cros_ec_keyb_resume);
654
655 static struct platform_driver cros_ec_keyb_driver = {
656         .probe = cros_ec_keyb_probe,
657         .remove = cros_ec_keyb_remove,
658         .driver = {
659                 .name = "cros-ec-keyb",
660                 .of_match_table = of_match_ptr(cros_ec_keyb_of_match),
661                 .pm = &cros_ec_keyb_pm_ops,
662         },
663 };
664
665 module_platform_driver(cros_ec_keyb_driver);
666
667 MODULE_LICENSE("GPL v2");
668 MODULE_DESCRIPTION("ChromeOS EC keyboard driver");
669 MODULE_ALIAS("platform:cros-ec-keyb");