Skip to contentSkip to conversation

r8a77961 CMT test setup using UIO

PATCH In review Magnus Damm 2 participants 5 messages Sep 20, 2020 – Sep 23, 2020

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

cover r8a77961 CMT test setup using UIO

r8a77961 CMT test setup using UIO

[PATCH 1/2] r8a77961 CMT0 device exposed via UIO
[PATCH 2/2] UIO CMT test program

These two patches contain kernel and user space modificatons to allow some basic testing from user space of the CMT0 device included on the r8a77961 SoC.

For the kernel, simply apply the kernel patch (including a few debug printouts) and make sure to extend your kernel config with CONFIG_UIO_PDRV_GENIRQ=y.

The following log shows how to execute the test program on the target:

# ./uio-cmt-test
found matching UIO device at /sys/class/uio/uio0/
CLKE
CMCSR
CMCOR
[   12.284451] irqhandler 20
waiting 10s
UIO write
CLKE
UIO read
got CMT IRQ
CLKE
#

Please note that only a few registers of a single channel of the CMT0 device has been exercised. The kernel debug printout and /proc/interrupts may be used to verify that at least one interrupt has been delivered.

One limitation with the current setup is that the UIO kernel driver only supports a single interrupt however the CMT devices come with one interrupt per channel on R-Car Gen3. Currently the code only uses a single IRQ.

If it turns out that the current test coverage should be extended then perhaps it would be wise to also extend the UIO kernel driver with support for multiple interrupts as well. To maintain the same user space interface the UIO driver can simply have a list of interrupts associated with each device and then enable/disable all of them on each IRQ. Not fast but good enough for testing.

The code applies cleanly on renesas-drivers-2020-09-15-v5.9-rc5 from the renesas-drivers repo on kernel.org. Testing has been performed remotely on r8a77961 Salvator-XS but should be easy enough to move to more or less any other SoC with any kind of memory mapped device. Devices that do not support bus mastering (like the CMT) can be safely used without any IOMMU.

Not-Yet-Signed-off-by Magnus Damm <[email protected]>

---

 arch/arm64/boot/dts/renesas/r8a77961.dtsi |   10 +
 drivers/uio/uio.c                         |    3 
 drivers/uio/uio_pdrv_genirq.c             |   10 +
 uio-cmt-test-20200919.c                   |  190 +++++++++++++++++++++++++++++
 4 files changed, 210 insertions(+), 3 deletions(-)
#1 lore raw

PATCH 1/2 r8a77961 CMT0 device exposed via UIO

From: Magnus Damm <[email protected]>

Device Tree modifications to expose CMT0 via UIO, code to add UIO driver debug code and also adjust the compat string matching in MODULE_DEVICE_TABLE()

---

 arch/arm64/boot/dts/renesas/r8a77961.dtsi |   10 ++++++++++
 drivers/uio/uio.c                         |    3 ++-
 drivers/uio/uio_pdrv_genirq.c             |   10 ++++++++--
 3 files changed, 20 insertions(+), 3 deletions(-)
arch/arm64/boot/dts/renesas/r8a77961.dtsi +10 -0
@@ -453,6 +453,16 @@
 			reg = <0 0xe6060000 0 0x50c>;
 		};
 
