diff mbox

[v2,1/2] Input: Add DaVinci DM365 Keypad support

Message ID 1252951959-31015-1-git-send-email-miguel.aguilar@ridgerun.com
State New, archived
Headers show

Commit Message

miguel.aguilar@ridgerun.com Sept. 14, 2009, 6:12 p.m. UTC
From: Miguel Aguilar <miguel.aguilar@ridgerun.com>

Adds the driver for enabling keypad support on DM365 platform.

This driver was tested on DM365 EVM rev c.

Signed-off-by: Miguel Aguilar <miguel.aguilar@ridgerun.com>
---
 arch/arm/mach-davinci/include/mach/keypad.h   |   35 +++
 drivers/input/keyboard/Kconfig                |    6 +
 drivers/input/keyboard/Makefile               |    1 +
 drivers/input/keyboard/davinci_dm365_keypad.c |  316 +++++++++++++++++++++++++
 4 files changed, 358 insertions(+), 0 deletions(-)
 create mode 100644 arch/arm/mach-davinci/include/mach/keypad.h
 create mode 100644 drivers/input/keyboard/davinci_dm365_keypad.c

Comments

David Brownell Sept. 14, 2009, 6:45 p.m. UTC | #1
On Monday 14 September 2009, miguel.aguilar@ridgerun.com wrote:
> +       dm365_kp = kzalloc(sizeof *dm365_kp, GFP_KERNEL);
> +       key_dev = input_allocate_device();
> +
> +       if (!dm365_kp || !key_dev) {
> +               dev_dbg(dev, "Could not allocate input device\n");
> +               return -ENOMEM;
> +       }

Can still leak the kzalloc'ed data...


> +       dm365_kp->irq = platform_get_irq(pdev, 0);
> +       if (dm365_kp->irq <= 0) {
> +               dev_dbg(dev, "%s: No DM365 Keypad irq\n", pdev->name);
> +               goto fail1;
> +       }

Still discards the true fault codes here and later ...


> +       printk(KERN_INFO "DaVinci DM365 Keypad Driver\n");

Nicer not to have such banners; a dev_info() in probe() is
better and won't show on boards where this driver isn't used.

--
To unsubscribe from this list: send the line "unsubscribe linux-input" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
miguel.aguilar@ridgerun.com Sept. 17, 2009, 5:49 p.m. UTC | #2
David,

What are the proper error codes when platform_get_resource, request_mem_region 
and ioremap functions fail?.

Thanks,

Miguel Aguilar
David Brownell wrote:
> On Monday 14 September 2009, miguel.aguilar@ridgerun.com wrote:
>> +       dm365_kp = kzalloc(sizeof *dm365_kp, GFP_KERNEL);
>> +       key_dev = input_allocate_device();
>> +
>> +       if (!dm365_kp || !key_dev) {
>> +               dev_dbg(dev, "Could not allocate input device\n");
>> +               return -ENOMEM;
>> +       }
> 
> Can still leak the kzalloc'ed data...
> 
> 
>> +       dm365_kp->irq = platform_get_irq(pdev, 0);
>> +       if (dm365_kp->irq <= 0) {
>> +               dev_dbg(dev, "%s: No DM365 Keypad irq\n", pdev->name);
>> +               goto fail1;
>> +       }
> 
> Still discards the true fault codes here and later ...
> 
> 
>> +       printk(KERN_INFO "DaVinci DM365 Keypad Driver\n");
> 
> Nicer not to have such banners; a dev_info() in probe() is
> better and won't show on boards where this driver isn't used.
> 
> --
> To unsubscribe from this list: send the line "unsubscribe linux-input" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html


--
To unsubscribe from this list: send the line "unsubscribe linux-input" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Sergei Shtylyov Sept. 17, 2009, 6:01 p.m. UTC | #3
Hello.

Miguel Aguilar wrote:

> David,

    Though I'm not David, I'll reply... :-)

> What are the proper error codes when platform_get_resource,

    -ENODEV.

> request_mem_region

    -EBUSY.

> and ioremap functions fail?.

    -ENOMEM.

WBR, Sergei
--
To unsubscribe from this list: send the line "unsubscribe linux-input" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
miguel.aguilar@ridgerun.com Sept. 17, 2009, 7:27 p.m. UTC | #4
Sergei,

