[v3,11/13] net/mvpp2: align documentation with MUSDK 18.09
diff mbox series

Message ID 1537859109-25659-12-git-send-email-amo@semihalf.com
State Accepted, archived
Delegated to: Ferruh Yigit
Headers show
  • net/mvpp2: add new features
Related show


Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Andrzej Ostruszka Sept. 25, 2018, 7:05 a.m. UTC
From: Natalie Samsonov <nsamsono@marvell.com>

Update documentation to align with MUSDK 18.09.

Signed-off-by: Natalie Samsonov <nsamsono@marvell.com>
 doc/guides/nics/mvpp2.rst | 26 ++++++++++++--------------
 1 file changed, 12 insertions(+), 14 deletions(-)

diff mbox series

diff --git a/doc/guides/nics/mvpp2.rst b/doc/guides/nics/mvpp2.rst
index a452c8a..3b3f8c6 100644
--- a/doc/guides/nics/mvpp2.rst
+++ b/doc/guides/nics/mvpp2.rst
@@ -74,6 +74,7 @@  Features of the MVPP2 PMD are:
 - QoS
 - RX flow control
 - TX queue start/stop
+- Scattered TX frames
@@ -96,19 +97,19 @@  Prerequisites
   .. code-block:: console
-     git clone https://github.com/MarvellEmbeddedProcessors/linux-marvell.git -b linux-4.4.52-armada-17.10
+     git clone https://github.com/MarvellEmbeddedProcessors/linux-marvell.git -b linux-4.4.120-armada-18.09
 - Out of tree `mvpp2x_sysfs` kernel module sources
   .. code-block:: console
-     git clone https://github.com/MarvellEmbeddedProcessors/mvpp2x-marvell.git -b mvpp2x-armada-17.10
+     git clone https://github.com/MarvellEmbeddedProcessors/mvpp2x-marvell.git -b mvpp2x-armada-18.09
 - MUSDK (Marvell User-Space SDK) sources
   .. code-block:: console
-     git clone https://github.com/MarvellEmbeddedProcessors/musdk-marvell.git -b musdk-armada-17.10
+     git clone https://github.com/MarvellEmbeddedProcessors/musdk-marvell.git -b musdk-armada-18.09
   MUSDK is a light-weight library that provides direct access to Marvell's
   PPv2 (Packet Processor v2). Alternatively prebuilt MUSDK library can be
@@ -119,12 +120,6 @@  Prerequisites
   To get better understanding of the library one can consult documentation
   available in the ``doc`` top level directory of the MUSDK sources.
-  MUSDK must be configured with the following features:
-  .. code-block:: console
-     --enable-bpool-dma=64
 - DPDK environment
   Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup
@@ -140,6 +135,9 @@  The following options can be modified in the ``config`` file.
     Toggle compilation of the librte mvpp2 driver.
+    .. Note::
+       When MVPP2 PMD is enabled ``CONFIG_RTE_LIBRTE_MVNETA_PMD`` must be disabled
 QoS Configuration
@@ -314,7 +312,7 @@  Driver needs precompiled MUSDK library during compilation.
    export CROSS_COMPILE=<toolchain>/bin/aarch64-linux-gnu-
-   ./configure --host=aarch64-linux-gnu --enable-bpool-dma=64
+   ./configure --host=aarch64-linux-gnu
    make install
 MUSDK will be installed to `usr/local` under current directory.
@@ -328,7 +326,8 @@  the path to the MUSDK installation directory needs to be exported.
    export LIBMUSDK_PATH=<musdk>/usr/local
    export CROSS=aarch64-linux-gnu-
    make config T=arm64-armv8a-linuxapp-gcc
-   sed -ri 's,(MVPP2_PMD=)n,\1y,' build/.config
+   sed -i "s/MVNETA_PMD=y/MVNETA_PMD=n/" build/.config
+   sed -i "s/MVPP2_PMD=n/MVPP2_PMD=y/" build/.config
 Flow API
@@ -500,15 +499,14 @@  Usage Example
 MVPP2 PMD requires extra out of tree kernel modules to function properly.
-`musdk_uio` and `mv_pp_uio` sources are part of the MUSDK. Please consult
+`musdk_cma` sources are part of the MUSDK. Please consult
 ``doc/musdk_get_started.txt`` for the detailed build instructions.
 For `mvpp2x_sysfs` please consult ``Documentation/pp22_sysfs.txt`` for the
 detailed build instructions.
 .. code-block:: console
-   insmod musdk_uio.ko
-   insmod mv_pp_uio.ko
+   insmod musdk_cma.ko
    insmod mvpp2x_sysfs.ko
 Additionally interfaces used by DPDK application need to be put up: