[thirdparty/linux.git] / drivers / input / keyboard / matrix_keypad.c

/*
 *  GPIO driven matrix keyboard driver
 *
 *  Copyright (c) 2008 Marek Vasut <marek.vasut@gmail.com>
 *
 *  Based on corgikbd.c
 *
 *  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/types.h>
#include <linux/delay.h>
#include <linux/platform_device.h>
#include <linux/input.h>
#include <linux/irq.h>
#include <linux/interrupt.h>
#include <linux/jiffies.h>
#include <linux/module.h>
#include <linux/gpio.h>
#include <linux/input/matrix_keypad.h>
#include <linux/slab.h>
#include <linux/of.h>
#include <linux/of_gpio.h>
#include <linux/of_platform.h>

struct matrix_keypad {
	const struct matrix_keypad_platform_data *pdata;
	struct input_dev *input_dev;
	unsigned int row_shift;

	DECLARE_BITMAP(disabled_gpios, MATRIX_MAX_ROWS);

	uint32_t last_key_state[MATRIX_MAX_COLS];
	struct delayed_work work;
	spinlock_t lock;
	bool scan_pending;
	bool stopped;
	bool gpio_all_disabled;
};

/*
 * NOTE: If drive_inactive_cols is false, then the GPIO has to be put into
 * HiZ when de-activated to cause minmal side effect when scanning other
 * columns. In that case it is configured here to be input, otherwise it is
 * driven with the inactive value.
 */
static void __activate_col(const struct matrix_keypad_platform_data *pdata,
			   int col, bool on)
{
	bool level_on = !pdata->active_low;

	if (on) {
		gpio_direction_output(pdata->col_gpios[col], level_on);
	} else {
		gpio_set_value_cansleep(pdata->col_gpios[col], !level_on);
		if (!pdata->drive_inactive_cols)
			gpio_direction_input(pdata->col_gpios[col]);
	}
}

static void activate_col(const struct matrix_keypad_platform_data *pdata,
			 int col, bool on)
{
	__activate_col(pdata, col, on);

	if (on && pdata->col_scan_delay_us)
		udelay(pdata->col_scan_delay_us);
}

static void activate_all_cols(const struct matrix_keypad_platform_data *pdata,
			      bool on)
{
	int col;

	for (col = 0; col < pdata->num_col_gpios; col++)
		__activate_col(pdata, col, on);
}

static bool row_asserted(const struct matrix_keypad_platform_data *pdata,
			 int row)
{
	return gpio_get_value_cansleep(pdata->row_gpios[row]) ?
			!pdata->active_low : pdata->active_low;
}

static void enable_row_irqs(struct matrix_keypad *keypad)
{
	const struct matrix_keypad_platform_data *pdata = keypad->pdata;
	int i;

	if (pdata->clustered_irq > 0)
		enable_irq(pdata->clustered_irq);
	else {
		for (i = 0; i < pdata->num_row_gpios; i++)
			enable_irq(gpio_to_irq(pdata->row_gpios[i]));
	}
}

static void disable_row_irqs(struct matrix_keypad *keypad)
{
	const struct matrix_keypad_platform_data *pdata = keypad->pdata;
	int i;

	if (pdata->clustered_irq > 0)
		disable_irq_nosync(pdata->clustered_irq);
	else {
		for (i = 0; i < pdata->num_row_gpios; i++)
			disable_irq_nosync(gpio_to_irq(pdata->row_gpios[i]));
	}
}

/*
 * This gets the keys from keyboard and reports it to input subsystem
 */
static void matrix_keypad_scan(struct work_struct *work)
{
	struct matrix_keypad *keypad =
		container_of(work, struct matrix_keypad, work.work);
	struct input_dev *input_dev = keypad->input_dev;
	const unsigned short *keycodes = input_dev->keycode;
	const struct matrix_keypad_platform_data *pdata = keypad->pdata;
	uint32_t new_state[MATRIX_MAX_COLS];
	int row, col, code;

	/* de-activate all columns for scanning */
	activate_all_cols(pdata, false);

	memset(new_state, 0, sizeof(new_state));

	/* assert each column and read the row status out */
	for (col = 0; col < pdata->num_col_gpios; col++) {

		activate_col(pdata, col, true);

		for (row = 0; row < pdata->num_row_gpios; row++)
			new_state[col] |=
				row_asserted(pdata, row) ? (1 << row) : 0;

		activate_col(pdata, col, false);
	}

	for (col = 0; col < pdata->num_col_gpios; col++) {
		uint32_t bits_changed;

		bits_changed = keypad->last_key_state[col] ^ new_state[col];
		if (bits_changed == 0)
			continue;

		for (row = 0; row < pdata->num_row_gpios; row++) {
			if ((bits_changed & (1 << row)) == 0)
				continue;

			code = MATRIX_SCAN_CODE(row, col, keypad->row_shift);
			input_event(input_dev, EV_MSC, MSC_SCAN, code);
			input_report_key(input_dev,
					 keycodes[code],
					 new_state[col] & (1 << row));
		}
	}
	input_sync(input_dev);

	memcpy(keypad->last_key_state, new_state, sizeof(new_state));

	activate_all_cols(pdata, true);

	/* Enable IRQs again */
	spin_lock_irq(&keypad->lock);
	keypad->scan_pending = false;
	enable_row_irqs(keypad);
	spin_unlock_irq(&keypad->lock);
}

