RE: [PATCH] input: add support for Nomadik SKE keypad controller

-----Original Message-----
From: linux-input-owner@vger.kernel.org [mailto:linux-input-
owner@vger.kernel.org] On Behalf Of Sundar Iyer
Sent: Monday, August 23, 2010 2:34 PM
To: Dmitry Torokhov; Dmitry Torokhov
Cc: linux-input@vger.kernel.org; STEricsson_nomadik_linux@list.st.com;
Sundar Iyer; Linus Walleij
Subject: [PATCH] input: add support for Nomadik SKE keypad controller

Acked-by: Linus Walleij <redacted>
Signed-off-by: Sundar Iyer <redacted>
---
 arch/arm/plat-nomadik/include/plat/ske.h    |   54 ++++
 drivers/input/keyboard/Kconfig              |   10 +
 drivers/input/keyboard/Makefile             |    1 +
 drivers/input/keyboard/nomadik-ske-keypad.c |  407
+++++++++++++++++++++++++++
 4 files changed, 472 insertions(+), 0 deletions(-)
 create mode 100644 arch/arm/plat-nomadik/include/plat/ske.h
 create mode 100644 drivers/input/keyboard/nomadik-ske-keypad.c

diff --git a/arch/arm/plat-nomadik/include/plat/ske.h b/arch/arm/plat-

nomadik/include/plat/ske.h
new file mode 100644
index 0000000..27aeadb

--- /dev/null
+++ b/arch/arm/plat-nomadik/include/plat/ske.h

@@ -0,0 +1,54 @@
+/*
+ * Copyright (C) ST-Ericsson SA 2010
+ *
+ * License Terms: GNU General Public License v2
+ * Author: Naveen Kumar Gaddipati <naveen.gaddipati@stericsson.com>
+ *
+ * ux500 Scroll key and Keypad Encoder (SKE) header
+ */
+
+#ifndef __SKE_H
+#define __SKE_H
+
+#include <linux/input/matrix_keypad.h>
+
+/* register definitions for SKE peripheral */
+#define SKE_CR               0x00
+#define SKE_VAL0     0x04
+#define SKE_VAL1     0x08
+#define SKE_DBCR     0x0C
+#define SKE_IMSC     0x10
+#define SKE_RIS              0x14
+#define SKE_MIS              0x18
+#define SKE_ICR              0x1C
+#define SKE_ASR0     0x20
+#define SKE_ASR1     0x24
+#define SKE_ASR2     0x28
+#define SKE_ASR3     0x2C
+
+#define SKE_NUM_ASRX_REGISTERS       (4)
+
+/*
+ * Keypad module
+ */
+
+/**
+ * struct keypad_platform_data - structure for platform specific data
+ * @init:    pointer to keypad init function
+ * @exit:    pointer to keypad deinitialisation function
+ * @keymap_data: matrix scan code table for keycodes
+ * @krow:    maximum number of rows
+ * @kcol:    maximum number of columns
+ * @debounce_ms: platform specific debounce time
+ * @no_autorepeat: flag for auto repetition
+ */
+struct ske_keypad_platform_data {
+     int (*init)(void);
+     int (*exit)(void);
+     struct matrix_keymap_data *keymap_data;
+     u8 krow;
+     u8 kcol;
+     u8 debounce_ms;
+     bool no_autorepeat;
+};
+#endif       /*__SKE_KPD_H*/

diff --git a/drivers/input/keyboard/Kconfig

b/drivers/input/keyboard/Kconfig
index 9cc488d..97dfab0 100644

--- a/drivers/input/keyboard/Kconfig
+++ b/drivers/input/keyboard/Kconfig

@@ -327,6 +327,16 @@ config KEYBOARD_NEWTON
        To compile this driver as a module, choose M here: the
        module will be called newtonkbd.

+config KEYBOARD_NOMADIK
+     tristate "ST-Ericsson Nomadik SKE keyboard"
+     depends on PLAT_NOMADIK
+     help
+       Say Y here if you want to use a keypad provided on the SKE

controller
+       used on the Ux500 and Nomadik platforms
+
+       To compile this driver as a module, choose M here: the
+       module will be called nmk-ske-keypad.
+
 config KEYBOARD_OPENCORES
      tristate "OpenCores Keyboard Controller"
      help

diff --git a/drivers/input/keyboard/Makefile

