1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) ST-Ericsson SA 2010
5 * Author: Naveen Kumar G <naveen.gaddipati@stericsson.com> for ST-Ericsson
6 * Author: Sundar Iyer <sundar.iyer@stericsson.com> for ST-Ericsson
8 * Keypad controller driver for the SKE (Scroll Key Encoder) module used in
9 * the Nomadik 8815 and Ux500 platforms.
12 #include <linux/platform_device.h>
13 #include <linux/interrupt.h>
14 #include <linux/spinlock.h>
16 #include <linux/delay.h>
17 #include <linux/input.h>
18 #include <linux/slab.h>
19 #include <linux/clk.h>
20 #include <linux/module.h>
22 #include <linux/platform_data/keypad-nomadik-ske.h>
25 #define SKE_KPMLT (0x1 << 6)
26 #define SKE_KPCN (0x7 << 3)
27 #define SKE_KPASEN (0x1 << 2)
28 #define SKE_KPASON (0x1 << 7)
31 #define SKE_KPIMA (0x1 << 2)
34 #define SKE_KPICS (0x1 << 3)
35 #define SKE_KPICA (0x1 << 2)
38 #define SKE_KPRISA (0x1 << 2)
40 #define SKE_KEYPAD_ROW_SHIFT 3
41 #define SKE_KPD_NUM_ROWS 8
42 #define SKE_KPD_NUM_COLS 8
44 /* keypad auto scan registers */
50 #define SKE_NUM_ASRX_REGISTERS (4)
51 #define KEY_PRESSED_DELAY 10
54 * struct ske_keypad - data structure used by keypad driver
56 * @reg_base: ske registers base address
57 * @input: pointer to input device object
58 * @board: keypad platform device
59 * @keymap: matrix scan code table for keycodes
60 * @clk: clock structure pointer
61 * @pclk: clock structure pointer
62 * @ske_keypad_lock: spinlock protecting the keypad read/writes
66 void __iomem *reg_base;
67 struct input_dev *input;
68 const struct ske_keypad_platform_data *board;
69 unsigned short keymap[SKE_KPD_NUM_ROWS * SKE_KPD_NUM_COLS];
72 spinlock_t ske_keypad_lock;
75 static void ske_keypad_set_bits(struct ske_keypad *keypad, u16 addr,
80 spin_lock(&keypad->ske_keypad_lock);
82 ret = readl(keypad->reg_base + addr);
85 writel(ret, keypad->reg_base + addr);
87 spin_unlock(&keypad->ske_keypad_lock);
91 * ske_keypad_chip_init: init keypad controller configuration
93 * Enable Multi key press detection, auto scan mode
95 static int __init ske_keypad_chip_init(struct ske_keypad *keypad)
98 int timeout = keypad->board->debounce_ms;
100 /* check SKE_RIS to be 0 */
101 while ((readl(keypad->reg_base + SKE_RIS) != 0x00000000) && timeout--)
109 * keypad dbounce is configured in DBCR[15:8]
110 * dbounce value in steps of 32/32.768 ms
112 spin_lock(&keypad->ske_keypad_lock);
113 value = readl(keypad->reg_base + SKE_DBCR);
114 value = value & 0xff;
115 value |= ((keypad->board->debounce_ms * 32000)/32768) << 8;
116 writel(value, keypad->reg_base + SKE_DBCR);
117 spin_unlock(&keypad->ske_keypad_lock);
119 /* enable multi key detection */
120 ske_keypad_set_bits(keypad, SKE_CR, 0x0, SKE_KPMLT);
123 * set up the number of columns
124 * KPCN[5:3] defines no. of keypad columns to be auto scanned
126 value = (keypad->board->kcol - 1) << 3;
127 ske_keypad_set_bits(keypad, SKE_CR, SKE_KPCN, value);
129 /* clear keypad interrupt for auto(and pending SW) scans */
130 ske_keypad_set_bits(keypad, SKE_ICR, 0x0, SKE_KPICA | SKE_KPICS);
132 /* un-mask keypad interrupts */
133 ske_keypad_set_bits(keypad, SKE_IMSC, 0x0, SKE_KPIMA);
135 /* enable automatic scan */
136 ske_keypad_set_bits(keypad, SKE_CR, 0x0, SKE_KPASEN);
141 static void ske_keypad_report(struct ske_keypad *keypad, u8 status, int col)
143 int row = 0, code, pos;
144 struct input_dev *input = keypad->input;
149 /* find out the row */
150 num_of_rows = hweight8(status);
154 status &= ~(1 << pos);
156 code = MATRIX_SCAN_CODE(row, col, SKE_KEYPAD_ROW_SHIFT);
157 ske_ris = readl(keypad->reg_base + SKE_RIS);
158 key_pressed = ske_ris & SKE_KPRISA;
160 input_event(input, EV_MSC, MSC_SCAN, code);
161 input_report_key(input, keypad->keymap[code], key_pressed);
164 } while (num_of_rows);
167 static void ske_keypad_read_data(struct ske_keypad *keypad)
174 * Read the auto scan registers
176 * Each SKE_ASRx (x=0 to x=3) contains two row values.
177 * lower byte contains row value for column 2*x,
178 * upper byte contains row value for column 2*x + 1
180 for (i = 0; i < SKE_NUM_ASRX_REGISTERS; i++) {
181 ske_asr = readl(keypad->reg_base + SKE_ASR0 + (4 * i));
185 /* now that ASRx is zero, find out the coloumn x and row y */
186 status = ske_asr & 0xff;
189 ske_keypad_report(keypad, status, col);
191 status = (ske_asr & 0xff00) >> 8;
194 ske_keypad_report(keypad, status, col);
199 static irqreturn_t ske_keypad_irq(int irq, void *dev_id)
201 struct ske_keypad *keypad = dev_id;
202 int timeout = keypad->board->debounce_ms;
204 /* disable auto scan interrupt; mask the interrupt generated */
205 ske_keypad_set_bits(keypad, SKE_IMSC, ~SKE_KPIMA, 0x0);
206 ske_keypad_set_bits(keypad, SKE_ICR, 0x0, SKE_KPICA);
208 while ((readl(keypad->reg_base + SKE_CR) & SKE_KPASON) && --timeout)
211 /* SKEx registers are stable and can be read */
212 ske_keypad_read_data(keypad);
214 /* wait until raw interrupt is clear */
215 while ((readl(keypad->reg_base + SKE_RIS)) && --timeout)
216 msleep(KEY_PRESSED_DELAY);
218 /* enable auto scan interrupts */
219 ske_keypad_set_bits(keypad, SKE_IMSC, 0x0, SKE_KPIMA);
224 static int __init ske_keypad_probe(struct platform_device *pdev)
226 const struct ske_keypad_platform_data *plat =
227 dev_get_platdata(&pdev->dev);
228 struct ske_keypad *keypad;
229 struct input_dev *input;
230 struct resource *res;
235 dev_err(&pdev->dev, "invalid keypad platform data\n");
239 irq = platform_get_irq(pdev, 0);
243 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
245 dev_err(&pdev->dev, "missing platform resources\n");
249 keypad = kzalloc(sizeof(struct ske_keypad), GFP_KERNEL);
250 input = input_allocate_device();
251 if (!keypad || !input) {
252 dev_err(&pdev->dev, "failed to allocate keypad memory\n");
258 keypad->board = plat;
259 keypad->input = input;
260 spin_lock_init(&keypad->ske_keypad_lock);
262 if (!request_mem_region(res->start, resource_size(res), pdev->name)) {
263 dev_err(&pdev->dev, "failed to request I/O memory\n");
268 keypad->reg_base = ioremap(res->start, resource_size(res));
269 if (!keypad->reg_base) {
270 dev_err(&pdev->dev, "failed to remap I/O memory\n");
272 goto err_free_mem_region;
275 keypad->pclk = clk_get(&pdev->dev, "apb_pclk");
276 if (IS_ERR(keypad->pclk)) {
277 dev_err(&pdev->dev, "failed to get pclk\n");
278 error = PTR_ERR(keypad->pclk);
282 keypad->clk = clk_get(&pdev->dev, NULL);
283 if (IS_ERR(keypad->clk)) {
284 dev_err(&pdev->dev, "failed to get clk\n");
285 error = PTR_ERR(keypad->clk);
289 input->id.bustype = BUS_HOST;
290 input->name = "ux500-ske-keypad";
291 input->dev.parent = &pdev->dev;
293 error = matrix_keypad_build_keymap(plat->keymap_data, NULL,
294 SKE_KPD_NUM_ROWS, SKE_KPD_NUM_COLS,
295 keypad->keymap, input);
297 dev_err(&pdev->dev, "Failed to build keymap\n");
301 input_set_capability(input, EV_MSC, MSC_SCAN);
302 if (!plat->no_autorepeat)
303 __set_bit(EV_REP, input->evbit);
305 error = clk_prepare_enable(keypad->pclk);
307 dev_err(&pdev->dev, "Failed to prepare/enable pclk\n");
311 error = clk_prepare_enable(keypad->clk);
313 dev_err(&pdev->dev, "Failed to prepare/enable clk\n");
314 goto err_pclk_disable;
318 /* go through board initialization helpers */
319 if (keypad->board->init)
320 keypad->board->init();
322 error = ske_keypad_chip_init(keypad);
324 dev_err(&pdev->dev, "unable to init keypad hardware\n");
325 goto err_clk_disable;
328 error = request_threaded_irq(keypad->irq, NULL, ske_keypad_irq,
329 IRQF_ONESHOT, "ske-keypad", keypad);
331 dev_err(&pdev->dev, "allocate irq %d failed\n", keypad->irq);
332 goto err_clk_disable;
335 error = input_register_device(input);
338 "unable to register input device: %d\n", error);
342 if (plat->wakeup_enable)
343 device_init_wakeup(&pdev->dev, true);
345 platform_set_drvdata(pdev, keypad);
350 free_irq(keypad->irq, keypad);
352 clk_disable_unprepare(keypad->clk);
354 clk_disable_unprepare(keypad->pclk);
356 clk_put(keypad->clk);
358 clk_put(keypad->pclk);
360 iounmap(keypad->reg_base);
362 release_mem_region(res->start, resource_size(res));
364 input_free_device(input);
369 static int ske_keypad_remove(struct platform_device *pdev)
371 struct ske_keypad *keypad = platform_get_drvdata(pdev);
372 struct resource *res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
374 free_irq(keypad->irq, keypad);
376 input_unregister_device(keypad->input);
378 clk_disable_unprepare(keypad->clk);
379 clk_put(keypad->clk);
381 if (keypad->board->exit)
382 keypad->board->exit();
384 iounmap(keypad->reg_base);
385 release_mem_region(res->start, resource_size(res));
391 #ifdef CONFIG_PM_SLEEP
392 static int ske_keypad_suspend(struct device *dev)
394 struct platform_device *pdev = to_platform_device(dev);
395 struct ske_keypad *keypad = platform_get_drvdata(pdev);
396 int irq = platform_get_irq(pdev, 0);
398 if (device_may_wakeup(dev))
399 enable_irq_wake(irq);
401 ske_keypad_set_bits(keypad, SKE_IMSC, ~SKE_KPIMA, 0x0);
406 static int ske_keypad_resume(struct device *dev)
408 struct platform_device *pdev = to_platform_device(dev);
409 struct ske_keypad *keypad = platform_get_drvdata(pdev);
410 int irq = platform_get_irq(pdev, 0);
412 if (device_may_wakeup(dev))
413 disable_irq_wake(irq);
415 ske_keypad_set_bits(keypad, SKE_IMSC, 0x0, SKE_KPIMA);
421 static SIMPLE_DEV_PM_OPS(ske_keypad_dev_pm_ops,
422 ske_keypad_suspend, ske_keypad_resume);
424 static struct platform_driver ske_keypad_driver = {
426 .name = "nmk-ske-keypad",
427 .pm = &ske_keypad_dev_pm_ops,
429 .remove = ske_keypad_remove,
432 module_platform_driver_probe(ske_keypad_driver, ske_keypad_probe);
434 MODULE_LICENSE("GPL v2");
435 MODULE_AUTHOR("Naveen Kumar <naveen.gaddipati@stericsson.com> / Sundar Iyer <sundar.iyer@stericsson.com>");
436 MODULE_DESCRIPTION("Nomadik Scroll-Key-Encoder Keypad Driver");
437 MODULE_ALIAS("platform:nomadik-ske-keypad");