From: Tianfei Zhang <tianfei.zhang@intel.com>
To: bhelgaas@google.com, linux-pci@vger.kernel.org,
linux-fpga@vger.kernel.org, lukas@wunner.de, kabel@kernel.org,
mani@kernel.org, pali@kernel.org, mdf@kernel.org,
hao.wu@intel.com, yilun.xu@intel.com, trix@redhat.com,
jgg@ziepe.ca, ira.weiny@intel.com,
andriy.shevchenko@linux.intel.com, dan.j.williams@intel.com,
keescook@chromium.org, rafael@kernel.org,
russell.h.weight@intel.com, corbet@lwn.net,
linux-doc@vger.kernel.org, ilpo.jarvinen@linux.intel.com,
lee@kernel.org, gregkh@linuxfoundation.org,
matthew.gerlach@linux.intel.com
Cc: Tianfei Zhang <tianfei.zhang@intel.com>
Subject: [PATCH v1 12/12] Documentation: fpga: add description of fpgahp driver
Date: Wed, 18 Jan 2023 20:36:02 -0500 [thread overview]
Message-ID: <20230119013602.607466-13-tianfei.zhang@intel.com> (raw)
In-Reply-To: <20230119013602.607466-1-tianfei.zhang@intel.com>
Add the description of fpgahp driver.
Signed-off-by: Tianfei Zhang <tianfei.zhang@intel.com>
---
Documentation/fpga/fpgahp.rst | 29 +++++++++++++++++++++++++++++
Documentation/fpga/index.rst | 1 +
MAINTAINERS | 1 +
3 files changed, 31 insertions(+)
create mode 100644 Documentation/fpga/fpgahp.rst
diff --git a/Documentation/fpga/fpgahp.rst b/Documentation/fpga/fpgahp.rst
new file mode 100644
index 000000000000..3ec34bbffde1
--- /dev/null
+++ b/Documentation/fpga/fpgahp.rst
@@ -0,0 +1,29 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+===========================
+FPGA Hotplug Manager Driver
+===========================
+
+Authors:
+
+- Tianfei Zhang <tianfei.zhang@intel.com>
+
+There are some board managements for PCIe-based FPGA card like burning the entire
+image, loading a new FPGA image or BMC firmware in FPGA deployment of data center
+or cloud. For example, loading a new FPGA image, the driver needs to remove all of
+PCI devices like PFs/VFs and as well as any other types of devices (platform, etc.)
+defined within the FPGA. After triggering the image load of the FPGA card via BMC,
+the driver reconfigures the PCI bus. The FPGA Hotplug Manager (fpgahp) driver manages
+those devices and functions leveraging the PCI hotplug framework to deal with the
+reconfiguration of the PCI bus and removal/probe of PCI devices below the FPGA card.
+
+This fpgahp driver adds 2 new callbacks to extend the hotplug mechanism to
+allow selecting and loading a new FPGA image.
+
+ - available_images: Optional: called to return the available images of a FPGA card.
+ - image_load: Optional: called to load a new image for a FPGA card.
+
+In general, the fpgahp driver provides some sysfs files::
+
+ /sys/bus/pci/slots/<X-X>/available_images
+ /sys/bus/pci/slots/<X-X>/image_load
diff --git a/Documentation/fpga/index.rst b/Documentation/fpga/index.rst
index f80f95667ca2..8973a8a3f066 100644
--- a/Documentation/fpga/index.rst
+++ b/Documentation/fpga/index.rst
@@ -8,6 +8,7 @@ fpga
:maxdepth: 1
dfl
+ fpgahp
.. only:: subproject and html
diff --git a/MAINTAINERS b/MAINTAINERS
index 85d4e3a0e986..569c7f680229 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -8169,6 +8169,7 @@ L: linux-fpga@vger.kernel.org
L: linux-pci@vger.kernel.org
S: Maintained
F: Documentation/ABI/testing/sysfs-driver-fpgahp
+F: Documentation/fpga/fpgahp.rst
F: drivers/pci/hotplug/fpgahp.c
F: include/linux/fpga/fpgahp_manager.h
--
2.38.1
next prev parent reply other threads:[~2023-01-19 1:34 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-19 1:35 [PATCH v1 00/12] add FPGA hotplug manager driver Tianfei Zhang
2023-01-19 1:35 ` [PATCH v1 01/12] PCI: hotplug: add new callbacks on hotplug_slot_ops Tianfei Zhang
2023-01-19 13:31 ` Greg KH
2023-01-19 1:35 ` [PATCH v1 02/12] PCI: hotplug: expose APIs from pciehp driver Tianfei Zhang
2023-01-19 1:35 ` [PATCH v1 03/12] PCI: hotplug: add and expose link disable API Tianfei Zhang
2023-01-19 1:35 ` [PATCH v1 04/12] PCI: hotplug: add FPGA PCI hotplug manager driver Tianfei Zhang
2023-01-19 1:35 ` [PATCH v1 05/12] fpga: dfl: register dfl-pci device into fpgahph driver Tianfei Zhang
2023-01-19 1:35 ` [PATCH v1 06/12] driver core: expose device_is_ancestor() API Tianfei Zhang
2023-01-19 1:35 ` [PATCH v1 07/12] PCI: hotplug: add register/unregister function for BMC device Tianfei Zhang
2023-01-19 1:35 ` [PATCH v1 08/12] fpga: m10bmc-sec: register BMC device into fpgahp driver Tianfei Zhang
2023-01-19 1:35 ` [PATCH v1 09/12] fpga: dfl: remove non-reserved devices Tianfei Zhang
2023-01-19 1:36 ` [PATCH v1 10/12] PCI: hotplug: implement the hotplug_slot_ops callback for fpgahp Tianfei Zhang
2023-01-19 13:28 ` Greg KH
2023-01-20 22:38 ` Russ Weight
2023-01-21 7:35 ` Greg KH
2023-01-19 1:36 ` [PATCH v1 11/12] fpga: m10bmc-sec: add m10bmc_sec_retimer_load callback Tianfei Zhang
2023-01-19 14:22 ` Lee Jones
2023-01-19 1:36 ` Tianfei Zhang [this message]
2023-01-19 9:38 ` [PATCH v1 12/12] Documentation: fpga: add description of fpgahp driver Bagas Sanjaya
2023-01-19 8:06 ` [PATCH v1 00/12] add FPGA hotplug manager driver Pali Rohár
2023-01-19 8:17 ` Zhang, Tianfei
2023-01-19 11:27 ` andriy.shevchenko
2023-01-19 12:09 ` Zhang, Tianfei
2023-01-19 13:33 ` Greg KH
2023-01-19 13:43 ` Rafael J. Wysocki
2023-01-19 15:33 ` Greg KH
2023-01-20 16:28 ` Russ Weight
2023-01-20 18:42 ` Lukas Wunner
2023-01-21 7:34 ` Greg KH
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=20230119013602.607466-13-tianfei.zhang@intel.com \
--to=tianfei.zhang@intel.com \
--cc=andriy.shevchenko@linux.intel.com \
--cc=bhelgaas@google.com \
--cc=corbet@lwn.net \
--cc=dan.j.williams@intel.com \
--cc=gregkh@linuxfoundation.org \
--cc=hao.wu@intel.com \
--cc=ilpo.jarvinen@linux.intel.com \
--cc=ira.weiny@intel.com \
--cc=jgg@ziepe.ca \
--cc=kabel@kernel.org \
--cc=keescook@chromium.org \
--cc=lee@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fpga@vger.kernel.org \
--cc=linux-pci@vger.kernel.org \
--cc=lukas@wunner.de \
--cc=mani@kernel.org \
--cc=matthew.gerlach@linux.intel.com \
--cc=mdf@kernel.org \
--cc=pali@kernel.org \
--cc=rafael@kernel.org \
--cc=russell.h.weight@intel.com \
--cc=trix@redhat.com \
--cc=yilun.xu@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: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).