Skip to content

Commit 128d573

Browse files
yilunxu1984matthew-gerlach
authored andcommitted
Documentation: fpga: dfl: Add description for DFL UIO support
This patch adds description for UIO support for dfl devices on DFL bus. Signed-off-by: Xu Yilun <yilun.xu@intel.com> Reviewed-by: Tom Rix <trix@redhat.com> Reviewed-by: Wu Hao <hao.wu@intel.com>
1 parent 8249f8b commit 128d573

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

Documentation/fpga/dfl.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -502,6 +502,30 @@ FME Partial Reconfiguration Sub Feature driver (see drivers/fpga/dfl-fme-pr.c)
502502
could be a reference.
503503

504504

505+
Userspace driver support for DFL devices
506+
========================================
507+
The purpose of an FPGA is to be reprogrammed with newly developed hardware
508+
components. New hardware can instantiate a new private feature in the DFL, and
509+
then present a DFL device in the system. In some cases users may need a
510+
userspace driver for the DFL device:
511+
512+
* Users may need to run some diagnostic test for their hardware.
513+
* Users may prototype the kernel driver in user space.
514+
* Some hardware is designed for specific purposes and does not fit into one of
515+
the standard kernel subsystems.
516+
517+
This requires direct access to MMIO space and interrupt handling from
518+
userspace. The uio_dfl module exposes the UIO device interfaces for this
519+
purpose.
520+
521+
Currently the uio_dfl driver only supports the Ether Group sub feature, which
522+
has no irq in hardware. So the interrupt handling is not added in this driver.
523+
524+
UIO_DFL should be selected to enable the uio_dfl module driver. To support a
525+
new DFL feature via UIO direct access, its feature id should be added to the
526+
driver's id_table.
527+
528+
505529
Open discussion
506530
===============
507531
FME driver exports one ioctl (DFL_FPGA_FME_PORT_PR) for partial reconfiguration

0 commit comments

Comments
 (0)