[dpdk-stable] patch 'doc: improve multiport PF in nfp guide' has been queued to stable release 19.11.6

[luca.boccassi at gmail.com]

Hi,

FYI, your patch has been queued to stable release 19.11.6

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 10/30/20. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Thanks.

Luca Boccassi

---
>From bc7135aecd639de6015c1df70fe013b477941301 Mon Sep 17 00:00:00 2001
From: Heinrich Kuhn <heinrich.kuhn at netronome.com>
Date: Thu, 3 Sep 2020 13:23:51 +0200
Subject: [PATCH] doc: improve multiport PF in nfp guide

[ upstream commit 979f2bae0714c18899e5bbb3d472842b0ce20060 ]

The Agilio CX family of smartNIC's generally have a 1:many mapping of PF
to physical ports. Elaborate on this mapping in the PF multiport section
of the NFP PMD documentation.

Fixes: d625beafc8be ("doc: update NFP with PF support information")

Signed-off-by: Heinrich Kuhn <heinrich.kuhn at netronome.com>
Signed-off-by: Simon Horman <simon.horman at netronome.com>
---
 doc/guides/nics/nfp.rst | 39 ++++++++++++++++++++++++++++-----------
 1 file changed, 28 insertions(+), 11 deletions(-)

diff --git a/doc/guides/nics/nfp.rst b/doc/guides/nics/nfp.rst
index 5f2a0698f6..020e37d131 100644
--- a/doc/guides/nics/nfp.rst
+++ b/doc/guides/nics/nfp.rst
@@ -102,22 +102,39 @@ directory per firmware application. Options 1 and 2 for firmware filenames allow
 more than one SmartNIC, same type of SmartNIC or different ones, and to upload a
 different firmware to each SmartNIC.
 
+   .. Note::
+      Currently the NFP PMD supports using the PF with Agilio Basic Firmware. See
+      https://help.netronome.com/support/solutions for more information on the
+      various firmwares supported by the Netronome Agilio CX smartNIC.
 
 PF multiport support
 --------------------
 
-Some NFP cards support several physical ports with just one single PCI device.
-The DPDK core is designed with a 1:1 relationship between PCI devices and DPDK
-ports, so NFP PMD PF support requires handling the multiport case specifically.
-During NFP PF initialization, the PMD will extract the information about the
-number of PF ports from the firmware and will create as many DPDK ports as
-needed.
-
-Because the unusual relationship between a single PCI device and several DPDK
-ports, there are some limitations when using more than one PF DPDK port: there
-is no support for RX interrupts and it is not possible either to use those PF
-ports with the device hotplug functionality.
+The NFP PMD can work with up to 8 ports on the same PF device. The number of
+available ports is firmware and hardware dependent, and the driver looks for a
+firmware symbol during initialization to know how many can be used.
 
+DPDK apps work with ports, and a port is usually a PF or a VF PCI device.
+However, with the NFP PF multiport there is just one PF PCI device. Supporting
+this particular configuration requires the PMD to create ports in a special way,
+although once they are created, DPDK apps should be able to use them as normal
+PCI ports.
+
+NFP ports belonging to same PF can be seen inside PMD initialization with a
+suffix added to the PCI ID: wwww:xx:yy.z_port_n. For example, a PF with PCI ID
+0000:03:00.0 and four ports is seen by the PMD code as:
+
+   .. code-block:: console
+
+      0000:03:00.0_port_0
+      0000:03:00.0_port_1
+      0000:03:00.0_port_2
+      0000:03:00.0_port_3
+
+   .. Note::
+
+      There are some limitations with multiport support: RX interrupts and
+      device hot-plugging are not supported.
 
 PF multiprocess support
 -----------------------
-- 
2.20.1

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2020-10-28 10:35:13.285745936 +0000
+++ 0048-doc-improve-multiport-PF-in-nfp-guide.patch	2020-10-28 10:35:11.512830142 +0000
@@ -1,14 +1,15 @@
-From 979f2bae0714c18899e5bbb3d472842b0ce20060 Mon Sep 17 00:00:00 2001
+From bc7135aecd639de6015c1df70fe013b477941301 Mon Sep 17 00:00:00 2001
 From: Heinrich Kuhn <heinrich.kuhn at netronome.com>
 Date: Thu, 3 Sep 2020 13:23:51 +0200
 Subject: [PATCH] doc: improve multiport PF in nfp guide
 
+[ upstream commit 979f2bae0714c18899e5bbb3d472842b0ce20060 ]
+
 The Agilio CX family of smartNIC's generally have a 1:many mapping of PF
 to physical ports. Elaborate on this mapping in the PF multiport section
 of the NFP PMD documentation.
 
 Fixes: d625beafc8be ("doc: update NFP with PF support information")
-Cc: stable at dpdk.org
 
 Signed-off-by: Heinrich Kuhn <heinrich.kuhn at netronome.com>
 Signed-off-by: Simon Horman <simon.horman at netronome.com>