gpio-button-hotplug: support interrupt properties
[openwrt/staging/wigyori.git] / package / kernel / gpio-button-hotplug / src / gpio-button-hotplug.c
1 /*
2 * GPIO Button Hotplug driver
3 *
4 * Copyright (C) 2012 Felix Fietkau <nbd@nbd.name>
5 * Copyright (C) 2008-2010 Gabor Juhos <juhosg@openwrt.org>
6 *
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>
11 *
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.
15 */
16
17 #include <linux/module.h>
18 #include <linux/version.h>
19 #include <linux/kmod.h>
20
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
32 #define DRV_NAME "gpio-keys"
33
34 #define BH_SKB_SIZE 2048
35
36 #define PFX DRV_NAME ": "
37
38 #undef BH_DEBUG
39
40 #ifdef BH_DEBUG
41 #define BH_DBG(fmt, args...) printk(KERN_DEBUG "%s: " fmt, DRV_NAME, ##args )
42 #else
43 #define BH_DBG(fmt, args...) do {} while (0)
44 #endif
45
46 #define BH_ERR(fmt, args...) printk(KERN_ERR "%s: " fmt, DRV_NAME, ##args )
47
48 struct bh_priv {
49 unsigned long seen;
50 };
51
52 struct bh_event {
53 const char *name;
54 unsigned int type;
55 char *action;
56 unsigned long seen;
57
58 struct sk_buff *skb;
59 struct work_struct work;
60 };
61
62 struct bh_map {
63 unsigned int code;
64 const char *name;
65 };
66
67 struct gpio_keys_button_data {
68 struct delayed_work work;
69 struct bh_priv bh;
70 int last_state;
71 int count;
72 int threshold;
73 int can_sleep;
74 int irq;
75 unsigned int software_debounce;
76 struct gpio_desc *gpiod;
77 const struct gpio_keys_button *b;
78 };
79
80 extern u64 uevent_next_seqnum(void);
81
82 #define BH_MAP(_code, _name) \
83 { \
84 .code = (_code), \
85 .name = (_name), \
86 }
87
88 static struct bh_map button_map[] = {
89 BH_MAP(BTN_0, "BTN_0"),
90 BH_MAP(BTN_1, "BTN_1"),
91 BH_MAP(BTN_2, "BTN_2"),
92 BH_MAP(BTN_3, "BTN_3"),
93 BH_MAP(BTN_4, "BTN_4"),
94 BH_MAP(BTN_5, "BTN_5"),
95 BH_MAP(BTN_6, "BTN_6"),
96 BH_MAP(BTN_7, "BTN_7"),
97 BH_MAP(BTN_8, "BTN_8"),
98 BH_MAP(BTN_9, "BTN_9"),
99 BH_MAP(KEY_BRIGHTNESS_ZERO, "brightness_zero"),
100 BH_MAP(KEY_CONFIG, "config"),
101 BH_MAP(KEY_COPY, "copy"),
102 BH_MAP(KEY_EJECTCD, "eject"),
103 BH_MAP(KEY_HELP, "help"),
104 BH_MAP(KEY_LIGHTS_TOGGLE, "lights_toggle"),
105 BH_MAP(KEY_PHONE, "phone"),
106 BH_MAP(KEY_POWER, "power"),
107 BH_MAP(KEY_POWER2, "reboot"),
108 BH_MAP(KEY_RESTART, "reset"),
109 BH_MAP(KEY_RFKILL, "rfkill"),
110 BH_MAP(KEY_VIDEO, "video"),
111 BH_MAP(KEY_WIMAX, "wwan"),
112 BH_MAP(KEY_WLAN, "wlan"),
113 BH_MAP(KEY_WPS_BUTTON, "wps"),
114 };
115
116 /* -------------------------------------------------------------------------*/
117
118 static __printf(3, 4)
119 int bh_event_add_var(struct bh_event *event, int argv, const char *format, ...)
120 {
121 static char buf[128];
122 char *s;
123 va_list args;
124 int len;
125
126 if (argv)
127 return 0;
128
129 va_start(args, format);
130 len = vsnprintf(buf, sizeof(buf), format, args);
131 va_end(args);
132
133 if (len >= sizeof(buf)) {
134 WARN(1, "buffer size too small");
135 return -ENOMEM;
136 }
137
138 s = skb_put(event->skb, len + 1);
139 strcpy(s, buf);
140
141 BH_DBG("added variable '%s'\n", s);
142
143 return 0;
144 }
145
146 static int button_hotplug_fill_event(struct bh_event *event)
147 {
148 int ret;
149
150 ret = bh_event_add_var(event, 0, "HOME=%s", "/");
151 if (ret)
152 return ret;
153
154 ret = bh_event_add_var(event, 0, "PATH=%s",
155 "/sbin:/bin:/usr/sbin:/usr/bin");
156 if (ret)
157 return ret;
158
159 ret = bh_event_add_var(event, 0, "SUBSYSTEM=%s", "button");
160 if (ret)
161 return ret;
162
163 ret = bh_event_add_var(event, 0, "ACTION=%s", event->action);
164 if (ret)
165 return ret;
166
167 ret = bh_event_add_var(event, 0, "BUTTON=%s", event->name);
168 if (ret)
169 return ret;
170
171 if (event->type == EV_SW) {
172 ret = bh_event_add_var(event, 0, "TYPE=%s", "switch");
173 if (ret)
174 return ret;
175 }
176
177 ret = bh_event_add_var(event, 0, "SEEN=%ld", event->seen);
178 if (ret)
179 return ret;
180
181 ret = bh_event_add_var(event, 0, "SEQNUM=%llu", uevent_next_seqnum());
182
183 return ret;
184 }
185
186 static void button_hotplug_work(struct work_struct *work)
187 {
188 struct bh_event *event = container_of(work, struct bh_event, work);
189 int ret = 0;
190
191 event->skb = alloc_skb(BH_SKB_SIZE, GFP_KERNEL);
192 if (!event->skb)
193 goto out_free_event;
194
195 ret = bh_event_add_var(event, 0, "%s@", event->action);
196 if (ret)
197 goto out_free_skb;
198
199 ret = button_hotplug_fill_event(event);
200 if (ret)
201 goto out_free_skb;
202
203 NETLINK_CB(event->skb).dst_group = 1;
204 broadcast_uevent(event->skb, 0, 1, GFP_KERNEL);
205
206 out_free_skb:
207 if (ret) {
208 BH_ERR("work error %d\n", ret);
209 kfree_skb(event->skb);
210 }
211 out_free_event:
212 kfree(event);
213 }
214
215 static int button_hotplug_create_event(const char *name, unsigned int type,
216 unsigned long seen, int pressed)
217 {
218 struct bh_event *event;
219
220 BH_DBG("create event, name=%s, seen=%lu, pressed=%d\n",
221 name, seen, pressed);
222
223 event = kzalloc(sizeof(*event), GFP_KERNEL);
224 if (!event)
225 return -ENOMEM;
226
227 event->name = name;
228 event->type = type;
229 event->seen = seen;
230 event->action = pressed ? "pressed" : "released";
231
232 INIT_WORK(&event->work, (void *)(void *)button_hotplug_work);
233 schedule_work(&event->work);
234
235 return 0;
236 }
237
238 /* -------------------------------------------------------------------------*/
239
240 static int button_get_index(unsigned int code)
241 {
242 int i;
243
244 for (i = 0; i < ARRAY_SIZE(button_map); i++)
245 if (button_map[i].code == code)
246 return i;
247
248 return -1;
249 }
250
251 static void button_hotplug_event(struct gpio_keys_button_data *data,
252 unsigned int type, int value)
253 {
254 struct bh_priv *priv = &data->bh;
255 unsigned long seen = jiffies;
256 int btn;
257
258 BH_DBG("event type=%u, code=%u, value=%d\n", type, data->b->code, value);
259
260 if ((type != EV_KEY) && (type != EV_SW))
261 return;
262
263 btn = button_get_index(data->b->code);
264 if (btn < 0)
265 return;
266
267 button_hotplug_create_event(button_map[btn].name, type,
268 (seen - priv->seen) / HZ, value);
269 priv->seen = seen;
270 }
271
272 struct gpio_keys_button_dev {
273 int polled;
274 struct delayed_work work;
275
276 struct device *dev;
277 struct gpio_keys_platform_data *pdata;
278 struct gpio_keys_button_data data[0];
279 };
280
281 static int gpio_button_get_value(struct gpio_keys_button_data *bdata)
282 {
283 int val;
284
285 if (bdata->can_sleep)
286 val = !!gpio_get_value_cansleep(bdata->b->gpio);
287 else
288 val = !!gpio_get_value(bdata->b->gpio);
289
290 return val ^ bdata->b->active_low;
291 }
292
293 static void gpio_keys_polled_check_state(struct gpio_keys_button_data *bdata)
294 {
295 int state = gpio_button_get_value(bdata);
296
297 if (state != bdata->last_state) {
298 unsigned int type = bdata->b->type ?: EV_KEY;
299
300 if (bdata->count < bdata->threshold) {
301 bdata->count++;
302 return;
303 }
304
305 if (bdata->last_state != -1 || type == EV_SW)
306 button_hotplug_event(bdata, type, state);
307
308 bdata->last_state = state;
309 }
310
311 bdata->count = 0;
312 }
313
314 static void gpio_keys_polled_queue_work(struct gpio_keys_button_dev *bdev)
315 {
316 struct gpio_keys_platform_data *pdata = bdev->pdata;
317 unsigned long delay = msecs_to_jiffies(pdata->poll_interval);
318
319 if (delay >= HZ)
320 delay = round_jiffies_relative(delay);
321 schedule_delayed_work(&bdev->work, delay);
322 }
323
324 static void gpio_keys_polled_poll(struct work_struct *work)
325 {
326 struct gpio_keys_button_dev *bdev =
327 container_of(work, struct gpio_keys_button_dev, work.work);
328 int i;
329
330 for (i = 0; i < bdev->pdata->nbuttons; i++) {
331 struct gpio_keys_button_data *bdata = &bdev->data[i];
332 gpio_keys_polled_check_state(bdata);
333 }
334 gpio_keys_polled_queue_work(bdev);
335 }
336
337 static void gpio_keys_polled_close(struct gpio_keys_button_dev *bdev)
338 {
339 struct gpio_keys_platform_data *pdata = bdev->pdata;
340
341 cancel_delayed_work_sync(&bdev->work);
342
343 if (pdata->disable)
344 pdata->disable(bdev->dev);
345 }
346
347 static void gpio_keys_irq_work_func(struct work_struct *work)
348 {
349 struct gpio_keys_button_data *bdata = container_of(work,
350 struct gpio_keys_button_data, work.work);
351 int state = gpio_button_get_value(bdata);
352
353 if (state != bdata->last_state) {
354 unsigned int type = bdata->b->type ?: EV_KEY;
355
356 if (bdata->last_state != -1 || type == EV_SW)
357 button_hotplug_event(bdata, type, state);
358
359 bdata->last_state = state;
360 }
361 }
362
363 static irqreturn_t button_handle_irq(int irq, void *_bdata)
364 {
365 struct gpio_keys_button_data *bdata =
366 (struct gpio_keys_button_data *) _bdata;
367
368 schedule_delayed_work(&bdata->work,
369 msecs_to_jiffies(bdata->software_debounce));
370
371 return IRQ_HANDLED;
372 }
373
374 #ifdef CONFIG_OF
375 static struct gpio_keys_platform_data *
376 gpio_keys_get_devtree_pdata(struct device *dev)
377 {
378 struct device_node *node, *pp;
379 struct gpio_keys_platform_data *pdata;
380 struct gpio_keys_button *button;
381 int error;
382 int nbuttons;
383 int i = 0;
384
385 node = dev->of_node;
386 if (!node)
387 return NULL;
388
389 nbuttons = of_get_child_count(node);
390 if (nbuttons == 0)
391 return NULL;
392
393 pdata = devm_kzalloc(dev, sizeof(*pdata) + nbuttons * (sizeof *button),
394 GFP_KERNEL);
395 if (!pdata) {
396 error = -ENOMEM;
397 goto err_out;
398 }
399
400 pdata->buttons = (struct gpio_keys_button *)(pdata + 1);
401 pdata->nbuttons = nbuttons;
402
403 pdata->rep = !!of_get_property(node, "autorepeat", NULL);
404 of_property_read_u32(node, "poll-interval", &pdata->poll_interval);
405
406 for_each_child_of_node(node, pp) {
407 enum of_gpio_flags flags;
408
409 if (!of_find_property(pp, "gpios", NULL)) {
410 pdata->nbuttons--;
411 dev_warn(dev, "Found button without gpios\n");
412 continue;
413 }
414
415 button = (struct gpio_keys_button *)(&pdata->buttons[i++]);
416
417 button->irq = irq_of_parse_and_map(pp, 0);
418
419 button->gpio = of_get_gpio_flags(pp, 0, &flags);
420 if (button->gpio < 0) {
421 error = button->gpio;
422 if (error != -ENOENT) {
423 if (error != -EPROBE_DEFER)
424 dev_err(dev,
425 "Failed to get gpio flags, error: %d\n",
426 error);
427 return ERR_PTR(error);
428 }
429 } else {
430 button->active_low = flags & OF_GPIO_ACTIVE_LOW;
431 }
432
433 if (of_property_read_u32(pp, "linux,code", &button->code)) {
434 dev_err(dev, "Button without keycode: 0x%x\n",
435 button->gpio);
436 error = -EINVAL;
437 goto err_out;
438 }
439
440 button->desc = of_get_property(pp, "label", NULL);
441
442 if (of_property_read_u32(pp, "linux,input-type", &button->type))
443 button->type = EV_KEY;
444
445 button->wakeup = !!of_get_property(pp, "gpio-key,wakeup", NULL);
446
447 if (of_property_read_u32(pp, "debounce-interval",
448 &button->debounce_interval))
449 button->debounce_interval = 5;
450 }
451
452 if (pdata->nbuttons == 0) {
453 error = -EINVAL;
454 goto err_out;
455 }
456
457 return pdata;
458
459 err_out:
460 return ERR_PTR(error);
461 }
462
463 static struct of_device_id gpio_keys_of_match[] = {
464 { .compatible = "gpio-keys", },
465 { },
466 };
467 MODULE_DEVICE_TABLE(of, gpio_keys_of_match);
468
469 static struct of_device_id gpio_keys_polled_of_match[] = {
470 { .compatible = "gpio-keys-polled", },
471 { },
472 };
473 MODULE_DEVICE_TABLE(of, gpio_keys_polled_of_match);
474
475 #else
476
477 static inline struct gpio_keys_platform_data *
478 gpio_keys_get_devtree_pdata(struct device *dev)
479 {
480 return NULL;
481 }
482 #endif
483
484 static int gpio_keys_button_probe(struct platform_device *pdev,
485 struct gpio_keys_button_dev **_bdev, int polled)
486 {
487 struct gpio_keys_platform_data *pdata = pdev->dev.platform_data;
488 struct device *dev = &pdev->dev;
489 struct gpio_keys_button_dev *bdev;
490 struct gpio_keys_button *buttons;
491 int error;
492 int i;
493
494 if (!pdata) {
495 pdata = gpio_keys_get_devtree_pdata(dev);
496 if (IS_ERR(pdata))
497 return PTR_ERR(pdata);
498 if (!pdata) {
499 dev_err(dev, "missing platform data\n");
500 return -EINVAL;
501 }
502 }
503
504 if (polled && !pdata->poll_interval) {
505 dev_err(dev, "missing poll_interval value\n");
506 return -EINVAL;
507 }
508
509 buttons = devm_kzalloc(dev, pdata->nbuttons * sizeof(struct gpio_keys_button),
510 GFP_KERNEL);
511 if (!buttons) {
512 dev_err(dev, "no memory for button data\n");
513 return -ENOMEM;
514 }
515 memcpy(buttons, pdata->buttons, pdata->nbuttons * sizeof(struct gpio_keys_button));
516
517 bdev = devm_kzalloc(dev, sizeof(struct gpio_keys_button_dev) +
518 pdata->nbuttons * sizeof(struct gpio_keys_button_data),
519 GFP_KERNEL);
520 if (!bdev) {
521 dev_err(dev, "no memory for private data\n");
522 return -ENOMEM;
523 }
524
525 bdev->polled = polled;
526
527 for (i = 0; i < pdata->nbuttons; i++) {
528 struct gpio_keys_button *button = &buttons[i];
529 struct gpio_keys_button_data *bdata = &bdev->data[i];
530 unsigned int gpio = button->gpio;
531
532 if (button->wakeup) {
533 dev_err(dev, DRV_NAME "does not support wakeup\n");
534 return -EINVAL;
535 }
536
537 error = devm_gpio_request(dev, gpio,
538 button->desc ? button->desc : DRV_NAME);
539 if (error) {
540 dev_err(dev, "unable to claim gpio %u, err=%d\n",
541 gpio, error);
542 return error;
543 }
544 bdata->gpiod = gpio_to_desc(gpio);
545 if (!bdata->gpiod)
546 return -EINVAL;
547
548 error = gpio_direction_input(gpio);
549 if (error) {
550 dev_err(dev,
551 "unable to set direction on gpio %u, err=%d\n",
552 gpio, error);
553 return error;
554 }
555
556 bdata->can_sleep = gpio_cansleep(gpio);
557 bdata->last_state = -1;
558
559 if (bdev->polled) {
560 bdata->threshold = DIV_ROUND_UP(button->debounce_interval,
561 pdata->poll_interval);
562 } else {
563 bdata->threshold = 1;
564
565 if (button->debounce_interval) {
566 error = gpiod_set_debounce(bdata->gpiod,
567 button->debounce_interval * 1000);
568 /*
569 * use timer if gpiolib doesn't provide
570 * debounce.
571 */
572 if (error < 0) {
573 bdata->software_debounce =
574 button->debounce_interval;
575 }
576 }
577 }
578
579 bdata->b = &pdata->buttons[i];
580 }
581
582 bdev->dev = &pdev->dev;
583 bdev->pdata = pdata;
584 platform_set_drvdata(pdev, bdev);
585
586 *_bdev = bdev;
587
588 return 0;
589 }
590
591 static int gpio_keys_probe(struct platform_device *pdev)
592 {
593 struct gpio_keys_platform_data *pdata;
594 struct gpio_keys_button_dev *bdev;
595 int ret, i;
596
597
598 ret = gpio_keys_button_probe(pdev, &bdev, 0);
599
600 if (ret)
601 return ret;
602
603 pdata = bdev->pdata;
604 for (i = 0; i < pdata->nbuttons; i++) {
605 const struct gpio_keys_button *button = &pdata->buttons[i];
606 struct gpio_keys_button_data *bdata = &bdev->data[i];
607 unsigned long irqflags = IRQF_ONESHOT;
608
609 if (!button->irq) {
610 bdata->irq = gpio_to_irq(button->gpio);
611
612 if (bdata->irq < 0) {
613 dev_err(&pdev->dev, "failed to get irq for gpio:%d\n",
614 button->gpio);
615 continue;
616 }
617
618 irqflags |= IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING;
619 } else {
620 bdata->irq = button->irq;
621 }
622
623 INIT_DELAYED_WORK(&bdata->work, gpio_keys_irq_work_func);
624
625 ret = devm_request_threaded_irq(&pdev->dev,
626 bdata->irq, NULL, button_handle_irq,
627 irqflags, dev_name(&pdev->dev), bdata);
628
629 if (ret < 0) {
630 bdata->irq = 0;
631 dev_err(&pdev->dev, "failed to request irq:%d for gpio:%d\n",
632 bdata->irq, button->gpio);
633 continue;
634 } else {
635 dev_dbg(&pdev->dev, "gpio:%d has irq:%d\n",
636 button->gpio, bdata->irq);
637 }
638
639 if (bdata->b->type == EV_SW)
640 button_hotplug_event(bdata, EV_SW, gpio_button_get_value(bdata));
641 }
642
643 return 0;
644 }
645
646 static int gpio_keys_polled_probe(struct platform_device *pdev)
647 {
648 struct gpio_keys_platform_data *pdata;
649 struct gpio_keys_button_dev *bdev;
650 int ret;
651 int i;
652
653 ret = gpio_keys_button_probe(pdev, &bdev, 1);
654
655 if (ret)
656 return ret;
657
658 INIT_DELAYED_WORK(&bdev->work, gpio_keys_polled_poll);
659
660 pdata = bdev->pdata;
661
662 if (pdata->enable)
663 pdata->enable(bdev->dev);
664
665 for (i = 0; i < pdata->nbuttons; i++)
666 gpio_keys_polled_check_state(&bdev->data[i]);
667
668 gpio_keys_polled_queue_work(bdev);
669
670 return ret;
671 }
672
673 static void gpio_keys_irq_close(struct gpio_keys_button_dev *bdev)
674 {
675 struct gpio_keys_platform_data *pdata = bdev->pdata;
676 size_t i;
677
678 for (i = 0; i < pdata->nbuttons; i++) {
679 struct gpio_keys_button_data *bdata = &bdev->data[i];
680
681 disable_irq(bdata->irq);
682 cancel_delayed_work_sync(&bdata->work);
683 }
684 }
685
686 static int gpio_keys_remove(struct platform_device *pdev)
687 {
688 struct gpio_keys_button_dev *bdev = platform_get_drvdata(pdev);
689
690 platform_set_drvdata(pdev, NULL);
691
692 if (bdev->polled)
693 gpio_keys_polled_close(bdev);
694 else
695 gpio_keys_irq_close(bdev);
696
697 return 0;
698 }
699
700 static struct platform_driver gpio_keys_driver = {
701 .probe = gpio_keys_probe,
702 .remove = gpio_keys_remove,
703 .driver = {
704 .name = "gpio-keys",
705 .owner = THIS_MODULE,
706 .of_match_table = of_match_ptr(gpio_keys_of_match),
707 },
708 };
709
710 static struct platform_driver gpio_keys_polled_driver = {
711 .probe = gpio_keys_polled_probe,
712 .remove = gpio_keys_remove,
713 .driver = {
714 .name = "gpio-keys-polled",
715 .owner = THIS_MODULE,
716 .of_match_table = of_match_ptr(gpio_keys_polled_of_match),
717 },
718 };
719
720 static int __init gpio_button_init(void)
721 {
722 int ret;
723
724 ret = platform_driver_register(&gpio_keys_driver);
725 if (ret)
726 return ret;
727
728 ret = platform_driver_register(&gpio_keys_polled_driver);
729 if (ret)
730 platform_driver_unregister(&gpio_keys_driver);
731
732 return ret;
733 }
734
735 static void __exit gpio_button_exit(void)
736 {
737 platform_driver_unregister(&gpio_keys_driver);
738 platform_driver_unregister(&gpio_keys_polled_driver);
739 }
740
741 module_init(gpio_button_init);
742 module_exit(gpio_button_exit);
743
744 MODULE_AUTHOR("Gabor Juhos <juhosg@openwrt.org>");
745 MODULE_AUTHOR("Felix Fietkau <nbd@nbd.name>");
746 MODULE_DESCRIPTION("Polled GPIO Buttons hotplug driver");
747 MODULE_LICENSE("GPL v2");
748 MODULE_ALIAS("platform:" DRV_NAME);