Skip to contentSkip to conversation

UIO support for dfl devices

PATCH Superseded Xu Yilun 2 participants 5 messages Dec 29, 2020 – Dec 30, 2020

Subsystems (3)

v4 of 12 Superseded Latest is v12 →

lore
Share & tools
lore

Xu Yilun

author maintainer
#0 lore raw

v4 cover UIO support for dfl devices

This patchset supports some dfl device drivers written in userspace.

In the patchset v1, the "driver_override" interface should be used to bind the DFL UIO driver to DFL devices. But there is concern that the "driver_override" interface is not OK itself.

In v2, we use a new matching algorithem. The "driver_override" interface is abandoned, the DFL UIO driver matches any DFL device which could not be handled by other DFL drivers. So the DFL UIO driver could be used for new DFL devices which are not supported by kernel. The concern is the UIO may not be suitable as a default/generic driver for all dfl features, such as features with multiple interrupts.

In v4, we specify each matching device in the id_table of the UIO driver, just the same as other dfl drivers do. Now the UIO driver supports Ether Group feature. To support more DFL features, their feature ids should be added to the driver's id_table.

Main changes from v1:
- switch to the new matching algorithem. It matches DFL devices which could not be handled by other DFL drivers.
- refacor the code about device resources filling.
- add the documentation.

Main changes from v2:
- split the match ops changes in dfl.c to an independent patch.
- move the declarations needed for dfl-uio-pdev from include/linux/dfl.h to driver/fpga/dfl.h
- some minor fixes.

Main changes from v3:
- switch to specifying each matching device in the driver's id_table.
- refactor the irq handling code.

Xu Yilun (2):
fpga: dfl: add the userspace I/O device support for DFL devices
Documentation: fpga: dfl: Add description for DFL UIO support

 Documentation/fpga/dfl.rst  |  24 +++++++++++
 drivers/fpga/Kconfig        |  10 +++++
 drivers/fpga/Makefile       |   1 +
 drivers/fpga/dfl-uio-pdev.c | 101 ++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 136 insertions(+)
 create mode 100644 drivers/fpga/dfl-uio-pdev.c
Signature · 1 line
2.7.4
author maintainer
#1 lore raw

PATCH v4 1/2 fpga: dfl: add the userspace I/O device support for DFL devices

This patch supports the DFL drivers be written in userspace. This is realized by exposing the userspace I/O device interfaces.

The driver leverages the uio_pdrv_genirq, it adds the uio_pdrv_genirq platform device with the DFL device's resources, and let the generic UIO platform device driver provide support to userspace access to kernel interrupts and memory locations.

The driver now supports the ether group feature. To support a new DFL feature been directly accessed via UIO, its feature id should be added to the driver's id_table.

---
v2: switch to the new matching algorithem. It matches DFL devices which
could not be handled by other DFL drivers.
refacor the code about device resources filling.
fix some comments.
v3: split the dfl.c changes out of this patch.
some minor fixes
v4: drop the idea of a generic matching algorithem, instead we specify
each matching device in id_table.
to make clear that only one irq is supported, the irq handling code
is refactored.

---
 drivers/fpga/Kconfig        |  10 +++++
 drivers/fpga/Makefile       |   1 +
 drivers/fpga/dfl-uio-pdev.c | 101 ++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 112 insertions(+)
 create mode 100644 drivers/fpga/dfl-uio-pdev.c
drivers/fpga/Kconfig +10 -0
index 5ff9438..61445be 100644
@@ -203,6 +203,16 @@ config FPGA_DFL_NIOS_INTEL_PAC_N3000
 	  the card. It also instantiates the SPI master (spi-altera) for
 	  the card's BMC (Board Management Controller).
 
+config FPGA_DFL_UIO_PDEV
+	tristate "FPGA DFL Driver for Userspace I/O platform devices"
+	depends on FPGA_DFL && UIO_PDRV_GENIRQ
+	help
+	  Enable this to allow some DFL drivers be written in userspace. It
+	  adds the uio_pdrv_genirq platform device with the DFL feature's
+	  resources, and lets the generic UIO platform device driver provide
+	  support for userspace access to kernel interrupts and memory
+	  locations.
+
 config FPGA_DFL_PCI
 	tristate "FPGA DFL PCIe Device Driver"
 	depends on PCI && FPGA_DFL
drivers/fpga/Makefile +1 -0
index 18dc9885..8847fe0 100644
@@ -45,6 +45,7 @@ dfl-afu-objs := dfl-afu-main.o dfl-afu-region.o dfl-afu-dma-region.o
 dfl-afu-objs += dfl-afu-error.o
 
 obj-$(CONFIG_FPGA_DFL_NIOS_INTEL_PAC_N3000)	+= dfl-n3000-nios.o
+obj-$(CONFIG_FPGA_DFL_UIO_PDEV)		+= dfl-uio-pdev.o
 
 # Drivers for FPGAs which implement DFL
 obj-$(CONFIG_FPGA_DFL_PCI)		+= dfl-pci.o
drivers/fpga/dfl-uio-pdev.c new file +101 -0

101 lines not on this page · raw message

Signature · 1 line
2.7.4
reviewer Reviewed-by on v4 1/2
#2 lore raw

Re: [PATCH v4 1/2] fpga: dfl: add the userspace I/O device support for DFL devices

Quoted 86 lines · Xu Yilun

This patch supports the DFL drivers be written in userspace. This is realized by exposing the userspace I/O device interfaces.

The driver leverages the uio_pdrv_genirq, it adds the uio_pdrv_genirq platform device with the DFL device's resources, and let the generic UIO platform device driver provide support to userspace access to kernel interrupts and memory locations.

The driver now supports the ether group feature. To support a new DFL feature been directly accessed via UIO, its feature id should be added to the driver's id_table.

---
v2: switch to the new matching algorithem. It matches DFL devices which
could not be handled by other DFL drivers.
refacor the code about device resources filling.
fix some comments.
v3: split the dfl.c changes out of this patch.
some minor fixes
v4: drop the idea of a generic matching algorithem, instead we specify
each matching device in id_table.
to make clear that only one irq is supported, the irq handling code
is refactored.

---
 drivers/fpga/Kconfig        |  10 +++++
 drivers/fpga/Makefile       |   1 +
 drivers/fpga/dfl-uio-pdev.c | 101 ++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 112 insertions(+)
 create mode 100644 drivers/fpga/dfl-uio-pdev.c
drivers/fpga/Kconfig +10 -0
index 5ff9438..61445be 100644
@@ -203,6 +203,16 @@ config FPGA_DFL_NIOS_INTEL_PAC_N3000
 	  the card. It also instantiates the SPI master (spi-altera) for
 	  the card's BMC (Board Management Controller).
 
+config FPGA_DFL_UIO_PDEV
+	tristate "FPGA DFL Driver for Userspace I/O platform devices"
+	depends on FPGA_DFL && UIO_PDRV_GENIRQ
+	help
+	  Enable this to allow some DFL drivers be written in userspace. It
+	  adds the uio_pdrv_genirq platform device with the DFL feature's
+	  resources, and lets the generic UIO platform device driver provide
+	  support for userspace access to kernel interrupts and memory
+	  locations.
+
 config FPGA_DFL_PCI
 	tristate "FPGA DFL PCIe Device Driver"
 	depends on PCI && FPGA_DFL
drivers/fpga/Makefile +1 -0
index 18dc9885..8847fe0 100644
@@ -45,6 +45,7 @@ dfl-afu-objs := dfl-afu-main.o dfl-afu-region.o dfl-afu-dma-region.o
 dfl-afu-objs += dfl-afu-error.o
 
 obj-$(CONFIG_FPGA_DFL_NIOS_INTEL_PAC_N3000)	+= dfl-n3000-nios.o
