doc/guides/nics/fm10k.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2015-2016 Intel Corporation.
   3
   4 FM10K Poll Mode Driver
   5 ======================
   6
   7 The FM10K poll mode driver library provides support for the Intel FM10000
   8 (FM10K) family of 40GbE/100GbE adapters.
   9
  10 FTAG Based Forwarding of FM10K
  11 ------------------------------
  12
  13 FTAG Based Forwarding is a unique feature of FM10K. The FM10K family of NICs
  14 support the addition of a Fabric Tag (FTAG) to carry special information.
  15 The FTAG is placed at the beginning of the frame, it contains information
  16 such as where the packet comes from and goes, and the vlan tag. In FTAG based
  17 forwarding mode, the switch logic forwards packets according to glort (global
  18 resource tag) information, rather than the mac and vlan table. Currently this
  19 feature works only on PF.
  20
  21 To enable this feature, the user should pass a devargs parameter to the eal
  22 like "-a 84:00.0,enable_ftag=1", and the application should make sure an
  23 appropriate FTAG is inserted for every frame on TX side.
  24
  25 Vector PMD for FM10K
  26 --------------------
  27
  28 Vector PMD (vPMD) uses Intel® SIMD instructions to optimize packet I/O.
  29 It improves load/store bandwidth efficiency of L1 data cache by using a wider
  30 SSE/AVX ''register (1)''.
  31 The wider register gives space to hold multiple packet buffers so as to save
  32 on the number of instructions when bulk processing packets.
  33
  34 There is no change to the PMD API. The RX/TX handlers are the only two entries for
  35 vPMD packet I/O. They are transparently registered at runtime RX/TX execution
  36 if all required conditions are met.
  37
  38 Some constraints apply as pre-conditions for specific optimizations on bulk
  39 packet transfers. The following sections explain RX and TX constraints in the
  40 vPMD.
  41
  42
  43 RX Constraints
  44 ~~~~~~~~~~~~~~
  45
  46
  47 Prerequisites and Pre-conditions
  48 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  49
  50 For Vector RX it is assumed that the number of descriptor rings will be a power
  51 of 2. With this pre-condition, the ring pointer can easily scroll back to the
  52 head after hitting the tail without a conditional check. In addition Vector RX
  53 can use this assumption to do a bit mask using ``ring_size - 1``.
  54
  55
  56 Features not Supported by Vector RX PMD
  57 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  58
  59 Some features are not supported when trying to increase the throughput in
  60 vPMD. They are:
  61
  62 *   IEEE1588
  63
  64 *   Flow director
  65
  66 *   Header split
  67
  68 *   RX checksum offload
  69
  70 Other features are supported using optional MACRO configuration. They include:
  71
  72 *   HW VLAN strip
  73
  74 *   L3/L4 packet type
  75
  76 To enable via ``RX_OLFLAGS`` use ``RTE_LIBRTE_FM10K_RX_OLFLAGS_ENABLE=y``.
  77
  78 To guarantee the constraint, the following capabilities in ``dev_conf.rxmode.offloads``
  79 will be checked:
  80
  81 *   ``RTE_ETH_RX_OFFLOAD_VLAN_EXTEND``
  82
  83 *   ``RTE_ETH_RX_OFFLOAD_CHECKSUM``
  84
  85 *   ``RTE_ETH_RX_OFFLOAD_HEADER_SPLIT``
  86
  87 *   ``fdir_conf->mode``
  88
  89
  90 RX Burst Size
  91 ^^^^^^^^^^^^^
  92
  93 As vPMD is focused on high throughput, it processes 4 packets at a time. So it assumes
  94 that the RX burst should be greater than 4 packets per burst. It returns zero if using
  95 ``nb_pkt`` < 4 in the receive handler. If ``nb_pkt`` is not a multiple of 4, a
  96 floor alignment will be applied.
  97
  98
  99 TX Constraint
 100 ~~~~~~~~~~~~~
 101
 102 Features not Supported by TX Vector PMD
 103 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 104
 105 TX vPMD only works when offloads is set to 0
 106
 107 This means that it does not support any TX offload.
 108
 109 Limitations
 110 -----------
 111
 112
 113 Switch manager
 114 ~~~~~~~~~~~~~~
 115
 116 The Intel FM10000 family of NICs integrate a hardware switch and multiple host
 117 interfaces. The FM10000 PMD only manages host interfaces. For the
 118 switch component another switch driver has to be loaded prior to the
 119 FM10000 PMD. The switch driver can be acquired from Intel support.
 120 Only Testpoint is validated with DPDK, the latest version that has been
 121 validated with DPDK is 4.1.6.
 122
 123 Support for Switch Restart
 124 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 125
 126 For FM10000 multi host based design a DPDK app running in the VM or host needs
 127 to be aware of the switch's state since it may undergo a quit-restart. When
 128 the switch goes down the DPDK app will receive a LSC event indicating link
 129 status down, and the app should stop the worker threads that are polling on
 130 the Rx/Tx queues. When switch comes up, a LSC event indicating ``LINK_UP`` is
 131 sent to the app, which can then restart the FM10000 port to resume network
 132 processing.
 133
 134 CRC stripping
 135 ~~~~~~~~~~~~~
 136
 137 The FM10000 family of NICs strip the CRC for every packets coming into the
 138 host interface. So, keeping CRC is not supported.
 139
 140 Maximum packet length
 141 ~~~~~~~~~~~~~~~~~~~~~
 142
 143 The FM10000 family of NICS support a maximum of a 15K jumbo frame. The value
 144 is fixed and cannot be changed. So, even when the ``rxmode.mtu``
 145 member of ``struct rte_eth_conf`` is set to a value lower than 15364, frames
 146 up to 15364 bytes can still reach the host interface.
 147
 148 Statistic Polling Frequency
 149 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 150
 151 The FM10000 NICs expose a set of statistics via the PCI BARs. These statistics
 152 are read from the hardware registers when ``rte_eth_stats_get()`` or
 153 ``rte_eth_xstats_get()`` is called. The packet counting registers are 32 bits
 154 while the byte counting registers are 48 bits. As a result, the statistics must
 155 be polled regularly in order to ensure the consistency of the returned reads.
 156
 157 Given the PCIe Gen3 x8, about 50Gbps of traffic can occur. With 64 byte packets
 158 this gives almost 100 million packets/second, causing 32 bit integer overflow
 159 after approx 40 seconds. To ensure these overflows are detected and accounted
 160 for in the statistics, it is necessary to read statistic regularly. It is
 161 suggested to read stats every 20 seconds, which will ensure the statistics
 162 are accurate.
 163
 164
 165 Interrupt mode
 166 ~~~~~~~~~~~~~~
 167
 168 The FM10000 family of NICS need one separate interrupt for mailbox. So only
 169 drivers which support multiple interrupt vectors e.g. vfio-pci can work
 170 for fm10k interrupt mode.