gpio_keys.c 21.2 KB
Newer Older
1 2 3 4
/*
 * Driver for keys on GPIO lines capable of generating interrupts.
 *
 * Copyright 2005 Phil Blundell
5
 * Copyright 2010, 2011 David Jander <david@protonic.nl>
6 7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 */

#include <linux/module.h>

#include <linux/init.h>
#include <linux/fs.h>
#include <linux/interrupt.h>
#include <linux/irq.h>
#include <linux/sched.h>
#include <linux/pm.h>
20
#include <linux/slab.h>
21 22 23 24 25
#include <linux/sysctl.h>
#include <linux/proc_fs.h>
#include <linux/delay.h>
#include <linux/platform_device.h>
#include <linux/input.h>
26
#include <linux/gpio_keys.h>
27
#include <linux/workqueue.h>
28
#include <linux/gpio.h>
29
#include <linux/of.h>
30 31
#include <linux/of_platform.h>
#include <linux/of_gpio.h>
32
#include <linux/of_irq.h>
33
#include <linux/spinlock.h>
34

35
struct gpio_button_data {
36
	const struct gpio_keys_button *button;
37
	struct input_dev *input;
38
	struct timer_list timer;
39
	struct work_struct work;
40 41 42
	unsigned int timer_debounce;	/* in msecs */
	unsigned int irq;
	spinlock_t lock;
43
	bool disabled;
44
	bool key_pressed;
45 46 47
};

struct gpio_keys_drvdata {
48
	const struct gpio_keys_platform_data *pdata;
49
	struct input_dev *input;
50
	struct mutex disable_lock;
51 52 53
	struct gpio_button_data data[0];
};

54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
/*
 * SYSFS interface for enabling/disabling keys and switches:
 *
 * There are 4 attributes under /sys/devices/platform/gpio-keys/
 *	keys [ro]              - bitmap of keys (EV_KEY) which can be
 *	                         disabled
 *	switches [ro]          - bitmap of switches (EV_SW) which can be
 *	                         disabled
 *	disabled_keys [rw]     - bitmap of keys currently disabled
 *	disabled_switches [rw] - bitmap of switches currently disabled
 *
 * Userland can change these values and hence disable event generation
 * for each key (or switch). Disabling a key means its interrupt line
 * is disabled.
 *
 * For example, if we have following switches set up as gpio-keys:
 *	SW_DOCK = 5
 *	SW_CAMERA_LENS_COVER = 9
 *	SW_KEYPAD_SLIDE = 10
 *	SW_FRONT_PROXIMITY = 11
 * This is read from switches:
 *	11-9,5
 * Next we want to disable proximity (11) and dock (5), we write:
 *	11,5
 * to file disabled_switches. Now proximity and dock IRQs are disabled.
 * This can be verified by reading the file disabled_switches:
 *	11,5
 * If we now want to enable proximity (11) switch we write:
 *	5
 * to disabled_switches.
 *
 * We can disable only those keys which don't allow sharing the irq.
 */

/**
 * get_n_events_by_type() - returns maximum number of events per @type
 * @type: type of button (%EV_KEY, %EV_SW)
 *
 * Return value of this function can be used to allocate bitmap
 * large enough to hold all bits for given type.
 */
static inline int get_n_events_by_type(int type)
{
	BUG_ON(type != EV_SW && type != EV_KEY);

	return (type == EV_KEY) ? KEY_CNT : SW_CNT;
}

/**
 * gpio_keys_disable_button() - disables given GPIO button
 * @bdata: button data for button to be disabled
 *
 * Disables button pointed by @bdata. This is done by masking
 * IRQ line. After this function is called, button won't generate
 * input events anymore. Note that one can only disable buttons
 * that don't share IRQs.
 *
 * Make sure that @bdata->disable_lock is locked when entering
 * this function to avoid races when concurrent threads are
 * disabling buttons at the same time.
 */
static void gpio_keys_disable_button(struct gpio_button_data *bdata)
{
	if (!bdata->disabled) {
		/*
		 * Disable IRQ and possible debouncing timer.
		 */
121
		disable_irq(bdata->irq);
122
		if (bdata->timer_debounce)
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
			del_timer_sync(&bdata->timer);

		bdata->disabled = true;
	}
}

