2 * Driver for keys on GPIO lines capable of generating interrupts.
4 * Copyright 2005 Phil Blundell
5 * Copyright 2010, 2011 David Jander <david@protonic.nl>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
12 #include <linux/module.h>
14 #include <linux/init.h>
16 #include <linux/interrupt.h>
17 #include <linux/irq.h>
18 #include <linux/sched.h>
20 #include <linux/slab.h>
21 #include <linux/sysctl.h>
22 #include <linux/proc_fs.h>
23 #include <linux/delay.h>
24 #include <linux/platform_device.h>
25 #include <linux/input.h>
26 #include <linux/gpio_keys.h>
27 #include <linux/workqueue.h>
28 #include <linux/gpio.h>
30 #include <linux/of_platform.h>
31 #include <linux/of_gpio.h>
32 #include <linux/of_irq.h>
33 #include <linux/spinlock.h>
35 struct gpio_button_data
{
36 const struct gpio_keys_button
*button
;
37 struct input_dev
*input
;
39 struct timer_list release_timer
;
40 unsigned int release_delay
; /* in msecs, for IRQ-only buttons */
42 struct delayed_work work
;
43 unsigned int software_debounce
; /* in msecs, for GPIO-driven buttons */
51 struct gpio_keys_drvdata
{
52 const struct gpio_keys_platform_data
*pdata
;
53 struct input_dev
*input
;
54 struct mutex disable_lock
;
55 struct gpio_button_data data
[0];
59 * SYSFS interface for enabling/disabling keys and switches:
61 * There are 4 attributes under /sys/devices/platform/gpio-keys/
62 * keys [ro] - bitmap of keys (EV_KEY) which can be
64 * switches [ro] - bitmap of switches (EV_SW) which can be
66 * disabled_keys [rw] - bitmap of keys currently disabled
67 * disabled_switches [rw] - bitmap of switches currently disabled
69 * Userland can change these values and hence disable event generation
70 * for each key (or switch). Disabling a key means its interrupt line
73 * For example, if we have following switches set up as gpio-keys:
75 * SW_CAMERA_LENS_COVER = 9
76 * SW_KEYPAD_SLIDE = 10
77 * SW_FRONT_PROXIMITY = 11
78 * This is read from switches:
80 * Next we want to disable proximity (11) and dock (5), we write:
82 * to file disabled_switches. Now proximity and dock IRQs are disabled.
83 * This can be verified by reading the file disabled_switches:
85 * If we now want to enable proximity (11) switch we write:
87 * to disabled_switches.
89 * We can disable only those keys which don't allow sharing the irq.
93 * get_n_events_by_type() - returns maximum number of events per @type
94 * @type: type of button (%EV_KEY, %EV_SW)
96 * Return value of this function can be used to allocate bitmap
97 * large enough to hold all bits for given type.
99 static inline int get_n_events_by_type(int type
)
101 BUG_ON(type
!= EV_SW
&& type
!= EV_KEY
);
103 return (type
== EV_KEY
) ? KEY_CNT
: SW_CNT
;
107 * gpio_keys_disable_button() - disables given GPIO button
108 * @bdata: button data for button to be disabled
110 * Disables button pointed by @bdata. This is done by masking
111 * IRQ line. After this function is called, button won't generate
112 * input events anymore. Note that one can only disable buttons
113 * that don't share IRQs.
115 * Make sure that @bdata->disable_lock is locked when entering
116 * this function to avoid races when concurrent threads are
117 * disabling buttons at the same time.
119 static void gpio_keys_disable_button(struct gpio_button_data
*bdata
)
121 if (!bdata
->disabled
) {
123 * Disable IRQ and associated timer/work structure.
125 disable_irq(bdata
->irq
);
127 if (gpio_is_valid(bdata
->button
->gpio
))
128 cancel_delayed_work_sync(&bdata
->work
);
130 del_timer_sync(&bdata
->release_timer
);
132 bdata
->disabled
= true;
137 * gpio_keys_enable_button() - enables given GPIO button
138 * @bdata: button data for button to be disabled
140 * Enables given button pointed by @bdata.
142 * Make sure that @bdata->disable_lock is locked when entering
143 * this function to avoid races with concurrent threads trying
144 * to enable the same button at the same time.
146 static void gpio_keys_enable_button(struct gpio_button_data
*bdata
)
148 if (bdata
->disabled
) {
149 enable_irq(bdata
->irq
);
150 bdata
->disabled
= false;
155 * gpio_keys_attr_show_helper() - fill in stringified bitmap of buttons
156 * @ddata: pointer to drvdata
157 * @buf: buffer where stringified bitmap is written
158 * @type: button type (%EV_KEY, %EV_SW)
159 * @only_disabled: does caller want only those buttons that are
160 * currently disabled or all buttons that can be
163 * This function writes buttons that can be disabled to @buf. If
164 * @only_disabled is true, then @buf contains only those buttons
165 * that are currently disabled. Returns 0 on success or negative
168 static ssize_t
gpio_keys_attr_show_helper(struct gpio_keys_drvdata
*ddata
,
169 char *buf
, unsigned int type
,
172 int n_events
= get_n_events_by_type(type
);
177 bits
= kcalloc(BITS_TO_LONGS(n_events
), sizeof(*bits
), GFP_KERNEL
);
181 for (i
= 0; i
< ddata
->pdata
->nbuttons
; i
++) {
182 struct gpio_button_data
*bdata
= &ddata
->data
[i
];
184 if (bdata
->button
->type
!= type
)
187 if (only_disabled
&& !bdata
->disabled
)
190 __set_bit(bdata
->button
->code
, bits
);
193 ret
= scnprintf(buf
, PAGE_SIZE
- 1, "%*pbl", n_events
, bits
);
203 * gpio_keys_attr_store_helper() - enable/disable buttons based on given bitmap
204 * @ddata: pointer to drvdata
205 * @buf: buffer from userspace that contains stringified bitmap
206 * @type: button type (%EV_KEY, %EV_SW)
208 * This function parses stringified bitmap from @buf and disables/enables
209 * GPIO buttons accordingly. Returns 0 on success and negative error
212 static ssize_t
gpio_keys_attr_store_helper(struct gpio_keys_drvdata
*ddata
,
213 const char *buf
, unsigned int type
)
215 int n_events
= get_n_events_by_type(type
);
220 bits
= kcalloc(BITS_TO_LONGS(n_events
), sizeof(*bits
), GFP_KERNEL
);
224 error
= bitmap_parselist(buf
, bits
, n_events
);
229 for (i
= 0; i
< ddata
->pdata
->nbuttons
; i
++) {
230 struct gpio_button_data
*bdata
= &ddata
->data
[i
];
232 if (bdata
->button
->type
!= type
)
235 if (test_bit(bdata
->button
->code
, bits
) &&
236 !bdata
->button
->can_disable
) {
242 mutex_lock(&ddata
->disable_lock
);
244 for (i
= 0; i
< ddata
->pdata
->nbuttons
; i
++) {
245 struct gpio_button_data
*bdata
= &ddata
->data
[i
];
247 if (bdata
->button
->type
!= type
)
250 if (test_bit(bdata
->button
->code
, bits
))
251 gpio_keys_disable_button(bdata
);
253 gpio_keys_enable_button(bdata
);
256 mutex_unlock(&ddata
->disable_lock
);
263 #define ATTR_SHOW_FN(name, type, only_disabled) \
264 static ssize_t gpio_keys_show_##name(struct device *dev, \
265 struct device_attribute *attr, \
268 struct platform_device *pdev = to_platform_device(dev); \
269 struct gpio_keys_drvdata *ddata = platform_get_drvdata(pdev); \
271 return gpio_keys_attr_show_helper(ddata, buf, \
272 type, only_disabled); \
275 ATTR_SHOW_FN(keys
, EV_KEY
, false);
276 ATTR_SHOW_FN(switches
, EV_SW
, false);
277 ATTR_SHOW_FN(disabled_keys
, EV_KEY
, true);
278 ATTR_SHOW_FN(disabled_switches
, EV_SW
, true);
283 * /sys/devices/platform/gpio-keys/keys [ro]
284 * /sys/devices/platform/gpio-keys/switches [ro]
286 static DEVICE_ATTR(keys
, S_IRUGO
, gpio_keys_show_keys
, NULL
);
287 static DEVICE_ATTR(switches
, S_IRUGO
, gpio_keys_show_switches
, NULL
);
289 #define ATTR_STORE_FN(name, type) \
290 static ssize_t gpio_keys_store_##name(struct device *dev, \
291 struct device_attribute *attr, \
295 struct platform_device *pdev = to_platform_device(dev); \
296 struct gpio_keys_drvdata *ddata = platform_get_drvdata(pdev); \
299 error = gpio_keys_attr_store_helper(ddata, buf, type); \
306 ATTR_STORE_FN(disabled_keys
, EV_KEY
);
307 ATTR_STORE_FN(disabled_switches
, EV_SW
);
312 * /sys/devices/platform/gpio-keys/disabled_keys [rw]
313 * /sys/devices/platform/gpio-keys/disables_switches [rw]
315 static DEVICE_ATTR(disabled_keys
, S_IWUSR
| S_IRUGO
,
316 gpio_keys_show_disabled_keys
,
317 gpio_keys_store_disabled_keys
);
318 static DEVICE_ATTR(disabled_switches
, S_IWUSR
| S_IRUGO
,
319 gpio_keys_show_disabled_switches
,
320 gpio_keys_store_disabled_switches
);
322 static struct attribute
*gpio_keys_attrs
[] = {
324 &dev_attr_switches
.attr
,
325 &dev_attr_disabled_keys
.attr
,
326 &dev_attr_disabled_switches
.attr
,
330 static struct attribute_group gpio_keys_attr_group
= {
331 .attrs
= gpio_keys_attrs
,
334 static void gpio_keys_gpio_report_event(struct gpio_button_data
*bdata
)
336 const struct gpio_keys_button
*button
= bdata
->button
;
337 struct input_dev
*input
= bdata
->input
;
338 unsigned int type
= button
->type
?: EV_KEY
;
339 int state
= (gpio_get_value_cansleep(button
->gpio
) ? 1 : 0) ^ button
->active_low
;
341 if (type
== EV_ABS
) {
343 input_event(input
, type
, button
->code
, button
->value
);
345 input_event(input
, type
, button
->code
, !!state
);
350 static void gpio_keys_gpio_work_func(struct work_struct
*work
)
352 struct gpio_button_data
*bdata
=
353 container_of(work
, struct gpio_button_data
, work
.work
);
355 gpio_keys_gpio_report_event(bdata
);
357 if (bdata
->button
->wakeup
)
358 pm_relax(bdata
->input
->dev
.parent
);
361 static irqreturn_t
gpio_keys_gpio_isr(int irq
, void *dev_id
)
363 struct gpio_button_data
*bdata
= dev_id
;
365 BUG_ON(irq
!= bdata
->irq
);
367 if (bdata
->button
->wakeup
)
368 pm_stay_awake(bdata
->input
->dev
.parent
);
370 mod_delayed_work(system_wq
,
372 msecs_to_jiffies(bdata
->software_debounce
));
377 static void gpio_keys_irq_timer(unsigned long _data
)
379 struct gpio_button_data
*bdata
= (struct gpio_button_data
*)_data
;
380 struct input_dev
*input
= bdata
->input
;
383 spin_lock_irqsave(&bdata
->lock
, flags
);
384 if (bdata
->key_pressed
) {
385 input_event(input
, EV_KEY
, bdata
->button
->code
, 0);
387 bdata
->key_pressed
= false;
389 spin_unlock_irqrestore(&bdata
->lock
, flags
);
392 static irqreturn_t
gpio_keys_irq_isr(int irq
, void *dev_id
)
394 struct gpio_button_data
*bdata
= dev_id
;
395 const struct gpio_keys_button
*button
= bdata
->button
;
396 struct input_dev
*input
= bdata
->input
;
399 BUG_ON(irq
!= bdata
->irq
);
401 spin_lock_irqsave(&bdata
->lock
, flags
);
403 if (!bdata
->key_pressed
) {
404 if (bdata
->button
->wakeup
)
405 pm_wakeup_event(bdata
->input
->dev
.parent
, 0);
407 input_event(input
, EV_KEY
, button
->code
, 1);
410 if (!bdata
->release_delay
) {
411 input_event(input
, EV_KEY
, button
->code
, 0);
416 bdata
->key_pressed
= true;
419 if (bdata
->release_delay
)
420 mod_timer(&bdata
->release_timer
,
421 jiffies
+ msecs_to_jiffies(bdata
->release_delay
));
423 spin_unlock_irqrestore(&bdata
->lock
, flags
);
427 static void gpio_keys_quiesce_key(void *data
)
429 struct gpio_button_data
*bdata
= data
;
431 if (gpio_is_valid(bdata
->button
->gpio
))
432 cancel_delayed_work_sync(&bdata
->work
);
434 del_timer_sync(&bdata
->release_timer
);
437 static int gpio_keys_setup_key(struct platform_device
*pdev
,
438 struct input_dev
*input
,
439 struct gpio_button_data
*bdata
,
440 const struct gpio_keys_button
*button
)
442 const char *desc
= button
->desc
? button
->desc
: "gpio_keys";
443 struct device
*dev
= &pdev
->dev
;
445 unsigned long irqflags
;
449 bdata
->input
= input
;
450 bdata
->button
= button
;
451 spin_lock_init(&bdata
->lock
);
453 if (gpio_is_valid(button
->gpio
)) {
455 error
= devm_gpio_request_one(&pdev
->dev
, button
->gpio
,
458 dev_err(dev
, "Failed to request GPIO %d, error %d\n",
459 button
->gpio
, error
);
463 if (button
->debounce_interval
) {
464 error
= gpio_set_debounce(button
->gpio
,
465 button
->debounce_interval
* 1000);
466 /* use timer if gpiolib doesn't provide debounce */
468 bdata
->software_debounce
=
469 button
->debounce_interval
;
473 bdata
->irq
= button
->irq
;
475 irq
= gpio_to_irq(button
->gpio
);
479 "Unable to get irq number for GPIO %d, error %d\n",
480 button
->gpio
, error
);
486 INIT_DELAYED_WORK(&bdata
->work
, gpio_keys_gpio_work_func
);
488 isr
= gpio_keys_gpio_isr
;
489 irqflags
= IRQF_TRIGGER_RISING
| IRQF_TRIGGER_FALLING
;
493 dev_err(dev
, "No IRQ specified\n");
496 bdata
->irq
= button
->irq
;
498 if (button
->type
&& button
->type
!= EV_KEY
) {
499 dev_err(dev
, "Only EV_KEY allowed for IRQ buttons.\n");
503 bdata
->release_delay
= button
->debounce_interval
;
504 setup_timer(&bdata
->release_timer
,
505 gpio_keys_irq_timer
, (unsigned long)bdata
);
507 isr
= gpio_keys_irq_isr
;
511 input_set_capability(input
, button
->type
?: EV_KEY
, button
->code
);
514 * Install custom action to cancel release timer and
517 error
= devm_add_action(&pdev
->dev
, gpio_keys_quiesce_key
, bdata
);
520 "failed to register quiesce action, error: %d\n",
526 * If platform has specified that the button can be disabled,
527 * we don't want it to share the interrupt line.
529 if (!button
->can_disable
)
530 irqflags
|= IRQF_SHARED
;
532 error
= devm_request_any_context_irq(&pdev
->dev
, bdata
->irq
,
533 isr
, irqflags
, desc
, bdata
);
535 dev_err(dev
, "Unable to claim irq %d; error %d\n",
543 static void gpio_keys_report_state(struct gpio_keys_drvdata
*ddata
)
545 struct input_dev
*input
= ddata
->input
;
548 for (i
= 0; i
< ddata
->pdata
->nbuttons
; i
++) {
549 struct gpio_button_data
*bdata
= &ddata
->data
[i
];
550 if (gpio_is_valid(bdata
->button
->gpio
))
551 gpio_keys_gpio_report_event(bdata
);
556 static int gpio_keys_open(struct input_dev
*input
)
558 struct gpio_keys_drvdata
*ddata
= input_get_drvdata(input
);
559 const struct gpio_keys_platform_data
*pdata
= ddata
->pdata
;
563 error
= pdata
->enable(input
->dev
.parent
);
568 /* Report current state of buttons that are connected to GPIOs */
569 gpio_keys_report_state(ddata
);
574 static void gpio_keys_close(struct input_dev
*input
)
576 struct gpio_keys_drvdata
*ddata
= input_get_drvdata(input
);
577 const struct gpio_keys_platform_data
*pdata
= ddata
->pdata
;
580 pdata
->disable(input
->dev
.parent
);
584 * Handlers for alternative sources of platform_data
589 * Translate OpenFirmware node properties into platform_data
591 static struct gpio_keys_platform_data
*
592 gpio_keys_get_devtree_pdata(struct device
*dev
)
594 struct device_node
*node
, *pp
;
595 struct gpio_keys_platform_data
*pdata
;
596 struct gpio_keys_button
*button
;
603 return ERR_PTR(-ENODEV
);
605 nbuttons
= of_get_child_count(node
);
607 return ERR_PTR(-ENODEV
);
609 pdata
= devm_kzalloc(dev
,
610 sizeof(*pdata
) + nbuttons
* sizeof(*button
),
613 return ERR_PTR(-ENOMEM
);
615 pdata
->buttons
= (struct gpio_keys_button
*)(pdata
+ 1);
616 pdata
->nbuttons
= nbuttons
;
618 pdata
->rep
= !!of_get_property(node
, "autorepeat", NULL
);
621 for_each_child_of_node(node
, pp
) {
622 enum of_gpio_flags flags
;
624 button
= &pdata
->buttons
[i
++];
626 button
->gpio
= of_get_gpio_flags(pp
, 0, &flags
);
627 if (button
->gpio
< 0) {
628 error
= button
->gpio
;
629 if (error
!= -ENOENT
) {
630 if (error
!= -EPROBE_DEFER
)
632 "Failed to get gpio flags, error: %d\n",
634 return ERR_PTR(error
);
637 button
->active_low
= flags
& OF_GPIO_ACTIVE_LOW
;
640 button
->irq
= irq_of_parse_and_map(pp
, 0);
642 if (!gpio_is_valid(button
->gpio
) && !button
->irq
) {
643 dev_err(dev
, "Found button without gpios or irqs\n");
644 return ERR_PTR(-EINVAL
);
647 if (of_property_read_u32(pp
, "linux,code", &button
->code
)) {
648 dev_err(dev
, "Button without keycode: 0x%x\n",
650 return ERR_PTR(-EINVAL
);
653 button
->desc
= of_get_property(pp
, "label", NULL
);
655 if (of_property_read_u32(pp
, "linux,input-type", &button
->type
))
656 button
->type
= EV_KEY
;
658 button
->wakeup
= !!of_get_property(pp
, "gpio-key,wakeup", NULL
);
660 button
->can_disable
= !!of_get_property(pp
, "linux,can-disable", NULL
);
662 if (of_property_read_u32(pp
, "debounce-interval",
663 &button
->debounce_interval
))
664 button
->debounce_interval
= 5;
667 if (pdata
->nbuttons
== 0)
668 return ERR_PTR(-EINVAL
);
673 static const struct of_device_id gpio_keys_of_match
[] = {
674 { .compatible
= "gpio-keys", },
677 MODULE_DEVICE_TABLE(of
, gpio_keys_of_match
);
681 static inline struct gpio_keys_platform_data
*
682 gpio_keys_get_devtree_pdata(struct device
*dev
)
684 return ERR_PTR(-ENODEV
);
689 static int gpio_keys_probe(struct platform_device
*pdev
)
691 struct device
*dev
= &pdev
->dev
;
692 const struct gpio_keys_platform_data
*pdata
= dev_get_platdata(dev
);
693 struct gpio_keys_drvdata
*ddata
;
694 struct input_dev
*input
;
700 pdata
= gpio_keys_get_devtree_pdata(dev
);
702 return PTR_ERR(pdata
);
705 size
= sizeof(struct gpio_keys_drvdata
) +
706 pdata
->nbuttons
* sizeof(struct gpio_button_data
);
707 ddata
= devm_kzalloc(dev
, size
, GFP_KERNEL
);
709 dev_err(dev
, "failed to allocate state\n");
713 input
= devm_input_allocate_device(dev
);
715 dev_err(dev
, "failed to allocate input device\n");
719 ddata
->pdata
= pdata
;
720 ddata
->input
= input
;
721 mutex_init(&ddata
->disable_lock
);
723 platform_set_drvdata(pdev
, ddata
);
724 input_set_drvdata(input
, ddata
);
726 input
->name
= pdata
->name
? : pdev
->name
;
727 input
->phys
= "gpio-keys/input0";
728 input
->dev
.parent
= &pdev
->dev
;
729 input
->open
= gpio_keys_open
;
730 input
->close
= gpio_keys_close
;
732 input
->id
.bustype
= BUS_HOST
;
733 input
->id
.vendor
= 0x0001;
734 input
->id
.product
= 0x0001;
735 input
->id
.version
= 0x0100;
737 /* Enable auto repeat feature of Linux input subsystem */
739 __set_bit(EV_REP
, input
->evbit
);
741 for (i
= 0; i
< pdata
->nbuttons
; i
++) {
742 const struct gpio_keys_button
*button
= &pdata
->buttons
[i
];
743 struct gpio_button_data
*bdata
= &ddata
->data
[i
];
745 error
= gpio_keys_setup_key(pdev
, input
, bdata
, button
);
753 error
= sysfs_create_group(&pdev
->dev
.kobj
, &gpio_keys_attr_group
);
755 dev_err(dev
, "Unable to export keys/switches, error: %d\n",
760 error
= input_register_device(input
);
762 dev_err(dev
, "Unable to register input device, error: %d\n",
764 goto err_remove_group
;
767 device_init_wakeup(&pdev
->dev
, wakeup
);
772 sysfs_remove_group(&pdev
->dev
.kobj
, &gpio_keys_attr_group
);
776 static int gpio_keys_remove(struct platform_device
*pdev
)
778 sysfs_remove_group(&pdev
->dev
.kobj
, &gpio_keys_attr_group
);
780 device_init_wakeup(&pdev
->dev
, 0);
785 #ifdef CONFIG_PM_SLEEP
786 static int gpio_keys_suspend(struct device
*dev
)
788 struct gpio_keys_drvdata
*ddata
= dev_get_drvdata(dev
);
789 struct input_dev
*input
= ddata
->input
;
792 if (device_may_wakeup(dev
)) {
793 for (i
= 0; i
< ddata
->pdata
->nbuttons
; i
++) {
794 struct gpio_button_data
*bdata
= &ddata
->data
[i
];
795 if (bdata
->button
->wakeup
)
796 enable_irq_wake(bdata
->irq
);
799 mutex_lock(&input
->mutex
);
801 gpio_keys_close(input
);
802 mutex_unlock(&input
->mutex
);
808 static int gpio_keys_resume(struct device
*dev
)
810 struct gpio_keys_drvdata
*ddata
= dev_get_drvdata(dev
);
811 struct input_dev
*input
= ddata
->input
;
815 if (device_may_wakeup(dev
)) {
816 for (i
= 0; i
< ddata
->pdata
->nbuttons
; i
++) {
817 struct gpio_button_data
*bdata
= &ddata
->data
[i
];
818 if (bdata
->button
->wakeup
)
819 disable_irq_wake(bdata
->irq
);
822 mutex_lock(&input
->mutex
);
824 error
= gpio_keys_open(input
);
825 mutex_unlock(&input
->mutex
);
831 gpio_keys_report_state(ddata
);
836 static SIMPLE_DEV_PM_OPS(gpio_keys_pm_ops
, gpio_keys_suspend
, gpio_keys_resume
);
838 static struct platform_driver gpio_keys_device_driver
= {
839 .probe
= gpio_keys_probe
,
840 .remove
= gpio_keys_remove
,
843 .pm
= &gpio_keys_pm_ops
,
844 .of_match_table
= of_match_ptr(gpio_keys_of_match
),
848 static int __init
gpio_keys_init(void)
850 return platform_driver_register(&gpio_keys_device_driver
);
853 static void __exit
gpio_keys_exit(void)
855 platform_driver_unregister(&gpio_keys_device_driver
);
858 late_initcall(gpio_keys_init
);
859 module_exit(gpio_keys_exit
);
861 MODULE_LICENSE("GPL");
862 MODULE_AUTHOR("Phil Blundell <pb@handhelds.org>");
863 MODULE_DESCRIPTION("Keyboard driver for GPIOs");
864 MODULE_ALIAS("platform:gpio-keys");