doc/guides/nics/cnxk.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(C) 2021 Marvell.
   3
   4 CNXK Poll Mode driver
   5 =====================
   6
   7 The CNXK ETHDEV PMD (**librte_net_cnxk**) provides poll mode ethdev driver
   8 support for the inbuilt network device found in **Marvell OCTEON CN9K/CN10K**
   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 CNXK Ethdev PMD are:
  18
  19 - Packet type information
  20 - Jumbo frames
  21 - SR-IOV VF
  22 - Lock-free Tx queue
  23 - Multiple queues for TX and RX
  24 - Receiver Side Scaling (RSS)
  25 - Link state information
  26 - Scatter-Gather IO support
  27 - Vector Poll mode driver
  28
  29 Prerequisites
  30 -------------
  31
  32 See :doc:`../platform/cnxk` for setup information.
  33
  34
  35 Driver compilation and testing
  36 ------------------------------
  37
  38 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
  39 for details.
  40
  41 Runtime Config Options
  42 ----------------------
  43
  44 - ``Rx&Tx scalar mode enable`` (default ``0``)
  45
  46    PMD supports both scalar and vector mode, it may be selected at runtime
  47    using ``scalar_enable`` ``devargs`` parameter.
  48
  49 - ``RSS reta size`` (default ``64``)
  50
  51    RSS redirection table size may be configured during runtime using ``reta_size``
  52    ``devargs`` parameter.
  53
  54    For example::
  55
  56       -a 0002:02:00.0,reta_size=256
  57
  58    With the above configuration, reta table of size 256 is populated.
  59
  60 - ``Flow priority levels`` (default ``3``)
  61
  62    RTE Flow priority levels can be configured during runtime using
  63    ``flow_max_priority`` ``devargs`` parameter.
  64
  65    For example::
  66
  67       -a 0002:02:00.0,flow_max_priority=10
  68
  69    With the above configuration, priority level was set to 10 (0-9). Max
  70    priority level supported is 32.
  71
  72 - ``Reserve Flow entries`` (default ``8``)
  73
  74    RTE flow entries can be pre allocated and the size of pre allocation can be
  75    selected runtime using ``flow_prealloc_size`` ``devargs`` parameter.
  76
  77    For example::
  78
  79       -a 0002:02:00.0,flow_prealloc_size=4
  80
  81    With the above configuration, pre alloc size was set to 4. Max pre alloc
  82    size supported is 32.
  83
  84 - ``Max SQB buffer count`` (default ``512``)
  85
  86    Send queue descriptor buffer count may be limited during runtime using
  87    ``max_sqb_count`` ``devargs`` parameter.
  88
  89    For example::
  90
  91       -a 0002:02:00.0,max_sqb_count=64
  92
  93    With the above configuration, each send queue's descriptor buffer count is
  94    limited to a maximum of 64 buffers.
  95
  96 - ``Switch header enable`` (default ``none``)
  97
  98    A port can be configured to a specific switch header type by using
  99    ``switch_header`` ``devargs`` parameter.
 100
 101    For example::
 102
 103       -a 0002:02:00.0,switch_header="higig2"
 104
 105    With the above configuration, higig2 will be enabled on that port and the
 106    traffic on this port should be higig2 traffic only. Supported switch header
 107    types are "higig2", "dsa", "chlen90b" and "chlen24b".
 108
 109 - ``RSS tag as XOR`` (default ``0``)
 110
 111    The HW gives two options to configure the RSS adder i.e
 112
 113    * ``rss_adder<7:0> = flow_tag<7:0> ^ flow_tag<15:8> ^ flow_tag<23:16> ^ flow_tag<31:24>``
 114
 115    * ``rss_adder<7:0> = flow_tag<7:0>``
 116
 117    Latter one aligns with standard NIC behavior vs former one is a legacy
 118    RSS adder scheme used in OCTEON TX2 products.
 119
 120    By default, the driver runs in the latter mode.
 121    Setting this flag to 1 to select the legacy mode.
 122
 123    For example to select the legacy mode(RSS tag adder as XOR)::
 124
 125       -a 0002:02:00.0,tag_as_xor=1
 126
 127
 128 .. note::
 129
 130    Above devarg parameters are configurable per device, user needs to pass the
 131    parameters to all the PCIe devices if application requires to configure on
 132    all the ethdev ports.