/**
 * gpio_keys_enable_button() - enables given GPIO button
 * @bdata: button data for button to be disabled
 *
 * Enables given button pointed by @bdata.
 *
 * Make sure that @bdata->disable_lock is locked when entering
 * this function to avoid races with concurrent threads trying
 * to enable the same button at the same time.
 */
static void gpio_keys_enable_button(struct gpio_button_data *bdata)
{
	if (bdata->disabled) {
142
		enable_irq(bdata->irq);
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
		bdata->disabled = false;
	}
}

/**
 * gpio_keys_attr_show_helper() - fill in stringified bitmap of buttons
 * @ddata: pointer to drvdata
 * @buf: buffer where stringified bitmap is written
 * @type: button type (%EV_KEY, %EV_SW)
 * @only_disabled: does caller want only those buttons that are
 *                 currently disabled or all buttons that can be
 *                 disabled
 *
 * This function writes buttons that can be disabled to @buf. If
 * @only_disabled is true, then @buf contains only those buttons
 * that are currently disabled. Returns 0 on success or negative
 * errno on failure.
 */
static ssize_t gpio_keys_attr_show_helper(struct gpio_keys_drvdata *ddata,
					  char *buf, unsigned int type,
					  bool only_disabled)
{
	int n_events = get_n_events_by_type(type);
	unsigned long *bits;
	ssize_t ret;
	int i;

	bits = kcalloc(BITS_TO_LONGS(n_events), sizeof(*bits), GFP_KERNEL);
	if (!bits)
		return -ENOMEM;

174
	for (i = 0; i < ddata->pdata->nbuttons; i++) {
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
		struct gpio_button_data *bdata = &ddata->data[i];

		if (bdata->button->type != type)
			continue;

		if (only_disabled && !bdata->disabled)
			continue;

		__set_bit(bdata->button->code, bits);
	}

	ret = bitmap_scnlistprintf(buf, PAGE_SIZE - 2, bits, n_events);
	buf[ret++] = '\n';
	buf[ret] = '\0';

	kfree(bits);

	return ret;
}

/**
 * gpio_keys_attr_store_helper() - enable/disable buttons based on given bitmap
 * @ddata: pointer to drvdata
 * @buf: buffer from userspace that contains stringified bitmap
 * @type: button type (%EV_KEY, %EV_SW)
 *
 * This function parses stringified bitmap from @buf and disables/enables
202
 * GPIO buttons accordingly. Returns 0 on success and negative error
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
 * on failure.
 */
static ssize_t gpio_keys_attr_store_helper(struct gpio_keys_drvdata *ddata,
					   const char *buf, unsigned int type)
{
	int n_events = get_n_events_by_type(type);
	unsigned long *bits;
	ssize_t error;
	int i;

	bits = kcalloc(BITS_TO_LONGS(n_events), sizeof(*bits), GFP_KERNEL);
	if (!bits)
		return -ENOMEM;

	error = bitmap_parselist(buf, bits, n_events);
	if (error)
		goto out;

	/* First validate */
222
	for (i = 0; i < ddata->pdata->nbuttons; i++) {
223 224 225 226 227 228 229 230 231 232 233 234 235 236
		struct gpio_button_data *bdata = &ddata->data[i];

		if (bdata->button->type != type)
			continue;

		if (test_bit(bdata->button->code, bits) &&
		    !bdata->button->can_disable) {
			error = -EINVAL;
			goto out;
		}
	}

	mutex_lock(&ddata->disable_lock);

237
	for (i = 0; i < ddata->pdata->nbuttons; i++) {
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
		struct gpio_button_data *bdata = &ddata->data[i];

		if (bdata->button->type != type)
			continue;

		if (test_bit(bdata->button->code, bits))
			gpio_keys_disable_button(bdata);
		else
			gpio_keys_enable_button(bdata);
	}

	mutex_unlock(&ddata->disable_lock);

out:
	kfree(bits);
	return error;
}

