[linux-2.6-block.git] / drivers / input / keyboard / samsung-keypad.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Samsung keypad driver
 *
 * Copyright (C) 2010 Samsung Electronics Co.Ltd
 * Author: Joonyoung Shim <jy0922.shim@samsung.com>
 * Author: Donghwa Lee <dh09.lee@samsung.com>
 */

#include <linux/clk.h>
#include <linux/delay.h>
#include <linux/err.h>
#include <linux/input.h>
#include <linux/interrupt.h>
#include <linux/io.h>
#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/pm.h>
#include <linux/pm_runtime.h>
#include <linux/slab.h>
#include <linux/of.h>
#include <linux/sched.h>
#include <linux/input/samsung-keypad.h>

#define SAMSUNG_KEYIFCON			0x00
#define SAMSUNG_KEYIFSTSCLR			0x04
#define SAMSUNG_KEYIFCOL			0x08
#define SAMSUNG_KEYIFROW			0x0c
#define SAMSUNG_KEYIFFC				0x10

/* SAMSUNG_KEYIFCON */
#define SAMSUNG_KEYIFCON_INT_F_EN		(1 << 0)
#define SAMSUNG_KEYIFCON_INT_R_EN		(1 << 1)
#define SAMSUNG_KEYIFCON_DF_EN			(1 << 2)
#define SAMSUNG_KEYIFCON_FC_EN			(1 << 3)
#define SAMSUNG_KEYIFCON_WAKEUPEN		(1 << 4)

/* SAMSUNG_KEYIFSTSCLR */
#define SAMSUNG_KEYIFSTSCLR_P_INT_MASK		(0xff << 0)
#define SAMSUNG_KEYIFSTSCLR_R_INT_MASK		(0xff << 8)
#define SAMSUNG_KEYIFSTSCLR_R_INT_OFFSET	8
#define S5PV210_KEYIFSTSCLR_P_INT_MASK		(0x3fff << 0)
#define S5PV210_KEYIFSTSCLR_R_INT_MASK		(0x3fff << 16)
#define S5PV210_KEYIFSTSCLR_R_INT_OFFSET	16

/* SAMSUNG_KEYIFCOL */
#define SAMSUNG_KEYIFCOL_MASK			(0xff << 0)
#define S5PV210_KEYIFCOLEN_MASK			(0xff << 8)

/* SAMSUNG_KEYIFROW */
#define SAMSUNG_KEYIFROW_MASK			(0xff << 0)
#define S5PV210_KEYIFROW_MASK			(0x3fff << 0)

/* SAMSUNG_KEYIFFC */
#define SAMSUNG_KEYIFFC_MASK			(0x3ff << 0)

enum samsung_keypad_type {
	KEYPAD_TYPE_SAMSUNG,
	KEYPAD_TYPE_S5PV210,
};

struct samsung_keypad {
	struct input_dev *input_dev;
	struct platform_device *pdev;
	struct clk *clk;
	void __iomem *base;
	wait_queue_head_t wait;
	bool stopped;
	bool wake_enabled;
	int irq;
	enum samsung_keypad_type type;
	unsigned int row_shift;
	unsigned int rows;
	unsigned int cols;
	unsigned int row_state[SAMSUNG_MAX_COLS];
	unsigned short keycodes[];
};

static void samsung_keypad_scan(struct samsung_keypad *keypad,
				unsigned int *row_state)
{
	unsigned int col;
	unsigned int val;

	for (col = 0; col < keypad->cols; col++) {
		if (keypad->type == KEYPAD_TYPE_S5PV210) {
			val = S5PV210_KEYIFCOLEN_MASK;
			val &= ~(1 << col) << 8;
		} else {
			val = SAMSUNG_KEYIFCOL_MASK;
			val &= ~(1 << col);
		}

		writel(val, keypad->base + SAMSUNG_KEYIFCOL);
		mdelay(1);

		val = readl(keypad->base + SAMSUNG_KEYIFROW);
		row_state[col] = ~val & ((1 << keypad->rows) - 1);
	}

	/* KEYIFCOL reg clear */
	writel(0, keypad->base + SAMSUNG_KEYIFCOL);
}

static bool samsung_keypad_report(struct samsung_keypad *keypad,
				  unsigned int *row_state)
{
	struct input_dev *input_dev = keypad->input_dev;
	unsigned int changed;
	unsigned int pressed;
	unsigned int key_down = 0;
	unsigned int val;
	unsigned int col, row;

	for (col = 0; col < keypad->cols; col++) {
		changed = row_state[col] ^ keypad->row_state[col];
		key_down |= row_state[col];
		if (!changed)
			continue;

		for (row = 0; row < keypad->rows; row++) {
			if (!(changed & (1 << row)))
				continue;

			pressed = row_state[col] & (1 << row);

			dev_dbg(&keypad->input_dev->dev,
				"key %s, row: %d, col: %d\n",
				pressed ? "pressed" : "released", row, col);

			val = MATRIX_SCAN_CODE(row, col, keypad->row_shift);

			input_event(input_dev, EV_MSC, MSC_SCAN, val);
			input_report_key(input_dev,
					keypad->keycodes[val], pressed);
		}
		input_sync(keypad->input_dev);
	}

	memcpy(keypad->row_state, row_state, sizeof(keypad->row_state));

	return key_down;
}

static irqreturn_t samsung_keypad_irq(int irq, void *dev_id)
{
	struct samsung_keypad *keypad = dev_id;
	unsigned int row_state[SAMSUNG_MAX_COLS];
	bool key_down;

	pm_runtime_get_sync(&keypad->pdev->dev);

	do {
		readl(keypad->base + SAMSUNG_KEYIFSTSCLR);
		/* Clear interrupt. */
		writel(~0x0, keypad->base + SAMSUNG_KEYIFSTSCLR);

		samsung_keypad_scan(keypad, row_state);

		key_down = samsung_keypad_report(keypad, row_state);
		if (key_down)
			wait_event_timeout(keypad->wait, keypad->stopped,
					   msecs_to_jiffies(50));

	} while (key_down && !keypad->stopped);

	pm_runtime_put(&keypad->pdev->dev);

	return IRQ_HANDLED;
}

