1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(C) 2019 Marvell International Ltd.
4 OCTEON TX2 Poll Mode driver
5 ===========================
7 The OCTEON TX2 ETHDEV PMD (**librte_pmd_octeontx2**) provides poll mode ethdev
8 driver support for the inbuilt network device found in **Marvell OCTEON TX2**
9 SoC family as well as for their virtual functions (VF) in SR-IOV context.
11 More information can be found at `Marvell Official Website
12 <https://www.marvell.com/embedded-processors/infrastructure-processors>`_.
17 Features of the OCTEON TX2 Ethdev PMD are:
21 - Debug utilities - Context dump and error interrupt support
26 See :doc:`../platform/octeontx2` for setup information.
28 Compile time Config Options
29 ---------------------------
31 The following options may be modified in the ``config`` file.
33 - ``CONFIG_RTE_LIBRTE_OCTEONTX2_PMD`` (default ``y``)
35 Toggle compilation of the ``librte_pmd_octeontx2`` driver.
37 Runtime Config Options
38 ----------------------
40 - ``HW offload ptype parsing disable`` (default ``0``)
42 Packet type parsing is HW offloaded by default and this feature may be toggled
43 using ``ptype_disable`` ``devargs`` parameter.
45 - ``Rx&Tx scalar mode enable`` (default ``0``)
47 Ethdev supports both scalar and vector mode, it may be selected at runtime
48 using ``scalar_enable`` ``devargs`` parameter.
50 - ``RSS reta size`` (default ``64``)
52 RSS redirection table size may be configured during runtime using ``reta_size``
53 ``devargs`` parameter.
57 -w 0002:02:00.0,reta_size=256
59 With the above configuration, reta table of size 256 is populated.
61 - ``Flow priority levels`` (default ``3``)
63 RTE Flow priority levels can be configured during runtime using
64 ``flow_max_priority`` ``devargs`` parameter.
68 -w 0002:02:00.0,flow_max_priority=10
70 With the above configuration, priority level was set to 10 (0-9). Max
71 priority level supported is 32.
73 - ``Reserve Flow entries`` (default ``8``)
75 RTE flow entries can be pre allocated and the size of pre allocation can be
76 selected runtime using ``flow_prealloc_size`` ``devargs`` parameter.
80 -w 0002:02:00.0,flow_prealloc_size=4
82 With the above configuration, pre alloc size was set to 4. Max pre alloc
85 - ``Max SQB buffer count`` (default ``512``)
87 Send queue descriptor buffer count may be limited during runtime using
88 ``max_sqb_count`` ``devargs`` parameter.
92 -w 0002:02:00.0,max_sqb_count=64
94 With the above configuration, each send queue's decscriptor buffer count is
95 limited to a maximum of 64 buffers.
100 Above devarg parameters are configurable per device, user needs to pass the
101 parameters to all the PCIe devices if application requires to configure on
102 all the ethdev ports.