#define ATTR_SHOW_FN(name, type, only_disabled)				\
static ssize_t gpio_keys_show_##name(struct device *dev,		\
				     struct device_attribute *attr,	\
				     char *buf)				\
{									\
	struct platform_device *pdev = to_platform_device(dev);		\
	struct gpio_keys_drvdata *ddata = platform_get_drvdata(pdev);	\
									\
	return gpio_keys_attr_show_helper(ddata, buf,			\
					  type, only_disabled);		\
}

ATTR_SHOW_FN(keys, EV_KEY, false);
ATTR_SHOW_FN(switches, EV_SW, false);
ATTR_SHOW_FN(disabled_keys, EV_KEY, true);
ATTR_SHOW_FN(disabled_switches, EV_SW, true);

/*
 * ATTRIBUTES:
 *
 * /sys/devices/platform/gpio-keys/keys [ro]
 * /sys/devices/platform/gpio-keys/switches [ro]
 */
static DEVICE_ATTR(keys, S_IRUGO, gpio_keys_show_keys, NULL);
static DEVICE_ATTR(switches, S_IRUGO, gpio_keys_show_switches, NULL);

#define ATTR_STORE_FN(name, type)					\
static ssize_t gpio_keys_store_##name(struct device *dev,		\
				      struct device_attribute *attr,	\
				      const char *buf,			\
				      size_t count)			\
{									\
	struct platform_device *pdev = to_platform_device(dev);		\
	struct gpio_keys_drvdata *ddata = platform_get_drvdata(pdev);	\
	ssize_t error;							\
									\
	error = gpio_keys_attr_store_helper(ddata, buf, type);		\
	if (error)							\
		return error;						\
									\
	return count;							\
}

ATTR_STORE_FN(disabled_keys, EV_KEY);
ATTR_STORE_FN(disabled_switches, EV_SW);

/*
 * ATTRIBUTES:
 *
 * /sys/devices/platform/gpio-keys/disabled_keys [rw]
 * /sys/devices/platform/gpio-keys/disables_switches [rw]
 */
static DEVICE_ATTR(disabled_keys, S_IWUSR | S_IRUGO,
		   gpio_keys_show_disabled_keys,
		   gpio_keys_store_disabled_keys);
static DEVICE_ATTR(disabled_switches, S_IWUSR | S_IRUGO,
		   gpio_keys_show_disabled_switches,
		   gpio_keys_store_disabled_switches);

static struct attribute *gpio_keys_attrs[] = {
	&dev_attr_keys.attr,
	&dev_attr_switches.attr,
	&dev_attr_disabled_keys.attr,
	&dev_attr_disabled_switches.attr,
	NULL,
};

static struct attribute_group gpio_keys_attr_group = {
	.attrs = gpio_keys_attrs,
};

327
static void gpio_keys_gpio_report_event(struct gpio_button_data *bdata)
328
{
329
	const struct gpio_keys_button *button = bdata->button;
330
	struct input_dev *input = bdata->input;
331
	unsigned int type = button->type ?: EV_KEY;
332
	int state = (gpio_get_value_cansleep(button->gpio) ? 1 : 0) ^ button->active_low;
333

334 335 336 337 338 339
	if (type == EV_ABS) {
		if (state)
			input_event(input, type, button->code, button->value);
	} else {
		input_event(input, type, button->code, !!state);
	}
340 341 342
	input_sync(input);
}

343
static void gpio_keys_gpio_work_func(struct work_struct *work)
344 345 346 347
{
	struct gpio_button_data *bdata =
		container_of(work, struct gpio_button_data, work);

348
	gpio_keys_gpio_report_event(bdata);
349 350 351

	if (bdata->button->wakeup)
		pm_relax(bdata->input->dev.parent);
352 353
}

354
static void gpio_keys_gpio_timer(unsigned long _data)
355
{
356
	struct gpio_button_data *bdata = (struct gpio_button_data *)_data;
357

358
	schedule_work(&bdata->work);
359 360
}

361
static irqreturn_t gpio_keys_gpio_isr(int irq, void *dev_id)
362
{
363
	struct gpio_button_data *bdata = dev_id;
364

365
	BUG_ON(irq != bdata->irq);
366

367 368
	if (bdata->button->wakeup)
		pm_stay_awake(bdata->input->dev.parent);
369
	if (bdata->timer_debounce)
370
		mod_timer(&bdata->timer,
371
			jiffies + msecs_to_jiffies(bdata->timer_debounce));
372
	else
373
		schedule_work(&bdata->work);
374

375
	return IRQ_HANDLED;
376 377
}

