blob: b890231debd8e028d51ddf28321a9e9bdb3d2099 [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>
David Janderfd05d082011-07-09 12:41:46 -070029#include <linux/of_platform.h>
30#include <linux/of_gpio.h>
Laxman Dewangand8ee4a12012-03-19 17:54:31 -070031#include <linux/spinlock.h>
Phil Blundell78a56aa2007-01-18 00:44:09 -050032
Dmitry Baryshkova33466e2008-05-07 16:30:15 -040033struct gpio_button_data {
Dmitry Torokhovd9080922012-03-18 23:36:29 -070034 const struct gpio_keys_button *button;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -040035 struct input_dev *input;
Jani Nikulaca865a72009-06-28 22:38:44 -070036 struct timer_list timer;
Jani Nikulada0d03f2009-06-28 22:38:56 -070037 struct work_struct work;
Laxman Dewangand8ee4a12012-03-19 17:54:31 -070038 unsigned int timer_debounce; /* in msecs */
39 unsigned int irq;
40 spinlock_t lock;
Mika Westerberg9e3af042010-02-04 00:48:00 -080041 bool disabled;
Laxman Dewangand8ee4a12012-03-19 17:54:31 -070042 bool key_pressed;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -040043};
44
45struct gpio_keys_drvdata {
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -070046 const struct gpio_keys_platform_data *pdata;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -040047 struct input_dev *input;
Mika Westerberg9e3af042010-02-04 00:48:00 -080048 struct mutex disable_lock;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -040049 struct gpio_button_data data[0];
50};
51
Mika Westerberg9e3af042010-02-04 00:48:00 -080052/*
53 * SYSFS interface for enabling/disabling keys and switches:
54 *
55 * There are 4 attributes under /sys/devices/platform/gpio-keys/
56 * keys [ro] - bitmap of keys (EV_KEY) which can be
57 * disabled
58 * switches [ro] - bitmap of switches (EV_SW) which can be
59 * disabled
60 * disabled_keys [rw] - bitmap of keys currently disabled
61 * disabled_switches [rw] - bitmap of switches currently disabled
62 *
63 * Userland can change these values and hence disable event generation
64 * for each key (or switch). Disabling a key means its interrupt line
65 * is disabled.
66 *
67 * For example, if we have following switches set up as gpio-keys:
68 * SW_DOCK = 5
69 * SW_CAMERA_LENS_COVER = 9
70 * SW_KEYPAD_SLIDE = 10
71 * SW_FRONT_PROXIMITY = 11
72 * This is read from switches:
73 * 11-9,5
74 * Next we want to disable proximity (11) and dock (5), we write:
75 * 11,5
76 * to file disabled_switches. Now proximity and dock IRQs are disabled.
77 * This can be verified by reading the file disabled_switches:
78 * 11,5
79 * If we now want to enable proximity (11) switch we write:
80 * 5
81 * to disabled_switches.
82 *
83 * We can disable only those keys which don't allow sharing the irq.
84 */
85
86/**
87 * get_n_events_by_type() - returns maximum number of events per @type
88 * @type: type of button (%EV_KEY, %EV_SW)
89 *
90 * Return value of this function can be used to allocate bitmap
91 * large enough to hold all bits for given type.
92 */
93static inline int get_n_events_by_type(int type)
94{
95 BUG_ON(type != EV_SW && type != EV_KEY);
96
97 return (type == EV_KEY) ? KEY_CNT : SW_CNT;
98}
99
100/**
101 * gpio_keys_disable_button() - disables given GPIO button
102 * @bdata: button data for button to be disabled
103 *
104 * Disables button pointed by @bdata. This is done by masking
105 * IRQ line. After this function is called, button won't generate
106 * input events anymore. Note that one can only disable buttons
107 * that don't share IRQs.
108 *
109 * Make sure that @bdata->disable_lock is locked when entering
110 * this function to avoid races when concurrent threads are
111 * disabling buttons at the same time.
112 */
113static void gpio_keys_disable_button(struct gpio_button_data *bdata)
114{
115 if (!bdata->disabled) {
116 /*
117 * Disable IRQ and possible debouncing timer.
118 */
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700119 disable_irq(bdata->irq);
Grazvydas Ignotas28ed6842010-06-28 10:59:32 -0700120 if (bdata->timer_debounce)
Mika Westerberg9e3af042010-02-04 00:48:00 -0800121 del_timer_sync(&bdata->timer);
122
123 bdata->disabled = true;
124 }
125}
126
127/**
128 * gpio_keys_enable_button() - enables given GPIO button
129 * @bdata: button data for button to be disabled
130 *
131 * Enables given button pointed by @bdata.
132 *
133 * Make sure that @bdata->disable_lock is locked when entering
134 * this function to avoid races with concurrent threads trying
135 * to enable the same button at the same time.
136 */
137static void gpio_keys_enable_button(struct gpio_button_data *bdata)
138{
139 if (bdata->disabled) {
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700140 enable_irq(bdata->irq);
Mika Westerberg9e3af042010-02-04 00:48:00 -0800141 bdata->disabled = false;
142 }
143}
144
145/**
146 * gpio_keys_attr_show_helper() - fill in stringified bitmap of buttons
147 * @ddata: pointer to drvdata
148 * @buf: buffer where stringified bitmap is written
149 * @type: button type (%EV_KEY, %EV_SW)
150 * @only_disabled: does caller want only those buttons that are
151 * currently disabled or all buttons that can be
152 * disabled
153 *
154 * This function writes buttons that can be disabled to @buf. If
155 * @only_disabled is true, then @buf contains only those buttons
156 * that are currently disabled. Returns 0 on success or negative
157 * errno on failure.
158 */
159static ssize_t gpio_keys_attr_show_helper(struct gpio_keys_drvdata *ddata,
160 char *buf, unsigned int type,
161 bool only_disabled)
162{
163 int n_events = get_n_events_by_type(type);
164 unsigned long *bits;
165 ssize_t ret;
166 int i;
167
168 bits = kcalloc(BITS_TO_LONGS(n_events), sizeof(*bits), GFP_KERNEL);
169 if (!bits)
170 return -ENOMEM;
171
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700172 for (i = 0; i < ddata->pdata->nbuttons; i++) {
Mika Westerberg9e3af042010-02-04 00:48:00 -0800173 struct gpio_button_data *bdata = &ddata->data[i];
174
175 if (bdata->button->type != type)
176 continue;
177
178 if (only_disabled && !bdata->disabled)
179 continue;
180
181 __set_bit(bdata->button->code, bits);
182 }
183
184 ret = bitmap_scnlistprintf(buf, PAGE_SIZE - 2, bits, n_events);
185 buf[ret++] = '\n';
186 buf[ret] = '\0';
187
188 kfree(bits);
189
190 return ret;
191}
192
193/**
194 * gpio_keys_attr_store_helper() - enable/disable buttons based on given bitmap
195 * @ddata: pointer to drvdata
196 * @buf: buffer from userspace that contains stringified bitmap
197 * @type: button type (%EV_KEY, %EV_SW)
198 *
199 * This function parses stringified bitmap from @buf and disables/enables
Dmitry Torokhova16ca232012-03-18 23:36:30 -0700200 * GPIO buttons accordingly. Returns 0 on success and negative error
Mika Westerberg9e3af042010-02-04 00:48:00 -0800201 * on failure.
202 */
203static ssize_t gpio_keys_attr_store_helper(struct gpio_keys_drvdata *ddata,
204 const char *buf, unsigned int type)
205{
206 int n_events = get_n_events_by_type(type);
207 unsigned long *bits;
208 ssize_t error;
209 int i;
210
211 bits = kcalloc(BITS_TO_LONGS(n_events), sizeof(*bits), GFP_KERNEL);
212 if (!bits)
213 return -ENOMEM;
214
215 error = bitmap_parselist(buf, bits, n_events);
216 if (error)
217 goto out;
218
219 /* First validate */
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700220 for (i = 0; i < ddata->pdata->nbuttons; i++) {
Mika Westerberg9e3af042010-02-04 00:48:00 -0800221 struct gpio_button_data *bdata = &ddata->data[i];
222
223 if (bdata->button->type != type)
224 continue;
225
226 if (test_bit(bdata->button->code, bits) &&
227 !bdata->button->can_disable) {
228 error = -EINVAL;
229 goto out;
230 }
231 }
232
233 mutex_lock(&ddata->disable_lock);
234
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700235 for (i = 0; i < ddata->pdata->nbuttons; i++) {
Mika Westerberg9e3af042010-02-04 00:48:00 -0800236 struct gpio_button_data *bdata = &ddata->data[i];
237
238 if (bdata->button->type != type)
239 continue;
240
241 if (test_bit(bdata->button->code, bits))
242 gpio_keys_disable_button(bdata);
243 else
244 gpio_keys_enable_button(bdata);
245 }
246
247 mutex_unlock(&ddata->disable_lock);
248
249out:
250 kfree(bits);
251 return error;
252}
253
254#define ATTR_SHOW_FN(name, type, only_disabled) \
255static ssize_t gpio_keys_show_##name(struct device *dev, \
256 struct device_attribute *attr, \
257 char *buf) \
258{ \
259 struct platform_device *pdev = to_platform_device(dev); \
260 struct gpio_keys_drvdata *ddata = platform_get_drvdata(pdev); \
261 \
262 return gpio_keys_attr_show_helper(ddata, buf, \
263 type, only_disabled); \
264}
265
266ATTR_SHOW_FN(keys, EV_KEY, false);
267ATTR_SHOW_FN(switches, EV_SW, false);
268ATTR_SHOW_FN(disabled_keys, EV_KEY, true);
269ATTR_SHOW_FN(disabled_switches, EV_SW, true);
270
271/*
272 * ATTRIBUTES:
273 *
274 * /sys/devices/platform/gpio-keys/keys [ro]
275 * /sys/devices/platform/gpio-keys/switches [ro]
276 */
277static DEVICE_ATTR(keys, S_IRUGO, gpio_keys_show_keys, NULL);
278static DEVICE_ATTR(switches, S_IRUGO, gpio_keys_show_switches, NULL);
279
280#define ATTR_STORE_FN(name, type) \
281static ssize_t gpio_keys_store_##name(struct device *dev, \
282 struct device_attribute *attr, \
283 const char *buf, \
284 size_t count) \
285{ \
286 struct platform_device *pdev = to_platform_device(dev); \
287 struct gpio_keys_drvdata *ddata = platform_get_drvdata(pdev); \
288 ssize_t error; \
289 \
290 error = gpio_keys_attr_store_helper(ddata, buf, type); \
291 if (error) \
292 return error; \
293 \
294 return count; \
295}
296
297ATTR_STORE_FN(disabled_keys, EV_KEY);
298ATTR_STORE_FN(disabled_switches, EV_SW);
299
300/*
301 * ATTRIBUTES:
302 *
303 * /sys/devices/platform/gpio-keys/disabled_keys [rw]
304 * /sys/devices/platform/gpio-keys/disables_switches [rw]
305 */
306static DEVICE_ATTR(disabled_keys, S_IWUSR | S_IRUGO,
307 gpio_keys_show_disabled_keys,
308 gpio_keys_store_disabled_keys);
309static DEVICE_ATTR(disabled_switches, S_IWUSR | S_IRUGO,
310 gpio_keys_show_disabled_switches,
311 gpio_keys_store_disabled_switches);
312
313static struct attribute *gpio_keys_attrs[] = {
314 &dev_attr_keys.attr,
315 &dev_attr_switches.attr,
316 &dev_attr_disabled_keys.attr,
317 &dev_attr_disabled_switches.attr,
318 NULL,
319};
320
321static struct attribute_group gpio_keys_attr_group = {
322 .attrs = gpio_keys_attrs,
323};
324
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700325static void gpio_keys_gpio_report_event(struct gpio_button_data *bdata)
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400326{
Dmitry Torokhovd9080922012-03-18 23:36:29 -0700327 const struct gpio_keys_button *button = bdata->button;
Uwe Kleine-Königce25d7e2008-08-08 12:14:36 -0400328 struct input_dev *input = bdata->input;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400329 unsigned int type = button->type ?: EV_KEY;
Philippe Langlais94a8cab2011-01-20 23:09:30 -0800330 int state = (gpio_get_value_cansleep(button->gpio) ? 1 : 0) ^ button->active_low;
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400331
Alexander Stein92a47672011-04-11 23:34:37 -0700332 if (type == EV_ABS) {
333 if (state)
334 input_event(input, type, button->code, button->value);
335 } else {
336 input_event(input, type, button->code, !!state);
337 }
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400338 input_sync(input);
339}
340
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700341static void gpio_keys_gpio_work_func(struct work_struct *work)
Daniel Mack6ee88d72009-11-30 00:04:02 -0800342{
343 struct gpio_button_data *bdata =
344 container_of(work, struct gpio_button_data, work);
345
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700346 gpio_keys_gpio_report_event(bdata);
Daniel Mack6ee88d72009-11-30 00:04:02 -0800347}
348
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700349static void gpio_keys_gpio_timer(unsigned long _data)
Jani Nikulaca865a72009-06-28 22:38:44 -0700350{
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700351 struct gpio_button_data *bdata = (struct gpio_button_data *)_data;
Jani Nikulaca865a72009-06-28 22:38:44 -0700352
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700353 schedule_work(&bdata->work);
Jani Nikulaca865a72009-06-28 22:38:44 -0700354}
355
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700356static irqreturn_t gpio_keys_gpio_isr(int irq, void *dev_id)
Phil Blundell78a56aa2007-01-18 00:44:09 -0500357{
Uwe Kleine-König57ffe9d2008-08-08 12:14:34 -0400358 struct gpio_button_data *bdata = dev_id;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500359
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700360 BUG_ON(irq != bdata->irq);
Phil Blundell78a56aa2007-01-18 00:44:09 -0500361
Grazvydas Ignotas28ed6842010-06-28 10:59:32 -0700362 if (bdata->timer_debounce)
Jani Nikulaca865a72009-06-28 22:38:44 -0700363 mod_timer(&bdata->timer,
Grazvydas Ignotas28ed6842010-06-28 10:59:32 -0700364 jiffies + msecs_to_jiffies(bdata->timer_debounce));
Jani Nikulaca865a72009-06-28 22:38:44 -0700365 else
Jani Nikulada0d03f2009-06-28 22:38:56 -0700366 schedule_work(&bdata->work);
Roman Moravcik84767d02007-05-01 00:39:13 -0400367
Uwe Kleine-König57ffe9d2008-08-08 12:14:34 -0400368 return IRQ_HANDLED;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500369}
370
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700371static void gpio_keys_irq_timer(unsigned long _data)
372{
373 struct gpio_button_data *bdata = (struct gpio_button_data *)_data;
374 struct input_dev *input = bdata->input;
375 unsigned long flags;
376
377 spin_lock_irqsave(&bdata->lock, flags);
378 if (bdata->key_pressed) {
379 input_event(input, EV_KEY, bdata->button->code, 0);
380 input_sync(input);
381 bdata->key_pressed = false;
382 }
383 spin_unlock_irqrestore(&bdata->lock, flags);
384}
385
386static irqreturn_t gpio_keys_irq_isr(int irq, void *dev_id)
387{
388 struct gpio_button_data *bdata = dev_id;
389 const struct gpio_keys_button *button = bdata->button;
390 struct input_dev *input = bdata->input;
391 unsigned long flags;
392
393 BUG_ON(irq != bdata->irq);
394
395 spin_lock_irqsave(&bdata->lock, flags);
396
397 if (!bdata->key_pressed) {
398 input_event(input, EV_KEY, button->code, 1);
399 input_sync(input);
400
401 if (!bdata->timer_debounce) {
402 input_event(input, EV_KEY, button->code, 0);
403 input_sync(input);
404 goto out;
405 }
406
407 bdata->key_pressed = true;
408 }
409
410 if (bdata->timer_debounce)
411 mod_timer(&bdata->timer,
412 jiffies + msecs_to_jiffies(bdata->timer_debounce));
413out:
414 spin_unlock_irqrestore(&bdata->lock, flags);
415 return IRQ_HANDLED;
416}
417
Mika Westerberg9e3af042010-02-04 00:48:00 -0800418static int __devinit gpio_keys_setup_key(struct platform_device *pdev,
Dmitry Torokhovd9080922012-03-18 23:36:29 -0700419 struct input_dev *input,
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800420 struct gpio_button_data *bdata,
Dmitry Torokhovd9080922012-03-18 23:36:29 -0700421 const struct gpio_keys_button *button)
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800422{
Alexander Stein92a47672011-04-11 23:34:37 -0700423 const char *desc = button->desc ? button->desc : "gpio_keys";
Mika Westerberg9e3af042010-02-04 00:48:00 -0800424 struct device *dev = &pdev->dev;
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700425 irq_handler_t isr;
Mika Westerberg9e3af042010-02-04 00:48:00 -0800426 unsigned long irqflags;
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800427 int irq, error;
428
Dmitry Torokhovd9080922012-03-18 23:36:29 -0700429 bdata->input = input;
430 bdata->button = button;
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700431 spin_lock_init(&bdata->lock);
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800432
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700433 if (gpio_is_valid(button->gpio)) {
434
435 error = gpio_request(button->gpio, desc);
436 if (error < 0) {
437 dev_err(dev, "Failed to request GPIO %d, error %d\n",
438 button->gpio, error);
439 return error;
440 }
441
442 error = gpio_direction_input(button->gpio);
443 if (error < 0) {
444 dev_err(dev,
445 "Failed to configure direction for GPIO %d, error %d\n",
446 button->gpio, error);
447 goto fail;
448 }
449
450 if (button->debounce_interval) {
451 error = gpio_set_debounce(button->gpio,
452 button->debounce_interval * 1000);
453 /* use timer if gpiolib doesn't provide debounce */
454 if (error < 0)
455 bdata->timer_debounce =
456 button->debounce_interval;
457 }
458
459 irq = gpio_to_irq(button->gpio);
460 if (irq < 0) {
461 error = irq;
462 dev_err(dev,
463 "Unable to get irq number for GPIO %d, error %d\n",
464 button->gpio, error);
465 goto fail;
466 }
467 bdata->irq = irq;
468
469 INIT_WORK(&bdata->work, gpio_keys_gpio_work_func);
470 setup_timer(&bdata->timer,
471 gpio_keys_gpio_timer, (unsigned long)bdata);
472
473 isr = gpio_keys_gpio_isr;
474 irqflags = IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING;
475
476 } else {
477 if (!button->irq) {
478 dev_err(dev, "No IRQ specified\n");
479 return -EINVAL;
480 }
481 bdata->irq = button->irq;
482
483 if (button->type && button->type != EV_KEY) {
484 dev_err(dev, "Only EV_KEY allowed for IRQ buttons.\n");
485 return -EINVAL;
486 }
487
488 bdata->timer_debounce = button->debounce_interval;
489 setup_timer(&bdata->timer,
490 gpio_keys_irq_timer, (unsigned long)bdata);
491
492 isr = gpio_keys_irq_isr;
493 irqflags = 0;
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800494 }
495
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700496 input_set_capability(input, button->type ?: EV_KEY, button->code);
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800497
Mika Westerberg9e3af042010-02-04 00:48:00 -0800498 /*
499 * If platform has specified that the button can be disabled,
500 * we don't want it to share the interrupt line.
501 */
502 if (!button->can_disable)
503 irqflags |= IRQF_SHARED;
504
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700505 error = request_any_context_irq(bdata->irq, isr, irqflags, desc, bdata);
Philippe Langlais94a8cab2011-01-20 23:09:30 -0800506 if (error < 0) {
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800507 dev_err(dev, "Unable to claim irq %d; error %d\n",
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700508 bdata->irq, error);
509 goto fail;
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800510 }
511
512 return 0;
513
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700514fail:
515 if (gpio_is_valid(button->gpio))
516 gpio_free(button->gpio);
517
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800518 return error;
519}
520
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700521static int gpio_keys_open(struct input_dev *input)
522{
523 struct gpio_keys_drvdata *ddata = input_get_drvdata(input);
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700524 const struct gpio_keys_platform_data *pdata = ddata->pdata;
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700525
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700526 return pdata->enable ? pdata->enable(input->dev.parent) : 0;
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700527}
528
529static void gpio_keys_close(struct input_dev *input)
530{
531 struct gpio_keys_drvdata *ddata = input_get_drvdata(input);
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700532 const struct gpio_keys_platform_data *pdata = ddata->pdata;
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700533
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700534 if (pdata->disable)
535 pdata->disable(input->dev.parent);
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700536}
537
David Janderfd05d082011-07-09 12:41:46 -0700538/*
539 * Handlers for alternative sources of platform_data
540 */
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700541
David Janderfd05d082011-07-09 12:41:46 -0700542#ifdef CONFIG_OF
543/*
544 * Translate OpenFirmware node properties into platform_data
545 */
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700546static struct gpio_keys_platform_data * __devinit
547gpio_keys_get_devtree_pdata(struct device *dev)
David Janderfd05d082011-07-09 12:41:46 -0700548{
549 struct device_node *node, *pp;
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700550 struct gpio_keys_platform_data *pdata;
551 struct gpio_keys_button *button;
552 int error;
553 int nbuttons;
David Janderfd05d082011-07-09 12:41:46 -0700554 int i;
David Janderfd05d082011-07-09 12:41:46 -0700555
556 node = dev->of_node;
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700557 if (!node) {
558 error = -ENODEV;
559 goto err_out;
560 }
David Janderfd05d082011-07-09 12:41:46 -0700561
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700562 nbuttons = of_get_child_count(node);
563 if (nbuttons == 0) {
564 error = -ENODEV;
565 goto err_out;
566 }
567
568 pdata = kzalloc(sizeof(*pdata) + nbuttons * (sizeof *button),
569 GFP_KERNEL);
570 if (!pdata) {
571 error = -ENOMEM;
572 goto err_out;
573 }
574
575 pdata->buttons = (struct gpio_keys_button *)(pdata + 1);
576 pdata->nbuttons = nbuttons;
David Janderfd05d082011-07-09 12:41:46 -0700577
Tobias Klausercca84692011-09-09 11:09:50 -0700578 pdata->rep = !!of_get_property(node, "autorepeat", NULL);
David Janderfd05d082011-07-09 12:41:46 -0700579
David Janderfd05d082011-07-09 12:41:46 -0700580 i = 0;
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700581 for_each_child_of_node(node, pp) {
David Janderfd05d082011-07-09 12:41:46 -0700582 enum of_gpio_flags flags;
583
584 if (!of_find_property(pp, "gpios", NULL)) {
585 pdata->nbuttons--;
586 dev_warn(dev, "Found button without gpios\n");
587 continue;
588 }
David Janderfd05d082011-07-09 12:41:46 -0700589
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700590 button = &pdata->buttons[i++];
591
592 button->gpio = of_get_gpio_flags(pp, 0, &flags);
593 button->active_low = flags & OF_GPIO_ACTIVE_LOW;
594
595 if (of_property_read_u32(pp, "linux,code", &button->code)) {
596 dev_err(dev, "Button without keycode: 0x%x\n",
597 button->gpio);
598 error = -EINVAL;
599 goto err_free_pdata;
David Janderfd05d082011-07-09 12:41:46 -0700600 }
David Janderfd05d082011-07-09 12:41:46 -0700601
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700602 button->desc = of_get_property(pp, "label", NULL);
David Janderfd05d082011-07-09 12:41:46 -0700603
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700604 if (of_property_read_u32(pp, "linux,input-type", &button->type))
605 button->type = EV_KEY;
David Janderfd05d082011-07-09 12:41:46 -0700606
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700607 button->wakeup = !!of_get_property(pp, "gpio-key,wakeup", NULL);
David Janderfd05d082011-07-09 12:41:46 -0700608
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700609 if (of_property_read_u32(pp, "debounce-interval",
610 &button->debounce_interval))
611 button->debounce_interval = 5;
David Janderfd05d082011-07-09 12:41:46 -0700612 }
613
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700614 if (pdata->nbuttons == 0) {
615 error = -EINVAL;
616 goto err_free_pdata;
617 }
David Janderfd05d082011-07-09 12:41:46 -0700618
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700619 return pdata;
David Janderfd05d082011-07-09 12:41:46 -0700620
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700621err_free_pdata:
622 kfree(pdata);
623err_out:
624 return ERR_PTR(error);
David Janderfd05d082011-07-09 12:41:46 -0700625}
626
627static struct of_device_id gpio_keys_of_match[] = {
628 { .compatible = "gpio-keys", },
629 { },
630};
631MODULE_DEVICE_TABLE(of, gpio_keys_of_match);
632
633#else
634
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700635static inline struct gpio_keys_platform_data *
636gpio_keys_get_devtree_pdata(struct device *dev)
David Janderfd05d082011-07-09 12:41:46 -0700637{
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700638 return ERR_PTR(-ENODEV);
David Janderfd05d082011-07-09 12:41:46 -0700639}
640
David Janderfd05d082011-07-09 12:41:46 -0700641#endif
642
Dmitry Torokhova16ca232012-03-18 23:36:30 -0700643static void gpio_remove_key(struct gpio_button_data *bdata)
644{
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700645 free_irq(bdata->irq, bdata);
Dmitry Torokhova16ca232012-03-18 23:36:30 -0700646 if (bdata->timer_debounce)
647 del_timer_sync(&bdata->timer);
648 cancel_work_sync(&bdata->work);
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700649 if (gpio_is_valid(bdata->button->gpio))
650 gpio_free(bdata->button->gpio);
Dmitry Torokhova16ca232012-03-18 23:36:30 -0700651}
652
Phil Blundell78a56aa2007-01-18 00:44:09 -0500653static int __devinit gpio_keys_probe(struct platform_device *pdev)
654{
Ben Dooksdb19fd82009-11-10 21:00:35 -0800655 struct device *dev = &pdev->dev;
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700656 const struct gpio_keys_platform_data *pdata = dev_get_platdata(dev);
657 struct gpio_keys_drvdata *ddata;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500658 struct input_dev *input;
659 int i, error;
Anti Sulline15b0212007-09-26 00:01:17 -0400660 int wakeup = 0;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500661
David Janderfd05d082011-07-09 12:41:46 -0700662 if (!pdata) {
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700663 pdata = gpio_keys_get_devtree_pdata(dev);
664 if (IS_ERR(pdata))
665 return PTR_ERR(pdata);
David Janderfd05d082011-07-09 12:41:46 -0700666 }
667
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400668 ddata = kzalloc(sizeof(struct gpio_keys_drvdata) +
669 pdata->nbuttons * sizeof(struct gpio_button_data),
670 GFP_KERNEL);
Phil Blundell78a56aa2007-01-18 00:44:09 -0500671 input = input_allocate_device();
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400672 if (!ddata || !input) {
Ben Dooksdb19fd82009-11-10 21:00:35 -0800673 dev_err(dev, "failed to allocate state\n");
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400674 error = -ENOMEM;
675 goto fail1;
676 }
Phil Blundell78a56aa2007-01-18 00:44:09 -0500677
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700678 ddata->pdata = pdata;
Mika Westerberg9e3af042010-02-04 00:48:00 -0800679 ddata->input = input;
Mika Westerberg9e3af042010-02-04 00:48:00 -0800680 mutex_init(&ddata->disable_lock);
681
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400682 platform_set_drvdata(pdev, ddata);
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700683 input_set_drvdata(input, ddata);
Phil Blundell78a56aa2007-01-18 00:44:09 -0500684
Alexander Stein46711272011-04-11 23:34:48 -0700685 input->name = pdata->name ? : pdev->name;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500686 input->phys = "gpio-keys/input0";
Dmitry Torokhov469ba4d2007-04-12 01:34:58 -0400687 input->dev.parent = &pdev->dev;
Shubhrajyoti D173bdd72010-08-03 19:44:40 -0700688 input->open = gpio_keys_open;
689 input->close = gpio_keys_close;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500690
691 input->id.bustype = BUS_HOST;
692 input->id.vendor = 0x0001;
693 input->id.product = 0x0001;
694 input->id.version = 0x0100;
695
Dominic Curranb67b4b12008-10-27 22:30:53 -0400696 /* Enable auto repeat feature of Linux input subsystem */
697 if (pdata->rep)
698 __set_bit(EV_REP, input->evbit);
699
Phil Blundell78a56aa2007-01-18 00:44:09 -0500700 for (i = 0; i < pdata->nbuttons; i++) {
Dmitry Torokhovd9080922012-03-18 23:36:29 -0700701 const struct gpio_keys_button *button = &pdata->buttons[i];
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400702 struct gpio_button_data *bdata = &ddata->data[i];
Phil Blundell78a56aa2007-01-18 00:44:09 -0500703
Dmitry Torokhovd9080922012-03-18 23:36:29 -0700704 error = gpio_keys_setup_key(pdev, input, bdata, button);
Ben Dooksbc8f1ea2009-11-10 21:01:31 -0800705 if (error)
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400706 goto fail2;
Roman Moravcik84767d02007-05-01 00:39:13 -0400707
Anti Sulline15b0212007-09-26 00:01:17 -0400708 if (button->wakeup)
709 wakeup = 1;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500710 }
711
Mika Westerberg9e3af042010-02-04 00:48:00 -0800712 error = sysfs_create_group(&pdev->dev.kobj, &gpio_keys_attr_group);
713 if (error) {
714 dev_err(dev, "Unable to export keys/switches, error: %d\n",
715 error);
716 goto fail2;
717 }
718
Phil Blundell78a56aa2007-01-18 00:44:09 -0500719 error = input_register_device(input);
720 if (error) {
Mika Westerberg9e3af042010-02-04 00:48:00 -0800721 dev_err(dev, "Unable to register input device, error: %d\n",
722 error);
723 goto fail3;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500724 }
725
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700726 /* get current state of buttons that are connected to GPIOs */
727 for (i = 0; i < pdata->nbuttons; i++) {
728 struct gpio_button_data *bdata = &ddata->data[i];
729 if (gpio_is_valid(bdata->button->gpio))
730 gpio_keys_gpio_report_event(bdata);
731 }
Daniel Mack6ee88d72009-11-30 00:04:02 -0800732 input_sync(input);
733
Anti Sulline15b0212007-09-26 00:01:17 -0400734 device_init_wakeup(&pdev->dev, wakeup);
735
Phil Blundell78a56aa2007-01-18 00:44:09 -0500736 return 0;
737
Mika Westerberg9e3af042010-02-04 00:48:00 -0800738 fail3:
739 sysfs_remove_group(&pdev->dev.kobj, &gpio_keys_attr_group);
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400740 fail2:
Dmitry Torokhova16ca232012-03-18 23:36:30 -0700741 while (--i >= 0)
742 gpio_remove_key(&ddata->data[i]);
Phil Blundell78a56aa2007-01-18 00:44:09 -0500743
Anti Sullin006df302007-09-26 00:01:03 -0400744 platform_set_drvdata(pdev, NULL);
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400745 fail1:
Phil Blundell78a56aa2007-01-18 00:44:09 -0500746 input_free_device(input);
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400747 kfree(ddata);
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700748 /* If we have no platform data, we allocated pdata dynamically. */
749 if (!dev_get_platdata(&pdev->dev))
750 kfree(pdata);
Phil Blundell78a56aa2007-01-18 00:44:09 -0500751
752 return error;
753}
754
755static int __devexit gpio_keys_remove(struct platform_device *pdev)
756{
Dmitry Baryshkova33466e2008-05-07 16:30:15 -0400757 struct gpio_keys_drvdata *ddata = platform_get_drvdata(pdev);
758 struct input_dev *input = ddata->input;
Phil Blundell78a56aa2007-01-18 00:44:09 -0500759 int i;
760
Mika Westerberg9e3af042010-02-04 00:48:00 -0800761 sysfs_remove_group(&pdev->dev.kobj, &gpio_keys_attr_group);
762
Anti Sulline15b0212007-09-26 00:01:17 -0400763 device_init_wakeup(&pdev->dev, 0);
764
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700765 for (i = 0; i < ddata->pdata->nbuttons; i++)
Dmitry Torokhova16ca232012-03-18 23:36:30 -0700766 gpio_remove_key(&ddata->data[i]);
Phil Blundell78a56aa2007-01-18 00:44:09 -0500767
768 input_unregister_device(input);
David Janderfd05d082011-07-09 12:41:46 -0700769
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700770 /* If we have no platform data, we allocated pdata dynamically. */
771 if (!dev_get_platdata(&pdev->dev))
772 kfree(ddata->pdata);
David Janderfd05d082011-07-09 12:41:46 -0700773
Axel Lin16382072011-06-28 14:23:30 -0700774 kfree(ddata);
Phil Blundell78a56aa2007-01-18 00:44:09 -0500775
776 return 0;
777}
778
Dmitry Torokhovbdda8212011-07-09 12:41:46 -0700779#ifdef CONFIG_PM_SLEEP
Mike Rapoportae78e0e2009-07-22 23:02:54 -0700780static int gpio_keys_suspend(struct device *dev)
Anti Sulline15b0212007-09-26 00:01:17 -0400781{
David Janderfd05d082011-07-09 12:41:46 -0700782 struct gpio_keys_drvdata *ddata = dev_get_drvdata(dev);
Anti Sulline15b0212007-09-26 00:01:17 -0400783 int i;
784
David Janderfd05d082011-07-09 12:41:46 -0700785 if (device_may_wakeup(dev)) {
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700786 for (i = 0; i < ddata->pdata->nbuttons; i++) {
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700787 struct gpio_button_data *bdata = &ddata->data[i];
788 if (bdata->button->wakeup)
789 enable_irq_wake(bdata->irq);
Anti Sulline15b0212007-09-26 00:01:17 -0400790 }
791 }
792
793 return 0;
794}
795
Mike Rapoportae78e0e2009-07-22 23:02:54 -0700796static int gpio_keys_resume(struct device *dev)
Anti Sulline15b0212007-09-26 00:01:17 -0400797{
David Janderfd05d082011-07-09 12:41:46 -0700798 struct gpio_keys_drvdata *ddata = dev_get_drvdata(dev);
Anti Sulline15b0212007-09-26 00:01:17 -0400799 int i;
800
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700801 for (i = 0; i < ddata->pdata->nbuttons; i++) {
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700802 struct gpio_button_data *bdata = &ddata->data[i];
803 if (bdata->button->wakeup && device_may_wakeup(dev))
804 disable_irq_wake(bdata->irq);
Daniel Mack6ee88d72009-11-30 00:04:02 -0800805
Laxman Dewangand8ee4a12012-03-19 17:54:31 -0700806 if (gpio_is_valid(bdata->button->gpio))
807 gpio_keys_gpio_report_event(bdata);
Anti Sulline15b0212007-09-26 00:01:17 -0400808 }
Daniel Mack6ee88d72009-11-30 00:04:02 -0800809 input_sync(ddata->input);
Anti Sulline15b0212007-09-26 00:01:17 -0400810
811 return 0;
812}
Anti Sulline15b0212007-09-26 00:01:17 -0400813#endif
814
Dmitry Torokhovbdda8212011-07-09 12:41:46 -0700815static SIMPLE_DEV_PM_OPS(gpio_keys_pm_ops, gpio_keys_suspend, gpio_keys_resume);
816
Uwe Kleine-König9b070442008-07-30 10:34:02 -0400817static struct platform_driver gpio_keys_device_driver = {
Phil Blundell78a56aa2007-01-18 00:44:09 -0500818 .probe = gpio_keys_probe,
819 .remove = __devexit_p(gpio_keys_remove),
Phil Blundell78a56aa2007-01-18 00:44:09 -0500820 .driver = {
821 .name = "gpio-keys",
Kay Sieversd7b52472008-04-18 00:24:42 -0400822 .owner = THIS_MODULE,
Mike Rapoportae78e0e2009-07-22 23:02:54 -0700823 .pm = &gpio_keys_pm_ops,
Alexandre Pereira da Silva219edc72012-07-29 22:18:47 -0700824 .of_match_table = of_match_ptr(gpio_keys_of_match),
Phil Blundell78a56aa2007-01-18 00:44:09 -0500825 }
826};
827
828static int __init gpio_keys_init(void)
829{
830 return platform_driver_register(&gpio_keys_device_driver);
831}
832
833static void __exit gpio_keys_exit(void)
834{
835 platform_driver_unregister(&gpio_keys_device_driver);
836}
837
David Janderb2330202011-06-23 01:30:09 -0700838late_initcall(gpio_keys_init);
Phil Blundell78a56aa2007-01-18 00:44:09 -0500839module_exit(gpio_keys_exit);
840
841MODULE_LICENSE("GPL");
842MODULE_AUTHOR("Phil Blundell <pb@handhelds.org>");
David Jander7e2ecdf2011-06-21 14:26:18 -0700843MODULE_DESCRIPTION("Keyboard driver for GPIOs");
Kay Sieversd7b52472008-04-18 00:24:42 -0400844MODULE_ALIAS("platform:gpio-keys");