static void samsung_keypad_start(struct samsung_keypad *keypad)
{
	unsigned int val;

	pm_runtime_get_sync(&keypad->pdev->dev);

	/* Tell IRQ thread that it may poll the device. */
	keypad->stopped = false;

	clk_enable(keypad->clk);

	/* Enable interrupt bits. */
	val = readl(keypad->base + SAMSUNG_KEYIFCON);
	val |= SAMSUNG_KEYIFCON_INT_F_EN | SAMSUNG_KEYIFCON_INT_R_EN;
	writel(val, keypad->base + SAMSUNG_KEYIFCON);

	/* KEYIFCOL reg clear. */
	writel(0, keypad->base + SAMSUNG_KEYIFCOL);

	pm_runtime_put(&keypad->pdev->dev);
}

static void samsung_keypad_stop(struct samsung_keypad *keypad)
{
	unsigned int val;

	pm_runtime_get_sync(&keypad->pdev->dev);

	/* Signal IRQ thread to stop polling and disable the handler. */
	keypad->stopped = true;
	wake_up(&keypad->wait);
	disable_irq(keypad->irq);

	/* Clear interrupt. */
	writel(~0x0, keypad->base + SAMSUNG_KEYIFSTSCLR);

	/* Disable interrupt bits. */
	val = readl(keypad->base + SAMSUNG_KEYIFCON);
	val &= ~(SAMSUNG_KEYIFCON_INT_F_EN | SAMSUNG_KEYIFCON_INT_R_EN);
	writel(val, keypad->base + SAMSUNG_KEYIFCON);

	clk_disable(keypad->clk);

	/*
	 * Now that chip should not generate interrupts we can safely
	 * re-enable the handler.
	 */
	enable_irq(keypad->irq);

	pm_runtime_put(&keypad->pdev->dev);
}

static int samsung_keypad_open(struct input_dev *input_dev)
{
	struct samsung_keypad *keypad = input_get_drvdata(input_dev);

	samsung_keypad_start(keypad);

	return 0;
}

static void samsung_keypad_close(struct input_dev *input_dev)
{
	struct samsung_keypad *keypad = input_get_drvdata(input_dev);

	samsung_keypad_stop(keypad);
}

#ifdef CONFIG_OF
static struct samsung_keypad_platdata *
samsung_keypad_parse_dt(struct device *dev)
{
	struct samsung_keypad_platdata *pdata;
	struct matrix_keymap_data *keymap_data;
	uint32_t *keymap, num_rows = 0, num_cols = 0;
	struct device_node *np = dev->of_node, *key_np;
	unsigned int key_count;

	if (!np) {
		dev_err(dev, "missing device tree data\n");
		return ERR_PTR(-EINVAL);
	}

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

	of_property_read_u32(np, "samsung,keypad-num-rows", &num_rows);
	of_property_read_u32(np, "samsung,keypad-num-columns", &num_cols);
	if (!num_rows || !num_cols) {
		dev_err(dev, "number of keypad rows/columns not specified\n");
		return ERR_PTR(-EINVAL);
	}
	pdata->rows = num_rows;
	pdata->cols = num_cols;

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

	key_count = of_get_child_count(np);
	keymap_data->keymap_size = key_count;
	keymap = devm_kcalloc(dev, key_count, sizeof(uint32_t), GFP_KERNEL);
	if (!keymap) {
		dev_err(dev, "could not allocate memory for keymap\n");
		return ERR_PTR(-ENOMEM);
	}
	keymap_data->keymap = keymap;

	for_each_child_of_node(np, key_np) {
		u32 row, col, key_code;
		of_property_read_u32(key_np, "keypad,row", &row);
		of_property_read_u32(key_np, "keypad,column", &col);
		of_property_read_u32(key_np, "linux,code", &key_code);
		*keymap++ = KEY(row, col, key_code);
	}

	pdata->no_autorepeat = of_property_read_bool(np, "linux,input-no-autorepeat");

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


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

	return ERR_PTR(-EINVAL);
}
#endif