static irqreturn_t matrix_keypad_interrupt(int irq, void *id)
{
	struct matrix_keypad *keypad = id;
	unsigned long flags;

	spin_lock_irqsave(&keypad->lock, flags);

	/*
	 * See if another IRQ beaten us to it and scheduled the
	 * scan already. In that case we should not try to
	 * disable IRQs again.
	 */
	if (unlikely(keypad->scan_pending || keypad->stopped))
		goto out;

	disable_row_irqs(keypad);
	keypad->scan_pending = true;
	schedule_delayed_work(&keypad->work,
		msecs_to_jiffies(keypad->pdata->debounce_ms));

out:
	spin_unlock_irqrestore(&keypad->lock, flags);
	return IRQ_HANDLED;
}

static int matrix_keypad_start(struct input_dev *dev)
{
	struct matrix_keypad *keypad = input_get_drvdata(dev);

	keypad->stopped = false;
	mb();

	/*
	 * Schedule an immediate key scan to capture current key state;
	 * columns will be activated and IRQs be enabled after the scan.
	 */
	schedule_delayed_work(&keypad->work, 0);

	return 0;
}

static void matrix_keypad_stop(struct input_dev *dev)
{
	struct matrix_keypad *keypad = input_get_drvdata(dev);

	spin_lock_irq(&keypad->lock);
	keypad->stopped = true;
	spin_unlock_irq(&keypad->lock);

	flush_work(&keypad->work.work);
	/*
	 * matrix_keypad_scan() will leave IRQs enabled;
	 * we should disable them now.
	 */
	disable_row_irqs(keypad);
}

#ifdef CONFIG_PM_SLEEP
static void matrix_keypad_enable_wakeup(struct matrix_keypad *keypad)
{
	const struct matrix_keypad_platform_data *pdata = keypad->pdata;
	unsigned int gpio;
	int i;

	if (pdata->clustered_irq > 0) {
		if (enable_irq_wake(pdata->clustered_irq) == 0)
			keypad->gpio_all_disabled = true;
	} else {

		for (i = 0; i < pdata->num_row_gpios; i++) {
			if (!test_bit(i, keypad->disabled_gpios)) {
				gpio = pdata->row_gpios[i];

				if (enable_irq_wake(gpio_to_irq(gpio)) == 0)
					__set_bit(i, keypad->disabled_gpios);
			}
		}
	}
}

static void matrix_keypad_disable_wakeup(struct matrix_keypad *keypad)
{
	const struct matrix_keypad_platform_data *pdata = keypad->pdata;
	unsigned int gpio;
	int i;

	if (pdata->clustered_irq > 0) {
		if (keypad->gpio_all_disabled) {
			disable_irq_wake(pdata->clustered_irq);
			keypad->gpio_all_disabled = false;
		}
	} else {
		for (i = 0; i < pdata->num_row_gpios; i++) {
			if (test_and_clear_bit(i, keypad->disabled_gpios)) {
				gpio = pdata->row_gpios[i];
				disable_irq_wake(gpio_to_irq(gpio));
			}
		}
	}
}

static int matrix_keypad_suspend(struct device *dev)
{
	struct platform_device *pdev = to_platform_device(dev);
	struct matrix_keypad *keypad = platform_get_drvdata(pdev);

	matrix_keypad_stop(keypad->input_dev);

	if (device_may_wakeup(&pdev->dev))
		matrix_keypad_enable_wakeup(keypad);

	return 0;
}

static int matrix_keypad_resume(struct device *dev)
{
	struct platform_device *pdev = to_platform_device(dev);
	struct matrix_keypad *keypad = platform_get_drvdata(pdev);

	if (device_may_wakeup(&pdev->dev))
		matrix_keypad_disable_wakeup(keypad);

	matrix_keypad_start(keypad->input_dev);

	return 0;
}
#endif

static SIMPLE_DEV_PM_OPS(matrix_keypad_pm_ops,
			 matrix_keypad_suspend, matrix_keypad_resume);

static int matrix_keypad_init_gpio(struct platform_device *pdev,
				   struct matrix_keypad *keypad)
{
	const struct matrix_keypad_platform_data *pdata = keypad->pdata;
	int i, err;

	/* initialized strobe lines as outputs, activated */
	for (i = 0; i < pdata->num_col_gpios; i++) {
		err = gpio_request(pdata->col_gpios[i], "matrix_kbd_col");
		if (err) {
			dev_err(&pdev->dev,
				"failed to request GPIO%d for COL%d\n",
				pdata->col_gpios[i], i);
			goto err_free_cols;
		}

		gpio_direction_output(pdata->col_gpios[i], !pdata->active_low);
	}

	for (i = 0; i < pdata->num_row_gpios; i++) {
		err = gpio_request(pdata->row_gpios[i], "matrix_kbd_row");
		if (err) {
			dev_err(&pdev->dev,
				"failed to request GPIO%d for ROW%d\n",
				pdata->row_gpios[i], i);
			goto err_free_rows;
		}

		gpio_direction_input(pdata->row_gpios[i]);
	}

	if (pdata->clustered_irq > 0) {
		err = request_any_context_irq(pdata->clustered_irq,
				matrix_keypad_interrupt,
				pdata->clustered_irq_flags,
				"matrix-keypad", keypad);
		if (err < 0) {
			dev_err(&pdev->dev,
				"Unable to acquire clustered interrupt\n");
			goto err_free_rows;
		}
	} else {
		for (i = 0; i < pdata->num_row_gpios; i++) {
			err = request_any_context_irq(
					gpio_to_irq(pdata->row_gpios[i]),
					matrix_keypad_interrupt,
					IRQF_TRIGGER_RISING |
					IRQF_TRIGGER_FALLING,
					"matrix-keypad", keypad);
			if (err < 0) {
				dev_err(&pdev->dev,
					"Unable to acquire interrupt for GPIO line %i\n",
					pdata->row_gpios[i]);
				goto err_free_irqs;
			}
		}
	}

