From mboxrd@z Thu Jan 1 00:00:00 1970 From: Tomasz Duszynski Subject: [PATCH v3 7/7] net/mrvl: update MRVL NET PMD documentation Date: Tue, 5 Dec 2017 10:39:22 +0100 Message-ID: <1512466762-1982-8-git-send-email-tdu@semihalf.com> References: <1512141592-16695-1-git-send-email-tdu@semihalf.com> <1512466762-1982-1-git-send-email-tdu@semihalf.com> Cc: mw@semihalf.com, jck@semihalf.com, dima@marvell.com, nsamsono@marvell.com, jianbo.liu@arm.com, Tomasz Duszynski To: dev@dpdk.org Return-path: Received: from mail-lf0-f67.google.com (mail-lf0-f67.google.com [209.85.215.67]) by dpdk.org (Postfix) with ESMTP id E3366199C8 for ; Tue, 5 Dec 2017 10:39:44 +0100 (CET) Received: by mail-lf0-f67.google.com with SMTP id e137so22506783lfg.5 for ; Tue, 05 Dec 2017 01:39:44 -0800 (PST) In-Reply-To: <1512466762-1982-1-git-send-email-tdu@semihalf.com> List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Update MRVL NET PMD documentation. Signed-off-by: Tomasz Duszynski Acked-by: Jianbo Liu --- 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 `__. +- Custom Linux Kernel sources -- Out of tree `mvpp2x_sysfs` kernel module sources available - `here `__. + .. code-block:: console -- MUSDK (Marvell User-Space SDK) sources available - `here `__. + 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 `_. 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 `_. 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 ` to setup - DPDK environment. + Follow the DPDK :ref:`Getting Started Guide for Linux ` 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 default] default_tc = - qos_mode = + mapping_priority = [port tc ] rxq = @@ -160,7 +164,7 @@ Where: - ````: Default traffic class (e.g. 0) -- ````: QoS priority for mapping (`ip`, `vlan`, `ip/vlan` or `vlan/ip`). +- ````: QoS priority for mapping (`ip`, `vlan`, `ip/vlan` or `vlan/ip`). - ````: 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=/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=/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