static int samsung_keypad_probe(struct platform_device *pdev)
{
	const struct samsung_keypad_platdata *pdata;
	const struct matrix_keymap_data *keymap_data;
	struct samsung_keypad *keypad;
	struct resource *res;
	struct input_dev *input_dev;
	unsigned int row_shift;
	unsigned int keymap_size;
	int error;

	pdata = dev_get_platdata(&pdev->dev);
	if (!pdata) {
		pdata = samsung_keypad_parse_dt(&pdev->dev);
		if (IS_ERR(pdata))
			return PTR_ERR(pdata);
	}

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

	if (!pdata->rows || pdata->rows > SAMSUNG_MAX_ROWS)
		return -EINVAL;

	if (!pdata->cols || pdata->cols > SAMSUNG_MAX_COLS)
		return -EINVAL;

	/* initialize the gpio */
	if (pdata->cfg_gpio)
		pdata->cfg_gpio(pdata->rows, pdata->cols);

	row_shift = get_count_order(pdata->cols);
	keymap_size = (pdata->rows << row_shift) * sizeof(keypad->keycodes[0]);

	keypad = devm_kzalloc(&pdev->dev, sizeof(*keypad) + keymap_size,
			      GFP_KERNEL);
	input_dev = devm_input_allocate_device(&pdev->dev);
	if (!keypad || !input_dev)
		return -ENOMEM;

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	if (!res)
		return -ENODEV;

	keypad->base = devm_ioremap(&pdev->dev, res->start, resource_size(res));
	if (!keypad->base)
		return -EBUSY;

	keypad->clk = devm_clk_get(&pdev->dev, "keypad");
	if (IS_ERR(keypad->clk)) {
		dev_err(&pdev->dev, "failed to get keypad clk\n");
		return PTR_ERR(keypad->clk);
	}

	error = clk_prepare(keypad->clk);
	if (error) {
		dev_err(&pdev->dev, "keypad clock prepare failed\n");
		return error;
	}

	keypad->input_dev = input_dev;
	keypad->pdev = pdev;
	keypad->row_shift = row_shift;
	keypad->rows = pdata->rows;
	keypad->cols = pdata->cols;
	keypad->stopped = true;
	init_waitqueue_head(&keypad->wait);

	if (pdev->dev.of_node)
		keypad->type = of_device_is_compatible(pdev->dev.of_node,
					"samsung,s5pv210-keypad");
	else
		keypad->type = platform_get_device_id(pdev)->driver_data;

	input_dev->name = pdev->name;
	input_dev->id.bustype = BUS_HOST;
	input_dev->dev.parent = &pdev->dev;

	input_dev->open = samsung_keypad_open;
	input_dev->close = samsung_keypad_close;

	error = matrix_keypad_build_keymap(keymap_data, NULL,
					   pdata->rows, pdata->cols,
					   keypad->keycodes, input_dev);
	if (error) {
		dev_err(&pdev->dev, "failed to build keymap\n");
		goto err_unprepare_clk;
	}

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

	input_set_drvdata(input_dev, keypad);

	keypad->irq = platform_get_irq(pdev, 0);
	if (keypad->irq < 0) {
		error = keypad->irq;
		goto err_unprepare_clk;
	}

	error = devm_request_threaded_irq(&pdev->dev, keypad->irq, NULL,
					  samsung_keypad_irq, IRQF_ONESHOT,
					  dev_name(&pdev->dev), keypad);
	if (error) {
		dev_err(&pdev->dev, "failed to register keypad interrupt\n");
		goto err_unprepare_clk;
	}

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

	error = input_register_device(keypad->input_dev);
	if (error)
		goto err_disable_runtime_pm;

	if (pdev->dev.of_node) {
		devm_kfree(&pdev->dev, (void *)pdata->keymap_data->keymap);
		devm_kfree(&pdev->dev, (void *)pdata->keymap_data);
		devm_kfree(&pdev->dev, (void *)pdata);
	}
	return 0;

err_disable_runtime_pm:
	pm_runtime_disable(&pdev->dev);
err_unprepare_clk:
	clk_unprepare(keypad->clk);
	return error;
}

static void samsung_keypad_remove(struct platform_device *pdev)
{
	struct samsung_keypad *keypad = platform_get_drvdata(pdev);

	pm_runtime_disable(&pdev->dev);

	input_unregister_device(keypad->input_dev);

	clk_unprepare(keypad->clk);
}

static int samsung_keypad_runtime_suspend(struct device *dev)
{
	struct platform_device *pdev = to_platform_device(dev);
	struct samsung_keypad *keypad = platform_get_drvdata(pdev);
	unsigned int val;
	int error;

	if (keypad->stopped)
		return 0;

	/* This may fail on some SoCs due to lack of controller support */
	error = enable_irq_wake(keypad->irq);
	if (!error)
		keypad->wake_enabled = true;

	val = readl(keypad->base + SAMSUNG_KEYIFCON);
	val |= SAMSUNG_KEYIFCON_WAKEUPEN;
	writel(val, keypad->base + SAMSUNG_KEYIFCON);

	clk_disable(keypad->clk);

	return 0;
}

static int samsung_keypad_runtime_resume(struct device *dev)
{
	struct platform_device *pdev = to_platform_device(dev);
	struct samsung_keypad *keypad = platform_get_drvdata(pdev);
	unsigned int val;

	if (keypad->stopped)
		return 0;

	clk_enable(keypad->clk);

	val = readl(keypad->base + SAMSUNG_KEYIFCON);
	val &= ~SAMSUNG_KEYIFCON_WAKEUPEN;
	writel(val, keypad->base + SAMSUNG_KEYIFCON);

	if (keypad->wake_enabled)
		disable_irq_wake(keypad->irq);

	return 0;
}

static void samsung_keypad_toggle_wakeup(struct samsung_keypad *keypad,
					 bool enable)
{
	unsigned int val;

	clk_enable(keypad->clk);

	val = readl(keypad->base + SAMSUNG_KEYIFCON);
	if (enable) {
		val |= SAMSUNG_KEYIFCON_WAKEUPEN;
		if (device_may_wakeup(&keypad->pdev->dev))
			enable_irq_wake(keypad->irq);
	} else {
		val &= ~SAMSUNG_KEYIFCON_WAKEUPEN;
		if (device_may_wakeup(&keypad->pdev->dev))
			disable_irq_wake(keypad->irq);
	}
	writel(val, keypad->base + SAMSUNG_KEYIFCON);

	clk_disable(keypad->clk);
}

static int samsung_keypad_suspend(struct device *dev)
{
	struct platform_device *pdev = to_platform_device(dev);
	struct samsung_keypad *keypad = platform_get_drvdata(pdev);
	struct input_dev *input_dev = keypad->input_dev;

	mutex_lock(&input_dev->mutex);

	if (input_device_enabled(input_dev))
		samsung_keypad_stop(keypad);

	samsung_keypad_toggle_wakeup(keypad, true);

	mutex_unlock(&input_dev->mutex);

	return 0;
}

static int samsung_keypad_resume(struct device *dev)
{
	struct platform_device *pdev = to_platform_device(dev);
	struct samsung_keypad *keypad = platform_get_drvdata(pdev);
	struct input_dev *input_dev = keypad->input_dev;

	mutex_lock(&input_dev->mutex);

	samsung_keypad_toggle_wakeup(keypad, false);

	if (input_device_enabled(input_dev))
		samsung_keypad_start(keypad);

	mutex_unlock(&input_dev->mutex);

	return 0;
}

