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

/*
 * Samsung keypad driver
 *
 * Copyright (C) 2010 Samsung Electronics Co.Ltd
 * Author: Joonyoung Shim <jy0922.shim@samsung.com>
 * Author: Donghwa Lee <dh09.lee@samsung.com>
 *
 * This program is free software; you can redistribute  it and/or modify it
 * under  the terms of  the GNU General  Public License as published by the
 * Free Software Foundation;  either version 2 of the  License, or (at your
 * option) any later version.
 */

#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];
	unsigned int val;
	bool key_down;

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

	do {
		val = 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_kzalloc(dev, sizeof(uint32_t) * key_count, 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);
	}

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

	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);
	device_init_wakeup(&pdev->dev, 0);
err_unprepare_clk:
	clk_unprepare(keypad->clk);
	return error;
}

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

	pm_runtime_disable(&pdev->dev);
	device_init_wakeup(&pdev->dev, 0);

	input_unregister_device(keypad->input_dev);

	clk_unprepare(keypad->clk);

	return 0;
}

#ifdef CONFIG_PM
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;
}
#endif

#ifdef CONFIG_PM_SLEEP
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_dev->users)
		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_dev->users)
		samsung_keypad_start(keypad);

	mutex_unlock(&input_dev->mutex);

	return 0;
}
#endif

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