[v2,1/1] doc: clarify VFIO doc for built-in modules

Message ID f28a1eadad851e69062b60cc2e6a4e0f3eb58c09.1635349028.git.anatoly.burakov@intel.com (mailing list archive)
State Accepted, archived
Delegated to: David Marchand
Headers
Series [v2,1/1] doc: clarify VFIO doc for built-in modules |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/github-robot: build success github build: passed
ci/iol-spell-check-testing warning Testing issues
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS

Commit Message

Burakov, Anatoly Oct. 27, 2021, 3:37 p.m. UTC
  Currently, the documentation only contains instructions for enabling
SRIOV support for VFIO compiled as a module, but doesn't have any
instructions on how to do the same for cases where VFIO is built-in.
Add these instructions.

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
---
 doc/guides/linux_gsg/linux_drivers.rst | 6 ++++++
 1 file changed, 6 insertions(+)
  

Comments

David Marchand Oct. 28, 2021, 8:14 a.m. UTC | #1
On Wed, Oct 27, 2021 at 5:39 PM Anatoly Burakov
<anatoly.burakov@intel.com> wrote:
>
> Currently, the documentation only contains instructions for enabling
> SRIOV support for VFIO compiled as a module, but doesn't have any
> instructions on how to do the same for cases where VFIO is built-in.
> Add these instructions.
>
> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
> Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>

Applied, thanks.
  

Patch

diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst
index c6b6881ea2..2dd711bb37 100644
--- a/doc/guides/linux_gsg/linux_drivers.rst
+++ b/doc/guides/linux_gsg/linux_drivers.rst
@@ -65,6 +65,12 @@  The token will be used for all PF and VF ports within the application.
 
       sudo modprobe vfio-pci enable_sriov=1
 
+   Alternatively, pass the ``enable_sriov`` parameter through the ``sysfs`` if the module is already loaded or is built-in:
+
+   .. code-block:: console
+
+      echo 1 | sudo tee /sys/module/vfio_pci/parameters/enable_sriov
+
 #. Bind the PCI devices to ``vfio-pci`` driver
 
    .. code-block:: console