378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
static void gpio_keys_irq_timer(unsigned long _data)
{
	struct gpio_button_data *bdata = (struct gpio_button_data *)_data;
	struct input_dev *input = bdata->input;
	unsigned long flags;

	spin_lock_irqsave(&bdata->lock, flags);
	if (bdata->key_pressed) {
		input_event(input, EV_KEY, bdata->button->code, 0);
		input_sync(input);
		bdata->key_pressed = false;
	}
	spin_unlock_irqrestore(&bdata->lock, flags);
}

static irqreturn_t gpio_keys_irq_isr(int irq, void *dev_id)
{
	struct gpio_button_data *bdata = dev_id;
	const struct gpio_keys_button *button = bdata->button;
	struct input_dev *input = bdata->input;
	unsigned long flags;

	BUG_ON(irq != bdata->irq);

	spin_lock_irqsave(&bdata->lock, flags);

	if (!bdata->key_pressed) {
405 406 407
		if (bdata->button->wakeup)
			pm_wakeup_event(bdata->input->dev.parent, 0);

408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
		input_event(input, EV_KEY, button->code, 1);
		input_sync(input);

		if (!bdata->timer_debounce) {
			input_event(input, EV_KEY, button->code, 0);
			input_sync(input);
			goto out;
		}

		bdata->key_pressed = true;
	}

	if (bdata->timer_debounce)
		mod_timer(&bdata->timer,
			jiffies + msecs_to_jiffies(bdata->timer_debounce));
out:
	spin_unlock_irqrestore(&bdata->lock, flags);
	return IRQ_HANDLED;
}

428 429 430 431 432 433 434 435 436 437
static void gpio_keys_quiesce_key(void *data)
{
	struct gpio_button_data *bdata = data;

	if (bdata->timer_debounce)
		del_timer_sync(&bdata->timer);

	cancel_work_sync(&bdata->work);
}

B
Bill Pemberton 已提交
438 439 440 441
static int gpio_keys_setup_key(struct platform_device *pdev,
				struct input_dev *input,
				struct gpio_button_data *bdata,
				const struct gpio_keys_button *button)
442
{
443
	const char *desc = button->desc ? button->desc : "gpio_keys";
444
	struct device *dev = &pdev->dev;
445
	irq_handler_t isr;
446
	unsigned long irqflags;
447 448
	int irq;
	int error;
449

450 451
	bdata->input = input;
	bdata->button = button;
452
	spin_lock_init(&bdata->lock);
453

454
	if (gpio_is_valid(button->gpio)) {
455

456 457
		error = devm_gpio_request_one(&pdev->dev, button->gpio,
					      GPIOF_IN, desc);
458 459 460 461 462
		if (error < 0) {
			dev_err(dev, "Failed to request GPIO %d, error %d\n",
				button->gpio, error);
			return error;
		}
463

464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
		if (button->debounce_interval) {
			error = gpio_set_debounce(button->gpio,
					button->debounce_interval * 1000);
			/* use timer if gpiolib doesn't provide debounce */
			if (error < 0)
				bdata->timer_debounce =
						button->debounce_interval;
		}

		irq = gpio_to_irq(button->gpio);
		if (irq < 0) {
			error = irq;
			dev_err(dev,
				"Unable to get irq number for GPIO %d, error %d\n",
				button->gpio, error);
479
			return error;
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
		}
		bdata->irq = irq;

		INIT_WORK(&bdata->work, gpio_keys_gpio_work_func);
		setup_timer(&bdata->timer,
			    gpio_keys_gpio_timer, (unsigned long)bdata);

		isr = gpio_keys_gpio_isr;
		irqflags = IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING;

	} else {
		if (!button->irq) {
			dev_err(dev, "No IRQ specified\n");
			return -EINVAL;
		}
		bdata->irq = button->irq;

		if (button->type && button->type != EV_KEY) {
			dev_err(dev, "Only EV_KEY allowed for IRQ buttons.\n");
			return -EINVAL;
		}

		bdata->timer_debounce = button->debounce_interval;
		setup_timer(&bdata->timer,
			    gpio_keys_irq_timer, (unsigned long)bdata);

		isr = gpio_keys_irq_isr;
		irqflags = 0;
508 509
	}

510 511
	input_set_capability(input, button->type ?: EV_KEY, button->code);

512 513 514 515 516 517 518 519 520 521 522 523
	/*
	 * Install custom action to cancel debounce timer and
	 * workqueue item.
	 */
	error = devm_add_action(&pdev->dev, gpio_keys_quiesce_key, bdata);
	if (error) {
		dev_err(&pdev->dev,
			"failed to register quiesce action, error: %d\n",
			error);
		return error;
	}

524 525 526 527 528 529 530
	/*
	 * If platform has specified that the button can be disabled,
	 * we don't want it to share the interrupt line.
	 */
	if (!button->can_disable)
		irqflags |= IRQF_SHARED;

531 532
	error = devm_request_any_context_irq(&pdev->dev, bdata->irq,
					     isr, irqflags, desc, bdata);
533
	if (error < 0) {
534
		dev_err(dev, "Unable to claim irq %d; error %d\n",
535
			bdata->irq, error);
536
		return error;
537 538 539 540 541
	}

	return 0;
}

