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