	/* initialized as disabled - enabled by input->open */
	disable_row_irqs(keypad);
	return 0;

err_free_irqs:
	while (--i >= 0)
		free_irq(gpio_to_irq(pdata->row_gpios[i]), keypad);
	i = pdata->num_row_gpios;
err_free_rows:
	while (--i >= 0)
		gpio_free(pdata->row_gpios[i]);
	i = pdata->num_col_gpios;
err_free_cols:
	while (--i >= 0)
		gpio_free(pdata->col_gpios[i]);

	return err;
}

static void matrix_keypad_free_gpio(struct matrix_keypad *keypad)
{
	const struct matrix_keypad_platform_data *pdata = keypad->pdata;
	int i;

	if (pdata->clustered_irq > 0) {
		free_irq(pdata->clustered_irq, keypad);
	} else {
		for (i = 0; i < pdata->num_row_gpios; i++)
			free_irq(gpio_to_irq(pdata->row_gpios[i]), keypad);
	}

	for (i = 0; i < pdata->num_row_gpios; i++)
		gpio_free(pdata->row_gpios[i]);

	for (i = 0; i < pdata->num_col_gpios; i++)
		gpio_free(pdata->col_gpios[i]);
}

#ifdef CONFIG_OF
static struct matrix_keypad_platform_data *
matrix_keypad_parse_dt(struct device *dev)
{
	struct matrix_keypad_platform_data *pdata;
	struct device_node *np = dev->of_node;
	unsigned int *gpios;
	int ret, i, nrow, ncol;

	if (!np) {
		dev_err(dev, "device lacks DT data\n");
		return ERR_PTR(-ENODEV);
	}

	pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
	if (!pdata) {
		dev_err(dev, "could not allocate memory for platform data\n");
		return ERR_PTR(-ENOMEM);
	}

	pdata->num_row_gpios = nrow = of_gpio_named_count(np, "row-gpios");
	pdata->num_col_gpios = ncol = of_gpio_named_count(np, "col-gpios");
	if (nrow <= 0 || ncol <= 0) {
		dev_err(dev, "number of keypad rows/columns not specified\n");
		return ERR_PTR(-EINVAL);
	}

	if (of_get_property(np, "linux,no-autorepeat", NULL))
		pdata->no_autorepeat = true;

	pdata->wakeup = of_property_read_bool(np, "wakeup-source") ||
			of_property_read_bool(np, "linux,wakeup"); /* legacy */

	if (of_get_property(np, "gpio-activelow", NULL))
		pdata->active_low = true;

	pdata->drive_inactive_cols =
		of_property_read_bool(np, "drive-inactive-cols");

	of_property_read_u32(np, "debounce-delay-ms", &pdata->debounce_ms);
	of_property_read_u32(np, "col-scan-delay-us",
						&pdata->col_scan_delay_us);

	gpios = devm_kcalloc(dev,
			     pdata->num_row_gpios + pdata->num_col_gpios,
			     sizeof(unsigned int),
			     GFP_KERNEL);
	if (!gpios) {
		dev_err(dev, "could not allocate memory for gpios\n");
		return ERR_PTR(-ENOMEM);
	}

	for (i = 0; i < nrow; i++) {
		ret = of_get_named_gpio(np, "row-gpios", i);
		if (ret < 0)
			return ERR_PTR(ret);
		gpios[i] = ret;
	}

	for (i = 0; i < ncol; i++) {
		ret = of_get_named_gpio(np, "col-gpios", i);
		if (ret < 0)
			return ERR_PTR(ret);
		gpios[nrow + i] = ret;
	}

	pdata->row_gpios = gpios;
	pdata->col_gpios = &gpios[pdata->num_row_gpios];

	return pdata;
}
#else
static inline struct matrix_keypad_platform_data *
matrix_keypad_parse_dt(struct device *dev)
{
	dev_err(dev, "no platform data defined\n");

	return ERR_PTR(-EINVAL);
}
#endif

static int matrix_keypad_probe(struct platform_device *pdev)
{
	const struct matrix_keypad_platform_data *pdata;
	struct matrix_keypad *keypad;
	struct input_dev *input_dev;
	int err;

	pdata = dev_get_platdata(&pdev->dev);
	if (!pdata) {
		pdata = matrix_keypad_parse_dt(&pdev->dev);
		if (IS_ERR(pdata))
			return PTR_ERR(pdata);
	} else if (!pdata->keymap_data) {
		dev_err(&pdev->dev, "no keymap data defined\n");
		return -EINVAL;
	}

	keypad = kzalloc(sizeof(struct matrix_keypad), GFP_KERNEL);
	input_dev = input_allocate_device();
	if (!keypad || !input_dev) {
		err = -ENOMEM;
		goto err_free_mem;
	}

	keypad->input_dev = input_dev;
	keypad->pdata = pdata;
	keypad->row_shift = get_count_order(pdata->num_col_gpios);
	keypad->stopped = true;
	INIT_DELAYED_WORK(&keypad->work, matrix_keypad_scan);
	spin_lock_init(&keypad->lock);

	input_dev->name		= pdev->name;
	input_dev->id.bustype	= BUS_HOST;
	input_dev->dev.parent	= &pdev->dev;
	input_dev->open		= matrix_keypad_start;
	input_dev->close	= matrix_keypad_stop;

	err = matrix_keypad_build_keymap(pdata->keymap_data, NULL,
					 pdata->num_row_gpios,
					 pdata->num_col_gpios,
					 NULL, input_dev);
	if (err) {
		dev_err(&pdev->dev, "failed to build keymap\n");
		goto err_free_mem;
	}

	if (!pdata->no_autorepeat)
		__set_bit(EV_REP, input_dev->evbit);
	input_set_capability(input_dev, EV_MSC, MSC_SCAN);
	input_set_drvdata(input_dev, keypad);

	err = matrix_keypad_init_gpio(pdev, keypad);
	if (err)
		goto err_free_mem;

	err = input_register_device(keypad->input_dev);
	if (err)
		goto err_free_gpio;

	device_init_wakeup(&pdev->dev, pdata->wakeup);
	platform_set_drvdata(pdev, keypad);

	return 0;

err_free_gpio:
	matrix_keypad_free_gpio(keypad);
err_free_mem:
	input_free_device(input_dev);
	kfree(keypad);
	return err;
}

