blob: ddf4045de08466210788ed583066b482e3951e38 [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>
Alexander Steinf2d347f2014-11-25 11:53:45 -080032#include <linux/of_irq.h>
Laxman Dewangand8ee4a12012-03-19 17:54:31 -070033#include <linux/spinlock.h>
Phil Blundell78a56aa2007-01-18 00:44:09 -050034
Dmitry Baryshkova33466e2008-05-07 16:30:15 -040035struct gpio_button_data {
Dmitry Torokhovd9080922012-03-18 23:36:29 -070036 const struct gpio_keys_button *button;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -040037 struct input_dev *input;
Dmitry Torokhov8ed92552014-11-14 17:32:01 -080038
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
Laxman Dewangand8ee4a12012-03-19 17:54:31 -070045 unsigned int irq;
46 spinlock_t lock;
Mika Westerberg9e3af042010-02-04 00:48:00 -080047 bool disabled;
Laxman Dewangand8ee4a12012-03-19 17:54:31 -070048 bool key_pressed;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -040049};
50
51struct gpio_keys_drvdata {
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -070052 const struct gpio_keys_platform_data *pdata;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -040053 struct input_dev *input;
Mika Westerberg9e3af042010-02-04 00:48:00 -080054 struct mutex disable_lock;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -040055 struct gpio_button_data data[0];
56};
57
Mika Westerberg9e3af042010-02-04 00:48:00 -080058/*
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 /*
Dmitry Torokhov8ed92552014-11-14 17:32:01 -0800123 * Disable IRQ and associated timer/work structure.
Mika Westerberg9e3af042010-02-04 00:48:00 -0800124 */
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700125 disable_irq(bdata->irq);
Dmitry Torokhov8ed92552014-11-14 17:32:01 -0800126
127 if (gpio_is_valid(bdata->button->gpio))
128 cancel_delayed_work_sync(&bdata->work);
129 else
130 del_timer_sync(&bdata->release_timer);
Mika Westerberg9e3af042010-02-04 00:48:00 -0800131
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) {
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700149 enable_irq(bdata->irq);
Mika Westerberg9e3af042010-02-04 00:48:00 -0800150 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
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700181 for (i = 0; i < ddata->pdata->nbuttons; i++) {
Mika Westerberg9e3af042010-02-04 00:48:00 -0800182 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
Tejun Heo0b480032015-02-13 14:37:48 -0800193 ret = scnprintf(buf, PAGE_SIZE - 1, "%*pbl", n_events, bits);
Mika Westerberg9e3af042010-02-04 00:48:00 -0800194 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
Dmitry Torokhova16ca232012-03-18 23:36:30 -0700209 * GPIO buttons accordingly. Returns 0 on success and negative error
Mika Westerberg9e3af042010-02-04 00:48:00 -0800210 * 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 */
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700229 for (i = 0; i < ddata->pdata->nbuttons; i++) {
Mika Westerberg9e3af042010-02-04 00:48:00 -0800230 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
242 mutex_lock(&ddata->disable_lock);
243
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700244 for (i = 0; i < ddata->pdata->nbuttons; i++) {
Mika Westerberg9e3af042010-02-04 00:48:00 -0800245 struct gpio_button_data *bdata = &ddata->data[i];
246
247 if (bdata->button->type != type)
248 continue;
249
250 if (test_bit(bdata->button->code, bits))
251 gpio_keys_disable_button(bdata);
252 else
253 gpio_keys_enable_button(bdata);
254 }
255
256 mutex_unlock(&ddata->disable_lock);
257
258out:
259 kfree(bits);
260 return error;
261}
262
263#define ATTR_SHOW_FN(name, type, only_disabled) \
264static ssize_t gpio_keys_show_##name(struct device *dev, \
265 struct device_attribute *attr, \
266 char *buf) \
267{ \
268 struct platform_device *pdev = to_platform_device(dev); \
269 struct gpio_keys_drvdata *ddata = platform_get_drvdata(pdev); \
270 \
271 return gpio_keys_attr_show_helper(ddata, buf, \
272 type, only_disabled); \
273}
274
275ATTR_SHOW_FN(keys, EV_KEY, false);
276ATTR_SHOW_FN(switches, EV_SW, false);
277ATTR_SHOW_FN(disabled_keys, EV_KEY, true);
278ATTR_SHOW_FN(disabled_switches, EV_SW, true);
279
280/*
281 * ATTRIBUTES:
282 *
283 * /sys/devices/platform/gpio-keys/keys [ro]
284 * /sys/devices/platform/gpio-keys/switches [ro]
285 */
286static DEVICE_ATTR(keys, S_IRUGO, gpio_keys_show_keys, NULL);
287static DEVICE_ATTR(switches, S_IRUGO, gpio_keys_show_switches, NULL);
288
289#define ATTR_STORE_FN(name, type) \
290static ssize_t gpio_keys_store_##name(struct device *dev, \
291 struct device_attribute *attr, \
292 const char *buf, \
293 size_t count) \
294{ \
295 struct platform_device *pdev = to_platform_device(dev); \
296 struct gpio_keys_drvdata *ddata = platform_get_drvdata(pdev); \
297 ssize_t error; \
298 \
299 error = gpio_keys_attr_store_helper(ddata, buf, type); \
300 if (error) \
301 return error; \
302 \
303 return count; \
304}
305
306ATTR_STORE_FN(disabled_keys, EV_KEY);
307ATTR_STORE_FN(disabled_switches, EV_SW);
308
309/*
310 * ATTRIBUTES:
311 *
312 * /sys/devices/platform/gpio-keys/disabled_keys [rw]
313 * /sys/devices/platform/gpio-keys/disables_switches [rw]
314 */
315static DEVICE_ATTR(disabled_keys, S_IWUSR | S_IRUGO,
316 gpio_keys_show_disabled_keys,
317 gpio_keys_store_disabled_keys);
318static DEVICE_ATTR(disabled_switches, S_IWUSR | S_IRUGO,
319 gpio_keys_show_disabled_switches,
320 gpio_keys_store_disabled_switches);
321
322static struct attribute *gpio_keys_attrs[] = {
323 &dev_attr_keys.attr,
324 &dev_attr_switches.attr,
325 &dev_attr_disabled_keys.attr,
326 &dev_attr_disabled_switches.attr,
327 NULL,
328};
329
330static struct attribute_group gpio_keys_attr_group = {
331 .attrs = gpio_keys_attrs,
332};
333
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700334static void gpio_keys_gpio_report_event(struct gpio_button_data *bdata)
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400335{
Dmitry Torokhovd9080922012-03-18 23:36:29 -0700336 const struct gpio_keys_button *button = bdata->button;
Uwe Kleine-Königce25d7e2008-08-08 12:14:36 -0400337 struct input_dev *input = bdata->input;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400338 unsigned int type = button->type ?: EV_KEY;
Philippe Langlais94a8cab2011-01-20 23:09:30 -0800339 int state = (gpio_get_value_cansleep(button->gpio) ? 1 : 0) ^ button->active_low;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400340
Alexander Stein92a47672011-04-11 23:34:37 -0700341 if (type == EV_ABS) {
342 if (state)
343 input_event(input, type, button->code, button->value);
344 } else {
345 input_event(input, type, button->code, !!state);
346 }
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400347 input_sync(input);
348}
349
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700350static void gpio_keys_gpio_work_func(struct work_struct *work)
Daniel Mack6ee88d72009-11-30 00:04:02 -0800351{
352 struct gpio_button_data *bdata =
Dmitry Torokhov8ed92552014-11-14 17:32:01 -0800353 container_of(work, struct gpio_button_data, work.work);
Daniel Mack6ee88d72009-11-30 00:04:02 -0800354
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700355 gpio_keys_gpio_report_event(bdata);
NeilBrown2fba26c2012-07-29 22:18:47 -0700356
357 if (bdata->button->wakeup)
358 pm_relax(bdata->input->dev.parent);
Daniel Mack6ee88d72009-11-30 00:04:02 -0800359}
360
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700361static irqreturn_t gpio_keys_gpio_isr(int irq, void *dev_id)
Phil Blundell78a56aa2007-01-18 00:44:09 -0500362{
Uwe Kleine-König57ffe9d2008-08-08 12:14:34 -0400363 struct gpio_button_data *bdata = dev_id;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500364
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700365 BUG_ON(irq != bdata->irq);
Phil Blundell78a56aa2007-01-18 00:44:09 -0500366
NeilBrown2fba26c2012-07-29 22:18:47 -0700367 if (bdata->button->wakeup)
368 pm_stay_awake(bdata->input->dev.parent);
Dmitry Torokhov8ed92552014-11-14 17:32:01 -0800369
370 mod_delayed_work(system_wq,
371 &bdata->work,
372 msecs_to_jiffies(bdata->software_debounce));
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
Dmitry Torokhov8ed92552014-11-14 17:32:01 -0800410 if (!bdata->release_delay) {
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700411 input_event(input, EV_KEY, button->code, 0);
412 input_sync(input);
413 goto out;
414 }
415
416 bdata->key_pressed = true;
417 }
418
Dmitry Torokhov8ed92552014-11-14 17:32:01 -0800419 if (bdata->release_delay)
420 mod_timer(&bdata->release_timer,
421 jiffies + msecs_to_jiffies(bdata->release_delay));
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700422out:
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
Dmitry Torokhov8ed92552014-11-14 17:32:01 -0800431 if (gpio_is_valid(bdata->button->gpio))
432 cancel_delayed_work_sync(&bdata->work);
433 else
434 del_timer_sync(&bdata->release_timer);
Alexander Shiyan27245512014-04-28 09:52:36 -0700435}
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)
Dmitry Torokhov8ed92552014-11-14 17:32:01 -0800468 bdata->software_debounce =
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700469 button->debounce_interval;
470 }
471
Dmitry Torokhov97d86e02014-11-14 15:57:09 -0800472 if (button->irq) {
473 bdata->irq = button->irq;
474 } else {
475 irq = gpio_to_irq(button->gpio);
476 if (irq < 0) {
477 error = irq;
478 dev_err(dev,
479 "Unable to get irq number for GPIO %d, error %d\n",
480 button->gpio, error);
481 return error;
482 }
483 bdata->irq = irq;
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700484 }
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700485
Dmitry Torokhov8ed92552014-11-14 17:32:01 -0800486 INIT_DELAYED_WORK(&bdata->work, gpio_keys_gpio_work_func);
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700487
488 isr = gpio_keys_gpio_isr;
489 irqflags = IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING;
490
491 } else {
492 if (!button->irq) {
493 dev_err(dev, "No IRQ specified\n");
494 return -EINVAL;
495 }
496 bdata->irq = button->irq;
497
498 if (button->type && button->type != EV_KEY) {
499 dev_err(dev, "Only EV_KEY allowed for IRQ buttons.\n");
500 return -EINVAL;
501 }
502
Dmitry Torokhov8ed92552014-11-14 17:32:01 -0800503 bdata->release_delay = button->debounce_interval;
504 setup_timer(&bdata->release_timer,
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700505 gpio_keys_irq_timer, (unsigned long)bdata);
506
507 isr = gpio_keys_irq_isr;
508 irqflags = 0;
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800509 }
510
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700511 input_set_capability(input, button->type ?: EV_KEY, button->code);
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800512
Mika Westerberg9e3af042010-02-04 00:48:00 -0800513 /*
Dmitry Torokhov8ed92552014-11-14 17:32:01 -0800514 * Install custom action to cancel release timer and
Alexander Shiyan27245512014-04-28 09:52:36 -0700515 * workqueue item.
516 */
517 error = devm_add_action(&pdev->dev, gpio_keys_quiesce_key, bdata);
518 if (error) {
519 dev_err(&pdev->dev,
520 "failed to register quiesce action, error: %d\n",
521 error);
522 return error;
523 }
524
525 /*
Mika Westerberg9e3af042010-02-04 00:48:00 -0800526 * If platform has specified that the button can be disabled,
527 * we don't want it to share the interrupt line.
528 */
529 if (!button->can_disable)
530 irqflags |= IRQF_SHARED;
531
Alexander Shiyan27245512014-04-28 09:52:36 -0700532 error = devm_request_any_context_irq(&pdev->dev, bdata->irq,
533 isr, irqflags, desc, bdata);
Philippe Langlais94a8cab2011-01-20 23:09:30 -0800534 if (error < 0) {
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800535 dev_err(dev, "Unable to claim irq %d; error %d\n",
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700536 bdata->irq, error);
Alexander Shiyan27245512014-04-28 09:52:36 -0700537 return error;
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800538 }
539
540 return 0;
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800541}
542
Dmitry Torokhov5b76d7b2012-11-24 01:22:43 -0800543static void gpio_keys_report_state(struct gpio_keys_drvdata *ddata)
544{
545 struct input_dev *input = ddata->input;
546 int i;
547
548 for (i = 0; i < ddata->pdata->nbuttons; i++) {
549 struct gpio_button_data *bdata = &ddata->data[i];
550 if (gpio_is_valid(bdata->button->gpio))
551 gpio_keys_gpio_report_event(bdata);
552 }
553 input_sync(input);
554}
555
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700556static int gpio_keys_open(struct input_dev *input)
557{
558 struct gpio_keys_drvdata *ddata = input_get_drvdata(input);
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700559 const struct gpio_keys_platform_data *pdata = ddata->pdata;
Dmitry Torokhov5b76d7b2012-11-24 01:22:43 -0800560 int error;
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700561
Dmitry Torokhov5b76d7b2012-11-24 01:22:43 -0800562 if (pdata->enable) {
563 error = pdata->enable(input->dev.parent);
564 if (error)
565 return error;
566 }
567
568 /* Report current state of buttons that are connected to GPIOs */
569 gpio_keys_report_state(ddata);
570
571 return 0;
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700572}
573
574static void gpio_keys_close(struct input_dev *input)
575{
576 struct gpio_keys_drvdata *ddata = input_get_drvdata(input);
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700577 const struct gpio_keys_platform_data *pdata = ddata->pdata;
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700578
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700579 if (pdata->disable)
580 pdata->disable(input->dev.parent);
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700581}
582
David Janderfd05d082011-07-09 12:41:46 -0700583/*
584 * Handlers for alternative sources of platform_data
585 */
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700586
David Janderfd05d082011-07-09 12:41:46 -0700587#ifdef CONFIG_OF
588/*
589 * Translate OpenFirmware node properties into platform_data
590 */
Bill Pemberton5298cc42012-11-23 21:38:25 -0800591static struct gpio_keys_platform_data *
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700592gpio_keys_get_devtree_pdata(struct device *dev)
David Janderfd05d082011-07-09 12:41:46 -0700593{
594 struct device_node *node, *pp;
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700595 struct gpio_keys_platform_data *pdata;
596 struct gpio_keys_button *button;
597 int error;
598 int nbuttons;
David Janderfd05d082011-07-09 12:41:46 -0700599 int i;
David Janderfd05d082011-07-09 12:41:46 -0700600
601 node = dev->of_node;
Andy Shevchenko5d422f22014-04-25 14:21:59 -0700602 if (!node)
603 return ERR_PTR(-ENODEV);
David Janderfd05d082011-07-09 12:41:46 -0700604
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700605 nbuttons = of_get_child_count(node);
Andy Shevchenko5d422f22014-04-25 14:21:59 -0700606 if (nbuttons == 0)
607 return ERR_PTR(-ENODEV);
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700608
Andy Shevchenko5d422f22014-04-25 14:21:59 -0700609 pdata = devm_kzalloc(dev,
610 sizeof(*pdata) + nbuttons * sizeof(*button),
611 GFP_KERNEL);
612 if (!pdata)
613 return ERR_PTR(-ENOMEM);
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700614
615 pdata->buttons = (struct gpio_keys_button *)(pdata + 1);
616 pdata->nbuttons = nbuttons;
David Janderfd05d082011-07-09 12:41:46 -0700617
Tobias Klausercca84692011-09-09 11:09:50 -0700618 pdata->rep = !!of_get_property(node, "autorepeat", NULL);
David Janderfd05d082011-07-09 12:41:46 -0700619
David Janderfd05d082011-07-09 12:41:46 -0700620 i = 0;
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700621 for_each_child_of_node(node, pp) {
David Janderfd05d082011-07-09 12:41:46 -0700622 enum of_gpio_flags flags;
623
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700624 button = &pdata->buttons[i++];
625
Dmitry Torokhov97d86e02014-11-14 15:57:09 -0800626 button->gpio = of_get_gpio_flags(pp, 0, &flags);
627 if (button->gpio < 0) {
628 error = button->gpio;
629 if (error != -ENOENT) {
Alexander Steinf2d347f2014-11-25 11:53:45 -0800630 if (error != -EPROBE_DEFER)
631 dev_err(dev,
632 "Failed to get gpio flags, error: %d\n",
633 error);
634 return ERR_PTR(error);
635 }
Dmitry Torokhov97d86e02014-11-14 15:57:09 -0800636 } else {
637 button->active_low = flags & OF_GPIO_ACTIVE_LOW;
David Janderfd05d082011-07-09 12:41:46 -0700638 }
639
Dmitry Torokhov97d86e02014-11-14 15:57:09 -0800640 button->irq = irq_of_parse_and_map(pp, 0);
641
642 if (!gpio_is_valid(button->gpio) && !button->irq) {
643 dev_err(dev, "Found button without gpios or irqs\n");
644 return ERR_PTR(-EINVAL);
645 }
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700646
647 if (of_property_read_u32(pp, "linux,code", &button->code)) {
648 dev_err(dev, "Button without keycode: 0x%x\n",
649 button->gpio);
Andy Shevchenko5d422f22014-04-25 14:21:59 -0700650 return ERR_PTR(-EINVAL);
David Janderfd05d082011-07-09 12:41:46 -0700651 }
David Janderfd05d082011-07-09 12:41:46 -0700652
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700653 button->desc = of_get_property(pp, "label", NULL);
David Janderfd05d082011-07-09 12:41:46 -0700654
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700655 if (of_property_read_u32(pp, "linux,input-type", &button->type))
656 button->type = EV_KEY;
David Janderfd05d082011-07-09 12:41:46 -0700657
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700658 button->wakeup = !!of_get_property(pp, "gpio-key,wakeup", NULL);
David Janderfd05d082011-07-09 12:41:46 -0700659
Dmitry Torokhov97d86e02014-11-14 15:57:09 -0800660 button->can_disable = !!of_get_property(pp, "linux,can-disable", NULL);
661
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700662 if (of_property_read_u32(pp, "debounce-interval",
663 &button->debounce_interval))
664 button->debounce_interval = 5;
David Janderfd05d082011-07-09 12:41:46 -0700665 }
666
Andy Shevchenko5d422f22014-04-25 14:21:59 -0700667 if (pdata->nbuttons == 0)
668 return ERR_PTR(-EINVAL);
David Janderfd05d082011-07-09 12:41:46 -0700669
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700670 return pdata;
David Janderfd05d082011-07-09 12:41:46 -0700671}
672
Jingoo Han22daae32014-05-07 12:58:06 -0700673static const struct of_device_id gpio_keys_of_match[] = {
David Janderfd05d082011-07-09 12:41:46 -0700674 { .compatible = "gpio-keys", },
675 { },
676};
677MODULE_DEVICE_TABLE(of, gpio_keys_of_match);
678
679#else
680
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700681static inline struct gpio_keys_platform_data *
682gpio_keys_get_devtree_pdata(struct device *dev)
David Janderfd05d082011-07-09 12:41:46 -0700683{
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700684 return ERR_PTR(-ENODEV);
David Janderfd05d082011-07-09 12:41:46 -0700685}
686
David Janderfd05d082011-07-09 12:41:46 -0700687#endif
688
Bill Pemberton5298cc42012-11-23 21:38:25 -0800689static int gpio_keys_probe(struct platform_device *pdev)
Phil Blundell78a56aa2007-01-18 00:44:09 -0500690{
Ben Dooksdb19fd82009-11-10 21:00:35 -0800691 struct device *dev = &pdev->dev;
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700692 const struct gpio_keys_platform_data *pdata = dev_get_platdata(dev);
693 struct gpio_keys_drvdata *ddata;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500694 struct input_dev *input;
Andy Shevchenko5d422f22014-04-25 14:21:59 -0700695 size_t size;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500696 int i, error;
Anti Sulline15b0212007-09-26 00:01:17 -0400697 int wakeup = 0;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500698
David Janderfd05d082011-07-09 12:41:46 -0700699 if (!pdata) {
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700700 pdata = gpio_keys_get_devtree_pdata(dev);
701 if (IS_ERR(pdata))
702 return PTR_ERR(pdata);
David Janderfd05d082011-07-09 12:41:46 -0700703 }
704
Andy Shevchenko5d422f22014-04-25 14:21:59 -0700705 size = sizeof(struct gpio_keys_drvdata) +
706 pdata->nbuttons * sizeof(struct gpio_button_data);
707 ddata = devm_kzalloc(dev, size, GFP_KERNEL);
708 if (!ddata) {
Ben Dooksdb19fd82009-11-10 21:00:35 -0800709 dev_err(dev, "failed to allocate state\n");
Andy Shevchenko5d422f22014-04-25 14:21:59 -0700710 return -ENOMEM;
711 }
712
713 input = devm_input_allocate_device(dev);
714 if (!input) {
715 dev_err(dev, "failed to allocate input device\n");
716 return -ENOMEM;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400717 }
Phil Blundell78a56aa2007-01-18 00:44:09 -0500718
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700719 ddata->pdata = pdata;
Mika Westerberg9e3af042010-02-04 00:48:00 -0800720 ddata->input = input;
Mika Westerberg9e3af042010-02-04 00:48:00 -0800721 mutex_init(&ddata->disable_lock);
722
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400723 platform_set_drvdata(pdev, ddata);
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700724 input_set_drvdata(input, ddata);
Phil Blundell78a56aa2007-01-18 00:44:09 -0500725
Alexander Stein46711272011-04-11 23:34:48 -0700726 input->name = pdata->name ? : pdev->name;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500727 input->phys = "gpio-keys/input0";
Dmitry Torokhov469ba4d2007-04-12 01:34:58 -0400728 input->dev.parent = &pdev->dev;
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700729 input->open = gpio_keys_open;
730 input->close = gpio_keys_close;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500731
732 input->id.bustype = BUS_HOST;
733 input->id.vendor = 0x0001;
734 input->id.product = 0x0001;
735 input->id.version = 0x0100;
736
Dominic Curranb67b4b12008-10-27 22:30:53 -0400737 /* Enable auto repeat feature of Linux input subsystem */
738 if (pdata->rep)
739 __set_bit(EV_REP, input->evbit);
740
Phil Blundell78a56aa2007-01-18 00:44:09 -0500741 for (i = 0; i < pdata->nbuttons; i++) {
Dmitry Torokhovd9080922012-03-18 23:36:29 -0700742 const struct gpio_keys_button *button = &pdata->buttons[i];
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400743 struct gpio_button_data *bdata = &ddata->data[i];
Phil Blundell78a56aa2007-01-18 00:44:09 -0500744
Dmitry Torokhovd9080922012-03-18 23:36:29 -0700745 error = gpio_keys_setup_key(pdev, input, bdata, button);
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800746 if (error)
Alexander Shiyan27245512014-04-28 09:52:36 -0700747 return error;
Roman Moravcik84767d02007-05-01 00:39:13 -0400748
Anti Sulline15b0212007-09-26 00:01:17 -0400749 if (button->wakeup)
750 wakeup = 1;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500751 }
752
Mika Westerberg9e3af042010-02-04 00:48:00 -0800753 error = sysfs_create_group(&pdev->dev.kobj, &gpio_keys_attr_group);
754 if (error) {
755 dev_err(dev, "Unable to export keys/switches, error: %d\n",
756 error);
Alexander Shiyan27245512014-04-28 09:52:36 -0700757 return error;
Mika Westerberg9e3af042010-02-04 00:48:00 -0800758 }
759
Phil Blundell78a56aa2007-01-18 00:44:09 -0500760 error = input_register_device(input);
761 if (error) {
Mika Westerberg9e3af042010-02-04 00:48:00 -0800762 dev_err(dev, "Unable to register input device, error: %d\n",
763 error);
Alexander Shiyan27245512014-04-28 09:52:36 -0700764 goto err_remove_group;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500765 }
766
Anti Sulline15b0212007-09-26 00:01:17 -0400767 device_init_wakeup(&pdev->dev, wakeup);
768
Phil Blundell78a56aa2007-01-18 00:44:09 -0500769 return 0;
770
Alexander Shiyan27245512014-04-28 09:52:36 -0700771err_remove_group:
Mika Westerberg9e3af042010-02-04 00:48:00 -0800772 sysfs_remove_group(&pdev->dev.kobj, &gpio_keys_attr_group);
Phil Blundell78a56aa2007-01-18 00:44:09 -0500773 return error;
774}
775
Bill Pembertone2619cf2012-11-23 21:50:47 -0800776static int gpio_keys_remove(struct platform_device *pdev)
Phil Blundell78a56aa2007-01-18 00:44:09 -0500777{
Mika Westerberg9e3af042010-02-04 00:48:00 -0800778 sysfs_remove_group(&pdev->dev.kobj, &gpio_keys_attr_group);
779
Anti Sulline15b0212007-09-26 00:01:17 -0400780 device_init_wakeup(&pdev->dev, 0);
781
Phil Blundell78a56aa2007-01-18 00:44:09 -0500782 return 0;
783}
784
Dmitry Torokhovbdda8212011-07-09 12:41:46 -0700785#ifdef CONFIG_PM_SLEEP
Mike Rapoportae78e0e2009-07-22 23:02:54 -0700786static int gpio_keys_suspend(struct device *dev)
Anti Sulline15b0212007-09-26 00:01:17 -0400787{
David Janderfd05d082011-07-09 12:41:46 -0700788 struct gpio_keys_drvdata *ddata = dev_get_drvdata(dev);
Jonas Aabergdda19a92012-11-24 00:10:29 -0800789 struct input_dev *input = ddata->input;
Anti Sulline15b0212007-09-26 00:01:17 -0400790 int i;
791
David Janderfd05d082011-07-09 12:41:46 -0700792 if (device_may_wakeup(dev)) {
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700793 for (i = 0; i < ddata->pdata->nbuttons; i++) {
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700794 struct gpio_button_data *bdata = &ddata->data[i];
795 if (bdata->button->wakeup)
796 enable_irq_wake(bdata->irq);
Anti Sulline15b0212007-09-26 00:01:17 -0400797 }
Jonas Aabergdda19a92012-11-24 00:10:29 -0800798 } else {
799 mutex_lock(&input->mutex);
800 if (input->users)
801 gpio_keys_close(input);
802 mutex_unlock(&input->mutex);
Anti Sulline15b0212007-09-26 00:01:17 -0400803 }
804
805 return 0;
806}
807
Mike Rapoportae78e0e2009-07-22 23:02:54 -0700808static int gpio_keys_resume(struct device *dev)
Anti Sulline15b0212007-09-26 00:01:17 -0400809{
David Janderfd05d082011-07-09 12:41:46 -0700810 struct gpio_keys_drvdata *ddata = dev_get_drvdata(dev);
Jonas Aabergdda19a92012-11-24 00:10:29 -0800811 struct input_dev *input = ddata->input;
812 int error = 0;
Anti Sulline15b0212007-09-26 00:01:17 -0400813 int i;
814
Jonas Aabergdda19a92012-11-24 00:10:29 -0800815 if (device_may_wakeup(dev)) {
816 for (i = 0; i < ddata->pdata->nbuttons; i++) {
817 struct gpio_button_data *bdata = &ddata->data[i];
818 if (bdata->button->wakeup)
819 disable_irq_wake(bdata->irq);
820 }
821 } else {
822 mutex_lock(&input->mutex);
823 if (input->users)
824 error = gpio_keys_open(input);
825 mutex_unlock(&input->mutex);
Anti Sulline15b0212007-09-26 00:01:17 -0400826 }
Dmitry Torokhov5b76d7b2012-11-24 01:22:43 -0800827
Jonas Aabergdda19a92012-11-24 00:10:29 -0800828 if (error)
829 return error;
Anti Sulline15b0212007-09-26 00:01:17 -0400830
Jonas Aabergdda19a92012-11-24 00:10:29 -0800831 gpio_keys_report_state(ddata);
Anti Sulline15b0212007-09-26 00:01:17 -0400832 return 0;
833}
Anti Sulline15b0212007-09-26 00:01:17 -0400834#endif
835
Dmitry Torokhovbdda8212011-07-09 12:41:46 -0700836static SIMPLE_DEV_PM_OPS(gpio_keys_pm_ops, gpio_keys_suspend, gpio_keys_resume);
837
Uwe Kleine-König9b070442008-07-30 10:34:02 -0400838static struct platform_driver gpio_keys_device_driver = {
Phil Blundell78a56aa2007-01-18 00:44:09 -0500839 .probe = gpio_keys_probe,
Bill Pemberton1cb0aa82012-11-23 21:27:39 -0800840 .remove = gpio_keys_remove,
Phil Blundell78a56aa2007-01-18 00:44:09 -0500841 .driver = {
842 .name = "gpio-keys",
Mike Rapoportae78e0e2009-07-22 23:02:54 -0700843 .pm = &gpio_keys_pm_ops,
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700844 .of_match_table = of_match_ptr(gpio_keys_of_match),
Phil Blundell78a56aa2007-01-18 00:44:09 -0500845 }
846};
847
848static int __init gpio_keys_init(void)
849{
850 return platform_driver_register(&gpio_keys_device_driver);
851}
852
853static void __exit gpio_keys_exit(void)
854{
855 platform_driver_unregister(&gpio_keys_device_driver);
856}
857
David Janderb2330202011-06-23 01:30:09 -0700858late_initcall(gpio_keys_init);
Phil Blundell78a56aa2007-01-18 00:44:09 -0500859module_exit(gpio_keys_exit);
860
861MODULE_LICENSE("GPL");
862MODULE_AUTHOR("Phil Blundell <pb@handhelds.org>");
David Jander7e2ecdf2011-06-21 14:26:18 -0700863MODULE_DESCRIPTION("Keyboard driver for GPIOs");
Kay Sieversd7b52472008-04-18 00:24:42 -0400864MODULE_ALIAS("platform:gpio-keys");