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 - Link state information
  22 - Debug utilities - Context dump and error interrupt support
  23
  24 Prerequisites
  25 -------------
  26
  27 See :doc:`../platform/octeontx2` for setup information.
  28
  29 Compile time Config Options
  30 ---------------------------
  31
  32 The following options may be modified in the ``config`` file.
  33
  34 - ``CONFIG_RTE_LIBRTE_OCTEONTX2_PMD`` (default ``y``)
  35
  36   Toggle compilation of the ``librte_pmd_octeontx2`` driver.
  37
  38 Runtime Config Options
  39 ----------------------
  40
  41 - ``HW offload ptype parsing disable`` (default ``0``)
  42
  43    Packet type parsing is HW offloaded by default and this feature may be toggled
  44    using ``ptype_disable`` ``devargs`` parameter.
  45
  46 - ``Rx&Tx scalar mode enable`` (default ``0``)
  47
  48    Ethdev supports both scalar and vector mode, it may be selected at runtime
  49    using ``scalar_enable`` ``devargs`` parameter.
  50
  51 - ``RSS reta size`` (default ``64``)
  52
  53    RSS redirection table size may be configured during runtime using ``reta_size``
  54    ``devargs`` parameter.
  55
  56    For example::
  57
  58       -w 0002:02:00.0,reta_size=256
  59
  60    With the above configuration, reta table of size 256 is populated.
  61
  62 - ``Flow priority levels`` (default ``3``)
  63
  64    RTE Flow priority levels can be configured during runtime using
  65    ``flow_max_priority`` ``devargs`` parameter.
  66
  67    For example::
  68
  69       -w 0002:02:00.0,flow_max_priority=10
  70
  71    With the above configuration, priority level was set to 10 (0-9). Max
  72    priority level supported is 32.
  73
  74 - ``Reserve Flow entries`` (default ``8``)
  75
  76    RTE flow entries can be pre allocated and the size of pre allocation can be
  77    selected runtime using ``flow_prealloc_size`` ``devargs`` parameter.
  78
  79    For example::
  80
  81       -w 0002:02:00.0,flow_prealloc_size=4
  82
  83    With the above configuration, pre alloc size was set to 4. Max pre alloc
  84    size supported is 32.
  85
  86 - ``Max SQB buffer count`` (default ``512``)
  87
  88    Send queue descriptor buffer count may be limited during runtime using
  89    ``max_sqb_count`` ``devargs`` parameter.
  90
  91    For example::
  92
  93       -w 0002:02:00.0,max_sqb_count=64
  94
  95    With the above configuration, each send queue's decscriptor buffer count is
  96    limited to a maximum of 64 buffers.
  97
  98
  99 .. note::
 100
 101    Above devarg parameters are configurable per device, user needs to pass the
 102    parameters to all the PCIe devices if application requires to configure on
 103    all the ethdev ports.