static const struct dev_pm_ops samsung_keypad_pm_ops = {
	SYSTEM_SLEEP_PM_OPS(samsung_keypad_suspend, samsung_keypad_resume)
	RUNTIME_PM_OPS(samsung_keypad_runtime_suspend,
		       samsung_keypad_runtime_resume, NULL)
};

#ifdef CONFIG_OF
static const struct of_device_id samsung_keypad_dt_match[] = {
	{ .compatible = "samsung,s3c6410-keypad" },
	{ .compatible = "samsung,s5pv210-keypad" },
	{},
};
MODULE_DEVICE_TABLE(of, samsung_keypad_dt_match);
#endif

static const struct platform_device_id samsung_keypad_driver_ids[] = {
	{
		.name		= "samsung-keypad",
		.driver_data	= KEYPAD_TYPE_SAMSUNG,
	}, {
		.name		= "s5pv210-keypad",
		.driver_data	= KEYPAD_TYPE_S5PV210,
	},
	{ },
};
MODULE_DEVICE_TABLE(platform, samsung_keypad_driver_ids);

static struct platform_driver samsung_keypad_driver = {
	.probe		= samsung_keypad_probe,
	.remove_new	= samsung_keypad_remove,
	.driver		= {
		.name	= "samsung-keypad",
		.of_match_table = of_match_ptr(samsung_keypad_dt_match),
		.pm	= pm_ptr(&samsung_keypad_pm_ops),
	},
	.id_table	= samsung_keypad_driver_ids,
};
module_platform_driver(samsung_keypad_driver);

MODULE_DESCRIPTION("Samsung keypad driver");
MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
MODULE_AUTHOR("Donghwa Lee <dh09.lee@samsung.com>");
MODULE_LICENSE("GPL");
Commit	Line	Data
2874c5fd	1	// SPDX-License-Identifier: GPL-2.0-or-later
0fffed27 JS	2	/*
	3	* Samsung keypad driver
	4	*
	5	* Copyright (C) 2010 Samsung Electronics Co.Ltd
	6	* Author: Joonyoung Shim <jy0922.shim@samsung.com>
	7	* Author: Donghwa Lee <dh09.lee@samsung.com>
0fffed27 JS	8	*/
	9
	10	#include <linux/clk.h>
	11	#include <linux/delay.h>
	12	#include <linux/err.h>
0fffed27 JS	13	#include <linux/input.h>
	14	#include <linux/interrupt.h>
	15	#include <linux/io.h>
	16	#include <linux/module.h>
	17	#include <linux/platform_device.h>
48c98b1b MB	18	#include <linux/pm.h>
48c98b1b MB	19	#include <linux/pm_runtime.h>
0fffed27	20	#include <linux/slab.h>
b3d6ac3e	21	#include <linux/of.h>
0fffed27	22	#include <linux/sched.h>
8d964a28	23	#include <linux/input/samsung-keypad.h>
0fffed27 JS	24
	25	#define SAMSUNG_KEYIFCON 0x00
	26	#define SAMSUNG_KEYIFSTSCLR 0x04
	27	#define SAMSUNG_KEYIFCOL 0x08
	28	#define SAMSUNG_KEYIFROW 0x0c
	29	#define SAMSUNG_KEYIFFC 0x10
	30
	31	/* SAMSUNG_KEYIFCON */
	32	#define SAMSUNG_KEYIFCON_INT_F_EN (1 << 0)
	33	#define SAMSUNG_KEYIFCON_INT_R_EN (1 << 1)
	34	#define SAMSUNG_KEYIFCON_DF_EN (1 << 2)
	35	#define SAMSUNG_KEYIFCON_FC_EN (1 << 3)
	36	#define SAMSUNG_KEYIFCON_WAKEUPEN (1 << 4)
	37
	38	/* SAMSUNG_KEYIFSTSCLR */
	39	#define SAMSUNG_KEYIFSTSCLR_P_INT_MASK (0xff << 0)
	40	#define SAMSUNG_KEYIFSTSCLR_R_INT_MASK (0xff << 8)
	41	#define SAMSUNG_KEYIFSTSCLR_R_INT_OFFSET 8
	42	#define S5PV210_KEYIFSTSCLR_P_INT_MASK (0x3fff << 0)
	43	#define S5PV210_KEYIFSTSCLR_R_INT_MASK (0x3fff << 16)
	44	#define S5PV210_KEYIFSTSCLR_R_INT_OFFSET 16
	45
	46	/* SAMSUNG_KEYIFCOL */
	47	#define SAMSUNG_KEYIFCOL_MASK (0xff << 0)
	48	#define S5PV210_KEYIFCOLEN_MASK (0xff << 8)
	49
	50	/* SAMSUNG_KEYIFROW */
	51	#define SAMSUNG_KEYIFROW_MASK (0xff << 0)
	52	#define S5PV210_KEYIFROW_MASK (0x3fff << 0)
	53
	54	/* SAMSUNG_KEYIFFC */
	55	#define SAMSUNG_KEYIFFC_MASK (0x3ff << 0)
	56
	57	enum samsung_keypad_type {
	58	KEYPAD_TYPE_SAMSUNG,
	59	KEYPAD_TYPE_S5PV210,
	60	};
	61
	62	struct samsung_keypad {
	63	struct input_dev *input_dev;
48c98b1b	64	struct platform_device *pdev;
0fffed27 JS	65	struct clk *clk;
	66	void __iomem *base;
	67	wait_queue_head_t wait;
	68	bool stopped;
48c98b1b	69	bool wake_enabled;
0fffed27	70	int irq;
b3d6ac3e	71	enum samsung_keypad_type type;
0fffed27 JS	72	unsigned int row_shift;
	73	unsigned int rows;
	74	unsigned int cols;
	75	unsigned int row_state[SAMSUNG_MAX_COLS];
	76	unsigned short keycodes[];
	77	};
	78
