Lines Matching +full:gpio +full:- +full:keymap
1 // SPDX-License-Identifier: GPL-2.0-only
3 * Driver for keys on GPIO lines capable of generating interrupts.
26 #include <linux/gpio.h>
27 #include <linux/gpio/consumer.h>
31 #include <dt-bindings/input/gpio-keys.h>
41 unsigned int release_delay; /* in msecs, for IRQ-only buttons */
45 unsigned int software_debounce; /* in msecs, for GPIO-driven buttons */
60 unsigned short *keymap; member
67 * There are 4 attributes under /sys/devices/platform/gpio-keys/
68 * keys [ro] - bitmap of keys (EV_KEY) which can be
70 * switches [ro] - bitmap of switches (EV_SW) which can be
72 * disabled_keys [rw] - bitmap of keys currently disabled
73 * disabled_switches [rw] - bitmap of switches currently disabled
79 * For example, if we have following switches set up as gpio-keys:
85 * 11-9,5
99 * get_n_events_by_type() - returns maximum number of events per @type
113 * get_bm_events_by_type() - returns bitmap of supported events per @type
125 return (type == EV_KEY) ? dev->keybit : dev->swbit; in get_bm_events_by_type()
132 if (!bdata->gpiod) in gpio_keys_quiesce_key()
133 hrtimer_cancel(&bdata->release_timer); in gpio_keys_quiesce_key()
134 else if (bdata->debounce_use_hrtimer) in gpio_keys_quiesce_key()
135 hrtimer_cancel(&bdata->debounce_timer); in gpio_keys_quiesce_key()
137 cancel_delayed_work_sync(&bdata->work); in gpio_keys_quiesce_key()
141 * gpio_keys_disable_button() - disables given GPIO button
149 * Make sure that @bdata->disable_lock is locked when entering
155 if (!bdata->disabled) { in gpio_keys_disable_button()
159 disable_irq(bdata->irq); in gpio_keys_disable_button()
161 bdata->disabled = true; in gpio_keys_disable_button()
166 * gpio_keys_enable_button() - enables given GPIO button
171 * Make sure that @bdata->disable_lock is locked when entering
177 if (bdata->disabled) { in gpio_keys_enable_button()
178 enable_irq(bdata->irq); in gpio_keys_enable_button()
179 bdata->disabled = false; in gpio_keys_enable_button()
184 * gpio_keys_attr_show_helper() - fill in stringified bitmap of buttons
208 return -ENOMEM; in gpio_keys_attr_show_helper()
210 for (i = 0; i < ddata->pdata->nbuttons; i++) { in gpio_keys_attr_show_helper()
211 struct gpio_button_data *bdata = &ddata->data[i]; in gpio_keys_attr_show_helper()
213 if (bdata->button->type != type) in gpio_keys_attr_show_helper()
216 if (only_disabled && !bdata->disabled) in gpio_keys_attr_show_helper()
219 __set_bit(*bdata->code, bits); in gpio_keys_attr_show_helper()
222 ret = scnprintf(buf, PAGE_SIZE - 1, "%*pbl", n_events, bits); in gpio_keys_attr_show_helper()
232 * gpio_keys_attr_store_helper() - enable/disable buttons based on given bitmap
238 * GPIO buttons accordingly. Returns 0 on success and negative error
245 const unsigned long *bitmap = get_bm_events_by_type(ddata->input, type); in gpio_keys_attr_store_helper()
252 return -ENOMEM; in gpio_keys_attr_store_helper()
260 error = -EINVAL; in gpio_keys_attr_store_helper()
264 for (i = 0; i < ddata->pdata->nbuttons; i++) { in gpio_keys_attr_store_helper()
265 struct gpio_button_data *bdata = &ddata->data[i]; in gpio_keys_attr_store_helper()
267 if (bdata->button->type != type) in gpio_keys_attr_store_helper()
270 if (test_bit(*bdata->code, bits) && in gpio_keys_attr_store_helper()
271 !bdata->button->can_disable) { in gpio_keys_attr_store_helper()
272 error = -EINVAL; in gpio_keys_attr_store_helper()
277 mutex_lock(&ddata->disable_lock); in gpio_keys_attr_store_helper()
279 for (i = 0; i < ddata->pdata->nbuttons; i++) { in gpio_keys_attr_store_helper()
280 struct gpio_button_data *bdata = &ddata->data[i]; in gpio_keys_attr_store_helper()
282 if (bdata->button->type != type) in gpio_keys_attr_store_helper()
285 if (test_bit(*bdata->code, bits)) in gpio_keys_attr_store_helper()
291 mutex_unlock(&ddata->disable_lock); in gpio_keys_attr_store_helper()
318 * /sys/devices/platform/gpio-keys/keys [ro]
319 * /sys/devices/platform/gpio-keys/switches [ro]
347 * /sys/devices/platform/gpio-keys/disabled_keys [rw]
348 * /sys/devices/platform/gpio-keys/disables_switches [rw]
368 const struct gpio_keys_button *button = bdata->button; in gpio_keys_gpio_report_event()
369 struct input_dev *input = bdata->input; in gpio_keys_gpio_report_event()
370 unsigned int type = button->type ?: EV_KEY; in gpio_keys_gpio_report_event()
373 state = bdata->debounce_use_hrtimer ? in gpio_keys_gpio_report_event()
374 gpiod_get_value(bdata->gpiod) : in gpio_keys_gpio_report_event()
375 gpiod_get_value_cansleep(bdata->gpiod); in gpio_keys_gpio_report_event()
377 dev_err(input->dev.parent, in gpio_keys_gpio_report_event()
378 "failed to get gpio state: %d\n", state); in gpio_keys_gpio_report_event()
384 input_event(input, type, button->code, button->value); in gpio_keys_gpio_report_event()
386 input_event(input, type, *bdata->code, state); in gpio_keys_gpio_report_event()
393 input_sync(bdata->input); in gpio_keys_debounce_event()
395 if (bdata->button->wakeup) in gpio_keys_debounce_event()
396 pm_relax(bdata->input->dev.parent); in gpio_keys_debounce_event()
421 BUG_ON(irq != bdata->irq); in gpio_keys_gpio_isr()
423 if (bdata->button->wakeup) { in gpio_keys_gpio_isr()
424 const struct gpio_keys_button *button = bdata->button; in gpio_keys_gpio_isr()
426 pm_stay_awake(bdata->input->dev.parent); in gpio_keys_gpio_isr()
427 if (bdata->suspended && in gpio_keys_gpio_isr()
428 (button->type == 0 || button->type == EV_KEY)) { in gpio_keys_gpio_isr()
434 input_report_key(bdata->input, button->code, 1); in gpio_keys_gpio_isr()
438 if (bdata->debounce_use_hrtimer) { in gpio_keys_gpio_isr()
439 hrtimer_start(&bdata->debounce_timer, in gpio_keys_gpio_isr()
440 ms_to_ktime(bdata->software_debounce), in gpio_keys_gpio_isr()
444 &bdata->work, in gpio_keys_gpio_isr()
445 msecs_to_jiffies(bdata->software_debounce)); in gpio_keys_gpio_isr()
456 struct input_dev *input = bdata->input; in gpio_keys_irq_timer()
458 guard(spinlock_irqsave)(&bdata->lock); in gpio_keys_irq_timer()
460 if (bdata->key_pressed) { in gpio_keys_irq_timer()
461 input_report_key(input, *bdata->code, 0); in gpio_keys_irq_timer()
463 bdata->key_pressed = false; in gpio_keys_irq_timer()
472 struct input_dev *input = bdata->input; in gpio_keys_irq_isr()
475 BUG_ON(irq != bdata->irq); in gpio_keys_irq_isr()
477 spin_lock_irqsave(&bdata->lock, flags); in gpio_keys_irq_isr()
479 if (!bdata->key_pressed) { in gpio_keys_irq_isr()
480 if (bdata->button->wakeup) in gpio_keys_irq_isr()
481 pm_wakeup_event(bdata->input->dev.parent, 0); in gpio_keys_irq_isr()
483 input_report_key(input, *bdata->code, 1); in gpio_keys_irq_isr()
486 if (!bdata->release_delay) { in gpio_keys_irq_isr()
487 input_report_key(input, *bdata->code, 0); in gpio_keys_irq_isr()
492 bdata->key_pressed = true; in gpio_keys_irq_isr()
495 if (bdata->release_delay) in gpio_keys_irq_isr()
496 hrtimer_start(&bdata->release_timer, in gpio_keys_irq_isr()
497 ms_to_ktime(bdata->release_delay), in gpio_keys_irq_isr()
500 spin_unlock_irqrestore(&bdata->lock, flags); in gpio_keys_irq_isr()
511 const char *desc = button->desc ? button->desc : "gpio_keys"; in gpio_keys_setup_key()
512 struct device *dev = &pdev->dev; in gpio_keys_setup_key()
513 struct gpio_button_data *bdata = &ddata->data[idx]; in gpio_keys_setup_key()
519 bdata->input = input; in gpio_keys_setup_key()
520 bdata->button = button; in gpio_keys_setup_key()
521 spin_lock_init(&bdata->lock); in gpio_keys_setup_key()
524 bdata->gpiod = devm_fwnode_gpiod_get(dev, child, in gpio_keys_setup_key()
526 if (IS_ERR(bdata->gpiod)) { in gpio_keys_setup_key()
527 error = PTR_ERR(bdata->gpiod); in gpio_keys_setup_key()
528 if (error != -ENOENT) in gpio_keys_setup_key()
530 "failed to get gpio\n"); in gpio_keys_setup_key()
533 * GPIO is optional, we may be dealing with in gpio_keys_setup_key()
534 * purely interrupt-driven setup. in gpio_keys_setup_key()
536 bdata->gpiod = NULL; in gpio_keys_setup_key()
538 } else if (gpio_is_valid(button->gpio)) { in gpio_keys_setup_key()
540 * Legacy GPIO number, so request the GPIO here and in gpio_keys_setup_key()
545 if (button->active_low) in gpio_keys_setup_key()
548 error = devm_gpio_request_one(dev, button->gpio, flags, desc); in gpio_keys_setup_key()
550 dev_err(dev, "Failed to request GPIO %d, error %d\n", in gpio_keys_setup_key()
551 button->gpio, error); in gpio_keys_setup_key()
555 bdata->gpiod = gpio_to_desc(button->gpio); in gpio_keys_setup_key()
556 if (!bdata->gpiod) in gpio_keys_setup_key()
557 return -EINVAL; in gpio_keys_setup_key()
560 if (bdata->gpiod) { in gpio_keys_setup_key()
561 bool active_low = gpiod_is_active_low(bdata->gpiod); in gpio_keys_setup_key()
563 if (button->debounce_interval) { in gpio_keys_setup_key()
564 error = gpiod_set_debounce(bdata->gpiod, in gpio_keys_setup_key()
565 button->debounce_interval * 1000); in gpio_keys_setup_key()
568 bdata->software_debounce = in gpio_keys_setup_key()
569 button->debounce_interval; in gpio_keys_setup_key()
572 * If reading the GPIO won't sleep, we can use a in gpio_keys_setup_key()
576 bdata->debounce_use_hrtimer = in gpio_keys_setup_key()
577 !gpiod_cansleep(bdata->gpiod); in gpio_keys_setup_key()
580 if (button->irq) { in gpio_keys_setup_key()
581 bdata->irq = button->irq; in gpio_keys_setup_key()
583 irq = gpiod_to_irq(bdata->gpiod); in gpio_keys_setup_key()
587 "Unable to get irq number for GPIO %d, error %d\n", in gpio_keys_setup_key()
588 button->gpio, error); in gpio_keys_setup_key()
591 bdata->irq = irq; in gpio_keys_setup_key()
594 INIT_DELAYED_WORK(&bdata->work, gpio_keys_gpio_work_func); in gpio_keys_setup_key()
596 hrtimer_init(&bdata->debounce_timer, in gpio_keys_setup_key()
598 bdata->debounce_timer.function = gpio_keys_debounce_timer; in gpio_keys_setup_key()
603 switch (button->wakeup_event_action) { in gpio_keys_setup_key()
605 bdata->wakeup_trigger_type = active_low ? in gpio_keys_setup_key()
609 bdata->wakeup_trigger_type = active_low ? in gpio_keys_setup_key()
621 if (!button->irq) { in gpio_keys_setup_key()
622 dev_err(dev, "Found button without gpio or irq\n"); in gpio_keys_setup_key()
623 return -EINVAL; in gpio_keys_setup_key()
626 bdata->irq = button->irq; in gpio_keys_setup_key()
628 if (button->type && button->type != EV_KEY) { in gpio_keys_setup_key()
630 return -EINVAL; in gpio_keys_setup_key()
633 bdata->release_delay = button->debounce_interval; in gpio_keys_setup_key()
634 hrtimer_init(&bdata->release_timer, in gpio_keys_setup_key()
636 bdata->release_timer.function = gpio_keys_irq_timer; in gpio_keys_setup_key()
647 bdata->code = &ddata->keymap[idx]; in gpio_keys_setup_key()
648 *bdata->code = button->code; in gpio_keys_setup_key()
649 input_set_capability(input, button->type ?: EV_KEY, *bdata->code); in gpio_keys_setup_key()
666 if (!button->can_disable) in gpio_keys_setup_key()
669 error = devm_request_any_context_irq(dev, bdata->irq, isr, irqflags, in gpio_keys_setup_key()
673 bdata->irq, error); in gpio_keys_setup_key()
682 struct input_dev *input = ddata->input; in gpio_keys_report_state()
685 for (i = 0; i < ddata->pdata->nbuttons; i++) { in gpio_keys_report_state()
686 struct gpio_button_data *bdata = &ddata->data[i]; in gpio_keys_report_state()
687 if (bdata->gpiod) in gpio_keys_report_state()
696 const struct gpio_keys_platform_data *pdata = ddata->pdata; in gpio_keys_open()
699 if (pdata->enable) { in gpio_keys_open()
700 error = pdata->enable(input->dev.parent); in gpio_keys_open()
714 const struct gpio_keys_platform_data *pdata = ddata->pdata; in gpio_keys_close()
716 if (pdata->disable) in gpio_keys_close()
717 pdata->disable(input->dev.parent); in gpio_keys_close()
737 return ERR_PTR(-ENODEV); in gpio_keys_get_devtree_pdata()
743 return ERR_PTR(-ENOMEM); in gpio_keys_get_devtree_pdata()
747 pdata->buttons = button; in gpio_keys_get_devtree_pdata()
748 pdata->nbuttons = nbuttons; in gpio_keys_get_devtree_pdata()
750 pdata->rep = device_property_read_bool(dev, "autorepeat"); in gpio_keys_get_devtree_pdata()
752 device_property_read_string(dev, "label", &pdata->name); in gpio_keys_get_devtree_pdata()
756 button->irq = in gpio_keys_get_devtree_pdata()
760 &button->code)) { in gpio_keys_get_devtree_pdata()
763 return ERR_PTR(-EINVAL); in gpio_keys_get_devtree_pdata()
766 fwnode_property_read_string(child, "label", &button->desc); in gpio_keys_get_devtree_pdata()
768 if (fwnode_property_read_u32(child, "linux,input-type", in gpio_keys_get_devtree_pdata()
769 &button->type)) in gpio_keys_get_devtree_pdata()
770 button->type = EV_KEY; in gpio_keys_get_devtree_pdata()
772 fwnode_property_read_u32(child, "linux,input-value", in gpio_keys_get_devtree_pdata()
773 (u32 *)&button->value); in gpio_keys_get_devtree_pdata()
775 button->wakeup = in gpio_keys_get_devtree_pdata()
776 fwnode_property_read_bool(child, "wakeup-source") || in gpio_keys_get_devtree_pdata()
778 fwnode_property_read_bool(child, "gpio-key,wakeup"); in gpio_keys_get_devtree_pdata()
780 fwnode_property_read_u32(child, "wakeup-event-action", in gpio_keys_get_devtree_pdata()
781 &button->wakeup_event_action); in gpio_keys_get_devtree_pdata()
783 button->can_disable = in gpio_keys_get_devtree_pdata()
784 fwnode_property_read_bool(child, "linux,can-disable"); in gpio_keys_get_devtree_pdata()
786 if (fwnode_property_read_u32(child, "debounce-interval", in gpio_keys_get_devtree_pdata()
787 &button->debounce_interval)) in gpio_keys_get_devtree_pdata()
788 button->debounce_interval = 5; in gpio_keys_get_devtree_pdata()
797 { .compatible = "gpio-keys", },
804 struct device *dev = &pdev->dev; in gpio_keys_probe()
818 ddata = devm_kzalloc(dev, struct_size(ddata, data, pdata->nbuttons), in gpio_keys_probe()
822 return -ENOMEM; in gpio_keys_probe()
825 ddata->keymap = devm_kcalloc(dev, in gpio_keys_probe()
826 pdata->nbuttons, sizeof(ddata->keymap[0]), in gpio_keys_probe()
828 if (!ddata->keymap) in gpio_keys_probe()
829 return -ENOMEM; in gpio_keys_probe()
834 return -ENOMEM; in gpio_keys_probe()
837 ddata->pdata = pdata; in gpio_keys_probe()
838 ddata->input = input; in gpio_keys_probe()
839 mutex_init(&ddata->disable_lock); in gpio_keys_probe()
844 input->name = pdata->name ? : pdev->name; in gpio_keys_probe()
845 input->phys = "gpio-keys/input0"; in gpio_keys_probe()
846 input->dev.parent = dev; in gpio_keys_probe()
847 input->open = gpio_keys_open; in gpio_keys_probe()
848 input->close = gpio_keys_close; in gpio_keys_probe()
850 input->id.bustype = BUS_HOST; in gpio_keys_probe()
851 input->id.vendor = 0x0001; in gpio_keys_probe()
852 input->id.product = 0x0001; in gpio_keys_probe()
853 input->id.version = 0x0100; in gpio_keys_probe()
855 input->keycode = ddata->keymap; in gpio_keys_probe()
856 input->keycodesize = sizeof(ddata->keymap[0]); in gpio_keys_probe()
857 input->keycodemax = pdata->nbuttons; in gpio_keys_probe()
860 if (pdata->rep) in gpio_keys_probe()
861 __set_bit(EV_REP, input->evbit); in gpio_keys_probe()
863 for (i = 0; i < pdata->nbuttons; i++) { in gpio_keys_probe()
864 const struct gpio_keys_button *button = &pdata->buttons[i]; in gpio_keys_probe()
872 return -EINVAL; in gpio_keys_probe()
883 if (button->wakeup) in gpio_keys_probe()
906 error = enable_irq_wake(bdata->irq); in gpio_keys_button_enable_wakeup()
908 dev_err(bdata->input->dev.parent, in gpio_keys_button_enable_wakeup()
910 bdata->irq, error); in gpio_keys_button_enable_wakeup()
914 if (bdata->wakeup_trigger_type) { in gpio_keys_button_enable_wakeup()
915 error = irq_set_irq_type(bdata->irq, in gpio_keys_button_enable_wakeup()
916 bdata->wakeup_trigger_type); in gpio_keys_button_enable_wakeup()
918 dev_err(bdata->input->dev.parent, in gpio_keys_button_enable_wakeup()
920 bdata->wakeup_trigger_type, bdata->irq, error); in gpio_keys_button_enable_wakeup()
921 disable_irq_wake(bdata->irq); in gpio_keys_button_enable_wakeup()
935 * The trigger type is always both edges for gpio-based keys and we do in gpio_keys_button_disable_wakeup()
936 * not support changing wakeup trigger for interrupt-based keys. in gpio_keys_button_disable_wakeup()
938 if (bdata->wakeup_trigger_type) { in gpio_keys_button_disable_wakeup()
939 error = irq_set_irq_type(bdata->irq, IRQ_TYPE_EDGE_BOTH); in gpio_keys_button_disable_wakeup()
941 dev_warn(bdata->input->dev.parent, in gpio_keys_button_disable_wakeup()
943 bdata->irq, error); in gpio_keys_button_disable_wakeup()
946 error = disable_irq_wake(bdata->irq); in gpio_keys_button_disable_wakeup()
948 dev_warn(bdata->input->dev.parent, in gpio_keys_button_disable_wakeup()
950 bdata->irq, error); in gpio_keys_button_disable_wakeup()
960 for (i = 0; i < ddata->pdata->nbuttons; i++) { in gpio_keys_enable_wakeup()
961 bdata = &ddata->data[i]; in gpio_keys_enable_wakeup()
962 if (bdata->button->wakeup) { in gpio_keys_enable_wakeup()
967 bdata->suspended = true; in gpio_keys_enable_wakeup()
973 while (i--) { in gpio_keys_enable_wakeup()
974 bdata = &ddata->data[i]; in gpio_keys_enable_wakeup()
975 if (bdata->button->wakeup) in gpio_keys_enable_wakeup()
977 bdata->suspended = false; in gpio_keys_enable_wakeup()
989 for (i = 0; i < ddata->pdata->nbuttons; i++) { in gpio_keys_disable_wakeup()
990 bdata = &ddata->data[i]; in gpio_keys_disable_wakeup()
991 bdata->suspended = false; in gpio_keys_disable_wakeup()
992 if (irqd_is_wakeup_set(irq_get_irq_data(bdata->irq))) in gpio_keys_disable_wakeup()
1000 struct input_dev *input = ddata->input; in gpio_keys_suspend()
1008 mutex_lock(&input->mutex); in gpio_keys_suspend()
1011 mutex_unlock(&input->mutex); in gpio_keys_suspend()
1020 struct input_dev *input = ddata->input; in gpio_keys_resume()
1026 mutex_lock(&input->mutex); in gpio_keys_resume()
1029 mutex_unlock(&input->mutex); in gpio_keys_resume()
1045 ret = gpio_keys_suspend(&pdev->dev); in gpio_keys_shutdown()
1047 dev_err(&pdev->dev, "failed to shutdown\n"); in gpio_keys_shutdown()
1054 .name = "gpio-keys",
1077 MODULE_ALIAS("platform:gpio-keys");