doc/guides/nics/octeontx2.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(C) 2019 Marvell International Ltd.
   3
   4 OCTEON TX2 Poll Mode driver
   5 ===========================
   6
   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.
  10
  11 More information can be found at `Marvell Official Website
  12 <https://www.marvell.com/embedded-processors/infrastructure-processors>`_.
  13
  14 Features
  15 --------
  16
  17 Features of the OCTEON TX2 Ethdev PMD are:
  18
  19 - SR-IOV VF
  20 - Lock-free Tx queue
  21 - Debug utilities - error interrupt support
  22
  23 Prerequisites
  24 -------------
  25
  26 See :doc:`../platform/octeontx2` for setup information.
  27
  28 Compile time Config Options
  29 ---------------------------
  30
  31 The following options may be modified in the ``config`` file.
  32
  33 - ``CONFIG_RTE_LIBRTE_OCTEONTX2_PMD`` (default ``y``)
  34
  35   Toggle compilation of the ``librte_pmd_octeontx2`` driver.
  36
  37 Runtime Config Options
  38 ----------------------
  39
  40 - ``HW offload ptype parsing disable`` (default ``0``)
  41
  42    Packet type parsing is HW offloaded by default and this feature may be toggled
  43    using ``ptype_disable`` ``devargs`` parameter.
  44
  45 - ``Rx&Tx scalar mode enable`` (default ``0``)
  46
  47    Ethdev supports both scalar and vector mode, it may be selected at runtime
  48    using ``scalar_enable`` ``devargs`` parameter.
  49
  50 - ``RSS reta size`` (default ``64``)
  51
  52    RSS redirection table size may be configured during runtime using ``reta_size``
  53    ``devargs`` parameter.
  54
  55    For example::
  56
  57       -w 0002:02:00.0,reta_size=256
  58
  59    With the above configuration, reta table of size 256 is populated.
  60
  61 - ``Flow priority levels`` (default ``3``)
  62
  63    RTE Flow priority levels can be configured during runtime using
  64    ``flow_max_priority`` ``devargs`` parameter.
  65
  66    For example::
  67
  68       -w 0002:02:00.0,flow_max_priority=10
  69
  70    With the above configuration, priority level was set to 10 (0-9). Max
  71    priority level supported is 32.
  72
  73 - ``Reserve Flow entries`` (default ``8``)
  74
  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.
  77
  78    For example::
  79
  80       -w 0002:02:00.0,flow_prealloc_size=4
  81
  82    With the above configuration, pre alloc size was set to 4. Max pre alloc
  83    size supported is 32.
  84
  85 - ``Max SQB buffer count`` (default ``512``)
  86
  87    Send queue descriptor buffer count may be limited during runtime using
  88    ``max_sqb_count`` ``devargs`` parameter.
  89
  90    For example::
  91
  92       -w 0002:02:00.0,max_sqb_count=64
  93
  94    With the above configuration, each send queue's decscriptor buffer count is
  95    limited to a maximum of 64 buffers.
  96
  97
  98 .. note::
  99
 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.