b/drivers/input/keyboard/Makefile
index 504b591..1e9adfe 100644

--- a/drivers/input/keyboard/Makefile
+++ b/drivers/input/keyboard/Makefile

@@ -28,6 +28,7 @@ obj-$(CONFIG_KEYBOARD_MATRIX)               += matrix_keypad.o
 obj-$(CONFIG_KEYBOARD_MAX7359)               += max7359_keypad.o
 obj-$(CONFIG_KEYBOARD_MCS)           += mcs_touchkey.o
 obj-$(CONFIG_KEYBOARD_NEWTON)                += newtonkbd.o
+obj-$(CONFIG_KEYBOARD_NOMADIK)               += nomadik-ske-keypad.o
 obj-$(CONFIG_KEYBOARD_OMAP)          += omap-keypad.o
 obj-$(CONFIG_KEYBOARD_OPENCORES)     += opencores-kbd.o
 obj-$(CONFIG_KEYBOARD_PXA27x)                += pxa27x_keypad.o

diff --git a/drivers/input/keyboard/nomadik-ske-keypad.c

b/drivers/input/keyboard/nomadik-ske-keypad.c
new file mode 100644
index 0000000..b4b4b1b

--- /dev/null
+++ b/drivers/input/keyboard/nomadik-ske-keypad.c

@@ -0,0 +1,407 @@
+/*
+ * Copyright (C) ST-Ericsson SA 2010
+ *
+ * Author: Naveen Kumar G <naveen.gaddipati@stericsson.com> for ST-

Ericsson
+ * Author: Sundar Iyer [off-list ref] for ST-Ericsson
+ *
+ * License terms:GNU General Public License (GPL) version 2
+ *
+ * Keypad controller driver for the SKE (Scroll Key Encoder) module used
in
+ * the Nomadik 8815 and Ux500 platforms.
+ */
+
+#include <linux/platform_device.h>
+#include <linux/interrupt.h>
+#include <linux/spinlock.h>
+#include <linux/io.h>
+#include <linux/input.h>
+#include <linux/slab.h>
+#include <linux/clk.h>
+
+#include <plat/ske.h>
+
+/* SKE_CR bits */
+#define SKE_KPMLT    (0x1 << 6)
+#define SKE_KPCN     (0x7 << 3)
+#define SKE_KPASEN   (0x1 << 2)
+#define SKE_KPASON   (0x1 << 7)
+
+/* SKE_IMSC bits */
+#define SKE_KPIMA    (0x1 << 2)
+
+/* SKE_ICR bits */
+#define SKE_KPICS    (0x1 << 3)
+#define SKE_KPICA    (0x1 << 2)
+
+/* SKE_RIS bits */
+#define SKE_KPRISA   (0x1 << 2)
+
+#define SKE_KEYPAD_ROW_SHIFT 3
+#define SKE_KPD_KEYMAP_SIZE  (8 * 8)
+
+/**
+ * struct ske_keypad  - data structure used by keypad driver
+ * @irq:     irq no
+ * @reg_base:        ske regsiters base address
+ * @input:   pointer to input device object
+ * @board:   keypad platform device
+ * @keymap:  matrix scan code table for keycodes
+ * @clk:     clock structure pointer
+ */
+struct ske_keypad {
+     int irq;
+     void __iomem *reg_base;
+     struct input_dev *input;
+     struct ske_keypad_platform_data *board;
+     unsigned short keymap[SKE_KPD_KEYMAP_SIZE];
+     struct clk *clk;
+};
+
+DEFINE_MUTEX(ske_keypad_lock);
+static void ske_keypad_set_bits(struct ske_keypad *keypad, u16 addr,
+             u8 mask, u8 data)
+{
+     u32 ret;
+
+     mutex_lock(&ske_keypad_lock);
+
+     ret = readl(keypad->reg_base + addr);
+     ret &= ~mask;
+     ret |= data;
+     writel(ret, keypad->reg_base + addr);
+
+     mutex_unlock(&ske_keypad_lock);
+}
+
+/*
+ * ske_keypad_chip_init : init keypad controller configuration
+ *
+ * Enable Multi key press detection, auto scan mode
+ */

