2 Copyright(c) 2017 Marvell International Ltd.
3 Copyright(c) 2017 Semihalf.
6 Redistribution and use in source and binary forms, with or without
7 modification, are permitted provided that the following conditions
10 * Redistributions of source code must retain the above copyright
11 notice, this list of conditions and the following disclaimer.
12 * Redistributions in binary form must reproduce the above copyright
13 notice, this list of conditions and the following disclaimer in
14 the documentation and/or other materials provided with the
16 * Neither the name of the copyright holder nor the names of its
17 contributors may be used to endorse or promote products derived
18 from this software without specific prior written permission.
20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 ======================
35 The MRVL PMD (librte_pmd_mrvl) provides poll mode driver support
36 for the Marvell PPv2 (Packet Processor v2) 1/10 Gbps adapter.
38 Detailed information about SoCs that use PPv2 can be obtained here:
40 * https://www.marvell.com/embedded-processors/armada-70xx/
41 * https://www.marvell.com/embedded-processors/armada-80xx/
45 Due to external dependencies, this driver is disabled by default. It must
46 be enabled manually by setting relevant configuration option manually.
47 Please refer to `Config File Options`_ section for further details.
53 Features of the MRVL PMD are:
63 - Multicast MAC filter
77 - Number of lcores is limited to 9 by MUSDK internal design. If more lcores
78 need to be allocated, locking will have to be considered. Number of available
79 lcores can be changed via ``MRVL_MUSDK_HIFS_RESERVED`` define in
80 ``mrvl_ethdev.c`` source file.
82 - Flushing vlans added for filtering is not possible due to MUSDK missing
83 functionality. Current workaround is to reset board so that PPv2 has a
84 chance to start in a sane state.
90 - Custom Linux Kernel sources available
91 `here <https://github.com/MarvellEmbeddedProcessors/linux-marvell/tree/linux-4.4.52-armada-17.08>`__.
93 - Out of tree `mvpp2x_sysfs` kernel module sources available
94 `here <https://github.com/MarvellEmbeddedProcessors/mvpp2x-marvell/tree/mvpp2x-armada-17.08>`__.
96 - MUSDK (Marvell User-Space SDK) sources available
97 `here <https://github.com/MarvellEmbeddedProcessors/musdk-marvell/tree/musdk-armada-17.08>`__.
99 MUSDK is a light-weight library that provides direct access to Marvell's
100 PPv2 (Packet Processor v2). Alternatively prebuilt MUSDK library can be
101 requested from `Marvell Extranet <https://extranet.marvell.com>`_. Once
102 approval has been granted, library can be found by typing ``musdk`` in
105 MUSDK must be configured with the following features:
107 .. code-block:: console
109 --enable-bpool-dma=64
113 Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup
120 The following options can be modified in the ``config`` file.
122 - ``CONFIG_RTE_LIBRTE_MRVL_PMD`` (default ``n``)
124 Toggle compilation of the librte_pmd_mrvl driver.
126 - ``CONFIG_RTE_MRVL_MUSDK_DMA_MEMSIZE`` (default ``41943040``)
128 Size in bytes of the contiguous memory region that MUSDK will allocate
129 for run-time DMA-able data buffers.
135 QoS configuration is done through external configuration file. Path to the
136 file must be given as `cfg` in driver's vdev parameter list.
141 .. code-block:: console
143 [port <portnum> default]
144 default_tc = <default_tc>
145 qos_mode = <qos_priority>
147 [port <portnum> tc <traffic_class>]
148 rxq = <rx_queue_list>
152 [port <portnum> tc <traffic_class>]
153 rxq = <rx_queue_list>
159 - ``<portnum>``: DPDK Port number (0..n).
161 - ``<default_tc>``: Default traffic class (e.g. 0)
163 - ``<qos_priority>``: QoS priority for mapping (`ip`, `vlan`, `ip/vlan` or `vlan/ip`).
165 - ``<traffic_class>``: Traffic Class to be configured.
167 - ``<rx_queue_list>``: List of DPDK RX queues (e.g. 0 1 3-4)
169 - ``<pcp_list>``: List of PCP values to handle in particular TC (e.g. 0 1 3-4 7).
171 - ``<dscp_list>``: List of DSCP values to handle in particular TC (e.g. 0-12 32-48 63).
173 Setting PCP/DSCP values for the default TC is not required. All PCP/DSCP
174 values not assigned explicitly to particular TC will be handled by the
177 Configuration file example
178 ^^^^^^^^^^^^^^^^^^^^^^^^^^
180 .. code-block:: console
209 .. code-block:: console
211 ./testpmd --vdev=eth_mrvl,iface=eth0,iface=eth2,cfg=/home/user/mrvl.conf \
212 -c 7 -- -i -a --disable-hw-vlan-strip --rxq=2
218 Driver needs precompiled MUSDK library during compilation. Please consult
219 ``doc/musdk_get_started.txt`` for the detailed build instructions.
221 Before the DPDK build process the environmental variable ``LIBMUSDK_PATH`` with
222 the path to the MUSDK installation directory needs to be exported.
228 MRVL PMD requires extra out of tree kernel modules to function properly.
229 `musdk_uio` and `mv_pp_uio` sources are part of the MUSDK. Please consult
230 ``doc/musdk_get_started.txt`` for the detailed build instructions.
231 For `mvpp2x_sysfs` please consult ``Documentation/pp22_sysfs.txt`` for the
232 detailed build instructions.
234 .. code-block:: console
238 insmod mvpp2x_sysfs.ko
240 Additionally interfaces used by DPDK application need to be put up:
242 .. code-block:: console
247 In order to run testpmd example application following command can be used:
249 .. code-block:: console
251 ./testpmd --vdev=eth_mrvl,iface=eth0,iface=eth2 -c 7 -- \
252 --burst=128 --txd=2048 --rxd=1024 --rxq=2 --txq=2 --nb-cores=2 \
253 -i -a --disable-hw-vlan-strip --rss-udp