2 * GPIO Button Hotplug driver
4 * Copyright (C) 2012 Felix Fietkau <nbd@nbd.name>
5 * Copyright (C) 2008-2010 Gabor Juhos <juhosg@openwrt.org>
7 * Based on the diag.c - GPIO interface driver for Broadcom boards
8 * Copyright (C) 2006 Mike Baker <mbm@openwrt.org>,
9 * Copyright (C) 2006-2007 Felix Fietkau <nbd@nbd.name>
10 * Copyright (C) 2008 Andy Boyett <agb@openwrt.org>
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License version 2 as published
14 * by the Free Software Foundation.
17 #include <linux/module.h>
18 #include <linux/version.h>
19 #include <linux/kmod.h>
21 #include <linux/workqueue.h>
22 #include <linux/skbuff.h>
23 #include <linux/netlink.h>
24 #include <linux/kobject.h>
25 #include <linux/input.h>
26 #include <linux/interrupt.h>
27 #include <linux/platform_device.h>
28 #include <linux/of_gpio.h>
29 #include <linux/of_irq.h>
30 #include <linux/gpio_keys.h>
31 #include <linux/gpio/consumer.h>
33 #define BH_SKB_SIZE 2048
35 #define DRV_NAME "gpio-keys"
36 #define PFX DRV_NAME ": "
49 struct work_struct work
;
57 struct gpio_keys_button_data
{
58 struct delayed_work work
;
65 unsigned int software_debounce
;
66 struct gpio_desc
*gpiod
;
67 const struct gpio_keys_button
*b
;
70 extern u64
uevent_next_seqnum(void);
72 #define BH_MAP(_code, _name) \
78 static struct bh_map button_map
[] = {
79 BH_MAP(BTN_0
, "BTN_0"),
80 BH_MAP(BTN_1
, "BTN_1"),
81 BH_MAP(BTN_2
, "BTN_2"),
82 BH_MAP(BTN_3
, "BTN_3"),
83 BH_MAP(BTN_4
, "BTN_4"),
84 BH_MAP(BTN_5
, "BTN_5"),
85 BH_MAP(BTN_6
, "BTN_6"),
86 BH_MAP(BTN_7
, "BTN_7"),
87 BH_MAP(BTN_8
, "BTN_8"),
88 BH_MAP(BTN_9
, "BTN_9"),
89 BH_MAP(KEY_BRIGHTNESS_ZERO
, "brightness_zero"),
90 BH_MAP(KEY_CONFIG
, "config"),
91 BH_MAP(KEY_COPY
, "copy"),
92 BH_MAP(KEY_EJECTCD
, "eject"),
93 BH_MAP(KEY_HELP
, "help"),
94 BH_MAP(KEY_LIGHTS_TOGGLE
, "lights_toggle"),
95 BH_MAP(KEY_PHONE
, "phone"),
96 BH_MAP(KEY_POWER
, "power"),
97 BH_MAP(KEY_POWER2
, "reboot"),
98 BH_MAP(KEY_RESTART
, "reset"),
99 BH_MAP(KEY_RFKILL
, "rfkill"),
100 BH_MAP(KEY_VIDEO
, "video"),
101 BH_MAP(KEY_WIMAX
, "wwan"),
102 BH_MAP(KEY_WLAN
, "wlan"),
103 BH_MAP(KEY_WPS_BUTTON
, "wps"),
106 /* -------------------------------------------------------------------------*/
108 static __printf(3, 4)
109 int bh_event_add_var(struct bh_event
*event
, int argv
, const char *format
, ...)
111 static char buf
[128];
119 va_start(args
, format
);
120 len
= vsnprintf(buf
, sizeof(buf
), format
, args
);
123 if (len
>= sizeof(buf
)) {
124 WARN(1, "buffer size too small");
128 s
= skb_put(event
->skb
, len
+ 1);
131 pr_debug(PFX
"added variable '%s'\n", s
);
136 static int button_hotplug_fill_event(struct bh_event
*event
)
140 ret
= bh_event_add_var(event
, 0, "HOME=%s", "/");
144 ret
= bh_event_add_var(event
, 0, "PATH=%s",
145 "/sbin:/bin:/usr/sbin:/usr/bin");
149 ret
= bh_event_add_var(event
, 0, "SUBSYSTEM=%s", "button");
153 ret
= bh_event_add_var(event
, 0, "ACTION=%s", event
->action
);
157 ret
= bh_event_add_var(event
, 0, "BUTTON=%s", event
->name
);
161 if (event
->type
== EV_SW
) {
162 ret
= bh_event_add_var(event
, 0, "TYPE=%s", "switch");
167 ret
= bh_event_add_var(event
, 0, "SEEN=%ld", event
->seen
);
171 ret
= bh_event_add_var(event
, 0, "SEQNUM=%llu", uevent_next_seqnum());
176 static void button_hotplug_work(struct work_struct
*work
)
178 struct bh_event
*event
= container_of(work
, struct bh_event
, work
);
181 event
->skb
= alloc_skb(BH_SKB_SIZE
, GFP_KERNEL
);
185 ret
= bh_event_add_var(event
, 0, "%s@", event
->action
);
189 ret
= button_hotplug_fill_event(event
);
193 NETLINK_CB(event
->skb
).dst_group
= 1;
194 broadcast_uevent(event
->skb
, 0, 1, GFP_KERNEL
);
198 pr_err(PFX
"work error %d\n", ret
);
199 kfree_skb(event
->skb
);
205 static int button_hotplug_create_event(const char *name
, unsigned int type
,
206 unsigned long seen
, int pressed
)
208 struct bh_event
*event
;
210 pr_debug(PFX
"create event, name=%s, seen=%lu, pressed=%d\n",
211 name
, seen
, pressed
);
213 event
= kzalloc(sizeof(*event
), GFP_KERNEL
);
220 event
->action
= pressed
? "pressed" : "released";
222 INIT_WORK(&event
->work
, (void *)(void *)button_hotplug_work
);
223 schedule_work(&event
->work
);
228 /* -------------------------------------------------------------------------*/
230 static int button_get_index(unsigned int code
)
234 for (i
= 0; i
< ARRAY_SIZE(button_map
); i
++)
235 if (button_map
[i
].code
== code
)
241 static void button_hotplug_event(struct gpio_keys_button_data
*data
,
242 unsigned int type
, int value
)
244 struct bh_priv
*priv
= &data
->bh
;
245 unsigned long seen
= jiffies
;
248 pr_debug(PFX
"event type=%u, code=%u, value=%d\n", type
, data
->b
->code
, value
);
250 if ((type
!= EV_KEY
) && (type
!= EV_SW
))
253 btn
= button_get_index(data
->b
->code
);
260 button_hotplug_create_event(button_map
[btn
].name
, type
,
261 (seen
- priv
->seen
) / HZ
, value
);
265 struct gpio_keys_button_dev
{
267 struct delayed_work work
;
270 struct gpio_keys_platform_data
*pdata
;
271 struct gpio_keys_button_data data
[0];
274 static int gpio_button_get_value(struct gpio_keys_button_data
*bdata
)
278 if (bdata
->can_sleep
)
279 val
= !!gpio_get_value_cansleep(bdata
->b
->gpio
);
281 val
= !!gpio_get_value(bdata
->b
->gpio
);
283 return val
^ bdata
->b
->active_low
;
286 static void gpio_keys_polled_check_state(struct gpio_keys_button_data
*bdata
)
288 int state
= gpio_button_get_value(bdata
);
290 if (state
!= bdata
->last_state
) {
291 unsigned int type
= bdata
->b
->type
?: EV_KEY
;
293 if (bdata
->count
< bdata
->threshold
) {
298 if (bdata
->last_state
!= -1 || type
== EV_SW
)
299 button_hotplug_event(bdata
, type
, state
);
301 bdata
->last_state
= state
;
307 static void gpio_keys_polled_queue_work(struct gpio_keys_button_dev
*bdev
)
309 struct gpio_keys_platform_data
*pdata
= bdev
->pdata
;
310 unsigned long delay
= msecs_to_jiffies(pdata
->poll_interval
);
313 delay
= round_jiffies_relative(delay
);
314 schedule_delayed_work(&bdev
->work
, delay
);
317 static void gpio_keys_polled_poll(struct work_struct
*work
)
319 struct gpio_keys_button_dev
*bdev
=
320 container_of(work
, struct gpio_keys_button_dev
, work
.work
);
323 for (i
= 0; i
< bdev
->pdata
->nbuttons
; i
++) {
324 struct gpio_keys_button_data
*bdata
= &bdev
->data
[i
];
325 gpio_keys_polled_check_state(bdata
);
327 gpio_keys_polled_queue_work(bdev
);
330 static void gpio_keys_polled_close(struct gpio_keys_button_dev
*bdev
)
332 struct gpio_keys_platform_data
*pdata
= bdev
->pdata
;
334 cancel_delayed_work_sync(&bdev
->work
);
337 pdata
->disable(bdev
->dev
);
340 static void gpio_keys_irq_work_func(struct work_struct
*work
)
342 struct gpio_keys_button_data
*bdata
= container_of(work
,
343 struct gpio_keys_button_data
, work
.work
);
345 button_hotplug_event(bdata
, bdata
->b
->type
?: EV_KEY
,
346 gpio_button_get_value(bdata
));
349 static irqreturn_t
button_handle_irq(int irq
, void *_bdata
)
351 struct gpio_keys_button_data
*bdata
=
352 (struct gpio_keys_button_data
*) _bdata
;
354 schedule_delayed_work(&bdata
->work
,
355 msecs_to_jiffies(bdata
->software_debounce
));
361 static struct gpio_keys_platform_data
*
362 gpio_keys_get_devtree_pdata(struct device
*dev
)
364 struct device_node
*node
, *pp
;
365 struct gpio_keys_platform_data
*pdata
;
366 struct gpio_keys_button
*button
;
375 nbuttons
= of_get_child_count(node
);
379 pdata
= devm_kzalloc(dev
, sizeof(*pdata
) + nbuttons
* (sizeof *button
),
386 pdata
->buttons
= (struct gpio_keys_button
*)(pdata
+ 1);
387 pdata
->nbuttons
= nbuttons
;
389 pdata
->rep
= !!of_get_property(node
, "autorepeat", NULL
);
390 of_property_read_u32(node
, "poll-interval", &pdata
->poll_interval
);
392 for_each_child_of_node(node
, pp
) {
393 enum of_gpio_flags flags
;
395 if (!of_find_property(pp
, "gpios", NULL
)) {
397 dev_warn(dev
, "Found button without gpios\n");
401 button
= (struct gpio_keys_button
*)(&pdata
->buttons
[i
++]);
403 button
->irq
= irq_of_parse_and_map(pp
, 0);
405 button
->gpio
= of_get_gpio_flags(pp
, 0, &flags
);
406 if (button
->gpio
< 0) {
407 error
= button
->gpio
;
408 if (error
!= -ENOENT
) {
409 if (error
!= -EPROBE_DEFER
)
411 "Failed to get gpio flags, error: %d\n",
413 return ERR_PTR(error
);
416 button
->active_low
= flags
& OF_GPIO_ACTIVE_LOW
;
419 if (of_property_read_u32(pp
, "linux,code", &button
->code
)) {
420 dev_err(dev
, "Button without keycode: 0x%x\n",
426 button
->desc
= of_get_property(pp
, "label", NULL
);
428 if (of_property_read_u32(pp
, "linux,input-type", &button
->type
))
429 button
->type
= EV_KEY
;
431 button
->wakeup
= !!of_get_property(pp
, "gpio-key,wakeup", NULL
);
433 if (of_property_read_u32(pp
, "debounce-interval",
434 &button
->debounce_interval
))
435 button
->debounce_interval
= 5;
438 if (pdata
->nbuttons
== 0) {
446 return ERR_PTR(error
);
449 static struct of_device_id gpio_keys_of_match
[] = {
450 { .compatible
= "gpio-keys", },
453 MODULE_DEVICE_TABLE(of
, gpio_keys_of_match
);
455 static struct of_device_id gpio_keys_polled_of_match
[] = {
456 { .compatible
= "gpio-keys-polled", },
459 MODULE_DEVICE_TABLE(of
, gpio_keys_polled_of_match
);
463 static inline struct gpio_keys_platform_data
*
464 gpio_keys_get_devtree_pdata(struct device
*dev
)
470 static int gpio_keys_button_probe(struct platform_device
*pdev
,
471 struct gpio_keys_button_dev
**_bdev
, int polled
)
473 struct gpio_keys_platform_data
*pdata
= pdev
->dev
.platform_data
;
474 struct device
*dev
= &pdev
->dev
;
475 struct gpio_keys_button_dev
*bdev
;
476 struct gpio_keys_button
*buttons
;
481 pdata
= gpio_keys_get_devtree_pdata(dev
);
483 return PTR_ERR(pdata
);
485 dev_err(dev
, "missing platform data\n");
490 if (polled
&& !pdata
->poll_interval
) {
491 dev_err(dev
, "missing poll_interval value\n");
495 buttons
= devm_kzalloc(dev
, pdata
->nbuttons
* sizeof(struct gpio_keys_button
),
498 dev_err(dev
, "no memory for button data\n");
501 memcpy(buttons
, pdata
->buttons
, pdata
->nbuttons
* sizeof(struct gpio_keys_button
));
503 bdev
= devm_kzalloc(dev
, sizeof(struct gpio_keys_button_dev
) +
504 pdata
->nbuttons
* sizeof(struct gpio_keys_button_data
),
507 dev_err(dev
, "no memory for private data\n");
511 bdev
->polled
= polled
;
513 for (i
= 0; i
< pdata
->nbuttons
; i
++) {
514 struct gpio_keys_button
*button
= &buttons
[i
];
515 struct gpio_keys_button_data
*bdata
= &bdev
->data
[i
];
516 unsigned int gpio
= button
->gpio
;
518 if (button
->wakeup
) {
519 dev_err(dev
, DRV_NAME
"does not support wakeup\n");
523 error
= devm_gpio_request(dev
, gpio
,
524 button
->desc
? button
->desc
: DRV_NAME
);
526 dev_err(dev
, "unable to claim gpio %u, err=%d\n",
530 bdata
->gpiod
= gpio_to_desc(gpio
);
534 error
= gpio_direction_input(gpio
);
537 "unable to set direction on gpio %u, err=%d\n",
542 bdata
->can_sleep
= gpio_cansleep(gpio
);
543 bdata
->last_state
= -1;
546 bdata
->threshold
= DIV_ROUND_UP(button
->debounce_interval
,
547 pdata
->poll_interval
);
549 bdata
->threshold
= 1;
551 if (button
->debounce_interval
) {
552 error
= gpiod_set_debounce(bdata
->gpiod
,
553 button
->debounce_interval
* 1000);
555 * use timer if gpiolib doesn't provide
559 bdata
->software_debounce
=
560 button
->debounce_interval
;
565 bdata
->b
= &pdata
->buttons
[i
];
568 bdev
->dev
= &pdev
->dev
;
570 platform_set_drvdata(pdev
, bdev
);
577 static int gpio_keys_probe(struct platform_device
*pdev
)
579 struct gpio_keys_platform_data
*pdata
;
580 struct gpio_keys_button_dev
*bdev
;
584 ret
= gpio_keys_button_probe(pdev
, &bdev
, 0);
590 for (i
= 0; i
< pdata
->nbuttons
; i
++) {
591 const struct gpio_keys_button
*button
= &pdata
->buttons
[i
];
592 struct gpio_keys_button_data
*bdata
= &bdev
->data
[i
];
593 unsigned long irqflags
= IRQF_ONESHOT
;
596 bdata
->irq
= gpio_to_irq(button
->gpio
);
598 if (bdata
->irq
< 0) {
599 dev_err(&pdev
->dev
, "failed to get irq for gpio:%d\n",
604 irqflags
|= IRQF_TRIGGER_RISING
| IRQF_TRIGGER_FALLING
;
606 bdata
->irq
= button
->irq
;
609 INIT_DELAYED_WORK(&bdata
->work
, gpio_keys_irq_work_func
);
611 ret
= devm_request_threaded_irq(&pdev
->dev
,
612 bdata
->irq
, NULL
, button_handle_irq
,
613 irqflags
, dev_name(&pdev
->dev
), bdata
);
617 dev_err(&pdev
->dev
, "failed to request irq:%d for gpio:%d\n",
618 bdata
->irq
, button
->gpio
);
621 dev_dbg(&pdev
->dev
, "gpio:%d has irq:%d\n",
622 button
->gpio
, bdata
->irq
);
625 if (bdata
->b
->type
== EV_SW
)
626 button_hotplug_event(bdata
, EV_SW
, gpio_button_get_value(bdata
));
632 static int gpio_keys_polled_probe(struct platform_device
*pdev
)
634 struct gpio_keys_platform_data
*pdata
;
635 struct gpio_keys_button_dev
*bdev
;
639 ret
= gpio_keys_button_probe(pdev
, &bdev
, 1);
644 INIT_DELAYED_WORK(&bdev
->work
, gpio_keys_polled_poll
);
649 pdata
->enable(bdev
->dev
);
651 for (i
= 0; i
< pdata
->nbuttons
; i
++)
652 gpio_keys_polled_check_state(&bdev
->data
[i
]);
654 gpio_keys_polled_queue_work(bdev
);
659 static void gpio_keys_irq_close(struct gpio_keys_button_dev
*bdev
)
661 struct gpio_keys_platform_data
*pdata
= bdev
->pdata
;
664 for (i
= 0; i
< pdata
->nbuttons
; i
++) {
665 struct gpio_keys_button_data
*bdata
= &bdev
->data
[i
];
667 disable_irq(bdata
->irq
);
668 cancel_delayed_work_sync(&bdata
->work
);
672 static int gpio_keys_remove(struct platform_device
*pdev
)
674 struct gpio_keys_button_dev
*bdev
= platform_get_drvdata(pdev
);
676 platform_set_drvdata(pdev
, NULL
);
679 gpio_keys_polled_close(bdev
);
681 gpio_keys_irq_close(bdev
);
686 static struct platform_driver gpio_keys_driver
= {
687 .probe
= gpio_keys_probe
,
688 .remove
= gpio_keys_remove
,
691 .owner
= THIS_MODULE
,
692 .of_match_table
= of_match_ptr(gpio_keys_of_match
),
696 static struct platform_driver gpio_keys_polled_driver
= {
697 .probe
= gpio_keys_polled_probe
,
698 .remove
= gpio_keys_remove
,
700 .name
= "gpio-keys-polled",
701 .owner
= THIS_MODULE
,
702 .of_match_table
= of_match_ptr(gpio_keys_polled_of_match
),
706 static int __init
gpio_button_init(void)
710 ret
= platform_driver_register(&gpio_keys_driver
);
714 ret
= platform_driver_register(&gpio_keys_polled_driver
);
716 platform_driver_unregister(&gpio_keys_driver
);
721 static void __exit
gpio_button_exit(void)
723 platform_driver_unregister(&gpio_keys_driver
);
724 platform_driver_unregister(&gpio_keys_polled_driver
);
727 module_init(gpio_button_init
);
728 module_exit(gpio_button_exit
);
730 MODULE_AUTHOR("Gabor Juhos <juhosg@openwrt.org>");
731 MODULE_AUTHOR("Felix Fietkau <nbd@nbd.name>");
732 MODULE_DESCRIPTION("Polled GPIO Buttons hotplug driver");
733 MODULE_LICENSE("GPL v2");
734 MODULE_ALIAS("platform:" DRV_NAME
);