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