0fffed27 JS	79	static void samsung_keypad_scan(struct samsung_keypad *keypad,
	80	unsigned int *row_state)
	81	{
0fffed27 JS	82	unsigned int col;
	83	unsigned int val;
	84
	85	for (col = 0; col < keypad->cols; col++) {
b3d6ac3e	86	if (keypad->type == KEYPAD_TYPE_S5PV210) {
0fffed27 JS	87	val = S5PV210_KEYIFCOLEN_MASK;
	88	val &= ~(1 << col) << 8;
	89	} else {
	90	val = SAMSUNG_KEYIFCOL_MASK;
	91	val &= ~(1 << col);
	92	}
	93
	94	writel(val, keypad->base + SAMSUNG_KEYIFCOL);
	95	mdelay(1);
	96
	97	val = readl(keypad->base + SAMSUNG_KEYIFROW);
	98	row_state[col] = ~val & ((1 << keypad->rows) - 1);
	99	}
	100
	101	/* KEYIFCOL reg clear */
	102	writel(0, keypad->base + SAMSUNG_KEYIFCOL);
	103	}
	104
	105	static bool samsung_keypad_report(struct samsung_keypad *keypad,
	106	unsigned int *row_state)
	107	{
	108	struct input_dev *input_dev = keypad->input_dev;
	109	unsigned int changed;
	110	unsigned int pressed;
	111	unsigned int key_down = 0;
	112	unsigned int val;
	113	unsigned int col, row;
	114
	115	for (col = 0; col < keypad->cols; col++) {
	116	changed = row_state[col] ^ keypad->row_state[col];
	117	key_down \|= row_state[col];
	118	if (!changed)
	119	continue;
	120
	121	for (row = 0; row < keypad->rows; row++) {
	122	if (!(changed & (1 << row)))
	123	continue;
	124
	125	pressed = row_state[col] & (1 << row);
	126
	127	dev_dbg(&keypad->input_dev->dev,
	128	"key %s, row: %d, col: %d\n",
	129	pressed ? "pressed" : "released", row, col);
	130
	131	val = MATRIX_SCAN_CODE(row, col, keypad->row_shift);
	132
	133	input_event(input_dev, EV_MSC, MSC_SCAN, val);
	134	input_report_key(input_dev,
	135	keypad->keycodes[val], pressed);
	136	}
	137	input_sync(keypad->input_dev);
	138	}
	139
	140	memcpy(keypad->row_state, row_state, sizeof(keypad->row_state));
	141
	142	return key_down;
	143	}
	144
	145	static irqreturn_t samsung_keypad_irq(int irq, void *dev_id)
	146	{
	147	struct samsung_keypad *keypad = dev_id;
	148	unsigned int row_state[SAMSUNG_MAX_COLS];
0fffed27 JS	149	bool key_down;
0fffed27 JS	150
48c98b1b MB	151	pm_runtime_get_sync(&keypad->pdev->dev);
48c98b1b MB	152
0fffed27	153	do {
f1556986	154	readl(keypad->base + SAMSUNG_KEYIFSTSCLR);
0fffed27 JS	155	/* Clear interrupt. */
	156	writel(~0x0, keypad->base + SAMSUNG_KEYIFSTSCLR);
	157
	158	samsung_keypad_scan(keypad, row_state);
	159
	160	key_down = samsung_keypad_report(keypad, row_state);
	161	if (key_down)
	162	wait_event_timeout(keypad->wait, keypad->stopped,
	163	msecs_to_jiffies(50));
	164
	165	} while (key_down && !keypad->stopped);
	166
69898e51	167	pm_runtime_put(&keypad->pdev->dev);
48c98b1b	168
0fffed27 JS	169	return IRQ_HANDLED;
	170	}
	171
	172	static void samsung_keypad_start(struct samsung_keypad *keypad)
	173	{
	174	unsigned int val;
	175
48c98b1b MB	176	pm_runtime_get_sync(&keypad->pdev->dev);
48c98b1b MB	177
0fffed27 JS	178	/* Tell IRQ thread that it may poll the device. */
	179	keypad->stopped = false;
	180
	181	clk_enable(keypad->clk);
	182
	183	/* Enable interrupt bits. */
	184	val = readl(keypad->base + SAMSUNG_KEYIFCON);
	185	val \|= SAMSUNG_KEYIFCON_INT_F_EN \| SAMSUNG_KEYIFCON_INT_R_EN;
	186	writel(val, keypad->base + SAMSUNG_KEYIFCON);
	187
	188	/* KEYIFCOL reg clear. */
	189	writel(0, keypad->base + SAMSUNG_KEYIFCOL);
48c98b1b	190
69898e51	191	pm_runtime_put(&keypad->pdev->dev);
0fffed27 JS	192	}
	193
	194	static void samsung_keypad_stop(struct samsung_keypad *keypad)
	195	{
	196	unsigned int val;
	197
48c98b1b MB	198	pm_runtime_get_sync(&keypad->pdev->dev);
48c98b1b MB	199
0fffed27 JS	200	/* Signal IRQ thread to stop polling and disable the handler. */
	201	keypad->stopped = true;
	202	wake_up(&keypad->wait);
	203	disable_irq(keypad->irq);
	204
	205	/* Clear interrupt. */
	206	writel(~0x0, keypad->base + SAMSUNG_KEYIFSTSCLR);
	207
	208	/* Disable interrupt bits. */
	209	val = readl(keypad->base + SAMSUNG_KEYIFCON);
	210	val &= ~(SAMSUNG_KEYIFCON_INT_F_EN \| SAMSUNG_KEYIFCON_INT_R_EN);
	211	writel(val, keypad->base + SAMSUNG_KEYIFCON);
	212
	213	clk_disable(keypad->clk);
	214
	215	/*
	216	* Now that chip should not generate interrupts we can safely
	217	* re-enable the handler.
	218	*/
	219	enable_irq(keypad->irq);
48c98b1b	220
69898e51	221	pm_runtime_put(&keypad->pdev->dev);
0fffed27 JS	222	}
	223
	224	static int samsung_keypad_open(struct input_dev *input_dev)
	225	{
	226	struct samsung_keypad *keypad = input_get_drvdata(input_dev);
	227
	228	samsung_keypad_start(keypad);
	229
	230	return 0;
	231	}
	232
	233	static void samsung_keypad_close(struct input_dev *input_dev)
	234	{
	235	struct samsung_keypad *keypad = input_get_drvdata(input_dev);
	236
	237	samsung_keypad_stop(keypad);
	238	}
	239