+static int ske_keypad_chip_init(struct ske_keypad *keypad)
+{
+     u32 value;
+     int timeout = keypad->board->debounce_ms;
+
+     /* check SKE_RIS to be 0 */
+     while ((readl(keypad->reg_base + SKE_RIS) != 0x00000000) && timeout-
-)
+             cpu_relax();
+     if (!timeout)
+             return -EINVAL;
+
+     /*
+      * set debounce value
+      * keypad dbounce is configured in DBCR[15:8]
+      * dbounce value in steps of 32/32.768 ms
+      */
+     mutex_lock(&ske_keypad_lock);
+     value = readl(keypad->reg_base + SKE_DBCR);
+     value = value & 0xff;
+     value |= ((keypad->board->debounce_ms * 32000)/32768) << 8;
+     writel(value, keypad->reg_base + SKE_DBCR);
+     mutex_unlock(&ske_keypad_lock);
+
+     /* enable multi key detection */
+     ske_keypad_set_bits(keypad, SKE_CR, 0x0, SKE_KPMLT);
+
+     /*
+      * set up the number of columns
+      * KPCN[5:3] defines no. of keypad columns to be auto scanned
+      */
+     value = (keypad->board->kcol - 1) << 3;
+     ske_keypad_set_bits(keypad, SKE_CR, SKE_KPCN, value);
+
+     /* clear keypad interrupt for auto(and pending SW) scans */
+     ske_keypad_set_bits(keypad, SKE_ICR, 0x0, SKE_KPICA | SKE_KPICS);
+
+     /* un-mask keypad interrupts */
+     ske_keypad_set_bits(keypad, SKE_IMSC, 0x0, SKE_KPIMA);
+
+     /* enable automatic scan */
+     ske_keypad_set_bits(keypad, SKE_CR, 0x0, SKE_KPASEN);
+
+     return 0;
+}
+