542 543 544 545 546 547 548 549 550 551 552 553 554
static void gpio_keys_report_state(struct gpio_keys_drvdata *ddata)
{
	struct input_dev *input = ddata->input;
	int i;

	for (i = 0; i < ddata->pdata->nbuttons; i++) {
		struct gpio_button_data *bdata = &ddata->data[i];
		if (gpio_is_valid(bdata->button->gpio))
			gpio_keys_gpio_report_event(bdata);
	}
	input_sync(input);
}

555 556 557
static int gpio_keys_open(struct input_dev *input)
{
	struct gpio_keys_drvdata *ddata = input_get_drvdata(input);
558
	const struct gpio_keys_platform_data *pdata = ddata->pdata;
559 560 561 562 563 564 565
	int error;

	if (pdata->enable) {
		error = pdata->enable(input->dev.parent);
		if (error)
			return error;
	}
566

567 568 569 570
	/* Report current state of buttons that are connected to GPIOs */
	gpio_keys_report_state(ddata);

	return 0;
571 572 573 574 575
}

static void gpio_keys_close(struct input_dev *input)
{
	struct gpio_keys_drvdata *ddata = input_get_drvdata(input);
576
	const struct gpio_keys_platform_data *pdata = ddata->pdata;
577

578 579
	if (pdata->disable)
		pdata->disable(input->dev.parent);
580 581
}

582 583 584
/*
 * Handlers for alternative sources of platform_data
 */
585

586 587 588 589
#ifdef CONFIG_OF
/*
 * Translate OpenFirmware node properties into platform_data
 */