b3d6ac3e	240	#ifdef CONFIG_OF
670d2072 DT	241	static struct samsung_keypad_platdata *
670d2072 DT	242	samsung_keypad_parse_dt(struct device *dev)
b3d6ac3e TA	243	{
	244	struct samsung_keypad_platdata *pdata;
	245	struct matrix_keymap_data *keymap_data;
	246	uint32_t *keymap, num_rows = 0, num_cols = 0;
	247	struct device_node np = dev->of_node, key_np;
31b95bfb	248	unsigned int key_count;
b3d6ac3e	249
670d2072 DT	250	if (!np) {
	251	dev_err(dev, "missing device tree data\n");
	252	return ERR_PTR(-EINVAL);
	253	}
	254
b3d6ac3e TA	255	pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
	256	if (!pdata) {
	257	dev_err(dev, "could not allocate memory for platform data\n");
670d2072	258	return ERR_PTR(-ENOMEM);
b3d6ac3e TA	259	}
	260
	261	of_property_read_u32(np, "samsung,keypad-num-rows", &num_rows);
	262	of_property_read_u32(np, "samsung,keypad-num-columns", &num_cols);
	263	if (!num_rows \|\| !num_cols) {
	264	dev_err(dev, "number of keypad rows/columns not specified\n");
670d2072	265	return ERR_PTR(-EINVAL);
b3d6ac3e TA	266	}
	267	pdata->rows = num_rows;
	268	pdata->cols = num_cols;
	269
	270	keymap_data = devm_kzalloc(dev, sizeof(*keymap_data), GFP_KERNEL);
	271	if (!keymap_data) {
	272	dev_err(dev, "could not allocate memory for keymap data\n");
670d2072	273	return ERR_PTR(-ENOMEM);
b3d6ac3e TA	274	}
	275	pdata->keymap_data = keymap_data;
	276
31b95bfb	277	key_count = of_get_child_count(np);
b3d6ac3e	278	keymap_data->keymap_size = key_count;
a86854d0	279	keymap = devm_kcalloc(dev, key_count, sizeof(uint32_t), GFP_KERNEL);
b3d6ac3e TA	280	if (!keymap) {
b3d6ac3e TA	281	dev_err(dev, "could not allocate memory for keymap\n");
670d2072	282	return ERR_PTR(-ENOMEM);
b3d6ac3e TA	283	}
	284	keymap_data->keymap = keymap;
	285
	286	for_each_child_of_node(np, key_np) {
	287	u32 row, col, key_code;
	288	of_property_read_u32(key_np, "keypad,row", &row);
	289	of_property_read_u32(key_np, "keypad,column", &col);
	290	of_property_read_u32(key_np, "linux,code", &key_code);
	291	*keymap++ = KEY(row, col, key_code);
	292	}
	293
12c7d0ae	294	pdata->no_autorepeat = of_property_read_bool(np, "linux,input-no-autorepeat");
670d2072	295
43b7be3b DT	296	pdata->wakeup = of_property_read_bool(np, "wakeup-source") \|\|
	297	/* legacy name */
	298	of_property_read_bool(np, "linux,input-wakeup");
	299
b3d6ac3e TA	300
	301	return pdata;
	302	}
