Input: tca8418_keypad - use dev_get_platdata() to retrieve platform data
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / input / keyboard / tca8418_keypad.c
CommitLineData
fb6c721b
KM
1/*
2 * Driver for TCA8418 I2C keyboard
3 *
4 * Copyright (C) 2011 Fuel7, Inc. All rights reserved.
5 *
6 * Author: Kyle Manna <kyle.manna@fuel7.com>
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public
10 * License v2 as published by the Free Software Foundation.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public
18 * License along with this program; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 021110-1307, USA.
21 *
22 * If you can't comply with GPLv2, alternative licensing terms may be
23 * arranged. Please contact Fuel7, Inc. (http://fuel7.com/) for proprietary
24 * alternative licensing inquiries.
25 */
26
27#include <linux/types.h>
28#include <linux/module.h>
29#include <linux/init.h>
30#include <linux/delay.h>
31#include <linux/slab.h>
32#include <linux/interrupt.h>
33#include <linux/workqueue.h>
34#include <linux/gpio.h>
35#include <linux/i2c.h>
36#include <linux/input.h>
37#include <linux/input/tca8418_keypad.h>
e89e29b8 38#include <linux/of.h>
fb6c721b
KM
39
40/* TCA8418 hardware limits */
41#define TCA8418_MAX_ROWS 8
42#define TCA8418_MAX_COLS 10
43
44/* TCA8418 register offsets */
45#define REG_CFG 0x01
46#define REG_INT_STAT 0x02
47#define REG_KEY_LCK_EC 0x03
48#define REG_KEY_EVENT_A 0x04
49#define REG_KEY_EVENT_B 0x05
50#define REG_KEY_EVENT_C 0x06
51#define REG_KEY_EVENT_D 0x07
52#define REG_KEY_EVENT_E 0x08
53#define REG_KEY_EVENT_F 0x09
54#define REG_KEY_EVENT_G 0x0A
55#define REG_KEY_EVENT_H 0x0B
56#define REG_KEY_EVENT_I 0x0C
57#define REG_KEY_EVENT_J 0x0D
58#define REG_KP_LCK_TIMER 0x0E
59#define REG_UNLOCK1 0x0F
60#define REG_UNLOCK2 0x10
61#define REG_GPIO_INT_STAT1 0x11
62#define REG_GPIO_INT_STAT2 0x12
63#define REG_GPIO_INT_STAT3 0x13
64#define REG_GPIO_DAT_STAT1 0x14
65#define REG_GPIO_DAT_STAT2 0x15
66#define REG_GPIO_DAT_STAT3 0x16
67#define REG_GPIO_DAT_OUT1 0x17
68#define REG_GPIO_DAT_OUT2 0x18
69#define REG_GPIO_DAT_OUT3 0x19
70#define REG_GPIO_INT_EN1 0x1A
71#define REG_GPIO_INT_EN2 0x1B
72#define REG_GPIO_INT_EN3 0x1C
73#define REG_KP_GPIO1 0x1D
74#define REG_KP_GPIO2 0x1E
75#define REG_KP_GPIO3 0x1F
76#define REG_GPI_EM1 0x20
77#define REG_GPI_EM2 0x21
78#define REG_GPI_EM3 0x22
79#define REG_GPIO_DIR1 0x23
80#define REG_GPIO_DIR2 0x24
81#define REG_GPIO_DIR3 0x25
82#define REG_GPIO_INT_LVL1 0x26
83#define REG_GPIO_INT_LVL2 0x27
84#define REG_GPIO_INT_LVL3 0x28
85#define REG_DEBOUNCE_DIS1 0x29
86#define REG_DEBOUNCE_DIS2 0x2A
87#define REG_DEBOUNCE_DIS3 0x2B
88#define REG_GPIO_PULL1 0x2C
89#define REG_GPIO_PULL2 0x2D
90#define REG_GPIO_PULL3 0x2E
91
92/* TCA8418 bit definitions */
93#define CFG_AI BIT(7)
94#define CFG_GPI_E_CFG BIT(6)
95#define CFG_OVR_FLOW_M BIT(5)
96#define CFG_INT_CFG BIT(4)
97#define CFG_OVR_FLOW_IEN BIT(3)
98#define CFG_K_LCK_IEN BIT(2)
99#define CFG_GPI_IEN BIT(1)
100#define CFG_KE_IEN BIT(0)
101
102#define INT_STAT_CAD_INT BIT(4)
103#define INT_STAT_OVR_FLOW_INT BIT(3)
104#define INT_STAT_K_LCK_INT BIT(2)
105#define INT_STAT_GPI_INT BIT(1)
106#define INT_STAT_K_INT BIT(0)
107
108/* TCA8418 register masks */
109#define KEY_LCK_EC_KEC 0x7
110#define KEY_EVENT_CODE 0x7f
111#define KEY_EVENT_VALUE 0x80
112
113
114static const struct i2c_device_id tca8418_id[] = {
115 { TCA8418_NAME, 8418, },
116 { }
117};
118MODULE_DEVICE_TABLE(i2c, tca8418_id);
119
e89e29b8
AB
120#ifdef CONFIG_OF
121static const struct of_device_id tca8418_dt_ids[] __devinitconst = {
122 { .compatible = "ti,tca8418", },
123 { }
124};
125MODULE_DEVICE_TABLE(of, tca8418_dt_ids);
126#endif
127
fb6c721b 128struct tca8418_keypad {
fb6c721b
KM
129 unsigned int irq;
130 unsigned int row_shift;
131
132 struct i2c_client *client;
133 struct input_dev *input;
134
135 /* Flexible array member, must be at end of struct */
136 unsigned short keymap[];
137};
138
139/*
140 * Write a byte to the TCA8418
141 */
142static int tca8418_write_byte(struct tca8418_keypad *keypad_data,
143 int reg, u8 val)
144{
145 int error;
146
147 error = i2c_smbus_write_byte_data(keypad_data->client, reg, val);
148 if (error < 0) {
149 dev_err(&keypad_data->client->dev,
150 "%s failed, reg: %d, val: %d, error: %d\n",
151 __func__, reg, val, error);
152 return error;
153 }
154
155 return 0;
156}
157
158/*
159 * Read a byte from the TCA8418
160 */
161static int tca8418_read_byte(struct tca8418_keypad *keypad_data,
162 int reg, u8 *val)
163{
164 int error;
165
166 error = i2c_smbus_read_byte_data(keypad_data->client, reg);
167 if (error < 0) {
168 dev_err(&keypad_data->client->dev,
169 "%s failed, reg: %d, error: %d\n",
170 __func__, reg, error);
171 return error;
172 }
173
174 *val = (u8)error;
175
176 return 0;
177}
178
179static void tca8418_read_keypad(struct tca8418_keypad *keypad_data)
180{
181 int error, col, row;
182 u8 reg, state, code;
183
184 /* Initial read of the key event FIFO */
185 error = tca8418_read_byte(keypad_data, REG_KEY_EVENT_A, &reg);
186
187 /* Assume that key code 0 signifies empty FIFO */
188 while (error >= 0 && reg > 0) {
189 state = reg & KEY_EVENT_VALUE;
190 code = reg & KEY_EVENT_CODE;
191
192 row = code / TCA8418_MAX_COLS;
193 col = code % TCA8418_MAX_COLS;
194
195 row = (col) ? row : row - 1;
196 col = (col) ? col - 1 : TCA8418_MAX_COLS - 1;
197
198 code = MATRIX_SCAN_CODE(row, col, keypad_data->row_shift);
199 input_event(keypad_data->input, EV_MSC, MSC_SCAN, code);
200 input_report_key(keypad_data->input,
201 keypad_data->keymap[code], state);
202
203 /* Read for next loop */
204 error = tca8418_read_byte(keypad_data, REG_KEY_EVENT_A, &reg);
205 }
206
207 if (error < 0)
208 dev_err(&keypad_data->client->dev,
209 "unable to read REG_KEY_EVENT_A\n");
210
211 input_sync(keypad_data->input);
212}
213
214/*
215 * Threaded IRQ handler and this can (and will) sleep.
216 */
217static irqreturn_t tca8418_irq_handler(int irq, void *dev_id)
218{
219 struct tca8418_keypad *keypad_data = dev_id;
220 u8 reg;
221 int error;
222
223 error = tca8418_read_byte(keypad_data, REG_INT_STAT, &reg);
224 if (error) {
225 dev_err(&keypad_data->client->dev,
226 "unable to read REG_INT_STAT\n");
bf7f5316 227 return IRQ_NONE;
fb6c721b
KM
228 }
229
bf7f5316
AB
230 if (!reg)
231 return IRQ_NONE;
232
fb6c721b
KM
233 if (reg & INT_STAT_OVR_FLOW_INT)
234 dev_warn(&keypad_data->client->dev, "overflow occurred\n");
235
236 if (reg & INT_STAT_K_INT)
237 tca8418_read_keypad(keypad_data);
238
fb6c721b
KM
239 /* Clear all interrupts, even IRQs we didn't check (GPI, CAD, LCK) */
240 reg = 0xff;
241 error = tca8418_write_byte(keypad_data, REG_INT_STAT, reg);
242 if (error)
243 dev_err(&keypad_data->client->dev,
244 "unable to clear REG_INT_STAT\n");
245
246 return IRQ_HANDLED;
247}
248
249/*
250 * Configure the TCA8418 for keypad operation
251 */
e89e29b8
AB
252static int tca8418_configure(struct tca8418_keypad *keypad_data,
253 u32 rows, u32 cols)
fb6c721b
KM
254{
255 int reg, error;
256
257 /* Write config register, if this fails assume device not present */
258 error = tca8418_write_byte(keypad_data, REG_CFG,
259 CFG_INT_CFG | CFG_OVR_FLOW_IEN | CFG_KE_IEN);
260 if (error < 0)
261 return -ENODEV;
262
263
264 /* Assemble a mask for row and column registers */
e89e29b8
AB
265 reg = ~(~0 << rows);
266 reg += (~(~0 << cols)) << 8;
fb6c721b
KM
267
268 /* Set registers to keypad mode */
269 error |= tca8418_write_byte(keypad_data, REG_KP_GPIO1, reg);
270 error |= tca8418_write_byte(keypad_data, REG_KP_GPIO2, reg >> 8);
271 error |= tca8418_write_byte(keypad_data, REG_KP_GPIO3, reg >> 16);
272
273 /* Enable column debouncing */
274 error |= tca8418_write_byte(keypad_data, REG_DEBOUNCE_DIS1, reg);
275 error |= tca8418_write_byte(keypad_data, REG_DEBOUNCE_DIS2, reg >> 8);
276 error |= tca8418_write_byte(keypad_data, REG_DEBOUNCE_DIS3, reg >> 16);
277
278 return error;
279}
280
5298cc4c 281static int tca8418_keypad_probe(struct i2c_client *client,
fb6c721b
KM
282 const struct i2c_device_id *id)
283{
efce8a41 284 struct device *dev = &client->dev;
fb6c721b 285 const struct tca8418_keypad_platform_data *pdata =
cdbe8a86 286 dev_get_platdata(dev);
fb6c721b
KM
287 struct tca8418_keypad *keypad_data;
288 struct input_dev *input;
e89e29b8
AB
289 const struct matrix_keymap_data *keymap_data = NULL;
290 u32 rows = 0, cols = 0;
291 bool rep = false;
292 bool irq_is_gpio = false;
fb6c721b
KM
293 int error, row_shift, max_keys;
294
295 /* Copy the platform data */
e89e29b8
AB
296 if (pdata) {
297 if (!pdata->keymap_data) {
efce8a41 298 dev_err(dev, "no keymap data defined\n");
e89e29b8
AB
299 return -EINVAL;
300 }
301 keymap_data = pdata->keymap_data;
302 rows = pdata->rows;
303 cols = pdata->cols;
304 rep = pdata->rep;
305 irq_is_gpio = pdata->irq_is_gpio;
306 } else {
efce8a41 307 struct device_node *np = dev->of_node;
e89e29b8
AB
308 of_property_read_u32(np, "keypad,num-rows", &rows);
309 of_property_read_u32(np, "keypad,num-columns", &cols);
310 rep = of_property_read_bool(np, "keypad,autorepeat");
fb6c721b
KM
311 }
312
e89e29b8 313 if (!rows || rows > TCA8418_MAX_ROWS) {
efce8a41 314 dev_err(dev, "invalid rows\n");
fb6c721b
KM
315 return -EINVAL;
316 }
317
e89e29b8 318 if (!cols || cols > TCA8418_MAX_COLS) {
efce8a41 319 dev_err(dev, "invalid columns\n");
fb6c721b
KM
320 return -EINVAL;
321 }
322
323 /* Check i2c driver capabilities */
324 if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE)) {
efce8a41 325 dev_err(dev, "%s adapter not supported\n",
fb6c721b
KM
326 dev_driver_string(&client->adapter->dev));
327 return -ENODEV;
328 }
329
e89e29b8
AB
330 row_shift = get_count_order(cols);
331 max_keys = rows << row_shift;
fb6c721b
KM
332
333 /* Allocate memory for keypad_data, keymap and input device */
334 keypad_data = kzalloc(sizeof(*keypad_data) +
335 max_keys * sizeof(keypad_data->keymap[0]), GFP_KERNEL);
336 if (!keypad_data)
337 return -ENOMEM;
338
fb6c721b
KM
339 keypad_data->client = client;
340 keypad_data->row_shift = row_shift;
341
342 /* Initialize the chip or fail if chip isn't present */
e89e29b8 343 error = tca8418_configure(keypad_data, rows, cols);
fb6c721b
KM
344 if (error < 0)
345 goto fail1;
346
347 /* Configure input device */
348 input = input_allocate_device();
349 if (!input) {
350 error = -ENOMEM;
351 goto fail1;
352 }
353 keypad_data->input = input;
354
355 input->name = client->name;
356 input->dev.parent = &client->dev;
357
358 input->id.bustype = BUS_I2C;
359 input->id.vendor = 0x0001;
360 input->id.product = 0x001;
361 input->id.version = 0x0001;
362
e89e29b8 363 error = matrix_keypad_build_keymap(keymap_data, NULL, rows, cols,
1932811f
DT
364 keypad_data->keymap, input);
365 if (error) {
efce8a41 366 dev_dbg(dev, "Failed to build keymap\n");
1932811f
DT
367 goto fail2;
368 }
fb6c721b 369
e89e29b8 370 if (rep)
fb6c721b 371 __set_bit(EV_REP, input->evbit);
fb6c721b
KM
372 input_set_capability(input, EV_MSC, MSC_SCAN);
373
374 input_set_drvdata(input, keypad_data);
375
e89e29b8 376 if (irq_is_gpio)
fb6c721b
KM
377 client->irq = gpio_to_irq(client->irq);
378
379 error = request_threaded_irq(client->irq, NULL, tca8418_irq_handler,
bf7f5316
AB
380 IRQF_TRIGGER_FALLING |
381 IRQF_SHARED |
382 IRQF_ONESHOT,
fb6c721b
KM
383 client->name, keypad_data);
384 if (error) {
efce8a41 385 dev_dbg(dev, "Unable to claim irq %d; error %d\n",
fb6c721b
KM
386 client->irq, error);
387 goto fail2;
388 }
389
390 error = input_register_device(input);
391 if (error) {
efce8a41
DT
392 dev_dbg(dev, "Unable to register input device, error: %d\n",
393 error);
fb6c721b
KM
394 goto fail3;
395 }
396
397 i2c_set_clientdata(client, keypad_data);
398 return 0;
399
400fail3:
401 free_irq(client->irq, keypad_data);
402fail2:
403 input_free_device(input);
404fail1:
405 kfree(keypad_data);
406 return error;
407}
408
e2619cf7 409static int tca8418_keypad_remove(struct i2c_client *client)
fb6c721b
KM
410{
411 struct tca8418_keypad *keypad_data = i2c_get_clientdata(client);
412
413 free_irq(keypad_data->client->irq, keypad_data);
414
415 input_unregister_device(keypad_data->input);
416
417 kfree(keypad_data);
418
419 return 0;
420}
421
fb6c721b
KM
422static struct i2c_driver tca8418_keypad_driver = {
423 .driver = {
424 .name = TCA8418_NAME,
425 .owner = THIS_MODULE,
e89e29b8 426 .of_match_table = of_match_ptr(tca8418_dt_ids),
fb6c721b
KM
427 },
428 .probe = tca8418_keypad_probe,
1cb0aa88 429 .remove = tca8418_keypad_remove,
fb6c721b
KM
430 .id_table = tca8418_id,
431};
432
433static int __init tca8418_keypad_init(void)
434{
435 return i2c_add_driver(&tca8418_keypad_driver);
436}
437subsys_initcall(tca8418_keypad_init);
438
439static void __exit tca8418_keypad_exit(void)
440{
441 i2c_del_driver(&tca8418_keypad_driver);
442}
443module_exit(tca8418_keypad_exit);
444
445MODULE_AUTHOR("Kyle Manna <kyle.manna@fuel7.com>");
446MODULE_DESCRIPTION("Keypad driver for TCA8418");
447MODULE_LICENSE("GPL");