B
Bill Pemberton 已提交
590
static struct gpio_keys_platform_data *
591
gpio_keys_get_devtree_pdata(struct device *dev)
592 593
{
	struct device_node *node, *pp;
594 595 596 597
	struct gpio_keys_platform_data *pdata;
	struct gpio_keys_button *button;
	int error;
	int nbuttons;
598 599 600
	int i;

	node = dev->of_node;
601 602
	if (!node)
		return ERR_PTR(-ENODEV);
603

604
	nbuttons = of_get_child_count(node);
605 606
	if (nbuttons == 0)
		return ERR_PTR(-ENODEV);
607

608 609 610 611 612
	pdata = devm_kzalloc(dev,
			     sizeof(*pdata) + nbuttons * sizeof(*button),
			     GFP_KERNEL);
	if (!pdata)
		return ERR_PTR(-ENOMEM);
613

614 615
	pdata->buttons = (struct gpio_keys_button *)(pdata + 1);
	pdata->nbuttons = nbuttons;
616

617
	pdata->rep = !!of_get_property(node, "autorepeat", NULL);
618 619

	i = 0;
620
	for_each_child_of_node(node, pp) {
621
		int gpio = -1;
622 623
		enum of_gpio_flags flags;

624 625
		button = &pdata->buttons[i++];

626
		if (!of_find_property(pp, "gpios", NULL)) {
627 628
			button->irq = irq_of_parse_and_map(pp, 0);
			if (button->irq == 0) {
629
				i--;
630 631 632 633 634 635 636 637 638 639 640 641 642 643
				pdata->nbuttons--;
				dev_warn(dev, "Found button without gpios or irqs\n");
				continue;
			}
		} else {
			gpio = of_get_gpio_flags(pp, 0, &flags);
			if (gpio < 0) {
				error = gpio;
				if (error != -EPROBE_DEFER)
					dev_err(dev,
						"Failed to get gpio flags, error: %d\n",
						error);
				return ERR_PTR(error);
			}
644 645 646
		}

		button->gpio = gpio;
647
		button->active_low = flags & OF_GPIO_ACTIVE_LOW;
648

649 650 651
		if (of_property_read_u32(pp, "linux,code", &button->code)) {
			dev_err(dev, "Button without keycode: 0x%x\n",
				button->gpio);
652
			return ERR_PTR(-EINVAL);
653
		}
654

655
		button->desc = of_get_property(pp, "label", NULL);
656

657 658 659 660
		if (of_property_read_u32(pp, "linux,input-type", &button->type))
			button->type = EV_KEY;

		button->wakeup = !!of_get_property(pp, "gpio-key,wakeup", NULL);
661

662 663 664
		if (of_property_read_u32(pp, "debounce-interval",
					 &button->debounce_interval))
			button->debounce_interval = 5;
665 666
	}

667 668
	if (pdata->nbuttons == 0)
		return ERR_PTR(-EINVAL);
669

670
	return pdata;
671 672
}

673
static const struct of_device_id gpio_keys_of_match[] = {
674 675 676 677 678 679 680
	{ .compatible = "gpio-keys", },
	{ },
};
MODULE_DEVICE_TABLE(of, gpio_keys_of_match);

#else

681 682
static inline struct gpio_keys_platform_data *
gpio_keys_get_devtree_pdata(struct device *dev)
683
{
684
	return ERR_PTR(-ENODEV);
685 686 687 688
}

#endif

B
Bill Pemberton 已提交
689
static int gpio_keys_probe(struct platform_device *pdev)
690
{
691
	struct device *dev = &pdev->dev;
692 693
	const struct gpio_keys_platform_data *pdata = dev_get_platdata(dev);
	struct gpio_keys_drvdata *ddata;
694
	struct input_dev *input;
695
	size_t size;
696
	int i, error;
697
	int wakeup = 0;
698

699
	if (!pdata) {
700 701 702
		pdata = gpio_keys_get_devtree_pdata(dev);
		if (IS_ERR(pdata))
			return PTR_ERR(pdata);
703 704
	}

705 706 707 708
	size = sizeof(struct gpio_keys_drvdata) +
			pdata->nbuttons * sizeof(struct gpio_button_data);
	ddata = devm_kzalloc(dev, size, GFP_KERNEL);
	if (!ddata) {
709
		dev_err(dev, "failed to allocate state\n");
710 711 712 713 714 715 716
		return -ENOMEM;
	}

	input = devm_input_allocate_device(dev);
	if (!input) {
		dev_err(dev, "failed to allocate input device\n");
		return -ENOMEM;
717
	}
718

719
	ddata->pdata = pdata;
720 721 722
	ddata->input = input;
	mutex_init(&ddata->disable_lock);

723
	platform_set_drvdata(pdev, ddata);
724
	input_set_drvdata(input, ddata);
725

726
	input->name = pdata->name ? : pdev->name;
727
	input->phys = "gpio-keys/input0";
728
	input->dev.parent = &pdev->dev;
729 730
	input->open = gpio_keys_open;
	input->close = gpio_keys_close;
731 732 733 734 735 736

	input->id.bustype = BUS_HOST;
	input->id.vendor = 0x0001;
	input->id.product = 0x0001;
	input->id.version = 0x0100;

737 738 739 740
	/* Enable auto repeat feature of Linux input subsystem */
	if (pdata->rep)
		__set_bit(EV_REP, input->evbit);

741
	for (i = 0; i < pdata->nbuttons; i++) {
742
		const struct gpio_keys_button *button = &pdata->buttons[i];
743
		struct gpio_button_data *bdata = &ddata->data[i];
744

745
		error = gpio_keys_setup_key(pdev, input, bdata, button);
746
		if (error)
747
			return error;
748

749 750
		if (button->wakeup)
			wakeup = 1;
751 752
	}

753
	error = sysfs_create_group(&pdev->dev.kobj, &gpio_keys_attr_group);
754
	if (error) {
755 756
		dev_err(dev, "Unable to export keys/switches, error: %d\n",
			error);
757
		return error;
758 759
	}

760 761 762 763
	error = input_register_device(input);
	if (error) {
		dev_err(dev, "Unable to register input device, error: %d\n",
			error);
764
		goto err_remove_group;
765 766
	}

767 768
	device_init_wakeup(&pdev->dev, wakeup);

769 770
	return 0;

771
err_remove_group:
772
	sysfs_remove_group(&pdev->dev.kobj, &gpio_keys_attr_group);
773 774 775
	return error;
}