+
+static irqreturn_t ske_keypad_irq(int irq, void *dev_id)
+{
+     struct ske_keypad *keypad = dev_id;
+     struct input_dev *input = keypad->input;
+     u16 status;
+     int col = 0, row = 0, code;
+     int ske_asr, ske_ris, key_pressed, i;
+
+     /* disable auto scan interrupt; mask the interrupt generated */
+     ske_keypad_set_bits(keypad, SKE_IMSC, ~SKE_KPIMA, 0x0);
+     ske_keypad_set_bits(keypad, SKE_ICR, 0x0, SKE_KPICA);
+
+     /* while away till the SKEx registers are stable and can be read */
+     while (readl(keypad->reg_base + SKE_CR) & SKE_KPASON)
+             cpu_relax();
+
+     /*
+      * Read the auto scan registers
+      *
+      * Each SKE_ASRx (x=0 to x=3) contains two row values.
+      * lower byte contains row value for coloumn 2*x,
+      * upper byte contains row value for column 2*x + 1
+      */
+     for (i = 0; i < SKE_NUM_ASRX_REGISTERS; i++) {
+             ske_asr = readl(keypad->reg_base + SKE_ASR0 + (4 * i));
+             if (!ske_asr)
+                     continue;
+
+             /* now that ASRx is zero, find out the coloumn x and row y*/
+             if (ske_asr & 0xff) {
+                     col = i * 2;
+                     status = ske_asr & 0xff;
+             } else {
+                     col = (i * 2) + 1;
+                     status = (ske_asr & 0xff00) >> 8;
+             }
+
+             /* find out the row */
+             row = __ffs(status);
+
+             code = MATRIX_SCAN_CODE(row, col, SKE_KEYPAD_ROW_SHIFT);
+             ske_ris = readl(keypad->reg_base + SKE_RIS);
+             key_pressed = ske_ris & SKE_KPRISA;
+
+             input_event(input, EV_MSC, MSC_SCAN, code);
+             input_report_key(input, keypad->keymap[code], key_pressed);
+             input_sync(input);
+     }
+
+     /* enable auto scan interrupts */
+     ske_keypad_set_bits(keypad, SKE_IMSC, 0x0, SKE_KPIMA);
+
+     return IRQ_HANDLED;
+}
+
+static int __devinit ske_keypad_probe(struct platform_device *pdev)
+{
+     struct ske_keypad *keypad;
+     struct resource *res = NULL;
+     struct input_dev *input;
+     struct clk *clk;
+     void __iomem *reg_base;
+     int ret;
+     int irq;
+     struct ske_keypad_platform_data *plat = pdev->dev.platform_data;
+
+     if (!plat) {
+             dev_err(&pdev->dev, "invalid keypad platform data\n");
+             return -EINVAL;
+     }
+
+     irq = platform_get_irq(pdev, 0);
+     if (irq < 0) {
+             dev_err(&pdev->dev, "failed to get keypad irq\n");
+             return -EINVAL;
+     }
+
+     res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+     if (res == NULL) {
+             dev_err(&pdev->dev, "missing platform resources\n");
+             return -ENXIO;
+     }
+
+     res = request_mem_region(res->start, resource_size(res), pdev-

quoted

name);

+     if (!res) {
+             dev_err(&pdev->dev, "failed to request I/O memory\n");
+             return -EBUSY;
+     }
+
+     reg_base = ioremap(res->start, resource_size(res));
+     if (!reg_base) {
+             dev_err(&pdev->dev, "failed to remap I/O memory\n");
+             ret = -ENXIO;
+             goto out_freerequest_memregions;
+     }
+
+     clk = clk_get(&pdev->dev, NULL);
+     if (IS_ERR(clk)) {
+             dev_err(&pdev->dev, "failed to clk_get\n");
+             ret = PTR_ERR(clk);
+             goto out_freeioremap;
+     }
+
+     /* resources are sane; we begin allocation */
+     keypad = kzalloc(sizeof(struct ske_keypad), GFP_KERNEL);
+     if (!keypad) {
+             dev_err(&pdev->dev, "failed to allocate keypad memory\n");
+             goto out_freeclk;
+     }
+
+     input = input_allocate_device();
+     if (!input) {
+             dev_err(&pdev->dev, "failed to input_allocate_device\n");
+             ret = -ENOMEM;
+             goto out_freekeypad;
+     }
+
+     input->id.bustype = BUS_HOST;
+     input->name = "ux500-ske-keypad";
+     input->dev.parent = &pdev->dev;
+
+     input->keycode = keypad->keymap;
+     input->keycodesize = sizeof(keypad->keymap[0]);
+     input->keycodemax = ARRAY_SIZE(keypad->keymap);
+
+     input_set_capability(input, EV_MSC, MSC_SCAN);
+
+     __set_bit(EV_KEY, input->evbit);
+     if (!plat->no_autorepeat)
+             __set_bit(EV_REP, input->evbit);
+
+     matrix_keypad_build_keymap(plat->keymap_data, SKE_KEYPAD_ROW_SHIFT,
+                                     input->keycode, input->keybit);
+
+     ret = input_register_device(input);
+     if (ret) {
+             dev_err(&pdev->dev,
+                     "unable to register input device: %d\n", ret);
+             goto out_freeinput;
+     }
+
+     keypad->board   = plat;
+     keypad->irq     = irq;
+     keypad->board   = plat;
+     keypad->input   = input;
+     keypad->reg_base = reg_base;
+     keypad->clk     = clk;
+
+     /* allocations are sane, we begin HW initialization */
+     clk_enable(keypad->clk);
+
+     if (!keypad->board->init) {
+             dev_err(&pdev->dev, "NULL board initialization helper\n");
+             ret = -EINVAL;
+             goto out_unregisterinput;
+     }
+
+     if (keypad->board->init() < 0) {
+             dev_err(&pdev->dev, "unable to set keypad board config\n");
+             ret = -EINVAL;
+             goto out_unregisterinput;
+     }
+
+     ret = ske_keypad_chip_init(keypad);
+     if (ret < 0) {
+             dev_err(&pdev->dev, "unable to init keypad hardware\n");
+             goto out_unregisterinput;
+     }
+
+     ret =  request_threaded_irq(keypad->irq, NULL, ske_keypad_irq,
+                             IRQF_ONESHOT, "ske-keypad", keypad);
+     if (ret) {
+             dev_err(&pdev->dev, "allocate irq %d failed\n", keypad->irq);
+             goto out_unregisterinput;
+     }
+
+     device_init_wakeup(&pdev->dev, true);
+
+     platform_set_drvdata(pdev, keypad);
+
+     return 0;
+
+out_unregisterinput:
+     input_unregister_device(input);
+     input = NULL;
+     clk_disable(keypad->clk);
+out_freeinput:

+     input_free_device(input);
+out_freekeypad:
+     kfree(keypad);
+out_freeclk: