[PATCH v4 0/1] Input: serio - Add ARC PS/2 driver

[PATCH v4 0/1] Input: serio - Add ARC PS/2 driver

[Mischa Jonker]

main changes for v4:
* add timeout for arc_ps2_check_rx() in case of
  non responding hardware

main changes for v3:
* proper __iomem annotation
* correct return values in case of error

main changes for v2:
* dev_* instead of pr_*
* ioread32/iowrite32 instead of inl/outl
* use module_platform_driver macro
* disabling interrupt twice was unnecessary

New patch has been tested on our own architecture (ARC) and
builds cleanly on x86-64.

Mischa Jonker (1):
  Input: serio - Add ARC PS/2 driver

 drivers/input/serio/Kconfig   |    9 ++
 drivers/input/serio/Makefile  |    1 +
 drivers/input/serio/arc_ps2.c |  275 +++++++++++++++++++++++++++++++++++++++++
 3 files changed, 285 insertions(+), 0 deletions(-)
 create mode 100644 drivers/input/serio/arc_ps2.c

[PATCH v4 1/1] Input: serio - Add ARC PS/2 driver

[Mischa Jonker]

This adds support for the PS/2 block that is used in various ARC FPGA
platforms.

Signed-off-by: Mischa Jonker <mischa.jonker@synopsys.com>
---
 drivers/input/serio/Kconfig   |    9 ++
 drivers/input/serio/Makefile  |    1 +
 drivers/input/serio/arc_ps2.c |  280 +++++++++++++++++++++++++++++++++++++++++
 3 files changed, 290 insertions(+), 0 deletions(-)
 create mode 100644 drivers/input/serio/arc_ps2.c

diff --git a/drivers/input/serio/Kconfig b/drivers/input/serio/Kconfig
index 55f2c22..4a4e182 100644
--- a/drivers/input/serio/Kconfig
+++ b/drivers/input/serio/Kconfig
@@ -234,4 +234,13 @@ config SERIO_PS2MULT
 	  To compile this driver as a module, choose M here: the
 	  module will be called ps2mult.
 
+config SERIO_ARC_PS2
+	tristate "ARC PS/2 support"
+	help
+	  Say Y here if you have an ARC FPGA platform with a PS/2
+	  controller in it.
+
+	  To compile this driver as a module, choose M here; the module
+	  will be called arc_ps2.
+
 endif
diff --git a/drivers/input/serio/Makefile b/drivers/input/serio/Makefile
index dbbe376..4b0c8f8 100644
--- a/drivers/input/serio/Makefile
+++ b/drivers/input/serio/Makefile
@@ -25,3 +25,4 @@ obj-$(CONFIG_SERIO_RAW)		+= serio_raw.o
 obj-$(CONFIG_SERIO_AMS_DELTA)	+= ams_delta_serio.o
 obj-$(CONFIG_SERIO_XILINX_XPS_PS2)	+= xilinx_ps2.o
 obj-$(CONFIG_SERIO_ALTERA_PS2)	+= altera_ps2.o
