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
;
38 struct timer_list timer
;
39 struct work_struct work
;
40 unsigned int timer_debounce
; /* in msecs */
47 struct gpio_keys_drvdata
{
48 const struct gpio_keys_platform_data
*pdata
;
49 struct input_dev
*input
;
50 struct mutex disable_lock
;
51 struct gpio_button_data data
[0];
55 * SYSFS interface for enabling/disabling keys and switches:
57 * There are 4 attributes under /sys/devices/platform/gpio-keys/
58 * keys [ro] - bitmap of keys (EV_KEY) which can be
60 * switches [ro] - bitmap of switches (EV_SW) which can be
62 * disabled_keys [rw] - bitmap of keys currently disabled
63 * disabled_switches [rw] - bitmap of switches currently disabled
65 * Userland can change these values and hence disable event generation
66 * for each key (or switch). Disabling a key means its interrupt line
69 * For example, if we have following switches set up as gpio-keys:
71 * SW_CAMERA_LENS_COVER = 9
72 * SW_KEYPAD_SLIDE = 10
73 * SW_FRONT_PROXIMITY = 11
74 * This is read from switches:
76 * Next we want to disable proximity (11) and dock (5), we write:
78 * to file disabled_switches. Now proximity and dock IRQs are disabled.
79 * This can be verified by reading the file disabled_switches:
81 * If we now want to enable proximity (11) switch we write:
83 * to disabled_switches.
85 * We can disable only those keys which don't allow sharing the irq.
89 * get_n_events_by_type() - returns maximum number of events per @type
90 * @type: type of button (%EV_KEY, %EV_SW)
92 * Return value of this function can be used to allocate bitmap
93 * large enough to hold all bits for given type.
95 static inline int get_n_events_by_type(int type
)
97 BUG_ON(type
!= EV_SW
&& type
!= EV_KEY
);
99 return (type
== EV_KEY
) ? KEY_CNT
: SW_CNT
;
103 * gpio_keys_disable_button() - disables given GPIO button
104 * @bdata: button data for button to be disabled
106 * Disables button pointed by @bdata. This is done by masking
107 * IRQ line. After this function is called, button won't generate
108 * input events anymore. Note that one can only disable buttons
109 * that don't share IRQs.
111 * Make sure that @bdata->disable_lock is locked when entering
112 * this function to avoid races when concurrent threads are
113 * disabling buttons at the same time.
115 static void gpio_keys_disable_button(struct gpio_button_data
*bdata
)
117 if (!bdata
->disabled
) {
119 * Disable IRQ and possible debouncing timer.
121 disable_irq(bdata
->irq
);
122 if (bdata
->timer_debounce
)
123 del_timer_sync(&bdata
->timer
);
125 bdata
->disabled
= true;
130 * gpio_keys_enable_button() - enables given GPIO button
131 * @bdata: button data for button to be disabled
133 * Enables given button pointed by @bdata.
135 * Make sure that @bdata->disable_lock is locked when entering
136 * this function to avoid races with concurrent threads trying
137 * to enable the same button at the same time.
139 static void gpio_keys_enable_button(struct gpio_button_data
*bdata
)
141 if (bdata
->disabled
) {
142 enable_irq(bdata
->irq
);
143 bdata
->disabled
= false;
148 * gpio_keys_attr_show_helper() - fill in stringified bitmap of buttons
149 * @ddata: pointer to drvdata
150 * @buf: buffer where stringified bitmap is written
151 * @type: button type (%EV_KEY, %EV_SW)
152 * @only_disabled: does caller want only those buttons that are
153 * currently disabled or all buttons that can be
156 * This function writes buttons that can be disabled to @buf. If
157 * @only_disabled is true, then @buf contains only those buttons
158 * that are currently disabled. Returns 0 on success or negative
161 static ssize_t
gpio_keys_attr_show_helper(struct gpio_keys_drvdata
*ddata
,
162 char *buf
, unsigned int type
,
165 int n_events
= get_n_events_by_type(type
);
170 bits
= kcalloc(BITS_TO_LONGS(n_events
), sizeof(*bits
), GFP_KERNEL
);
174 for (i
= 0; i
< ddata
->pdata
->nbuttons
; i
++) {
175 struct gpio_button_data
*bdata
= &ddata
->data
[i
];
177 if (bdata
->button
->type
!= type
)
180 if (only_disabled
&& !bdata
->disabled
)
183 __set_bit(bdata
->button
->code
, bits
);
186 ret
= bitmap_scnlistprintf(buf
, PAGE_SIZE
- 2, bits
, n_events
);
196 * gpio_keys_attr_store_helper() - enable/disable buttons based on given bitmap
197 * @ddata: pointer to drvdata
198 * @buf: buffer from userspace that contains stringified bitmap
199 * @type: button type (%EV_KEY, %EV_SW)
201 * This function parses stringified bitmap from @buf and disables/enables
202 * GPIO buttons accordingly. Returns 0 on success and negative error
205 static ssize_t
gpio_keys_attr_store_helper(struct gpio_keys_drvdata
*ddata
,
206 const char *buf
, unsigned int type
)
208 int n_events
= get_n_events_by_type(type
);
213 bits
= kcalloc(BITS_TO_LONGS(n_events
), sizeof(*bits
), GFP_KERNEL
);
217 error
= bitmap_parselist(buf
, bits
, n_events
);
222 for (i
= 0; i
< ddata
->pdata
->nbuttons
; i
++) {
223 struct gpio_button_data
*bdata
= &ddata
->data
[i
];
225 if (bdata
->button
->type
!= type
)
228 if (test_bit(bdata
->button
->code
, bits
) &&
229 !bdata
->button
->can_disable
) {
235 mutex_lock(&ddata
->disable_lock
);
237 for (i
= 0; i
< ddata
->pdata
->nbuttons
; i
++) {
238 struct gpio_button_data
*bdata
= &ddata
->data
[i
];
240 if (bdata
->button
->type
!= type
)
243 if (test_bit(bdata
->button
->code
, bits
))
244 gpio_keys_disable_button(bdata
);
246 gpio_keys_enable_button(bdata
);
249 mutex_unlock(&ddata
->disable_lock
);
256 #define ATTR_SHOW_FN(name, type, only_disabled) \
257 static ssize_t gpio_keys_show_##name(struct device *dev, \
258 struct device_attribute *attr, \
261 struct platform_device *pdev = to_platform_device(dev); \
262 struct gpio_keys_drvdata *ddata = platform_get_drvdata(pdev); \
264 return gpio_keys_attr_show_helper(ddata, buf, \
265 type, only_disabled); \
268 ATTR_SHOW_FN(keys
, EV_KEY
, false);
269 ATTR_SHOW_FN(switches
, EV_SW
, false);
270 ATTR_SHOW_FN(disabled_keys
, EV_KEY
, true);
271 ATTR_SHOW_FN(disabled_switches
, EV_SW
, true);
276 * /sys/devices/platform/gpio-keys/keys [ro]
277 * /sys/devices/platform/gpio-keys/switches [ro]
279 static DEVICE_ATTR(keys
, S_IRUGO
, gpio_keys_show_keys
, NULL
);
280 static DEVICE_ATTR(switches
, S_IRUGO
, gpio_keys_show_switches
, NULL
);
282 #define ATTR_STORE_FN(name, type) \
283 static ssize_t gpio_keys_store_##name(struct device *dev, \
284 struct device_attribute *attr, \
288 struct platform_device *pdev = to_platform_device(dev); \
289 struct gpio_keys_drvdata *ddata = platform_get_drvdata(pdev); \
292 error = gpio_keys_attr_store_helper(ddata, buf, type); \
299 ATTR_STORE_FN(disabled_keys
, EV_KEY
);
300 ATTR_STORE_FN(disabled_switches
, EV_SW
);
305 * /sys/devices/platform/gpio-keys/disabled_keys [rw]
306 * /sys/devices/platform/gpio-keys/disables_switches [rw]
308 static DEVICE_ATTR(disabled_keys
, S_IWUSR
| S_IRUGO
,
309 gpio_keys_show_disabled_keys
,
310 gpio_keys_store_disabled_keys
);
311 static DEVICE_ATTR(disabled_switches
, S_IWUSR
| S_IRUGO
,
312 gpio_keys_show_disabled_switches
,
313 gpio_keys_store_disabled_switches
);
315 static struct attribute
*gpio_keys_attrs
[] = {
317 &dev_attr_switches
.attr
,
318 &dev_attr_disabled_keys
.attr
,
319 &dev_attr_disabled_switches
.attr
,
323 static struct attribute_group gpio_keys_attr_group
= {
324 .attrs
= gpio_keys_attrs
,
327 static void gpio_keys_gpio_report_event(struct gpio_button_data
*bdata
)
329 const struct gpio_keys_button
*button
= bdata
->button
;
330 struct input_dev
*input
= bdata
->input
;
331 unsigned int type
= button
->type
?: EV_KEY
;
332 int state
= (gpio_get_value_cansleep(button
->gpio
) ? 1 : 0) ^ button
->active_low
;
334 if (type
== EV_ABS
) {
336 input_event(input
, type
, button
->code
, button
->value
);
338 input_event(input
, type
, button
->code
, !!state
);
343 static void gpio_keys_gpio_work_func(struct work_struct
*work
)
345 struct gpio_button_data
*bdata
=
346 container_of(work
, struct gpio_button_data
, work
);
348 gpio_keys_gpio_report_event(bdata
);
350 if (bdata
->button
->wakeup
)
351 pm_relax(bdata
->input
->dev
.parent
);
354 static void gpio_keys_gpio_timer(unsigned long _data
)
356 struct gpio_button_data
*bdata
= (struct gpio_button_data
*)_data
;
358 schedule_work(&bdata
->work
);
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
);
369 if (bdata
->timer_debounce
)
370 mod_timer(&bdata
->timer
,
371 jiffies
+ msecs_to_jiffies(bdata
->timer_debounce
));
373 schedule_work(&bdata
->work
);
378 static void gpio_keys_irq_timer(unsigned long _data
)
380 struct gpio_button_data
*bdata
= (struct gpio_button_data
*)_data
;
381 struct input_dev
*input
= bdata
->input
;
384 spin_lock_irqsave(&bdata
->lock
, flags
);
385 if (bdata
->key_pressed
) {
386 input_event(input
, EV_KEY
, bdata
->button
->code
, 0);
388 bdata
->key_pressed
= false;
390 spin_unlock_irqrestore(&bdata
->lock
, flags
);
393 static irqreturn_t
gpio_keys_irq_isr(int irq
, void *dev_id
)
395 struct gpio_button_data
*bdata
= dev_id
;
396 const struct gpio_keys_button
*button
= bdata
->button
;
397 struct input_dev
*input
= bdata
->input
;
400 BUG_ON(irq
!= bdata
->irq
);
402 spin_lock_irqsave(&bdata
->lock
, flags
);
404 if (!bdata
->key_pressed
) {
405 if (bdata
->button
->wakeup
)
406 pm_wakeup_event(bdata
->input
->dev
.parent
, 0);
408 input_event(input
, EV_KEY
, button
->code
, 1);
411 if (!bdata
->timer_debounce
) {
412 input_event(input
, EV_KEY
, button
->code
, 0);
417 bdata
->key_pressed
= true;
420 if (bdata
->timer_debounce
)
421 mod_timer(&bdata
->timer
,
422 jiffies
+ msecs_to_jiffies(bdata
->timer_debounce
));
424 spin_unlock_irqrestore(&bdata
->lock
, flags
);
428 static void gpio_keys_quiesce_key(void *data
)
430 struct gpio_button_data
*bdata
= data
;
432 if (bdata
->timer_debounce
)
433 del_timer_sync(&bdata
->timer
);
435 cancel_work_sync(&bdata
->work
);
438 static int gpio_keys_setup_key(struct platform_device
*pdev
,
439 struct input_dev
*input
,
440 struct gpio_button_data
*bdata
,
441 const struct gpio_keys_button
*button
)
443 const char *desc
= button
->desc
? button
->desc
: "gpio_keys";
444 struct device
*dev
= &pdev
->dev
;
446 unsigned long irqflags
;
450 bdata
->input
= input
;
451 bdata
->button
= button
;
452 spin_lock_init(&bdata
->lock
);
454 if (gpio_is_valid(button
->gpio
)) {
456 error
= devm_gpio_request_one(&pdev
->dev
, button
->gpio
,
459 dev_err(dev
, "Failed to request GPIO %d, error %d\n",
460 button
->gpio
, error
);
464 if (button
->debounce_interval
) {
465 error
= gpio_set_debounce(button
->gpio
,
466 button
->debounce_interval
* 1000);
467 /* use timer if gpiolib doesn't provide debounce */
469 bdata
->timer_debounce
=
470 button
->debounce_interval
;
473 irq
= gpio_to_irq(button
->gpio
);
477 "Unable to get irq number for GPIO %d, error %d\n",
478 button
->gpio
, error
);
483 INIT_WORK(&bdata
->work
, gpio_keys_gpio_work_func
);
484 setup_timer(&bdata
->timer
,
485 gpio_keys_gpio_timer
, (unsigned long)bdata
);
487 isr
= gpio_keys_gpio_isr
;
488 irqflags
= IRQF_TRIGGER_RISING
| IRQF_TRIGGER_FALLING
;
492 dev_err(dev
, "No IRQ specified\n");
495 bdata
->irq
= button
->irq
;
497 if (button
->type
&& button
->type
!= EV_KEY
) {
498 dev_err(dev
, "Only EV_KEY allowed for IRQ buttons.\n");
502 bdata
->timer_debounce
= button
->debounce_interval
;
503 setup_timer(&bdata
->timer
,
504 gpio_keys_irq_timer
, (unsigned long)bdata
);
506 isr
= gpio_keys_irq_isr
;
510 input_set_capability(input
, button
->type
?: EV_KEY
, button
->code
);
513 * Install custom action to cancel debounce timer and
516 error
= devm_add_action(&pdev
->dev
, gpio_keys_quiesce_key
, bdata
);
519 "failed to register quiesce action, error: %d\n",
525 * If platform has specified that the button can be disabled,
526 * we don't want it to share the interrupt line.
528 if (!button
->can_disable
)
529 irqflags
|= IRQF_SHARED
;
531 error
= devm_request_any_context_irq(&pdev
->dev
, bdata
->irq
,
532 isr
, irqflags
, desc
, bdata
);
534 dev_err(dev
, "Unable to claim irq %d; error %d\n",
542 static void gpio_keys_report_state(struct gpio_keys_drvdata
*ddata
)
544 struct input_dev
*input
= ddata
->input
;
547 for (i
= 0; i
< ddata
->pdata
->nbuttons
; i
++) {
548 struct gpio_button_data
*bdata
= &ddata
->data
[i
];
549 if (gpio_is_valid(bdata
->button
->gpio
))
550 gpio_keys_gpio_report_event(bdata
);
555 static int gpio_keys_open(struct input_dev
*input
)
557 struct gpio_keys_drvdata
*ddata
= input_get_drvdata(input
);
558 const struct gpio_keys_platform_data
*pdata
= ddata
->pdata
;
562 error
= pdata
->enable(input
->dev
.parent
);
567 /* Report current state of buttons that are connected to GPIOs */
568 gpio_keys_report_state(ddata
);
573 static void gpio_keys_close(struct input_dev
*input
)
575 struct gpio_keys_drvdata
*ddata
= input_get_drvdata(input
);
576 const struct gpio_keys_platform_data
*pdata
= ddata
->pdata
;
579 pdata
->disable(input
->dev
.parent
);
583 * Handlers for alternative sources of platform_data
588 * Translate OpenFirmware node properties into platform_data
590 static struct gpio_keys_platform_data
*
591 gpio_keys_get_devtree_pdata(struct device
*dev
)
593 struct device_node
*node
, *pp
;
594 struct gpio_keys_platform_data
*pdata
;
595 struct gpio_keys_button
*button
;
602 return ERR_PTR(-ENODEV
);
604 nbuttons
= of_get_child_count(node
);
606 return ERR_PTR(-ENODEV
);
608 pdata
= devm_kzalloc(dev
,
609 sizeof(*pdata
) + nbuttons
* sizeof(*button
),
612 return ERR_PTR(-ENOMEM
);
614 pdata
->buttons
= (struct gpio_keys_button
*)(pdata
+ 1);
615 pdata
->nbuttons
= nbuttons
;
617 pdata
->rep
= !!of_get_property(node
, "autorepeat", NULL
);
620 for_each_child_of_node(node
, pp
) {
622 enum of_gpio_flags flags
;
624 button
= &pdata
->buttons
[i
++];
626 if (!of_find_property(pp
, "gpios", NULL
)) {
627 button
->irq
= irq_of_parse_and_map(pp
, 0);
628 if (button
->irq
== 0) {
631 dev_warn(dev
, "Found button without gpios or irqs\n");
635 gpio
= of_get_gpio_flags(pp
, 0, &flags
);
638 if (error
!= -EPROBE_DEFER
)
640 "Failed to get gpio flags, error: %d\n",
642 return ERR_PTR(error
);
647 button
->active_low
= flags
& OF_GPIO_ACTIVE_LOW
;
649 if (of_property_read_u32(pp
, "linux,code", &button
->code
)) {
650 dev_err(dev
, "Button without keycode: 0x%x\n",
652 return ERR_PTR(-EINVAL
);
655 button
->desc
= of_get_property(pp
, "label", NULL
);
657 if (of_property_read_u32(pp
, "linux,input-type", &button
->type
))
658 button
->type
= EV_KEY
;
660 button
->wakeup
= !!of_get_property(pp
, "gpio-key,wakeup", 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");