doc: update thunderx guide
diff mbox series

Message ID 1581069769-26903-1-git-send-email-hkalra@marvell.com
State Accepted
Delegated to: Jerin Jacob
Headers show
Series
  • doc: update thunderx guide
Related show

Checks

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

Commit Message

Harman Kalra Feb. 7, 2020, 10:02 a.m. UTC
Updating the thunderx with loopback port support,
debugging options, new features added and correcting
some formating issues.

Signed-off-by: Harman Kalra <hkalra@marvell.com>
---
 doc/guides/nics/thunderx.rst | 153 ++++++++++++++++++++---------------
 1 file changed, 88 insertions(+), 65 deletions(-)

Comments

Jerin Jacob Feb. 21, 2020, 9:20 a.m. UTC | #1
On Fri, Feb 7, 2020 at 3:33 PM Harman Kalra <hkalra@marvell.com> wrote:
>
> Updating the thunderx with loopback port support,
> debugging options, new features added and correcting
> some formating issues.

Fixed: s/formating/formatting

>
> Signed-off-by: Harman Kalra <hkalra@marvell.com>

Acked-by: Jerin Jacob <jerinj@marvell.com>
Applied to dpdk-next-net-mrvl/master. Thanks

Patch
diff mbox series

diff --git a/doc/guides/nics/thunderx.rst b/doc/guides/nics/thunderx.rst
index 89d439def..f42133e54 100644
--- a/doc/guides/nics/thunderx.rst
+++ b/doc/guides/nics/thunderx.rst
@@ -25,6 +25,7 @@  Features of the ThunderX PMD are:
 - Port hardware statistics
 - Jumbo frames
 - Link state information
+- Setting up link state.
 - Scattered and gather for TX and RX
 - VLAN stripping
 - SR-IOV VF
@@ -242,6 +243,12 @@  driver' list, secondary VFs are on the remaining on the remaining part of the li
       Depending on the hardware used, the kernel driver sets a threshold ``vf_id``. VFs that try to attached with an id below or equal to
       this boundary are considered primary VFs. VFs that try to attach with an id above this boundary are considered secondary VFs.
 
+LBK HW Access
+~~~~~~~~~~~~~
+
+Loopback HW Unit (LBK) receives packets from NIC-RX and sends packets back to NIC-TX.
+The loopback block has N channels and contains data buffering that is shared across
+all channels. Four primary VFs are reserved as loopback ports.
 
 Example device binding
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -263,36 +270,40 @@  on a non-NUMA machine.
 
       Network devices using kernel driver
       ===================================
-      0000:01:10.0 'Device a026' if= drv=thunder-BGX unused=vfio-pci,uio_pci_generic
-      0000:01:10.1 'Device a026' if= drv=thunder-BGX unused=vfio-pci,uio_pci_generic
-      0002:01:00.0 'Device a01e' if= drv=thunder-nic unused=vfio-pci,uio_pci_generic
-      0002:01:00.1 'Device 0011' if=eth0 drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
-      0002:01:00.2 'Device 0011' if=eth1 drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
-      0002:01:00.3 'Device 0011' if=eth2 drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
-      0002:01:00.4 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
-      0002:01:00.5 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
-      0002:01:00.6 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
-      0002:01:00.7 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
-      0002:01:01.0 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
-      0002:01:01.1 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
-      0002:01:01.2 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
-      0002:01:01.3 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
-      0002:01:01.4 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
-      0002:01:01.5 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
-      0002:01:01.6 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
-      0002:01:01.7 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
-      0002:01:02.0 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
-      0002:01:02.1 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
-      0002:01:02.2 'Device 0011' if= drv=thunder-nicvf unused=vfio-pci,uio_pci_generic
+      0000:01:10.0 'THUNDERX BGX (Common Ethernet Interface) a026' if= drv=thunder-BGX unused=vfio-pci
+      0000:01:10.1 'THUNDERX BGX (Common Ethernet Interface) a026' if= drv=thunder-BGX unused=vfio-pci
+      0001:01:00.0 'THUNDERX Network Interface Controller a01e' if= drv=thunder-nic unused=vfio-pci
+      0001:01:00.1 'Device a034' if=eth0 drv=thunder-nicvf unused=vfio-pci
+      0001:01:00.2 'Device a034' if=eth1 drv=thunder-nicvf unused=vfio-pci
+      0001:01:00.3 'Device a034' if=eth2 drv=thunder-nicvf unused=vfio-pci
+      0001:01:00.4 'Device a034' if=eth3 drv=thunder-nicvf unused=vfio-pci
+      0001:01:00.5 'Device a034' if=eth4 drv=thunder-nicvf unused=vfio-pci
+      0001:01:00.6 'Device a034' if=lbk0 drv=thunder-nicvf unused=vfio-pci
+      0001:01:00.7 'Device a034' if=lbk1 drv=thunder-nicvf unused=vfio-pci
+      0001:01:01.0 'Device a034' if=lbk2 drv=thunder-nicvf unused=vfio-pci
+      0001:01:01.1 'Device a034' if=lbk3 drv=thunder-nicvf unused=vfio-pci
+      0001:01:01.2 'Device a034' if= drv=thunder-nicvf unused=vfio-pci
+      0001:01:01.3 'Device a034' if= drv=thunder-nicvf unused=vfio-pci
+      0001:01:01.4 'Device a034' if= drv=thunder-nicvf unused=vfio-pci
+      0001:01:01.5 'Device a034' if= drv=thunder-nicvf unused=vfio-pci
+      0001:01:01.6 'Device a034' if= drv=thunder-nicvf unused=vfio-pci
+      0001:01:01.7 'Device a034' if= drv=thunder-nicvf unused=vfio-pci
+      0001:01:02.0 'Device a034' if= drv=thunder-nicvf unused=vfio-pci
+      0001:01:02.1 'Device a034' if= drv=thunder-nicvf unused=vfio-pci
+      0001:01:02.2 'Device a034' if= drv=thunder-nicvf unused=vfio-pci
 
       Other network devices
       =====================
       0002:00:03.0 'Device a01f' unused=vfio-pci,uio_pci_generic
 
