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 - Promiscuous mode
  21 - Jumbo frames
  22 - SR-IOV VF
  23 - Lock-free Tx queue
  24 - Multiple queues for TX and RX
  25 - Receiver Side Scaling (RSS)
  26 - MAC filtering
  27 - Inner and Outer Checksum offload
  28 - Link state information
  29 - Link flow control
  30 - MTU update
  31 - Scatter-Gather IO support
  32 - Vector Poll mode driver
  33
  34 Prerequisites
  35 -------------
  36
  37 See :doc:`../platform/cnxk` for setup information.
  38
  39
  40 Driver compilation and testing
  41 ------------------------------
  42
  43 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
  44 for details.
  45
  46 #. Running testpmd:
  47
  48    Follow instructions available in the document
  49    :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
  50    to run testpmd.
  51
  52    Example output:
  53
  54    .. code-block:: console
  55
  56       ./<build_dir>/app/dpdk-testpmd -c 0xc -a 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1
  57       EAL: Detected 4 lcore(s)
  58       EAL: Detected 1 NUMA nodes
  59       EAL: Multi-process socket /var/run/dpdk/rte/mp_socket
  60       EAL: Selected IOVA mode 'VA'
  61       EAL: No available hugepages reported in hugepages-16777216kB
  62       EAL: No available hugepages reported in hugepages-2048kB
  63       EAL: Probing VFIO support...
  64       EAL: VFIO support initialized
  65       EAL:   using IOMMU type 1 (Type 1)
  66       [ 2003.202721] vfio-pci 0002:02:00.0: vfio_cap_init: hiding cap 0x14@0x98
  67       EAL: Probe PCI driver: net_cn10k (177d:a063) device: 0002:02:00.0 (socket 0)
  68       PMD: RoC Model: cn10k
  69       EAL: No legacy callbacks, legacy socket not created
  70       testpmd: create a new mbuf pool <mb_pool_0>: n=155456, size=2176, socket=0
  71       testpmd: preferred mempool ops selected: cn10k_mempool_ops
  72       Configuring Port 0 (socket 0)
  73       PMD: Port 0: Link Up - speed 25000 Mbps - full-duplex
  74
  75       Port 0: link state change event
  76       Port 0: 96:D4:99:72:A5:BF
  77       Checking link statuses...
  78       Done
  79       No commandline core given, start packet forwarding
  80       io packet forwarding - ports=1 - cores=1 - streams=1 - NUMA support enabled, MP allocation mode: native
  81       Logical Core 3 (socket 0) forwards packets on 1 streams:
  82         RX P=0/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
  83
  84         io packet forwarding packets/burst=32
  85         nb forwarding cores=1 - nb forwarding ports=1
  86         port 0: RX queue number: 1 Tx queue number: 1
  87           Rx offloads=0x0 Tx offloads=0x10000
  88           RX queue: 0
  89             RX desc=4096 - RX free threshold=0
  90             RX threshold registers: pthresh=0 hthresh=0  wthresh=0
  91             RX Offloads=0x0
  92           TX queue: 0
  93             TX desc=512 - TX free threshold=0
  94             TX threshold registers: pthresh=0 hthresh=0  wthresh=0
  95             TX offloads=0x0 - TX RS bit threshold=0
  96       Press enter to exit
  97
  98 Runtime Config Options
  99 ----------------------
 100
 101 - ``Rx&Tx scalar mode enable`` (default ``0``)
 102
 103    PMD supports both scalar and vector mode, it may be selected at runtime
 104    using ``scalar_enable`` ``devargs`` parameter.
 105
 106 - ``RSS reta size`` (default ``64``)
 107
 108    RSS redirection table size may be configured during runtime using ``reta_size``
 109    ``devargs`` parameter.
 110
 111    For example::
 112
 113       -a 0002:02:00.0,reta_size=256
 114
 115    With the above configuration, reta table of size 256 is populated.
 116
 117 - ``Flow priority levels`` (default ``3``)
 118
 119    RTE Flow priority levels can be configured during runtime using
 120    ``flow_max_priority`` ``devargs`` parameter.
 121
 122    For example::
 123
 124       -a 0002:02:00.0,flow_max_priority=10
 125
 126    With the above configuration, priority level was set to 10 (0-9). Max
 127    priority level supported is 32.
 128
 129 - ``Reserve Flow entries`` (default ``8``)
 130
 131    RTE flow entries can be pre allocated and the size of pre allocation can be
 132    selected runtime using ``flow_prealloc_size`` ``devargs`` parameter.
 133
 134    For example::
 135
 136       -a 0002:02:00.0,flow_prealloc_size=4
 137
 138    With the above configuration, pre alloc size was set to 4. Max pre alloc
 139    size supported is 32.
 140
 141 - ``Max SQB buffer count`` (default ``512``)
 142
 143    Send queue descriptor buffer count may be limited during runtime using
 144    ``max_sqb_count`` ``devargs`` parameter.
 145
 146    For example::
 147
 148       -a 0002:02:00.0,max_sqb_count=64
 149
 150    With the above configuration, each send queue's descriptor buffer count is
 151    limited to a maximum of 64 buffers.
 152
 153 - ``Switch header enable`` (default ``none``)
 154
 155    A port can be configured to a specific switch header type by using
 156    ``switch_header`` ``devargs`` parameter.
 157
 158    For example::
 159
 160       -a 0002:02:00.0,switch_header="higig2"
 161
 162    With the above configuration, higig2 will be enabled on that port and the
 163    traffic on this port should be higig2 traffic only. Supported switch header
 164    types are "higig2", "dsa", "chlen90b" and "chlen24b".
 165
 166 - ``RSS tag as XOR`` (default ``0``)
 167
 168    The HW gives two options to configure the RSS adder i.e
 169
 170    * ``rss_adder<7:0> = flow_tag<7:0> ^ flow_tag<15:8> ^ flow_tag<23:16> ^ flow_tag<31:24>``
 171
 172    * ``rss_adder<7:0> = flow_tag<7:0>``
 173
 174    Latter one aligns with standard NIC behavior vs former one is a legacy
 175    RSS adder scheme used in OCTEON TX2 products.
 176
 177    By default, the driver runs in the latter mode.
 178    Setting this flag to 1 to select the legacy mode.
 179
 180    For example to select the legacy mode(RSS tag adder as XOR)::
 181
 182       -a 0002:02:00.0,tag_as_xor=1
 183
 184
 185 .. note::
 186
 187    Above devarg parameters are configurable per device, user needs to pass the
 188    parameters to all the PCIe devices if application requires to configure on
 189    all the ethdev ports.
 190
 191 Limitations
 192 -----------
 193
 194 ``mempool_cnxk`` external mempool handler dependency
 195 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 196
 197 The OCTEON CN9K/CN10K SoC family NIC has inbuilt HW assisted external mempool manager.
 198 ``net_cnxk`` pmd only works with ``mempool_cnxk`` mempool handler
 199 as it is performance wise most effective way for packet allocation and Tx buffer
 200 recycling on OCTEON TX2 SoC platform.
 201
 202 CRC stripping
 203 ~~~~~~~~~~~~~
 204
 205 The OCTEON CN9K/CN10K SoC family NICs strip the CRC for every packet being received by
 206 the host interface irrespective of the offload configuration.
 207
 208 Debugging Options
 209 -----------------
 210
 211 .. _table_cnxk_ethdev_debug_options:
 212
 213 .. table:: cnxk ethdev debug options
 214
 215    +---+------------+-------------------------------------------------------+
 216    | # | Component  | EAL log command                                       |
 217    +===+============+=======================================================+
 218    | 1 | NIX        | --log-level='pmd\.net.cnxk,8'                         |
 219    +---+------------+-------------------------------------------------------+
 220    | 2 | NPC        | --log-level='pmd\.net.cnxk\.flow,8'                   |
 221    +---+------------+-------------------------------------------------------+