B
Bill Pemberton 已提交
776
static int gpio_keys_remove(struct platform_device *pdev)
777
{
778 779
	sysfs_remove_group(&pdev->dev.kobj, &gpio_keys_attr_group);

780 781
	device_init_wakeup(&pdev->dev, 0);

782 783 784
	return 0;
}

785
#ifdef CONFIG_PM_SLEEP
786
static int gpio_keys_suspend(struct device *dev)
787
{
788
	struct gpio_keys_drvdata *ddata = dev_get_drvdata(dev);
789
	struct input_dev *input = ddata->input;
790 791
	int i;

792
	if (device_may_wakeup(dev)) {
793
		for (i = 0; i < ddata->pdata->nbuttons; i++) {
794 795 796
			struct gpio_button_data *bdata = &ddata->data[i];
			if (bdata->button->wakeup)
				enable_irq_wake(bdata->irq);
797
		}
798 799 800 801 802
	} else {
		mutex_lock(&input->mutex);
		if (input->users)
			gpio_keys_close(input);
		mutex_unlock(&input->mutex);
803 804 805 806 807
	}

	return 0;
}

808
static int gpio_keys_resume(struct device *dev)
809
{
810
	struct gpio_keys_drvdata *ddata = dev_get_drvdata(dev);
811 812
	struct input_dev *input = ddata->input;
	int error = 0;
813 814
	int i;

815 816 817 818 819 820 821 822 823 824 825
	if (device_may_wakeup(dev)) {
		for (i = 0; i < ddata->pdata->nbuttons; i++) {
			struct gpio_button_data *bdata = &ddata->data[i];
			if (bdata->button->wakeup)
				disable_irq_wake(bdata->irq);
		}
	} else {
		mutex_lock(&input->mutex);
		if (input->users)
			error = gpio_keys_open(input);
		mutex_unlock(&input->mutex);
826
	}
827

828 829
	if (error)
		return error;
830

831
	gpio_keys_report_state(ddata);
832 833 834 835
	return 0;
}
#endif

836 837
static SIMPLE_DEV_PM_OPS(gpio_keys_pm_ops, gpio_keys_suspend, gpio_keys_resume);

838
static struct platform_driver gpio_keys_device_driver = {
839
	.probe		= gpio_keys_probe,
B
Bill Pemberton 已提交
840
	.remove		= gpio_keys_remove,
841 842
	.driver		= {
		.name	= "gpio-keys",
843
		.owner	= THIS_MODULE,
844
		.pm	= &gpio_keys_pm_ops,
845
		.of_match_table = of_match_ptr(gpio_keys_of_match),
846 847 848 849 850 851 852 853 854 855 856 857 858
	}
};

static int __init gpio_keys_init(void)
{
	return platform_driver_register(&gpio_keys_device_driver);
}

static void __exit gpio_keys_exit(void)
{
	platform_driver_unregister(&gpio_keys_device_driver);
}

859
late_initcall(gpio_keys_init);
860 861 862 863
module_exit(gpio_keys_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Phil Blundell <pb@handhelds.org>");
864
MODULE_DESCRIPTION("Keyboard driver for GPIOs");
865
MODULE_ALIAS("platform:gpio-keys");