]>
Commit | Line | Data |
---|---|---|
78a56aab PB |
1 | /* |
2 | * Driver for keys on GPIO lines capable of generating interrupts. | |
3 | * | |
4 | * Copyright 2005 Phil Blundell | |
fd05d089 | 5 | * Copyright 2010, 2011 David Jander <david@protonic.nl> |
78a56aab PB |
6 | * |
7 | * This program is free software; you can redistribute it and/or modify | |
8 | * it under the terms of the GNU General Public License version 2 as | |
9 | * published by the Free Software Foundation. | |
10 | */ | |
11 | ||
12 | #include <linux/module.h> | |
78a56aab PB |
13 | |
14 | #include <linux/init.h> | |
15 | #include <linux/fs.h> | |
16 | #include <linux/interrupt.h> | |
17 | #include <linux/irq.h> | |
18 | #include <linux/sched.h> | |
19 | #include <linux/pm.h> | |
5a0e3ad6 | 20 | #include <linux/slab.h> |
78a56aab PB |
21 | #include <linux/sysctl.h> |
22 | #include <linux/proc_fs.h> | |
23 | #include <linux/delay.h> | |
24 | #include <linux/platform_device.h> | |
25 | #include <linux/input.h> | |
49015bee | 26 | #include <linux/gpio_keys.h> |
da0d03fe | 27 | #include <linux/workqueue.h> |
111bc59c | 28 | #include <linux/gpio.h> |
415a4caa | 29 | #include <linux/of.h> |
fd05d089 DJ |
30 | #include <linux/of_platform.h> |
31 | #include <linux/of_gpio.h> | |
d8ee4a1c | 32 | #include <linux/spinlock.h> |
78a56aab | 33 | |
a33466e3 | 34 | struct gpio_button_data { |
d9080921 | 35 | const struct gpio_keys_button *button; |
a33466e3 | 36 | struct input_dev *input; |
ca865a77 | 37 | struct timer_list timer; |
da0d03fe | 38 | struct work_struct work; |
d8ee4a1c LD |
39 | unsigned int timer_debounce; /* in msecs */ |
40 | unsigned int irq; | |
41 | spinlock_t lock; | |
9e3af04f | 42 | bool disabled; |
d8ee4a1c | 43 | bool key_pressed; |
a33466e3 DES |
44 | }; |
45 | ||
46 | struct gpio_keys_drvdata { | |
219edc71 | 47 | const struct gpio_keys_platform_data *pdata; |
a33466e3 | 48 | struct input_dev *input; |
9e3af04f | 49 | struct mutex disable_lock; |
a33466e3 DES |
50 | struct gpio_button_data data[0]; |
51 | }; | |
52 | ||
9e3af04f MW |
53 | /* |
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 | */ | |
94 | static 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 | */ | |
114 | static void gpio_keys_disable_button(struct gpio_button_data *bdata) | |
115 | { | |
116 | if (!bdata->disabled) { | |
117 | /* | |
118 | * Disable IRQ and possible debouncing timer. | |
119 | */ | |
d8ee4a1c | 120 | disable_irq(bdata->irq); |
28ed684f | 121 | if (bdata->timer_debounce) |
9e3af04f MW |
122 | 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 | */ | |
138 | static void gpio_keys_enable_button(struct gpio_button_data *bdata) | |
139 | { | |
140 | if (bdata->disabled) { | |
d8ee4a1c | 141 | enable_irq(bdata->irq); |
9e3af04f MW |
142 | 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 | */ | |
160 | static 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 | ||
219edc71 | 173 | for (i = 0; i < ddata->pdata->nbuttons; i++) { |
9e3af04f MW |
174 | 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 | |
a16ca239 | 201 | * GPIO buttons accordingly. Returns 0 on success and negative error |
9e3af04f MW |
202 | * on failure. |
203 | */ | |
204 | static 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 */ | |
219edc71 | 221 | for (i = 0; i < ddata->pdata->nbuttons; i++) { |
9e3af04f MW |
222 | 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 | ||
219edc71 | 236 | for (i = 0; i < ddata->pdata->nbuttons; i++) { |
9e3af04f MW |
237 | 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 | ||
250 | out: | |
251 | kfree(bits); | |
252 | return error; | |
253 | } | |
254 | ||
255 | #define ATTR_SHOW_FN(name, type, only_disabled) \ | |
256 | static 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 | ||
267 | ATTR_SHOW_FN(keys, EV_KEY, false); | |
268 | ATTR_SHOW_FN(switches, EV_SW, false); | |
269 | ATTR_SHOW_FN(disabled_keys, EV_KEY, true); | |
270 | ATTR_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 | */ | |
278 | static DEVICE_ATTR(keys, S_IRUGO, gpio_keys_show_keys, NULL); | |
279 | static DEVICE_ATTR(switches, S_IRUGO, gpio_keys_show_switches, NULL); | |
280 | ||
281 | #define ATTR_STORE_FN(name, type) \ | |
282 | static 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 | ||
298 | ATTR_STORE_FN(disabled_keys, EV_KEY); | |
299 | ATTR_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 | */ | |
307 | static DEVICE_ATTR(disabled_keys, S_IWUSR | S_IRUGO, | |
308 | gpio_keys_show_disabled_keys, | |
309 | gpio_keys_store_disabled_keys); | |
310 | static DEVICE_ATTR(disabled_switches, S_IWUSR | S_IRUGO, | |
311 | gpio_keys_show_disabled_switches, | |
312 | gpio_keys_store_disabled_switches); | |
313 | ||
314 | static 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 | ||
322 | static struct attribute_group gpio_keys_attr_group = { | |
323 | .attrs = gpio_keys_attrs, | |
324 | }; | |
325 | ||
d8ee4a1c | 326 | static void gpio_keys_gpio_report_event(struct gpio_button_data *bdata) |
a33466e3 | 327 | { |
d9080921 | 328 | const struct gpio_keys_button *button = bdata->button; |
ce25d7e9 | 329 | struct input_dev *input = bdata->input; |
a33466e3 | 330 | unsigned int type = button->type ?: EV_KEY; |
94a8cab8 | 331 | int state = (gpio_get_value_cansleep(button->gpio) ? 1 : 0) ^ button->active_low; |
a33466e3 | 332 | |
92a47674 AS |
333 | 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 | } | |
a33466e3 DES |
339 | input_sync(input); |
340 | } | |
341 | ||
d8ee4a1c | 342 | static void gpio_keys_gpio_work_func(struct work_struct *work) |
6ee88d71 DM |
343 | { |
344 | struct gpio_button_data *bdata = | |
345 | container_of(work, struct gpio_button_data, work); | |
346 | ||
d8ee4a1c | 347 | gpio_keys_gpio_report_event(bdata); |
2fba26c6 N |
348 | |
349 | if (bdata->button->wakeup) | |
350 | pm_relax(bdata->input->dev.parent); | |
6ee88d71 DM |
351 | } |
352 | ||
d8ee4a1c | 353 | static void gpio_keys_gpio_timer(unsigned long _data) |
ca865a77 | 354 | { |
d8ee4a1c | 355 | struct gpio_button_data *bdata = (struct gpio_button_data *)_data; |
ca865a77 | 356 | |
d8ee4a1c | 357 | schedule_work(&bdata->work); |
ca865a77 JN |
358 | } |
359 | ||
d8ee4a1c | 360 | static irqreturn_t gpio_keys_gpio_isr(int irq, void *dev_id) |
78a56aab | 361 | { |
57ffe9d5 | 362 | struct gpio_button_data *bdata = dev_id; |
78a56aab | 363 | |
d8ee4a1c | 364 | BUG_ON(irq != bdata->irq); |
84767d00 | 365 | |
2fba26c6 N |
366 | if (bdata->button->wakeup) |
367 | pm_stay_awake(bdata->input->dev.parent); | |
28ed684f | 368 | if (bdata->timer_debounce) |
ca865a77 | 369 | mod_timer(&bdata->timer, |
28ed684f | 370 | jiffies + msecs_to_jiffies(bdata->timer_debounce)); |
ca865a77 | 371 | else |
da0d03fe | 372 | schedule_work(&bdata->work); |
78a56aab | 373 | |
57ffe9d5 | 374 | return IRQ_HANDLED; |
78a56aab PB |
375 | } |
376 | ||
d8ee4a1c LD |
377 | static 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 | ||
392 | static 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) { | |
2fba26c6 N |
404 | if (bdata->button->wakeup) |
405 | pm_wakeup_event(bdata->input->dev.parent, 0); | |
406 | ||
d8ee4a1c LD |
407 | 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)); | |
422 | out: | |
423 | spin_unlock_irqrestore(&bdata->lock, flags); | |
424 | return IRQ_HANDLED; | |
425 | } | |
426 | ||
5298cc4c BP |
427 | static int gpio_keys_setup_key(struct platform_device *pdev, |
428 | struct input_dev *input, | |
429 | struct gpio_button_data *bdata, | |
430 | const struct gpio_keys_button *button) | |
bc8f1eaf | 431 | { |
92a47674 | 432 | const char *desc = button->desc ? button->desc : "gpio_keys"; |
9e3af04f | 433 | struct device *dev = &pdev->dev; |
d8ee4a1c | 434 | irq_handler_t isr; |
9e3af04f | 435 | unsigned long irqflags; |
bc8f1eaf BD |
436 | int irq, error; |
437 | ||
d9080921 DT |
438 | bdata->input = input; |
439 | bdata->button = button; | |
d8ee4a1c | 440 | spin_lock_init(&bdata->lock); |
bc8f1eaf | 441 | |
d8ee4a1c | 442 | if (gpio_is_valid(button->gpio)) { |
bc8f1eaf | 443 | |
333e34bf | 444 | error = gpio_request_one(button->gpio, GPIOF_IN, desc); |
d8ee4a1c LD |
445 | if (error < 0) { |
446 | dev_err(dev, "Failed to request GPIO %d, error %d\n", | |
447 | button->gpio, error); | |
448 | return error; | |
449 | } | |
bc8f1eaf | 450 | |
d8ee4a1c LD |
451 | if (button->debounce_interval) { |
452 | error = gpio_set_debounce(button->gpio, | |
453 | button->debounce_interval * 1000); | |
454 | /* use timer if gpiolib doesn't provide debounce */ | |
455 | if (error < 0) | |
456 | bdata->timer_debounce = | |
457 | button->debounce_interval; | |
458 | } | |
459 | ||
460 | irq = gpio_to_irq(button->gpio); | |
461 | if (irq < 0) { | |
462 | error = irq; | |
463 | dev_err(dev, | |
464 | "Unable to get irq number for GPIO %d, error %d\n", | |
465 | button->gpio, error); | |
466 | goto fail; | |
467 | } | |
468 | bdata->irq = irq; | |
469 | ||
470 | INIT_WORK(&bdata->work, gpio_keys_gpio_work_func); | |
471 | setup_timer(&bdata->timer, | |
472 | gpio_keys_gpio_timer, (unsigned long)bdata); | |
473 | ||
474 | isr = gpio_keys_gpio_isr; | |
475 | irqflags = IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING; | |
476 | ||
477 | } else { | |
478 | if (!button->irq) { | |
479 | dev_err(dev, "No IRQ specified\n"); | |
480 | return -EINVAL; | |
481 | } | |
482 | bdata->irq = button->irq; | |
483 | ||
484 | if (button->type && button->type != EV_KEY) { | |
485 | dev_err(dev, "Only EV_KEY allowed for IRQ buttons.\n"); | |
486 | return -EINVAL; | |
487 | } | |
488 | ||
489 | bdata->timer_debounce = button->debounce_interval; | |
490 | setup_timer(&bdata->timer, | |
491 | gpio_keys_irq_timer, (unsigned long)bdata); | |
492 | ||
493 | isr = gpio_keys_irq_isr; | |
494 | irqflags = 0; | |
bc8f1eaf BD |
495 | } |
496 | ||
d8ee4a1c LD |
497 | input_set_capability(input, button->type ?: EV_KEY, button->code); |
498 | ||
9e3af04f MW |
499 | /* |
500 | * If platform has specified that the button can be disabled, | |
501 | * we don't want it to share the interrupt line. | |
502 | */ | |
503 | if (!button->can_disable) | |
504 | irqflags |= IRQF_SHARED; | |
505 | ||
d8ee4a1c | 506 | error = request_any_context_irq(bdata->irq, isr, irqflags, desc, bdata); |
94a8cab8 | 507 | if (error < 0) { |
bc8f1eaf | 508 | dev_err(dev, "Unable to claim irq %d; error %d\n", |
d8ee4a1c LD |
509 | bdata->irq, error); |
510 | goto fail; | |
bc8f1eaf BD |
511 | } |
512 | ||
513 | return 0; | |
514 | ||
d8ee4a1c LD |
515 | fail: |
516 | if (gpio_is_valid(button->gpio)) | |
517 | gpio_free(button->gpio); | |
518 | ||
bc8f1eaf BD |
519 | return error; |
520 | } | |
521 | ||
5b76d7b4 DT |
522 | static void gpio_keys_report_state(struct gpio_keys_drvdata *ddata) |
523 | { | |
524 | struct input_dev *input = ddata->input; | |
525 | int i; | |
526 | ||
527 | for (i = 0; i < ddata->pdata->nbuttons; i++) { | |
528 | struct gpio_button_data *bdata = &ddata->data[i]; | |
529 | if (gpio_is_valid(bdata->button->gpio)) | |
530 | gpio_keys_gpio_report_event(bdata); | |
531 | } | |
532 | input_sync(input); | |
533 | } | |
534 | ||
173bdd74 S |
535 | static int gpio_keys_open(struct input_dev *input) |
536 | { | |
537 | struct gpio_keys_drvdata *ddata = input_get_drvdata(input); | |
219edc71 | 538 | const struct gpio_keys_platform_data *pdata = ddata->pdata; |
5b76d7b4 DT |
539 | int error; |
540 | ||
541 | if (pdata->enable) { | |
542 | error = pdata->enable(input->dev.parent); | |
543 | if (error) | |
544 | return error; | |
545 | } | |
173bdd74 | 546 | |
5b76d7b4 DT |
547 | /* Report current state of buttons that are connected to GPIOs */ |
548 | gpio_keys_report_state(ddata); | |
549 | ||
550 | return 0; | |
173bdd74 S |
551 | } |
552 | ||
553 | static void gpio_keys_close(struct input_dev *input) | |
554 | { | |
555 | struct gpio_keys_drvdata *ddata = input_get_drvdata(input); | |
219edc71 | 556 | const struct gpio_keys_platform_data *pdata = ddata->pdata; |
173bdd74 | 557 | |
219edc71 APS |
558 | if (pdata->disable) |
559 | pdata->disable(input->dev.parent); | |
173bdd74 S |
560 | } |
561 | ||
fd05d089 DJ |
562 | /* |
563 | * Handlers for alternative sources of platform_data | |
564 | */ | |
219edc71 | 565 | |
fd05d089 DJ |
566 | #ifdef CONFIG_OF |
567 | /* | |
568 | * Translate OpenFirmware node properties into platform_data | |
569 | */ | |
5298cc4c | 570 | static struct gpio_keys_platform_data * |
219edc71 | 571 | gpio_keys_get_devtree_pdata(struct device *dev) |
fd05d089 DJ |
572 | { |
573 | struct device_node *node, *pp; | |
219edc71 APS |
574 | struct gpio_keys_platform_data *pdata; |
575 | struct gpio_keys_button *button; | |
576 | int error; | |
577 | int nbuttons; | |
fd05d089 | 578 | int i; |
fd05d089 DJ |
579 | |
580 | node = dev->of_node; | |
5d422f2e AS |
581 | if (!node) |
582 | return ERR_PTR(-ENODEV); | |
fd05d089 | 583 | |
219edc71 | 584 | nbuttons = of_get_child_count(node); |
5d422f2e AS |
585 | if (nbuttons == 0) |
586 | return ERR_PTR(-ENODEV); | |
fd05d089 | 587 | |
5d422f2e AS |
588 | pdata = devm_kzalloc(dev, |
589 | sizeof(*pdata) + nbuttons * sizeof(*button), | |
590 | GFP_KERNEL); | |
591 | if (!pdata) | |
592 | return ERR_PTR(-ENOMEM); | |
fd05d089 | 593 | |
219edc71 APS |
594 | pdata->buttons = (struct gpio_keys_button *)(pdata + 1); |
595 | pdata->nbuttons = nbuttons; | |
fd05d089 | 596 | |
219edc71 | 597 | pdata->rep = !!of_get_property(node, "autorepeat", NULL); |
fd05d089 | 598 | |
fd05d089 | 599 | i = 0; |
219edc71 | 600 | for_each_child_of_node(node, pp) { |
e324ce61 | 601 | int gpio; |
fd05d089 DJ |
602 | enum of_gpio_flags flags; |
603 | ||
604 | if (!of_find_property(pp, "gpios", NULL)) { | |
605 | pdata->nbuttons--; | |
606 | dev_warn(dev, "Found button without gpios\n"); | |
607 | continue; | |
608 | } | |
fd05d089 | 609 | |
e324ce61 DT |
610 | gpio = of_get_gpio_flags(pp, 0, &flags); |
611 | if (gpio < 0) { | |
612 | error = gpio; | |
613 | if (error != -EPROBE_DEFER) | |
614 | dev_err(dev, | |
615 | "Failed to get gpio flags, error: %d\n", | |
616 | error); | |
5d422f2e | 617 | return ERR_PTR(error); |
e324ce61 DT |
618 | } |
619 | ||
219edc71 | 620 | button = &pdata->buttons[i++]; |
fd05d089 | 621 | |
e324ce61 | 622 | button->gpio = gpio; |
219edc71 | 623 | button->active_low = flags & OF_GPIO_ACTIVE_LOW; |
fd05d089 | 624 | |
219edc71 APS |
625 | if (of_property_read_u32(pp, "linux,code", &button->code)) { |
626 | dev_err(dev, "Button without keycode: 0x%x\n", | |
627 | button->gpio); | |
5d422f2e | 628 | return ERR_PTR(-EINVAL); |
219edc71 | 629 | } |
fd05d089 | 630 | |
219edc71 | 631 | button->desc = of_get_property(pp, "label", NULL); |
fd05d089 | 632 | |
219edc71 APS |
633 | if (of_property_read_u32(pp, "linux,input-type", &button->type)) |
634 | button->type = EV_KEY; | |
635 | ||
636 | button->wakeup = !!of_get_property(pp, "gpio-key,wakeup", NULL); | |
fd05d089 | 637 | |
219edc71 APS |
638 | if (of_property_read_u32(pp, "debounce-interval", |
639 | &button->debounce_interval)) | |
640 | button->debounce_interval = 5; | |
fd05d089 DJ |
641 | } |
642 | ||
5d422f2e AS |
643 | if (pdata->nbuttons == 0) |
644 | return ERR_PTR(-EINVAL); | |
fd05d089 | 645 | |
219edc71 | 646 | return pdata; |
fd05d089 DJ |
647 | } |
648 | ||
649 | static struct of_device_id gpio_keys_of_match[] = { | |
650 | { .compatible = "gpio-keys", }, | |
651 | { }, | |
652 | }; | |
653 | MODULE_DEVICE_TABLE(of, gpio_keys_of_match); | |
654 | ||
655 | #else | |
656 | ||
219edc71 APS |
657 | static inline struct gpio_keys_platform_data * |
658 | gpio_keys_get_devtree_pdata(struct device *dev) | |
fd05d089 | 659 | { |
219edc71 | 660 | return ERR_PTR(-ENODEV); |
fd05d089 DJ |
661 | } |
662 | ||
fd05d089 DJ |
663 | #endif |
664 | ||
a16ca239 DT |
665 | static void gpio_remove_key(struct gpio_button_data *bdata) |
666 | { | |
d8ee4a1c | 667 | free_irq(bdata->irq, bdata); |
a16ca239 DT |
668 | if (bdata->timer_debounce) |
669 | del_timer_sync(&bdata->timer); | |
670 | cancel_work_sync(&bdata->work); | |
d8ee4a1c LD |
671 | if (gpio_is_valid(bdata->button->gpio)) |
672 | gpio_free(bdata->button->gpio); | |
a16ca239 DT |
673 | } |
674 | ||
5298cc4c | 675 | static int gpio_keys_probe(struct platform_device *pdev) |
78a56aab | 676 | { |
db19fd8b | 677 | struct device *dev = &pdev->dev; |
219edc71 APS |
678 | const struct gpio_keys_platform_data *pdata = dev_get_platdata(dev); |
679 | struct gpio_keys_drvdata *ddata; | |
78a56aab | 680 | struct input_dev *input; |
5d422f2e | 681 | size_t size; |
78a56aab | 682 | int i, error; |
e15b0213 | 683 | int wakeup = 0; |
78a56aab | 684 | |
fd05d089 | 685 | if (!pdata) { |
219edc71 APS |
686 | pdata = gpio_keys_get_devtree_pdata(dev); |
687 | if (IS_ERR(pdata)) | |
688 | return PTR_ERR(pdata); | |
fd05d089 DJ |
689 | } |
690 | ||
5d422f2e AS |
691 | size = sizeof(struct gpio_keys_drvdata) + |
692 | pdata->nbuttons * sizeof(struct gpio_button_data); | |
693 | ddata = devm_kzalloc(dev, size, GFP_KERNEL); | |
694 | if (!ddata) { | |
db19fd8b | 695 | dev_err(dev, "failed to allocate state\n"); |
5d422f2e AS |
696 | return -ENOMEM; |
697 | } | |
698 | ||
699 | input = devm_input_allocate_device(dev); | |
700 | if (!input) { | |
701 | dev_err(dev, "failed to allocate input device\n"); | |
702 | return -ENOMEM; | |
a33466e3 | 703 | } |
78a56aab | 704 | |
219edc71 | 705 | ddata->pdata = pdata; |
9e3af04f | 706 | ddata->input = input; |
9e3af04f MW |
707 | mutex_init(&ddata->disable_lock); |
708 | ||
a33466e3 | 709 | platform_set_drvdata(pdev, ddata); |
173bdd74 | 710 | input_set_drvdata(input, ddata); |
78a56aab | 711 | |
46711277 | 712 | input->name = pdata->name ? : pdev->name; |
78a56aab | 713 | input->phys = "gpio-keys/input0"; |
469ba4df | 714 | input->dev.parent = &pdev->dev; |
173bdd74 S |
715 | input->open = gpio_keys_open; |
716 | input->close = gpio_keys_close; | |
78a56aab PB |
717 | |
718 | input->id.bustype = BUS_HOST; | |
719 | input->id.vendor = 0x0001; | |
720 | input->id.product = 0x0001; | |
721 | input->id.version = 0x0100; | |
722 | ||
b67b4b11 DC |
723 | /* Enable auto repeat feature of Linux input subsystem */ |
724 | if (pdata->rep) | |
725 | __set_bit(EV_REP, input->evbit); | |
726 | ||
78a56aab | 727 | for (i = 0; i < pdata->nbuttons; i++) { |
d9080921 | 728 | const struct gpio_keys_button *button = &pdata->buttons[i]; |
a33466e3 | 729 | struct gpio_button_data *bdata = &ddata->data[i]; |
78a56aab | 730 | |
d9080921 | 731 | error = gpio_keys_setup_key(pdev, input, bdata, button); |
bc8f1eaf | 732 | if (error) |
a33466e3 | 733 | goto fail2; |
84767d00 | 734 | |
e15b0213 AS |
735 | if (button->wakeup) |
736 | wakeup = 1; | |
78a56aab PB |
737 | } |
738 | ||
9e3af04f | 739 | error = sysfs_create_group(&pdev->dev.kobj, &gpio_keys_attr_group); |
78a56aab | 740 | if (error) { |
9e3af04f MW |
741 | dev_err(dev, "Unable to export keys/switches, error: %d\n", |
742 | error); | |
a33466e3 | 743 | goto fail2; |
78a56aab PB |
744 | } |
745 | ||
9e3af04f MW |
746 | error = input_register_device(input); |
747 | if (error) { | |
748 | dev_err(dev, "Unable to register input device, error: %d\n", | |
749 | error); | |
750 | goto fail3; | |
751 | } | |
752 | ||
e15b0213 AS |
753 | device_init_wakeup(&pdev->dev, wakeup); |
754 | ||
78a56aab PB |
755 | return 0; |
756 | ||
9e3af04f MW |
757 | fail3: |
758 | sysfs_remove_group(&pdev->dev.kobj, &gpio_keys_attr_group); | |
a33466e3 | 759 | fail2: |
a16ca239 DT |
760 | while (--i >= 0) |
761 | gpio_remove_key(&ddata->data[i]); | |
78a56aab | 762 | |
78a56aab PB |
763 | return error; |
764 | } | |
765 | ||
e2619cf7 | 766 | static int gpio_keys_remove(struct platform_device *pdev) |
78a56aab | 767 | { |
a33466e3 | 768 | struct gpio_keys_drvdata *ddata = platform_get_drvdata(pdev); |
78a56aab PB |
769 | int i; |
770 | ||
9e3af04f MW |
771 | sysfs_remove_group(&pdev->dev.kobj, &gpio_keys_attr_group); |
772 | ||
e15b0213 AS |
773 | device_init_wakeup(&pdev->dev, 0); |
774 | ||
219edc71 | 775 | for (i = 0; i < ddata->pdata->nbuttons; i++) |
a16ca239 | 776 | gpio_remove_key(&ddata->data[i]); |
78a56aab | 777 | |
78a56aab PB |
778 | return 0; |
779 | } | |
780 | ||
bdda8216 | 781 | #ifdef CONFIG_PM_SLEEP |
ae78e0e0 | 782 | static int gpio_keys_suspend(struct device *dev) |
e15b0213 | 783 | { |
fd05d089 | 784 | struct gpio_keys_drvdata *ddata = dev_get_drvdata(dev); |
dda19a92 | 785 | struct input_dev *input = ddata->input; |
e15b0213 AS |
786 | int i; |
787 | ||
fd05d089 | 788 | if (device_may_wakeup(dev)) { |
219edc71 | 789 | for (i = 0; i < ddata->pdata->nbuttons; i++) { |
d8ee4a1c LD |
790 | struct gpio_button_data *bdata = &ddata->data[i]; |
791 | if (bdata->button->wakeup) | |
792 | enable_irq_wake(bdata->irq); | |
e15b0213 | 793 | } |
dda19a92 JA |
794 | } else { |
795 | mutex_lock(&input->mutex); | |
796 | if (input->users) | |
797 | gpio_keys_close(input); | |
798 | mutex_unlock(&input->mutex); | |
e15b0213 AS |
799 | } |
800 | ||
801 | return 0; | |
802 | } | |
803 | ||
ae78e0e0 | 804 | static int gpio_keys_resume(struct device *dev) |
e15b0213 | 805 | { |
fd05d089 | 806 | struct gpio_keys_drvdata *ddata = dev_get_drvdata(dev); |
dda19a92 JA |
807 | struct input_dev *input = ddata->input; |
808 | int error = 0; | |
e15b0213 AS |
809 | int i; |
810 | ||
dda19a92 JA |
811 | if (device_may_wakeup(dev)) { |
812 | for (i = 0; i < ddata->pdata->nbuttons; i++) { | |
813 | struct gpio_button_data *bdata = &ddata->data[i]; | |
814 | if (bdata->button->wakeup) | |
815 | disable_irq_wake(bdata->irq); | |
816 | } | |
817 | } else { | |
818 | mutex_lock(&input->mutex); | |
819 | if (input->users) | |
820 | error = gpio_keys_open(input); | |
821 | mutex_unlock(&input->mutex); | |
e15b0213 | 822 | } |
5b76d7b4 | 823 | |
dda19a92 JA |
824 | if (error) |
825 | return error; | |
e15b0213 | 826 | |
dda19a92 | 827 | gpio_keys_report_state(ddata); |
e15b0213 AS |
828 | return 0; |
829 | } | |
e15b0213 AS |
830 | #endif |
831 | ||
bdda8216 DT |
832 | static SIMPLE_DEV_PM_OPS(gpio_keys_pm_ops, gpio_keys_suspend, gpio_keys_resume); |
833 | ||
9b07044c | 834 | static struct platform_driver gpio_keys_device_driver = { |
78a56aab | 835 | .probe = gpio_keys_probe, |
1cb0aa88 | 836 | .remove = gpio_keys_remove, |
78a56aab PB |
837 | .driver = { |
838 | .name = "gpio-keys", | |
d7b5247b | 839 | .owner = THIS_MODULE, |
ae78e0e0 | 840 | .pm = &gpio_keys_pm_ops, |
219edc71 | 841 | .of_match_table = of_match_ptr(gpio_keys_of_match), |
78a56aab PB |
842 | } |
843 | }; | |
844 | ||
845 | static int __init gpio_keys_init(void) | |
846 | { | |
847 | return platform_driver_register(&gpio_keys_device_driver); | |
848 | } | |
849 | ||
850 | static void __exit gpio_keys_exit(void) | |
851 | { | |
852 | platform_driver_unregister(&gpio_keys_device_driver); | |
853 | } | |
854 | ||
b2330205 | 855 | late_initcall(gpio_keys_init); |
78a56aab PB |
856 | module_exit(gpio_keys_exit); |
857 | ||
858 | MODULE_LICENSE("GPL"); | |
859 | MODULE_AUTHOR("Phil Blundell <pb@handhelds.org>"); | |
7e2ecdf4 | 860 | MODULE_DESCRIPTION("Keyboard driver for GPIOs"); |
d7b5247b | 861 | MODULE_ALIAS("platform:gpio-keys"); |