projects / openwrt / openwrt.git / blob
? search:


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