Commit | Line | Data |
---|---|---|
d2912cb1 | 1 | // SPDX-License-Identifier: GPL-2.0-only |
0e7d0c86 GJ |
2 | /* |
3 | * Driver for buttons on GPIO lines not capable of generating interrupts | |
4 | * | |
5 | * Copyright (C) 2007-2010 Gabor Juhos <juhosg@openwrt.org> | |
6 | * Copyright (C) 2010 Nuno Goncalves <nunojpg@gmail.com> | |
7 | * | |
8 | * This file was based on: /drivers/input/misc/cobalt_btns.c | |
9 | * Copyright (C) 2007 Yoichi Yuasa <yoichi_yuasa@tripeaks.co.jp> | |
10 | * | |
11 | * also was based on: /drivers/input/keyboard/gpio_keys.c | |
12 | * Copyright 2005 Phil Blundell | |
0e7d0c86 GJ |
13 | */ |
14 | ||
15 | #include <linux/kernel.h> | |
16 | #include <linux/module.h> | |
0e7d0c86 GJ |
17 | #include <linux/slab.h> |
18 | #include <linux/input.h> | |
19 | #include <linux/input-polldev.h> | |
20 | #include <linux/ioport.h> | |
21 | #include <linux/platform_device.h> | |
22 | #include <linux/gpio.h> | |
633a21d8 | 23 | #include <linux/gpio/consumer.h> |
0e7d0c86 | 24 | #include <linux/gpio_keys.h> |
b26d4e22 | 25 | #include <linux/property.h> |
0e7d0c86 GJ |
26 | |
27 | #define DRV_NAME "gpio-keys-polled" | |
28 | ||
29 | struct gpio_keys_button_data { | |
0f78ba96 | 30 | struct gpio_desc *gpiod; |
0e7d0c86 GJ |
31 | int last_state; |
32 | int count; | |
33 | int threshold; | |
0e7d0c86 GJ |
34 | }; |
35 | ||
36 | struct gpio_keys_polled_dev { | |
37 | struct input_polled_dev *poll_dev; | |
38 | struct device *dev; | |
2976f247 | 39 | const struct gpio_keys_platform_data *pdata; |
6f29d3b2 HG |
40 | unsigned long rel_axis_seen[BITS_TO_LONGS(REL_CNT)]; |
41 | unsigned long abs_axis_seen[BITS_TO_LONGS(ABS_CNT)]; | |
0e7d0c86 GJ |
42 | struct gpio_keys_button_data data[0]; |
43 | }; | |
44 | ||
6f29d3b2 | 45 | static void gpio_keys_button_event(struct input_polled_dev *dev, |
0f78ba96 | 46 | const struct gpio_keys_button *button, |
6f29d3b2 HG |
47 | int state) |
48 | { | |
49 | struct gpio_keys_polled_dev *bdev = dev->private; | |
50 | struct input_dev *input = dev->input; | |
51 | unsigned int type = button->type ?: EV_KEY; | |
52 | ||
53 | if (type == EV_REL) { | |
54 | if (state) { | |
55 | input_event(input, type, button->code, button->value); | |
56 | __set_bit(button->code, bdev->rel_axis_seen); | |
57 | } | |
58 | } else if (type == EV_ABS) { | |
59 | if (state) { | |
60 | input_event(input, type, button->code, button->value); | |
61 | __set_bit(button->code, bdev->abs_axis_seen); | |
62 | } | |
63 | } else { | |
64 | input_event(input, type, button->code, state); | |
65 | input_sync(input); | |
66 | } | |
67 | } | |
68 | ||
69 | static void gpio_keys_polled_check_state(struct input_polled_dev *dev, | |
0f78ba96 | 70 | const struct gpio_keys_button *button, |
0e7d0c86 GJ |
71 | struct gpio_keys_button_data *bdata) |
72 | { | |
73 | int state; | |
74 | ||
ea6aabf8 DT |
75 | state = gpiod_get_value_cansleep(bdata->gpiod); |
76 | if (state < 0) { | |
77 | dev_err(dev->input->dev.parent, | |
78 | "failed to get gpio state: %d\n", state); | |
79 | } else { | |
80 | gpio_keys_button_event(dev, button, state); | |
0e7d0c86 | 81 | |
ea6aabf8 DT |
82 | if (state != bdata->last_state) { |
83 | bdata->count = 0; | |
84 | bdata->last_state = state; | |
85 | } | |
0e7d0c86 GJ |
86 | } |
87 | } | |
88 | ||
89 | static void gpio_keys_polled_poll(struct input_polled_dev *dev) | |
90 | { | |
91 | struct gpio_keys_polled_dev *bdev = dev->private; | |
2976f247 | 92 | const struct gpio_keys_platform_data *pdata = bdev->pdata; |
0e7d0c86 GJ |
93 | struct input_dev *input = dev->input; |
94 | int i; | |
95 | ||
6f29d3b2 HG |
96 | memset(bdev->rel_axis_seen, 0, sizeof(bdev->rel_axis_seen)); |
97 | memset(bdev->abs_axis_seen, 0, sizeof(bdev->abs_axis_seen)); | |
98 | ||
2976f247 | 99 | for (i = 0; i < pdata->nbuttons; i++) { |
0e7d0c86 GJ |
100 | struct gpio_keys_button_data *bdata = &bdev->data[i]; |
101 | ||
6f29d3b2 | 102 | if (bdata->count < bdata->threshold) { |
0e7d0c86 | 103 | bdata->count++; |
6f29d3b2 HG |
104 | gpio_keys_button_event(dev, &pdata->buttons[i], |
105 | bdata->last_state); | |
106 | } else { | |
107 | gpio_keys_polled_check_state(dev, &pdata->buttons[i], | |
0e7d0c86 | 108 | bdata); |
6f29d3b2 HG |
109 | } |
110 | } | |
111 | ||
112 | for_each_set_bit(i, input->relbit, REL_CNT) { | |
113 | if (!test_bit(i, bdev->rel_axis_seen)) | |
114 | input_event(input, EV_REL, i, 0); | |
115 | } | |
116 | ||
117 | for_each_set_bit(i, input->absbit, ABS_CNT) { | |
118 | if (!test_bit(i, bdev->abs_axis_seen)) | |
119 | input_event(input, EV_ABS, i, 0); | |
0e7d0c86 | 120 | } |
6f29d3b2 HG |
121 | |
122 | input_sync(input); | |
0e7d0c86 GJ |
123 | } |
124 | ||
125 | static void gpio_keys_polled_open(struct input_polled_dev *dev) | |
126 | { | |
127 | struct gpio_keys_polled_dev *bdev = dev->private; | |
2976f247 | 128 | const struct gpio_keys_platform_data *pdata = bdev->pdata; |
0e7d0c86 GJ |
129 | |
130 | if (pdata->enable) | |
131 | pdata->enable(bdev->dev); | |
132 | } | |
133 | ||
134 | static void gpio_keys_polled_close(struct input_polled_dev *dev) | |
135 | { | |
136 | struct gpio_keys_polled_dev *bdev = dev->private; | |
2976f247 | 137 | const struct gpio_keys_platform_data *pdata = bdev->pdata; |
0e7d0c86 GJ |
138 | |
139 | if (pdata->disable) | |
140 | pdata->disable(bdev->dev); | |
141 | } | |
142 | ||
0f78ba96 DT |
143 | static struct gpio_keys_platform_data * |
144 | gpio_keys_polled_get_devtree_pdata(struct device *dev) | |
a2f25245 | 145 | { |
a2f25245 APS |
146 | struct gpio_keys_platform_data *pdata; |
147 | struct gpio_keys_button *button; | |
b26d4e22 | 148 | struct fwnode_handle *child; |
a2f25245 | 149 | int nbuttons; |
a2f25245 | 150 | |
b26d4e22 | 151 | nbuttons = device_get_child_node_count(dev); |
a2f25245 | 152 | if (nbuttons == 0) |
0f78ba96 | 153 | return ERR_PTR(-EINVAL); |
a2f25245 | 154 | |
68252638 AS |
155 | pdata = devm_kzalloc(dev, sizeof(*pdata) + nbuttons * sizeof(*button), |
156 | GFP_KERNEL); | |
157 | if (!pdata) | |
158 | return ERR_PTR(-ENOMEM); | |
a2f25245 | 159 | |
0f78ba96 DT |
160 | button = (struct gpio_keys_button *)(pdata + 1); |
161 | ||
162 | pdata->buttons = button; | |
163 | pdata->nbuttons = nbuttons; | |
a2f25245 | 164 | |
b26d4e22 AL |
165 | pdata->rep = device_property_present(dev, "autorepeat"); |
166 | device_property_read_u32(dev, "poll-interval", &pdata->poll_interval); | |
a2f25245 | 167 | |
b26d4e22 | 168 | device_for_each_child_node(dev, child) { |
0f78ba96 DT |
169 | if (fwnode_property_read_u32(child, "linux,code", |
170 | &button->code)) { | |
171 | dev_err(dev, "button without keycode\n"); | |
b26d4e22 | 172 | fwnode_handle_put(child); |
68252638 | 173 | return ERR_PTR(-EINVAL); |
a2f25245 APS |
174 | } |
175 | ||
b26d4e22 | 176 | fwnode_property_read_string(child, "label", &button->desc); |
a2f25245 | 177 | |
b26d4e22 AL |
178 | if (fwnode_property_read_u32(child, "linux,input-type", |
179 | &button->type)) | |
a2f25245 APS |
180 | button->type = EV_KEY; |
181 | ||
6f29d3b2 HG |
182 | if (fwnode_property_read_u32(child, "linux,input-value", |
183 | (u32 *)&button->value)) | |
184 | button->value = 1; | |
185 | ||
99b4ffbd DT |
186 | button->wakeup = |
187 | fwnode_property_read_bool(child, "wakeup-source") || | |
188 | /* legacy name */ | |
189 | fwnode_property_read_bool(child, "gpio-key,wakeup"); | |
a2f25245 | 190 | |
b26d4e22 AL |
191 | if (fwnode_property_read_u32(child, "debounce-interval", |
192 | &button->debounce_interval)) | |
a2f25245 | 193 | button->debounce_interval = 5; |
a2f25245 | 194 | |
0f78ba96 DT |
195 | button++; |
196 | } | |
a2f25245 APS |
197 | |
198 | return pdata; | |
a2f25245 APS |
199 | } |
200 | ||
6f29d3b2 HG |
201 | static void gpio_keys_polled_set_abs_params(struct input_dev *input, |
202 | const struct gpio_keys_platform_data *pdata, unsigned int code) | |
203 | { | |
204 | int i, min = 0, max = 0; | |
205 | ||
206 | for (i = 0; i < pdata->nbuttons; i++) { | |
0f78ba96 | 207 | const struct gpio_keys_button *button = &pdata->buttons[i]; |
6f29d3b2 HG |
208 | |
209 | if (button->type != EV_ABS || button->code != code) | |
210 | continue; | |
211 | ||
212 | if (button->value < min) | |
213 | min = button->value; | |
214 | if (button->value > max) | |
215 | max = button->value; | |
216 | } | |
0f78ba96 | 217 | |
6f29d3b2 HG |
218 | input_set_abs_params(input, code, min, max, 0, 0); |
219 | } | |
220 | ||
90c98ef5 | 221 | static const struct of_device_id gpio_keys_polled_of_match[] = { |
a2f25245 APS |
222 | { .compatible = "gpio-keys-polled", }, |
223 | { }, | |
224 | }; | |
225 | MODULE_DEVICE_TABLE(of, gpio_keys_polled_of_match); | |
226 | ||
5298cc4c | 227 | static int gpio_keys_polled_probe(struct platform_device *pdev) |
0e7d0c86 | 228 | { |
0e7d0c86 | 229 | struct device *dev = &pdev->dev; |
0f78ba96 | 230 | struct fwnode_handle *child = NULL; |
2976f247 | 231 | const struct gpio_keys_platform_data *pdata = dev_get_platdata(dev); |
0e7d0c86 GJ |
232 | struct gpio_keys_polled_dev *bdev; |
233 | struct input_polled_dev *poll_dev; | |
234 | struct input_dev *input; | |
68252638 | 235 | size_t size; |
0e7d0c86 GJ |
236 | int error; |
237 | int i; | |
238 | ||
a2f25245 APS |
239 | if (!pdata) { |
240 | pdata = gpio_keys_polled_get_devtree_pdata(dev); | |
241 | if (IS_ERR(pdata)) | |
242 | return PTR_ERR(pdata); | |
a2f25245 APS |
243 | } |
244 | ||
245 | if (!pdata->poll_interval) { | |
246 | dev_err(dev, "missing poll_interval value\n"); | |
68252638 | 247 | return -EINVAL; |
a2f25245 | 248 | } |
0e7d0c86 | 249 | |
68252638 AS |
250 | size = sizeof(struct gpio_keys_polled_dev) + |
251 | pdata->nbuttons * sizeof(struct gpio_keys_button_data); | |
b4e66e7d | 252 | bdev = devm_kzalloc(dev, size, GFP_KERNEL); |
0e7d0c86 GJ |
253 | if (!bdev) { |
254 | dev_err(dev, "no memory for private data\n"); | |
68252638 | 255 | return -ENOMEM; |
0e7d0c86 GJ |
256 | } |
257 | ||
b4e66e7d | 258 | poll_dev = devm_input_allocate_polled_device(dev); |
0e7d0c86 GJ |
259 | if (!poll_dev) { |
260 | dev_err(dev, "no memory for polled device\n"); | |
68252638 | 261 | return -ENOMEM; |
0e7d0c86 GJ |
262 | } |
263 | ||
264 | poll_dev->private = bdev; | |
265 | poll_dev->poll = gpio_keys_polled_poll; | |
266 | poll_dev->poll_interval = pdata->poll_interval; | |
267 | poll_dev->open = gpio_keys_polled_open; | |
268 | poll_dev->close = gpio_keys_polled_close; | |
269 | ||
270 | input = poll_dev->input; | |
271 | ||
0e7d0c86 GJ |
272 | input->name = pdev->name; |
273 | input->phys = DRV_NAME"/input0"; | |
0e7d0c86 GJ |
274 | |
275 | input->id.bustype = BUS_HOST; | |
276 | input->id.vendor = 0x0001; | |
277 | input->id.product = 0x0001; | |
278 | input->id.version = 0x0100; | |
279 | ||
1a22e16f AS |
280 | __set_bit(EV_KEY, input->evbit); |
281 | if (pdata->rep) | |
282 | __set_bit(EV_REP, input->evbit); | |
283 | ||
0e7d0c86 | 284 | for (i = 0; i < pdata->nbuttons; i++) { |
0f78ba96 | 285 | const struct gpio_keys_button *button = &pdata->buttons[i]; |
0e7d0c86 | 286 | struct gpio_keys_button_data *bdata = &bdev->data[i]; |
0e7d0c86 GJ |
287 | unsigned int type = button->type ?: EV_KEY; |
288 | ||
289 | if (button->wakeup) { | |
290 | dev_err(dev, DRV_NAME " does not support wakeup\n"); | |
0f78ba96 | 291 | fwnode_handle_put(child); |
68252638 | 292 | return -EINVAL; |
0e7d0c86 GJ |
293 | } |
294 | ||
0f78ba96 DT |
295 | if (!dev_get_platdata(dev)) { |
296 | /* No legacy static platform data */ | |
297 | child = device_get_next_child_node(dev, child); | |
298 | if (!child) { | |
299 | dev_err(dev, "missing child device node\n"); | |
300 | return -EINVAL; | |
301 | } | |
302 | ||
4b094797 BB |
303 | bdata->gpiod = devm_fwnode_get_gpiod_from_child(dev, |
304 | NULL, child, | |
305 | GPIOD_IN, | |
306 | button->desc); | |
0f78ba96 DT |
307 | if (IS_ERR(bdata->gpiod)) { |
308 | error = PTR_ERR(bdata->gpiod); | |
309 | if (error != -EPROBE_DEFER) | |
310 | dev_err(dev, | |
311 | "failed to get gpio: %d\n", | |
312 | error); | |
313 | fwnode_handle_put(child); | |
314 | return error; | |
315 | } | |
316 | } else if (gpio_is_valid(button->gpio)) { | |
317 | /* | |
318 | * Legacy GPIO number so request the GPIO here and | |
319 | * convert it to descriptor. | |
320 | */ | |
1ae5ddb6 | 321 | unsigned flags = GPIOF_IN; |
633a21d8 AL |
322 | |
323 | if (button->active_low) | |
324 | flags |= GPIOF_ACTIVE_LOW; | |
325 | ||
b4e66e7d | 326 | error = devm_gpio_request_one(dev, button->gpio, |
633a21d8 AL |
327 | flags, button->desc ? : DRV_NAME); |
328 | if (error) { | |
0f78ba96 DT |
329 | dev_err(dev, |
330 | "unable to claim gpio %u, err=%d\n", | |
633a21d8 AL |
331 | button->gpio, error); |
332 | return error; | |
333 | } | |
334 | ||
0f78ba96 DT |
335 | bdata->gpiod = gpio_to_desc(button->gpio); |
336 | if (!bdata->gpiod) { | |
337 | dev_err(dev, | |
338 | "unable to convert gpio %u to descriptor\n", | |
339 | button->gpio); | |
340 | return -EINVAL; | |
341 | } | |
0e7d0c86 | 342 | } |
0e7d0c86 | 343 | |
0e7d0c86 GJ |
344 | bdata->last_state = -1; |
345 | bdata->threshold = DIV_ROUND_UP(button->debounce_interval, | |
346 | pdata->poll_interval); | |
347 | ||
348 | input_set_capability(input, type, button->code); | |
6f29d3b2 HG |
349 | if (type == EV_ABS) |
350 | gpio_keys_polled_set_abs_params(input, pdata, | |
351 | button->code); | |
0e7d0c86 GJ |
352 | } |
353 | ||
0f78ba96 DT |
354 | fwnode_handle_put(child); |
355 | ||
0e7d0c86 GJ |
356 | bdev->poll_dev = poll_dev; |
357 | bdev->dev = dev; | |
358 | bdev->pdata = pdata; | |
0e7d0c86 GJ |
359 | |
360 | error = input_register_polled_device(poll_dev); | |
361 | if (error) { | |
362 | dev_err(dev, "unable to register polled device, err=%d\n", | |
363 | error); | |
68252638 | 364 | return error; |
0e7d0c86 GJ |
365 | } |
366 | ||
367 | /* report initial state of the buttons */ | |
368 | for (i = 0; i < pdata->nbuttons; i++) | |
6f29d3b2 | 369 | gpio_keys_polled_check_state(poll_dev, &pdata->buttons[i], |
a2f25245 | 370 | &bdev->data[i]); |
0e7d0c86 | 371 | |
6f29d3b2 HG |
372 | input_sync(input); |
373 | ||
0e7d0c86 | 374 | return 0; |
0e7d0c86 GJ |
375 | } |
376 | ||
377 | static struct platform_driver gpio_keys_polled_driver = { | |
378 | .probe = gpio_keys_polled_probe, | |
0e7d0c86 GJ |
379 | .driver = { |
380 | .name = DRV_NAME, | |
b26d4e22 | 381 | .of_match_table = gpio_keys_polled_of_match, |
0e7d0c86 GJ |
382 | }, |
383 | }; | |
5146c84f | 384 | module_platform_driver(gpio_keys_polled_driver); |
0e7d0c86 GJ |
385 | |
386 | MODULE_LICENSE("GPL v2"); | |
387 | MODULE_AUTHOR("Gabor Juhos <juhosg@openwrt.org>"); | |
388 | MODULE_DESCRIPTION("Polled GPIO Buttons driver"); | |
389 | MODULE_ALIAS("platform:" DRV_NAME); |