static int matrix_keypad_remove(struct platform_device *pdev)
{
	struct matrix_keypad *keypad = platform_get_drvdata(pdev);

	matrix_keypad_free_gpio(keypad);
	input_unregister_device(keypad->input_dev);
	kfree(keypad);

	return 0;
}

#ifdef CONFIG_OF
static const struct of_device_id matrix_keypad_dt_match[] = {
	{ .compatible = "gpio-matrix-keypad" },
	{ }
};
MODULE_DEVICE_TABLE(of, matrix_keypad_dt_match);
#endif

static struct platform_driver matrix_keypad_driver = {
	.probe		= matrix_keypad_probe,
	.remove		= matrix_keypad_remove,
	.driver		= {
		.name	= "matrix-keypad",
		.pm	= &matrix_keypad_pm_ops,
		.of_match_table = of_match_ptr(matrix_keypad_dt_match),
	},
};
module_platform_driver(matrix_keypad_driver);

MODULE_AUTHOR("Marek Vasut <marek.vasut@gmail.com>");
MODULE_DESCRIPTION("GPIO Driven Matrix Keypad Driver");
MODULE_LICENSE("GPL v2");
MODULE_ALIAS("platform:matrix-keypad");
Commit	Line	Data
bab7614d EM	1	/*
	2	* GPIO driven matrix keyboard driver
	3	*
	4	* Copyright (c) 2008 Marek Vasut <marek.vasut@gmail.com>
	5	*
	6	* Based on corgikbd.c
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License version 2 as
	10	* published by the Free Software Foundation.
	11	*
	12	*/
	13
	14	#include <linux/types.h>
	15	#include <linux/delay.h>
	16	#include <linux/platform_device.h>
bab7614d EM	17	#include <linux/input.h>
	18	#include <linux/irq.h>
	19	#include <linux/interrupt.h>
	20	#include <linux/jiffies.h>
	21	#include <linux/module.h>
	22	#include <linux/gpio.h>
	23	#include <linux/input/matrix_keypad.h>
5a0e3ad6	24	#include <linux/slab.h>
4a83eecf AC	25	#include <linux/of.h>
	26	#include <linux/of_gpio.h>
	27	#include <linux/of_platform.h>