+obj-$(CONFIG_FPGA_DFL_UIO_PDEV)		+= dfl-uio-pdev.o
 
 # Drivers for FPGAs which implement DFL
 obj-$(CONFIG_FPGA_DFL_PCI)		+= dfl-pci.o
drivers/fpga/dfl-uio-pdev.c new file +16 -0
new file mode 100644
index 0000000..1100434
@@ -0,0 +1,101 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * DFL driver for Userspace I/O platform devices
+ *
+ * Copyright (C) 2020 Intel Corporation, Inc.
+ */
+#include <linux/dfl.h>
+#include <linux/errno.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/slab.h>
+#include <linux/uio_driver.h>
+
+#define DRIVER_NAME "dfl-uio-pdev"
+

drivers/fpga/dfl-uio-pdev.c line 26

Quoted 10 lines
drivers/fpga/dfl-uio-pdev.c new file +10 -0
+static int dfl_uio_pdev_probe(struct dfl_device *ddev)
+{
+	struct device *dev = &ddev->dev;
+	struct platform_device_info pdevinfo = { 0 };
+	struct uio_info uio_pdata = { 0 };
+	struct platform_device *uio_pdev;
+	unsigned int num_res = 1;
+	struct resource *res;
+
+	if (ddev->num_irqs > 1)

This num_irq check could be combined with the one below.

drivers/fpga/dfl-uio-pdev.c line 36

Quoted 10 lines
drivers/fpga/dfl-uio-pdev.c new file +10 -0
+		dev_warn(&ddev->dev,
+			 "%d irqs for %s, but UIO only supports the first one\n",
+			 ddev->num_irqs, dev_name(&ddev->dev));
+
+	pdevinfo.name = "uio_pdrv_genirq";
+
+	if (ddev->num_irqs)
+		num_res++;
+
+	res = kcalloc(num_res, sizeof(*res), GFP_KERNEL);

Since num_res is at most 2, could res be converted to a stack array ?

Quoted 65 lines
drivers/fpga/dfl-uio-pdev.c new file +65 -0
+	if (!res)
+		return -ENOMEM;
+
+	res[0].parent = &ddev->mmio_res;
+	res[0].flags = IORESOURCE_MEM;
+	res[0].start = ddev->mmio_res.start;
+	res[0].end = ddev->mmio_res.end;
+
+	/* then add irq resource */
+	if (num_res > 1) {
+		res[1].flags = IORESOURCE_IRQ;
+		res[1].start = ddev->irqs[0];
+		res[1].end = ddev->irqs[0];
+	}
+
+	uio_pdata.name = DRIVER_NAME;
+	uio_pdata.version = "0";
+
+	pdevinfo.res = res;
+	pdevinfo.num_res = num_res;
+	pdevinfo.parent = &ddev->dev;
+	pdevinfo.id = PLATFORM_DEVID_AUTO;
+	pdevinfo.data = &uio_pdata;
+	pdevinfo.size_data = sizeof(uio_pdata);
+
+	uio_pdev = platform_device_register_full(&pdevinfo);
+	if (!IS_ERR(uio_pdev))
+		dev_set_drvdata(dev, uio_pdev);
+
+	kfree(res);
+
+	return PTR_ERR_OR_ZERO(uio_pdev);
+}
+
+static void dfl_uio_pdev_remove(struct dfl_device *ddev)
+{
+	struct platform_device *uio_pdev = dev_get_drvdata(&ddev->dev);
+
+	platform_device_unregister(uio_pdev);
+}
+
+#define FME_FEATURE_ID_ETH_GROUP	0x10
+
+static const struct dfl_device_id dfl_uio_pdev_ids[] = {
+	{ FME_ID, FME_FEATURE_ID_ETH_GROUP },
+
+	/* Add your new id entries here to support uio for more dfl features */
+
+	{ }
+};
+MODULE_DEVICE_TABLE(dfl, dfl_uio_pdev_ids);
+
+static struct dfl_driver dfl_uio_pdev_driver = {
+	.drv	= {
+		.name       = DRIVER_NAME,
+	},
+	.id_table = dfl_uio_pdev_ids,
+	.probe	= dfl_uio_pdev_probe,
+	.remove	= dfl_uio_pdev_remove,
+};
+module_dfl_driver(dfl_uio_pdev_driver);
+
+MODULE_DESCRIPTION("DFL driver for Userspace I/O platform devices");
+MODULE_AUTHOR("Intel Corporation");
+MODULE_LICENSE("GPL v2");
author maintainer
#3 lore raw

