1/*
2 * linux/drivers/input/keyboard/omap-keypad.c
3 *
4 * OMAP Keypad Driver
5 *
6 * Copyright (C) 2003 Nokia Corporation
7 * Written by Timo Ter��s <ext-timo.teras@nokia.com>
8 *
9 * Added support for H2 & H3 Keypad
10 * Copyright (C) 2004 Texas Instruments
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 */
26
27#include <linux/module.h>
28#include <linux/interrupt.h>
29#include <linux/types.h>
30#include <linux/input.h>
31#include <linux/kernel.h>
32#include <linux/delay.h>
33#include <linux/platform_device.h>
34#include <linux/mutex.h>
35#include <linux/errno.h>
36#include <linux/slab.h>
37#include <linux/gpio.h>
38#include <linux/platform_data/gpio-omap.h>
39#include <linux/platform_data/keypad-omap.h>
40
41#undef NEW_BOARD_LEARNING_MODE
42
43static void omap_kp_tasklet(unsigned long);
44static void omap_kp_timer(unsigned long);
45
46static unsigned char keypad_state[8];
47static DEFINE_MUTEX(kp_enable_mutex);
48static int kp_enable = 1;
49static int kp_cur_group = -1;
50
51struct omap_kp {
52	struct input_dev *input;
53	struct timer_list timer;
54	int irq;
55	unsigned int rows;
56	unsigned int cols;
57	unsigned long delay;
58	unsigned int debounce;
59	unsigned short keymap[];
60};
61
62static DECLARE_TASKLET_DISABLED(kp_tasklet, omap_kp_tasklet, 0);
63
64static unsigned int *row_gpios;
65static unsigned int *col_gpios;
66
67#ifdef CONFIG_ARCH_OMAP2
68static void set_col_gpio_val(struct omap_kp *omap_kp, u8 value)
69{
70	int col;
71
72	for (col = 0; col < omap_kp->cols; col++)
73		gpio_set_value(col_gpios[col], value & (1 << col));
74}
75
76static u8 get_row_gpio_val(struct omap_kp *omap_kp)
77{
78	int row;
79	u8 value = 0;
80
81	for (row = 0; row < omap_kp->rows; row++) {
82		if (gpio_get_value(row_gpios[row]))
83			value |= (1 << row);
84	}
85	return value;
86}
87#else
88#define		set_col_gpio_val(x, y)	do {} while (0)
89#define		get_row_gpio_val(x)	0
90#endif
91
92static irqreturn_t omap_kp_interrupt(int irq, void *dev_id)
93{
94	/* disable keyboard interrupt and schedule for handling */
95	omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
96
97	tasklet_schedule(&kp_tasklet);
98
99	return IRQ_HANDLED;
100}
101
102static void omap_kp_timer(unsigned long data)
103{
104	tasklet_schedule(&kp_tasklet);
105}
106
107static void omap_kp_scan_keypad(struct omap_kp *omap_kp, unsigned char *state)
108{
109	int col = 0;
110
111	/* disable keyboard interrupt and schedule for handling */
112	omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
113
114	/* read the keypad status */
115	omap_writew(0xff, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBC);
116	for (col = 0; col < omap_kp->cols; col++) {
117		omap_writew(~(1 << col) & 0xff,
118			    OMAP1_MPUIO_BASE + OMAP_MPUIO_KBC);
119
120		udelay(omap_kp->delay);
121
122		state[col] = ~omap_readw(OMAP1_MPUIO_BASE +
123					 OMAP_MPUIO_KBR_LATCH) & 0xff;
124	}
125	omap_writew(0x00, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBC);
126	udelay(2);
127}
128
129static void omap_kp_tasklet(unsigned long data)
130{
131	struct omap_kp *omap_kp_data = (struct omap_kp *) data;
132	unsigned short *keycodes = omap_kp_data->input->keycode;
133	unsigned int row_shift = get_count_order(omap_kp_data->cols);
134	unsigned char new_state[8], changed, key_down = 0;
135	int col, row;
136	int spurious = 0;
137
138	/* check for any changes */
139	omap_kp_scan_keypad(omap_kp_data, new_state);
140
141	/* check for changes and print those */
142	for (col = 0; col < omap_kp_data->cols; col++) {
143		changed = new_state[col] ^ keypad_state[col];
144		key_down |= new_state[col];
145		if (changed == 0)
146			continue;
147
148		for (row = 0; row < omap_kp_data->rows; row++) {
149			int key;
150			if (!(changed & (1 << row)))
151				continue;
152#ifdef NEW_BOARD_LEARNING_MODE
153			printk(KERN_INFO "omap-keypad: key %d-%d %s\n", col,
154			       row, (new_state[col] & (1 << row)) ?
155			       "pressed" : "released");
156#else
157			key = keycodes[MATRIX_SCAN_CODE(row, col, row_shift)];
158			if (key < 0) {
159				printk(KERN_WARNING
160				      "omap-keypad: Spurious key event %d-%d\n",
161				       col, row);
162				/* We scan again after a couple of seconds */
163				spurious = 1;
164				continue;
165			}
166
167			if (!(kp_cur_group == (key & GROUP_MASK) ||
168			      kp_cur_group == -1))
169				continue;
170
171			kp_cur_group = key & GROUP_MASK;
172			input_report_key(omap_kp_data->input, key & ~GROUP_MASK,
173					 new_state[col] & (1 << row));
174#endif
175		}
176	}
177	input_sync(omap_kp_data->input);
178	memcpy(keypad_state, new_state, sizeof(keypad_state));
179
180	if (key_down) {
181		int delay = HZ / 20;
182		/* some key is pressed - keep irq disabled and use timer
183		 * to poll the keypad */
184		if (spurious)
185			delay = 2 * HZ;
186		mod_timer(&omap_kp_data->timer, jiffies + delay);
187	} else {
188		/* enable interrupts */
189		omap_writew(0, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
190		kp_cur_group = -1;
191	}
192}
193
194static ssize_t omap_kp_enable_show(struct device *dev,
195				   struct device_attribute *attr, char *buf)
196{
197	return sprintf(buf, "%u\n", kp_enable);
198}
199
200static ssize_t omap_kp_enable_store(struct device *dev, struct device_attribute *attr,
201				    const char *buf, size_t count)
202{
203	struct omap_kp *omap_kp = dev_get_drvdata(dev);
204	int state;
205
206	if (sscanf(buf, "%u", &state) != 1)
207		return -EINVAL;
208
209	if ((state != 1) && (state != 0))
210		return -EINVAL;
211
212	mutex_lock(&kp_enable_mutex);
213	if (state != kp_enable) {
214		if (state)
215			enable_irq(omap_kp->irq);
216		else
217			disable_irq(omap_kp->irq);
218		kp_enable = state;
219	}
220	mutex_unlock(&kp_enable_mutex);
221
222	return strnlen(buf, count);
223}
224
225static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR, omap_kp_enable_show, omap_kp_enable_store);
226
227#ifdef CONFIG_PM
228static int omap_kp_suspend(struct platform_device *dev, pm_message_t state)
229{
230	/* Nothing yet */
231
232	return 0;
233}
234
235static int omap_kp_resume(struct platform_device *dev)
236{
237	/* Nothing yet */
238
239	return 0;
240}
241#else
242#define omap_kp_suspend	NULL
243#define omap_kp_resume	NULL
244#endif
245
246static int omap_kp_probe(struct platform_device *pdev)
247{
248	struct omap_kp *omap_kp;
249	struct input_dev *input_dev;
250	struct omap_kp_platform_data *pdata = dev_get_platdata(&pdev->dev);
251	int i, col_idx, row_idx, ret;
252	unsigned int row_shift, keycodemax;
253
254	if (!pdata->rows || !pdata->cols || !pdata->keymap_data) {
255		printk(KERN_ERR "No rows, cols or keymap_data from pdata\n");
256		return -EINVAL;
257	}
258
259	row_shift = get_count_order(pdata->cols);
260	keycodemax = pdata->rows << row_shift;
261
262	omap_kp = kzalloc(sizeof(struct omap_kp) +
263			keycodemax * sizeof(unsigned short), GFP_KERNEL);
264	input_dev = input_allocate_device();
265	if (!omap_kp || !input_dev) {
266		kfree(omap_kp);
267		input_free_device(input_dev);
268		return -ENOMEM;
269	}
270
271	platform_set_drvdata(pdev, omap_kp);
272
273	omap_kp->input = input_dev;
274
275	/* Disable the interrupt for the MPUIO keyboard */
276	omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
277
278	if (pdata->delay)
279		omap_kp->delay = pdata->delay;
280
281	if (pdata->row_gpios && pdata->col_gpios) {
282		row_gpios = pdata->row_gpios;
283		col_gpios = pdata->col_gpios;
284	}
285
286	omap_kp->rows = pdata->rows;
287	omap_kp->cols = pdata->cols;
288
289	col_idx = 0;
290	row_idx = 0;
291
292	setup_timer(&omap_kp->timer, omap_kp_timer, (unsigned long)omap_kp);
293
294	/* get the irq and init timer*/
295	tasklet_enable(&kp_tasklet);
296	kp_tasklet.data = (unsigned long) omap_kp;
297
298	ret = device_create_file(&pdev->dev, &dev_attr_enable);
299	if (ret < 0)
300		goto err2;
301
302	/* setup input device */
303	input_dev->name = "omap-keypad";
304	input_dev->phys = "omap-keypad/input0";
305	input_dev->dev.parent = &pdev->dev;
306
307	input_dev->id.bustype = BUS_HOST;
308	input_dev->id.vendor = 0x0001;
309	input_dev->id.product = 0x0001;
310	input_dev->id.version = 0x0100;
311
312	if (pdata->rep)
313		__set_bit(EV_REP, input_dev->evbit);
314
315	ret = matrix_keypad_build_keymap(pdata->keymap_data, NULL,
316					 pdata->rows, pdata->cols,
317					 omap_kp->keymap, input_dev);
318	if (ret < 0)
319		goto err3;
320
321	ret = input_register_device(omap_kp->input);
322	if (ret < 0) {
323		printk(KERN_ERR "Unable to register omap-keypad input device\n");
324		goto err3;
325	}
326
327	if (pdata->dbounce)
328		omap_writew(0xff, OMAP1_MPUIO_BASE + OMAP_MPUIO_GPIO_DEBOUNCING);
329
330	/* scan current status and enable interrupt */
331	omap_kp_scan_keypad(omap_kp, keypad_state);
332	omap_kp->irq = platform_get_irq(pdev, 0);
333	if (omap_kp->irq >= 0) {
334		if (request_irq(omap_kp->irq, omap_kp_interrupt, 0,
335				"omap-keypad", omap_kp) < 0)
336			goto err4;
337	}
338	omap_writew(0, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
339
340	return 0;
341
342err4:
343	input_unregister_device(omap_kp->input);
344	input_dev = NULL;
345err3:
346	device_remove_file(&pdev->dev, &dev_attr_enable);
347err2:
348	for (i = row_idx - 1; i >= 0; i--)
349		gpio_free(row_gpios[i]);
350	for (i = col_idx - 1; i >= 0; i--)
351		gpio_free(col_gpios[i]);
352
353	kfree(omap_kp);
354	input_free_device(input_dev);
355
356	return -EINVAL;
357}
358
359static int omap_kp_remove(struct platform_device *pdev)
360{
361	struct omap_kp *omap_kp = platform_get_drvdata(pdev);
362
363	/* disable keypad interrupt handling */
364	tasklet_disable(&kp_tasklet);
365	omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
366	free_irq(omap_kp->irq, omap_kp);
367
368	del_timer_sync(&omap_kp->timer);
369	tasklet_kill(&kp_tasklet);
370
371	/* unregister everything */
372	input_unregister_device(omap_kp->input);
373
374	kfree(omap_kp);
375
376	return 0;
377}
378
379static struct platform_driver omap_kp_driver = {
380	.probe		= omap_kp_probe,
381	.remove		= omap_kp_remove,
382	.suspend	= omap_kp_suspend,
383	.resume		= omap_kp_resume,
384	.driver		= {
385		.name	= "omap-keypad",
386	},
387};
388module_platform_driver(omap_kp_driver);
389
390MODULE_AUTHOR("Timo Ter��s");
391MODULE_DESCRIPTION("OMAP Keypad Driver");
392MODULE_LICENSE("GPL");
393MODULE_ALIAS("platform:omap-keypad");
394