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