bab7614d EM	28
	29	struct matrix_keypad {
	30	const struct matrix_keypad_platform_data *pdata;
	31	struct input_dev *input_dev;
d82f1c35	32	unsigned int row_shift;
bab7614d	33
dd219234 DT	34	DECLARE_BITMAP(disabled_gpios, MATRIX_MAX_ROWS);
dd219234 DT	35
bab7614d EM	36	uint32_t last_key_state[MATRIX_MAX_COLS];
bab7614d EM	37	struct delayed_work work;
dd219234	38	spinlock_t lock;
bab7614d EM	39	bool scan_pending;
bab7614d EM	40	bool stopped;
fb76dd10	41	bool gpio_all_disabled;
bab7614d EM	42	};
	43
	44	/*
aa0e26bb DR	45	* NOTE: If drive_inactive_cols is false, then the GPIO has to be put into
	46	* HiZ when de-activated to cause minmal side effect when scanning other
	47	* columns. In that case it is configured here to be input, otherwise it is
	48	* driven with the inactive value.
bab7614d EM	49	*/
	50	static void __activate_col(const struct matrix_keypad_platform_data *pdata,
	51	int col, bool on)
	52	{
	53	bool level_on = !pdata->active_low;
	54
	55	if (on) {
	56	gpio_direction_output(pdata->col_gpios[col], level_on);
	57	} else {
	58	gpio_set_value_cansleep(pdata->col_gpios[col], !level_on);
aa0e26bb DR	59	if (!pdata->drive_inactive_cols)
aa0e26bb DR	60	gpio_direction_input(pdata->col_gpios[col]);
bab7614d EM	61	}
	62	}
	63
	64	static void activate_col(const struct matrix_keypad_platform_data *pdata,
	65	int col, bool on)
	66	{
	67	__activate_col(pdata, col, on);
	68
	69	if (on && pdata->col_scan_delay_us)
	70	udelay(pdata->col_scan_delay_us);
	71	}
	72
	73	static void activate_all_cols(const struct matrix_keypad_platform_data *pdata,
	74	bool on)
	75	{
	76	int col;
	77
	78	for (col = 0; col < pdata->num_col_gpios; col++)
	79	__activate_col(pdata, col, on);
	80	}
	81
	82	static bool row_asserted(const struct matrix_keypad_platform_data *pdata,
	83	int row)
	84	{
	85	return gpio_get_value_cansleep(pdata->row_gpios[row]) ?
	86	!pdata->active_low : pdata->active_low;
	87	}
	88
	89	static void enable_row_irqs(struct matrix_keypad *keypad)
	90	{
	91	const struct matrix_keypad_platform_data *pdata = keypad->pdata;
	92	int i;
	93
fb76dd10 LF	94	if (pdata->clustered_irq > 0)
	95	enable_irq(pdata->clustered_irq);
	96	else {
	97	for (i = 0; i < pdata->num_row_gpios; i++)
	98	enable_irq(gpio_to_irq(pdata->row_gpios[i]));
	99	}
bab7614d EM	100	}
	101
	102	static void disable_row_irqs(struct matrix_keypad *keypad)
	103	{
	104	const struct matrix_keypad_platform_data *pdata = keypad->pdata;
	105	int i;
	106
fb76dd10 LF	107	if (pdata->clustered_irq > 0)
	108	disable_irq_nosync(pdata->clustered_irq);
	109	else {
	110	for (i = 0; i < pdata->num_row_gpios; i++)
	111	disable_irq_nosync(gpio_to_irq(pdata->row_gpios[i]));
	112	}
bab7614d EM	113	}
	114
	115	/*
	116	* This gets the keys from keyboard and reports it to input subsystem
	117	*/
	118	static void matrix_keypad_scan(struct work_struct *work)
	119	{
	120	struct matrix_keypad *keypad =
	121	container_of(work, struct matrix_keypad, work.work);
	122	struct input_dev *input_dev = keypad->input_dev;
4a83eecf	123	const unsigned short *keycodes = input_dev->keycode;
bab7614d EM	124	const struct matrix_keypad_platform_data *pdata = keypad->pdata;
	125	uint32_t new_state[MATRIX_MAX_COLS];
	126	int row, col, code;
	127
	128	/* de-activate all columns for scanning */
	129	activate_all_cols(pdata, false);
	130
	131	memset(new_state, 0, sizeof(new_state));
	132
	133	/* assert each column and read the row status out */
	134	for (col = 0; col < pdata->num_col_gpios; col++) {
	135
	136	activate_col(pdata, col, true);
	137
	138	for (row = 0; row < pdata->num_row_gpios; row++)
	139	new_state[col] \|=
	140	row_asserted(pdata, row) ? (1 << row) : 0;
	141
	142	activate_col(pdata, col, false);
	143	}
	144
	145	for (col = 0; col < pdata->num_col_gpios; col++) {
	146	uint32_t bits_changed;
	147
	148	bits_changed = keypad->last_key_state[col] ^ new_state[col];
	149	if (bits_changed == 0)
	150	continue;
	151
	152	for (row = 0; row < pdata->num_row_gpios; row++) {
	153	if ((bits_changed & (1 << row)) == 0)
	154	continue;
	155
d82f1c35	156	code = MATRIX_SCAN_CODE(row, col, keypad->row_shift);
bab7614d EM	157	input_event(input_dev, EV_MSC, MSC_SCAN, code);
bab7614d EM	158	input_report_key(input_dev,
4a83eecf	159	keycodes[code],
bab7614d EM	160	new_state[col] & (1 << row));
	161	}
	162	}
	163	input_sync(input_dev);
	164
	165	memcpy(keypad->last_key_state, new_state, sizeof(new_state));
	166
	167	activate_all_cols(pdata, true);
	168
	169	/* Enable IRQs again */
	170	spin_lock_irq(&keypad->lock);
	171	keypad->scan_pending = false;
	172	enable_row_irqs(keypad);
	173	spin_unlock_irq(&keypad->lock);
	174	}
	175
	176	static irqreturn_t matrix_keypad_interrupt(int irq, void *id)
	177	{
	178	struct matrix_keypad *keypad = id;
	179	unsigned long flags;
	180
	181	spin_lock_irqsave(&keypad->lock, flags);
	182
	183	/*
	184	* See if another IRQ beaten us to it and scheduled the
	185	* scan already. In that case we should not try to
	186	* disable IRQs again.
	187	*/
	188	if (unlikely(keypad->scan_pending \|\| keypad->stopped))
	189	goto out;
	190
	191	disable_row_irqs(keypad);
	192	keypad->scan_pending = true;
	193	schedule_delayed_work(&keypad->work,
	194	msecs_to_jiffies(keypad->pdata->debounce_ms));
	195
	196	out:
	197	spin_unlock_irqrestore(&keypad->lock, flags);
	198	return IRQ_HANDLED;
	199	}
	200
	201	static int matrix_keypad_start(struct input_dev *dev)
	202	{
	203	struct matrix_keypad *keypad = input_get_drvdata(dev);
	204
	205	keypad->stopped = false;
	206	mb();
	207
	208	/*
	209	* Schedule an immediate key scan to capture current key state;
	210	* columns will be activated and IRQs be enabled after the scan.
	211	*/
	212	schedule_delayed_work(&keypad->work, 0);
	213
	214	return 0;
	215	}
	216
	217	static void matrix_keypad_stop(struct input_dev *dev)
	218	{
	219	struct matrix_keypad *keypad = input_get_drvdata(dev);
	220
ea4f7bd2	221	spin_lock_irq(&keypad->lock);
bab7614d	222	keypad->stopped = true;
ea4f7bd2 ZB	223	spin_unlock_irq(&keypad->lock);
ea4f7bd2 ZB	224
bab7614d EM	225	flush_work(&keypad->work.work);
	226	/*
	227	* matrix_keypad_scan() will leave IRQs enabled;
	228	* we should disable them now.
	229	*/
	230	disable_row_irqs(keypad);
	231	}
	232
0508c19a	233	#ifdef CONFIG_PM_SLEEP
fb76dd10	234	static void matrix_keypad_enable_wakeup(struct matrix_keypad *keypad)
bab7614d	235	{
bab7614d	236	const struct matrix_keypad_platform_data *pdata = keypad->pdata;
fb76dd10	237	unsigned int gpio;
bab7614d EM	238	int i;
bab7614d EM	239
fb76dd10 LF	240	if (pdata->clustered_irq > 0) {
	241	if (enable_irq_wake(pdata->clustered_irq) == 0)
	242	keypad->gpio_all_disabled = true;
	243	} else {
bab7614d	244
dd219234 DT	245	for (i = 0; i < pdata->num_row_gpios; i++) {
dd219234 DT	246	if (!test_bit(i, keypad->disabled_gpios)) {
fb76dd10	247	gpio = pdata->row_gpios[i];
dd219234 DT	248
	249	if (enable_irq_wake(gpio_to_irq(gpio)) == 0)
	250	__set_bit(i, keypad->disabled_gpios);
	251	}
	252	}
	253	}
bab7614d EM	254	}
bab7614d EM	255
fb76dd10	256	static void matrix_keypad_disable_wakeup(struct matrix_keypad *keypad)
bab7614d	257	{
bab7614d	258	const struct matrix_keypad_platform_data *pdata = keypad->pdata;
fb76dd10	259	unsigned int gpio;
bab7614d EM	260	int i;
bab7614d EM	261
fb76dd10 LF	262	if (pdata->clustered_irq > 0) {
	263	if (keypad->gpio_all_disabled) {
	264	disable_irq_wake(pdata->clustered_irq);
	265	keypad->gpio_all_disabled = false;
	266	}
	267	} else {
dd219234 DT	268	for (i = 0; i < pdata->num_row_gpios; i++) {
dd219234 DT	269	if (test_and_clear_bit(i, keypad->disabled_gpios)) {
fb76dd10	270	gpio = pdata->row_gpios[i];
dd219234 DT	271	disable_irq_wake(gpio_to_irq(gpio));
	272	}
	273	}
	274	}
fb76dd10 LF	275	}
	276
	277	static int matrix_keypad_suspend(struct device *dev)
	278	{
	279	struct platform_device *pdev = to_platform_device(dev);
	280	struct matrix_keypad *keypad = platform_get_drvdata(pdev);
	281
	282	matrix_keypad_stop(keypad->input_dev);
	283
	284	if (device_may_wakeup(&pdev->dev))
	285	matrix_keypad_enable_wakeup(keypad);
	286
	287	return 0;
	288	}
	289
	290	static int matrix_keypad_resume(struct device *dev)
	291	{
	292	struct platform_device *pdev = to_platform_device(dev);
	293	struct matrix_keypad *keypad = platform_get_drvdata(pdev);
	294
	295	if (device_may_wakeup(&pdev->dev))
	296	matrix_keypad_disable_wakeup(keypad);
bab7614d EM	297
	298	matrix_keypad_start(keypad->input_dev);
	299
	300	return 0;
	301	}
bab7614d EM	302	#endif
bab7614d EM	303
0508c19a DT	304	static SIMPLE_DEV_PM_OPS(matrix_keypad_pm_ops,
	305	matrix_keypad_suspend, matrix_keypad_resume);
	306
5298cc4c BP	307	static int matrix_keypad_init_gpio(struct platform_device *pdev,
5298cc4c BP	308	struct matrix_keypad *keypad)
bab7614d EM	309	{
bab7614d EM	310	const struct matrix_keypad_platform_data *pdata = keypad->pdata;
b83643eb	311	int i, err;
bab7614d EM	312
	313	/* initialized strobe lines as outputs, activated */
	314	for (i = 0; i < pdata->num_col_gpios; i++) {
	315	err = gpio_request(pdata->col_gpios[i], "matrix_kbd_col");
	316	if (err) {
	317	dev_err(&pdev->dev,
	318	"failed to request GPIO%d for COL%d\n",
	319	pdata->col_gpios[i], i);
	320	goto err_free_cols;
	321	}
	322
	323	gpio_direction_output(pdata->col_gpios[i], !pdata->active_low);
	324	}
	325
	326	for (i = 0; i < pdata->num_row_gpios; i++) {
	327	err = gpio_request(pdata->row_gpios[i], "matrix_kbd_row");
	328	if (err) {
	329	dev_err(&pdev->dev,
	330	"failed to request GPIO%d for ROW%d\n",
	331	pdata->row_gpios[i], i);
	332	goto err_free_rows;
	333	}
	334
	335	gpio_direction_input(pdata->row_gpios[i]);
	336	}
	337
fb76dd10	338	if (pdata->clustered_irq > 0) {
24e4d21c	339	err = request_any_context_irq(pdata->clustered_irq,
bab7614d	340	matrix_keypad_interrupt,
fb76dd10	341	pdata->clustered_irq_flags,
bab7614d	342	"matrix-keypad", keypad);
24e4d21c	343	if (err < 0) {
bab7614d	344	dev_err(&pdev->dev,
fb76dd10 LF	345	"Unable to acquire clustered interrupt\n");
	346	goto err_free_rows;
	347	}
	348	} else {
	349	for (i = 0; i < pdata->num_row_gpios; i++) {
24e4d21c LW	350	err = request_any_context_irq(
24e4d21c LW	351	gpio_to_irq(pdata->row_gpios[i]),
fb76dd10	352	matrix_keypad_interrupt,
fb76dd10 LF	353	IRQF_TRIGGER_RISING \|
	354	IRQF_TRIGGER_FALLING,
	355	"matrix-keypad", keypad);
24e4d21c	356	if (err < 0) {
fb76dd10	357	dev_err(&pdev->dev,
b83643eb	358	"Unable to acquire interrupt for GPIO line %i\n",
fb76dd10 LF	359	pdata->row_gpios[i]);
	360	goto err_free_irqs;
	361	}
bab7614d EM	362	}
	363	}
	364
	365	/* initialized as disabled - enabled by input->open */
	366	disable_row_irqs(keypad);
	367	return 0;
	368
	369	err_free_irqs:
	370	while (--i >= 0)
	371	free_irq(gpio_to_irq(pdata->row_gpios[i]), keypad);
	372	i = pdata->num_row_gpios;
	373	err_free_rows:
	374	while (--i >= 0)
	375	gpio_free(pdata->row_gpios[i]);
	376	i = pdata->num_col_gpios;
	377	err_free_cols:
	378	while (--i >= 0)
	379	gpio_free(pdata->col_gpios[i]);
	380
	381	return err;
	382	}
	383
b83643eb DT	384	static void matrix_keypad_free_gpio(struct matrix_keypad *keypad)
	385	{
	386	const struct matrix_keypad_platform_data *pdata = keypad->pdata;
	387	int i;
	388
	389	if (pdata->clustered_irq > 0) {
	390	free_irq(pdata->clustered_irq, keypad);
	391	} else {
	392	for (i = 0; i < pdata->num_row_gpios; i++)
	393	free_irq(gpio_to_irq(pdata->row_gpios[i]), keypad);
	394	}
	395
	396	for (i = 0; i < pdata->num_row_gpios; i++)
	397	gpio_free(pdata->row_gpios[i]);
	398
	399	for (i = 0; i < pdata->num_col_gpios; i++)
	400	gpio_free(pdata->col_gpios[i]);
	401	}
	402
4a83eecf	403	#ifdef CONFIG_OF
5298cc4c	404	static struct matrix_keypad_platform_data *
4a83eecf AC	405	matrix_keypad_parse_dt(struct device *dev)
	406	{
	407	struct matrix_keypad_platform_data *pdata;
	408	struct device_node *np = dev->of_node;
	409	unsigned int *gpios;
d55bda1b	410	int ret, i, nrow, ncol;
4a83eecf AC	411
	412	if (!np) {
	413	dev_err(dev, "device lacks DT data\n");
	414	return ERR_PTR(-ENODEV);
	415	}
	416
	417	pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
	418	if (!pdata) {
	419	dev_err(dev, "could not allocate memory for platform data\n");
	420	return ERR_PTR(-ENOMEM);
	421	}
	422
e80beb27 GL	423	pdata->num_row_gpios = nrow = of_gpio_named_count(np, "row-gpios");
	424	pdata->num_col_gpios = ncol = of_gpio_named_count(np, "col-gpios");
	425	if (nrow <= 0 \|\| ncol <= 0) {
4a83eecf AC	426	dev_err(dev, "number of keypad rows/columns not specified\n");
	427	return ERR_PTR(-EINVAL);
	428	}
	429
	430	if (of_get_property(np, "linux,no-autorepeat", NULL))
	431	pdata->no_autorepeat = true;
aeda5003 DT	432
	433	pdata->wakeup = of_property_read_bool(np, "wakeup-source") \|\|
	434	of_property_read_bool(np, "linux,wakeup"); /* legacy */
	435
4a83eecf AC	436	if (of_get_property(np, "gpio-activelow", NULL))
	437	pdata->active_low = true;
	438
aa0e26bb DR	439	pdata->drive_inactive_cols =
	440	of_property_read_bool(np, "drive-inactive-cols");
	441
4a83eecf AC	442	of_property_read_u32(np, "debounce-delay-ms", &pdata->debounce_ms);
	443	of_property_read_u32(np, "col-scan-delay-us",
	444	&pdata->col_scan_delay_us);
	445
a86854d0 KC	446	gpios = devm_kcalloc(dev,
	447	pdata->num_row_gpios + pdata->num_col_gpios,
	448	sizeof(unsigned int),
4a83eecf AC	449	GFP_KERNEL);
	450	if (!gpios) {
	451	dev_err(dev, "could not allocate memory for gpios\n");
	452	return ERR_PTR(-ENOMEM);
	453	}
	454
d55bda1b CH	455	for (i = 0; i < nrow; i++) {
	456	ret = of_get_named_gpio(np, "row-gpios", i);
	457	if (ret < 0)
	458	return ERR_PTR(ret);
	459	gpios[i] = ret;
	460	}
4a83eecf	461
d55bda1b CH	462	for (i = 0; i < ncol; i++) {
	463	ret = of_get_named_gpio(np, "col-gpios", i);
	464	if (ret < 0)
	465	return ERR_PTR(ret);
	466	gpios[nrow + i] = ret;
	467	}
4a83eecf AC	468
	469	pdata->row_gpios = gpios;
	470	pdata->col_gpios = &gpios[pdata->num_row_gpios];
	471
	472	return pdata;
	473	}
	474	#else
	475	static inline struct matrix_keypad_platform_data *
	476	matrix_keypad_parse_dt(struct device *dev)
	477	{
	478	dev_err(dev, "no platform data defined\n");
	479
	480	return ERR_PTR(-EINVAL);
	481	}
	482	#endif
	483
