From: Wu Hao <hao.wu@intel.com> To: Alan Tull <atull@kernel.org> Cc: Moritz Fischer <mdf@kernel.org>, linux-fpga@vger.kernel.org, linux-kernel <linux-kernel@vger.kernel.org>, linux-api@vger.kernel.org, "Kang, Luwei" <luwei.kang@intel.com>, "Zhang, Yi Z" <yi.z.zhang@intel.com>, Enno Luebbers <enno.luebbers@intel.com>, Xiao Guangrong <guangrong.xiao@linux.intel.com> Subject: Re: [PATCH v3 01/21] docs: fpga: add a document for Intel FPGA driver overview Date: Tue, 5 Dec 2017 11:57:02 +0800 [thread overview] Message-ID: <20171205035702.GC19730@hao-dev> (raw) In-Reply-To: <CANk1AXSYYaoZsgQTN_VNE5p_iSx9P6R1+hbVV4RX8s9dyWPD=g@mail.gmail.com> On Mon, Dec 04, 2017 at 01:55:37PM -0600, Alan Tull wrote: > On Mon, Nov 27, 2017 at 12:42 AM, Wu Hao <hao.wu@intel.com> wrote: > > Add a document for Intel FPGA driver overview. > > > > Signed-off-by: Enno Luebbers <enno.luebbers@intel.com> > > Signed-off-by: Xiao Guangrong <guangrong.xiao@linux.intel.com> > > Signed-off-by: Wu Hao <hao.wu@intel.com> > > ---- > > v2: added FME fpga-mgr/bridge/region platform driver to driver organization. > > updated open discussion per current implementation. > > fixed some typos. > > v3: use FPGA base region as container device instead of fpga-dev class. > > split common enumeration code from pcie driver to functions exposed by > > device feature list framework. > > update FME performance reporting which supports both integrated (iperf/) > > and discrete (dperf/) FPGA solutions. > > --- > > Documentation/fpga/intel-fpga.txt | 261 ++++++++++++++++++++++++++++++++++++++ > > 1 file changed, 261 insertions(+) > > create mode 100644 Documentation/fpga/intel-fpga.txt > > > > diff --git a/Documentation/fpga/intel-fpga.txt b/Documentation/fpga/intel-fpga.txt > > new file mode 100644 > > index 0000000..0754733 > > --- /dev/null > > +++ b/Documentation/fpga/intel-fpga.txt > > @@ -0,0 +1,261 @@ > > +=============================================================================== > > + Intel FPGA driver Overview > > This doesn't look Intel specific to me. This could all be 'DFL FPGA Framework' Sure, will rename this doc to dfl-fpga.txt in the next version as we plan to rename the pcie driver to dfl-pci per your comments on the patch #8, there is no reason to keep it in this doc as all drivers will be dfl-* in the next version. :) > > > +------------------------------------------------------------------------------- > > + Enno Luebbers <enno.luebbers@intel.com> > > + Xiao Guangrong <guangrong.xiao@linux.intel.com> > > + Wu Hao <hao.wu@intel.com> > > + > > +The Intel FPGA driver provides interfaces for userspace applications to > > +configure, enumerate, open, and access FPGA accelerators on platforms equipped > > +with Intel(R) FPGA PCIe based solutions and enables system level management > > +functions such as FPGA reconfiguration, power management, and virtualization. > > + > > +HW Architecture > > +=============== > > +From the OS's point of view, the FPGA hardware appears as a regular PCIe device. > > +The FPGA device memory is organized using a predefined data structure (Device > > +Feature List). Features supported by the particular FPGA device are exposed > > +through these data structures, as illustrated below: > > + > > + +-------------------------------+ +-------------+ > > + | PF | | VF | > > + +-------------------------------+ +-------------+ > > + ^ ^ ^ ^ > > + | | | | > > ++-----|------------|---------|--------------|-------+ > > +| | | | | | > > +| +-----+ +-------+ +-------+ +-------+ | > > +| | FME | | Port0 | | Port1 | | Port2 | | > > +| +-----+ +-------+ +-------+ +-------+ | > > +| ^ ^ ^ | > > +| | | | | > > +| +-------+ +------+ +-------+ | > > +| | AFU | | AFU | | AFU | | > > +| +-------+ +------+ +-------+ | > > +| | > > +| FPGA PCIe Device | > > ++---------------------------------------------------+ > > + > > +The driver supports PCIe SR-IOV to create virtual functions (VFs) which can be > > +used to assign individual accelerators to virtual machines. > > + > > +FME (FPGA Management Engine) > > +============================ > > +The FPGA Management Engine performs power and thermal management, error > > +reporting, reconfiguration, performance reporting for integrated and discrete > > +solution, and other infrastructure functions. Each FPGA has one FME, which is > > +always accessed through the physical function (PF). > > + > > +User-space applications can acquire exclusive access to the FME using open(), > > +and release it using close(). > > + > > +The following functions are exposed through ioctls: > > + > > + Get driver API version (FPGA_GET_API_VERSION) > > + Check for extensions (FPGA_CHECK_EXTENSION) > > + Assign port to PF (FPGA_FME_PORT_ASSIGN) > > + Release port from PF (FPGA_FME_PORT_RELEASE) > > + Program bitstream (FPGA_FME_PORT_PR) > > + > > +More functions are exposed through sysfs > > +(/sys/class/fpga_region/regionX/fpga-dfl-fme.n/): > > I see that /sys/class/fpga/* has changed to /sys/class/fpga_region/* > now as requested (thanks!). It looks like it ended up being pretty > straightforward (so far, just diffing this doc with the previous v2). Thanks for the suggestion on using fpga base region. :) Hao
WARNING: multiple messages have this Message-ID (diff)
From: Wu Hao <hao.wu-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org> To: Alan Tull <atull-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org> Cc: Moritz Fischer <mdf-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>, linux-fpga-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, linux-kernel <linux-kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>, linux-api-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, "Kang, Luwei" <luwei.kang-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>, "Zhang, Yi Z" <yi.z.zhang-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>, Enno Luebbers <enno.luebbers-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>, Xiao Guangrong <guangrong.xiao-VuQAYsv1563Yd54FQh9/CA@public.gmane.org> Subject: Re: [PATCH v3 01/21] docs: fpga: add a document for Intel FPGA driver overview Date: Tue, 5 Dec 2017 11:57:02 +0800 [thread overview] Message-ID: <20171205035702.GC19730@hao-dev> (raw) In-Reply-To: <CANk1AXSYYaoZsgQTN_VNE5p_iSx9P6R1+hbVV4RX8s9dyWPD=g@mail.gmail.com> On Mon, Dec 04, 2017 at 01:55:37PM -0600, Alan Tull wrote: > On Mon, Nov 27, 2017 at 12:42 AM, Wu Hao <hao.wu-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org> wrote: > > Add a document for Intel FPGA driver overview. > > > > Signed-off-by: Enno Luebbers <enno.luebbers-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org> > > Signed-off-by: Xiao Guangrong <guangrong.xiao-VuQAYsv1563Yd54FQh9/CA@public.gmane.org> > > Signed-off-by: Wu Hao <hao.wu-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org> > > ---- > > v2: added FME fpga-mgr/bridge/region platform driver to driver organization. > > updated open discussion per current implementation. > > fixed some typos. > > v3: use FPGA base region as container device instead of fpga-dev class. > > split common enumeration code from pcie driver to functions exposed by > > device feature list framework. > > update FME performance reporting which supports both integrated (iperf/) > > and discrete (dperf/) FPGA solutions. > > --- > > Documentation/fpga/intel-fpga.txt | 261 ++++++++++++++++++++++++++++++++++++++ > > 1 file changed, 261 insertions(+) > > create mode 100644 Documentation/fpga/intel-fpga.txt > > > > diff --git a/Documentation/fpga/intel-fpga.txt b/Documentation/fpga/intel-fpga.txt > > new file mode 100644 > > index 0000000..0754733 > > --- /dev/null > > +++ b/Documentation/fpga/intel-fpga.txt > > @@ -0,0 +1,261 @@ > > +=============================================================================== > > + Intel FPGA driver Overview > > This doesn't look Intel specific to me. This could all be 'DFL FPGA Framework' Sure, will rename this doc to dfl-fpga.txt in the next version as we plan to rename the pcie driver to dfl-pci per your comments on the patch #8, there is no reason to keep it in this doc as all drivers will be dfl-* in the next version. :) > > > +------------------------------------------------------------------------------- > > + Enno Luebbers <enno.luebbers-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org> > > + Xiao Guangrong <guangrong.xiao-VuQAYsv1563Yd54FQh9/CA@public.gmane.org> > > + Wu Hao <hao.wu-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org> > > + > > +The Intel FPGA driver provides interfaces for userspace applications to > > +configure, enumerate, open, and access FPGA accelerators on platforms equipped > > +with Intel(R) FPGA PCIe based solutions and enables system level management > > +functions such as FPGA reconfiguration, power management, and virtualization. > > + > > +HW Architecture > > +=============== > > +From the OS's point of view, the FPGA hardware appears as a regular PCIe device. > > +The FPGA device memory is organized using a predefined data structure (Device > > +Feature List). Features supported by the particular FPGA device are exposed > > +through these data structures, as illustrated below: > > + > > + +-------------------------------+ +-------------+ > > + | PF | | VF | > > + +-------------------------------+ +-------------+ > > + ^ ^ ^ ^ > > + | | | | > > ++-----|------------|---------|--------------|-------+ > > +| | | | | | > > +| +-----+ +-------+ +-------+ +-------+ | > > +| | FME | | Port0 | | Port1 | | Port2 | | > > +| +-----+ +-------+ +-------+ +-------+ | > > +| ^ ^ ^ | > > +| | | | | > > +| +-------+ +------+ +-------+ | > > +| | AFU | | AFU | | AFU | | > > +| +-------+ +------+ +-------+ | > > +| | > > +| FPGA PCIe Device | > > ++---------------------------------------------------+ > > + > > +The driver supports PCIe SR-IOV to create virtual functions (VFs) which can be > > +used to assign individual accelerators to virtual machines. > > + > > +FME (FPGA Management Engine) > > +============================ > > +The FPGA Management Engine performs power and thermal management, error > > +reporting, reconfiguration, performance reporting for integrated and discrete > > +solution, and other infrastructure functions. Each FPGA has one FME, which is > > +always accessed through the physical function (PF). > > + > > +User-space applications can acquire exclusive access to the FME using open(), > > +and release it using close(). > > + > > +The following functions are exposed through ioctls: > > + > > + Get driver API version (FPGA_GET_API_VERSION) > > + Check for extensions (FPGA_CHECK_EXTENSION) > > + Assign port to PF (FPGA_FME_PORT_ASSIGN) > > + Release port from PF (FPGA_FME_PORT_RELEASE) > > + Program bitstream (FPGA_FME_PORT_PR) > > + > > +More functions are exposed through sysfs > > +(/sys/class/fpga_region/regionX/fpga-dfl-fme.n/): > > I see that /sys/class/fpga/* has changed to /sys/class/fpga_region/* > now as requested (thanks!). It looks like it ended up being pretty > straightforward (so far, just diffing this doc with the previous v2). Thanks for the suggestion on using fpga base region. :) Hao
next prev parent reply other threads:[~2017-12-05 4:06 UTC|newest] Thread overview: 151+ messages / expand[flat|nested] mbox.gz Atom feed top 2017-11-27 6:42 [PATCH v3 00/21] Intel FPGA Device Drivers Wu Hao 2017-11-27 6:42 ` [PATCH v3 01/21] docs: fpga: add a document for Intel FPGA driver overview Wu Hao 2017-11-27 6:42 ` Wu Hao 2017-12-04 19:55 ` Alan Tull 2017-12-05 3:57 ` Wu Hao [this message] 2017-12-05 3:57 ` Wu Hao 2017-12-06 10:04 ` David Laight 2017-12-20 22:31 ` Alan Tull 2017-12-20 22:31 ` Alan Tull 2017-12-21 6:02 ` Wu Hao 2017-12-21 6:02 ` Wu Hao 2017-11-27 6:42 ` [PATCH v3 02/21] fpga: mgr: add region_id to fpga_image_info Wu Hao 2017-11-29 6:11 ` Moritz Fischer 2017-11-29 6:11 ` Moritz Fischer 2017-12-04 20:26 ` Alan Tull 2017-12-05 3:36 ` Wu Hao 2017-12-05 3:36 ` Wu Hao 2018-01-31 15:35 ` Alan Tull 2018-01-31 15:35 ` Alan Tull 2018-02-01 5:05 ` Wu Hao 2017-11-27 6:42 ` [PATCH v3 03/21] fpga: mgr: add status for fpga-manager Wu Hao 2017-12-04 20:55 ` Alan Tull 2017-12-04 20:55 ` Alan Tull 2017-12-05 4:08 ` Wu Hao 2017-12-05 4:08 ` Wu Hao 2017-12-12 18:18 ` Alan Tull 2017-12-13 4:48 ` Wu Hao 2017-12-13 4:48 ` Wu Hao 2017-11-27 6:42 ` [PATCH v3 04/21] fpga: add device feature list support Wu Hao 2017-11-27 6:42 ` Wu Hao 2017-11-29 6:07 ` Moritz Fischer 2017-11-29 6:07 ` Moritz Fischer 2017-11-30 5:59 ` Wu Hao 2017-12-20 22:29 ` Alan Tull 2017-12-21 0:58 ` Alan Tull 2017-12-21 7:22 ` Wu Hao 2017-12-21 7:22 ` Wu Hao 2017-12-22 8:45 ` Wu Hao 2018-01-31 23:22 ` Alan Tull 2018-01-31 23:22 ` Alan Tull 2017-11-27 6:42 ` [PATCH v3 05/21] fpga: dfl: add chardev support for feature devices Wu Hao 2017-11-27 6:42 ` [PATCH v3 06/21] fpga: dfl: adds fpga_cdev_find_port Wu Hao 2018-02-05 22:08 ` Alan Tull 2018-02-06 2:37 ` Wu Hao 2017-11-27 6:42 ` [PATCH v3 07/21] fpga: dfl: add feature device infrastructure Wu Hao 2017-11-27 6:42 ` [PATCH v3 08/21] fpga: add Intel FPGA DFL PCIe device Wu Hao 2017-11-27 10:28 ` David Laight 2017-11-27 10:28 ` David Laight 2017-11-28 3:15 ` Wu Hao 2017-11-28 3:15 ` Wu Hao 2017-12-04 19:46 ` Alan Tull 2017-12-04 19:46 ` Alan Tull 2017-12-05 3:33 ` Wu Hao 2017-12-05 3:33 ` Wu Hao 2017-12-05 17:00 ` Alan Tull 2017-12-06 5:30 ` Wu Hao 2017-12-06 9:44 ` David Laight 2017-12-06 9:44 ` David Laight 2017-12-06 15:29 ` Alan Tull 2017-12-06 15:29 ` Alan Tull 2017-12-06 16:28 ` David Laight 2017-12-06 16:28 ` David Laight 2017-12-06 16:28 ` David Laight 2017-12-06 22:39 ` Alan Tull 2018-02-01 21:59 ` Alan Tull 2018-02-01 21:59 ` Alan Tull 2018-02-13 9:36 ` Wu Hao 2017-12-06 9:34 ` David Laight 2017-12-06 9:34 ` David Laight 2017-12-07 3:47 ` Wu Hao 2017-12-07 3:47 ` Wu Hao 2017-12-06 9:31 ` David Laight 2017-12-06 9:31 ` David Laight 2017-12-06 9:31 ` David Laight 2017-11-27 6:42 ` [PATCH v3 09/21] fpga: intel-dfl-pci: add enumeration for feature devices Wu Hao 2017-12-07 21:41 ` Alan Tull 2017-12-07 21:41 ` Alan Tull 2017-12-08 9:25 ` Wu Hao 2017-12-08 9:25 ` Wu Hao 2017-11-27 6:42 ` [PATCH v3 10/21] fpga: dfl: add FPGA Management Engine driver basic framework Wu Hao 2017-11-27 6:42 ` [PATCH v3 11/21] fpga: dfl: fme: add header sub feature support Wu Hao 2018-02-12 16:51 ` Alan Tull 2018-02-12 16:51 ` Alan Tull 2018-02-13 3:44 ` Wu Hao 2018-02-13 3:44 ` Wu Hao 2017-11-27 6:42 ` [PATCH v3 12/21] fpga: dfl: fme: add FPGA_GET_API_VERSION/CHECK_EXTENSION ioctls support Wu Hao 2018-01-31 15:31 ` Alan Tull 2018-01-31 15:31 ` Alan Tull 2018-02-01 5:11 ` Wu Hao 2018-02-01 15:11 ` Moritz Fischer 2017-11-27 6:42 ` [PATCH v3 13/21] fpga: dfl: fme: add partial reconfiguration sub feature support Wu Hao 2017-11-27 6:42 ` [PATCH v3 14/21] fpga: dfl: add fpga manager platform driver for FME Wu Hao 2018-02-01 22:00 ` Alan Tull 2018-02-01 22:00 ` Alan Tull 2018-02-02 9:42 ` Wu Hao 2018-02-03 0:26 ` Luebbers, Enno 2018-02-03 0:26 ` Luebbers, Enno 2018-02-03 10:41 ` Moritz Fischer 2018-02-04 10:05 ` Wu Hao 2018-02-04 10:05 ` Wu Hao 2018-02-05 17:21 ` Alan Tull 2018-02-05 17:21 ` Alan Tull 2018-02-06 2:17 ` Wu Hao 2018-02-06 2:17 ` Wu Hao 2018-02-06 4:25 ` Alan Tull 2018-02-06 5:23 ` Wu Hao 2018-02-06 5:23 ` Wu Hao 2018-02-06 6:44 ` Moritz Fischer 2018-02-06 6:44 ` Moritz Fischer 2018-02-04 9:37 ` Wu Hao 2018-02-04 9:37 ` Wu Hao 2018-02-05 18:36 ` Luebbers, Enno 2018-02-05 18:36 ` Luebbers, Enno 2018-02-06 1:47 ` Wu Hao 2018-02-06 1:47 ` Wu Hao 2018-02-06 4:25 ` Alan Tull 2018-02-06 4:25 ` Alan Tull 2018-02-06 6:47 ` Wu Hao 2018-02-06 6:47 ` Wu Hao 2018-02-06 18:53 ` Alan Tull 2018-02-06 18:53 ` Alan Tull 2018-02-07 4:52 ` Wu Hao 2018-02-07 22:37 ` Alan Tull 2018-02-07 22:37 ` Alan Tull 2017-11-27 6:42 ` [PATCH v3 15/21] fpga: dfl: add fpga bridge " Wu Hao 2018-01-31 15:16 ` Alan Tull 2018-01-31 15:16 ` Alan Tull 2018-02-01 5:15 ` Wu Hao 2018-02-01 15:11 ` Moritz Fischer 2018-02-01 15:11 ` Moritz Fischer 2017-11-27 6:42 ` [PATCH v3 16/21] fpga: dfl: add fpga region " Wu Hao 2018-01-31 20:46 ` Alan Tull 2018-02-01 5:23 ` Wu Hao 2018-02-01 15:13 ` Moritz Fischer 2017-11-27 6:42 ` [PATCH v3 17/21] fpga: dfl: add FPGA Accelerated Function Unit driver basic framework Wu Hao 2017-11-27 6:42 ` [PATCH v3 18/21] fpga: dfl: afu: add header sub feature support Wu Hao 2018-02-12 17:43 ` Alan Tull 2018-02-12 17:43 ` Alan Tull 2018-02-13 3:33 ` Wu Hao 2018-02-13 3:33 ` Wu Hao 2017-11-27 6:42 ` [PATCH v3 19/21] fpga: dfl: afu: add FPGA_GET_API_VERSION/CHECK_EXTENSION ioctls support Wu Hao 2018-01-31 14:52 ` Alan Tull 2018-01-31 14:52 ` Alan Tull 2018-02-01 5:16 ` Wu Hao 2018-02-01 15:13 ` Moritz Fischer 2018-02-02 9:08 ` Wu Hao 2018-02-02 9:08 ` Wu Hao 2017-11-27 6:42 ` [PATCH v3 20/21] fpga: dfl: afu: add user afu sub feature support Wu Hao 2017-11-27 6:42 ` [PATCH v3 21/21] fpga: dfl: afu: add FPGA_PORT_DMA_MAP/UNMAP ioctls support Wu Hao 2017-11-27 21:26 ` [PATCH v3 00/21] Intel FPGA Device Drivers Alan Tull 2017-11-27 21:26 ` Alan Tull
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=20171205035702.GC19730@hao-dev \ --to=hao.wu@intel.com \ --cc=atull@kernel.org \ --cc=enno.luebbers@intel.com \ --cc=guangrong.xiao@linux.intel.com \ --cc=linux-api@vger.kernel.org \ --cc=linux-fpga@vger.kernel.org \ --cc=linux-kernel@vger.kernel.org \ --cc=luwei.kang@intel.com \ --cc=mdf@kernel.org \ --cc=yi.z.zhang@intel.com \ /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: linkBe 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.