+obj-$(CONFIG_SERIO_ARC_PS2)	+= arc_ps2.o
diff --git a/drivers/input/serio/arc_ps2.c b/drivers/input/serio/arc_ps2.c
new file mode 100644
index 0000000..38aa361
--- /dev/null
+++ b/drivers/input/serio/arc_ps2.c
@@ -0,0 +1,280 @@
+/*
+ * Copyright (C) 2004, 2007-2010, 2011-2012 Synopsys, Inc. (www.synopsys.com)
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2 as
+ * published by the Free Software Foundation.
+ *
+ * Driver is originally developed by Pavel Sokolov <psokolov@synopsys.com>
+ */
+
+#include <linux/module.h>
+#include <linux/interrupt.h>
+#include <linux/input.h>
+#include <linux/serio.h>
+#include <linux/platform_device.h>
+#include <linux/io.h>
+#include <linux/kernel.h>
+#include <linux/slab.h>
+
+#define ARC_PS2_PORTS                   (2)
+
+#define ARC_ARC_PS2_ID                  (0x0001f609)
+
+#define STAT_TIMEOUT                    (128)
+
+#define PS2_STAT_RX_FRM_ERR             (1)
+#define PS2_STAT_RX_BUF_OVER            (1 << 1)
+#define PS2_STAT_RX_INT_EN              (1 << 2)
+#define PS2_STAT_RX_VAL                 (1 << 3)
+#define PS2_STAT_TX_ISNOT_FUL           (1 << 4)
+#define PS2_STAT_TX_INT_EN              (1 << 5)
+
+struct arc_ps2_port {
+	void __iomem *data_addr, *status_addr;
+	struct serio *io;
+};
+
+struct arc_ps2_data {
+	struct arc_ps2_port port[ARC_PS2_PORTS];
+	struct resource *iomem_res;
+	int irq;
+	void __iomem *addr;
+	unsigned int frame_error;
+	unsigned int buf_overflow;
+	unsigned int total_int;
+};
+
+static void arc_ps2_check_rx(struct arc_ps2_data *arc_ps2,
+			     struct arc_ps2_port *port)
+{
+	unsigned int flag, status, timeout;
+	unsigned char data;
+
+	timeout = 1000;
+	while (1) {
+		status = ioread32(port->status_addr);
+		if ((!(status & PS2_STAT_RX_VAL)) || (!(--timeout)))
+			break;
+		flag = 0;
+
+		arc_ps2->total_int++;
+		if (status & PS2_STAT_RX_FRM_ERR) {
+			arc_ps2->frame_error++;
+			flag |= SERIO_PARITY;
+		} else if (status & PS2_STAT_RX_BUF_OVER) {
+			arc_ps2->buf_overflow++;
+			flag |= SERIO_FRAME;
+		}
+		data = ioread32(port->data_addr) & 0xff;
+
+		serio_interrupt(port->io, data, flag);
+	}
+
+	if (!timeout)
+		dev_err(&port->io->dev, "PS/2 hardware stuck\n");
+}
+
+static irqreturn_t arc_ps2_interrupt(int irq, void *dev)
+{
+	struct arc_ps2_data *arc_ps2 = dev;
+	int i;
+
+	for (i = 0; i < ARC_PS2_PORTS; i++)
+		arc_ps2_check_rx(arc_ps2, &arc_ps2->port[i]);
+
+	return IRQ_HANDLED;
+}
+
+static int arc_ps2_write(struct serio *io, unsigned char val)
+{
+	unsigned status;
+	struct arc_ps2_port *port = io->port_data;
+	int timeout = STAT_TIMEOUT;
+
+	do {
+		status = ioread32(port->status_addr);
+		cpu_relax();
+		timeout--;
+	} while (!(status & PS2_STAT_TX_ISNOT_FUL) && timeout);
+
+	if (timeout) {
+		iowrite32(val & 0xff, port->data_addr);
+	} else {
+		dev_err(&io->dev, "write timeout\n");
+		return -ETIMEDOUT;
+	}
+
+	return 0;
+}
+
+static int arc_ps2_open(struct serio *io)
+{
+	struct arc_ps2_port *port = io->port_data;
+	iowrite32(PS2_STAT_RX_INT_EN, port->status_addr);
+	return 0;
+}
+
+static void arc_ps2_close(struct serio *io)
+{
+	struct arc_ps2_port *port = io->port_data;
+
+	iowrite32(ioread32(port->status_addr) & ~PS2_STAT_RX_INT_EN,
+		  port->status_addr);
+}
+
+static int __devinit arc_ps2_allocate_port(struct platform_device *pdev,
+					   struct arc_ps2_port *port,
+					   int index, void *base)
+{
+	struct serio *io;
+
+	io = kzalloc(sizeof(struct serio), GFP_KERNEL);
+	if (!io)
+		return -ENOMEM;
+
+	io->id.type = SERIO_8042;
+	io->write = arc_ps2_write;
+	io->open = arc_ps2_open;
+	io->close = arc_ps2_close;
+	snprintf(io->name, sizeof(io->name), "ARC PS/2 port%d", index);
+	snprintf(io->phys, sizeof(io->phys), "arc/serio%d", index);
+	io->port_data = port;
+
+	port->io = io;
+
+	port->data_addr = base + 4 + index * 4;
+	port->status_addr = base + 4 + ARC_PS2_PORTS * 4 + index * 4;
+
+	dev_dbg(&pdev->dev, "port%d is allocated (data = 0x%p, status = 0x%p)\n",
+		index, port->data_addr, port->status_addr);
+
+	return 0;
+}
+
+static int __devinit arc_ps2_probe(struct platform_device *pdev)
+{
+	struct arc_ps2_data *arc_ps2;
+	int error, id, i;
+
+	arc_ps2 = kzalloc(sizeof(struct arc_ps2_data), GFP_KERNEL);
+	if (!arc_ps2) {
+		dev_err(&pdev->dev, "out of memory\n");
+		error = -ENOMEM;
+		goto out;
+	}
+
+	arc_ps2->iomem_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+	if (!arc_ps2->iomem_res) {
+		dev_err(&pdev->dev, "no IO memory defined\n");
+		error = -EINVAL;
+		goto out_free;
+	}
+
+	arc_ps2->irq = platform_get_irq_byname(pdev, "arc_ps2_irq");
+	if (arc_ps2->irq < 0) {
+		dev_err(&pdev->dev, "no IRQ defined\n");
+		error = -EINVAL;
+		goto out_free;
+	}
+
+	if (!request_mem_region(arc_ps2->iomem_res->start,
+	    resource_size(arc_ps2->iomem_res), pdev->name)) {
+		dev_err(&pdev->dev, "memory region allocation failed for %pR\n",
+			arc_ps2->iomem_res);
+
+		error = -EBUSY;
+		goto out_free;
+	}
+
+	arc_ps2->addr = ioremap_nocache(arc_ps2->iomem_res->start,
+					resource_size(arc_ps2->iomem_res));
+	if (!arc_ps2->addr) {
+		dev_err(&pdev->dev, "memory mapping failed\n");
+		error = -ENOMEM;
+		goto out_release_region;
+	}
+
+	dev_info(&pdev->dev, "irq = %d, address = 0x%p, ports = %i\n",
+		 arc_ps2->irq, arc_ps2->addr, ARC_PS2_PORTS);
+
+	id = ioread32(arc_ps2->addr);
+	if (id != ARC_ARC_PS2_ID) {
+		dev_err(&pdev->dev, "device id does not match\n");
+		error = -ENXIO;
+		goto out_unmap;
+	}
+
+	platform_set_drvdata(pdev, arc_ps2);
+
+	for (i = 0; i < ARC_PS2_PORTS; i++) {
+		error = arc_ps2_allocate_port(pdev, &arc_ps2->port[i], i,
+					    arc_ps2->addr);
+		if (error)
+			goto release;
+		serio_register_port(arc_ps2->port[i].io);
+	}
+
+	error = request_irq(arc_ps2->irq, arc_ps2_interrupt, 0,
+			    "arc_ps2", arc_ps2);
+	if (error) {
+		dev_err(&pdev->dev, "Could not allocate IRQ\n");
+		goto release;
+	}
+
+	return 0;
+
+release:
+	for (i = 0; i < ARC_PS2_PORTS; i++) {
+		if (arc_ps2->port[i].io)
+			serio_unregister_port(arc_ps2->port[i].io);
+	}
+out_unmap:
+	iounmap(arc_ps2->addr);
+out_release_region:
+	release_mem_region(arc_ps2->iomem_res->start,
+			   resource_size(arc_ps2->iomem_res));
+out_free:
+	kfree(arc_ps2);
+out:
+	return error;
+}
+
+static int __devexit arc_ps2_remove(struct platform_device *pdev)
+{
+	struct arc_ps2_data *arc_ps2;
+	int i;
+
+	arc_ps2 = platform_get_drvdata(pdev);
+	for (i = 0; i < ARC_PS2_PORTS; i++)
+		serio_unregister_port(arc_ps2->port[i].io);
+
+	free_irq(arc_ps2->irq, arc_ps2);
+	iounmap(arc_ps2->addr);
+	release_mem_region(arc_ps2->iomem_res->start,
+			   resource_size(arc_ps2->iomem_res));
+
+	dev_dbg(&pdev->dev, "interrupt count = %i\n", arc_ps2->total_int);
+	dev_dbg(&pdev->dev, "frame error count = %i\n", arc_ps2->frame_error);
+	dev_dbg(&pdev->dev, "buffer overflow count = %i\n",
+		arc_ps2->buf_overflow);
+
+	kfree(arc_ps2);
+
+	return 0;
+}
+
+static struct platform_driver arc_ps2_driver = {
+	.driver = {
+		   .name = "arc_ps2",
+		   .owner = THIS_MODULE,
+		   },
+	.probe = arc_ps2_probe,
+	.remove = __devexit_p(arc_ps2_remove),
+};
+
+module_platform_driver(arc_ps2_driver);
+
+MODULE_LICENSE("GPL");
+MODULE_AUTHOR("Pavel Sokolov <psokolov@synopsys.com>");
+MODULE_DESCRIPTION("ARC PS/2 Driver");
-- 
1.7.0.4

