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