Skip to contentSkip to conversation

UIO support for dfl devices

PATCH Superseded Xu Yilun 2 participants 5 messages Jan 20, 2021

Subsystems (3)

v7 of 12 Superseded Latest is v12 →

lore
Share & tools
lore

Xu Yilun

author maintainer
#0 lore raw

v7 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.

Main changes from v4:
- refactor the irq handling code.

Main changes from v5:
- fix the res[] zero initialization issue.
- improve the return code for probe().
- some doc improvement.

Main changes from v6:
- use platform_device_register_resndata() for pdev creation.

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  | 25 ++++++++++++++
 drivers/fpga/Kconfig        | 10 ++++++
 drivers/fpga/Makefile       |  1 +
 drivers/fpga/dfl-uio-pdev.c | 84 +++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 120 insertions(+)
 create mode 100644 drivers/fpga/dfl-uio-pdev.c
Signature · 1 line
2.7.4
author maintainer
#1 lore raw

PATCH v7 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.
v5: refactor the irq resource code.
v6: fix the res[] zero initialization issue.
improve the return code for probe().
v7: use platform_device_register_resndata() for pdev creation.
remove some unnecessary head file includings.
some minor fixes.

---
 drivers/fpga/Kconfig        | 10 ++++++
 drivers/fpga/Makefile       |  1 +
 drivers/fpga/dfl-uio-pdev.c | 84 +++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 95 insertions(+)
 create mode 100644 drivers/fpga/dfl-uio-pdev.c
drivers/fpga/Kconfig +10 -0
index 5ff9438..0a21bf2 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 DFL drivers to 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 +84 -0

84 lines not on this page · raw message

Signature · 1 line
2.7.4
author maintainer
#2 lore raw

PATCH v7 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.
v5: no change.
v6: improve the title of the userspace driver support section.
some word improvement.
v7: rebased to next-20210119

---
 Documentation/fpga/dfl.rst | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
Documentation/fpga/dfl.rst +25 -0
index c41ac76..f96a6fb 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
@@ -530,6 +531,30 @@ Being able to specify more than one DFL per BAR has been considered, but it
 was determined the use case did not provide value.  Specifying a single DFL
 per BAR simplifies the implementation and allows for extra error checking.
 
+
+Userspace driver 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 direct access to MMIO space and interrupt handling from
+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
reviewer
#3 lore raw

Re: [PATCH v7 2/2] Documentation: fpga: dfl: Add description for DFL UIO support

Doc suggestions:

Quoted 29 lines · 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.
v5: no change.
v6: improve the title of the userspace driver support section.
some word improvement.
v7: rebased to next-20210119

---
 Documentation/fpga/dfl.rst | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
Documentation/fpga/dfl.rst +1 -0
index c41ac76..f96a6fb 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

Documentation/fpga/dfl.rst Being able to specify more than one DFL per BAR has been considered, but it · line 539

Quoted 9 lines
Documentation/fpga/dfl.rst +6 -0
@@ -530,6 +531,30 @@ Being able to specify more than one DFL per BAR has been considered, but it
 was determined the use case did not provide value.  Specifying a single DFL
 per BAR simplifies the implementation and allows for extra error checking.
 
+
+Userspace driver 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

then present a DFL device in the system.

Documentation/fpga/dfl.rst Being able to specify more than one DFL per BAR has been considered, but it · line 542

Quoted 3 lines
Documentation/fpga/dfl.rst +3 -0
+driver for the DFL device:
+
+* Users may need to run some diagnostic test for their hardwares.

hardware.

Documentation/fpga/dfl.rst Being able to specify more than one DFL per BAR has been considered, but it · line 554

Quoted 12 lines
Documentation/fpga/dfl.rst +12 -0
+* 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 direct access to MMIO space and interrupt handling from
+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

To support a new DFL feature via UIO direct access, its feature id

Documentation/fpga/dfl.rst Being able to specify more than one DFL per BAR has been considered, but it · line 560

Quoted 7 lines
Documentation/fpga/dfl.rst +3 -0
+should be added to the driver's id_table.
+
+
 Open discussion
 ===============
 FME driver exports one ioctl (DFL_FPGA_FME_PORT_PR) for partial reconfiguration

HTH.

Signature · 4 lines
~Randy
"He closes his eyes and drops the goggles.  You can't get hurt
by looking at a bitmap.  Or can you?"
(Neal Stephenson: Snow Crash)
author maintainer
#4 lore raw

Re: [PATCH v7 2/2] Documentation: fpga: dfl: Add description for DFL UIO support

Quoted 50 lines · Randy Dunlap

Doc suggestions:

Quoted 29 lines · 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.
v5: no change.
v6: improve the title of the userspace driver support section.
some word improvement.
v7: rebased to next-20210119

---
 Documentation/fpga/dfl.rst | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
Documentation/fpga/dfl.rst +1 -0
index c41ac76..f96a6fb 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

Documentation/fpga/dfl.rst Being able to specify more than one DFL per BAR has been considered, but it · line 539

Quoted 9 lines
Documentation/fpga/dfl.rst +6 -0
@@ -530,6 +531,30 @@ Being able to specify more than one DFL per BAR has been considered, but it
 was determined the use case did not provide value.  Specifying a single DFL
 per BAR simplifies the implementation and allows for extra error checking.
 
+
+Userspace driver 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

then present a DFL device in the system.

Documentation/fpga/dfl.rst Being able to specify more than one DFL per BAR has been considered, but it · line 542

Quoted 3 lines
Documentation/fpga/dfl.rst +3 -0
+driver for the DFL device:
+
+* Users may need to run some diagnostic test for their hardwares.

hardware.

Quoted 14 lines

Documentation/fpga/dfl.rst Being able to specify more than one DFL per BAR has been considered, but it · line 554

Quoted 12 lines
Documentation/fpga/dfl.rst +12 -0
+* 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 direct access to MMIO space and interrupt handling from
+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

To support a new DFL feature via UIO direct access, its feature id

Thanks for the fixes. Will fix them all.

Yilun