+   .. note::
+
+      Here total no of primary VFs = 5 (variable, depends on no of ethernet ports present) + 4 (fixed, loopback ports).
+      Ethernet ports are indicated as `if=eth0` while loopback ports as `if=lbk0`.
 
 We want to bind two physical interfaces with 24 queues each device, we attach two primary VFs
-and four secondary queues. In our example we choose two 10G interfaces eth1 (0002:01:00.2) and eth2 (0002:01:00.3).
-We will choose four secondary queue sets from the ending of the list (0002:01:01.7-0002:01:02.2).
+and four secondary VFs. In our example we choose two 10G interfaces eth1 (0002:01:00.2) and eth2 (0002:01:00.3).
+We will choose four secondary queue sets from the ending of the list (0001:01:01.2-0002:01:02.2).
 
 
 #. Bind two primary VFs to the ``vfio-pci`` driver:
@@ -313,56 +324,68 @@  We will choose four secondary queue sets from the ending of the list (0002:01:01
 
 The nicvf thunderx driver will make use of attached secondary VFs automatically during the interface configuration stage.
 
-driver thunder-nic VF's
-~~~~~~~~~~~~~~~~~~~~~~~
+Thunder-nic VF's
+~~~~~~~~~~~~~~~~
 
 Use sysfs to distinguish thunder-nic primary VFs and secondary VFs.
    .. code-block:: console
 
-   ll /sys/bus/pci/drivers/thunder-nic/
-   total 0
-   drwxr-xr-x  2 root root     0 Jan 22 11:19 ./
-   drwxr-xr-x 86 root root     0 Jan 22 11:07 ../
-   lrwxrwxrwx  1 root root     0 Jan 22 11:19 0001:01:00.0 -> '../../../../devices/platform/soc@0/849000000000.pci/pci0001:00/0001:00:10.0/0001:01:00.0'/
-
-   cat /sys/bus/pci/drivers/thunder-nic/0001\:01\:00.0/sriov_sqs_assignment
-   12
-   0 0001:01:00.1 vfio-pci +: 12 13
-   1 0001:01:00.2 thunder-nicvf -:
-   2 0001:01:00.3 thunder-nicvf -:
-   3 0001:01:00.4 thunder-nicvf -:
-   4 0001:01:00.5 thunder-nicvf -:
-   5 0001:01:00.6 thunder-nicvf -:
-   6 0001:01:00.7 thunder-nicvf -:
-   7 0001:01:01.0 thunder-nicvf -:
-   8 0001:01:01.1 thunder-nicvf -:
-   9 0001:01:01.2 thunder-nicvf -:
-   10 0001:01:01.3 thunder-nicvf -:
-   11 0001:01:01.4 thunder-nicvf -:
-   12 0001:01:01.5 vfio-pci: 0
-   13 0001:01:01.6 vfio-pci: 0
-   14 0001:01:01.7 thunder-nicvf: 255
-   15 0001:01:02.0 thunder-nicvf: 255
-   16 0001:01:02.1 thunder-nicvf: 255
-   17 0001:01:02.2 thunder-nicvf: 255
-   18 0001:01:02.3 thunder-nicvf: 255
-   19 0001:01:02.4 thunder-nicvf: 255
-   20 0001:01:02.5 thunder-nicvf: 255
-   21 0001:01:02.6 thunder-nicvf: 255
-   22 0001:01:02.7 thunder-nicvf: 255
-   23 0001:01:03.0 thunder-nicvf: 255
-   24 0001:01:03.1 thunder-nicvf: 255
-   25 0001:01:03.2 thunder-nicvf: 255
-   26 0001:01:03.3 thunder-nicvf: 255
-   27 0001:01:03.4 thunder-nicvf: 255
-   28 0001:01:03.5 thunder-nicvf: 255
-   29 0001:01:03.6 thunder-nicvf: 255
-   30 0001:01:03.7 thunder-nicvf: 255
-   31 0001:01:04.0 thunder-nicvf: 255
+      ls -l /sys/bus/pci/drivers/thunder-nic/
+      total 0
+      drwxr-xr-x  2 root root     0 Jan 22 11:19 ./
+      drwxr-xr-x 86 root root     0 Jan 22 11:07 ../
+      lrwxrwxrwx  1 root root     0 Jan 22 11:19 0001:01:00.0 -> '../../../../devices/platform/soc@0/849000000000.pci/pci0001:00/0001:00:10.0/0001:01:00.0'/
+
+   .. code-block:: console
+
+      cat /sys/bus/pci/drivers/thunder-nic/0001\:01\:00.0/sriov_sqs_assignment
+      12
+      0 0001:01:00.1 vfio-pci +: 12 13
+      1 0001:01:00.2 thunder-nicvf -:
+      2 0001:01:00.3 thunder-nicvf -:
+      3 0001:01:00.4 thunder-nicvf -:
+      4 0001:01:00.5 thunder-nicvf -:
+      5 0001:01:00.6 thunder-nicvf -:
+      6 0001:01:00.7 thunder-nicvf -:
+      7 0001:01:01.0 thunder-nicvf -:
+      8 0001:01:01.1 thunder-nicvf -:
+      9 0001:01:01.2 thunder-nicvf -:
+      10 0001:01:01.3 thunder-nicvf -:
+      11 0001:01:01.4 thunder-nicvf -:
+      12 0001:01:01.5 vfio-pci: 0
+      13 0001:01:01.6 vfio-pci: 0
+      14 0001:01:01.7 thunder-nicvf: 255
+      15 0001:01:02.0 thunder-nicvf: 255
+      16 0001:01:02.1 thunder-nicvf: 255
+      17 0001:01:02.2 thunder-nicvf: 255
+      18 0001:01:02.3 thunder-nicvf: 255
+      19 0001:01:02.4 thunder-nicvf: 255
+      20 0001:01:02.5 thunder-nicvf: 255
+      21 0001:01:02.6 thunder-nicvf: 255
+      22 0001:01:02.7 thunder-nicvf: 255
+      23 0001:01:03.0 thunder-nicvf: 255
+      24 0001:01:03.1 thunder-nicvf: 255
+      25 0001:01:03.2 thunder-nicvf: 255
+      26 0001:01:03.3 thunder-nicvf: 255
+      27 0001:01:03.4 thunder-nicvf: 255
+      28 0001:01:03.5 thunder-nicvf: 255
+      29 0001:01:03.6 thunder-nicvf: 255
+      30 0001:01:03.7 thunder-nicvf: 255
+      31 0001:01:04.0 thunder-nicvf: 255
 
 Every column that ends with 'thunder-nicvf: number' can be used as secondary VF.
 In printout above all entres after '14 0001:01:01.7 thunder-nicvf: 255' can be used as secondary VF.
 
+Debugging Options
+-----------------
+
+EAL command option to change  log level
+   .. code-block:: console
+
+      --log-level=pmd.net.thunderx.driver:info
+      or
+      --log-level=pmd.net.thunderx.driver,7
+
 Module params
 --------------