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