2 * Driver for keys on GPIO lines capable of generating interrupts.
4 * Copyright (C) 2015, Fuzhou Rockchip Electronics Co., Ltd
5 * Copyright 2005 Phil Blundell
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.
12 #include <linux/module.h>
13 #include <linux/init.h>
15 #include <linux/interrupt.h>
16 #include <linux/irq.h>
17 #include <linux/sched.h>
19 #include <linux/sysctl.h>
20 #include <linux/proc_fs.h>
21 #include <linux/delay.h>
22 #include <linux/platform_device.h>
23 #include <linux/input.h>
24 #include <linux/adc.h>
25 #include <linux/slab.h>
26 #include <linux/wakelock.h>
28 #include <linux/iio/iio.h>
29 #include <linux/iio/machine.h>
30 #include <linux/iio/driver.h>
31 #include <linux/iio/consumer.h>
33 #include <linux/gpio.h>
35 #include <linux/of_irq.h>
36 #include <linux/of_gpio.h>
37 #include <linux/of_platform.h>
39 #define EMPTY_ADVALUE 950
40 #define DRIFT_ADVALUE 70
41 #define INVALID_ADVALUE -1
42 #define EV_ENCALL KEY_F4
43 #define EV_MENU KEY_F1
46 #define key_dbg(bdata, format, arg...) \
47 dev_info(&bdata->input->dev, format, ##arg)
49 #define key_dbg(bdata, format, arg...)
52 #define DEBOUNCE_JIFFIES (10 / (MSEC_PER_SEC / HZ)) /* 10ms */
53 #define ADC_SAMPLE_JIFFIES (100 / (MSEC_PER_SEC / HZ)) /* 100ms */
54 #define WAKE_LOCK_JIFFIES (1 * HZ) /* 1s */
61 struct rk_keys_button {
62 u32 type; /* TYPE_GPIO, TYPE_ADC */
63 u32 code; /* key code */
64 const char *desc; /* key label */
65 u32 state; /* key up & down state */
66 int gpio; /* gpio only */
67 int adc_value; /* adc only */
68 int adc_state; /* adc only */
69 int active_low; /* gpio only */
70 int wakeup; /* gpio only */
71 struct timer_list timer;
74 struct rk_keys_drvdata {
76 /* flag to indicate if we're suspending/resuming */
80 struct wake_lock wake_lock;
81 struct input_dev *input;
82 struct delayed_work adc_poll_work;
83 struct iio_channel *chan;
84 struct rk_keys_button button[0];
87 static struct input_dev *sinput_dev;
88 static struct rk_keys_drvdata *spdata;
90 static void *rk_key_get_drvdata(void)
96 void rk_send_power_key(int state)
101 input_report_key(sinput_dev, KEY_POWER, 1);
102 input_sync(sinput_dev);
104 input_report_key(sinput_dev, KEY_POWER, 0);
105 input_sync(sinput_dev);
108 EXPORT_SYMBOL(rk_send_power_key);
110 void rk_send_wakeup_key(void)
115 input_report_key(sinput_dev, KEY_WAKEUP, 1);
116 input_sync(sinput_dev);
117 input_report_key(sinput_dev, KEY_WAKEUP, 0);
118 input_sync(sinput_dev);
120 EXPORT_SYMBOL(rk_send_wakeup_key);
122 static void keys_timer(unsigned long _data)
124 struct rk_keys_drvdata *pdata = rk_key_get_drvdata();
125 struct rk_keys_button *button = (struct rk_keys_button *)_data;
126 struct input_dev *input = pdata->input;
129 if (button->type == TYPE_GPIO)
130 state = !!((gpio_get_value(button->gpio) ? 1 : 0) ^
133 state = !!button->adc_state;
135 if (button->state != state) {
136 button->state = state;
137 input_event(input, EV_KEY, button->code, button->state);
138 key_dbg(pdata, "%skey[%s]: report event[%d] state[%d]\n",
139 button->type == TYPE_ADC ? "adc" : "gpio",
140 button->desc, button->code, button->state);
141 input_event(input, EV_KEY, button->code, button->state);
146 mod_timer(&button->timer, jiffies + DEBOUNCE_JIFFIES);
149 static irqreturn_t keys_isr(int irq, void *dev_id)
151 struct rk_keys_drvdata *pdata = rk_key_get_drvdata();
152 struct rk_keys_button *button = (struct rk_keys_button *)dev_id;
153 struct input_dev *input = pdata->input;
155 BUG_ON(irq != gpio_to_irq(button->gpio));
157 if (button->wakeup && pdata->in_suspend) {
160 "wakeup: %skey[%s]: report event[%d] state[%d]\n",
161 (button->type == TYPE_ADC) ? "adc" : "gpio",
162 button->desc, button->code, button->state);
163 input_event(input, EV_KEY, button->code, button->state);
167 wake_lock_timeout(&pdata->wake_lock, WAKE_LOCK_JIFFIES);
168 mod_timer(&button->timer, jiffies + DEBOUNCE_JIFFIES);
174 static ssize_t adc_value_show(struct device *dev, struct device_attribute *attr,
177 struct rk_keys_drvdata *ddata = dev_get_drvdata(dev);
179 return sprintf(buf, "adc_value: %d\n", ddata->result);
181 static DEVICE_ATTR(get_adc_value, S_IRUGO | S_IWUSR, adc_value_show, NULL);
184 static const struct of_device_id rk_key_match[] = {
185 { .compatible = "rockchip,key", .data = NULL},
188 MODULE_DEVICE_TABLE(of, rk_key_match);
190 static int rk_key_adc_iio_read(struct rk_keys_drvdata *data)
192 struct iio_channel *channel = data->chan;
196 return INVALID_ADVALUE;
197 ret = iio_read_channel_raw(channel, &val);
199 pr_err("read channel() error: %d\n", ret);
205 static void adc_key_poll(struct work_struct *work)
207 struct rk_keys_drvdata *ddata;
210 ddata = container_of(work, struct rk_keys_drvdata, adc_poll_work.work);
211 if (!ddata->in_suspend) {
212 result = rk_key_adc_iio_read(ddata);
213 if (result > INVALID_ADVALUE && result < EMPTY_ADVALUE)
214 ddata->result = result;
215 for (i = 0; i < ddata->nbuttons; i++) {
216 struct rk_keys_button *button = &ddata->button[i];
218 if (!button->adc_value)
220 if (result < button->adc_value + DRIFT_ADVALUE &&
221 result > button->adc_value - DRIFT_ADVALUE)
222 button->adc_state = 1;
224 button->adc_state = 0;
225 if (button->state != button->adc_state)
226 mod_timer(&button->timer,
227 jiffies + DEBOUNCE_JIFFIES);
231 schedule_delayed_work(&ddata->adc_poll_work, ADC_SAMPLE_JIFFIES);
234 static int rk_key_type_get(struct device_node *node,
235 struct rk_keys_button *button)
239 if (!of_property_read_u32(node, "rockchip,adc_value", &adc_value))
241 else if (of_get_gpio(node, 0) >= 0)
247 static int rk_keys_parse_dt(struct rk_keys_drvdata *pdata,
248 struct platform_device *pdev)
250 struct device_node *node = pdev->dev.of_node;
251 struct device_node *child_node;
252 struct iio_channel *chan;
253 int ret, gpio, i = 0;
254 u32 code, adc_value, flags;
256 chan = iio_channel_get(&pdev->dev, NULL);
258 dev_info(&pdev->dev, "no io-channels defined\n");
263 for_each_child_of_node(node, child_node) {
264 if (of_property_read_u32(child_node, "linux,code", &code)) {
266 "Missing linux,code property in the DT.\n");
270 pdata->button[i].code = code;
271 pdata->button[i].desc =
272 of_get_property(child_node, "label", NULL);
273 pdata->button[i].type =
274 rk_key_type_get(child_node, &pdata->button[i]);
275 switch (pdata->button[i].type) {
277 gpio = of_get_gpio_flags(child_node, 0, &flags);
280 if (ret != -EPROBE_DEFER)
282 "Failed to get gpio flags, error: %d\n",
287 pdata->button[i].gpio = gpio;
288 pdata->button[i].active_low =
289 flags & OF_GPIO_ACTIVE_LOW;
290 pdata->button[i].wakeup =
291 !!of_get_property(child_node, "gpio-key,wakeup",
296 if (of_property_read_u32
297 (child_node, "rockchip,adc_value", &adc_value)) {
299 "Missing rockchip,adc_value property in the DT.\n");
303 pdata->button[i].adc_value = adc_value;
308 "Error rockchip,type property in the DT.\n");
321 static int keys_probe(struct platform_device *pdev)
323 struct device *dev = &pdev->dev;
324 struct device_node *np = pdev->dev.of_node;
325 struct rk_keys_drvdata *ddata = NULL;
326 struct input_dev *input = NULL;
328 int wakeup, key_num = 0;
330 key_num = of_get_child_count(np);
332 dev_info(&pdev->dev, "no key defined\n");
334 ddata = devm_kzalloc(dev, sizeof(struct rk_keys_drvdata) +
335 key_num * sizeof(struct rk_keys_button),
338 input = devm_input_allocate_device(dev);
339 if (!ddata || !input) {
343 platform_set_drvdata(pdev, ddata);
345 input->name = "rk29-keypad"; /* pdev->name; */
346 input->phys = "gpio-keys/input0";
347 input->dev.parent = dev;
349 input->id.bustype = BUS_HOST;
350 input->id.vendor = 0x0001;
351 input->id.product = 0x0001;
352 input->id.version = 0x0100;
353 ddata->input = input;
355 /* parse info from dt */
356 ddata->nbuttons = key_num;
357 error = rk_keys_parse_dt(ddata, pdev);
361 /* Enable auto repeat feature of Linux input subsystem */
363 __set_bit(EV_REP, input->evbit);
365 for (i = 0; i < ddata->nbuttons; i++) {
366 struct rk_keys_button *button = &ddata->button[i];
369 setup_timer(&button->timer,
370 keys_timer, (unsigned long)button);
376 input_set_capability(input, EV_KEY, button->code);
379 wake_lock_init(&ddata->wake_lock, WAKE_LOCK_SUSPEND, input->name);
381 for (i = 0; i < ddata->nbuttons; i++) {
382 struct rk_keys_button *button = &ddata->button[i];
384 if (button->type == TYPE_GPIO) {
388 devm_gpio_request(dev, button->gpio,
389 button->desc ? : "keys");
391 pr_err("gpio-keys: failed to request GPIO %d, error %d\n",
392 button->gpio, error);
396 error = gpio_direction_input(button->gpio);
398 pr_err("gpio-keys: failed to configure input direction for GPIO %d, error %d\n",
399 button->gpio, error);
400 gpio_free(button->gpio);
404 irq = gpio_to_irq(button->gpio);
407 pr_err("gpio-keys: Unable to get irq number for GPIO %d, error %d\n",
408 button->gpio, error);
409 gpio_free(button->gpio);
413 error = devm_request_irq(dev, irq, keys_isr,
415 IRQF_TRIGGER_FALLING :
418 button->desc : "keys",
421 pr_err("gpio-keys: Unable to claim irq %d; error %d\n",
423 gpio_free(button->gpio);
429 input_set_capability(input, EV_KEY, KEY_WAKEUP);
430 device_init_wakeup(dev, wakeup);
432 error = input_register_device(input);
434 pr_err("gpio-keys: Unable to register input device, error: %d\n",
439 /* adc polling work */
441 INIT_DELAYED_WORK(&ddata->adc_poll_work, adc_key_poll);
442 schedule_delayed_work(&ddata->adc_poll_work,
451 device_init_wakeup(dev, 0);
453 wake_lock_destroy(&ddata->wake_lock);
455 del_timer_sync(&ddata->button[i].timer);
457 platform_set_drvdata(pdev, NULL);
462 static int keys_remove(struct platform_device *pdev)
464 struct device *dev = &pdev->dev;
465 struct rk_keys_drvdata *ddata = dev_get_drvdata(dev);
466 struct input_dev *input = ddata->input;
469 device_init_wakeup(dev, 0);
470 for (i = 0; i < ddata->nbuttons; i++)
471 del_timer_sync(&ddata->button[i].timer);
473 cancel_delayed_work_sync(&ddata->adc_poll_work);
474 input_unregister_device(input);
475 wake_lock_destroy(&ddata->wake_lock);
484 static int keys_suspend(struct device *dev)
486 struct rk_keys_drvdata *ddata = dev_get_drvdata(dev);
489 ddata->in_suspend = true;
490 if (device_may_wakeup(dev)) {
491 for (i = 0; i < ddata->nbuttons; i++) {
492 struct rk_keys_button *button = ddata->button + i;
495 enable_irq_wake(gpio_to_irq(button->gpio));
502 static int keys_resume(struct device *dev)
504 struct rk_keys_drvdata *ddata = dev_get_drvdata(dev);
507 if (device_may_wakeup(dev)) {
508 for (i = 0; i < ddata->nbuttons; i++) {
509 struct rk_keys_button *button = ddata->button + i;
512 disable_irq_wake(gpio_to_irq(button->gpio));
515 /* for call resend_irqs, which may call keys_isr */
516 if (local_softirq_pending())
518 preempt_enable_no_resched();
521 ddata->in_suspend = false;
526 static const struct dev_pm_ops keys_pm_ops = {
527 .suspend = keys_suspend,
528 .resume = keys_resume,
532 static struct platform_driver keys_device_driver = {
534 .remove = keys_remove,
537 .owner = THIS_MODULE,
538 .of_match_table = rk_key_match,
545 module_platform_driver(keys_device_driver);