From 48d162206e908e4a0cc93aaa62eb93abbad3f785 Mon Sep 17 00:00:00 2001 From: Klaus Pedersen Date: Wed, 2 Apr 2008 11:42:29 +0300 Subject: [PATCH] I2C: TWL4030 keyboard driver enhancements While getting trying to get the keyboard driver to accept my keyboard layout I found and fixed a few bugs. - Fixed the driver to respect the matrix size and .rep fields from "struct omap_kp_platform_data" - Fixed misc. configuration problems. - Fixed some problems with the interrupt/polling code by implementing 100% event driven scan handling (there was a race between the timer and interrupt initiated calls to twl_4030_kp_scan()). - Too many interrupts was delivered -> enable "PENDING_DISABLE". - The controller would hang with keys stuck on -> program KEYP_TIMEOUT so sensible timeout. Other enhancements: - Simple ghost key suppression. - Support for non-matrix switches. That is switches connected between GND and a row. To configure the driver for the non-matrix switches you add the key as you normally would, but the col-index will have to be the same value as the col-size. For example with .cols = 2 and you will use the value "2" for COL for the two non-matrix switches: static int rocket_control_keymap[] = { /* COL ROW */ KEY(0, 0, KEY_3), KEY(0, 1, KEY_2), KEY(1, 0, KEY_1), KEY(1, 1, KEY_LAUNCH), KEY(2, 0, KEY_ABORT), KEY(2, 1, KEY_SD), 0 } Cleanup: I might have gone too far when fixing the twl4030-keypad.h file, but I was loosing breath and attention spelling my way through these 32+ letter identifiers with names like: BIT_KEYP_CTRL_REG_TOLE_EN_MASK which is a bit in the register: REG_KEYP_CTRL_REG leading to statements like: twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, BIT_KEYP_CTRL_REG_TOLE_EN_MASK, REG_KEYP_CTRL_REG); What I did was to take out all the redundant stuff like BIT, REG and MASK, making reading a little easier: twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, KEYP_CTRL_TOLE_EN, KEYP_CTRL); There was a lot of configuration stuff in header file that wasn't really needed. I think I even found a joke: .h had this line: #define BIT_PTV_REG_PTV4 (0x4) .c had this: /* Set Pre Scalar Field PTV to 4 */ reg = BIT_LK_PTV_REG_PTV_MASK & (BIT_PTV_REG_PTV4 << BIT_LK_PTV_REG_PTV); Signed-off-by: Klaus Pedersen Signed-off-by: Tony Lindgren --- drivers/input/keyboard/omap-twl4030keypad.c | 285 ++++++++++---------- drivers/input/keyboard/twl4030-keypad.h | 80 +++--- 2 files changed, 180 insertions(+), 185 deletions(-) diff --git a/drivers/input/keyboard/omap-twl4030keypad.c b/drivers/input/keyboard/omap-twl4030keypad.c index 3bc304544af..17ed36d8c2f 100644 --- a/drivers/input/keyboard/omap-twl4030keypad.c +++ b/drivers/input/keyboard/omap-twl4030keypad.c @@ -2,6 +2,7 @@ * drivers/input/keyboard/omap-twl4030keypad.c * * Copyright (C) 2007 Texas Instruments, Inc. + * Copyright (C) 2008 Nokia Corporation * * Code re-written for 2430SDP by: * Syed Mohammed Khasim @@ -31,6 +32,7 @@ #include #include #include +#include #include #include #include @@ -38,44 +40,25 @@ #include #include "twl4030-keypad.h" -#define OMAP_TWL4030KP_LOG_LEVEL 0 +#define PTV_PRESCALER 4 -#define KEY(col, row, val) (((col) << 28) | ((row) << 24) | (val)) -#define NUM_ROWS 5 -#define NUM_COLS 6 - -#define ROW_MASK ((1<= 0) { + for (row = 0; row < n_rows; row++) + state[row] = omap_kp_col_xlate(new_state[row]); + } + return ret; +} + +static int omap_kp_is_in_ghost_state(u16 *key_state) +{ + int i; + u16 check = 0; + + for (i = 0; i < n_rows; i++) { + u16 col = key_state[i]; + + if ((col & check) && hweight16(col) > 1) + return 1; + check |= col; + } + + return 0; +} + +static void twl4030_kp_scan(int release_all) +{ + u16 new_state[MAX_ROWS]; + int col, row; + + if (release_all) + memset(new_state, 0, sizeof(new_state)); + else { + /* check for any changes */ + int ret = omap_kp_read_kp_matrix_state(new_state); + if (ret < 0) /* panic ... */ + return; + + if (omap_kp_is_in_ghost_state(new_state)) + return; + } /* check for changes and print those */ - for (row = 0; row < NUM_ROWS; row++) { - changed = new_state[row] ^ kp_state[row]; - key_down |= new_state[row]; + for (row = 0; row < n_rows; row++) { + int changed = new_state[row] ^ kp_state[row]; - if (changed == 0) + if (!changed) continue; - for (col = 0; col < NUM_COLS; col++) { + for (col = 0; col < n_cols + 1; col++) { int key; if (!(changed & (1 << col))) continue; - dev_dbg(dbg_dev, "key %s %s\n", switch_name[row][col], + dev_dbg(dbg_dev, "key [%d:%d] %s\n", row, col, (new_state[row] & (1 << col)) ? "press" : "release"); key = omap_kp_find_key(col, row); - if (key < 0) { - dev_warn(dbg_dev, "omap-kp: Spurious key event %d-%d\n", + if (key < 0) + dev_warn(dbg_dev, "Spurious key event %d-%d\n", col, row); - /* We scan again after a couple of seconds */ - spurious = 1; - continue; - } - input_report_key(omap_twl4030kp, key, - new_state[row] & (1 << col)); + else + input_report_key(omap_twl4030kp, key, + new_state[row] & (1 << col)); } + kp_state[row] = new_state[row]; } - if (key_down) { - /* - * some key is pressed - keep irq disabled and use timer - * to poll for key release - */ - if (spurious) - mod_timer(&kptimer, jiffies + SCAN_RATE * 2); - else - mod_timer(&kptimer, jiffies + SCAN_RATE); - } - memcpy(kp_state, new_state, sizeof(kp_state)); -} - -static void twl4030_timer_work(struct work_struct *unused) -{ - twl4030_kp_scan(); -} - -void omap_kp_timer(unsigned long data) -{ - schedule_work(&timer_work); } /* @@ -185,22 +188,15 @@ static irqreturn_t do_kp_irq(int irq, void *dev_id) u8 reg; int ret; - /* Mask keypad interrupts */ - reg = KEYP_IMR1_MASK; - ret = twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, reg, REG_KEYP_IMR1); - - /* - * Scan keypad for any changes - * in keypad matrix. - */ - twl4030_kp_scan(); - - /* Clear TWL4030 PIH interrupt */ - ret = twl4030_kpread_u8(TWL4030_MODULE_KEYPAD, ®, REG_KEYP_ISR1); + /* Read & Clear TWL4030 pending interrupt */ + ret = twl4030_kpread(TWL4030_MODULE_KEYPAD, ®, KEYP_ISR1, 1); - /* Enable interrupts */ - reg = KEYP_IMR1_UNMASK; - ret = twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, reg, REG_KEYP_IMR1); + /* Release all keys if I2C has gone bad or + * the KEYP has gone to idle state */ + if ((ret >= 0) && (reg & KEYP_IMR1_KP)) + twl4030_kp_scan(0); + else + twl4030_kp_scan(1); return IRQ_HANDLED; } @@ -208,12 +204,11 @@ static irqreturn_t do_kp_irq(int irq, void *dev_id) /* * Registers keypad device with input sub system * and configures TWL4030 keypad registers - * */ static int __init omap_kp_probe(struct platform_device *pdev) { - u8 reg, i; - u8 code_reg = REG_FULL_CODE_7_0; + u8 reg; + int i; int ret = 0; struct omap_kp_platform_data *pdata = pdev->dev.platform_data; @@ -230,15 +225,18 @@ static int __init omap_kp_probe(struct platform_device *pdev) return -ENOMEM; keymap = pdata->keymap; + n_rows = pdata->rows; + n_cols = pdata->cols; /* setup input device */ set_bit(EV_KEY, omap_twl4030kp->evbit); /* Enable auto repeat feature of Linux input subsystem */ - set_bit(EV_REP, omap_twl4030kp->evbit); + if (pdata->rep) + set_bit(EV_REP, omap_twl4030kp->evbit); for (i = 0; keymap[i] != 0; i++) - set_bit(keymap[i] & 0x00ffffff, omap_twl4030kp->keybit); + set_bit(keymap[i] & KEYNUM_MASK, omap_twl4030kp->keybit); omap_twl4030kp->name = "omap_twl4030keypad"; omap_twl4030kp->phys = "omap_twl4030keypad/input0"; @@ -259,49 +257,46 @@ static int __init omap_kp_probe(struct platform_device *pdev) goto err2; } - setup_timer(&kptimer,omap_kp_timer,(unsigned long) omap_twl4030kp); - - /* - * Since keypad driver uses I2C for reading - * twl4030 keypad registers, tasklets cannot - * be used. - */ - INIT_WORK(&timer_work, twl4030_timer_work); + /* Disable auto-repeat */ + reg = KEYP_CTRL_NOAUTORPT; + ret = twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, reg, KEYP_CTRL); + if (ret < 0) + goto err3; - reg = KEYP_CTRL_REG_MASK_NOAUTORPT; - ret = twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, reg, - REG_KEYP_CTRL_REG); + /* Enable TO rising and KP rising and falling edge detection */ + reg = KEYP_EDR_KP_BOTH | KEYP_EDR_TO_RISING; + ret = twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, reg, KEYP_EDR); if (ret < 0) goto err3; - /* Set all events to Falling Edge detection */ - reg = KEYP_EDR_MASK; - ret = twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, reg, REG_KEYP_EDR); + /* Set PTV prescaler Field */ + reg = (PTV_PRESCALER << KEYP_LK_PTV_PTV_SHIFT); + ret = twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, reg, KEYP_LK_PTV); if (ret < 0) goto err3; - /* Set Pre Scalar Field PTV to 4 */ - reg = BIT_LK_PTV_REG_PTV_MASK & (BIT_PTV_REG_PTV4 << BIT_LK_PTV_REG_PTV); + /* Set key debounce time to 20 ms */ + i = KEYP_PERIOD_US(20000, PTV_PRESCALER); + ret = twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, i, KEYP_DEB); + if (ret < 0) + goto err3; - ret = twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, reg, REG_LK_PTV_REG); + /* Set timeout period to 100 ms */ + i = KEYP_PERIOD_US(200000, PTV_PRESCALER); + ret = twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, + (i & 0xFF), KEYP_TIMEOUT_L); if (ret < 0) goto err3; - /* - * Set key debounce time to 10 ms using equation - * Tint = Tclk * (LOAD_TIM+1) * 2^(PTV+1) - * Where Tclk = 31.25 us ( since kbd_if_clk is 32KHz) - * PTV = 4 for all the operations. - */ - ret = twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, 0x3f, - REG_KEY_DEB_REG); + ret = twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, + (i >> 8), KEYP_TIMEOUT_H); if (ret < 0) goto err3; - /* Set SIH Ctrl register */ - reg = KEYP_SIH_CTRL_MASK; - ret = twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, reg, - REG_KEYP_SIH_CTRL); + /* Enable Clear-on-Read */ + reg = KEYP_SIH_CTRL_COR | KEYP_SIH_CTRL_PEND_DIS; + ret = twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, + reg, KEYP_SIH_CTRL); if (ret < 0) goto err3; @@ -316,27 +311,22 @@ static int __init omap_kp_probe(struct platform_device *pdev) TWL4030_MODIRQ_KEYPAD); goto err3; } else { - /* Enable keypad module interrupts now. */ - reg = KEYP_IMR1_UNMASK; - ret = twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, reg, - REG_KEYP_IMR1); - if (ret < 0) { - /* mask all events - dont care abt result */ - (void)twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, 0xff, - REG_KEYP_IMR1); - goto err4; - } + /* Enable KP and TO interrupts now. */ + reg = ~(KEYP_IMR1_KP | KEYP_IMR1_TO); + ret = twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, + reg, KEYP_IMR1); + if (ret < 0) + goto err5; } - /* Read initial state of keypad matrix. */ - ret = twl4030_i2c_read(TWL4030_MODULE_KEYPAD, kp_state, code_reg, - NUM_ROWS); - if (ret < 0) { - dev_warn(dbg_dev, "Could not read TWL4030 register %X - ret %d[%x]\n", - reg, ret, ret); + ret = omap_kp_read_kp_matrix_state(kp_state); + if (ret < 0) goto err4; - } - return (ret); + + return ret; +err5: + /* mask all events - we don't care about the result */ + (void) twl4030_kpwrite_u8(TWL4030_MODULE_KEYPAD, 0xff, KEYP_IMR1); err4: free_irq(TWL4030_MODIRQ_KEYPAD, NULL); err3: @@ -349,7 +339,6 @@ err2: static int omap_kp_remove(struct platform_device *pdev) { free_irq(TWL4030_MODIRQ_KEYPAD, NULL); - del_timer_sync(&kptimer); input_unregister_device(omap_twl4030kp); return 0; diff --git a/drivers/input/keyboard/twl4030-keypad.h b/drivers/input/keyboard/twl4030-keypad.h index 642b851f03f..131faff552b 100644 --- a/drivers/input/keyboard/twl4030-keypad.h +++ b/drivers/input/keyboard/twl4030-keypad.h @@ -24,53 +24,59 @@ #define __TWL4030_KEYPAD_H__ /* Register Definitions */ -#define REG_KEYP_CTRL_REG (0x0) -#define REG_KEY_DEB_REG (0x1) -#define REG_LK_PTV_REG (0x3) -#define REG_FULL_CODE_7_0 (0x9) -#define REG_KEYP_ISR1 (0x11) -#define REG_KEYP_IMR1 (0x12) -#define REG_KEYP_EDR (0x16) -#define REG_KEYP_SIH_CTRL (0x17) +#define KEYP_CTRL 0x00 +#define KEYP_DEB 0x01 +#define KEYP_LONG_KEY 0x02 +#define KEYP_LK_PTV 0x03 +#define KEYP_TIMEOUT_L 0x04 +#define KEYP_TIMEOUT_H 0x05 +#define KEYP_FULL_CODE_7_0 0x09 +#define KEYP_ISR1 0x11 +#define KEYP_IMR1 0x12 +#define KEYP_EDR 0x16 +#define KEYP_SIH_CTRL 0x17 /* KEYP_CTRL_REG Fields */ -#define BIT_KEYP_CTRL_REG_SOFT_NRST_MASK (0x00000001) -#define BIT_KEYP_CTRL_REG_SOFTMODEN_MASK (0x00000002) -#define BIT_KEYP_CTRL_REG_LK_EN_MASK (0x00000004) -#define BIT_KEYP_CTRL_REG_TOE_EN_MASK (0x00000008) -#define BIT_KEYP_CTRL_REG_TOLE_EN_MASK (0x00000010) -#define BIT_KEYP_CTRL_REG_RP_EN_MASK (0x00000020) -#define BIT_KEYP_CTRL_REG_KBD_ON_MASK (0x00000040) +#define KEYP_CTRL_SOFT_NRST 0x01 +#define KEYP_CTRL_SOFTMODEN 0x02 +#define KEYP_CTRL_LK_EN 0x04 +#define KEYP_CTRL_TOE_EN 0x08 +#define KEYP_CTRL_TOLE_EN 0x10 +#define KEYP_CTRL_RP_EN 0x20 +#define KEYP_CTRL_KBD_ON 0x40 -#define KEYP_CTRL_REG_MASK_NOAUTORPT BIT_KEYP_CTRL_REG_SOFT_NRST_MASK |\ - BIT_KEYP_CTRL_REG_SOFTMODEN_MASK |\ - BIT_KEYP_CTRL_REG_KBD_ON_MASK +#define KEYP_CTRL_NOAUTORPT (KEYP_CTRL_SOFT_NRST | \ + KEYP_CTRL_SOFTMODEN | \ + KEYP_CTRL_TOE_EN | \ + KEYP_CTRL_KBD_ON) -/* LK_PTV_REG Fields */ -#define BIT_LK_PTV_REG_PTV (0x005) -#define BIT_LK_PTV_REG_PTV_MASK (0x000000E0) -#define BIT_PTV_REG_PTV4 (0x4) +/* KEYP_DEB, KEYP_LONG_KEY, KEYP_TIMEOUT_x*/ +#define KEYP_PERIOD_US(T, prescale) (T / (31 << (prescale + 1)) - 1) + +/* KEYP_LK_PTV_REG Fields */ +#define KEYP_LK_PTV_PTV_SHIFT 5 /* KEYP_IMR1 Fields */ -#define KEYP_IMR1_MASK (0x0F) -#define KEYP_IMR1_UNMASK (0x00) +#define KEYP_IMR1_MIS 0x08 +#define KEYP_IMR1_TO 0x04 +#define KEYP_IMR1_LK 0x02 +#define KEYP_IMR1_KP 0x01 /* KEYP_EDR Fields */ -#define BIT_KEYP_EDR_ITKPFALLING_MASK (0x00000001) -#define BIT_KEYP_EDR_ITKPRISING_MASK (0x00000002) -#define BIT_KEYP_EDR_ITLKFALLING_MASK (0x00000004) -#define BIT_KEYP_EDR_ITLKRISING_MASK (0x00000008) -#define BIT_KEYP_EDR_ITTOFALLING_MASK (0x00000010) -#define BIT_KEYP_EDR_ITTORISING_MASK (0x00000020) -#define BIT_KEYP_EDR_ITMISFALLING_MASK (0x00000040) -#define BIT_KEYP_EDR_ITMISRISING_MASK (0x00000080) +#define KEYP_EDR_KP_FALLING 0x01 +#define KEYP_EDR_KP_RISING 0x02 +#define KEYP_EDR_KP_BOTH 0x03 +#define KEYP_EDR_LK_FALLING 0x04 +#define KEYP_EDR_LK_RISING 0x08 +#define KEYP_EDR_TO_FALLING 0x10 +#define KEYP_EDR_TO_RISING 0x20 +#define KEYP_EDR_MIS_FALLING 0x40 +#define KEYP_EDR_MIS_RISING 0x80 -#define KEYP_EDR_MASK BIT_KEYP_EDR_ITKPFALLING_MASK |\ - BIT_KEYP_EDR_ITLKFALLING_MASK |\ - BIT_KEYP_EDR_ITTOFALLING_MASK |\ - BIT_KEYP_EDR_ITMISFALLING_MASK /* KEYP_SIH_CTRL Fields */ -#define KEYP_SIH_CTRL_MASK (0x04) +#define KEYP_SIH_CTRL_COR 0x04 +#define KEYP_SIH_CTRL_PEND_DIS 0x02 +#define KEYP_SIH_CTRL_EXCL_EN 0x01 #endif /* End of __TWL4030-KEYPAD_H__ */ -- 2.41.3