From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-lf0-f68.google.com (mail-lf0-f68.google.com [209.85.215.68]) by dpdk.org (Postfix) with ESMTP id 009347CFC for ; Fri, 1 Dec 2017 16:20:14 +0100 (CET) Received: by mail-lf0-f68.google.com with SMTP id l81so12095762lfl.6 for ; Fri, 01 Dec 2017 07:20:14 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=semihalf-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=UHI7+wvnM/I26dnGb8FanB4lkruq6zHJpVNEF0Qhwlc=; b=OMMTCyd08vOtURW/DsHvMvCG+1/Zcg7yMjI8s3eyYhF3M8fqaoxt9teoD3KcrRbkPT V58tVo2blQOJI4iZ0vX5JhDzpgBs8YeP03LGrGJicQdtEmM5P9xnPNZ/oy/P2Gx0/9MA iy4gmxzI8z+3GiObAMhYxy6Y1RwjnLXwjyxeEuJX844nuvYulT9tFDSRJ9O8eKt1Wn2n zRPUqf2wt8J+oDNAKqZv6JCyoyhILufLPvlVRCoKEStrnRYAFd13ZHLQGV3LL+G73ukh WmVjCCAxQzpaggqHXunzw7CfnGFlYwzszOgrChmxIL2w7DXzle7IdNfZW0kk3TbdQUBO OsRA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=UHI7+wvnM/I26dnGb8FanB4lkruq6zHJpVNEF0Qhwlc=; b=KPdfEk4AaYhUOIgYuHR7EmL4SQWF7wGz2GfS3xxHA9GOrYiQosl3RPBahyRB7WBv2e cCGu2apG/8g7B2iaRElPBmsxxM3DZ8sZi85yea+AfuDHS92DL7eYc7bYVD6yw8lbF67m MTtEQnuJFM1Uc/gezrGr7yOQrvcGUSHWVgMkBpdoUCZ/CoUamyOChAKneOW1IiqXya+t C4TynExOmwcyVrCPqr4T/wR5CniQ7WmNqXYhFbfnti744YtoiXuptmz+UFgq1kLwfHce +jqEJb5gx4vXbqtCASj6p9HsBs9m8Zy53KCB4fNiGODA1yXeC99BT5H0r6CO7AlWM0iI FkBg== X-Gm-Message-State: AJaThX4pWTHyImvSOUpn64P3xK+h2kQEEy4RY7TtyUBLZHz0NA+VoU3B xWYsVa76vZ3u9P/hqvMLHQ+QOUnTLLQ= X-Google-Smtp-Source: AGs4zManxutTH2ZA+g0c4H6lgYjGKWdlK6aDAi4OGgK2jILSoGngPmCUSIwHV56+wOdyPe46jACh1Q== X-Received: by 10.25.234.26 with SMTP id i26mr4554005lfh.188.1512141614223; Fri, 01 Dec 2017 07:20:14 -0800 (PST) Received: from tdu.semihalf.local (31-172-191-173.noc.fibertech.net.pl. [31.172.191.173]) by smtp.gmail.com with ESMTPSA id j1sm1177674lfe.66.2017.12.01.07.20.12 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 01 Dec 2017 07:20:13 -0800 (PST) From: Tomasz Duszynski To: dev@dpdk.org Cc: mw@semihalf.com, jck@semihalf.com, dima@marvell.com, nsamsono@marvell.com, jianbo.liu@arm.com, Tomasz Duszynski Date: Fri, 1 Dec 2017 16:19:52 +0100 Message-Id: <1512141592-16695-8-git-send-email-tdu@semihalf.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1512141592-16695-1-git-send-email-tdu@semihalf.com> References: <1512048743-23749-1-git-send-email-tdu@semihalf.com> <1512141592-16695-1-git-send-email-tdu@semihalf.com> Subject: [dpdk-dev] [PATCH 7/7] net/mrvl: update MRVL NET PMD documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 01 Dec 2017 15:20:15 -0000 Update MRVL NET PMD documentation. Signed-off-by: Tomasz Duszynski --- 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