Thanks for your response.

I have another question: When should I use dev_err and dev_dbg in a probe 
function, for reporting the errors (-ENOMEM, -ENODEV, -ENOMEM, etc)?

Thanks,

Miguel Aguilar
Sergei Shtylyov wrote:
> Hello.
> 
> Miguel Aguilar wrote:
> 
>> David,
> 
>    Though I'm not David, I'll reply... :-)
> 
>> What are the proper error codes when platform_get_resource,
> 
>    -ENODEV.
> 
>> request_mem_region
> 
>    -EBUSY.
> 
>> and ioremap functions fail?.
> 
>    -ENOMEM.
> 
> WBR, Sergei



--
To unsubscribe from this list: send the line "unsubscribe linux-input" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
David Brownell Sept. 17, 2009, 7:48 p.m. UTC | #5
On Thursday 17 September 2009, Miguel Aguilar wrote:
> I have another question: When should I use dev_err and dev_dbg in a probe 
> function, for reporting the errors (-ENOMEM, -ENODEV, -ENOMEM, etc)?

My two cents:  dev_dbg() for configuration errors, which
vanish once the board config is properly set up and are
only needed in early debug stages.  For anything else
(rare!) it's OK to use dev_err().

Some folk like to clutter kernel images with gobs of strings
for messages that never appear.  I'm not one of them; and I
think drivers should be written to minimize space used on
production systems.  Save that RAM for Real Work (tm)!

