blob: 8c98e97f8e41144a08c53e4c5ee1eefca9ebfb0f [file] [log] [blame]
Phil Blundell78a56aa2007-01-18 00:44:09 -05001/*
2 * Driver for keys on GPIO lines capable of generating interrupts.
3 *
4 * Copyright 2005 Phil Blundell
David Janderfd05d082011-07-09 12:41:46 -07005 * Copyright 2010, 2011 David Jander <david@protonic.nl>
Phil Blundell78a56aa2007-01-18 00:44:09 -05006 *
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>
Phil Blundell78a56aa2007-01-18 00:44:09 -050013
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>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090020#include <linux/slab.h>
Phil Blundell78a56aa2007-01-18 00:44:09 -050021#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>
David Brownell49015be2007-03-05 00:30:22 -080026#include <linux/gpio_keys.h>
Jani Nikulada0d03f2009-06-28 22:38:56 -070027#include <linux/workqueue.h>
Ben Dooks111bc592009-11-10 21:01:31 -080028#include <linux/gpio.h>
Sachin Kamat415a4ca2013-10-06 00:55:14 -070029#include <linux/of.h>
David Janderfd05d082011-07-09 12:41:46 -070030#include <linux/of_platform.h>
31#include <linux/of_gpio.h>
Laxman Dewangand8ee4a12012-03-19 17:54:31 -070032#include <linux/spinlock.h>
Phil Blundell78a56aa2007-01-18 00:44:09 -050033
Dmitry Baryshkova33466e2008-05-07 16:30:15 -040034struct gpio_button_data {
Dmitry Torokhovd9080922012-03-18 23:36:29 -070035 const struct gpio_keys_button *button;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -040036 struct input_dev *input;
Jani Nikulaca865a72009-06-28 22:38:44 -070037 struct timer_list timer;
Jani Nikulada0d03f2009-06-28 22:38:56 -070038 struct work_struct work;
Laxman Dewangand8ee4a12012-03-19 17:54:31 -070039 unsigned int timer_debounce; /* in msecs */
40 unsigned int irq;
41 spinlock_t lock;
Mika Westerberg9e3af042010-02-04 00:48:00 -080042 bool disabled;
Laxman Dewangand8ee4a12012-03-19 17:54:31 -070043 bool key_pressed;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -040044};
45
46struct gpio_keys_drvdata {
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -070047 const struct gpio_keys_platform_data *pdata;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -040048 struct input_dev *input;
Mika Westerberg9e3af042010-02-04 00:48:00 -080049 struct mutex disable_lock;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -040050 struct gpio_button_data data[0];
51};
52
Mika Westerberg9e3af042010-02-04 00:48:00 -080053/*
54 * SYSFS interface for enabling/disabling keys and switches:
55 *
56 * There are 4 attributes under /sys/devices/platform/gpio-keys/
57 * keys [ro] - bitmap of keys (EV_KEY) which can be
58 * disabled
59 * switches [ro] - bitmap of switches (EV_SW) which can be
60 * disabled
61 * disabled_keys [rw] - bitmap of keys currently disabled
62 * disabled_switches [rw] - bitmap of switches currently disabled
63 *
64 * Userland can change these values and hence disable event generation
65 * for each key (or switch). Disabling a key means its interrupt line
66 * is disabled.
67 *
68 * For example, if we have following switches set up as gpio-keys:
69 * SW_DOCK = 5
70 * SW_CAMERA_LENS_COVER = 9
71 * SW_KEYPAD_SLIDE = 10
72 * SW_FRONT_PROXIMITY = 11
73 * This is read from switches:
74 * 11-9,5
75 * Next we want to disable proximity (11) and dock (5), we write:
76 * 11,5
77 * to file disabled_switches. Now proximity and dock IRQs are disabled.
78 * This can be verified by reading the file disabled_switches:
79 * 11,5
80 * If we now want to enable proximity (11) switch we write:
81 * 5
82 * to disabled_switches.
83 *
84 * We can disable only those keys which don't allow sharing the irq.
85 */
86
87/**
88 * get_n_events_by_type() - returns maximum number of events per @type
89 * @type: type of button (%EV_KEY, %EV_SW)
90 *
91 * Return value of this function can be used to allocate bitmap
92 * large enough to hold all bits for given type.
93 */
94static inline int get_n_events_by_type(int type)
95{
96 BUG_ON(type != EV_SW && type != EV_KEY);
97
98 return (type == EV_KEY) ? KEY_CNT : SW_CNT;
99}
100
101/**
102 * gpio_keys_disable_button() - disables given GPIO button
103 * @bdata: button data for button to be disabled
104 *
105 * Disables button pointed by @bdata. This is done by masking
106 * IRQ line. After this function is called, button won't generate
107 * input events anymore. Note that one can only disable buttons
108 * that don't share IRQs.
109 *
110 * Make sure that @bdata->disable_lock is locked when entering
111 * this function to avoid races when concurrent threads are
112 * disabling buttons at the same time.
113 */
114static void gpio_keys_disable_button(struct gpio_button_data *bdata)
115{
116 if (!bdata->disabled) {
117 /*
118 * Disable IRQ and possible debouncing timer.
119 */
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700120 disable_irq(bdata->irq);
Grazvydas Ignotas28ed6842010-06-28 10:59:32 -0700121 if (bdata->timer_debounce)
Mika Westerberg9e3af042010-02-04 00:48:00 -0800122 del_timer_sync(&bdata->timer);
123
124 bdata->disabled = true;
125 }
126}
127
128/**
129 * gpio_keys_enable_button() - enables given GPIO button
130 * @bdata: button data for button to be disabled
131 *
132 * Enables given button pointed by @bdata.
133 *
134 * Make sure that @bdata->disable_lock is locked when entering
135 * this function to avoid races with concurrent threads trying
136 * to enable the same button at the same time.
137 */
138static void gpio_keys_enable_button(struct gpio_button_data *bdata)
139{
140 if (bdata->disabled) {
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700141 enable_irq(bdata->irq);
Mika Westerberg9e3af042010-02-04 00:48:00 -0800142 bdata->disabled = false;
143 }
144}
145
146/**
147 * gpio_keys_attr_show_helper() - fill in stringified bitmap of buttons
148 * @ddata: pointer to drvdata
149 * @buf: buffer where stringified bitmap is written
150 * @type: button type (%EV_KEY, %EV_SW)
151 * @only_disabled: does caller want only those buttons that are
152 * currently disabled or all buttons that can be
153 * disabled
154 *
155 * This function writes buttons that can be disabled to @buf. If
156 * @only_disabled is true, then @buf contains only those buttons
157 * that are currently disabled. Returns 0 on success or negative
158 * errno on failure.
159 */
160static ssize_t gpio_keys_attr_show_helper(struct gpio_keys_drvdata *ddata,
161 char *buf, unsigned int type,
162 bool only_disabled)
163{
164 int n_events = get_n_events_by_type(type);
165 unsigned long *bits;
166 ssize_t ret;
167 int i;
168
169 bits = kcalloc(BITS_TO_LONGS(n_events), sizeof(*bits), GFP_KERNEL);
170 if (!bits)
171 return -ENOMEM;
172
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700173 for (i = 0; i < ddata->pdata->nbuttons; i++) {
Mika Westerberg9e3af042010-02-04 00:48:00 -0800174 struct gpio_button_data *bdata = &ddata->data[i];
175
176 if (bdata->button->type != type)
177 continue;
178
179 if (only_disabled && !bdata->disabled)
180 continue;
181
182 __set_bit(bdata->button->code, bits);
183 }
184
185 ret = bitmap_scnlistprintf(buf, PAGE_SIZE - 2, bits, n_events);
186 buf[ret++] = '\n';
187 buf[ret] = '\0';
188
189 kfree(bits);
190
191 return ret;
192}
193
194/**
195 * gpio_keys_attr_store_helper() - enable/disable buttons based on given bitmap
196 * @ddata: pointer to drvdata
197 * @buf: buffer from userspace that contains stringified bitmap
198 * @type: button type (%EV_KEY, %EV_SW)
199 *
200 * This function parses stringified bitmap from @buf and disables/enables
Dmitry Torokhova16ca232012-03-18 23:36:30 -0700201 * GPIO buttons accordingly. Returns 0 on success and negative error
Mika Westerberg9e3af042010-02-04 00:48:00 -0800202 * on failure.
203 */
204static ssize_t gpio_keys_attr_store_helper(struct gpio_keys_drvdata *ddata,
205 const char *buf, unsigned int type)
206{
207 int n_events = get_n_events_by_type(type);
208 unsigned long *bits;
209 ssize_t error;
210 int i;
211
212 bits = kcalloc(BITS_TO_LONGS(n_events), sizeof(*bits), GFP_KERNEL);
213 if (!bits)
214 return -ENOMEM;
215
216 error = bitmap_parselist(buf, bits, n_events);
217 if (error)
218 goto out;
219
220 /* First validate */
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700221 for (i = 0; i < ddata->pdata->nbuttons; i++) {
Mika Westerberg9e3af042010-02-04 00:48:00 -0800222 struct gpio_button_data *bdata = &ddata->data[i];
223
224 if (bdata->button->type != type)
225 continue;
226
227 if (test_bit(bdata->button->code, bits) &&
228 !bdata->button->can_disable) {
229 error = -EINVAL;
230 goto out;
231 }
232 }
233
234 mutex_lock(&ddata->disable_lock);
235
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700236 for (i = 0; i < ddata->pdata->nbuttons; i++) {
Mika Westerberg9e3af042010-02-04 00:48:00 -0800237 struct gpio_button_data *bdata = &ddata->data[i];
238
239 if (bdata->button->type != type)
240 continue;
241
242 if (test_bit(bdata->button->code, bits))
243 gpio_keys_disable_button(bdata);
244 else
245 gpio_keys_enable_button(bdata);
246 }
247
248 mutex_unlock(&ddata->disable_lock);
249
250out:
251 kfree(bits);
252 return error;
253}
254
255#define ATTR_SHOW_FN(name, type, only_disabled) \
256static ssize_t gpio_keys_show_##name(struct device *dev, \
257 struct device_attribute *attr, \
258 char *buf) \
259{ \
260 struct platform_device *pdev = to_platform_device(dev); \
261 struct gpio_keys_drvdata *ddata = platform_get_drvdata(pdev); \
262 \
263 return gpio_keys_attr_show_helper(ddata, buf, \
264 type, only_disabled); \
265}
266
267ATTR_SHOW_FN(keys, EV_KEY, false);
268ATTR_SHOW_FN(switches, EV_SW, false);
269ATTR_SHOW_FN(disabled_keys, EV_KEY, true);
270ATTR_SHOW_FN(disabled_switches, EV_SW, true);
271
272/*
273 * ATTRIBUTES:
274 *
275 * /sys/devices/platform/gpio-keys/keys [ro]
276 * /sys/devices/platform/gpio-keys/switches [ro]
277 */
278static DEVICE_ATTR(keys, S_IRUGO, gpio_keys_show_keys, NULL);
279static DEVICE_ATTR(switches, S_IRUGO, gpio_keys_show_switches, NULL);
280
281#define ATTR_STORE_FN(name, type) \
282static ssize_t gpio_keys_store_##name(struct device *dev, \
283 struct device_attribute *attr, \
284 const char *buf, \
285 size_t count) \
286{ \
287 struct platform_device *pdev = to_platform_device(dev); \
288 struct gpio_keys_drvdata *ddata = platform_get_drvdata(pdev); \
289 ssize_t error; \
290 \
291 error = gpio_keys_attr_store_helper(ddata, buf, type); \
292 if (error) \
293 return error; \
294 \
295 return count; \
296}
297
298ATTR_STORE_FN(disabled_keys, EV_KEY);
299ATTR_STORE_FN(disabled_switches, EV_SW);
300
301/*
302 * ATTRIBUTES:
303 *
304 * /sys/devices/platform/gpio-keys/disabled_keys [rw]
305 * /sys/devices/platform/gpio-keys/disables_switches [rw]
306 */
307static DEVICE_ATTR(disabled_keys, S_IWUSR | S_IRUGO,
308 gpio_keys_show_disabled_keys,
309 gpio_keys_store_disabled_keys);
310static DEVICE_ATTR(disabled_switches, S_IWUSR | S_IRUGO,
311 gpio_keys_show_disabled_switches,
312 gpio_keys_store_disabled_switches);
313
314static struct attribute *gpio_keys_attrs[] = {
315 &dev_attr_keys.attr,
316 &dev_attr_switches.attr,
317 &dev_attr_disabled_keys.attr,
318 &dev_attr_disabled_switches.attr,
319 NULL,
320};
321
322static struct attribute_group gpio_keys_attr_group = {
323 .attrs = gpio_keys_attrs,
324};
325
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700326static void gpio_keys_gpio_report_event(struct gpio_button_data *bdata)
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400327{
Dmitry Torokhovd9080922012-03-18 23:36:29 -0700328 const struct gpio_keys_button *button = bdata->button;
Uwe Kleine-Königce25d7e2008-08-08 12:14:36 -0400329 struct input_dev *input = bdata->input;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400330 unsigned int type = button->type ?: EV_KEY;
Philippe Langlais94a8cab2011-01-20 23:09:30 -0800331 int state = (gpio_get_value_cansleep(button->gpio) ? 1 : 0) ^ button->active_low;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400332
Alexander Stein92a47672011-04-11 23:34:37 -0700333 if (type == EV_ABS) {
334 if (state)
335 input_event(input, type, button->code, button->value);
336 } else {
337 input_event(input, type, button->code, !!state);
338 }
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400339 input_sync(input);
340}
341
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700342static void gpio_keys_gpio_work_func(struct work_struct *work)
Daniel Mack6ee88d72009-11-30 00:04:02 -0800343{
344 struct gpio_button_data *bdata =
345 container_of(work, struct gpio_button_data, work);
346
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700347 gpio_keys_gpio_report_event(bdata);
NeilBrown2fba26c2012-07-29 22:18:47 -0700348
349 if (bdata->button->wakeup)
350 pm_relax(bdata->input->dev.parent);
Daniel Mack6ee88d72009-11-30 00:04:02 -0800351}
352
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700353static void gpio_keys_gpio_timer(unsigned long _data)
Jani Nikulaca865a72009-06-28 22:38:44 -0700354{
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700355 struct gpio_button_data *bdata = (struct gpio_button_data *)_data;
Jani Nikulaca865a72009-06-28 22:38:44 -0700356
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700357 schedule_work(&bdata->work);
Jani Nikulaca865a72009-06-28 22:38:44 -0700358}
359
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700360static irqreturn_t gpio_keys_gpio_isr(int irq, void *dev_id)
Phil Blundell78a56aa2007-01-18 00:44:09 -0500361{
Uwe Kleine-König57ffe9d2008-08-08 12:14:34 -0400362 struct gpio_button_data *bdata = dev_id;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500363
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700364 BUG_ON(irq != bdata->irq);
Phil Blundell78a56aa2007-01-18 00:44:09 -0500365
NeilBrown2fba26c2012-07-29 22:18:47 -0700366 if (bdata->button->wakeup)
367 pm_stay_awake(bdata->input->dev.parent);
Grazvydas Ignotas28ed6842010-06-28 10:59:32 -0700368 if (bdata->timer_debounce)
Jani Nikulaca865a72009-06-28 22:38:44 -0700369 mod_timer(&bdata->timer,
Grazvydas Ignotas28ed6842010-06-28 10:59:32 -0700370 jiffies + msecs_to_jiffies(bdata->timer_debounce));
Jani Nikulaca865a72009-06-28 22:38:44 -0700371 else
Jani Nikulada0d03f2009-06-28 22:38:56 -0700372 schedule_work(&bdata->work);
Roman Moravcik84767d02007-05-01 00:39:13 -0400373
Uwe Kleine-König57ffe9d2008-08-08 12:14:34 -0400374 return IRQ_HANDLED;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500375}
376
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700377static void gpio_keys_irq_timer(unsigned long _data)
378{
379 struct gpio_button_data *bdata = (struct gpio_button_data *)_data;
380 struct input_dev *input = bdata->input;
381 unsigned long flags;
382
383 spin_lock_irqsave(&bdata->lock, flags);
384 if (bdata->key_pressed) {
385 input_event(input, EV_KEY, bdata->button->code, 0);
386 input_sync(input);
387 bdata->key_pressed = false;
388 }
389 spin_unlock_irqrestore(&bdata->lock, flags);
390}
391
392static irqreturn_t gpio_keys_irq_isr(int irq, void *dev_id)
393{
394 struct gpio_button_data *bdata = dev_id;
395 const struct gpio_keys_button *button = bdata->button;
396 struct input_dev *input = bdata->input;
397 unsigned long flags;
398
399 BUG_ON(irq != bdata->irq);
400
401 spin_lock_irqsave(&bdata->lock, flags);
402
403 if (!bdata->key_pressed) {
NeilBrown2fba26c2012-07-29 22:18:47 -0700404 if (bdata->button->wakeup)
405 pm_wakeup_event(bdata->input->dev.parent, 0);
406
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700407 input_event(input, EV_KEY, button->code, 1);
408 input_sync(input);
409
410 if (!bdata->timer_debounce) {
411 input_event(input, EV_KEY, button->code, 0);
412 input_sync(input);
413 goto out;
414 }
415
416 bdata->key_pressed = true;
417 }
418
419 if (bdata->timer_debounce)
420 mod_timer(&bdata->timer,
421 jiffies + msecs_to_jiffies(bdata->timer_debounce));
422out:
423 spin_unlock_irqrestore(&bdata->lock, flags);
424 return IRQ_HANDLED;
425}
426
Alexander Shiyan27245512014-04-28 09:52:36 -0700427static void gpio_keys_quiesce_key(void *data)
428{
429 struct gpio_button_data *bdata = data;
430
431 if (bdata->timer_debounce)
432 del_timer_sync(&bdata->timer);
433
434 cancel_work_sync(&bdata->work);
435}
436
Bill Pemberton5298cc42012-11-23 21:38:25 -0800437static int gpio_keys_setup_key(struct platform_device *pdev,
438 struct input_dev *input,
439 struct gpio_button_data *bdata,
440 const struct gpio_keys_button *button)
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800441{
Alexander Stein92a47672011-04-11 23:34:37 -0700442 const char *desc = button->desc ? button->desc : "gpio_keys";
Mika Westerberg9e3af042010-02-04 00:48:00 -0800443 struct device *dev = &pdev->dev;
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700444 irq_handler_t isr;
Mika Westerberg9e3af042010-02-04 00:48:00 -0800445 unsigned long irqflags;
Alexander Shiyan27245512014-04-28 09:52:36 -0700446 int irq;
447 int error;
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800448
Dmitry Torokhovd9080922012-03-18 23:36:29 -0700449 bdata->input = input;
450 bdata->button = button;
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700451 spin_lock_init(&bdata->lock);
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800452
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700453 if (gpio_is_valid(button->gpio)) {
454
Alexander Shiyan27245512014-04-28 09:52:36 -0700455 error = devm_gpio_request_one(&pdev->dev, button->gpio,
456 GPIOF_IN, desc);
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700457 if (error < 0) {
458 dev_err(dev, "Failed to request GPIO %d, error %d\n",
459 button->gpio, error);
460 return error;
461 }
462
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700463 if (button->debounce_interval) {
464 error = gpio_set_debounce(button->gpio,
465 button->debounce_interval * 1000);
466 /* use timer if gpiolib doesn't provide debounce */
467 if (error < 0)
468 bdata->timer_debounce =
469 button->debounce_interval;
470 }
471
472 irq = gpio_to_irq(button->gpio);
473 if (irq < 0) {
474 error = irq;
475 dev_err(dev,
476 "Unable to get irq number for GPIO %d, error %d\n",
477 button->gpio, error);
Alexander Shiyan27245512014-04-28 09:52:36 -0700478 return error;
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700479 }
480 bdata->irq = irq;
481
482 INIT_WORK(&bdata->work, gpio_keys_gpio_work_func);
483 setup_timer(&bdata->timer,
484 gpio_keys_gpio_timer, (unsigned long)bdata);
485
486 isr = gpio_keys_gpio_isr;
487 irqflags = IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING;
488
489 } else {
490 if (!button->irq) {
491 dev_err(dev, "No IRQ specified\n");
492 return -EINVAL;
493 }
494 bdata->irq = button->irq;
495
496 if (button->type && button->type != EV_KEY) {
497 dev_err(dev, "Only EV_KEY allowed for IRQ buttons.\n");
498 return -EINVAL;
499 }
500
501 bdata->timer_debounce = button->debounce_interval;
502 setup_timer(&bdata->timer,
503 gpio_keys_irq_timer, (unsigned long)bdata);
504
505 isr = gpio_keys_irq_isr;
506 irqflags = 0;
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800507 }
508
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700509 input_set_capability(input, button->type ?: EV_KEY, button->code);
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800510
Mika Westerberg9e3af042010-02-04 00:48:00 -0800511 /*
Alexander Shiyan27245512014-04-28 09:52:36 -0700512 * Install custom action to cancel debounce timer and
513 * workqueue item.
514 */
515 error = devm_add_action(&pdev->dev, gpio_keys_quiesce_key, bdata);
516 if (error) {
517 dev_err(&pdev->dev,
518 "failed to register quiesce action, error: %d\n",
519 error);
520 return error;
521 }
522
523 /*
Mika Westerberg9e3af042010-02-04 00:48:00 -0800524 * If platform has specified that the button can be disabled,
525 * we don't want it to share the interrupt line.
526 */
527 if (!button->can_disable)
528 irqflags |= IRQF_SHARED;
529
Alexander Shiyan27245512014-04-28 09:52:36 -0700530 error = devm_request_any_context_irq(&pdev->dev, bdata->irq,
531 isr, irqflags, desc, bdata);
Philippe Langlais94a8cab2011-01-20 23:09:30 -0800532 if (error < 0) {
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800533 dev_err(dev, "Unable to claim irq %d; error %d\n",
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700534 bdata->irq, error);
Alexander Shiyan27245512014-04-28 09:52:36 -0700535 return error;
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800536 }
537
538 return 0;
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800539}
540
Dmitry Torokhov5b76d7b2012-11-24 01:22:43 -0800541static void gpio_keys_report_state(struct gpio_keys_drvdata *ddata)
542{
543 struct input_dev *input = ddata->input;
544 int i;
545
546 for (i = 0; i < ddata->pdata->nbuttons; i++) {
547 struct gpio_button_data *bdata = &ddata->data[i];
548 if (gpio_is_valid(bdata->button->gpio))
549 gpio_keys_gpio_report_event(bdata);
550 }
551 input_sync(input);
552}
553
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700554static int gpio_keys_open(struct input_dev *input)
555{
556 struct gpio_keys_drvdata *ddata = input_get_drvdata(input);
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700557 const struct gpio_keys_platform_data *pdata = ddata->pdata;
Dmitry Torokhov5b76d7b2012-11-24 01:22:43 -0800558 int error;
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700559
Dmitry Torokhov5b76d7b2012-11-24 01:22:43 -0800560 if (pdata->enable) {
561 error = pdata->enable(input->dev.parent);
562 if (error)
563 return error;
564 }
565
566 /* Report current state of buttons that are connected to GPIOs */
567 gpio_keys_report_state(ddata);
568
569 return 0;
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700570}
571
572static void gpio_keys_close(struct input_dev *input)
573{
574 struct gpio_keys_drvdata *ddata = input_get_drvdata(input);
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700575 const struct gpio_keys_platform_data *pdata = ddata->pdata;
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700576
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700577 if (pdata->disable)
578 pdata->disable(input->dev.parent);
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700579}
580
David Janderfd05d082011-07-09 12:41:46 -0700581/*
582 * Handlers for alternative sources of platform_data
583 */
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700584
David Janderfd05d082011-07-09 12:41:46 -0700585#ifdef CONFIG_OF
586/*
587 * Translate OpenFirmware node properties into platform_data
588 */
Bill Pemberton5298cc42012-11-23 21:38:25 -0800589static struct gpio_keys_platform_data *
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700590gpio_keys_get_devtree_pdata(struct device *dev)
David Janderfd05d082011-07-09 12:41:46 -0700591{
592 struct device_node *node, *pp;
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700593 struct gpio_keys_platform_data *pdata;
594 struct gpio_keys_button *button;
595 int error;
596 int nbuttons;
David Janderfd05d082011-07-09 12:41:46 -0700597 int i;
David Janderfd05d082011-07-09 12:41:46 -0700598
599 node = dev->of_node;
Andy Shevchenko5d422f22014-04-25 14:21:59 -0700600 if (!node)
601 return ERR_PTR(-ENODEV);
David Janderfd05d082011-07-09 12:41:46 -0700602
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700603 nbuttons = of_get_child_count(node);
Andy Shevchenko5d422f22014-04-25 14:21:59 -0700604 if (nbuttons == 0)
605 return ERR_PTR(-ENODEV);
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700606
Andy Shevchenko5d422f22014-04-25 14:21:59 -0700607 pdata = devm_kzalloc(dev,
608 sizeof(*pdata) + nbuttons * sizeof(*button),
609 GFP_KERNEL);
610 if (!pdata)
611 return ERR_PTR(-ENOMEM);
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700612
613 pdata->buttons = (struct gpio_keys_button *)(pdata + 1);
614 pdata->nbuttons = nbuttons;
David Janderfd05d082011-07-09 12:41:46 -0700615
Tobias Klausercca84692011-09-09 11:09:50 -0700616 pdata->rep = !!of_get_property(node, "autorepeat", NULL);
David Janderfd05d082011-07-09 12:41:46 -0700617
David Janderfd05d082011-07-09 12:41:46 -0700618 i = 0;
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700619 for_each_child_of_node(node, pp) {
Dmitry Torokhove324ce62012-12-24 09:32:46 -0800620 int gpio;
David Janderfd05d082011-07-09 12:41:46 -0700621 enum of_gpio_flags flags;
622
623 if (!of_find_property(pp, "gpios", NULL)) {
624 pdata->nbuttons--;
625 dev_warn(dev, "Found button without gpios\n");
626 continue;
627 }
David Janderfd05d082011-07-09 12:41:46 -0700628
Dmitry Torokhove324ce62012-12-24 09:32:46 -0800629 gpio = of_get_gpio_flags(pp, 0, &flags);
630 if (gpio < 0) {
631 error = gpio;
632 if (error != -EPROBE_DEFER)
633 dev_err(dev,
634 "Failed to get gpio flags, error: %d\n",
635 error);
Andy Shevchenko5d422f22014-04-25 14:21:59 -0700636 return ERR_PTR(error);
Dmitry Torokhove324ce62012-12-24 09:32:46 -0800637 }
638
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700639 button = &pdata->buttons[i++];
640
Dmitry Torokhove324ce62012-12-24 09:32:46 -0800641 button->gpio = gpio;
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700642 button->active_low = flags & OF_GPIO_ACTIVE_LOW;
643
644 if (of_property_read_u32(pp, "linux,code", &button->code)) {
645 dev_err(dev, "Button without keycode: 0x%x\n",
646 button->gpio);
Andy Shevchenko5d422f22014-04-25 14:21:59 -0700647 return ERR_PTR(-EINVAL);
David Janderfd05d082011-07-09 12:41:46 -0700648 }
David Janderfd05d082011-07-09 12:41:46 -0700649
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700650 button->desc = of_get_property(pp, "label", NULL);
David Janderfd05d082011-07-09 12:41:46 -0700651
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700652 if (of_property_read_u32(pp, "linux,input-type", &button->type))
653 button->type = EV_KEY;
David Janderfd05d082011-07-09 12:41:46 -0700654
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700655 button->wakeup = !!of_get_property(pp, "gpio-key,wakeup", NULL);
David Janderfd05d082011-07-09 12:41:46 -0700656
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700657 if (of_property_read_u32(pp, "debounce-interval",
658 &button->debounce_interval))
659 button->debounce_interval = 5;
David Janderfd05d082011-07-09 12:41:46 -0700660 }
661
Andy Shevchenko5d422f22014-04-25 14:21:59 -0700662 if (pdata->nbuttons == 0)
663 return ERR_PTR(-EINVAL);
David Janderfd05d082011-07-09 12:41:46 -0700664
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700665 return pdata;
David Janderfd05d082011-07-09 12:41:46 -0700666}
667
Jingoo Han22daae32014-05-07 12:58:06 -0700668static const struct of_device_id gpio_keys_of_match[] = {
David Janderfd05d082011-07-09 12:41:46 -0700669 { .compatible = "gpio-keys", },
670 { },
671};
672MODULE_DEVICE_TABLE(of, gpio_keys_of_match);
673
674#else
675
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700676static inline struct gpio_keys_platform_data *
677gpio_keys_get_devtree_pdata(struct device *dev)
David Janderfd05d082011-07-09 12:41:46 -0700678{
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700679 return ERR_PTR(-ENODEV);
David Janderfd05d082011-07-09 12:41:46 -0700680}
681
David Janderfd05d082011-07-09 12:41:46 -0700682#endif
683
Bill Pemberton5298cc42012-11-23 21:38:25 -0800684static int gpio_keys_probe(struct platform_device *pdev)
Phil Blundell78a56aa2007-01-18 00:44:09 -0500685{
Ben Dooksdb19fd82009-11-10 21:00:35 -0800686 struct device *dev = &pdev->dev;
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700687 const struct gpio_keys_platform_data *pdata = dev_get_platdata(dev);
688 struct gpio_keys_drvdata *ddata;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500689 struct input_dev *input;
Andy Shevchenko5d422f22014-04-25 14:21:59 -0700690 size_t size;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500691 int i, error;
Anti Sulline15b0212007-09-26 00:01:17 -0400692 int wakeup = 0;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500693
David Janderfd05d082011-07-09 12:41:46 -0700694 if (!pdata) {
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700695 pdata = gpio_keys_get_devtree_pdata(dev);
696 if (IS_ERR(pdata))
697 return PTR_ERR(pdata);
David Janderfd05d082011-07-09 12:41:46 -0700698 }
699
Andy Shevchenko5d422f22014-04-25 14:21:59 -0700700 size = sizeof(struct gpio_keys_drvdata) +
701 pdata->nbuttons * sizeof(struct gpio_button_data);
702 ddata = devm_kzalloc(dev, size, GFP_KERNEL);
703 if (!ddata) {
Ben Dooksdb19fd82009-11-10 21:00:35 -0800704 dev_err(dev, "failed to allocate state\n");
Andy Shevchenko5d422f22014-04-25 14:21:59 -0700705 return -ENOMEM;
706 }
707
708 input = devm_input_allocate_device(dev);
709 if (!input) {
710 dev_err(dev, "failed to allocate input device\n");
711 return -ENOMEM;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400712 }
Phil Blundell78a56aa2007-01-18 00:44:09 -0500713
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700714 ddata->pdata = pdata;
Mika Westerberg9e3af042010-02-04 00:48:00 -0800715 ddata->input = input;
Mika Westerberg9e3af042010-02-04 00:48:00 -0800716 mutex_init(&ddata->disable_lock);
717
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400718 platform_set_drvdata(pdev, ddata);
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700719 input_set_drvdata(input, ddata);
Phil Blundell78a56aa2007-01-18 00:44:09 -0500720
Alexander Stein46711272011-04-11 23:34:48 -0700721 input->name = pdata->name ? : pdev->name;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500722 input->phys = "gpio-keys/input0";
Dmitry Torokhov469ba4d2007-04-12 01:34:58 -0400723 input->dev.parent = &pdev->dev;
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700724 input->open = gpio_keys_open;
725 input->close = gpio_keys_close;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500726
727 input->id.bustype = BUS_HOST;
728 input->id.vendor = 0x0001;
729 input->id.product = 0x0001;
730 input->id.version = 0x0100;
731
Dominic Curranb67b4b12008-10-27 22:30:53 -0400732 /* Enable auto repeat feature of Linux input subsystem */
733 if (pdata->rep)
734 __set_bit(EV_REP, input->evbit);
735
Phil Blundell78a56aa2007-01-18 00:44:09 -0500736 for (i = 0; i < pdata->nbuttons; i++) {
Dmitry Torokhovd9080922012-03-18 23:36:29 -0700737 const struct gpio_keys_button *button = &pdata->buttons[i];
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400738 struct gpio_button_data *bdata = &ddata->data[i];
Phil Blundell78a56aa2007-01-18 00:44:09 -0500739
Dmitry Torokhovd9080922012-03-18 23:36:29 -0700740 error = gpio_keys_setup_key(pdev, input, bdata, button);
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800741 if (error)
Alexander Shiyan27245512014-04-28 09:52:36 -0700742 return error;
Roman Moravcik84767d02007-05-01 00:39:13 -0400743
Anti Sulline15b0212007-09-26 00:01:17 -0400744 if (button->wakeup)
745 wakeup = 1;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500746 }
747
Mika Westerberg9e3af042010-02-04 00:48:00 -0800748 error = sysfs_create_group(&pdev->dev.kobj, &gpio_keys_attr_group);
749 if (error) {
750 dev_err(dev, "Unable to export keys/switches, error: %d\n",
751 error);
Alexander Shiyan27245512014-04-28 09:52:36 -0700752 return error;
Mika Westerberg9e3af042010-02-04 00:48:00 -0800753 }
754
Phil Blundell78a56aa2007-01-18 00:44:09 -0500755 error = input_register_device(input);
756 if (error) {
Mika Westerberg9e3af042010-02-04 00:48:00 -0800757 dev_err(dev, "Unable to register input device, error: %d\n",
758 error);
Alexander Shiyan27245512014-04-28 09:52:36 -0700759 goto err_remove_group;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500760 }
761
Anti Sulline15b0212007-09-26 00:01:17 -0400762 device_init_wakeup(&pdev->dev, wakeup);
763
Phil Blundell78a56aa2007-01-18 00:44:09 -0500764 return 0;
765
Alexander Shiyan27245512014-04-28 09:52:36 -0700766err_remove_group:
Mika Westerberg9e3af042010-02-04 00:48:00 -0800767 sysfs_remove_group(&pdev->dev.kobj, &gpio_keys_attr_group);
Phil Blundell78a56aa2007-01-18 00:44:09 -0500768 return error;
769}
770
Bill Pembertone2619cf2012-11-23 21:50:47 -0800771static int gpio_keys_remove(struct platform_device *pdev)
Phil Blundell78a56aa2007-01-18 00:44:09 -0500772{
Mika Westerberg9e3af042010-02-04 00:48:00 -0800773 sysfs_remove_group(&pdev->dev.kobj, &gpio_keys_attr_group);
774
Anti Sulline15b0212007-09-26 00:01:17 -0400775 device_init_wakeup(&pdev->dev, 0);
776
Phil Blundell78a56aa2007-01-18 00:44:09 -0500777 return 0;
778}
779
Dmitry Torokhovbdda8212011-07-09 12:41:46 -0700780#ifdef CONFIG_PM_SLEEP
Mike Rapoportae78e0e2009-07-22 23:02:54 -0700781static int gpio_keys_suspend(struct device *dev)
Anti Sulline15b0212007-09-26 00:01:17 -0400782{
David Janderfd05d082011-07-09 12:41:46 -0700783 struct gpio_keys_drvdata *ddata = dev_get_drvdata(dev);
Jonas Aabergdda19a92012-11-24 00:10:29 -0800784 struct input_dev *input = ddata->input;
Anti Sulline15b0212007-09-26 00:01:17 -0400785 int i;
786
David Janderfd05d082011-07-09 12:41:46 -0700787 if (device_may_wakeup(dev)) {
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700788 for (i = 0; i < ddata->pdata->nbuttons; i++) {
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700789 struct gpio_button_data *bdata = &ddata->data[i];
790 if (bdata->button->wakeup)
791 enable_irq_wake(bdata->irq);
Anti Sulline15b0212007-09-26 00:01:17 -0400792 }
Jonas Aabergdda19a92012-11-24 00:10:29 -0800793 } else {
794 mutex_lock(&input->mutex);
795 if (input->users)
796 gpio_keys_close(input);
797 mutex_unlock(&input->mutex);
Anti Sulline15b0212007-09-26 00:01:17 -0400798 }
799
800 return 0;
801}
802
Mike Rapoportae78e0e2009-07-22 23:02:54 -0700803static int gpio_keys_resume(struct device *dev)
Anti Sulline15b0212007-09-26 00:01:17 -0400804{
David Janderfd05d082011-07-09 12:41:46 -0700805 struct gpio_keys_drvdata *ddata = dev_get_drvdata(dev);
Jonas Aabergdda19a92012-11-24 00:10:29 -0800806 struct input_dev *input = ddata->input;
807 int error = 0;
Anti Sulline15b0212007-09-26 00:01:17 -0400808 int i;
809
Jonas Aabergdda19a92012-11-24 00:10:29 -0800810 if (device_may_wakeup(dev)) {
811 for (i = 0; i < ddata->pdata->nbuttons; i++) {
812 struct gpio_button_data *bdata = &ddata->data[i];
813 if (bdata->button->wakeup)
814 disable_irq_wake(bdata->irq);
815 }
816 } else {
817 mutex_lock(&input->mutex);
818 if (input->users)
819 error = gpio_keys_open(input);
820 mutex_unlock(&input->mutex);
Anti Sulline15b0212007-09-26 00:01:17 -0400821 }
Dmitry Torokhov5b76d7b2012-11-24 01:22:43 -0800822
Jonas Aabergdda19a92012-11-24 00:10:29 -0800823 if (error)
824 return error;
Anti Sulline15b0212007-09-26 00:01:17 -0400825
Jonas Aabergdda19a92012-11-24 00:10:29 -0800826 gpio_keys_report_state(ddata);
Anti Sulline15b0212007-09-26 00:01:17 -0400827 return 0;
828}
Anti Sulline15b0212007-09-26 00:01:17 -0400829#endif
830
Dmitry Torokhovbdda8212011-07-09 12:41:46 -0700831static SIMPLE_DEV_PM_OPS(gpio_keys_pm_ops, gpio_keys_suspend, gpio_keys_resume);
832
Uwe Kleine-König9b070442008-07-30 10:34:02 -0400833static struct platform_driver gpio_keys_device_driver = {
Phil Blundell78a56aa2007-01-18 00:44:09 -0500834 .probe = gpio_keys_probe,
Bill Pemberton1cb0aa82012-11-23 21:27:39 -0800835 .remove = gpio_keys_remove,
Phil Blundell78a56aa2007-01-18 00:44:09 -0500836 .driver = {
837 .name = "gpio-keys",
Kay Sieversd7b52472008-04-18 00:24:42 -0400838 .owner = THIS_MODULE,
Mike Rapoportae78e0e2009-07-22 23:02:54 -0700839 .pm = &gpio_keys_pm_ops,
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700840 .of_match_table = of_match_ptr(gpio_keys_of_match),
Phil Blundell78a56aa2007-01-18 00:44:09 -0500841 }
842};
843
844static int __init gpio_keys_init(void)
845{
846 return platform_driver_register(&gpio_keys_device_driver);
847}
848
849static void __exit gpio_keys_exit(void)
850{
851 platform_driver_unregister(&gpio_keys_device_driver);
852}
853
David Janderb2330202011-06-23 01:30:09 -0700854late_initcall(gpio_keys_init);
Phil Blundell78a56aa2007-01-18 00:44:09 -0500855module_exit(gpio_keys_exit);
856
857MODULE_LICENSE("GPL");
858MODULE_AUTHOR("Phil Blundell <pb@handhelds.org>");
David Jander7e2ecdf2011-06-21 14:26:18 -0700859MODULE_DESCRIPTION("Keyboard driver for GPIOs");
Kay Sieversd7b52472008-04-18 00:24:42 -0400860MODULE_ALIAS("platform:gpio-keys");