Re: [PATCH v4 1/1] Input: serio - Add ARC PS/2 driver

[Dmitry Torokhov]

On Thu, Oct 18, 2012 at 11:28:58AM +0200, Mischa Jonker wrote:
> This adds support for the PS/2 block that is used in various ARC FPGA
> platforms.

Applied with minor edits, please take a look at my 'next' branch and
holler if you see something wrong.

BTW, does the patch below work for you?

Thanks.

-- 
Dmitry


Input: arc_ps2 - switch to using managed resources

Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
---

 drivers/input/serio/arc_ps2.c |  123 ++++++++++++++++++++---------------------
 1 file changed, 59 insertions(+), 64 deletions(-)


diff --git a/drivers/input/serio/arc_ps2.c b/drivers/input/serio/arc_ps2.c
index f8c026a..89ad763 100644
--- a/drivers/input/serio/arc_ps2.c
+++ b/drivers/input/serio/arc_ps2.c
@@ -38,8 +38,6 @@ struct arc_ps2_port {
 
 struct arc_ps2_data {
 	struct arc_ps2_port port[ARC_PS2_PORTS];
-	struct resource *iomem_res;
-	int irq;
 	void __iomem *addr;
 	unsigned int frame_error;
 	unsigned int buf_overflow;
@@ -125,6 +123,32 @@ static void arc_ps2_close(struct serio *io)
 		  port->status_addr);
 }
 