b3d6ac3e	303	#else
670d2072 DT	304	static struct samsung_keypad_platdata *
670d2072 DT	305	samsung_keypad_parse_dt(struct device *dev)
b3d6ac3e	306	{
670d2072 DT	307	dev_err(dev, "no platform data defined\n");
	308
	309	return ERR_PTR(-EINVAL);
b3d6ac3e	310	}
b3d6ac3e TA	311	#endif
b3d6ac3e TA	312
5298cc4c	313	static int samsung_keypad_probe(struct platform_device *pdev)
0fffed27 JS	314	{
	315	const struct samsung_keypad_platdata *pdata;
	316	const struct matrix_keymap_data *keymap_data;
	317	struct samsung_keypad *keypad;
	318	struct resource *res;
	319	struct input_dev *input_dev;
	320	unsigned int row_shift;
	321	unsigned int keymap_size;
	322	int error;
	323
670d2072	324	pdata = dev_get_platdata(&pdev->dev);
0fffed27	325	if (!pdata) {
670d2072 DT	326	pdata = samsung_keypad_parse_dt(&pdev->dev);
	327	if (IS_ERR(pdata))
	328	return PTR_ERR(pdata);
0fffed27 JS	329	}
	330
	331	keymap_data = pdata->keymap_data;
	332	if (!keymap_data) {
	333	dev_err(&pdev->dev, "no keymap data defined\n");
	334	return -EINVAL;
	335	}
	336
	337	if (!pdata->rows \|\| pdata->rows > SAMSUNG_MAX_ROWS)
	338	return -EINVAL;
	339
	340	if (!pdata->cols \|\| pdata->cols > SAMSUNG_MAX_COLS)
	341	return -EINVAL;
	342
	343	/* initialize the gpio */
	344	if (pdata->cfg_gpio)
	345	pdata->cfg_gpio(pdata->rows, pdata->cols);
	346
	347	row_shift = get_count_order(pdata->cols);
	348	keymap_size = (pdata->rows << row_shift) * sizeof(keypad->keycodes[0]);
	349
a57da347 SK	350	keypad = devm_kzalloc(&pdev->dev, sizeof(*keypad) + keymap_size,
	351	GFP_KERNEL);
	352	input_dev = devm_input_allocate_device(&pdev->dev);
	353	if (!keypad \|\| !input_dev)
	354	return -ENOMEM;
0fffed27 JS	355
0fffed27 JS	356	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
a57da347 SK	357	if (!res)
a57da347 SK	358	return -ENODEV;
0fffed27	359
a57da347 SK	360	keypad->base = devm_ioremap(&pdev->dev, res->start, resource_size(res));
	361	if (!keypad->base)
	362	return -EBUSY;
0fffed27	363
a57da347	364	keypad->clk = devm_clk_get(&pdev->dev, "keypad");
0fffed27 JS	365	if (IS_ERR(keypad->clk)) {
0fffed27 JS	366	dev_err(&pdev->dev, "failed to get keypad clk\n");
a57da347	367	return PTR_ERR(keypad->clk);
0fffed27 JS	368	}
0fffed27 JS	369
aba828ce TA	370	error = clk_prepare(keypad->clk);
	371	if (error) {
	372	dev_err(&pdev->dev, "keypad clock prepare failed\n");
a57da347	373	return error;
aba828ce TA	374	}
aba828ce TA	375
0fffed27	376	keypad->input_dev = input_dev;
48c98b1b	377	keypad->pdev = pdev;
0fffed27 JS	378	keypad->row_shift = row_shift;
	379	keypad->rows = pdata->rows;
	380	keypad->cols = pdata->cols;
48c98b1b	381	keypad->stopped = true;
0fffed27 JS	382	init_waitqueue_head(&keypad->wait);
0fffed27 JS	383
41cc2aaf	384	if (pdev->dev.of_node)
b3d6ac3e TA	385	keypad->type = of_device_is_compatible(pdev->dev.of_node,
b3d6ac3e TA	386	"samsung,s5pv210-keypad");
41cc2aaf	387	else
b3d6ac3e	388	keypad->type = platform_get_device_id(pdev)->driver_data;
b3d6ac3e	389
0fffed27 JS	390	input_dev->name = pdev->name;
	391	input_dev->id.bustype = BUS_HOST;
	392	input_dev->dev.parent = &pdev->dev;
0fffed27 JS	393
	394	input_dev->open = samsung_keypad_open;
	395	input_dev->close = samsung_keypad_close;
	396
1932811f DT	397	error = matrix_keypad_build_keymap(keymap_data, NULL,
	398	pdata->rows, pdata->cols,
	399	keypad->keycodes, input_dev);
	400	if (error) {
	401	dev_err(&pdev->dev, "failed to build keymap\n");
aba828ce	402	goto err_unprepare_clk;
1932811f	403	}
0fffed27 JS	404
0fffed27 JS	405	input_set_capability(input_dev, EV_MSC, MSC_SCAN);
1932811f DT	406	if (!pdata->no_autorepeat)
1932811f DT	407	__set_bit(EV_REP, input_dev->evbit);
0fffed27	408
1932811f	409	input_set_drvdata(input_dev, keypad);
0fffed27 JS	410
	411	keypad->irq = platform_get_irq(pdev, 0);
	412	if (keypad->irq < 0) {
	413	error = keypad->irq;
a57da347	414	goto err_unprepare_clk;
0fffed27 JS	415	}
0fffed27 JS	416
a57da347 SK	417	error = devm_request_threaded_irq(&pdev->dev, keypad->irq, NULL,
	418	samsung_keypad_irq, IRQF_ONESHOT,
	419	dev_name(&pdev->dev), keypad);
0fffed27 JS	420	if (error) {
0fffed27 JS	421	dev_err(&pdev->dev, "failed to register keypad interrupt\n");
a57da347	422	goto err_unprepare_clk;
0fffed27 JS	423	}
0fffed27 JS	424
48c98b1b MB	425	device_init_wakeup(&pdev->dev, pdata->wakeup);
	426	platform_set_drvdata(pdev, keypad);
	427	pm_runtime_enable(&pdev->dev);
	428
0fffed27 JS	429	error = input_register_device(keypad->input_dev);
0fffed27 JS	430	if (error)
a57da347	431	goto err_disable_runtime_pm;
0fffed27	432
b3d6ac3e TA	433	if (pdev->dev.of_node) {
	434	devm_kfree(&pdev->dev, (void *)pdata->keymap_data->keymap);
	435	devm_kfree(&pdev->dev, (void *)pdata->keymap_data);
	436	devm_kfree(&pdev->dev, (void *)pdata);
	437	}
0fffed27 JS	438	return 0;
0fffed27 JS	439
a57da347	440	err_disable_runtime_pm:
48c98b1b	441	pm_runtime_disable(&pdev->dev);
aba828ce TA	442	err_unprepare_clk:
aba828ce TA	443	clk_unprepare(keypad->clk);
0fffed27 JS	444	return error;
	445	}
	446
