1 /* Copyright (c) 2009-2011, Code Aurora Forum. All rights reserved.
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License version 2 and
5 * only version 2 as published by the Free Software Foundation.
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
13 #include <linux/module.h>
14 #include <linux/platform_device.h>
15 #include <linux/kernel.h>
16 #include <linux/interrupt.h>
17 #include <linux/slab.h>
18 #include <linux/input.h>
19 #include <linux/bitops.h>
20 #include <linux/delay.h>
21 #include <linux/mutex.h>
23 #include <linux/mfd/pm8xxx/core.h>
24 #include <linux/input/pmic8xxx-keypad.h>
26 #define PM8XXX_MAX_ROWS 18
27 #define PM8XXX_MAX_COLS 8
28 #define PM8XXX_ROW_SHIFT 3
29 #define PM8XXX_MATRIX_MAX_SIZE (PM8XXX_MAX_ROWS * PM8XXX_MAX_COLS)
31 #define PM8XXX_MIN_ROWS 5
32 #define PM8XXX_MIN_COLS 5
34 #define MAX_SCAN_DELAY 128
35 #define MIN_SCAN_DELAY 1
38 #define MAX_ROW_HOLD_DELAY 122000
39 #define MIN_ROW_HOLD_DELAY 30500
41 #define MAX_DEBOUNCE_TIME 20
42 #define MIN_DEBOUNCE_TIME 5
44 #define KEYP_CTRL 0x148
46 #define KEYP_CTRL_EVNTS BIT(0)
47 #define KEYP_CTRL_EVNTS_MASK 0x3
49 #define KEYP_CTRL_SCAN_COLS_SHIFT 5
50 #define KEYP_CTRL_SCAN_COLS_MIN 5
51 #define KEYP_CTRL_SCAN_COLS_BITS 0x3
53 #define KEYP_CTRL_SCAN_ROWS_SHIFT 2
54 #define KEYP_CTRL_SCAN_ROWS_MIN 5
55 #define KEYP_CTRL_SCAN_ROWS_BITS 0x7
57 #define KEYP_CTRL_KEYP_EN BIT(7)
59 #define KEYP_SCAN 0x149
61 #define KEYP_SCAN_READ_STATE BIT(0)
62 #define KEYP_SCAN_DBOUNCE_SHIFT 1
63 #define KEYP_SCAN_PAUSE_SHIFT 3
64 #define KEYP_SCAN_ROW_HOLD_SHIFT 6
66 #define KEYP_TEST 0x14A
68 #define KEYP_TEST_CLEAR_RECENT_SCAN BIT(6)
69 #define KEYP_TEST_CLEAR_OLD_SCAN BIT(5)
70 #define KEYP_TEST_READ_RESET BIT(4)
71 #define KEYP_TEST_DTEST_EN BIT(3)
72 #define KEYP_TEST_ABORT_READ BIT(0)
74 #define KEYP_TEST_DBG_SELECT_SHIFT 1
76 /* bits of these registers represent
80 #define KEYP_RECENT_DATA 0x14B
81 #define KEYP_OLD_DATA 0x14C
83 #define KEYP_CLOCK_FREQ 32768
86 * struct pmic8xxx_kp - internal keypad data structure
87 * @pdata - keypad platform data pointer
88 * @input - input device pointer for keypad
89 * @key_sense_irq - key press/release irq number
90 * @key_stuck_irq - key stuck notification irq number
91 * @keycodes - array to hold the key codes
92 * @dev - parent device pointer
93 * @keystate - present key press/release state
94 * @stuckstate - present state when key stuck irq
95 * @ctrl_reg - control register value
98 const struct pm8xxx_keypad_platform_data *pdata;
99 struct input_dev *input;
103 unsigned short keycodes[PM8XXX_MATRIX_MAX_SIZE];
106 u16 keystate[PM8XXX_MAX_ROWS];
107 u16 stuckstate[PM8XXX_MAX_ROWS];
112 static int pmic8xxx_kp_write_u8(struct pmic8xxx_kp *kp,
117 rc = pm8xxx_writeb(kp->dev->parent, reg, data);
121 static int pmic8xxx_kp_read(struct pmic8xxx_kp *kp,
122 u8 *data, u16 reg, unsigned num_bytes)
126 rc = pm8xxx_read_buf(kp->dev->parent, reg, data, num_bytes);
130 static int pmic8xxx_kp_read_u8(struct pmic8xxx_kp *kp,
135 rc = pmic8xxx_kp_read(kp, data, reg, 1);
139 static u8 pmic8xxx_col_state(struct pmic8xxx_kp *kp, u8 col)
141 /* all keys pressed on that particular row? */
143 return 1 << kp->pdata->num_cols;
145 return col & ((1 << kp->pdata->num_cols) - 1);
149 * Synchronous read protocol for RevB0 onwards:
151 * 1. Write '1' to ReadState bit in KEYP_SCAN register
152 * 2. Wait 2*32KHz clocks, so that HW can successfully enter read mode
154 * 3. Read rows in old array first if events are more than one
155 * 4. Read rows in recent array
156 * 5. Wait 4*32KHz clocks
157 * 6. Write '0' to ReadState bit of KEYP_SCAN register so that hw can
158 * synchronously exit read mode.
160 static int pmic8xxx_chk_sync_read(struct pmic8xxx_kp *kp)
165 rc = pmic8xxx_kp_read_u8(kp, &scan_val, KEYP_SCAN);
167 dev_err(kp->dev, "Error reading KEYP_SCAN reg, rc=%d\n", rc);
173 rc = pmic8xxx_kp_write_u8(kp, scan_val, KEYP_SCAN);
175 dev_err(kp->dev, "Error writing KEYP_SCAN reg, rc=%d\n", rc);
179 /* 2 * 32KHz clocks */
180 udelay((2 * DIV_ROUND_UP(USEC_PER_SEC, KEYP_CLOCK_FREQ)) + 1);
185 static int pmic8xxx_kp_read_data(struct pmic8xxx_kp *kp, u16 *state,
186 u16 data_reg, int read_rows)
189 u8 new_data[PM8XXX_MAX_ROWS];
191 rc = pmic8xxx_kp_read(kp, new_data, data_reg, read_rows);
195 for (row = 0; row < kp->pdata->num_rows; row++) {
196 dev_dbg(kp->dev, "new_data[%d] = %d\n", row,
198 state[row] = pmic8xxx_col_state(kp, new_data[row]);
204 static int pmic8xxx_kp_read_matrix(struct pmic8xxx_kp *kp, u16 *new_state,
210 if (kp->pdata->num_rows < PM8XXX_MIN_ROWS)
211 read_rows = PM8XXX_MIN_ROWS;
213 read_rows = kp->pdata->num_rows;
215 pmic8xxx_chk_sync_read(kp);
218 rc = pmic8xxx_kp_read_data(kp, old_state, KEYP_OLD_DATA,
222 "Error reading KEYP_OLD_DATA, rc=%d\n", rc);
227 rc = pmic8xxx_kp_read_data(kp, new_state, KEYP_RECENT_DATA,
231 "Error reading KEYP_RECENT_DATA, rc=%d\n", rc);
235 /* 4 * 32KHz clocks */
236 udelay((4 * DIV_ROUND_UP(USEC_PER_SEC, KEYP_CLOCK_FREQ)) + 1);
238 rc = pmic8xxx_kp_read_u8(kp, &scan_val, KEYP_SCAN);
240 dev_err(kp->dev, "Error reading KEYP_SCAN reg, rc=%d\n", rc);
245 rc = pmic8xxx_kp_write_u8(kp, scan_val, KEYP_SCAN);
247 dev_err(kp->dev, "Error writing KEYP_SCAN reg, rc=%d\n", rc);
252 static void __pmic8xxx_kp_scan_matrix(struct pmic8xxx_kp *kp, u16 *new_state,
257 for (row = 0; row < kp->pdata->num_rows; row++) {
258 int bits_changed = new_state[row] ^ old_state[row];
263 for (col = 0; col < kp->pdata->num_cols; col++) {
264 if (!(bits_changed & (1 << col)))
267 dev_dbg(kp->dev, "key [%d:%d] %s\n", row, col,
268 !(new_state[row] & (1 << col)) ?
269 "pressed" : "released");
271 code = MATRIX_SCAN_CODE(row, col, PM8XXX_ROW_SHIFT);
273 input_event(kp->input, EV_MSC, MSC_SCAN, code);
274 input_report_key(kp->input,
276 !(new_state[row] & (1 << col)));
278 input_sync(kp->input);
283 static bool pmic8xxx_detect_ghost_keys(struct pmic8xxx_kp *kp, u16 *new_state)
285 int row, found_first = -1;
286 u16 check, row_state;
289 for (row = 0; row < kp->pdata->num_rows; row++) {
290 row_state = (~new_state[row]) &
291 ((1 << kp->pdata->num_cols) - 1);
293 if (hweight16(row_state) > 1) {
294 if (found_first == -1)
296 if (check & row_state) {
297 dev_dbg(kp->dev, "detected ghost key on row[%d]"
298 " and row[%d]\n", found_first, row);
307 static int pmic8xxx_kp_scan_matrix(struct pmic8xxx_kp *kp, unsigned int events)
309 u16 new_state[PM8XXX_MAX_ROWS];
310 u16 old_state[PM8XXX_MAX_ROWS];
315 rc = pmic8xxx_kp_read_matrix(kp, new_state, NULL);
319 /* detecting ghost key is not an error */
320 if (pmic8xxx_detect_ghost_keys(kp, new_state))
322 __pmic8xxx_kp_scan_matrix(kp, new_state, kp->keystate);
323 memcpy(kp->keystate, new_state, sizeof(new_state));
325 case 0x3: /* two events - eventcounter is gray-coded */
326 rc = pmic8xxx_kp_read_matrix(kp, new_state, old_state);
330 __pmic8xxx_kp_scan_matrix(kp, old_state, kp->keystate);
331 __pmic8xxx_kp_scan_matrix(kp, new_state, old_state);
332 memcpy(kp->keystate, new_state, sizeof(new_state));
335 dev_dbg(kp->dev, "Some key events were lost\n");
336 rc = pmic8xxx_kp_read_matrix(kp, new_state, old_state);
339 __pmic8xxx_kp_scan_matrix(kp, old_state, kp->keystate);
340 __pmic8xxx_kp_scan_matrix(kp, new_state, old_state);
341 memcpy(kp->keystate, new_state, sizeof(new_state));
350 * NOTE: We are reading recent and old data registers blindly
351 * whenever key-stuck interrupt happens, because events counter doesn't
352 * get updated when this interrupt happens due to key stuck doesn't get
353 * considered as key state change.
355 * We are not using old data register contents after they are being read
356 * because it might report the key which was pressed before the key being stuck
357 * as stuck key because it's pressed status is stored in the old data
360 static irqreturn_t pmic8xxx_kp_stuck_irq(int irq, void *data)
362 u16 new_state[PM8XXX_MAX_ROWS];
363 u16 old_state[PM8XXX_MAX_ROWS];
365 struct pmic8xxx_kp *kp = data;
367 rc = pmic8xxx_kp_read_matrix(kp, new_state, old_state);
369 dev_err(kp->dev, "failed to read keypad matrix\n");
373 __pmic8xxx_kp_scan_matrix(kp, new_state, kp->stuckstate);
378 static irqreturn_t pmic8xxx_kp_irq(int irq, void *data)
380 struct pmic8xxx_kp *kp = data;
384 rc = pmic8xxx_kp_read(kp, &ctrl_val, KEYP_CTRL, 1);
386 dev_err(kp->dev, "failed to read keyp_ctrl register\n");
390 events = ctrl_val & KEYP_CTRL_EVNTS_MASK;
392 rc = pmic8xxx_kp_scan_matrix(kp, events);
394 dev_err(kp->dev, "failed to scan matrix\n");
399 static int pmic8xxx_kpd_init(struct pmic8xxx_kp *kp)
401 int bits, rc, cycles;
402 u8 scan_val = 0, ctrl_val = 0;
403 static const u8 row_bits[] = {
404 0, 1, 2, 3, 4, 4, 5, 5, 6, 6, 6, 7, 7, 7,
407 /* Find column bits */
408 if (kp->pdata->num_cols < KEYP_CTRL_SCAN_COLS_MIN)
411 bits = kp->pdata->num_cols - KEYP_CTRL_SCAN_COLS_MIN;
412 ctrl_val = (bits & KEYP_CTRL_SCAN_COLS_BITS) <<
413 KEYP_CTRL_SCAN_COLS_SHIFT;
416 if (kp->pdata->num_rows < KEYP_CTRL_SCAN_ROWS_MIN)
419 bits = row_bits[kp->pdata->num_rows - KEYP_CTRL_SCAN_ROWS_MIN];
421 ctrl_val |= (bits << KEYP_CTRL_SCAN_ROWS_SHIFT);
423 rc = pmic8xxx_kp_write_u8(kp, ctrl_val, KEYP_CTRL);
425 dev_err(kp->dev, "Error writing KEYP_CTRL reg, rc=%d\n", rc);
429 bits = (kp->pdata->debounce_ms / 5) - 1;
431 scan_val |= (bits << KEYP_SCAN_DBOUNCE_SHIFT);
433 bits = fls(kp->pdata->scan_delay_ms) - 1;
434 scan_val |= (bits << KEYP_SCAN_PAUSE_SHIFT);
436 /* Row hold time is a multiple of 32KHz cycles. */
437 cycles = (kp->pdata->row_hold_ns * KEYP_CLOCK_FREQ) / NSEC_PER_SEC;
439 scan_val |= (cycles << KEYP_SCAN_ROW_HOLD_SHIFT);
441 rc = pmic8xxx_kp_write_u8(kp, scan_val, KEYP_SCAN);
443 dev_err(kp->dev, "Error writing KEYP_SCAN reg, rc=%d\n", rc);
449 static int pmic8xxx_kp_enable(struct pmic8xxx_kp *kp)
453 kp->ctrl_reg |= KEYP_CTRL_KEYP_EN;
455 rc = pmic8xxx_kp_write_u8(kp, kp->ctrl_reg, KEYP_CTRL);
457 dev_err(kp->dev, "Error writing KEYP_CTRL reg, rc=%d\n", rc);
462 static int pmic8xxx_kp_disable(struct pmic8xxx_kp *kp)
466 kp->ctrl_reg &= ~KEYP_CTRL_KEYP_EN;
468 rc = pmic8xxx_kp_write_u8(kp, kp->ctrl_reg, KEYP_CTRL);
475 static int pmic8xxx_kp_open(struct input_dev *dev)
477 struct pmic8xxx_kp *kp = input_get_drvdata(dev);
479 return pmic8xxx_kp_enable(kp);
482 static void pmic8xxx_kp_close(struct input_dev *dev)
484 struct pmic8xxx_kp *kp = input_get_drvdata(dev);
486 pmic8xxx_kp_disable(kp);
490 * keypad controller should be initialized in the following sequence
491 * only, otherwise it might get into FSM stuck state.
493 * - Initialize keypad control parameters, like no. of rows, columns,
494 * timing values etc.,
495 * - configure rows and column gpios pull up/down.
496 * - set irq edge type.
497 * - enable the keypad controller.
499 static int pmic8xxx_kp_probe(struct platform_device *pdev)
501 const struct pm8xxx_keypad_platform_data *pdata =
502 dev_get_platdata(&pdev->dev);
503 const struct matrix_keymap_data *keymap_data;
504 struct pmic8xxx_kp *kp;
508 if (!pdata || !pdata->num_cols || !pdata->num_rows ||
509 pdata->num_cols > PM8XXX_MAX_COLS ||
510 pdata->num_rows > PM8XXX_MAX_ROWS ||
511 pdata->num_cols < PM8XXX_MIN_COLS) {
512 dev_err(&pdev->dev, "invalid platform data\n");
516 if (!pdata->scan_delay_ms ||
517 pdata->scan_delay_ms > MAX_SCAN_DELAY ||
518 pdata->scan_delay_ms < MIN_SCAN_DELAY ||
519 !is_power_of_2(pdata->scan_delay_ms)) {
520 dev_err(&pdev->dev, "invalid keypad scan time supplied\n");
524 if (!pdata->row_hold_ns ||
525 pdata->row_hold_ns > MAX_ROW_HOLD_DELAY ||
526 pdata->row_hold_ns < MIN_ROW_HOLD_DELAY ||
527 ((pdata->row_hold_ns % MIN_ROW_HOLD_DELAY) != 0)) {
528 dev_err(&pdev->dev, "invalid keypad row hold time supplied\n");
532 if (!pdata->debounce_ms ||
533 ((pdata->debounce_ms % 5) != 0) ||
534 pdata->debounce_ms > MAX_DEBOUNCE_TIME ||
535 pdata->debounce_ms < MIN_DEBOUNCE_TIME) {
536 dev_err(&pdev->dev, "invalid debounce time supplied\n");
540 keymap_data = pdata->keymap_data;
542 dev_err(&pdev->dev, "no keymap data supplied\n");
546 kp = devm_kzalloc(&pdev->dev, sizeof(*kp), GFP_KERNEL);
550 platform_set_drvdata(pdev, kp);
553 kp->dev = &pdev->dev;
555 kp->input = devm_input_allocate_device(&pdev->dev);
557 dev_err(&pdev->dev, "unable to allocate input device\n");
561 kp->key_sense_irq = platform_get_irq(pdev, 0);
562 if (kp->key_sense_irq < 0) {
563 dev_err(&pdev->dev, "unable to get keypad sense irq\n");
564 return kp->key_sense_irq;
567 kp->key_stuck_irq = platform_get_irq(pdev, 1);
568 if (kp->key_stuck_irq < 0) {
569 dev_err(&pdev->dev, "unable to get keypad stuck irq\n");
570 return kp->key_stuck_irq;
573 kp->input->name = pdata->input_name ? : "PMIC8XXX keypad";
574 kp->input->phys = pdata->input_phys_device ? : "pmic8xxx_keypad/input0";
576 kp->input->id.bustype = BUS_I2C;
577 kp->input->id.version = 0x0001;
578 kp->input->id.product = 0x0001;
579 kp->input->id.vendor = 0x0001;
581 kp->input->open = pmic8xxx_kp_open;
582 kp->input->close = pmic8xxx_kp_close;
584 rc = matrix_keypad_build_keymap(keymap_data, NULL,
585 PM8XXX_MAX_ROWS, PM8XXX_MAX_COLS,
586 kp->keycodes, kp->input);
588 dev_err(&pdev->dev, "failed to build keymap\n");
593 __set_bit(EV_REP, kp->input->evbit);
594 input_set_capability(kp->input, EV_MSC, MSC_SCAN);
596 input_set_drvdata(kp->input, kp);
598 /* initialize keypad state */
599 memset(kp->keystate, 0xff, sizeof(kp->keystate));
600 memset(kp->stuckstate, 0xff, sizeof(kp->stuckstate));
602 rc = pmic8xxx_kpd_init(kp);
604 dev_err(&pdev->dev, "unable to initialize keypad controller\n");
608 rc = devm_request_any_context_irq(&pdev->dev, kp->key_sense_irq,
609 pmic8xxx_kp_irq, IRQF_TRIGGER_RISING, "pmic-keypad",
612 dev_err(&pdev->dev, "failed to request keypad sense irq\n");
616 rc = devm_request_any_context_irq(&pdev->dev, kp->key_stuck_irq,
617 pmic8xxx_kp_stuck_irq, IRQF_TRIGGER_RISING,
618 "pmic-keypad-stuck", kp);
620 dev_err(&pdev->dev, "failed to request keypad stuck irq\n");
624 rc = pmic8xxx_kp_read_u8(kp, &ctrl_val, KEYP_CTRL);
626 dev_err(&pdev->dev, "failed to read KEYP_CTRL register\n");
630 kp->ctrl_reg = ctrl_val;
632 rc = input_register_device(kp->input);
634 dev_err(&pdev->dev, "unable to register keypad input device\n");
638 device_init_wakeup(&pdev->dev, pdata->wakeup);
643 #ifdef CONFIG_PM_SLEEP
644 static int pmic8xxx_kp_suspend(struct device *dev)
646 struct platform_device *pdev = to_platform_device(dev);
647 struct pmic8xxx_kp *kp = platform_get_drvdata(pdev);
648 struct input_dev *input_dev = kp->input;
650 if (device_may_wakeup(dev)) {
651 enable_irq_wake(kp->key_sense_irq);
653 mutex_lock(&input_dev->mutex);
655 if (input_dev->users)
656 pmic8xxx_kp_disable(kp);
658 mutex_unlock(&input_dev->mutex);
664 static int pmic8xxx_kp_resume(struct device *dev)
666 struct platform_device *pdev = to_platform_device(dev);
667 struct pmic8xxx_kp *kp = platform_get_drvdata(pdev);
668 struct input_dev *input_dev = kp->input;
670 if (device_may_wakeup(dev)) {
671 disable_irq_wake(kp->key_sense_irq);
673 mutex_lock(&input_dev->mutex);
675 if (input_dev->users)
676 pmic8xxx_kp_enable(kp);
678 mutex_unlock(&input_dev->mutex);
685 static SIMPLE_DEV_PM_OPS(pm8xxx_kp_pm_ops,
686 pmic8xxx_kp_suspend, pmic8xxx_kp_resume);
688 static struct platform_driver pmic8xxx_kp_driver = {
689 .probe = pmic8xxx_kp_probe,
691 .name = PM8XXX_KEYPAD_DEV_NAME,
692 .owner = THIS_MODULE,
693 .pm = &pm8xxx_kp_pm_ops,
696 module_platform_driver(pmic8xxx_kp_driver);
698 MODULE_LICENSE("GPL v2");
699 MODULE_DESCRIPTION("PMIC8XXX keypad driver");
700 MODULE_VERSION("1.0");
701 MODULE_ALIAS("platform:pmic8xxx_keypad");
702 MODULE_AUTHOR("Trilok Soni <tsoni@codeaurora.org>");