[v1,1/1] doc: clarify vfio doc for built-in modules
Checks
Commit Message
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>
---
doc/guides/linux_gsg/linux_drivers.rst | 6 ++++++
1 file changed, 6 insertions(+)
Comments
On Thu, Oct 14, 2021 at 12:52:38PM +0000, Anatoly Burakov 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>
Hi Anatoly,
> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Anatoly Burakov
> Sent: Thursday, October 14, 2021 1:53 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH v1 1/1] doc: clarify vfio doc for built-in modules
>
> 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>
> ---
> doc/guides/linux_gsg/linux_drivers.rst | 6 ++++++
> 1 file changed, 6 insertions(+)
>
> 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:
Probably better to wrap above line as quite long.
> +
> + .. 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
> --
> 2.25.1
~/dpdk_21_11/devtools# ./check-git-log.sh
Wrong headline case:
"doc: clarify vfio doc for built-in modules": vfio --> VFIO
Invalid patch(es) found - checked 1 patch
Otherwise
Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
On 14-Oct-21 8:47 PM, Iremonger, Bernard wrote:
>
> Hi Anatoly,
>
>> -----Original Message-----
>> From: dev <dev-bounces@dpdk.org> On Behalf Of Anatoly Burakov
>> Sent: Thursday, October 14, 2021 1:53 PM
>> To: dev@dpdk.org
>> Subject: [dpdk-dev] [PATCH v1 1/1] doc: clarify vfio doc for built-in modules
>>
>> 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>
>> ---
>> doc/guides/linux_gsg/linux_drivers.rst | 6 ++++++
>> 1 file changed, 6 insertions(+)
>>
>> 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:
>
> Probably better to wrap above line as quite long.
>
I believe the general consensus on docs is that we should leave the
lines to be long.
>> +
>> + .. 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
>> --
>> 2.25.1
>
> ~/dpdk_21_11/devtools# ./check-git-log.sh
> Wrong headline case:
> "doc: clarify vfio doc for built-in modules": vfio --> VFIO
>
> Invalid patch(es) found - checked 1 patch
>
Thanks, will fix in v2!
> Otherwise
> Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
>
@@ -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