+		cmt0: timer@e60f0000 {
+			compatible = "uio_pdrv_genirq";
+			reg = <0 0xe60f0000 0 0x1004>;
+			interrupts = <GIC_SPI 142 IRQ_TYPE_LEVEL_HIGH>;
+			clocks = <&cpg CPG_MOD 303>;
+			clock-names = "fck";
+			power-domains = <&sysc R8A77961_PD_ALWAYS_ON>;
+			resets = <&cpg 303>;
+		};
+
 		cpg: clock-controller@e6150000 {
 			compatible = "renesas,r8a77961-cpg-mssr";
 			reg = <0 0xe6150000 0 0x1000>;
drivers/uio/uio.c +2 -1
@@ -11,7 +11,7 @@
  *
  * Base Functions
  */
-
+#define DEBUG
 #include <linux/module.h>
 #include <linux/init.h>
 #include <linux/poll.h>
@@ -975,6 +975,7 @@ int __uio_register_device(struct module
 		 * FDs at the time of unregister and therefore may not be
 		 * freed until they are released.
 		 */
+		pr_debug("uio request_irq %lu\n", info->irq);
 		ret = request_irq(info->irq, uio_interrupt,
 				  info->irq_flags, info->name, idev);
 		if (ret) {
drivers/uio/uio_pdrv_genirq.c +8 -2
@@ -10,7 +10,7 @@
  * Copyright (C) 2008 by Digi International Inc.
  * All rights reserved.
  */
-
+#define DEBUG
 #include <linux/platform_device.h>
 #include <linux/uio_driver.h>
 #include <linux/spinlock.h>
@@ -66,6 +66,8 @@ static irqreturn_t uio_pdrv_genirq_handl
 	 * remember the state so we can allow user space to enable it later.
 	 */
 
+	pr_debug("irqhandler %d\n", irq);
+
 	spin_lock(&priv->lock);
 	if (!__test_and_set_bit(UIO_IRQ_DISABLED, &priv->flags))
 		disable_irq_nosync(irq);
@@ -87,6 +89,8 @@ static int uio_pdrv_genirq_irqcontrol(st
 	 * with irq handler on SMP systems.
 	 */
 
+	pr_debug("irqcontrol %d\n", irq_on);
+	
 	spin_lock_irqsave(&priv->lock, flags);
 	if (irq_on) {
 		if (__test_and_clear_bit(UIO_IRQ_DISABLED, &priv->flags))
@@ -172,6 +176,8 @@ static int uio_pdrv_genirq_probe(struct
 		}
 	}
 
+	pr_debug("uio irq %lu\n", uioinfo->irq);
+	
 	if (uioinfo->irq) {
 		struct irq_data *irq_data = irq_get_irq_data(uioinfo->irq);
 
@@ -276,7 +282,7 @@ static const struct dev_pm_ops uio_pdrv_
 
 #ifdef CONFIG_OF
 static struct of_device_id uio_of_genirq_match[] = {
-	{ /* This is filled with module_parm */ },
+	{ .compatible = "uio_pdrv_genirq", },
 	{ /* Sentinel */ },
 };
 MODULE_DEVICE_TABLE(of, uio_of_genirq_match);
#2 lore raw

Re: [PATCH 1/2] r8a77961 CMT0 device exposed via UIO

Hi Magnus,

Quoted 6 lines · Magnus Damm

From: Magnus Damm <[email protected]>

Device Tree modifications to expose CMT0 via UIO, code to add UIO driver debug code and also adjust the compat string matching in MODULE_DEVICE_TABLE()

Thanks for your patch!

Quoted 4 lines
 arch/arm64/boot/dts/renesas/r8a77961.dtsi |   10 ++++++++++
 drivers/uio/uio.c                         |    3 ++-
 drivers/uio/uio_pdrv_genirq.c             |   10 ++++++++--
 3 files changed, 20 insertions(+), 3 deletions(-)

Please don't mix DTS and driver changes in a single patch.

arch/arm64/boot/dts/renesas/r8a77961.dtsi 2020-09-20 06:37:14.578864063 +0900 line 457

Quoted 8 lines
arch/arm64/boot/dts/renesas/r8a77961.dtsi 2020-09-20 06:37:14.578864063 +0900 renamed from arch/arm64/boot/dts/renesas/r8a77961.dtsi +2 -0
@@ -453,6 +453,16 @@
                        reg = <0 0xe6060000 0 0x50c>;
                };
 
+               cmt0: timer@e60f0000 {
+                       compatible = "uio_pdrv_genirq";

Please use an appropriate compatible value, describing the device. DT describes hardware, not software policy.

arch/arm64/boot/dts/renesas/r8a77961.dtsi 2020-09-20 06:37:14.578864063 +0900 line 463

Quoted 6 lines
arch/arm64/boot/dts/renesas/r8a77961.dtsi 2020-09-20 06:37:14.578864063 +0900 renamed from arch/arm64/boot/dts/renesas/r8a77961.dtsi +6 -0
+                       reg = <0 0xe60f0000 0 0x1004>;
+                       interrupts = <GIC_SPI 142 IRQ_TYPE_LEVEL_HIGH>;
+                       clocks = <&cpg CPG_MOD 303>;
+                       clock-names = "fck";
+                       power-domains = <&sysc R8A77961_PD_ALWAYS_ON>;
+                       resets = <&cpg 303>;

status = "disabled"; ?

arch/arm64/boot/dts/renesas/r8a77961.dtsi 2020-09-20 06:37:14.578864063 +0900 line 464

Quoted 1 line
arch/arm64/boot/dts/renesas/r8a77961.dtsi 2020-09-20 06:37:14.578864063 +0900 renamed from arch/arm64/boot/dts/renesas/r8a77961.dtsi +1 -0
+               };

While at it, please add the other CMT instances, too.

drivers/uio/uio.c 2020-09-20 07:58:51.295172430 +0900 line 14

Quoted 12 lines
arch/arm64/boot/dts/renesas/r8a77961.dtsi 2020-09-20 06:37:14.578864063 +0900 renamed from arch/arm64/boot/dts/renesas/r8a77961.dtsi +1 -0
+
                cpg: clock-controller@e6150000 {
                        compatible = "renesas,r8a77961-cpg-mssr";
                        reg = <0 0xe6150000 0 0x1000>;
drivers/uio/uio.c 2020-09-20 07:58:51.295172430 +0900 renamed from drivers/uio/uio.c +1 -1
@@ -11,7 +11,7 @@
  *
  * Base Functions
  */
-
+#define DEBUG

I don't think this is appropriate for upstream inclusion.

drivers/uio/uio_pdrv_genirq.c 2020-09-20 07:58:07.417169667 +0900 line 13

Quoted 8 lines
drivers/uio/uio_pdrv_genirq.c 2020-09-20 07:58:07.417169667 +0900 renamed from drivers/uio/uio_pdrv_genirq.c +1 -1
@@ -10,7 +10,7 @@
  * Copyright (C) 2008 by Digi International Inc.
  * All rights reserved.
  */
-
+#define DEBUG

Likewise.

drivers/uio/uio_pdrv_genirq.c 2020-09-20 07:58:07.417169667 +0900 static const struct dev_pm_ops uio_pdrv_ · line 285

Quoted 10 lines
drivers/uio/uio_pdrv_genirq.c 2020-09-20 07:58:07.417169667 +0900 renamed from drivers/uio/uio_pdrv_genirq.c +1 -1
 #include <linux/platform_device.h>
 #include <linux/uio_driver.h>
 #include <linux/spinlock.h>
@@ -276,7 +282,7 @@ static const struct dev_pm_ops uio_pdrv_
 
 #ifdef CONFIG_OF
 static struct of_device_id uio_of_genirq_match[] = {
-       { /* This is filled with module_parm */ },
+       { .compatible = "uio_pdrv_genirq", },

This does not look like a proper compatible value.

drivers/uio/uio_pdrv_genirq.c 2020-09-20 07:58:07.417169667 +0900 static const struct dev_pm_ops uio_pdrv_ · line 288

Quoted 3 lines
drivers/uio/uio_pdrv_genirq.c 2020-09-20 07:58:07.417169667 +0900 renamed from drivers/uio/uio_pdrv_genirq.c +0 -0
        { /* Sentinel */ },
 };
 MODULE_DEVICE_TABLE(of, uio_of_genirq_match);

Note that you can bind this driver to your device without modifying this driver, by using one of:
1. modprobe uio_pdrv_genirq of_id=my-compatible-value
2. echo uio_pdrv_genirq >
/sys/bus/platform/devices/e60f0000.timer/driver_override
echo e60f0000.timer > sys/bus/platform/drivers/uio_pdrv_genirq/bind

Gr{oetje,eeting}s,

Geert

Signature · 5 lines
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected]

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds
#3 lore raw

PATCH 2/2 UIO CMT test program

In reply to Magnus Damm
uio-cmt-test-20200919.c new file +190 -0
@@ -0,0 +1,190 @@
+/*
+ * uio-cmt-test-20200919.c - UIO CMT example test code, 20200919 Magnus Damm
+ *
+ * A small linux program that programs the CMT timer and waits for IRQ
+ *
+ * Compile for Linux using:
+ * $ cross-gcc -o uio-cmt-test uio-cmt-test.c
+ * 
+ * Designed to work with the Linux UIO kernel driver uio_pdrv_genirq.c
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <string.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <sys/mman.h>
+#include <fcntl.h>
+
+static int fgets_with_openclose(char *fname, char *buf, size_t maxlen) {
+       FILE *fp;
+
+       if ((fp = fopen(fname, "r")) != NULL) {
+               fgets(buf, maxlen, fp);
+               fclose(fp);
+               return strlen(buf);
+       } else {
+               return -1;
+       }
+}
+
+struct uio_device {
+       char *name;
+       char *path;
+       int fd;
+};
+
+#define MAXUIOIDS  100
+#define MAXNAMELEN 256
+
+static int locate_uio_device(char *name, struct uio_device *udp)
+{
+       char fname[MAXNAMELEN], buf[MAXNAMELEN];
+       int uio_id, i;
+
+       for (uio_id = 0; uio_id < MAXUIOIDS; uio_id++) {
+               sprintf(fname, "/sys/class/uio/uio%d/name", uio_id);
+               if (fgets_with_openclose(fname, buf, MAXNAMELEN) < 0)
+                       continue;
+               if (strncmp(name, buf, strlen(name)) == 0)
+                       break;
+       }
+
+       if (uio_id >= MAXUIOIDS)
+               return -1;
+
+       udp->name = strdup(buf);
+       udp->path = strdup(fname);
+       udp->path[strlen(udp->path) - 4] = '\0';
+
+       sprintf(buf, "/dev/uio%d", uio_id);
+       udp->fd = open(buf, O_RDWR|O_SYNC /*| O_NONBLOCK*/);
+
+       if (udp->fd < 0) {
+               perror("open");
+               return -1;
+       }
+
+       return 0;
+}
+
+#define CMT_CMCLKE 0x1000 /* start/stop register, some bits reserved as 1 */
+#define CMT_CMCLKE_CH0 0x20 /* set bit to one to start channel */
+#define CMT_CMCSR 0x510 /* 0x124 enables interrupts and selects CLK/8 */
+#define CMT_CMCNT 0x514 /* counting up, set to 0 */
+#define CMT_CMCOR 0x518 /* match value, set to ~0 */
+
+struct uio_map {
+       unsigned long address;
+       unsigned long size;
+       void *iomem;
+};
+
+static int setup_uio_map(struct uio_device *udp, int nr, struct uio_map *ump)
+{
+       char fname[MAXNAMELEN], buf[MAXNAMELEN];
+ 
+       sprintf(fname, "%s/maps/map%d/addr", udp->path, nr);
+       if (fgets_with_openclose(fname, buf, MAXNAMELEN) <= 0)
+               return -1;
+
+       ump->address = strtoul(buf, NULL, 0);
+
+       sprintf(fname, "%s/maps/map%d/size", udp->path, nr);
+       if (fgets_with_openclose(fname, buf, MAXNAMELEN) <= 0)
+               return -1;
+
+       ump->size = strtoul(buf, NULL, 0);
+
+       ump->iomem = mmap(0, ump->size,
+                         PROT_READ|PROT_WRITE, MAP_SHARED,
+                         udp->fd, nr * getpagesize());
+
+       if (ump->iomem == MAP_FAILED)
+               return -1;
+
+       return 0;
+}
+
+struct uio_device uio_dev;
+struct uio_map uio_mmio;
+
+int main(int argc, char *argv[])
+{
+	int ret;
+
+	ret = locate_uio_device("timer", &uio_dev);
+	if (ret < 0)
+		return ret;
+       
+	printf("found matching UIO device at %s\n", uio_dev.path);
+
+	ret = setup_uio_map(&uio_dev, 0, &uio_mmio);
+	if (ret < 0)
+		return ret;
+
+	printf("CLKE\n");
+	/* Stop timer channel */
+	{
+		unsigned long *p = (uio_mmio.iomem + CMT_CMCLKE);
+
+		*p = *p & ~CMT_CMCLKE_CH0;
+	}
+
+	printf("CMCSR\n");
+	/* CMCSR */
+	{
+		unsigned long *p = (uio_mmio.iomem + CMT_CMCSR);
+
+		*p = 0x124;
+	}
+
+	printf("CMCOR\n");
+	/* CMCOR */
+	{
+		unsigned long *p = (uio_mmio.iomem + CMT_CMCOR);
+
+		*p = (32768 / 8) * 2; /* interrupt after about 2s */
+	}
+
+	printf("waiting 10s");
+	sleep(10);
+	
+	printf("UIO write\n");
+	/* Enable interrupt in UIO driver */
+	{
+		unsigned long enable = 1;
+
+		write(uio_dev.fd, &enable, sizeof(u_long));
+	}
+
+	printf("CLKE\n");
+	/* Start timer channel */
+	{
+		unsigned long *p = (uio_mmio.iomem + CMT_CMCLKE);
+
+		*p = *p | CMT_CMCLKE_CH0;
+	}
+
+	printf("UIO read\n");
+	/* Wait for interrupt */
+	{
+		unsigned long n_pending;
+
+		read(uio_dev.fd, &n_pending, sizeof(u_long));
+
+		printf("got CMT IRQ\n");
+	}
+
+	printf("CLKE\n");
+	/* Stop timer channel */
+	{
+		unsigned long *p = (uio_mmio.iomem + CMT_CMCLKE);
+
+		*p = *p & ~CMT_CMCLKE_CH0;
+	}
+	
+	return 0;
+}
#4 lore raw
In reply to Magnus Damm

Hi Magnus,

Quoted 13 lines · Magnus Damm

r8a77961 CMT test setup using UIO

[PATCH 1/2] r8a77961 CMT0 device exposed via UIO
[PATCH 2/2] UIO CMT test program

These two patches contain kernel and user space modificatons to allow some basic testing from user space of the CMT0 device included on the r8a77961 SoC.

For the kernel, simply apply the kernel patch (including a few debug printouts) and make sure to extend your kernel config with CONFIG_UIO_PDRV_GENIRQ=y.

The following log shows how to execute the test program on the target:

Quoted 13 lines
# ./uio-cmt-test
found matching UIO device at /sys/class/uio/uio0/
CLKE
CMCSR
CMCOR
[   12.284451] irqhandler 20
waiting 10s
UIO write
CLKE
UIO read
got CMT IRQ
CLKE
#

I guess you could test this device using the sh_cmt driver, and a generic userspace timer test program (from tools/testing/selftests/?), too?

Gr{oetje,eeting}s,

Geert

Signature · 5 lines
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected]

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds