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 
43 static void omap_kp_tasklet(unsigned long);
44 static void omap_kp_timer(unsigned long);
45 
46 static unsigned char keypad_state[8];
47 static DEFINE_MUTEX(kp_enable_mutex);
48 static int kp_enable = 1;
49 static int kp_cur_group = -1;
50 
51 struct 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 
62 static DECLARE_TASKLET_DISABLED(kp_tasklet, omap_kp_tasklet, 0);
63 
64 static unsigned int *row_gpios;
65 static unsigned int *col_gpios;
66 
67 #ifdef CONFIG_ARCH_OMAP2
68 static 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 
76 static 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 
92 static 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 
102 static void omap_kp_timer(unsigned long data)
103 {
104 	tasklet_schedule(&kp_tasklet);
105 }
106 
107 static 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 
129 static 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 
159 			if (!(kp_cur_group == (key & GROUP_MASK) ||
160 			      kp_cur_group == -1))
161 				continue;
162 
163 			kp_cur_group = key & GROUP_MASK;
164 			input_report_key(omap_kp_data->input, key & ~GROUP_MASK,
165 					 new_state[col] & (1 << row));
166 #endif
167 		}
168 	}
169 	input_sync(omap_kp_data->input);
170 	memcpy(keypad_state, new_state, sizeof(keypad_state));
171 
172 	if (key_down) {
173 		int delay = HZ / 20;
174 		/* some key is pressed - keep irq disabled and use timer
175 		 * to poll the keypad */
176 		if (spurious)
177 			delay = 2 * HZ;
178 		mod_timer(&omap_kp_data->timer, jiffies + delay);
179 	} else {
180 		/* enable interrupts */
181 		omap_writew(0, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
182 		kp_cur_group = -1;
183 	}
184 }
185 
186 static ssize_t omap_kp_enable_show(struct device *dev,
187 				   struct device_attribute *attr, char *buf)
188 {
189 	return sprintf(buf, "%u\n", kp_enable);
190 }
191 
192 static ssize_t omap_kp_enable_store(struct device *dev, struct device_attribute *attr,
193 				    const char *buf, size_t count)
194 {
195 	struct omap_kp *omap_kp = dev_get_drvdata(dev);
196 	int state;
197 
198 	if (sscanf(buf, "%u", &state) != 1)
199 		return -EINVAL;
200 
201 	if ((state != 1) && (state != 0))
202 		return -EINVAL;
203 
204 	mutex_lock(&kp_enable_mutex);
205 	if (state != kp_enable) {
206 		if (state)
207 			enable_irq(omap_kp->irq);
208 		else
209 			disable_irq(omap_kp->irq);
210 		kp_enable = state;
211 	}
212 	mutex_unlock(&kp_enable_mutex);
213 
214 	return strnlen(buf, count);
215 }
216 
217 static DEVICE_ATTR(enable, S_IRUGO | S_IWUSR, omap_kp_enable_show, omap_kp_enable_store);
218 
219 #ifdef CONFIG_PM
220 static int omap_kp_suspend(struct platform_device *dev, pm_message_t state)
221 {
222 	/* Nothing yet */
223 
224 	return 0;
225 }
226 
227 static int omap_kp_resume(struct platform_device *dev)
228 {
229 	/* Nothing yet */
230 
231 	return 0;
232 }
233 #else
234 #define omap_kp_suspend	NULL
235 #define omap_kp_resume	NULL
236 #endif
237 
238 static int omap_kp_probe(struct platform_device *pdev)
239 {
240 	struct omap_kp *omap_kp;
241 	struct input_dev *input_dev;
242 	struct omap_kp_platform_data *pdata = dev_get_platdata(&pdev->dev);
243 	int i, col_idx, row_idx, ret;
244 	unsigned int row_shift, keycodemax;
245 
246 	if (!pdata->rows || !pdata->cols || !pdata->keymap_data) {
247 		printk(KERN_ERR "No rows, cols or keymap_data from pdata\n");
248 		return -EINVAL;
249 	}
250 
251 	row_shift = get_count_order(pdata->cols);
252 	keycodemax = pdata->rows << row_shift;
253 
254 	omap_kp = kzalloc(sizeof(struct omap_kp) +
255 			keycodemax * sizeof(unsigned short), GFP_KERNEL);
256 	input_dev = input_allocate_device();
257 	if (!omap_kp || !input_dev) {
258 		kfree(omap_kp);
259 		input_free_device(input_dev);
260 		return -ENOMEM;
261 	}
262 
263 	platform_set_drvdata(pdev, omap_kp);
264 
265 	omap_kp->input = input_dev;
266 
267 	/* Disable the interrupt for the MPUIO keyboard */
268 	omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
269 
270 	if (pdata->delay)
271 		omap_kp->delay = pdata->delay;
272 
273 	if (pdata->row_gpios && pdata->col_gpios) {
274 		row_gpios = pdata->row_gpios;
275 		col_gpios = pdata->col_gpios;
276 	}
277 
278 	omap_kp->rows = pdata->rows;
279 	omap_kp->cols = pdata->cols;
280 
281 	col_idx = 0;
282 	row_idx = 0;
283 
284 	setup_timer(&omap_kp->timer, omap_kp_timer, (unsigned long)omap_kp);
285 
286 	/* get the irq and init timer*/
287 	kp_tasklet.data = (unsigned long) omap_kp;
288 	tasklet_enable(&kp_tasklet);
289 
290 	ret = device_create_file(&pdev->dev, &dev_attr_enable);
291 	if (ret < 0)
292 		goto err2;
293 
294 	/* setup input device */
295 	input_dev->name = "omap-keypad";
296 	input_dev->phys = "omap-keypad/input0";
297 	input_dev->dev.parent = &pdev->dev;
298 
299 	input_dev->id.bustype = BUS_HOST;
300 	input_dev->id.vendor = 0x0001;
301 	input_dev->id.product = 0x0001;
302 	input_dev->id.version = 0x0100;
303 
304 	if (pdata->rep)
305 		__set_bit(EV_REP, input_dev->evbit);
306 
307 	ret = matrix_keypad_build_keymap(pdata->keymap_data, NULL,
308 					 pdata->rows, pdata->cols,
309 					 omap_kp->keymap, input_dev);
310 	if (ret < 0)
311 		goto err3;
312 
313 	ret = input_register_device(omap_kp->input);
314 	if (ret < 0) {
315 		printk(KERN_ERR "Unable to register omap-keypad input device\n");
316 		goto err3;
317 	}
318 
319 	if (pdata->dbounce)
320 		omap_writew(0xff, OMAP1_MPUIO_BASE + OMAP_MPUIO_GPIO_DEBOUNCING);
321 
322 	/* scan current status and enable interrupt */
323 	omap_kp_scan_keypad(omap_kp, keypad_state);
324 	omap_kp->irq = platform_get_irq(pdev, 0);
325 	if (omap_kp->irq >= 0) {
326 		if (request_irq(omap_kp->irq, omap_kp_interrupt, 0,
327 				"omap-keypad", omap_kp) < 0)
328 			goto err4;
329 	}
330 	omap_writew(0, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
331 
332 	return 0;
333 
334 err4:
335 	input_unregister_device(omap_kp->input);
336 	input_dev = NULL;
337 err3:
338 	device_remove_file(&pdev->dev, &dev_attr_enable);
339 err2:
340 	for (i = row_idx - 1; i >= 0; i--)
341 		gpio_free(row_gpios[i]);
342 	for (i = col_idx - 1; i >= 0; i--)
343 		gpio_free(col_gpios[i]);
344 
345 	kfree(omap_kp);
346 	input_free_device(input_dev);
347 
348 	return -EINVAL;
349 }
350 
351 static int omap_kp_remove(struct platform_device *pdev)
352 {
353 	struct omap_kp *omap_kp = platform_get_drvdata(pdev);
354 
355 	/* disable keypad interrupt handling */
356 	tasklet_disable(&kp_tasklet);
357 	omap_writew(1, OMAP1_MPUIO_BASE + OMAP_MPUIO_KBD_MASKIT);
358 	free_irq(omap_kp->irq, omap_kp);
359 
360 	del_timer_sync(&omap_kp->timer);
361 	tasklet_kill(&kp_tasklet);
362 
363 	/* unregister everything */
364 	input_unregister_device(omap_kp->input);
365 
366 	kfree(omap_kp);
367 
368 	return 0;
369 }
370 
371 static struct platform_driver omap_kp_driver = {
372 	.probe		= omap_kp_probe,
373 	.remove		= omap_kp_remove,
374 	.suspend	= omap_kp_suspend,
375 	.resume		= omap_kp_resume,
376 	.driver		= {
377 		.name	= "omap-keypad",
378 	},
379 };
380 module_platform_driver(omap_kp_driver);
381 
382 MODULE_AUTHOR("Timo Teräs");
383 MODULE_DESCRIPTION("OMAP Keypad Driver");
384 MODULE_LICENSE("GPL");
385 MODULE_ALIAS("platform:omap-keypad");
386