/*
* GPIO Button Hotplug driver
*
- * Copyright (C) 2012 Felix Fietkau <nbd@openwrt.org>
+ * Copyright (C) 2012 Felix Fietkau <nbd@nbd.name>
* Copyright (C) 2008-2010 Gabor Juhos <juhosg@openwrt.org>
*
* Based on the diag.c - GPIO interface driver for Broadcom boards
* Copyright (C) 2006 Mike Baker <mbm@openwrt.org>,
- * Copyright (C) 2006-2007 Felix Fietkau <nbd@openwrt.org>
+ * Copyright (C) 2006-2007 Felix Fietkau <nbd@nbd.name>
* Copyright (C) 2008 Andy Boyett <agb@openwrt.org>
*
* This program is free software; you can redistribute it and/or modify it
#include <linux/netlink.h>
#include <linux/kobject.h>
#include <linux/input.h>
+#include <linux/interrupt.h>
#include <linux/platform_device.h>
#include <linux/of_gpio.h>
+#include <linux/of_irq.h>
#include <linux/gpio_keys.h>
-#define DRV_NAME "gpio-keys-polled"
-
#define BH_SKB_SIZE 2048
+#define DRV_NAME "gpio-keys"
#define PFX DRV_NAME ": "
-#undef BH_DEBUG
-
-#ifdef BH_DEBUG
-#define BH_DBG(fmt, args...) printk(KERN_DEBUG "%s: " fmt, DRV_NAME, ##args )
-#else
-#define BH_DBG(fmt, args...) do {} while (0)
-#endif
-
-#define BH_ERR(fmt, args...) printk(KERN_ERR "%s: " fmt, DRV_NAME, ##args )
-
struct bh_priv {
unsigned long seen;
};
int count;
int threshold;
int can_sleep;
+ int irq;
+ unsigned int software_debounce;
+ struct gpio_desc *gpiod;
+ const struct gpio_keys_button *b;
};
extern u64 uevent_next_seqnum(void);
}
static struct bh_map button_map[] = {
- BH_MAP(BTN_0, "BTN_0"),
- BH_MAP(BTN_1, "BTN_1"),
- BH_MAP(BTN_2, "BTN_2"),
- BH_MAP(BTN_3, "BTN_3"),
- BH_MAP(BTN_4, "BTN_4"),
- BH_MAP(BTN_5, "BTN_5"),
- BH_MAP(BTN_6, "BTN_6"),
- BH_MAP(BTN_7, "BTN_7"),
- BH_MAP(BTN_8, "BTN_8"),
- BH_MAP(BTN_9, "BTN_9"),
- BH_MAP(KEY_RESTART, "reset"),
- BH_MAP(KEY_RFKILL, "rfkill"),
- BH_MAP(KEY_WPS_BUTTON, "wps"),
+ BH_MAP(BTN_0, "BTN_0"),
+ BH_MAP(BTN_1, "BTN_1"),
+ BH_MAP(BTN_2, "BTN_2"),
+ BH_MAP(BTN_3, "BTN_3"),
+ BH_MAP(BTN_4, "BTN_4"),
+ BH_MAP(BTN_5, "BTN_5"),
+ BH_MAP(BTN_6, "BTN_6"),
+ BH_MAP(BTN_7, "BTN_7"),
+ BH_MAP(BTN_8, "BTN_8"),
+ BH_MAP(BTN_9, "BTN_9"),
+ BH_MAP(KEY_BRIGHTNESS_ZERO, "brightness_zero"),
+ BH_MAP(KEY_CONFIG, "config"),
+ BH_MAP(KEY_COPY, "copy"),
+ BH_MAP(KEY_EJECTCD, "eject"),
+ BH_MAP(KEY_HELP, "help"),
+ BH_MAP(KEY_LIGHTS_TOGGLE, "lights_toggle"),
+ BH_MAP(KEY_PHONE, "phone"),
+ BH_MAP(KEY_POWER, "power"),
+ BH_MAP(KEY_POWER2, "reboot"),
+ BH_MAP(KEY_RESTART, "reset"),
+ BH_MAP(KEY_RFKILL, "rfkill"),
+ BH_MAP(KEY_VIDEO, "video"),
+ BH_MAP(KEY_WIMAX, "wwan"),
+ BH_MAP(KEY_WLAN, "wlan"),
+ BH_MAP(KEY_WPS_BUTTON, "wps"),
};
/* -------------------------------------------------------------------------*/
-static int bh_event_add_var(struct bh_event *event, int argv,
- const char *format, ...)
+static __printf(3, 4)
+int bh_event_add_var(struct bh_event *event, int argv, const char *format, ...)
{
static char buf[128];
char *s;
va_end(args);
if (len >= sizeof(buf)) {
- BH_ERR("buffer size too small\n");
- WARN_ON(1);
+ WARN(1, "buffer size too small");
return -ENOMEM;
}
s = skb_put(event->skb, len + 1);
strcpy(s, buf);
- BH_DBG("added variable '%s'\n", s);
+ pr_debug(PFX "added variable '%s'\n", s);
return 0;
}
static int button_hotplug_fill_event(struct bh_event *event)
{
- char *s;
int ret;
ret = bh_event_add_var(event, 0, "HOME=%s", "/");
if (ret)
return ret;
- switch (event->type) {
- case EV_SW:
- s = "switch";
- break;
- case EV_KEY:
- default:
- s = "button";
- break;
- }
-
- ret = bh_event_add_var(event, 0, "SUBSYSTEM=%s", s);
+ ret = bh_event_add_var(event, 0, "SUBSYSTEM=%s", "button");
if (ret)
return ret;
if (ret)
return ret;
+ if (event->type == EV_SW) {
+ ret = bh_event_add_var(event, 0, "TYPE=%s", "switch");
+ if (ret)
+ return ret;
+ }
+
ret = bh_event_add_var(event, 0, "SEEN=%ld", event->seen);
if (ret)
return ret;
out_free_skb:
if (ret) {
- BH_ERR("work error %d\n", ret);
+ pr_err(PFX "work error %d\n", ret);
kfree_skb(event->skb);
}
out_free_event:
{
struct bh_event *event;
- BH_DBG("create event, name=%s, seen=%lu, pressed=%d\n",
- name, seen, pressed);
+ pr_debug(PFX "create event, name=%s, seen=%lu, pressed=%d\n",
+ name, seen, pressed);
event = kzalloc(sizeof(*event), GFP_KERNEL);
if (!event)
/* -------------------------------------------------------------------------*/
-#ifdef CONFIG_HOTPLUG
static int button_get_index(unsigned int code)
{
int i;
}
static void button_hotplug_event(struct gpio_keys_button_data *data,
- unsigned int type, unsigned int code, int value)
+ unsigned int type, int value)
{
struct bh_priv *priv = &data->bh;
unsigned long seen = jiffies;
int btn;
- BH_DBG("event type=%u, code=%u, value=%d\n", type, code, value);
+ pr_debug(PFX "event type=%u, code=%u, value=%d\n", type, data->b->code, value);
if ((type != EV_KEY) && (type != EV_SW))
return;
- btn = button_get_index(code);
+ btn = button_get_index(data->b->code);
if (btn < 0)
return;
+ if (priv->seen == 0)
+ priv->seen = seen;
+
button_hotplug_create_event(button_map[btn].name, type,
(seen - priv->seen) / HZ, value);
priv->seen = seen;
}
-#else
-static void button_hotplug_event(struct gpio_keys_button_data *data,
- unsigned int type, unsigned int code, int value)
-{
-}
-#endif /* CONFIG_HOTPLUG */
-struct gpio_keys_polled_dev {
+struct gpio_keys_button_dev {
+ int polled;
struct delayed_work work;
struct device *dev;
struct gpio_keys_button_data data[0];
};
-static int gpio_button_get_value(struct gpio_keys_button *button,
- struct gpio_keys_button_data *bdata)
+static int gpio_button_get_value(struct gpio_keys_button_data *bdata)
{
int val;
if (bdata->can_sleep)
- val = !!gpio_get_value_cansleep(button->gpio);
+ val = !!gpio_get_value_cansleep(bdata->b->gpio);
else
- val = !!gpio_get_value(button->gpio);
+ val = !!gpio_get_value(bdata->b->gpio);
- return val ^ button->active_low;
+ return val ^ bdata->b->active_low;
}
-static void gpio_keys_polled_check_state(struct gpio_keys_button *button,
- struct gpio_keys_button_data *bdata)
+static void gpio_keys_polled_check_state(struct gpio_keys_button_data *bdata)
{
- int state = gpio_button_get_value(button, bdata);
+ int state = gpio_button_get_value(bdata);
if (state != bdata->last_state) {
- unsigned int type = button->type ?: EV_KEY;
+ unsigned int type = bdata->b->type ?: EV_KEY;
if (bdata->count < bdata->threshold) {
bdata->count++;
return;
}
- button_hotplug_event(bdata, type, button->code, state);
+ if (bdata->last_state != -1 || type == EV_SW)
+ button_hotplug_event(bdata, type, state);
+
bdata->last_state = state;
}
bdata->count = 0;
}
-static void gpio_keys_polled_queue_work(struct gpio_keys_polled_dev *bdev)
+static void gpio_keys_polled_queue_work(struct gpio_keys_button_dev *bdev)
{
struct gpio_keys_platform_data *pdata = bdev->pdata;
unsigned long delay = msecs_to_jiffies(pdata->poll_interval);
if (delay >= HZ)
- delay = round_jiffies_relative(delay);
+ delay = round_jiffies_relative(delay);
schedule_delayed_work(&bdev->work, delay);
}
static void gpio_keys_polled_poll(struct work_struct *work)
{
- struct gpio_keys_polled_dev *bdev =
- container_of(work, struct gpio_keys_polled_dev, work.work);
- struct gpio_keys_platform_data *pdata = bdev->pdata;
+ struct gpio_keys_button_dev *bdev =
+ container_of(work, struct gpio_keys_button_dev, work.work);
int i;
for (i = 0; i < bdev->pdata->nbuttons; i++) {
struct gpio_keys_button_data *bdata = &bdev->data[i];
- gpio_keys_polled_check_state(&pdata->buttons[i], bdata);
+ gpio_keys_polled_check_state(bdata);
}
gpio_keys_polled_queue_work(bdev);
}
-static void gpio_keys_polled_open(struct gpio_keys_polled_dev *bdev)
+static void gpio_keys_polled_close(struct gpio_keys_button_dev *bdev)
{
struct gpio_keys_platform_data *pdata = bdev->pdata;
- int i;
- if (pdata->enable)
- pdata->enable(bdev->dev);
+ cancel_delayed_work_sync(&bdev->work);
- /* report initial state of the buttons */
- for (i = 0; i < pdata->nbuttons; i++)
- gpio_keys_polled_check_state(&pdata->buttons[i], &bdev->data[i]);
+ if (pdata->disable)
+ pdata->disable(bdev->dev);
+}
- gpio_keys_polled_queue_work(bdev);
+static void gpio_keys_irq_work_func(struct work_struct *work)
+{
+ struct gpio_keys_button_data *bdata = container_of(work,
+ struct gpio_keys_button_data, work.work);
+ int state = gpio_button_get_value(bdata);
+
+ if (state != bdata->last_state) {
+ unsigned int type = bdata->b->type ?: EV_KEY;
+
+ if (bdata->last_state != -1 || type == EV_SW)
+ button_hotplug_event(bdata, type, state);
+
+ bdata->last_state = state;
+ }
+}
+
+static irqreturn_t button_handle_irq(int irq, void *_bdata)
+{
+ struct gpio_keys_button_data *bdata =
+ (struct gpio_keys_button_data *) _bdata;
+
+ schedule_delayed_work(&bdata->work,
+ msecs_to_jiffies(bdata->software_debounce));
+
+ return IRQ_HANDLED;
}
#ifdef CONFIG_OF
static struct gpio_keys_platform_data *
-gpio_keys_polled_get_devtree_pdata(struct device *dev)
+gpio_keys_get_devtree_pdata(struct device *dev)
{
struct device_node *node, *pp;
struct gpio_keys_platform_data *pdata;
struct gpio_keys_button *button;
int error;
int nbuttons;
- int i;
+ int i = 0;
node = dev->of_node;
if (!node)
if (nbuttons == 0)
return NULL;
- pdata = kzalloc(sizeof(*pdata) + nbuttons * (sizeof *button),
+ pdata = devm_kzalloc(dev, sizeof(*pdata) + nbuttons * (sizeof *button),
GFP_KERNEL);
if (!pdata) {
error = -ENOMEM;
pdata->rep = !!of_get_property(node, "autorepeat", NULL);
of_property_read_u32(node, "poll-interval", &pdata->poll_interval);
- i = 0;
for_each_child_of_node(node, pp) {
enum of_gpio_flags flags;
continue;
}
- button = &pdata->buttons[i++];
+ button = (struct gpio_keys_button *)(&pdata->buttons[i++]);
+
+ button->irq = irq_of_parse_and_map(pp, 0);
button->gpio = of_get_gpio_flags(pp, 0, &flags);
- button->active_low = flags & OF_GPIO_ACTIVE_LOW;
+ if (button->gpio < 0) {
+ error = button->gpio;
+ if (error != -ENOENT) {
+ if (error != -EPROBE_DEFER)
+ dev_err(dev,
+ "Failed to get gpio flags, error: %d\n",
+ error);
+ return ERR_PTR(error);
+ }
+ } else {
+ button->active_low = flags & OF_GPIO_ACTIVE_LOW;
+ }
if (of_property_read_u32(pp, "linux,code", &button->code)) {
dev_err(dev, "Button without keycode: 0x%x\n",
button->gpio);
error = -EINVAL;
- goto err_free_pdata;
+ goto err_out;
}
button->desc = of_get_property(pp, "label", NULL);
if (pdata->nbuttons == 0) {
error = -EINVAL;
- goto err_free_pdata;
+ goto err_out;
}
return pdata;
-err_free_pdata:
- kfree(pdata);
err_out:
return ERR_PTR(error);
}
+static struct of_device_id gpio_keys_of_match[] = {
+ { .compatible = "gpio-keys", },
+ { },
+};
+MODULE_DEVICE_TABLE(of, gpio_keys_of_match);
+
static struct of_device_id gpio_keys_polled_of_match[] = {
{ .compatible = "gpio-keys-polled", },
{ },
#else
static inline struct gpio_keys_platform_data *
-gpio_keys_polled_get_devtree_pdata(struct device *dev)
+gpio_keys_get_devtree_pdata(struct device *dev)
{
return NULL;
}
#endif
-static void gpio_keys_polled_close(struct gpio_keys_polled_dev *bdev)
-{
- struct gpio_keys_platform_data *pdata = bdev->pdata;
-
- cancel_delayed_work_sync(&bdev->work);
-
- if (pdata->disable)
- pdata->disable(bdev->dev);
-}
-
-static int gpio_keys_polled_probe(struct platform_device *pdev)
+static int gpio_keys_button_probe(struct platform_device *pdev,
+ struct gpio_keys_button_dev **_bdev, int polled)
{
struct gpio_keys_platform_data *pdata = pdev->dev.platform_data;
struct device *dev = &pdev->dev;
- struct gpio_keys_polled_dev *bdev;
+ struct gpio_keys_button_dev *bdev;
+ struct gpio_keys_button *buttons;
int error;
int i;
if (!pdata) {
- pdata = gpio_keys_polled_get_devtree_pdata(dev);
+ pdata = gpio_keys_get_devtree_pdata(dev);
if (IS_ERR(pdata))
return PTR_ERR(pdata);
if (!pdata) {
}
}
- if (!pdata->poll_interval) {
+ if (polled && !pdata->poll_interval) {
dev_err(dev, "missing poll_interval value\n");
- error = -EINVAL;
- goto err_free_pdata;
+ return -EINVAL;
+ }
+
+ buttons = devm_kzalloc(dev, pdata->nbuttons * sizeof(struct gpio_keys_button),
+ GFP_KERNEL);
+ if (!buttons) {
+ dev_err(dev, "no memory for button data\n");
+ return -ENOMEM;
}
+ memcpy(buttons, pdata->buttons, pdata->nbuttons * sizeof(struct gpio_keys_button));
- bdev = kzalloc(sizeof(struct gpio_keys_polled_dev) +
+ bdev = devm_kzalloc(dev, sizeof(struct gpio_keys_button_dev) +
pdata->nbuttons * sizeof(struct gpio_keys_button_data),
GFP_KERNEL);
if (!bdev) {
return -ENOMEM;
}
+ bdev->polled = polled;
+
for (i = 0; i < pdata->nbuttons; i++) {
- struct gpio_keys_button *button = &pdata->buttons[i];
+ struct gpio_keys_button *button = &buttons[i];
struct gpio_keys_button_data *bdata = &bdev->data[i];
unsigned int gpio = button->gpio;
if (button->wakeup) {
- dev_err(dev, DRV_NAME " does not support wakeup\n");
- error = -EINVAL;
- goto err_free_gpio;
+ dev_err(dev, DRV_NAME "does not support wakeup\n");
+ return -EINVAL;
}
- error = gpio_request(gpio,
+ error = devm_gpio_request(dev, gpio,
button->desc ? button->desc : DRV_NAME);
if (error) {
dev_err(dev, "unable to claim gpio %u, err=%d\n",
gpio, error);
- goto err_free_gpio;
+ return error;
}
+ bdata->gpiod = gpio_to_desc(gpio);
+ if (!bdata->gpiod)
+ return -EINVAL;
error = gpio_direction_input(gpio);
if (error) {
dev_err(dev,
"unable to set direction on gpio %u, err=%d\n",
gpio, error);
- goto err_free_gpio;
+ return error;
}
bdata->can_sleep = gpio_cansleep(gpio);
- bdata->last_state = gpio_button_get_value(button, bdata);
- bdata->threshold = DIV_ROUND_UP(button->debounce_interval,
- pdata->poll_interval);
+ bdata->last_state = -1;
+
+ if (bdev->polled) {
+ bdata->threshold = DIV_ROUND_UP(button->debounce_interval,
+ pdata->poll_interval);
+ } else {
+ bdata->threshold = 1;
+
+ if (button->debounce_interval) {
+ error = gpiod_set_debounce(bdata->gpiod,
+ button->debounce_interval * 1000);
+ /*
+ * use timer if gpiolib doesn't provide
+ * debounce.
+ */
+ if (error < 0) {
+ bdata->software_debounce =
+ button->debounce_interval;
+ }
+ }
+ }
+
+ bdata->b = &pdata->buttons[i];
}
bdev->dev = &pdev->dev;
bdev->pdata = pdata;
platform_set_drvdata(pdev, bdev);
- INIT_DELAYED_WORK(&bdev->work, gpio_keys_polled_poll);
+ *_bdev = bdev;
- gpio_keys_polled_open(bdev);
+ return 0;
+}
+
+static int gpio_keys_probe(struct platform_device *pdev)
+{
+ struct gpio_keys_platform_data *pdata;
+ struct gpio_keys_button_dev *bdev;
+ int ret, i;
+
+
+ ret = gpio_keys_button_probe(pdev, &bdev, 0);
+
+ if (ret)
+ return ret;
+
+ pdata = bdev->pdata;
+ for (i = 0; i < pdata->nbuttons; i++) {
+ const struct gpio_keys_button *button = &pdata->buttons[i];
+ struct gpio_keys_button_data *bdata = &bdev->data[i];
+ unsigned long irqflags = IRQF_ONESHOT;
+
+ if (!button->irq) {
+ bdata->irq = gpio_to_irq(button->gpio);
+
+ if (bdata->irq < 0) {
+ dev_err(&pdev->dev, "failed to get irq for gpio:%d\n",
+ button->gpio);
+ continue;
+ }
+
+ irqflags |= IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING;
+ } else {
+ bdata->irq = button->irq;
+ }
+
+ INIT_DELAYED_WORK(&bdata->work, gpio_keys_irq_work_func);
+
+ ret = devm_request_threaded_irq(&pdev->dev,
+ bdata->irq, NULL, button_handle_irq,
+ irqflags, dev_name(&pdev->dev), bdata);
+
+ if (ret < 0) {
+ bdata->irq = 0;
+ dev_err(&pdev->dev, "failed to request irq:%d for gpio:%d\n",
+ bdata->irq, button->gpio);
+ continue;
+ } else {
+ dev_dbg(&pdev->dev, "gpio:%d has irq:%d\n",
+ button->gpio, bdata->irq);
+ }
+
+ if (bdata->b->type == EV_SW)
+ button_hotplug_event(bdata, EV_SW, gpio_button_get_value(bdata));
+ }
return 0;
+}
+
+static int gpio_keys_polled_probe(struct platform_device *pdev)
+{
+ struct gpio_keys_platform_data *pdata;
+ struct gpio_keys_button_dev *bdev;
+ int ret;
+ int i;
-err_free_gpio:
- while (--i >= 0)
- gpio_free(pdata->buttons[i].gpio);
+ ret = gpio_keys_button_probe(pdev, &bdev, 1);
- kfree(bdev);
- platform_set_drvdata(pdev, NULL);
+ if (ret)
+ return ret;
+
+ INIT_DELAYED_WORK(&bdev->work, gpio_keys_polled_poll);
+
+ pdata = bdev->pdata;
-err_free_pdata:
- /* If we have no platform_data, we allocated pdata dynamically. */
- if (!dev_get_platdata(&pdev->dev))
- kfree(pdata);
+ if (pdata->enable)
+ pdata->enable(bdev->dev);
+
+ for (i = 0; i < pdata->nbuttons; i++)
+ gpio_keys_polled_check_state(&bdev->data[i]);
- return error;
+ gpio_keys_polled_queue_work(bdev);
+
+ return ret;
}
-static int gpio_keys_polled_remove(struct platform_device *pdev)
+static void gpio_keys_irq_close(struct gpio_keys_button_dev *bdev)
{
- struct gpio_keys_polled_dev *bdev = platform_get_drvdata(pdev);
struct gpio_keys_platform_data *pdata = bdev->pdata;
- int i = pdata->nbuttons;
+ size_t i;
- gpio_keys_polled_close(bdev);
+ for (i = 0; i < pdata->nbuttons; i++) {
+ struct gpio_keys_button_data *bdata = &bdev->data[i];
- while (--i >= 0)
- gpio_free(pdata->buttons[i].gpio);
+ disable_irq(bdata->irq);
+ cancel_delayed_work_sync(&bdata->work);
+ }
+}
+
+static int gpio_keys_remove(struct platform_device *pdev)
+{
+ struct gpio_keys_button_dev *bdev = platform_get_drvdata(pdev);
- kfree(bdev);
platform_set_drvdata(pdev, NULL);
+ if (bdev->polled)
+ gpio_keys_polled_close(bdev);
+ else
+ gpio_keys_irq_close(bdev);
+
return 0;
}
+static struct platform_driver gpio_keys_driver = {
+ .probe = gpio_keys_probe,
+ .remove = gpio_keys_remove,
+ .driver = {
+ .name = "gpio-keys",
+ .owner = THIS_MODULE,
+ .of_match_table = of_match_ptr(gpio_keys_of_match),
+ },
+};
+
static struct platform_driver gpio_keys_polled_driver = {
.probe = gpio_keys_polled_probe,
- .remove = gpio_keys_polled_remove,
+ .remove = gpio_keys_remove,
.driver = {
- .name = DRV_NAME,
+ .name = "gpio-keys-polled",
.owner = THIS_MODULE,
.of_match_table = of_match_ptr(gpio_keys_polled_of_match),
},
};
-static int __init gpio_keys_polled_init(void)
+static int __init gpio_button_init(void)
{
- return platform_driver_register(&gpio_keys_polled_driver);
+ int ret;
+
+ ret = platform_driver_register(&gpio_keys_driver);
+ if (ret)
+ return ret;
+
+ ret = platform_driver_register(&gpio_keys_polled_driver);
+ if (ret)
+ platform_driver_unregister(&gpio_keys_driver);
+
+ return ret;
}
-static void __exit gpio_keys_polled_exit(void)
+static void __exit gpio_button_exit(void)
{
+ platform_driver_unregister(&gpio_keys_driver);
platform_driver_unregister(&gpio_keys_polled_driver);
}
-module_init(gpio_keys_polled_init);
-module_exit(gpio_keys_polled_exit);
+module_init(gpio_button_init);
+module_exit(gpio_button_exit);
MODULE_AUTHOR("Gabor Juhos <juhosg@openwrt.org>");
-MODULE_AUTHOR("Felix Fietkau <nbd@openwrt.org>");
+MODULE_AUTHOR("Felix Fietkau <nbd@nbd.name>");
MODULE_DESCRIPTION("Polled GPIO Buttons hotplug driver");
MODULE_LICENSE("GPL v2");
MODULE_ALIAS("platform:" DRV_NAME);