doc/guides/nics/mvneta.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2018 Marvell International Ltd.
   3     Copyright(c) 2018 Semihalf.
   4     All rights reserved.
   5
   6 MVNETA Poll Mode Driver
   7 =======================
   8
   9 The MVNETA PMD (librte_pmd_mvneta) provides poll mode driver support
  10 for the Marvell NETA 1/2.5 Gbps adapter.
  11
  12 Detailed information about SoCs that use PPv2 can be obtained here:
  13
  14 * https://www.marvell.com/embedded-processors/armada-3700/
  15
  16 .. Note::
  17
  18    Due to external dependencies, this driver is disabled by default. It must
  19    be enabled manually by setting relevant configuration option manually.
  20    Please refer to `Config File Options`_ section for further details.
  21
  22
  23 Features
  24 --------
  25
  26 Features of the MVNETA PMD are:
  27
  28 - Start/stop
  29 - tx/rx_queue_setup
  30 - tx/rx_burst
  31 - Speed capabilities
  32 - Jumbo frame
  33 - MTU update
  34 - Promiscuous mode
  35 - Link status
  36 - CRC offload
  37 - L3 checksum offload
  38 - L4 checksum offload
  39 - Packet type parsing
  40
  41
  42 Limitations
  43 -----------
  44
  45 - Flushing vlans added for filtering is not possible due to MUSDK missing
  46   functionality. Current workaround is to reset board so that NETA has a
  47   chance to start in a sane state.
  48
  49 Prerequisites
  50 -------------
  51
  52 - Custom Linux Kernel sources
  53
  54   .. code-block:: console
  55
  56      git clone https://github.com/MarvellEmbeddedProcessors/linux-marvell.git -b linux-4.4.120-armada-18.09
  57
  58
  59 - MUSDK (Marvell User-Space SDK) sources
  60
  61   .. code-block:: console
  62
  63      git clone https://github.com/MarvellEmbeddedProcessors/musdk-marvell.git -b musdk-armada-18.09
  64
  65   MUSDK is a light-weight library that provides direct access to Marvell's
  66   NETA. Alternatively prebuilt MUSDK library can be
  67   requested from `Marvell Extranet <https://extranet.marvell.com>`_. Once
  68   approval has been granted, library can be found by typing ``musdk`` in
  69   the search box.
  70
  71   MUSDK must be configured with the following features:
  72
  73   .. code-block:: console
  74
  75      --enable-pp2=no --enable-neta
  76
  77 - DPDK environment
  78
  79   Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup
  80   DPDK environment.
  81
  82 Pre-Installation Configuration
  83 ------------------------------
  84
  85 Config File Options
  86 ~~~~~~~~~~~~~~~~~~~
  87
  88 The following options can be modified in the ``config`` file.
  89
  90 - ``CONFIG_RTE_LIBRTE_MVNETA_PMD`` (default ``n``)
  91
  92     Toggle compilation of the librte_pmd_mvneta driver.
  93
  94 Runtime options
  95 ~~~~~~~~~~~~~~~
  96
  97 The following ``devargs`` options can be enabled at runtime. They must
  98 be passed as part of EAL arguments.
  99
 100 - ``iface`` (mandatory, with no default value)
 101
 102   The name of port (owned by MUSDK) that should be enabled in DPDK.
 103   This options can be repeated resulting in a list of ports to be
 104   enabled.  For instance below will enable ``eth0`` and ``eth1`` ports.
 105
 106 .. code-block:: console
 107
 108    ./testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 \
 109     -c 3 -- -i --p 3 -a
 110
 111
 112 Building DPDK
 113 -------------
 114
 115 Driver needs precompiled MUSDK library during compilation.
 116
 117 .. code-block:: console
 118
 119    export CROSS_COMPILE=<toolchain>/bin/aarch64-linux-gnu-
 120    ./bootstrap
 121    ./configure --host=aarch64-linux-gnu --enable-pp2=no --enable-neta
 122    make install
 123
 124 MUSDK will be installed to `usr/local` under current directory.
 125 For the detailed build instructions please consult ``doc/musdk_get_started.txt``.
 126
 127 Before the DPDK build process the environmental variable ``LIBMUSDK_PATH`` with
 128 the path to the MUSDK installation directory needs to be exported.
 129
 130 .. code-block:: console
 131
 132    export LIBMUSDK_PATH=<musdk>/usr/local
 133    export CROSS=aarch64-linux-gnu-
 134    make config T=arm64-armv8a-linuxapp-gcc
 135    sed -ri 's,(MVNETA_PMD=)n,\1y,' build/.config
 136    make
 137
 138 Usage Example
 139 -------------
 140
 141 MVNETA PMD requires extra out of tree kernel modules to function properly.
 142 `musdk_uio` and `mv_neta_uio` sources are part of the MUSDK. Please consult
 143 ``doc/musdk_get_started.txt`` for the detailed build instructions.
 144
 145 .. code-block:: console
 146
 147    insmod musdk_uio.ko
 148    insmod mv_neta_uio.ko
 149
 150 Additionally interfaces used by DPDK application need to be put up:
 151
 152 .. code-block:: console
 153
 154    ip link set eth0 up
 155    ip link set eth1 up
 156
 157 In order to run testpmd example application following command can be used:
 158
 159 .. code-block:: console
 160
 161    ./testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- \
 162      -i --p 3 -a --txd 256 --rxd 128 --rxq=1 --txq=1  --nb-cores=1
 163
 164
 165 In order to run l2fwd example application following command can be used:
 166
 167 .. code-block:: console
 168
 169    ./l2fwd --vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- -T 1 -p 3