Re: [PATCH v1 12/12] Documentation: fpga: add description of fpgahp driver

From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Tianfei Zhang <tianfei.zhang@intel.com>,
	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
Subject: Re: [PATCH v1 12/12] Documentation: fpga: add description of fpgahp driver
Date: Thu, 19 Jan 2023 16:38:41 +0700	[thread overview]
Message-ID: <Y8kPoXnCNyB7AwUv@debian.me> (raw)
In-Reply-To: <20230119013602.607466-13-tianfei.zhang@intel.com>

[-- Attachment #1: Type: text/plain, Size: 3942 bytes --]

On Wed, Jan 18, 2023 at 08:36:02PM -0500, Tianfei Zhang wrote:
> +===========================
> +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

The doc reads a rather confused to me, so I have to make wording improv:

---- >8 ----

diff --git a/Documentation/fpga/fpgahp.rst b/Documentation/fpga/fpgahp.rst
index 3ec34bbffde10c..73f1b53de1cf85 100644
--- a/Documentation/fpga/fpgahp.rst
+++ b/Documentation/fpga/fpgahp.rst
@@ -8,22 +8,22 @@ 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.
+The FPGA Hotplug Manager (fpgahp) manages PCIe-based FPGA card devices.
+The PCI bus reconfiguration and device probe for devices below the FPGA
+card are done by leveraging the PCI hotplug framework.
 
- - 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.
+The driver can be helpful in device management tasks like burning the entire
+image and loading a new FPGA image or BMC firmware in FPGA deployment of data
+center or cloud. For example, when loading the 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 appropriate PCI bus.
 
-In general, the fpgahp driver provides some sysfs files::
+The driver adds 2 new sysfs callbacks to extend the hotplug mechanism to
+allow selecting and loading a new FPGA image:
+
+ - ``/sys/bus/pci/slots/<X-X>/available_images``: list available images for
+   a FPGA card.
+ - ``/sys/bus/pci/slots/<X-X>/image_load``: load the image.
 
-        /sys/bus/pci/slots/<X-X>/available_images
-        /sys/bus/pci/slots/<X-X>/image_load

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
