]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - drivers/input/keyboard/gpio_keys.c
Input: add DA9062 OnKey capability to DA9063 OnKey driver
[mirror_ubuntu-jammy-kernel.git] / drivers / input / keyboard / gpio_keys.c
CommitLineData
78a56aab
PB
1/*
2 * Driver for keys on GPIO lines capable of generating interrupts.
3 *
4 * Copyright 2005 Phil Blundell
fd05d089 5 * Copyright 2010, 2011 David Jander <david@protonic.nl>
78a56aab
PB
6 *
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.
10 */
11
12#include <linux/module.h>
78a56aab
PB
13
14#include <linux/init.h>
15#include <linux/fs.h>
16#include <linux/interrupt.h>
17#include <linux/irq.h>
18#include <linux/sched.h>
19#include <linux/pm.h>
5a0e3ad6 20#include <linux/slab.h>
78a56aab
PB
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>
49015bee 26#include <linux/gpio_keys.h>
da0d03fe 27#include <linux/workqueue.h>
111bc59c 28#include <linux/gpio.h>
415a4caa 29#include <linux/of.h>
fd05d089
DJ
30#include <linux/of_platform.h>
31#include <linux/of_gpio.h>
f2d347ff 32#include <linux/of_irq.h>
d8ee4a1c 33#include <linux/spinlock.h>
78a56aab 34
a33466e3 35struct gpio_button_data {
d9080921 36 const struct gpio_keys_button *button;
a33466e3 37 struct input_dev *input;
8ed92556
DT
38
39 struct timer_list release_timer;
40 unsigned int release_delay; /* in msecs, for IRQ-only buttons */
41
42 struct delayed_work work;
43 unsigned int software_debounce; /* in msecs, for GPIO-driven buttons */
44
d8ee4a1c
LD
45 unsigned int irq;
46 spinlock_t lock;
9e3af04f 47 bool disabled;
d8ee4a1c 48 bool key_pressed;
a33466e3
DB
49};
50
51struct gpio_keys_drvdata {
219edc71 52 const struct gpio_keys_platform_data *pdata;
a33466e3 53 struct input_dev *input;
9e3af04f 54 struct mutex disable_lock;
a33466e3
DB
55 struct gpio_button_data data[0];
56};
57
9e3af04f
MW
58/*
59 * SYSFS interface for enabling/disabling keys and switches:
60 *
61 * There are 4 attributes under /sys/devices/platform/gpio-keys/
62 * keys [ro] - bitmap of keys (EV_KEY) which can be
63 * disabled
64 * switches [ro] - bitmap of switches (EV_SW) which can be
65 * disabled
66 * disabled_keys [rw] - bitmap of keys currently disabled
67 * disabled_switches [rw] - bitmap of switches currently disabled
68 *
69 * Userland can change these values and hence disable event generation
70 * for each key (or switch). Disabling a key means its interrupt line
71 * is disabled.
72 *
73 * For example, if we have following switches set up as gpio-keys:
74 * SW_DOCK = 5
75 * SW_CAMERA_LENS_COVER = 9
76 * SW_KEYPAD_SLIDE = 10
77 * SW_FRONT_PROXIMITY = 11
78 * This is read from switches:
79 * 11-9,5
80 * Next we want to disable proximity (11) and dock (5), we write:
81 * 11,5
82 * to file disabled_switches. Now proximity and dock IRQs are disabled.
83 * This can be verified by reading the file disabled_switches:
84 * 11,5
85 * If we now want to enable proximity (11) switch we write:
86 * 5
87 * to disabled_switches.
88 *
89 * We can disable only those keys which don't allow sharing the irq.
90 */
91
92/**
93 * get_n_events_by_type() - returns maximum number of events per @type
94 * @type: type of button (%EV_KEY, %EV_SW)
95 *
96 * Return value of this function can be used to allocate bitmap
97 * large enough to hold all bits for given type.
98 */
99static inline int get_n_events_by_type(int type)
100{
101 BUG_ON(type != EV_SW && type != EV_KEY);
102
103 return (type == EV_KEY) ? KEY_CNT : SW_CNT;
104}
105
106/**
107 * gpio_keys_disable_button() - disables given GPIO button
108 * @bdata: button data for button to be disabled
109 *
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.
114 *
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.
118 */
119static void gpio_keys_disable_button(struct gpio_button_data *bdata)
120{
121 if (!bdata->disabled) {
122 /*
8ed92556 123 * Disable IRQ and associated timer/work structure.
9e3af04f 124 */
d8ee4a1c 125 disable_irq(bdata->irq);
8ed92556
DT
126
127 if (gpio_is_valid(bdata->button->gpio))
128 cancel_delayed_work_sync(&bdata->work);
129 else
130 del_timer_sync(&bdata->release_timer);
9e3af04f
MW
131
132 bdata->disabled = true;
133 }
134}
135
136/**
137 * gpio_keys_enable_button() - enables given GPIO button
138 * @bdata: button data for button to be disabled
139 *
140 * Enables given button pointed by @bdata.
141 *
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.
145 */
146static void gpio_keys_enable_button(struct gpio_button_data *bdata)
147{
148 if (bdata->disabled) {
d8ee4a1c 149 enable_irq(bdata->irq);
9e3af04f
MW
150 bdata->disabled = false;
151 }
152}
153
154/**
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
161 * disabled
162 *
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
166 * errno on failure.
167 */
168static ssize_t gpio_keys_attr_show_helper(struct gpio_keys_drvdata *ddata,
169 char *buf, unsigned int type,
170 bool only_disabled)
171{
172 int n_events = get_n_events_by_type(type);
173 unsigned long *bits;
174 ssize_t ret;
175 int i;
176
177 bits = kcalloc(BITS_TO_LONGS(n_events), sizeof(*bits), GFP_KERNEL);
178 if (!bits)
179 return -ENOMEM;
180
219edc71 181 for (i = 0; i < ddata->pdata->nbuttons; i++) {
9e3af04f
MW
182 struct gpio_button_data *bdata = &ddata->data[i];
183
184 if (bdata->button->type != type)
185 continue;
186
187 if (only_disabled && !bdata->disabled)
188 continue;
189
190 __set_bit(bdata->button->code, bits);
191 }
192
0b480037 193 ret = scnprintf(buf, PAGE_SIZE - 1, "%*pbl", n_events, bits);
9e3af04f
MW
194 buf[ret++] = '\n';
195 buf[ret] = '\0';
196
197 kfree(bits);
198
199 return ret;
200}
201
202/**
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)
207 *
208 * This function parses stringified bitmap from @buf and disables/enables
a16ca239 209 * GPIO buttons accordingly. Returns 0 on success and negative error
9e3af04f
MW
210 * on failure.
211 */
212static ssize_t gpio_keys_attr_store_helper(struct gpio_keys_drvdata *ddata,
213 const char *buf, unsigned int type)
214{
215 int n_events = get_n_events_by_type(type);
216 unsigned long *bits;
217 ssize_t error;
218 int i;
219
220 bits = kcalloc(BITS_TO_LONGS(n_events), sizeof(*bits), GFP_KERNEL);
221 if (!bits)
222 return -ENOMEM;
223
224 error = bitmap_parselist(buf, bits, n_events);
225 if (error)
226 goto out;
227
228 /* First validate */
219edc71 229 for (i = 0; i < ddata->pdata->nbuttons; i++) {
9e3af04f
MW
230 struct gpio_button_data *bdata = &ddata->data[i];
231
232 if (bdata->button->type != type)
233 continue;
234
235 if (test_bit(bdata->button->code, bits) &&
236 !bdata->button->can_disable) {
237 error = -EINVAL;
238 goto out;
239 }
240 }
241
4ea14a53
PF
242 if (i == ddata->pdata->nbuttons) {
243 error = -EINVAL;
244 goto out;
245 }
246
9e3af04f
MW
247 mutex_lock(&ddata->disable_lock);
248
219edc71 249 for (i = 0; i < ddata->pdata->nbuttons; i++) {
9e3af04f
MW
250 struct gpio_button_data *bdata = &ddata->data[i];
251
252 if (bdata->button->type != type)
253 continue;
254
255 if (test_bit(bdata->button->code, bits))
256 gpio_keys_disable_button(bdata);
257 else
258 gpio_keys_enable_button(bdata);
259 }
260
261 mutex_unlock(&ddata->disable_lock);
262
263out:
264 kfree(bits);
265 return error;
266}
267
268#define ATTR_SHOW_FN(name, type, only_disabled) \
269static ssize_t gpio_keys_show_##name(struct device *dev, \
270 struct device_attribute *attr, \
271 char *buf) \
272{ \
273 struct platform_device *pdev = to_platform_device(dev); \
274 struct gpio_keys_drvdata *ddata = platform_get_drvdata(pdev); \
275 \
276 return gpio_keys_attr_show_helper(ddata, buf, \
277 type, only_disabled); \
278}
279
280ATTR_SHOW_FN(keys, EV_KEY, false);
281ATTR_SHOW_FN(switches, EV_SW, false);
282ATTR_SHOW_FN(disabled_keys, EV_KEY, true);
283ATTR_SHOW_FN(disabled_switches, EV_SW, true);
284
285/*
286 * ATTRIBUTES:
287 *
288 * /sys/devices/platform/gpio-keys/keys [ro]
289 * /sys/devices/platform/gpio-keys/switches [ro]
290 */
291static DEVICE_ATTR(keys, S_IRUGO, gpio_keys_show_keys, NULL);
292static DEVICE_ATTR(switches, S_IRUGO, gpio_keys_show_switches, NULL);
293
294#define ATTR_STORE_FN(name, type) \
295static ssize_t gpio_keys_store_##name(struct device *dev, \
296 struct device_attribute *attr, \
297 const char *buf, \
298 size_t count) \
299{ \
300 struct platform_device *pdev = to_platform_device(dev); \
301 struct gpio_keys_drvdata *ddata = platform_get_drvdata(pdev); \
302 ssize_t error; \
303 \
304 error = gpio_keys_attr_store_helper(ddata, buf, type); \
305 if (error) \
306 return error; \
307 \
308 return count; \
309}
310
311ATTR_STORE_FN(disabled_keys, EV_KEY);
312ATTR_STORE_FN(disabled_switches, EV_SW);
313
314/*
315 * ATTRIBUTES:
316 *
317 * /sys/devices/platform/gpio-keys/disabled_keys [rw]
318 * /sys/devices/platform/gpio-keys/disables_switches [rw]
319 */
320static DEVICE_ATTR(disabled_keys, S_IWUSR | S_IRUGO,
321 gpio_keys_show_disabled_keys,
322 gpio_keys_store_disabled_keys);
323static DEVICE_ATTR(disabled_switches, S_IWUSR | S_IRUGO,
324 gpio_keys_show_disabled_switches,
325 gpio_keys_store_disabled_switches);
326
327static struct attribute *gpio_keys_attrs[] = {
328 &dev_attr_keys.attr,
329 &dev_attr_switches.attr,
330 &dev_attr_disabled_keys.attr,
331 &dev_attr_disabled_switches.attr,
332 NULL,
333};
334
335static struct attribute_group gpio_keys_attr_group = {
336 .attrs = gpio_keys_attrs,
337};
338
d8ee4a1c 339static void gpio_keys_gpio_report_event(struct gpio_button_data *bdata)
a33466e3 340{
d9080921 341 const struct gpio_keys_button *button = bdata->button;
ce25d7e9 342 struct input_dev *input = bdata->input;
a33466e3 343 unsigned int type = button->type ?: EV_KEY;
94a8cab8 344 int state = (gpio_get_value_cansleep(button->gpio) ? 1 : 0) ^ button->active_low;
a33466e3 345
92a47674
AS
346 if (type == EV_ABS) {
347 if (state)
348 input_event(input, type, button->code, button->value);
349 } else {
350 input_event(input, type, button->code, !!state);
351 }
a33466e3
DB
352 input_sync(input);
353}
354
d8ee4a1c 355static void gpio_keys_gpio_work_func(struct work_struct *work)
6ee88d71
DM
356{
357 struct gpio_button_data *bdata =
8ed92556 358 container_of(work, struct gpio_button_data, work.work);
6ee88d71 359
d8ee4a1c 360 gpio_keys_gpio_report_event(bdata);
2fba26c6
N
361
362 if (bdata->button->wakeup)
363 pm_relax(bdata->input->dev.parent);
6ee88d71
DM
364}
365
d8ee4a1c 366static irqreturn_t gpio_keys_gpio_isr(int irq, void *dev_id)
78a56aab 367{
57ffe9d5 368 struct gpio_button_data *bdata = dev_id;
78a56aab 369
d8ee4a1c 370 BUG_ON(irq != bdata->irq);
84767d00 371
2fba26c6
N
372 if (bdata->button->wakeup)
373 pm_stay_awake(bdata->input->dev.parent);
8ed92556
DT
374
375 mod_delayed_work(system_wq,
376 &bdata->work,
377 msecs_to_jiffies(bdata->software_debounce));
78a56aab 378
57ffe9d5 379 return IRQ_HANDLED;
78a56aab
PB
380}
381
d8ee4a1c
LD
382static void gpio_keys_irq_timer(unsigned long _data)
383{
384 struct gpio_button_data *bdata = (struct gpio_button_data *)_data;
385 struct input_dev *input = bdata->input;
386 unsigned long flags;
387
388 spin_lock_irqsave(&bdata->lock, flags);
389 if (bdata->key_pressed) {
390 input_event(input, EV_KEY, bdata->button->code, 0);
391 input_sync(input);
392 bdata->key_pressed = false;
393 }
394 spin_unlock_irqrestore(&bdata->lock, flags);
395}
396
397static irqreturn_t gpio_keys_irq_isr(int irq, void *dev_id)
398{
399 struct gpio_button_data *bdata = dev_id;
400 const struct gpio_keys_button *button = bdata->button;
401 struct input_dev *input = bdata->input;
402 unsigned long flags;
403
404 BUG_ON(irq != bdata->irq);
405
406 spin_lock_irqsave(&bdata->lock, flags);
407
408 if (!bdata->key_pressed) {
2fba26c6
N
409 if (bdata->button->wakeup)
410 pm_wakeup_event(bdata->input->dev.parent, 0);
411
d8ee4a1c
LD
412 input_event(input, EV_KEY, button->code, 1);
413 input_sync(input);
414
8ed92556 415 if (!bdata->release_delay) {
d8ee4a1c
LD
416 input_event(input, EV_KEY, button->code, 0);
417 input_sync(input);
418 goto out;
419 }
420
421 bdata->key_pressed = true;
422 }
423
8ed92556
DT
424 if (bdata->release_delay)
425 mod_timer(&bdata->release_timer,
426 jiffies + msecs_to_jiffies(bdata->release_delay));
d8ee4a1c
LD
427out:
428 spin_unlock_irqrestore(&bdata->lock, flags);
429 return IRQ_HANDLED;
430}
431
27245519
AS
432static void gpio_keys_quiesce_key(void *data)
433{
434 struct gpio_button_data *bdata = data;
435
8ed92556
DT
436 if (gpio_is_valid(bdata->button->gpio))
437 cancel_delayed_work_sync(&bdata->work);
438 else
439 del_timer_sync(&bdata->release_timer);
27245519
AS
440}
441
5298cc4c
BP
442static int gpio_keys_setup_key(struct platform_device *pdev,
443 struct input_dev *input,
444 struct gpio_button_data *bdata,
445 const struct gpio_keys_button *button)
bc8f1eaf 446{
92a47674 447 const char *desc = button->desc ? button->desc : "gpio_keys";
9e3af04f 448 struct device *dev = &pdev->dev;
d8ee4a1c 449 irq_handler_t isr;
9e3af04f 450 unsigned long irqflags;
27245519
AS
451 int irq;
452 int error;
bc8f1eaf 453
d9080921
DT
454 bdata->input = input;
455 bdata->button = button;
d8ee4a1c 456 spin_lock_init(&bdata->lock);
bc8f1eaf 457
d8ee4a1c 458 if (gpio_is_valid(button->gpio)) {
bc8f1eaf 459
27245519
AS
460 error = devm_gpio_request_one(&pdev->dev, button->gpio,
461 GPIOF_IN, desc);
d8ee4a1c
LD
462 if (error < 0) {
463 dev_err(dev, "Failed to request GPIO %d, error %d\n",
464 button->gpio, error);
465 return error;
466 }
bc8f1eaf 467
d8ee4a1c
LD
468 if (button->debounce_interval) {
469 error = gpio_set_debounce(button->gpio,
470 button->debounce_interval * 1000);
471 /* use timer if gpiolib doesn't provide debounce */
472 if (error < 0)
8ed92556 473 bdata->software_debounce =
d8ee4a1c
LD
474 button->debounce_interval;
475 }
476
97d86e07
DT
477 if (button->irq) {
478 bdata->irq = button->irq;
479 } else {
480 irq = gpio_to_irq(button->gpio);
481 if (irq < 0) {
482 error = irq;
483 dev_err(dev,
484 "Unable to get irq number for GPIO %d, error %d\n",
485 button->gpio, error);
486 return error;
487 }
488 bdata->irq = irq;
d8ee4a1c 489 }
d8ee4a1c 490
8ed92556 491 INIT_DELAYED_WORK(&bdata->work, gpio_keys_gpio_work_func);
d8ee4a1c
LD
492
493 isr = gpio_keys_gpio_isr;
494 irqflags = IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING;
495
496 } else {
497 if (!button->irq) {
498 dev_err(dev, "No IRQ specified\n");
499 return -EINVAL;
500 }
501 bdata->irq = button->irq;
502
503 if (button->type && button->type != EV_KEY) {
504 dev_err(dev, "Only EV_KEY allowed for IRQ buttons.\n");
505 return -EINVAL;
506 }
507
8ed92556
DT
508 bdata->release_delay = button->debounce_interval;
509 setup_timer(&bdata->release_timer,
d8ee4a1c
LD
510 gpio_keys_irq_timer, (unsigned long)bdata);
511
512 isr = gpio_keys_irq_isr;
513 irqflags = 0;
bc8f1eaf
BD
514 }
515
d8ee4a1c
LD
516 input_set_capability(input, button->type ?: EV_KEY, button->code);
517
27245519 518 /*
8ed92556 519 * Install custom action to cancel release timer and
27245519
AS
520 * workqueue item.
521 */
522 error = devm_add_action(&pdev->dev, gpio_keys_quiesce_key, bdata);
523 if (error) {
524 dev_err(&pdev->dev,
525 "failed to register quiesce action, error: %d\n",
526 error);
527 return error;
528 }
529
9e3af04f
MW
530 /*
531 * If platform has specified that the button can be disabled,
532 * we don't want it to share the interrupt line.
533 */
534 if (!button->can_disable)
535 irqflags |= IRQF_SHARED;
536
27245519
AS
537 error = devm_request_any_context_irq(&pdev->dev, bdata->irq,
538 isr, irqflags, desc, bdata);
94a8cab8 539 if (error < 0) {
bc8f1eaf 540 dev_err(dev, "Unable to claim irq %d; error %d\n",
d8ee4a1c 541 bdata->irq, error);
27245519 542 return error;
bc8f1eaf
BD
543 }
544
545 return 0;
bc8f1eaf
BD
546}
547
5b76d7b4
DT
548static void gpio_keys_report_state(struct gpio_keys_drvdata *ddata)
549{
550 struct input_dev *input = ddata->input;
551 int i;
552
553 for (i = 0; i < ddata->pdata->nbuttons; i++) {
554 struct gpio_button_data *bdata = &ddata->data[i];
555 if (gpio_is_valid(bdata->button->gpio))
556 gpio_keys_gpio_report_event(bdata);
557 }
558 input_sync(input);
559}
560
173bdd74
S
561static int gpio_keys_open(struct input_dev *input)
562{
563 struct gpio_keys_drvdata *ddata = input_get_drvdata(input);
219edc71 564 const struct gpio_keys_platform_data *pdata = ddata->pdata;
5b76d7b4
DT
565 int error;
566
567 if (pdata->enable) {
568 error = pdata->enable(input->dev.parent);
569 if (error)
570 return error;
571 }
173bdd74 572
5b76d7b4
DT
573 /* Report current state of buttons that are connected to GPIOs */
574 gpio_keys_report_state(ddata);
575
576 return 0;
173bdd74
S
577}
578
579static void gpio_keys_close(struct input_dev *input)
580{
581 struct gpio_keys_drvdata *ddata = input_get_drvdata(input);
219edc71 582 const struct gpio_keys_platform_data *pdata = ddata->pdata;
173bdd74 583
219edc71
APS
584 if (pdata->disable)
585 pdata->disable(input->dev.parent);
173bdd74
S
586}
587
fd05d089
DJ
588/*
589 * Handlers for alternative sources of platform_data
590 */
219edc71 591
fd05d089
DJ
592#ifdef CONFIG_OF
593/*
594 * Translate OpenFirmware node properties into platform_data
595 */
5298cc4c 596static struct gpio_keys_platform_data *
219edc71 597gpio_keys_get_devtree_pdata(struct device *dev)
fd05d089
DJ
598{
599 struct device_node *node, *pp;
219edc71
APS
600 struct gpio_keys_platform_data *pdata;
601 struct gpio_keys_button *button;
602 int error;
603 int nbuttons;
fd05d089 604 int i;
fd05d089
DJ
605
606 node = dev->of_node;
5d422f2e
AS
607 if (!node)
608 return ERR_PTR(-ENODEV);
fd05d089 609
219edc71 610 nbuttons = of_get_child_count(node);
5d422f2e
AS
611 if (nbuttons == 0)
612 return ERR_PTR(-ENODEV);
fd05d089 613
5d422f2e
AS
614 pdata = devm_kzalloc(dev,
615 sizeof(*pdata) + nbuttons * sizeof(*button),
616 GFP_KERNEL);
617 if (!pdata)
618 return ERR_PTR(-ENOMEM);
fd05d089 619
219edc71
APS
620 pdata->buttons = (struct gpio_keys_button *)(pdata + 1);
621 pdata->nbuttons = nbuttons;
fd05d089 622
219edc71 623 pdata->rep = !!of_get_property(node, "autorepeat", NULL);
fd05d089 624
fd05d089 625 i = 0;
219edc71 626 for_each_child_of_node(node, pp) {
fd05d089
DJ
627 enum of_gpio_flags flags;
628
1d6a0136 629 button = &pdata->buttons[i++];
fd05d089 630
97d86e07
DT
631 button->gpio = of_get_gpio_flags(pp, 0, &flags);
632 if (button->gpio < 0) {
633 error = button->gpio;
634 if (error != -ENOENT) {
f2d347ff
AS
635 if (error != -EPROBE_DEFER)
636 dev_err(dev,
637 "Failed to get gpio flags, error: %d\n",
638 error);
639 return ERR_PTR(error);
640 }
97d86e07
DT
641 } else {
642 button->active_low = flags & OF_GPIO_ACTIVE_LOW;
e324ce61
DT
643 }
644
97d86e07
DT
645 button->irq = irq_of_parse_and_map(pp, 0);
646
647 if (!gpio_is_valid(button->gpio) && !button->irq) {
648 dev_err(dev, "Found button without gpios or irqs\n");
649 return ERR_PTR(-EINVAL);
650 }
fd05d089 651
219edc71
APS
652 if (of_property_read_u32(pp, "linux,code", &button->code)) {
653 dev_err(dev, "Button without keycode: 0x%x\n",
654 button->gpio);
5d422f2e 655 return ERR_PTR(-EINVAL);
219edc71 656 }
fd05d089 657
219edc71 658 button->desc = of_get_property(pp, "label", NULL);
fd05d089 659
219edc71
APS
660 if (of_property_read_u32(pp, "linux,input-type", &button->type))
661 button->type = EV_KEY;
662
99b4ffbd
DT
663 button->wakeup = of_property_read_bool(pp, "wakeup-source") ||
664 /* legacy name */
665 of_property_read_bool(pp, "gpio-key,wakeup");
fd05d089 666
97d86e07
DT
667 button->can_disable = !!of_get_property(pp, "linux,can-disable", NULL);
668
219edc71
APS
669 if (of_property_read_u32(pp, "debounce-interval",
670 &button->debounce_interval))
671 button->debounce_interval = 5;
fd05d089
DJ
672 }
673
5d422f2e
AS
674 if (pdata->nbuttons == 0)
675 return ERR_PTR(-EINVAL);
fd05d089 676
219edc71 677 return pdata;
fd05d089
DJ
678}
679
22daae31 680static const struct of_device_id gpio_keys_of_match[] = {
fd05d089
DJ
681 { .compatible = "gpio-keys", },
682 { },
683};
684MODULE_DEVICE_TABLE(of, gpio_keys_of_match);
685
686#else
687
219edc71
APS
688static inline struct gpio_keys_platform_data *
689gpio_keys_get_devtree_pdata(struct device *dev)
fd05d089 690{
219edc71 691 return ERR_PTR(-ENODEV);
fd05d089
DJ
692}
693
fd05d089
DJ
694#endif
695
5298cc4c 696static int gpio_keys_probe(struct platform_device *pdev)
78a56aab 697{
db19fd8b 698 struct device *dev = &pdev->dev;
219edc71
APS
699 const struct gpio_keys_platform_data *pdata = dev_get_platdata(dev);
700 struct gpio_keys_drvdata *ddata;
78a56aab 701 struct input_dev *input;
5d422f2e 702 size_t size;
78a56aab 703 int i, error;
e15b0213 704 int wakeup = 0;
78a56aab 705
fd05d089 706 if (!pdata) {
219edc71
APS
707 pdata = gpio_keys_get_devtree_pdata(dev);
708 if (IS_ERR(pdata))
709 return PTR_ERR(pdata);
fd05d089
DJ
710 }
711
5d422f2e
AS
712 size = sizeof(struct gpio_keys_drvdata) +
713 pdata->nbuttons * sizeof(struct gpio_button_data);
714 ddata = devm_kzalloc(dev, size, GFP_KERNEL);
715 if (!ddata) {
db19fd8b 716 dev_err(dev, "failed to allocate state\n");
5d422f2e
AS
717 return -ENOMEM;
718 }
719
720 input = devm_input_allocate_device(dev);
721 if (!input) {
722 dev_err(dev, "failed to allocate input device\n");
723 return -ENOMEM;
a33466e3 724 }
78a56aab 725
219edc71 726 ddata->pdata = pdata;
9e3af04f 727 ddata->input = input;
9e3af04f
MW
728 mutex_init(&ddata->disable_lock);
729
a33466e3 730 platform_set_drvdata(pdev, ddata);
173bdd74 731 input_set_drvdata(input, ddata);
78a56aab 732
46711277 733 input->name = pdata->name ? : pdev->name;
78a56aab 734 input->phys = "gpio-keys/input0";
469ba4df 735 input->dev.parent = &pdev->dev;
173bdd74
S
736 input->open = gpio_keys_open;
737 input->close = gpio_keys_close;
78a56aab
PB
738
739 input->id.bustype = BUS_HOST;
740 input->id.vendor = 0x0001;
741 input->id.product = 0x0001;
742 input->id.version = 0x0100;
743
b67b4b11
DC
744 /* Enable auto repeat feature of Linux input subsystem */
745 if (pdata->rep)
746 __set_bit(EV_REP, input->evbit);
747
78a56aab 748 for (i = 0; i < pdata->nbuttons; i++) {
d9080921 749 const struct gpio_keys_button *button = &pdata->buttons[i];
a33466e3 750 struct gpio_button_data *bdata = &ddata->data[i];
78a56aab 751
d9080921 752 error = gpio_keys_setup_key(pdev, input, bdata, button);
bc8f1eaf 753 if (error)
27245519 754 return error;
84767d00 755
e15b0213
AS
756 if (button->wakeup)
757 wakeup = 1;
78a56aab
PB
758 }
759
9e3af04f 760 error = sysfs_create_group(&pdev->dev.kobj, &gpio_keys_attr_group);
78a56aab 761 if (error) {
9e3af04f
MW
762 dev_err(dev, "Unable to export keys/switches, error: %d\n",
763 error);
27245519 764 return error;
78a56aab
PB
765 }
766
9e3af04f
MW
767 error = input_register_device(input);
768 if (error) {
769 dev_err(dev, "Unable to register input device, error: %d\n",
770 error);
27245519 771 goto err_remove_group;
9e3af04f
MW
772 }
773
e15b0213
AS
774 device_init_wakeup(&pdev->dev, wakeup);
775
78a56aab
PB
776 return 0;
777
27245519 778err_remove_group:
9e3af04f 779 sysfs_remove_group(&pdev->dev.kobj, &gpio_keys_attr_group);
78a56aab
PB
780 return error;
781}
782
e2619cf7 783static int gpio_keys_remove(struct platform_device *pdev)
78a56aab 784{
9e3af04f
MW
785 sysfs_remove_group(&pdev->dev.kobj, &gpio_keys_attr_group);
786
e15b0213
AS
787 device_init_wakeup(&pdev->dev, 0);
788
78a56aab
PB
789 return 0;
790}
791
bdda8216 792#ifdef CONFIG_PM_SLEEP
ae78e0e0 793static int gpio_keys_suspend(struct device *dev)
e15b0213 794{
fd05d089 795 struct gpio_keys_drvdata *ddata = dev_get_drvdata(dev);
dda19a92 796 struct input_dev *input = ddata->input;
e15b0213
AS
797 int i;
798
fd05d089 799 if (device_may_wakeup(dev)) {
219edc71 800 for (i = 0; i < ddata->pdata->nbuttons; i++) {
d8ee4a1c
LD
801 struct gpio_button_data *bdata = &ddata->data[i];
802 if (bdata->button->wakeup)
803 enable_irq_wake(bdata->irq);
e15b0213 804 }
dda19a92
JA
805 } else {
806 mutex_lock(&input->mutex);
807 if (input->users)
808 gpio_keys_close(input);
809 mutex_unlock(&input->mutex);
e15b0213
AS
810 }
811
812 return 0;
813}
814
ae78e0e0 815static int gpio_keys_resume(struct device *dev)
e15b0213 816{
fd05d089 817 struct gpio_keys_drvdata *ddata = dev_get_drvdata(dev);
dda19a92
JA
818 struct input_dev *input = ddata->input;
819 int error = 0;
e15b0213
AS
820 int i;
821
dda19a92
JA
822 if (device_may_wakeup(dev)) {
823 for (i = 0; i < ddata->pdata->nbuttons; i++) {
824 struct gpio_button_data *bdata = &ddata->data[i];
825 if (bdata->button->wakeup)
826 disable_irq_wake(bdata->irq);
827 }
828 } else {
829 mutex_lock(&input->mutex);
830 if (input->users)
831 error = gpio_keys_open(input);
832 mutex_unlock(&input->mutex);
e15b0213 833 }
5b76d7b4 834
dda19a92
JA
835 if (error)
836 return error;
e15b0213 837
dda19a92 838 gpio_keys_report_state(ddata);
e15b0213
AS
839 return 0;
840}
e15b0213
AS
841#endif
842
bdda8216
DT
843static SIMPLE_DEV_PM_OPS(gpio_keys_pm_ops, gpio_keys_suspend, gpio_keys_resume);
844
9b07044c 845static struct platform_driver gpio_keys_device_driver = {
78a56aab 846 .probe = gpio_keys_probe,
1cb0aa88 847 .remove = gpio_keys_remove,
78a56aab
PB
848 .driver = {
849 .name = "gpio-keys",
ae78e0e0 850 .pm = &gpio_keys_pm_ops,
219edc71 851 .of_match_table = of_match_ptr(gpio_keys_of_match),
78a56aab
PB
852 }
853};
854
855static int __init gpio_keys_init(void)
856{
857 return platform_driver_register(&gpio_keys_device_driver);
858}
859
860static void __exit gpio_keys_exit(void)
861{
862 platform_driver_unregister(&gpio_keys_device_driver);
863}
864
b2330205 865late_initcall(gpio_keys_init);
78a56aab
PB
866module_exit(gpio_keys_exit);
867
868MODULE_LICENSE("GPL");
869MODULE_AUTHOR("Phil Blundell <pb@handhelds.org>");
7e2ecdf4 870MODULE_DESCRIPTION("Keyboard driver for GPIOs");
d7b5247b 871MODULE_ALIAS("platform:gpio-keys");