It's a good habit to scan the driver object before you call
work on it "done".  For platform drivers, probe/remove code
should normally sit in init/exit sections.  Symbols should
as a rule not be exported from drivers.  Having more than
a handful of strings should raise red flags ... who is ever
going to read them?  (And why, and what should they do with
them once they've seen those messages?)  Real hardware faults
generally deserve log messages.  Little else does.

Even look at the object code generated ... you may well observe
stupidly large amounts of code generated for some things, which
can easily be trimmed.  (Remember that the cost of a few extra
fetches into I-cache often dwarf call/return costs for a few
helper subroutines, even on critical paths!)

Sometimes a few minutes spent with such basic checks can show
problems that bloat the runtime footprint by 20% or more.
(Less after you get good habits though!)

- Dave
--
To unsubscribe from this list: send the line "unsubscribe linux-input" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/arch/arm/mach-davinci/include/mach/keypad.h b/arch/arm/mach-davinci/include/mach/keypad.h
new file mode 100644
index 0000000..922d20e
--- /dev/null
+++ b/arch/arm/mach-davinci/include/mach/keypad.h
@@ -0,0 +1,35 @@ 
+/*
+ * Copyright (C) 2009 Texas Instruments, Inc
+ *
+ * Author: Miguel Aguilar <miguel.aguilar@ridgerun.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
+#ifndef DAVINCI_KEYPAD_H
+#define DAVINCI_KEYPAD_H
+
+#include <linux/io.h>
+
+struct davinci_kp_platform_data {
+	int	*keymap;
+	u32	keymapsize;
+	u32	rep:1;
+	u32	strobe;
+	u32	interval;
+};
+
+#endif
+
diff --git a/drivers/input/keyboard/Kconfig b/drivers/input/keyboard/Kconfig
index a6b989a..08ed7d4 100644
--- a/drivers/input/keyboard/Kconfig
+++ b/drivers/input/keyboard/Kconfig
@@ -361,4 +361,10 @@  config KEYBOARD_XTKBD
 	  To compile this driver as a module, choose M here: the
 	  module will be called xtkbd.
 
+config KEYBOARD_DAVINCI_DM365
+	tristate "TI DaVinci DM365 Keypad"
+	depends on ARCH_DAVINCI_DM365
+	help
+	 Supports the keypad module on the DM365
+
 endif
diff --git a/drivers/input/keyboard/Makefile b/drivers/input/keyboard/Makefile
index b5b5eae..1921bac 100644
--- a/drivers/input/keyboard/Makefile
+++ b/drivers/input/keyboard/Makefile
@@ -31,3 +31,4 @@  obj-$(CONFIG_KEYBOARD_STOWAWAY)		+= stowaway.o
 obj-$(CONFIG_KEYBOARD_SUNKBD)		+= sunkbd.o
 obj-$(CONFIG_KEYBOARD_TOSA)		+= tosakbd.o
 obj-$(CONFIG_KEYBOARD_XTKBD)		+= xtkbd.o
+obj-$(CONFIG_KEYBOARD_DAVINCI_DM365)	+= davinci_dm365_keypad.o
diff --git a/drivers/input/keyboard/davinci_dm365_keypad.c b/drivers/input/keyboard/davinci_dm365_keypad.c
new file mode 100644
index 0000000..616ddd5
--- /dev/null
+++ b/drivers/input/keyboard/davinci_dm365_keypad.c
@@ -0,0 +1,316 @@ 
+/*
+ * DaVinci DM365 Keypad Driver
+ *
+ * Copyright (C) 2009 Texas Instruments, Inc
+ *
+ * Author: Miguel Aguilar <miguel.aguilar@ridgerun.com>
+ *
+ * Intial Code: Sandeep Paulraj <s-paulraj@ti.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+#include <linux/module.h>
+#include <linux/init.h>
+#include <linux/interrupt.h>
+#include <linux/types.h>
+#include <linux/input.h>
+#include <linux/kernel.h>
+#include <linux/delay.h>
+#include <linux/platform_device.h>
+#include <linux/errno.h>
+
+#include <asm/irq.h>
+
+#include <mach/hardware.h>
+#include <mach/irqs.h>
+#include <mach/keypad.h>
+
+/* Keypad registers */
+#define DM365_KEYPAD_KEYCTRL		0x0000
+#define DM365_KEYPAD_INTENA		0x0004
+#define DM365_KEYPAD_INTFLAG		0x0008
+#define DM365_KEYPAD_INTCLR		0x000c
+#define DM365_KEYPAD_STRBWIDTH		0x0010
+#define DM365_KEYPAD_INTERVAL		0x0014
+#define DM365_KEYPAD_CONTTIME		0x0018
+#define DM365_KEYPAD_CURRENTST		0x001c
+#define DM365_KEYPAD_PREVSTATE		0x0020
+#define DM365_KEYPAD_EMUCTRL		0x0024
+#define DM365_KEYPAD_IODFTCTRL		0x002c
+
+/* Key Control Register (KEYCTRL) */
+#define DM365_KEYPAD_KEYEN		0x00000001
+#define DM365_KEYPAD_PREVMODE		0x00000002
+#define DM365_KEYPAD_CHATOFF		0x00000004
+#define DM365_KEYPAD_AUTODET		0x00000008
+#define DM365_KEYPAD_SCANMODE		0x00000010
+#define DM365_KEYPAD_OUTTYPE		0x00000020
+#define DM365_KEYPAD_4X4		0x00000040
+
+/* Masks for the interrupts */
+#define DM365_KEYPAD_INT_CONT		0x00000008
+#define DM365_KEYPAD_INT_OFF		0x00000004
+#define DM365_KEYPAD_INT_ON		0x00000002
+#define DM365_KEYPAD_INT_CHANGE		0x00000001
+#define DM365_KEYPAD_INT_ALL		0x0000000f
+
+struct davinci_kp {
+	struct input_dev		*input;
+	struct davinci_kp_platform_data	*pdata;
+	int				irq;
+	void __iomem			*base;
+	resource_size_t			pbase;
+	size_t				base_size;
+};
+
+static void dm365_kp_write(struct davinci_kp *dm365_kp, u32 val, u32 addr)
+{
+	u32 base = (u32)dm365_kp->base;
+
+	__raw_writel(val,(u32 *)(base + addr));
+}
+
+static u32 dm365_kp_read(struct davinci_kp *dm365_kp, u32 addr)
+{
+	u32 base = (u32)dm365_kp->base;
+
+	return __raw_readl((u32 *)(base + addr));
+}
+
+/* Initializing the kp Module */
+static void dm365_kp_initialize(struct davinci_kp *dm365_kp)
+{
+	u32 strobe = dm365_kp->pdata->strobe;
+	u32 interval = dm365_kp->pdata->interval;
+
+	/* Enable all interrupts */
+	dm365_kp_write(dm365_kp, DM365_KEYPAD_INT_ALL, DM365_KEYPAD_INTENA);
+
+	/* Clear interrupts if any */
+	dm365_kp_write(dm365_kp, DM365_KEYPAD_INT_ALL, DM365_KEYPAD_INTCLR);
+
+	/* Setup the scan period = strobe + interval */
+	dm365_kp_write(dm365_kp, strobe, DM365_KEYPAD_STRBWIDTH);
+	dm365_kp_write(dm365_kp, interval, DM365_KEYPAD_INTERVAL);
+	dm365_kp_write(dm365_kp, 0x01, DM365_KEYPAD_CONTTIME);
+
+	/* Enable Keyscan module and enable */
+	dm365_kp_write(dm365_kp, DM365_KEYPAD_AUTODET | DM365_KEYPAD_KEYEN,
+			DM365_KEYPAD_KEYCTRL);
+}
+
+static irqreturn_t dm365_kp_interrupt(int irq, void *dev_id)
+{
+	int i;
+	u32 prev_status, new_status, changed;
+	int keycode = KEY_UNKNOWN;
+	struct davinci_kp *dm365_kp = dev_id;
+	int *keymap = dm365_kp->pdata->keymap;
+	u32 keymapsize = dm365_kp->pdata->keymapsize;
+	struct device *dev = &dm365_kp->input->dev;
+
+	/* Disable interrupt */
+	dm365_kp_write(dm365_kp, 0x0, DM365_KEYPAD_INTENA);
+
+	/* Reading previous and new status of the keypad */
+	prev_status = dm365_kp_read(dm365_kp, DM365_KEYPAD_PREVSTATE);
+	new_status = dm365_kp_read(dm365_kp, DM365_KEYPAD_CURRENTST);
+
+	changed = prev_status ^ new_status;
+
+	for (i = 0; i < keymapsize; i++) {
+		if ((changed >> i) & 0x1) {
+			keycode = keymap[i];
+			if((new_status >> i) & 0x1) {
+				/* Report release */
+				input_report_key(dm365_kp->input, keycode, 0);
+				input_sync(dm365_kp->input);
+				dev_dbg(dev, "dm365_keypad: key %d released\n",
+						keycode);
+			} else {
+				/* Report press */
+				input_report_key(dm365_kp->input, keycode, 1);
+				input_sync(dm365_kp->input);
+				dev_dbg(dev, "dm365_keypad: key %d pressed\n",
+						keycode);
+			}
+		}
+	}
+
+	/* Clearing interrupt */
+	dm365_kp_write(dm365_kp, DM365_KEYPAD_INT_ALL, DM365_KEYPAD_INTCLR);
+
+	/* Enable interrupts */
+	dm365_kp_write(dm365_kp, 0x1, DM365_KEYPAD_INTENA);
+
+	return IRQ_HANDLED;
+}
+
+/*
+ * Registers keypad device with input sub system and configures
+ * DM365 keypad registers
+ */
+static int dm365_kp_probe(struct platform_device *pdev)
+{
+	struct davinci_kp *dm365_kp;
+	struct input_dev *key_dev;
+	struct resource *res, *mem;
+	int ret, i;
+	struct device * dev = &pdev->dev;
+	struct davinci_kp_platform_data *pdata = pdev->dev.platform_data;
+
+	if (!pdata->keymap) {
+		dev_dbg(dev, "No keymap from pdata\n");
+		return -EINVAL;
+	}
+
+	dm365_kp = kzalloc(sizeof *dm365_kp, GFP_KERNEL);
+	key_dev = input_allocate_device();
+
+	if (!dm365_kp || !key_dev) {
+		dev_dbg(dev, "Could not allocate input device\n");
+		return -ENOMEM;
+	}
+
+	platform_set_drvdata(pdev, dm365_kp);
+
+	dm365_kp->input = key_dev;
+
+	dm365_kp->irq = platform_get_irq(pdev, 0);
+	if (dm365_kp->irq <= 0) {
+		dev_dbg(dev, "%s: No DM365 Keypad irq\n", pdev->name);
+		goto fail1;
+	}
+
+	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+
+	dm365_kp->pbase = res->start;
+	dm365_kp->base_size = resource_size(res);
+
+	if (res)
+		mem = request_mem_region(res->start,
+					dm365_kp->base_size, pdev->name);
+	else
+		mem = NULL;
+
+	if (!mem) {
+		dev_dbg(dev,"%s: KEYSCAN registers at %08x are not free\n",
+			pdev->name, dm365_kp->pbase);
+		goto fail1;
+	}
+
+	dm365_kp->base = ioremap(res->start, dm365_kp->base_size);
+	if (dm365_kp->base == NULL) {
+		dev_dbg(dev,"%s: Can't ioremap MEM resource.\n", pdev->name);
+		goto fail2;
+	}
+
+	/* Enable auto repeat feature of Linux input subsystem */
+	if (pdata->rep)
+		__set_bit(EV_REP, key_dev->evbit);
+
+	/* Setup input device */
+	__set_bit(EV_KEY, key_dev->evbit);
+
+	/* Setup the keymap */
+	dm365_kp->pdata = pdata;
+
+	for (i = 0; i < dm365_kp->pdata->keymapsize; i++)
+		__set_bit(dm365_kp->pdata->keymap[i], key_dev->keybit);
+
+	key_dev->name = "dm365_keypad";
+	key_dev->phys = "dm365_keypad/input0";
+	key_dev->dev.parent = &pdev->dev;
+	key_dev->id.bustype = BUS_HOST;
+	key_dev->id.vendor = 0x0001;
+	key_dev->id.product = 0x0365;
+	key_dev->id.version = 0x0001;
+	key_dev->keycode = dm365_kp->pdata->keymap;
+	key_dev->keycodesize = sizeof(unsigned int);
+	key_dev->keycodemax = dm365_kp->pdata->keymapsize;
+
+	ret = input_register_device(dm365_kp->input);
+	if (ret < 0) {
+		dev_err(dev, "Unable to register DaVinci DM365 keypad device\n");
+		goto fail3;
+	}
+
+	ret = request_irq(dm365_kp->irq, dm365_kp_interrupt, IRQF_DISABLED,
+                         "dm365_keypad", dm365_kp);
+	if (ret < 0) {
+		dev_err(dev, "Unable to register DaVinci DM365 keypad Interrupt\n");
+		goto fail4;
+	}
+
+	dm365_kp_initialize(dm365_kp);
+
+	return 0;
+fail4:
+	input_unregister_device(dm365_kp->input);
+	key_dev = NULL;
+fail3:
+	iounmap(dm365_kp->base);
+fail2:
+	release_mem_region(dm365_kp->pbase, dm365_kp->base_size);
+fail1:
+	input_free_device(key_dev);
+	kfree(dm365_kp);
+
+	return -EINVAL;
+}
+
+static int __exit dm365_kp_remove(struct platform_device *pdev)
+{
+	struct davinci_kp *dm365_kp = platform_get_drvdata(pdev);
+
+	free_irq(dm365_kp->irq, dm365_kp);
+
+	iounmap(dm365_kp->base);
+	release_mem_region(dm365_kp->pbase, dm365_kp->base_size);
+
+	platform_set_drvdata(pdev, NULL);
+
+	input_unregister_device(dm365_kp->input);
+
+	kfree(dm365_kp);
+
+	return 0;
+}
+
+static struct platform_driver dm365_kp_driver = {
+	.driver = {
+			.name = "dm365_keypad",
+			.owner = THIS_MODULE,
+		},
+	.remove = __exit_p(dm365_kp_remove),
+};
+
+static int __init dm365_kp_init(void)
+{
+	printk(KERN_INFO "DaVinci DM365 Keypad Driver\n");
+
+	return platform_driver_probe(&dm365_kp_driver, dm365_kp_probe);
+}
+module_init(dm365_kp_init);
+
+static void __exit dm365_kp_exit(void)
+{
+	platform_driver_unregister(&dm365_kp_driver);
+}
+module_exit(dm365_kp_exit);
+
+MODULE_AUTHOR("Miguel Aguilar");
+MODULE_DESCRIPTION("Texas Instruments DaVinci DM365 EVM Keypad Driver");
+MODULE_LICENSE("GPL");