[linux-block.git] / drivers / input / keyboard / matrix_keypad.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 *  GPIO driven matrix keyboard driver
 *
 *  Copyright (c) 2008 Marek Vasut <marek.vasut@gmail.com>
 *
 *  Based on corgikbd.c
 */

#include <linux/types.h>
#include <linux/delay.h>
#include <linux/gpio/consumer.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));

	for (row = 0; row < pdata->num_row_gpios; row++)
		gpio_direction_input(pdata->row_gpios[row]);

	/* 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_delayed_work(&keypad->work);
	/*
	 * matrix_keypad_scan() will leave IRQs enabled;
	 * we should disable them now.
	 */
	disable_row_irqs(keypad);
}

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;
}

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