Re: [PATCH v4 1/2] fpga: dfl: add the userspace I/O device support for DFL devices

Quoted 91 lines · Tom Rix
Quoted 89 lines · Xu Yilun

This patch supports the DFL drivers be written in userspace. This is realized by exposing the userspace I/O device interfaces.

The driver leverages the uio_pdrv_genirq, it adds the uio_pdrv_genirq platform device with the DFL device's resources, and let the generic UIO platform device driver provide support to userspace access to kernel interrupts and memory locations.

The driver now supports the ether group feature. To support a new DFL feature been directly accessed via UIO, its feature id should be added to the driver's id_table.

---
v2: switch to the new matching algorithem. It matches DFL devices which
could not be handled by other DFL drivers.
refacor the code about device resources filling.
fix some comments.
v3: split the dfl.c changes out of this patch.
some minor fixes
v4: drop the idea of a generic matching algorithem, instead we specify
each matching device in id_table.
to make clear that only one irq is supported, the irq handling code
is refactored.

---
 drivers/fpga/Kconfig        |  10 +++++
 drivers/fpga/Makefile       |   1 +
 drivers/fpga/dfl-uio-pdev.c | 101 ++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 112 insertions(+)
 create mode 100644 drivers/fpga/dfl-uio-pdev.c
drivers/fpga/Kconfig +10 -0
index 5ff9438..61445be 100644
@@ -203,6 +203,16 @@ config FPGA_DFL_NIOS_INTEL_PAC_N3000
 	  the card. It also instantiates the SPI master (spi-altera) for
 	  the card's BMC (Board Management Controller).
 
+config FPGA_DFL_UIO_PDEV
+	tristate "FPGA DFL Driver for Userspace I/O platform devices"
+	depends on FPGA_DFL && UIO_PDRV_GENIRQ
+	help
+	  Enable this to allow some DFL drivers be written in userspace. It
+	  adds the uio_pdrv_genirq platform device with the DFL feature's
+	  resources, and lets the generic UIO platform device driver provide
+	  support for userspace access to kernel interrupts and memory
+	  locations.
+
 config FPGA_DFL_PCI
 	tristate "FPGA DFL PCIe Device Driver"
 	depends on PCI && FPGA_DFL
drivers/fpga/Makefile +1 -0
index 18dc9885..8847fe0 100644
@@ -45,6 +45,7 @@ dfl-afu-objs := dfl-afu-main.o dfl-afu-region.o dfl-afu-dma-region.o
 dfl-afu-objs += dfl-afu-error.o
 
 obj-$(CONFIG_FPGA_DFL_NIOS_INTEL_PAC_N3000)	+= dfl-n3000-nios.o
+obj-$(CONFIG_FPGA_DFL_UIO_PDEV)		+= dfl-uio-pdev.o
 
 # Drivers for FPGAs which implement DFL
 obj-$(CONFIG_FPGA_DFL_PCI)		+= dfl-pci.o
drivers/fpga/dfl-uio-pdev.c new file +19 -0
new file mode 100644
index 0000000..1100434
@@ -0,0 +1,101 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * DFL driver for Userspace I/O platform devices
+ *
+ * Copyright (C) 2020 Intel Corporation, Inc.
+ */
+#include <linux/dfl.h>
+#include <linux/errno.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/slab.h>
+#include <linux/uio_driver.h>
+
+#define DRIVER_NAME "dfl-uio-pdev"
+
+static int dfl_uio_pdev_probe(struct dfl_device *ddev)
+{
+	struct device *dev = &ddev->dev;
Quoted 8 lines

drivers/fpga/dfl-uio-pdev.c line 26

Quoted 7 lines
drivers/fpga/dfl-uio-pdev.c new file +7 -0
+	struct platform_device_info pdevinfo = { 0 };
+	struct uio_info uio_pdata = { 0 };
+	struct platform_device *uio_pdev;
+	unsigned int num_res = 1;
+	struct resource *res;
+
+	if (ddev->num_irqs > 1)

This num_irq check could be combined with the one below.

Yes, I'll change it.

Quoted 4 lines
Quoted 4 lines
drivers/fpga/dfl-uio-pdev.c new file +4 -0
+		dev_warn(&ddev->dev,
+			 "%d irqs for %s, but UIO only supports the first one\n",
+			 ddev->num_irqs, dev_name(&ddev->dev));
+
Quoted 8 lines

drivers/fpga/dfl-uio-pdev.c line 36

Quoted 6 lines
drivers/fpga/dfl-uio-pdev.c new file +6 -0
+	pdevinfo.name = "uio_pdrv_genirq";
+
+	if (ddev->num_irqs)
+		num_res++;
+
+	res = kcalloc(num_res, sizeof(*res), GFP_KERNEL);

Since num_res is at most 2, could res be converted to a stack array ?

Yes, I could refactor the code.

Thanks,
Yilun

Quoted 2 lines
author maintainer
#4 lore raw

PATCH v4 2/2 Documentation: fpga: dfl: Add description for DFL UIO support

In reply to Xu Yilun

This patch adds description for UIO support for dfl devices on DFL bus.

---
v2: no doc in v1, add it for v2.
v3: some documentation fixes.
v4: documentation change since the driver matching is changed.

---
 Documentation/fpga/dfl.rst | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
Documentation/fpga/dfl.rst +24 -0
index 0404fe6..b8497f3 100644
@@ -7,6 +7,7 @@ Authors:
 - Enno Luebbers <[email protected]>
 - Xiao Guangrong <[email protected]>
 - Wu Hao <[email protected]>
+- Xu Yilun <[email protected]>
 
 The Device Feature List (DFL) FPGA framework (and drivers according to
 this framework) hides the very details of low layer hardwares and provides
@@ -502,6 +503,29 @@ FME Partial Reconfiguration Sub Feature driver (see drivers/fpga/dfl-fme-pr.c)
 could be a reference.
 
 
+UIO support for DFL devices
+===========================
+The purpose of an FPGA is to be reprogrammed with newly developed hardware
+components. New hardware can instantiate a new private feature in the DFL, and
+then get a DFL device in their system. In some cases users may need a userspace
+driver for the DFL device:
+
+* Users may need to run some diagnostic test for their hardwares.
+* Users may prototype the kernel driver in user space.
+* Some hardware is designed for specific purposes and does not fit into one of
+  the standard kernel subsystems.
+
+This requires the direct access to the MMIO space and interrupt handling in
+userspace. The dfl-uio-pdev module exposes the UIO device interfaces for this
+purpose. It adds the uio_pdrv_genirq platform device with the resources of
+the DFL feature, and lets the generic UIO platform device driver provide UIO
+support to userspace.
+
+FPGA_DFL_UIO_PDEV should be selected to enable the dfl-uio-pdev module driver.
+To support a new DFL feature been directly accessed via UIO, its feature id
+should be added to the driver's id_table.
+
+
 Open discussion
 ===============
 FME driver exports one ioctl (DFL_FPGA_FME_PORT_PR) for partial reconfiguration
Signature · 1 line
2.7.4