All of lore.kernel.org
 help / color / mirror / Atom feed
From: Xu Yilun <yilun.xu@intel.com>
To: mdf@kernel.org, linux-fpga@vger.kernel.org, linux-kernel@vger.kernel.org
Cc: Xu Yilun <yilun.xu@intel.com>, Luwei Kang <luwei.kang@intel.com>,
	Wu Hao <hao.wu@intel.com>
Subject: [PATCH 7/7] Documentation: fpga: dfl: add descriptions for interrupt related interfaces.
Date: Mon,  9 Mar 2020 18:29:50 +0800	[thread overview]
Message-ID: <1583749790-10837-8-git-send-email-yilun.xu@intel.com> (raw)
In-Reply-To: <1583749790-10837-1-git-send-email-yilun.xu@intel.com>

This patch adds introductions of interrupt related interfaces for FME
error reporting, port error reporting and AFU user interrupts features.

Signed-off-by: Luwei Kang <luwei.kang@intel.com>
Signed-off-by: Wu Hao <hao.wu@intel.com>
Signed-off-by: Xu Yilun <yilun.xu@intel.com>
---
 Documentation/fpga/dfl.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/Documentation/fpga/dfl.rst b/Documentation/fpga/dfl.rst
index 094fc8a..3c4e150 100644
--- a/Documentation/fpga/dfl.rst
+++ b/Documentation/fpga/dfl.rst
@@ -89,6 +89,8 @@ The following functions are exposed through ioctls:
 - Program bitstream (DFL_FPGA_FME_PORT_PR)
 - Assign port to PF (DFL_FPGA_FME_PORT_ASSIGN)
 - Release port from PF (DFL_FPGA_FME_PORT_RELEASE)
+- Get FME global error info (DFL_FPGA_FME_ERR_GET_INFO)
+- Set interrupt trigger for FME error (DFL_FPGA_FME_ERR_SET_IRQ)
 
 More functions are exposed through sysfs
 (/sys/class/fpga_region/regionX/dfl-fme.n/):
@@ -144,6 +146,10 @@ The following functions are exposed through ioctls:
 - Map DMA buffer (DFL_FPGA_PORT_DMA_MAP)
 - Unmap DMA buffer (DFL_FPGA_PORT_DMA_UNMAP)
 - Reset AFU (DFL_FPGA_PORT_RESET)
+- Get port error info (DFL_FPGA_PORT_ERR_GET_INFO)
+- Set interrupt trigger for port error(DFL_FPGA_PORT_ERR_SET_IRQ)
+- Get User AFU interrupt(UINT) info (DFL_FPGA_PORT_UINT_GET_INFO)
+- Set interrupt trigger for UINT (DFL_FPGA_PORT_UINT_SET_IRQ)
 
 DFL_FPGA_PORT_RESET:
   reset the FPGA Port and its AFU. Userspace can do Port
@@ -378,6 +384,17 @@ The device nodes used for ioctl() or mmap() can be referenced through::
 	/sys/class/fpga_region/<regionX>/<dfl-port.n>/dev
 
 
+Interrupt support
+=================
+Some FME and AFU private features are able to generate interrupts. As mentioned
+above, users could call ioctl (DFL_FPGA_*_GET_INFO), query the nr_irqs field to
+know whether or how many interrupts are supported for this private feature.
+Drivers also implement an eventfd based interrupt handling mechanism for users
+to get notified when interrupt happens. Users could set eventfds to driver via
+ioctl (DFL_FPGA_*_SET_IRQ), and then poll/select on these eventfds waiting for
+notification.
+
+
 Add new FIUs support
 ====================
 It's possible that developers made some new function blocks (FIUs) under this
-- 
2.7.4


      parent reply	other threads:[~2020-03-09 10:32 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-09 10:29 [PATCH 0/7] Add interrupt support to FPGA DFL drivers Xu Yilun
2020-03-09 10:29 ` [PATCH 1/7] fpga: dfl: parse interrupt info for feature devices on enumeration Xu Yilun
2020-03-10  2:26   ` Wu Hao
2020-03-10  9:25     ` Xu Yilun
2020-03-10 10:21       ` Wu Hao
2020-03-09 10:29 ` [PATCH 2/7] fpga: dfl: pci: add irq info for feature devices enumeration Xu Yilun
2020-03-10  2:46   ` Wu Hao
2020-03-10  9:41     ` Xu Yilun
2020-03-10 10:26       ` Wu Hao
2020-03-09 10:29 ` [PATCH 3/7] fpga: dfl: introduce interrupt trigger setting API Xu Yilun
2020-03-10 10:30   ` Wu Hao
2020-03-11  2:14     ` Xu Yilun
2020-03-09 10:29 ` [PATCH 4/7] fpga: dfl: afu: add interrupt support for error reporting Xu Yilun
2020-03-10 10:39   ` Wu Hao
2020-03-10 16:47     ` Xu Yilun
2020-03-11  2:43       ` Wu Hao
2020-03-11  6:35         ` Xu Yilun
2020-03-09 10:29 ` [PATCH 5/7] fpga: dfl: fme: add interrupt support for global " Xu Yilun
2020-03-09 10:29 ` [PATCH 6/7] fpga: dfl: afu: add user interrupt support Xu Yilun
2020-03-09 10:29 ` Xu Yilun [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1583749790-10837-8-git-send-email-yilun.xu@intel.com \
    --to=yilun.xu@intel.com \
    --cc=hao.wu@intel.com \
    --cc=linux-fpga@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=luwei.kang@intel.com \
    --cc=mdf@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.