/*
* 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/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"
+#include <linux/gpio/consumer.h>
#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;
-};
-
struct bh_event {
const char *name;
unsigned int type;
struct gpio_keys_button_data {
struct delayed_work work;
- struct bh_priv bh;
+ unsigned long seen;
+ int map_entry;
int last_state;
int count;
int threshold;
int can_sleep;
- struct gpio_keys_button *b;
+ 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_POWER, "power"),
- 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_VOLUMEDOWN, "volume_down"),
+ BH_MAP(KEY_VOLUMEUP, "volume_up"),
+ 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 buf[128];
char *s;
va_list args;
int len;
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;
}
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;
return -1;
}
-static void button_hotplug_event(struct gpio_keys_button_data *data,
- 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, data->b->code, value);
-
- if ((type != EV_KEY) && (type != EV_SW))
- return;
-
- btn = button_get_index(data->b->code);
- if (btn < 0)
- return;
-
- 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, int value)
-{
-}
-#endif /* CONFIG_HOTPLUG */
-
-struct gpio_keys_button_dev {
- int polled;
- struct delayed_work work;
-
- struct device *dev;
- struct gpio_keys_platform_data *pdata;
- struct gpio_keys_button_data data[0];
-};
-
static int gpio_button_get_value(struct gpio_keys_button_data *bdata)
{
int val;
if (bdata->can_sleep)
- val = !!gpio_get_value_cansleep(bdata->b->gpio);
+ val = !!gpiod_get_value_cansleep(bdata->gpiod);
else
- val = !!gpio_get_value(bdata->b->gpio);
+ val = !!gpiod_get_value(bdata->gpiod);
- return val ^ bdata->b->active_low;
+ return val;
}
-static void gpio_keys_polled_check_state(struct gpio_keys_button_data *bdata)
+static void gpio_keys_handle_button(struct gpio_keys_button_data *bdata)
{
+ unsigned int type = bdata->b->type ?: EV_KEY;
int state = gpio_button_get_value(bdata);
+ unsigned long seen = jiffies;
- if (state != bdata->last_state) {
- unsigned int type = bdata->b->type ?: EV_KEY;
+ pr_debug(PFX "event type=%u, code=%u, pressed=%d\n",
+ type, bdata->b->code, state);
+
+ /* is this the initialization state? */
+ if (bdata->last_state == -1) {
+ /*
+ * Don't advertise unpressed buttons on initialization.
+ * Just save their state and continue otherwise this
+ * can cause OpenWrt to enter failsafe.
+ */
+ if (type == EV_KEY && state == 0)
+ goto set_state;
+ /*
+ * But we are very interested in pressed buttons and
+ * initial switch state. These will be reported to
+ * userland.
+ */
+ } else if (bdata->last_state == state) {
+ /* reset asserted counter (only relevant for polled keys) */
+ bdata->count = 0;
+ return;
+ }
- if (bdata->count < bdata->threshold) {
- bdata->count++;
- return;
- }
+ if (bdata->count < bdata->threshold) {
+ bdata->count++;
+ return;
+ }
- if ((bdata->last_state != -1) || (type == EV_SW))
- button_hotplug_event(bdata, type, state);
+ if (bdata->seen == 0)
+ bdata->seen = seen;
- bdata->last_state = state;
- }
+ button_hotplug_create_event(button_map[bdata->map_entry].name, type,
+ (seen - bdata->seen) / HZ, state);
+ bdata->seen = seen;
+set_state:
+ bdata->last_state = state;
bdata->count = 0;
}
+struct gpio_keys_button_dev {
+ int polled;
+ struct delayed_work work;
+
+ struct device *dev;
+ struct gpio_keys_platform_data *pdata;
+ struct gpio_keys_button_data data[0];
+};
+
static void gpio_keys_polled_queue_work(struct gpio_keys_button_dev *bdev)
{
struct gpio_keys_platform_data *pdata = bdev->pdata;
for (i = 0; i < bdev->pdata->nbuttons; i++) {
struct gpio_keys_button_data *bdata = &bdev->data[i];
- gpio_keys_polled_check_state(bdata);
+
+ if (bdata->gpiod)
+ gpio_keys_handle_button(bdata);
}
gpio_keys_polled_queue_work(bdev);
}
pdata->disable(bdev->dev);
}
+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);
+
+ gpio_keys_handle_button(bdata);
+}
+
static irqreturn_t button_handle_irq(int irq, void *_bdata)
{
- struct gpio_keys_button_data *bdata = (struct gpio_keys_button_data *) _bdata;
+ struct gpio_keys_button_data *bdata =
+ (struct gpio_keys_button_data *) _bdata;
- button_hotplug_event(bdata, bdata->b->type ?: EV_KEY, gpio_button_get_value(bdata));
+ mod_delayed_work(system_wq, &bdata->work,
+ msecs_to_jiffies(bdata->software_debounce));
return IRQ_HANDLED;
}
struct device_node *node, *pp;
struct gpio_keys_platform_data *pdata;
struct gpio_keys_button *button;
- int error;
int nbuttons;
int i = 0;
nbuttons = of_get_child_count(node);
if (nbuttons == 0)
- return NULL;
+ return ERR_PTR(-EINVAL);
pdata = devm_kzalloc(dev, sizeof(*pdata) + nbuttons * (sizeof *button),
GFP_KERNEL);
- if (!pdata) {
- error = -ENOMEM;
- goto err_out;
- }
+ if (!pdata)
+ return ERR_PTR(-ENOMEM);
pdata->buttons = (struct gpio_keys_button *)(pdata + 1);
pdata->nbuttons = nbuttons;
of_property_read_u32(node, "poll-interval", &pdata->poll_interval);
for_each_child_of_node(node, pp) {
- enum of_gpio_flags flags;
-
- if (!of_find_property(pp, "gpios", NULL)) {
- pdata->nbuttons--;
- dev_warn(dev, "Found button without gpios\n");
- continue;
- }
-
- button = &pdata->buttons[i++];
-
- button->gpio = of_get_gpio_flags(pp, 0, &flags);
- button->active_low = flags & OF_GPIO_ACTIVE_LOW;
+ button = (struct gpio_keys_button *)(&pdata->buttons[i++]);
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_out;
+ dev_err(dev, "Button node '%s' without keycode\n",
+ pp->full_name);
+ of_node_put(pp);
+ return ERR_PTR(-EINVAL);
}
button->desc = of_get_property(pp, "label", NULL);
if (of_property_read_u32(pp, "debounce-interval",
&button->debounce_interval))
button->debounce_interval = 5;
- }
- if (pdata->nbuttons == 0) {
- error = -EINVAL;
- goto err_out;
+ button->irq = irq_of_parse_and_map(pp, 0);
+ button->gpio = -ENOENT; /* mark this as device-tree */
}
return pdata;
-
-err_out:
- return ERR_PTR(error);
}
static struct of_device_id gpio_keys_of_match[] = {
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_platform_data *pdata = dev_get_platdata(dev);
struct gpio_keys_button_dev *bdev;
struct gpio_keys_button *buttons;
- int error;
+ struct device_node *prev = NULL;
+ int error = 0;
int i;
if (!pdata) {
dev_err(dev, "missing platform data\n");
return -EINVAL;
}
- pdev->dev.platform_data = pdata;
}
if (polled && !pdata->poll_interval) {
for (i = 0; i < pdata->nbuttons; i++) {
struct gpio_keys_button *button = &buttons[i];
struct gpio_keys_button_data *bdata = &bdev->data[i];
- unsigned int gpio = button->gpio;
+ const char *desc = button->desc ? button->desc : DRV_NAME;
if (button->wakeup) {
- dev_err(dev, DRV_NAME "does not support wakeup\n");
- return -EINVAL;
+ dev_err(dev, "does not support wakeup\n");
+ error = -EINVAL;
+ goto out;
}
- 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);
- return error;
+ bdata->map_entry = button_get_index(button->code);
+ if (bdata->map_entry < 0) {
+ dev_err(dev, "does not support key code:%u\n",
+ button->code);
+ error = -EINVAL;
+ goto out;
}
- error = gpio_direction_input(gpio);
- if (error) {
- dev_err(dev,
- "unable to set direction on gpio %u, err=%d\n",
- gpio, error);
- return error;
+ if (!(button->type == 0 || button->type == EV_KEY ||
+ button->type == EV_SW)) {
+ dev_err(dev, "only supports buttons or switches\n");
+ error = -EINVAL;
+ goto out;
}
- bdata->can_sleep = gpio_cansleep(gpio);
- bdata->last_state = -1;
+ if (button->irq) {
+ dev_err(dev, "skipping button %s (only gpio buttons supported)\n",
+ button->desc);
+ bdata->b = &pdata->buttons[i];
+ continue;
+ }
- if (bdev->polled)
+ if (gpio_is_valid(button->gpio)) {
+ /* legacy platform data... but is it the lookup table? */
+ bdata->gpiod = devm_gpiod_get_index(dev, desc, i,
+ GPIOD_IN);
+ if (IS_ERR(bdata->gpiod)) {
+ /* or the legacy (button->gpio is good) way? */
+ error = devm_gpio_request_one(dev,
+ button->gpio, GPIOF_IN | (
+ button->active_low ? GPIOF_ACTIVE_LOW :
+ 0), desc);
+ if (error) {
+ if (error != -EPROBE_DEFER) {
+ dev_err(dev, "unable to claim gpio %d, err=%d\n",
+ button->gpio, error);
+ }
+ goto out;
+ }
+
+ bdata->gpiod = gpio_to_desc(button->gpio);
+ }
+ } else {
+ /* Device-tree */
+ struct device_node *child =
+ of_get_next_child(dev->of_node, prev);
+
+ bdata->gpiod = devm_fwnode_gpiod_get(dev,
+ of_fwnode_handle(child), NULL, GPIOD_IN,
+ desc);
+
+ prev = child;
+ }
+
+ if (IS_ERR_OR_NULL(bdata->gpiod)) {
+ error = IS_ERR(bdata->gpiod) ? PTR_ERR(bdata->gpiod) :
+ -EINVAL;
+ goto out;
+ }
+
+ bdata->can_sleep = gpiod_cansleep(bdata->gpiod);
+ bdata->last_state = -1; /* Unknown state on boot */
+
+ if (bdev->polled) {
bdata->threshold = DIV_ROUND_UP(button->debounce_interval,
- pdata->poll_interval);
- else
- bdata->threshold = 1;
+ pdata->poll_interval);
+ } else {
+ /* bdata->threshold = 0; already initialized */
+
+ 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];
}
platform_set_drvdata(pdev, bdev);
*_bdev = bdev;
+ error = 0;
- return 0;
+out:
+ of_node_put(prev);
+ return error;
}
static int gpio_keys_probe(struct platform_device *pdev)
struct gpio_keys_button_dev *bdev;
int ret, i;
-
ret = gpio_keys_button_probe(pdev, &bdev, 0);
-
if (ret)
return ret;
- pdata = pdev->dev.platform_data;
+ pdata = bdev->pdata;
for (i = 0; i < pdata->nbuttons; i++) {
- struct gpio_keys_button *button = &pdata->buttons[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 (bdata->can_sleep) {
- dev_err(&pdev->dev, "skipping gpio:%d, it can sleep\n", button->gpio);
- continue;
+ INIT_DELAYED_WORK(&bdata->work, gpio_keys_irq_work_func);
+
+ if (!button->irq) {
+ bdata->irq = gpiod_to_irq(bdata->gpiod);
+ 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;
}
- if (!button->irq)
- button->irq = gpio_to_irq(button->gpio);
- if (button->irq < 0) {
- dev_err(&pdev->dev, "failed to get irq for gpio:%d\n", button->gpio);
+
+ schedule_delayed_work(&bdata->work,
+ msecs_to_jiffies(bdata->software_debounce));
+
+ 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);
}
- ret = devm_request_irq(&pdev->dev, button->irq, button_handle_irq,
- IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING,
- dev_name(&pdev->dev), bdata);
- if (ret)
- dev_err(&pdev->dev, "failed to request irq:%d for gpio:%d\n", button->irq, button->gpio);
- else
- dev_dbg(&pdev->dev, "gpio:%d has irq:%d\n", button->gpio, button->irq);
-
- if (bdata->b->type == EV_SW)
- button_hotplug_event(bdata, EV_SW, gpio_button_get_value(bdata));
}
return 0;
struct gpio_keys_platform_data *pdata;
struct gpio_keys_button_dev *bdev;
int ret;
- int i;
ret = gpio_keys_button_probe(pdev, &bdev, 1);
-
if (ret)
return ret;
INIT_DELAYED_WORK(&bdev->work, gpio_keys_polled_poll);
pdata = bdev->pdata;
-
if (pdata->enable)
pdata->enable(bdev->dev);
- for (i = 0; i < pdata->nbuttons; i++)
- gpio_keys_polled_check_state(&bdev->data[i]);
-
gpio_keys_polled_queue_work(bdev);
return ret;
}
+static void gpio_keys_irq_close(struct gpio_keys_button_dev *bdev)
+{
+ struct gpio_keys_platform_data *pdata = bdev->pdata;
+ size_t i;
+
+ for (i = 0; i < pdata->nbuttons; i++) {
+ struct gpio_keys_button_data *bdata = &bdev->data[i];
+
+ 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);
if (bdev->polled)
gpio_keys_polled_close(bdev);
+ else
+ gpio_keys_irq_close(bdev);
return 0;
}
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);