4e268589	447	static void samsung_keypad_remove(struct platform_device *pdev)
0fffed27 JS	448	{
	449	struct samsung_keypad *keypad = platform_get_drvdata(pdev);
	450
48c98b1b	451	pm_runtime_disable(&pdev->dev);
0fffed27 JS	452
	453	input_unregister_device(keypad->input_dev);
	454
aba828ce	455	clk_unprepare(keypad->clk);
0fffed27 JS	456	}
0fffed27 JS	457
48c98b1b MB	458	static int samsung_keypad_runtime_suspend(struct device *dev)
	459	{
	460	struct platform_device *pdev = to_platform_device(dev);
	461	struct samsung_keypad *keypad = platform_get_drvdata(pdev);
	462	unsigned int val;
	463	int error;
	464
	465	if (keypad->stopped)
	466	return 0;
	467
	468	/* This may fail on some SoCs due to lack of controller support */
	469	error = enable_irq_wake(keypad->irq);
	470	if (!error)
	471	keypad->wake_enabled = true;
	472
	473	val = readl(keypad->base + SAMSUNG_KEYIFCON);
	474	val \|= SAMSUNG_KEYIFCON_WAKEUPEN;
	475	writel(val, keypad->base + SAMSUNG_KEYIFCON);
	476
	477	clk_disable(keypad->clk);
	478
	479	return 0;
	480	}
	481
	482	static int samsung_keypad_runtime_resume(struct device *dev)
	483	{
	484	struct platform_device *pdev = to_platform_device(dev);
	485	struct samsung_keypad *keypad = platform_get_drvdata(pdev);
	486	unsigned int val;
	487
	488	if (keypad->stopped)
	489	return 0;
	490
	491	clk_enable(keypad->clk);
	492
	493	val = readl(keypad->base + SAMSUNG_KEYIFCON);
	494	val &= ~SAMSUNG_KEYIFCON_WAKEUPEN;
	495	writel(val, keypad->base + SAMSUNG_KEYIFCON);
	496
	497	if (keypad->wake_enabled)
	498	disable_irq_wake(keypad->irq);
	499
	500	return 0;
	501	}
48c98b1b	502
0fffed27 JS	503	static void samsung_keypad_toggle_wakeup(struct samsung_keypad *keypad,
	504	bool enable)
	505	{
0fffed27 JS	506	unsigned int val;
	507
	508	clk_enable(keypad->clk);
	509
	510	val = readl(keypad->base + SAMSUNG_KEYIFCON);
	511	if (enable) {
	512	val \|= SAMSUNG_KEYIFCON_WAKEUPEN;
48c98b1b	513	if (device_may_wakeup(&keypad->pdev->dev))
0fffed27 JS	514	enable_irq_wake(keypad->irq);
	515	} else {
	516	val &= ~SAMSUNG_KEYIFCON_WAKEUPEN;
48c98b1b	517	if (device_may_wakeup(&keypad->pdev->dev))
0fffed27 JS	518	disable_irq_wake(keypad->irq);
	519	}
	520	writel(val, keypad->base + SAMSUNG_KEYIFCON);
	521
	522	clk_disable(keypad->clk);
	523	}
	524
	525	static int samsung_keypad_suspend(struct device *dev)
	526	{
	527	struct platform_device *pdev = to_platform_device(dev);
	528	struct samsung_keypad *keypad = platform_get_drvdata(pdev);
	529	struct input_dev *input_dev = keypad->input_dev;
	530
	531	mutex_lock(&input_dev->mutex);
	532
d69f0a43	533	if (input_device_enabled(input_dev))
0fffed27 JS	534	samsung_keypad_stop(keypad);
	535
	536	samsung_keypad_toggle_wakeup(keypad, true);
	537
	538	mutex_unlock(&input_dev->mutex);
	539
	540	return 0;
	541	}
	542
	543	static int samsung_keypad_resume(struct device *dev)
	544	{
	545	struct platform_device *pdev = to_platform_device(dev);
	546	struct samsung_keypad *keypad = platform_get_drvdata(pdev);
	547	struct input_dev *input_dev = keypad->input_dev;
	548
	549	mutex_lock(&input_dev->mutex);
	550
	551	samsung_keypad_toggle_wakeup(keypad, false);
	552
d69f0a43	553	if (input_device_enabled(input_dev))
0fffed27 JS	554	samsung_keypad_start(keypad);
	555
	556	mutex_unlock(&input_dev->mutex);
	557
	558	return 0;
	559	}
0fffed27	560
48c98b1b	561	static const struct dev_pm_ops samsung_keypad_pm_ops = {
c51283d7 JC	562	SYSTEM_SLEEP_PM_OPS(samsung_keypad_suspend, samsung_keypad_resume)
	563	RUNTIME_PM_OPS(samsung_keypad_runtime_suspend,
	564	samsung_keypad_runtime_resume, NULL)
48c98b1b	565	};
400bf299	566
b3d6ac3e TA	567	#ifdef CONFIG_OF
	568	static const struct of_device_id samsung_keypad_dt_match[] = {
	569	{ .compatible = "samsung,s3c6410-keypad" },
	570	{ .compatible = "samsung,s5pv210-keypad" },
	571	{},
	572	};
	573	MODULE_DEVICE_TABLE(of, samsung_keypad_dt_match);
b3d6ac3e TA	574	#endif
b3d6ac3e TA	575
8550b073	576	static const struct platform_device_id samsung_keypad_driver_ids[] = {
0fffed27 JS	577	{
	578	.name = "samsung-keypad",
	579	.driver_data = KEYPAD_TYPE_SAMSUNG,
	580	}, {
	581	.name = "s5pv210-keypad",
	582	.driver_data = KEYPAD_TYPE_S5PV210,
	583	},
	584	{ },
	585	};
	586	MODULE_DEVICE_TABLE(platform, samsung_keypad_driver_ids);
	587
	588	static struct platform_driver samsung_keypad_driver = {
	589	.probe = samsung_keypad_probe,
4e268589	590	.remove_new = samsung_keypad_remove,
0fffed27 JS	591	.driver = {
0fffed27 JS	592	.name = "samsung-keypad",
f4d4661b	593	.of_match_table = of_match_ptr(samsung_keypad_dt_match),
c51283d7	594	.pm = pm_ptr(&samsung_keypad_pm_ops),
0fffed27 JS	595	},
	596	.id_table = samsung_keypad_driver_ids,
	597	};
5146c84f	598	module_platform_driver(samsung_keypad_driver);
0fffed27 JS	599
	600	MODULE_DESCRIPTION("Samsung keypad driver");
	601	MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
	602	MODULE_AUTHOR("Donghwa Lee <dh09.lee@samsung.com>");
	603	MODULE_LICENSE("GPL");