1
2
3
4
5
6
7
8
9
10
11
12#include <linux/module.h>
13#include <linux/init.h>
14#include <linux/interrupt.h>
15#include <linux/input.h>
16#include <linux/platform_device.h>
17#include <linux/input/matrix_keypad.h>
18#include <linux/i2c.h>
19#include <linux/slab.h>
20#include <linux/mfd/tc3589x.h>
21
22
23#define TC3589x_MAX_KPROW 8
24#define TC3589x_MAX_KPCOL 12
25
26
27#define TC3589x_MAX_DEBOUNCE_SETTLE 0xFF
28#define DEDICATED_KEY_VAL 0xFF
29
30
31#define TC3589x_NO_PULL_MASK 0x0
32#define TC3589x_PULL_DOWN_MASK 0x1
33#define TC3589x_PULL_UP_MASK 0x2
34#define TC3589x_PULLUP_ALL_MASK 0xAA
35#define TC3589x_IO_PULL_VAL(index, mask) ((mask)<<((index)%4)*2))
36
37
38#define IOCFG_BALLCFG 0x01
39#define IOCFG_IG 0x08
40
41#define KP_EVCODE_COL_MASK 0x0F
42#define KP_EVCODE_ROW_MASK 0x70
43#define KP_RELEASE_EVT_MASK 0x80
44
45#define KP_ROW_SHIFT 4
46
47#define KP_NO_VALID_KEY_MASK 0x7F
48
49
50#define TC3589x_KBDRST 0x2
51#define TC3589x_IRQRST 0x10
52#define TC3589x_RESET_ALL 0x1B
53
54
55#define TC3589x_KBDMFS_EN 0x1
56
57
58#define KPD_CLK_EN 0x1
59
60
61#define IRQ_CLEAR 0x1
62
63
64#define TC3589x_EVT_LOSS_INT 0x8
65#define TC3589x_EVT_INT 0x4
66#define TC3589x_KBD_LOSS_INT 0x2
67#define TC3589x_KBD_INT 0x1
68
69
70#define TC3589x_EVT_INT_CLR 0x2
71#define TC3589x_KBD_INT_CLR 0x1
72
73
74
75
76
77
78
79
80
81
82
83struct tc_keypad {
84 struct tc3589x *tc3589x;
85 struct input_dev *input;
86 const struct tc3589x_keypad_platform_data *board;
87 unsigned int krow;
88 unsigned int kcol;
89 unsigned short *keymap;
90 bool keypad_stopped;
91};
92
93static int tc3589x_keypad_init_key_hardware(struct tc_keypad *keypad)
94{
95 int ret;
96 struct tc3589x *tc3589x = keypad->tc3589x;
97 const struct tc3589x_keypad_platform_data *board = keypad->board;
98
99
100 if (board->kcol > TC3589x_MAX_KPCOL || board->krow > TC3589x_MAX_KPROW)
101 return -EINVAL;
102
103
104 ret = tc3589x_reg_write(tc3589x, TC3589x_KBDSIZE,
105 (board->krow << KP_ROW_SHIFT) | board->kcol);
106 if (ret < 0)
107 return ret;
108
109
110 ret = tc3589x_reg_write(tc3589x, TC3589x_KBCFG_LSB, DEDICATED_KEY_VAL);
111 if (ret < 0)
112 return ret;
113
114 ret = tc3589x_reg_write(tc3589x, TC3589x_KBCFG_MSB, DEDICATED_KEY_VAL);
115 if (ret < 0)
116 return ret;
117
118
119 ret = tc3589x_reg_write(tc3589x, TC3589x_KBDSETTLE_REG,
120 board->settle_time);
121 if (ret < 0)
122 return ret;
123
124
125 ret = tc3589x_reg_write(tc3589x, TC3589x_KBDBOUNCE,
126 board->debounce_period);
127 if (ret < 0)
128 return ret;
129
130
131 ret = tc3589x_set_bits(tc3589x, TC3589x_IOCFG, 0x0, IOCFG_IG);
132 if (ret < 0)
133 return ret;
134
135
136 ret = tc3589x_reg_write(tc3589x, TC3589x_IOPULLCFG0_LSB,
137 TC3589x_PULLUP_ALL_MASK);
138 if (ret < 0)
139 return ret;
140
141 ret = tc3589x_reg_write(tc3589x, TC3589x_IOPULLCFG0_MSB,
142 TC3589x_PULLUP_ALL_MASK);
143 if (ret < 0)
144 return ret;
145
146
147 ret = tc3589x_reg_write(tc3589x, TC3589x_IOPULLCFG1_LSB,
148 TC3589x_PULLUP_ALL_MASK);
149 if (ret < 0)
150 return ret;
151
152 ret = tc3589x_reg_write(tc3589x, TC3589x_IOPULLCFG1_MSB,
153 TC3589x_PULLUP_ALL_MASK);
154 if (ret < 0)
155 return ret;
156
157 ret = tc3589x_reg_write(tc3589x, TC3589x_IOPULLCFG2_LSB,
158 TC3589x_PULLUP_ALL_MASK);
159
160 return ret;
161}
162
163#define TC35893_DATA_REGS 4
164#define TC35893_KEYCODE_FIFO_EMPTY 0x7f
165#define TC35893_KEYCODE_FIFO_CLEAR 0xff
166#define TC35893_KEYPAD_ROW_SHIFT 0x3
167
168static irqreturn_t tc3589x_keypad_irq(int irq, void *dev)
169{
170 struct tc_keypad *keypad = dev;
171 struct tc3589x *tc3589x = keypad->tc3589x;
172 u8 i, row_index, col_index, kbd_code, up;
173 u8 code;
174
175 for (i = 0; i < TC35893_DATA_REGS * 2; i++) {
176 kbd_code = tc3589x_reg_read(tc3589x, TC3589x_EVTCODE_FIFO);
177
178
179 if (kbd_code == TC35893_KEYCODE_FIFO_EMPTY ||
180 kbd_code == TC35893_KEYCODE_FIFO_CLEAR)
181 continue;
182
183
184 col_index = kbd_code & KP_EVCODE_COL_MASK;
185 row_index = (kbd_code & KP_EVCODE_ROW_MASK) >> KP_ROW_SHIFT;
186 code = MATRIX_SCAN_CODE(row_index, col_index,
187 TC35893_KEYPAD_ROW_SHIFT);
188 up = kbd_code & KP_RELEASE_EVT_MASK;
189
190 input_event(keypad->input, EV_MSC, MSC_SCAN, code);
191 input_report_key(keypad->input, keypad->keymap[code], !up);
192 input_sync(keypad->input);
193 }
194
195
196 tc3589x_set_bits(tc3589x, TC3589x_KBDIC,
197 0x0, TC3589x_EVT_INT_CLR | TC3589x_KBD_INT_CLR);
198
199 tc3589x_set_bits(tc3589x, TC3589x_KBDMSK,
200 0x0, TC3589x_EVT_LOSS_INT | TC3589x_EVT_INT);
201
202 return IRQ_HANDLED;
203}
204
205static int tc3589x_keypad_enable(struct tc_keypad *keypad)
206{
207 struct tc3589x *tc3589x = keypad->tc3589x;
208 int ret;
209
210
211 ret = tc3589x_set_bits(tc3589x, TC3589x_RSTCTRL, TC3589x_KBDRST, 0x0);
212 if (ret < 0)
213 return ret;
214
215
216 ret = tc3589x_set_bits(tc3589x, TC3589x_KBDMFS, 0x0, TC3589x_KBDMFS_EN);
217 if (ret < 0)
218 return ret;
219
220
221 ret = tc3589x_set_bits(tc3589x, TC3589x_CLKEN, 0x0, KPD_CLK_EN);
222 if (ret < 0)
223 return ret;
224
225
226 ret = tc3589x_set_bits(tc3589x, TC3589x_RSTINTCLR, 0x0, 0x1);
227 if (ret < 0)
228 return ret;
229
230
231 ret = tc3589x_set_bits(tc3589x, TC3589x_KBDMSK, 0x0,
232 TC3589x_EVT_LOSS_INT | TC3589x_EVT_INT);
233 if (ret < 0)
234 return ret;
235
236 keypad->keypad_stopped = false;
237
238 return ret;
239}
240
241static int tc3589x_keypad_disable(struct tc_keypad *keypad)
242{
243 struct tc3589x *tc3589x = keypad->tc3589x;
244 int ret;
245
246
247 ret = tc3589x_set_bits(tc3589x, TC3589x_KBDIC,
248 0x0, TC3589x_EVT_INT_CLR | TC3589x_KBD_INT_CLR);
249 if (ret < 0)
250 return ret;
251
252
253 ret = tc3589x_set_bits(tc3589x, TC3589x_KBDMSK,
254 ~(TC3589x_EVT_LOSS_INT | TC3589x_EVT_INT), 0x0);
255 if (ret < 0)
256 return ret;
257
258
259 ret = tc3589x_set_bits(tc3589x, TC3589x_CLKEN, 0x1, 0x0);
260 if (ret < 0)
261 return ret;
262
263
264 ret = tc3589x_set_bits(tc3589x, TC3589x_RSTCTRL, TC3589x_KBDRST, 0x1);
265
266 keypad->keypad_stopped = true;
267
268 return ret;
269}
270
271static int tc3589x_keypad_open(struct input_dev *input)
272{
273 int error;
274 struct tc_keypad *keypad = input_get_drvdata(input);
275
276
277 error = tc3589x_keypad_enable(keypad);
278 if (error < 0) {
279 dev_err(&input->dev, "failed to enable keypad module\n");
280 return error;
281 }
282
283 error = tc3589x_keypad_init_key_hardware(keypad);
284 if (error < 0) {
285 dev_err(&input->dev, "failed to configure keypad module\n");
286 return error;
287 }
288
289 return 0;
290}
291
292static void tc3589x_keypad_close(struct input_dev *input)
293{
294 struct tc_keypad *keypad = input_get_drvdata(input);
295
296
297 tc3589x_keypad_disable(keypad);
298}
299
300static int tc3589x_keypad_probe(struct platform_device *pdev)
301{
302 struct tc3589x *tc3589x = dev_get_drvdata(pdev->dev.parent);
303 struct tc_keypad *keypad;
304 struct input_dev *input;
305 const struct tc3589x_keypad_platform_data *plat;
306 int error, irq;
307
308 plat = tc3589x->pdata->keypad;
309 if (!plat) {
310 dev_err(&pdev->dev, "invalid keypad platform data\n");
311 return -EINVAL;
312 }
313
314 irq = platform_get_irq(pdev, 0);
315 if (irq < 0)
316 return irq;
317
318 keypad = kzalloc(sizeof(struct tc_keypad), GFP_KERNEL);
319 input = input_allocate_device();
320 if (!keypad || !input) {
321 dev_err(&pdev->dev, "failed to allocate keypad memory\n");
322 error = -ENOMEM;
323 goto err_free_mem;
324 }
325
326 keypad->board = plat;
327 keypad->input = input;
328 keypad->tc3589x = tc3589x;
329
330 input->id.bustype = BUS_I2C;
331 input->name = pdev->name;
332 input->dev.parent = &pdev->dev;
333
334 input->open = tc3589x_keypad_open;
335 input->close = tc3589x_keypad_close;
336
337 error = matrix_keypad_build_keymap(plat->keymap_data, NULL,
338 TC3589x_MAX_KPROW, TC3589x_MAX_KPCOL,
339 NULL, input);
340 if (error) {
341 dev_err(&pdev->dev, "Failed to build keymap\n");
342 goto err_free_mem;
343 }
344
345 keypad->keymap = input->keycode;
346
347 input_set_capability(input, EV_MSC, MSC_SCAN);
348 if (!plat->no_autorepeat)
349 __set_bit(EV_REP, input->evbit);
350
351 input_set_drvdata(input, keypad);
352
353 error = request_threaded_irq(irq, NULL,
354 tc3589x_keypad_irq, plat->irqtype,
355 "tc3589x-keypad", keypad);
356 if (error < 0) {
357 dev_err(&pdev->dev,
358 "Could not allocate irq %d,error %d\n",
359 irq, error);
360 goto err_free_mem;
361 }
362
363 error = input_register_device(input);
364 if (error) {
365 dev_err(&pdev->dev, "Could not register input device\n");
366 goto err_free_irq;
367 }
368
369
370 device_init_wakeup(&pdev->dev, plat->enable_wakeup);
371 device_set_wakeup_capable(&pdev->dev, plat->enable_wakeup);
372
373 platform_set_drvdata(pdev, keypad);
374
375 return 0;
376
377err_free_irq:
378 free_irq(irq, keypad);
379err_free_mem:
380 input_free_device(input);
381 kfree(keypad);
382 return error;
383}
384
385static int tc3589x_keypad_remove(struct platform_device *pdev)
386{
387 struct tc_keypad *keypad = platform_get_drvdata(pdev);
388 int irq = platform_get_irq(pdev, 0);
389
390 if (!keypad->keypad_stopped)
391 tc3589x_keypad_disable(keypad);
392
393 free_irq(irq, keypad);
394
395 input_unregister_device(keypad->input);
396
397 kfree(keypad);
398
399 return 0;
400}
401
402#ifdef CONFIG_PM_SLEEP
403static int tc3589x_keypad_suspend(struct device *dev)
404{
405 struct platform_device *pdev = to_platform_device(dev);
406 struct tc_keypad *keypad = platform_get_drvdata(pdev);
407 int irq = platform_get_irq(pdev, 0);
408
409
410 if (keypad->keypad_stopped)
411 return 0;
412
413
414 if (!device_may_wakeup(&pdev->dev))
415 tc3589x_keypad_disable(keypad);
416 else
417 enable_irq_wake(irq);
418
419 return 0;
420}
421
422static int tc3589x_keypad_resume(struct device *dev)
423{
424 struct platform_device *pdev = to_platform_device(dev);
425 struct tc_keypad *keypad = platform_get_drvdata(pdev);
426 int irq = platform_get_irq(pdev, 0);
427
428 if (!keypad->keypad_stopped)
429 return 0;
430
431
432 if (!device_may_wakeup(&pdev->dev))
433 tc3589x_keypad_enable(keypad);
434 else
435 disable_irq_wake(irq);
436
437 return 0;
438}
439#endif
440
441static SIMPLE_DEV_PM_OPS(tc3589x_keypad_dev_pm_ops,
442 tc3589x_keypad_suspend, tc3589x_keypad_resume);
443
444static struct platform_driver tc3589x_keypad_driver = {
445 .driver = {
446 .name = "tc3589x-keypad",
447 .owner = THIS_MODULE,
448 .pm = &tc3589x_keypad_dev_pm_ops,
449 },
450 .probe = tc3589x_keypad_probe,
451 .remove = tc3589x_keypad_remove,
452};
453module_platform_driver(tc3589x_keypad_driver);
454
455MODULE_LICENSE("GPL v2");
456MODULE_AUTHOR("Jayeeta Banerjee/Sundar Iyer");
457MODULE_DESCRIPTION("TC35893 Keypad Driver");
458MODULE_ALIAS("platform:tc3589x-keypad");
459
