[v2] doc/devbind: remove references to igb_uio
diff mbox series

Message ID 20200924175347.13619-1-stephen@networkplumber.org
State New
Delegated to: Thomas Monjalon
Headers show
Series
  • [v2] doc/devbind: remove references to igb_uio
Related show

Checks

Context Check Description
ci/travis-robot success Travis build: passed
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Stephen Hemminger Sept. 24, 2020, 5:53 p.m. UTC
We should be encouraging the use of vfio_pci for developers, not telling
them to use igb_uio.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
v2 -- drop change about filename

 doc/guides/tools/devbind.rst | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

Comments

Ferruh Yigit Oct. 14, 2020, 4:43 p.m. UTC | #1
On 9/24/2020 6:53 PM, Stephen Hemminger wrote:
> We should be encouraging the use of vfio_pci for developers, not telling
> them to use igb_uio.
> 
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---
> v2 -- drop change about filename
> 
>   doc/guides/tools/devbind.rst | 18 +++++++++---------
>   1 file changed, 9 insertions(+), 9 deletions(-)
> 
> diff --git a/doc/guides/tools/devbind.rst b/doc/guides/tools/devbind.rst
> index a2910e103aab..5dcaf8c207dd 100644
> --- a/doc/guides/tools/devbind.rst
> +++ b/doc/guides/tools/devbind.rst
> @@ -30,11 +30,11 @@ OPTIONS
>           Print the current status of all known network interfaces.
>           For each device, it displays the PCI domain, bus, slot and function,
>           along with a text description of the device. Depending upon whether the
> -        device is being used by a kernel driver, the ``igb_uio`` driver, or no
> +        device is being used by a kernel driver, the ``vfio_pci`` driver, or no
>           driver, other relevant information will be displayed:
>           - the Linux interface name e.g. ``if=eth0``
> -        - the driver being used e.g. ``drv=igb_uio``
> -        - any suitable drivers not currently using that device e.g. ``unused=igb_uio``
> +        - the driver being used e.g. ``drv=vfio_pci``
> +        - any suitable drivers not currently using that device e.g. ``unused=vfio_pci``
>           NOTE: if this flag is passed along with a bind/unbind option, the
>           status display will always occur after the other operations have taken
>           place.
> @@ -80,9 +80,9 @@ To display current device status::
>   
>      dpdk-devbind --status
>   
> -To bind eth1 from the current driver and move to use igb_uio::
> +To bind eth1 from the current driver and move to use vfio_pci::
>   
> -   dpdk-devbind --bind=igb_uio eth1
> +   dpdk-devbind --bind=vfio_pci eth1

Module name is 'vfio_pci' but driver name is 'vfio-pci', for this document I 
guess all instances should be 'vfio-pci'.

>   
>   To unbind 0000:01:00.0 from using any driver::
>   
> @@ -92,7 +92,7 @@ To bind 0000:02:00.0 and 0000:02:00.1 to the ixgbe kernel driver::
>   
>      dpdk-devbind -b ixgbe 02:00.0 02:00.1
>   
> -To check status of all network ports, assign one to the igb_uio driver and check status again::
> +To check status of all network ports, assign one to the vfio_pci driver and check status again::
>   
>      # Check the status of the available devices.
>      dpdk-devbind --status
> @@ -105,12 +105,12 @@ To check status of all network ports, assign one to the igb_uio driver and check
>      0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
>   
>   
> -   # Bind the device to igb_uio.
> -   sudo dpdk-devbind -b igb_uio 0000:0a:00.0
> +   # Bind the device to vfio_pci.
> +   sudo dpdk-devbind -b vfio_pci 0000:0a:00.0
>   
>   
>      # Recheck the status of the devices.
>      dpdk-devbind --status
>      Network devices using DPDK-compatible driver
>      ============================================
> -   0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
> +   0000:0a:00.0 '82599ES 10-Gigabit' drv=vfio_pci unused=
>

Patch
diff mbox series

diff --git a/doc/guides/tools/devbind.rst b/doc/guides/tools/devbind.rst
index a2910e103aab..5dcaf8c207dd 100644
--- a/doc/guides/tools/devbind.rst
+++ b/doc/guides/tools/devbind.rst
@@ -30,11 +30,11 @@  OPTIONS
         Print the current status of all known network interfaces.
         For each device, it displays the PCI domain, bus, slot and function,
         along with a text description of the device. Depending upon whether the
-        device is being used by a kernel driver, the ``igb_uio`` driver, or no
+        device is being used by a kernel driver, the ``vfio_pci`` driver, or no
         driver, other relevant information will be displayed:
         - the Linux interface name e.g. ``if=eth0``
-        - the driver being used e.g. ``drv=igb_uio``
-        - any suitable drivers not currently using that device e.g. ``unused=igb_uio``
+        - the driver being used e.g. ``drv=vfio_pci``
+        - any suitable drivers not currently using that device e.g. ``unused=vfio_pci``
         NOTE: if this flag is passed along with a bind/unbind option, the
         status display will always occur after the other operations have taken
         place.
@@ -80,9 +80,9 @@  To display current device status::
 
    dpdk-devbind --status
 
-To bind eth1 from the current driver and move to use igb_uio::
+To bind eth1 from the current driver and move to use vfio_pci::
 
-   dpdk-devbind --bind=igb_uio eth1
+   dpdk-devbind --bind=vfio_pci eth1
 
 To unbind 0000:01:00.0 from using any driver::
 
@@ -92,7 +92,7 @@  To bind 0000:02:00.0 and 0000:02:00.1 to the ixgbe kernel driver::
 
    dpdk-devbind -b ixgbe 02:00.0 02:00.1
 
-To check status of all network ports, assign one to the igb_uio driver and check status again::
+To check status of all network ports, assign one to the vfio_pci driver and check status again::
 
    # Check the status of the available devices.
    dpdk-devbind --status
@@ -105,12 +105,12 @@  To check status of all network ports, assign one to the igb_uio driver and check
    0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
 
 
-   # Bind the device to igb_uio.
-   sudo dpdk-devbind -b igb_uio 0000:0a:00.0
+   # Bind the device to vfio_pci.
+   sudo dpdk-devbind -b vfio_pci 0000:0a:00.0
 
 
    # Recheck the status of the devices.
    dpdk-devbind --status
    Network devices using DPDK-compatible driver
    ============================================
-   0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
+   0000:0a:00.0 '82599ES 10-Gigabit' drv=vfio_pci unused=