5298cc4c	484	static int matrix_keypad_probe(struct platform_device *pdev)
bab7614d EM	485	{
bab7614d EM	486	const struct matrix_keypad_platform_data *pdata;
bab7614d EM	487	struct matrix_keypad *keypad;
bab7614d EM	488	struct input_dev *input_dev;
bab7614d EM	489	int err;
bab7614d EM	490
4a83eecf	491	pdata = dev_get_platdata(&pdev->dev);
bab7614d	492	if (!pdata) {
4a83eecf	493	pdata = matrix_keypad_parse_dt(&pdev->dev);
d55bda1b	494	if (IS_ERR(pdata))
4a83eecf	495	return PTR_ERR(pdata);
4a83eecf	496	} else if (!pdata->keymap_data) {
bab7614d EM	497	dev_err(&pdev->dev, "no keymap data defined\n");
	498	return -EINVAL;
	499	}
	500
4a83eecf	501	keypad = kzalloc(sizeof(struct matrix_keypad), GFP_KERNEL);
bab7614d	502	input_dev = input_allocate_device();
01111fcd	503	if (!keypad \|\| !input_dev) {
bab7614d EM	504	err = -ENOMEM;
	505	goto err_free_mem;
	506	}
	507
	508	keypad->input_dev = input_dev;
	509	keypad->pdata = pdata;
4a83eecf	510	keypad->row_shift = get_count_order(pdata->num_col_gpios);
bab7614d EM	511	keypad->stopped = true;
	512	INIT_DELAYED_WORK(&keypad->work, matrix_keypad_scan);
	513	spin_lock_init(&keypad->lock);
	514
	515	input_dev->name = pdev->name;
	516	input_dev->id.bustype = BUS_HOST;
	517	input_dev->dev.parent = &pdev->dev;
bab7614d EM	518	input_dev->open = matrix_keypad_start;
	519	input_dev->close = matrix_keypad_stop;
	520
4a83eecf	521	err = matrix_keypad_build_keymap(pdata->keymap_data, NULL,
1932811f DT	522	pdata->num_row_gpios,
1932811f DT	523	pdata->num_col_gpios,
4a83eecf AC	524	NULL, input_dev);
	525	if (err) {
	526	dev_err(&pdev->dev, "failed to build keymap\n");
1932811f	527	goto err_free_mem;
4a83eecf	528	}
bab7614d	529
1932811f DT	530	if (!pdata->no_autorepeat)
1932811f DT	531	__set_bit(EV_REP, input_dev->evbit);
bab7614d EM	532	input_set_capability(input_dev, EV_MSC, MSC_SCAN);
	533	input_set_drvdata(input_dev, keypad);
	534
b83643eb	535	err = matrix_keypad_init_gpio(pdev, keypad);
bab7614d EM	536	if (err)
	537	goto err_free_mem;
	538
	539	err = input_register_device(keypad->input_dev);
	540	if (err)
b83643eb	541	goto err_free_gpio;
bab7614d EM	542
	543	device_init_wakeup(&pdev->dev, pdata->wakeup);
	544	platform_set_drvdata(pdev, keypad);
	545
	546	return 0;
	547
b83643eb DT	548	err_free_gpio:
b83643eb DT	549	matrix_keypad_free_gpio(keypad);
bab7614d EM	550	err_free_mem:
bab7614d EM	551	input_free_device(input_dev);
bab7614d EM	552	kfree(keypad);
	553	return err;
	554	}
	555
e2619cf7	556	static int matrix_keypad_remove(struct platform_device *pdev)
bab7614d EM	557	{
bab7614d EM	558	struct matrix_keypad *keypad = platform_get_drvdata(pdev);
bab7614d	559
b83643eb	560	matrix_keypad_free_gpio(keypad);
bab7614d	561	input_unregister_device(keypad->input_dev);
bab7614d EM	562	kfree(keypad);
	563
	564	return 0;
	565	}
	566
4a83eecf AC	567	#ifdef CONFIG_OF
	568	static const struct of_device_id matrix_keypad_dt_match[] = {
	569	{ .compatible = "gpio-matrix-keypad" },
	570	{ }
	571	};
	572	MODULE_DEVICE_TABLE(of, matrix_keypad_dt_match);
	573	#endif
	574
bab7614d EM	575	static struct platform_driver matrix_keypad_driver = {
bab7614d EM	576	.probe = matrix_keypad_probe,
1cb0aa88	577	.remove = matrix_keypad_remove,
bab7614d EM	578	.driver = {
bab7614d EM	579	.name = "matrix-keypad",
f72a28ab	580	.pm = &matrix_keypad_pm_ops,
4a83eecf	581	.of_match_table = of_match_ptr(matrix_keypad_dt_match),
bab7614d EM	582	},
bab7614d EM	583	};
5146c84f	584	module_platform_driver(matrix_keypad_driver);
bab7614d EM	585
	586	MODULE_AUTHOR("Marek Vasut <marek.vasut@gmail.com>");
	587	MODULE_DESCRIPTION("GPIO Driven Matrix Keypad Driver");
	588	MODULE_LICENSE("GPL v2");
	589	MODULE_ALIAS("platform:matrix-keypad");