+static void __iomem * __devinit arc_ps2_calc_addr(struct arc_ps2_data *arc_ps2,
+						  int index, bool status)
+{
+	void __iomem *addr;
+
+	addr = arc_ps2->addr + 4 + 4 * index;
+	if (status)
+		addr += ARC_PS2_PORTS * 4;
+
+	return addr;
+}
+
+static void __devinit arc_ps2_inhibit_ports(struct arc_ps2_data *arc_ps2)
+{
+	void __iomem *addr;
+	u32 val;
+	int i;
+
+	for (i = 0; i < ARC_PS2_PORTS; i++) {
+		addr = arc_ps2_calc_addr(arc_ps2, i, true);
+		val = ioread32(addr);
+		val &= ~(PS2_STAT_RX_INT_EN | PS2_STAT_TX_INT_EN);
+		iowrite32(val, addr);
+	}
+}
+
 static int __devinit arc_ps2_create_port(struct platform_device *pdev,
 					 struct arc_ps2_data *arc_ps2,
 					 int index)
@@ -146,8 +170,8 @@ static int __devinit arc_ps2_create_port(struct platform_device *pdev,
 
 	port->io = io;
 
-	port->data_addr = arc_ps2->addr + 4 + index * 4;
-	port->status_addr = arc_ps2->addr + 4 + ARC_PS2_PORTS * 4 + index * 4;
+	port->data_addr = arc_ps2_calc_addr(arc_ps2, index, false);
+	port->status_addr = arc_ps2_calc_addr(arc_ps2, index, true);
 
 	dev_dbg(&pdev->dev, "port%d is allocated (data = 0x%p, status = 0x%p)\n",
 		index, port->data_addr, port->status_addr);
@@ -159,85 +183,63 @@ static int __devinit arc_ps2_create_port(struct platform_device *pdev,
 static int __devinit arc_ps2_probe(struct platform_device *pdev)
 {
 	struct arc_ps2_data *arc_ps2;
+	struct resource *res;
+	int irq;
 	int error, id, i;
 
-	arc_ps2 = kzalloc(sizeof(struct arc_ps2_data), GFP_KERNEL);
-	if (!arc_ps2) {
-		dev_err(&pdev->dev, "out of memory\n");
-		return -ENOMEM;
-	}
-
-	arc_ps2->iomem_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
-	if (!arc_ps2->iomem_res) {
+	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+	if (!res) {
 		dev_err(&pdev->dev, "no IO memory defined\n");
-		error = -EINVAL;
-		goto err_free_mem;
+		return -EINVAL;
 	}
 
-	arc_ps2->irq = platform_get_irq_byname(pdev, "arc_ps2_irq");
-	if (arc_ps2->irq < 0) {
+	irq = platform_get_irq_byname(pdev, "arc_ps2_irq");
+	if (irq < 0) {
 		dev_err(&pdev->dev, "no IRQ defined\n");
-		error = -EINVAL;
-		goto err_free_mem;
+		return -EINVAL;
 	}
 
-	if (!request_mem_region(arc_ps2->iomem_res->start,
-	    resource_size(arc_ps2->iomem_res), pdev->name)) {
-		dev_err(&pdev->dev, "memory region allocation failed for %pR\n",
-			arc_ps2->iomem_res);
-
-		error = -EBUSY;
-		goto err_free_mem;
+	arc_ps2 = devm_kzalloc(&pdev->dev, sizeof(struct arc_ps2_data),
+				GFP_KERNEL);
+	if (!arc_ps2) {
+		dev_err(&pdev->dev, "out of memory\n");
+		return -ENOMEM;
 	}
 
-	arc_ps2->addr = ioremap_nocache(arc_ps2->iomem_res->start,
-					resource_size(arc_ps2->iomem_res));
-	if (!arc_ps2->addr) {
-		dev_err(&pdev->dev, "memory mapping failed\n");
-		error = -ENOMEM;
-		goto err_release_region;
-	}
+	arc_ps2->addr = devm_request_and_ioremap(&pdev->dev, res);
+	if (!arc_ps2->addr)
+		return -EBUSY;
 
 	dev_info(&pdev->dev, "irq = %d, address = 0x%p, ports = %i\n",
-		 arc_ps2->irq, arc_ps2->addr, ARC_PS2_PORTS);
+		 irq, arc_ps2->addr, ARC_PS2_PORTS);
 
 	id = ioread32(arc_ps2->addr);
 	if (id != ARC_ARC_PS2_ID) {
 		dev_err(&pdev->dev, "device id does not match\n");
-		error = -ENXIO;
-		goto err_unmap;
+		return -ENXIO;
 	}
 
-	for (i = 0; i < ARC_PS2_PORTS; i++) {
-		error = arc_ps2_create_port(pdev, arc_ps2, i);
-		if (error)
-			goto err_unregister_ports;
-	}
+	arc_ps2_inhibit_ports(arc_ps2);
 
-	error = request_irq(arc_ps2->irq, arc_ps2_interrupt, 0,
-			    "arc_ps2", arc_ps2);
+	error = devm_request_irq(&pdev->dev, irq, arc_ps2_interrupt,
+				 0, "arc_ps2", arc_ps2);
 	if (error) {
 		dev_err(&pdev->dev, "Could not allocate IRQ\n");
-		goto err_unregister_ports;
+		return error;
+	}
+
+	for (i = 0; i < ARC_PS2_PORTS; i++) {
+		error = arc_ps2_create_port(pdev, arc_ps2, i);
+		if (error) {
+			while (--i >= 0)
+				serio_unregister_port(arc_ps2->port[i].io);
+			return error;
+		}
 	}
 
 	platform_set_drvdata(pdev, arc_ps2);
 
 	return 0;
-
-err_unregister_ports:
-	for (i = 0; i < ARC_PS2_PORTS; i++) {
-		if (arc_ps2->port[i].io)
-			serio_unregister_port(arc_ps2->port[i].io);
-	}
-err_unmap:
-	iounmap(arc_ps2->addr);
-err_release_region:
-	release_mem_region(arc_ps2->iomem_res->start,
-			   resource_size(arc_ps2->iomem_res));
-err_free_mem:
-	kfree(arc_ps2);
-	return error;
 }
 
 static int __devexit arc_ps2_remove(struct platform_device *pdev)
@@ -248,18 +250,11 @@ static int __devexit arc_ps2_remove(struct platform_device *pdev)
 	for (i = 0; i < ARC_PS2_PORTS; i++)
 		serio_unregister_port(arc_ps2->port[i].io);
 
-	free_irq(arc_ps2->irq, arc_ps2);
-	iounmap(arc_ps2->addr);
-	release_mem_region(arc_ps2->iomem_res->start,
-			   resource_size(arc_ps2->iomem_res));
-
 	dev_dbg(&pdev->dev, "interrupt count = %i\n", arc_ps2->total_int);
 	dev_dbg(&pdev->dev, "frame error count = %i\n", arc_ps2->frame_error);
 	dev_dbg(&pdev->dev, "buffer overflow count = %i\n",
 		arc_ps2->buf_overflow);
 
-	kfree(arc_ps2);
-
 	return 0;
 }
 

RE: [PATCH v4 1/1] Input: serio - Add ARC PS/2 driver

[Mischa Jonker]

Hi Dmitry,


> > This adds support for the PS/2 block that is used in various ARC FPGA 
> > platforms.
> Applied with minor edits, please take a look at my 'next' branch and holler if you see something wrong.

Looks good & works fine, thanks for applying!


> BTW, does the patch below work for you?
> [patch to use managed resources]

Looks good to me. Tested, works OK. 


Thanks,

Mischa