From: Tomasz Duszynski <tdu@semihalf.com>
To: dev@dpdk.org
Cc: mw@semihalf.com, jck@semihalf.com, dima@marvell.com,
nsamsono@marvell.com, jianbo.liu@arm.com,
Tomasz Duszynski <tdu@semihalf.com>
Subject: [dpdk-dev] [PATCH 7/7] net/mrvl: update MRVL NET PMD documentation
Date: Thu, 30 Nov 2017 14:32:23 +0100 [thread overview]
Message-ID: <1512048743-23749-8-git-send-email-tdu@semihalf.com> (raw)
In-Reply-To: <1512048743-23749-1-git-send-email-tdu@semihalf.com>
Update MRVL NET PMD documentation.
Signed-off-by: Tomasz Duszynski <tdu@semihalf.com>
---
doc/guides/nics/mrvl.rst | 69 +++++++++++++++++++++++++++++++-----------------
1 file changed, 45 insertions(+), 24 deletions(-)
diff --git a/doc/guides/nics/mrvl.rst b/doc/guides/nics/mrvl.rst
index fbfdf47..67b254c 100644
--- a/doc/guides/nics/mrvl.rst
+++ b/doc/guides/nics/mrvl.rst
@@ -87,31 +87,40 @@ Limitations
Prerequisites
-------------
-- Custom Linux Kernel sources available
- `here <https://github.com/MarvellEmbeddedProcessors/linux-marvell/tree/linux-4.4.52-armada-17.08>`__.
+- Custom Linux Kernel sources
-- Out of tree `mvpp2x_sysfs` kernel module sources available
- `here <https://github.com/MarvellEmbeddedProcessors/mvpp2x-marvell/tree/mvpp2x-armada-17.08>`__.
+ .. code-block:: console
-- MUSDK (Marvell User-Space SDK) sources available
- `here <https://github.com/MarvellEmbeddedProcessors/musdk-marvell/tree/musdk-armada-17.08>`__.
+ git clone https://github.com/MarvellEmbeddedProcessors/linux-marvell.git -b linux-4.4.52-armada-17.10
- MUSDK is a light-weight library that provides direct access to Marvell's
- PPv2 (Packet Processor v2). Alternatively prebuilt MUSDK library can be
- requested from `Marvell Extranet <https://extranet.marvell.com>`_. Once
- approval has been granted, library can be found by typing ``musdk`` in
- the search box.
+- Out of tree `mvpp2x_sysfs` kernel module sources
- MUSDK must be configured with the following features:
+ .. code-block:: console
- .. code-block:: console
+ git clone https://github.com/MarvellEmbeddedProcessors/mvpp2x-marvell.git -b mvpp2x-armada-17.10
- --enable-bpool-dma=64
+- MUSDK (Marvell User-Space SDK) sources
+
+ .. code-block:: console
+
+ git clone https://github.com/MarvellEmbeddedProcessors/musdk-marvell.git -b musdk-armada-17.10
+
+ MUSDK is a light-weight library that provides direct access to Marvell's
+ PPv2 (Packet Processor v2). Alternatively prebuilt MUSDK library can be
+ requested from `Marvell Extranet <https://extranet.marvell.com>`_. Once
+ approval has been granted, library can be found by typing ``musdk`` in
+ the search box.
+
+ 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
- DPDK environment.
+ Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup
+ DPDK environment.
Config File Options
@@ -123,11 +132,6 @@ The following options can be modified in the ``config`` file.
Toggle compilation of the librte_pmd_mrvl driver.
-- ``CONFIG_RTE_MRVL_MUSDK_DMA_MEMSIZE`` (default ``41943040``)
-
- Size in bytes of the contiguous memory region that MUSDK will allocate
- for run-time DMA-able data buffers.
-
QoS Configuration
-----------------
@@ -142,7 +146,7 @@ Configuration syntax
[port <portnum> default]
default_tc = <default_tc>
- qos_mode = <qos_priority>
+ mapping_priority = <mapping_priority>
[port <portnum> tc <traffic_class>]
rxq = <rx_queue_list>
@@ -160,7 +164,7 @@ Where:
- ``<default_tc>``: Default traffic class (e.g. 0)
-- ``<qos_priority>``: QoS priority for mapping (`ip`, `vlan`, `ip/vlan` or `vlan/ip`).
+- ``<mapping_priority>``: QoS priority for mapping (`ip`, `vlan`, `ip/vlan` or `vlan/ip`).
- ``<traffic_class>``: Traffic Class to be configured.
@@ -218,9 +222,26 @@ Building DPDK
Driver needs precompiled MUSDK library during compilation. Please consult
``doc/musdk_get_started.txt`` for the detailed build instructions.
+.. code-block:: console
+
+ export CROSS_COMPILE=<toolchain>/bin/aarch64-linux-gnu-
+ ./bootstrap
+ ./configure --enable-bpool-dma=64
+ make install
+
+MUSDK will be installed to `usr/local` under current directory.
+For the detailed build instructions please consult ``doc/musdk_get_started.txt``.
+
Before the DPDK build process the environmental variable ``LIBMUSDK_PATH`` with
the path to the MUSDK installation directory needs to be exported.
+.. code-block:: console
+
+ export LIBMUSDK_PATH=<musdk>/usr/local
+ export CROSS=aarch64-linux-gnu-
+ make config T=arm64-armv8a-linuxapp-gcc
+ sed -ri 's,(MRVL_PMD=)n,\1y,' build/.config
+ make
Usage Example
-------------
@@ -242,7 +263,7 @@ Additionally interfaces used by DPDK application need to be put up:
.. code-block:: console
ip link set eth0 up
- ip link set eth1 up
+ ip link set eth2 up
In order to run testpmd example application following command can be used:
--
2.7.4
next prev parent reply other threads:[~2017-11-30 13:32 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-11-30 13:32 [dpdk-dev] [PATCH 0/7] Sync with MUSDK-17.10 Tomasz Duszynski
2017-11-30 13:32 ` [dpdk-dev] [PATCH 1/7] net/mrvl: sync compilation with musdk-17.10 Tomasz Duszynski
2017-12-01 3:29 ` Jianbo Liu
2017-12-01 9:03 ` Tomasz Duszynski
2017-11-30 13:32 ` [dpdk-dev] [PATCH 2/7] net/mrvl: query link status using library API Tomasz Duszynski
2017-11-30 13:32 ` [dpdk-dev] [PATCH 3/7] net/mrvl: do not enable port after setting MAC address Tomasz Duszynski
2017-11-30 13:32 ` [dpdk-dev] [PATCH 4/7] net/mrvl: check if ppio is initialized Tomasz Duszynski
2017-11-30 13:32 ` [dpdk-dev] [PATCH 5/7] net/mrvl: add extra error logs Tomasz Duszynski
2017-12-01 3:32 ` Jianbo Liu
2017-12-01 8:26 ` Tomasz Duszynski
2017-11-30 13:32 ` [dpdk-dev] [PATCH 6/7] devtools/test-build: add MRVL NET PMD to test-build Tomasz Duszynski
2017-11-30 13:32 ` Tomasz Duszynski [this message]
2017-12-01 15:19 ` [dpdk-dev] [PATCH 0/7] Sync with MUSDK-17.10 Tomasz Duszynski
2017-12-01 15:19 ` [dpdk-dev] [PATCH 1/7] net/mrvl: sync compilation with musdk-17.10 Tomasz Duszynski
2017-12-01 15:19 ` [dpdk-dev] [PATCH 2/7] net/mrvl: query link status using library API Tomasz Duszynski
2017-12-01 15:19 ` [dpdk-dev] [PATCH 3/7] net/mrvl: do not enable port after setting MAC address Tomasz Duszynski
2017-12-01 15:19 ` [dpdk-dev] [PATCH 4/7] net/mrvl: check if ppio is initialized Tomasz Duszynski
2017-12-01 15:19 ` [dpdk-dev] [PATCH 5/7] net/mrvl: add extra error logs Tomasz Duszynski
2017-12-01 15:19 ` [dpdk-dev] [PATCH 6/7] devtools/test-build: add MRVL NET PMD to test-build Tomasz Duszynski
2017-12-05 0:48 ` Ferruh Yigit
2017-12-05 8:38 ` Tomasz Duszynski
2017-12-01 15:19 ` [dpdk-dev] [PATCH 7/7] net/mrvl: update MRVL NET PMD documentation Tomasz Duszynski
2017-12-04 2:25 ` [dpdk-dev] [PATCH 0/7] Sync with MUSDK-17.10 Jianbo Liu
2017-12-05 9:39 ` [dpdk-dev] [PATCH v3 " Tomasz Duszynski
2017-12-05 9:39 ` [dpdk-dev] [PATCH v3 1/7] net/mrvl: sync compilation with musdk-17.10 Tomasz Duszynski
2017-12-05 9:39 ` [dpdk-dev] [PATCH v3 2/7] net/mrvl: query link status using library API Tomasz Duszynski
2017-12-05 9:39 ` [dpdk-dev] [PATCH v3 3/7] net/mrvl: do not enable port after setting MAC address Tomasz Duszynski
2017-12-05 9:39 ` [dpdk-dev] [PATCH v3 4/7] net/mrvl: check if ppio is initialized Tomasz Duszynski
2017-12-05 9:39 ` [dpdk-dev] [PATCH v3 5/7] net/mrvl: add extra error logs Tomasz Duszynski
2017-12-05 9:39 ` [dpdk-dev] [PATCH v3 6/7] devtools/test-build: add MRVL NET PMD to test-build Tomasz Duszynski
2017-12-05 9:39 ` [dpdk-dev] [PATCH v3 7/7] net/mrvl: update MRVL NET PMD documentation Tomasz Duszynski
2017-12-07 1:13 ` [dpdk-dev] [PATCH v3 0/7] Sync with MUSDK-17.10 Ferruh Yigit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1512048743-23749-8-git-send-email-tdu@semihalf.com \
--to=tdu@semihalf.com \
--cc=dev@dpdk.org \
--cc=dima@marvell.com \
--cc=jck@semihalf.com \
--cc=jianbo.liu@arm.com \
--cc=mw@semihalf.com \
--cc=nsamsono@marvell.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).