doc/guides/nics/i40e.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2016 Intel Corporation.
   3
   4 I40E Poll Mode Driver
   5 ======================
   6
   7 The i40e PMD (librte_pmd_i40e) provides poll mode driver support for
   8 10/25/40 Gbps Intel® Ethernet 700 Series Network Adapters based on
   9 the Intel Ethernet Controller X710/XL710/XXV710 and Intel Ethernet
  10 Connection X722 (only support part of features).
  11
  12
  13 Features
  14 --------
  15
  16 Features of the i40e PMD are:
  17
  18 - Multiple queues for TX and RX
  19 - Receiver Side Scaling (RSS)
  20 - MAC/VLAN filtering
  21 - Packet type information
  22 - Flow director
  23 - Cloud filter
  24 - Checksum offload
  25 - VLAN/QinQ stripping and inserting
  26 - TSO offload
  27 - Promiscuous mode
  28 - Multicast mode
  29 - Port hardware statistics
  30 - Jumbo frames
  31 - Link state information
  32 - Link flow control
  33 - Mirror on port, VLAN and VSI
  34 - Interrupt mode for RX
  35 - Scattered and gather for TX and RX
  36 - Vector Poll mode driver
  37 - DCB
  38 - VMDQ
  39 - SR-IOV VF
  40 - Hot plug
  41 - IEEE1588/802.1AS timestamping
  42 - VF Daemon (VFD) - EXPERIMENTAL
  43 - Dynamic Device Personalization (DDP)
  44 - Queue region configuration
  45 - Virtual Function Port Representors
  46
  47 Prerequisites
  48 -------------
  49
  50 - Identifying your adapter using `Intel Support
  51   <http://www.intel.com/support>`_ and get the latest NVM/FW images.
  52
  53 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
  54
  55 - To get better performance on Intel platforms, please follow the "How to get best performance with NICs on Intel platforms"
  56   section of the :ref:`Getting Started Guide for Linux <linux_gsg>`.
  57
  58 - Upgrade the NVM/FW version following the `Intel® Ethernet NVM Update Tool Quick Usage Guide for Linux
  59   <https://www-ssl.intel.com/content/www/us/en/embedded/products/networking/nvm-update-tool-quick-linux-usage-guide.html>`_ and `Intel® Ethernet NVM Update Tool: Quick Usage Guide for EFI <https://www.intel.com/content/www/us/en/embedded/products/networking/nvm-update-tool-quick-efi-usage-guide.html>`_ if needed.
  60
  61 Recommended Matching List
  62 -------------------------
  63
  64 It is highly recommended to upgrade the i40e kernel driver and firmware to
  65 avoid the compatibility issues with i40e PMD. Here is the suggested matching
  66 list which has been tested and verified. The detailed information can refer
  67 to chapter Tested Platforms/Tested NICs in release notes.
  68
  69    +--------------+-----------------------+------------------+
  70    | DPDK version | Kernel driver version | Firmware version |
  71    +==============+=======================+==================+
  72    |    18.05     |         2.4.6         |       6.01       |
  73    +--------------+-----------------------+------------------+
  74    |    18.02     |         2.4.3         |       6.01       |
  75    +--------------+-----------------------+------------------+
  76    |    17.11     |         2.1.26        |       6.01       |
  77    +--------------+-----------------------+------------------+
  78    |    17.08     |         2.0.19        |       6.01       |
  79    +--------------+-----------------------+------------------+
  80    |    17.05     |         1.5.23        |       5.05       |
  81    +--------------+-----------------------+------------------+
  82    |    17.02     |         1.5.23        |       5.05       |
  83    +--------------+-----------------------+------------------+
  84    |    16.11     |         1.5.23        |       5.05       |
  85    +--------------+-----------------------+------------------+
  86    |    16.07     |         1.4.25        |       5.04       |
  87    +--------------+-----------------------+------------------+
  88    |    16.04     |         1.4.25        |       5.02       |
  89    +--------------+-----------------------+------------------+
  90
  91 Pre-Installation Configuration
  92 ------------------------------
  93
  94 Config File Options
  95 ~~~~~~~~~~~~~~~~~~~
  96
  97 The following options can be modified in the ``config`` file.
  98 Please note that enabling debugging options may affect system performance.
  99
 100 - ``CONFIG_RTE_LIBRTE_I40E_PMD`` (default ``y``)
 101
 102   Toggle compilation of the ``librte_pmd_i40e`` driver.
 103
 104 - ``CONFIG_RTE_LIBRTE_I40E_DEBUG_*`` (default ``n``)
 105
 106   Toggle display of generic debugging messages.
 107
 108 - ``CONFIG_RTE_LIBRTE_I40E_RX_ALLOW_BULK_ALLOC`` (default ``y``)
 109
 110   Toggle bulk allocation for RX.
 111
 112 - ``CONFIG_RTE_LIBRTE_I40E_INC_VECTOR`` (default ``n``)
 113
 114   Toggle the use of Vector PMD instead of normal RX/TX path.
 115   To enable vPMD for RX, bulk allocation for Rx must be allowed.
 116
 117 - ``CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC`` (default ``n``)
 118
 119   Toggle to use a 16-byte RX descriptor, by default the RX descriptor is 32 byte.
 120
 121 - ``CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_PF`` (default ``64``)
 122
 123   Number of queues reserved for PF.
 124
 125 - ``CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_VM`` (default ``4``)
 126
 127   Number of queues reserved for each VMDQ Pool.
 128
 129 Runtime Config Options
 130 ~~~~~~~~~~~~~~~~~~~~~~
 131
 132 - ``Reserved number of Queues per VF`` (default ``4``)
 133
 134   The number of reserved queue per VF is determined by its host PF. If the
 135   PCI address of an i40e PF is aaaa:bb.cc, the number of reserved queues per
 136   VF can be configured with EAL parameter like -w aaaa:bb.cc,queue-num-per-vf=n.
 137   The value n can be 1, 2, 4, 8 or 16. If no such parameter is configured, the
 138   number of reserved queues per VF is 4 by default. If VF request more than
 139   reserved queues per VF, PF will able to allocate max to 16 queues after a VF
 140   reset.
 141
 142
 143 - ``Support multiple driver`` (default ``disable``)
 144
 145   There was a multiple driver support issue during use of 700 series Ethernet
 146   Adapter with both Linux kernel and DPDK PMD. To fix this issue, ``devargs``
 147   parameter ``support-multi-driver`` is introduced, for example::
 148
 149     -w 84:00.0,support-multi-driver=1
 150
 151   With the above configuration, DPDK PMD will not change global registers, and
 152   will switch PF interrupt from IntN to Int0 to avoid interrupt conflict between
 153   DPDK and Linux Kernel.
 154
 155 - ``Support VF Port Representor`` (default ``not enabled``)
 156
 157   The i40e PF PMD supports the creation of VF port representors for the control
 158   and monitoring of i40e virtual function devices. Each port representor
 159   corresponds to a single virtual function of that device. Using the ``devargs``
 160   option ``representor`` the user can specify which virtual functions to create
 161   port representors for on initialization of the PF PMD by passing the VF IDs of
 162   the VFs which are required.::
 163
 164   -w DBDF,representor=[0,1,4]
 165
 166   Currently hot-plugging of representor ports is not supported so all required
 167   representors must be specified on the creation of the PF.
 168
 169 - ``Use latest supported vector`` (default ``disable``)
 170
 171   Latest supported vector path may not always get the best perf so vector path was
 172   recommended to use only on later platform. But users may want the latest vector path
 173   since it can get better perf in some real work loading cases. So ``devargs`` param
 174   ``use-latest-supported-vec`` is introduced, for example::
 175
 176   -w 84:00.0,use-latest-supported-vec=1
 177
 178 Vector RX Pre-conditions
 179 ~~~~~~~~~~~~~~~~~~~~~~~~
 180 For Vector RX it is assumed that the number of descriptor rings will be a power
 181 of 2. With this pre-condition, the ring pointer can easily scroll back to the
 182 head after hitting the tail without a conditional check. In addition Vector RX
 183 can use this assumption to do a bit mask using ``ring_size - 1``.
 184
 185 Driver compilation and testing
 186 ------------------------------
 187
 188 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 189 for details.
 190
 191
 192 SR-IOV: Prerequisites and sample Application Notes
 193 --------------------------------------------------
 194
 195 #. Load the kernel module:
 196
 197    .. code-block:: console
 198
 199       modprobe i40e
 200
 201    Check the output in dmesg:
 202
 203    .. code-block:: console
 204
 205       i40e 0000:83:00.1 ens802f0: renamed from eth0
 206
 207 #. Bring up the PF ports:
 208
 209    .. code-block:: console
 210
 211       ifconfig ens802f0 up
 212
 213 #. Create VF device(s):
 214
 215    Echo the number of VFs to be created into the ``sriov_numvfs`` sysfs entry
 216    of the parent PF.
 217
 218    Example:
 219
 220    .. code-block:: console
 221
 222       echo 2 > /sys/devices/pci0000:00/0000:00:03.0/0000:81:00.0/sriov_numvfs
 223
 224
 225 #. Assign VF MAC address:
 226
 227    Assign MAC address to the VF using iproute2 utility. The syntax is:
 228
 229    .. code-block:: console
 230
 231       ip link set <PF netdev id> vf <VF id> mac <macaddr>
 232
 233    Example:
 234
 235    .. code-block:: console
 236
 237       ip link set ens802f0 vf 0 mac a0:b0:c0:d0:e0:f0
 238
 239 #. Assign VF to VM, and bring up the VM.
 240    Please see the documentation for the *I40E/IXGBE/IGB Virtual Function Driver*.
 241
 242 #. Running testpmd:
 243
 244    Follow instructions available in the document
 245    :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 246    to run testpmd.
 247
 248    Example output:
 249
 250    .. code-block:: console
 251
 252       ...
 253       EAL: PCI device 0000:83:00.0 on NUMA socket 1
 254       EAL: probe driver: 8086:1572 rte_i40e_pmd
 255       EAL: PCI memory mapped at 0x7f7f80000000
 256       EAL: PCI memory mapped at 0x7f7f80800000
 257       PMD: eth_i40e_dev_init(): FW 5.0 API 1.5 NVM 05.00.02 eetrack 8000208a
 258       Interactive-mode selected
 259       Configuring Port 0 (socket 0)
 260       ...
 261
 262       PMD: i40e_dev_rx_queue_setup(): Rx Burst Bulk Alloc Preconditions are
 263       satisfied.Rx Burst Bulk Alloc function will be used on port=0, queue=0.
 264
 265       ...
 266       Port 0: 68:05:CA:26:85:84
 267       Checking link statuses...
 268       Port 0 Link Up - speed 10000 Mbps - full-duplex
 269       Done
 270
 271       testpmd>
 272
 273
 274 Sample Application Notes
 275 ------------------------
 276
 277 Vlan filter
 278 ~~~~~~~~~~~
 279
 280 Vlan filter only works when Promiscuous mode is off.
 281
 282 To start ``testpmd``, and add vlan 10 to port 0:
 283
 284 .. code-block:: console
 285
 286     ./app/testpmd -l 0-15 -n 4 -- -i --forward-mode=mac
 287     ...
 288
 289     testpmd> set promisc 0 off
 290     testpmd> rx_vlan add 10 0
 291
 292
 293 Flow Director
 294 ~~~~~~~~~~~~~
 295
 296 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
 297 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set per flow type and the flexible payload.
 298
 299 The default input set of each flow type is::
 300
 301    ipv4-other : src_ip_address, dst_ip_address
 302    ipv4-frag  : src_ip_address, dst_ip_address
 303    ipv4-tcp   : src_ip_address, dst_ip_address, src_port, dst_port
 304    ipv4-udp   : src_ip_address, dst_ip_address, src_port, dst_port
 305    ipv4-sctp  : src_ip_address, dst_ip_address, src_port, dst_port,
 306                 verification_tag
 307    ipv6-other : src_ip_address, dst_ip_address
 308    ipv6-frag  : src_ip_address, dst_ip_address
 309    ipv6-tcp   : src_ip_address, dst_ip_address, src_port, dst_port
 310    ipv6-udp   : src_ip_address, dst_ip_address, src_port, dst_port
 311    ipv6-sctp  : src_ip_address, dst_ip_address, src_port, dst_port,
 312                 verification_tag
 313    l2_payload : ether_type
 314
 315 The flex payload is selected from offset 0 to 15 of packet's payload by default, while it is masked out from matching.
 316
 317 Start ``testpmd`` with ``--disable-rss`` and ``--pkt-filter-mode=perfect``:
 318
 319 .. code-block:: console
 320
 321    ./app/testpmd -l 0-15 -n 4 -- -i --disable-rss --pkt-filter-mode=perfect \
 322                  --rxq=8 --txq=8 --nb-cores=8 --nb-ports=1
 323
 324 Add a rule to direct ``ipv4-udp`` packet whose ``dst_ip=2.2.2.5, src_ip=2.2.2.3, src_port=32, dst_port=32`` to queue 1:
 325
 326 .. code-block:: console
 327
 328    testpmd> flow_director_filter 0 mode IP add flow ipv4-udp  \
 329             src 2.2.2.3 32 dst 2.2.2.5 32 vlan 0 flexbytes () \
 330             fwd pf queue 1 fd_id 1
 331
 332 Check the flow director status:
 333
 334 .. code-block:: console
 335
 336    testpmd> show port fdir 0
 337
 338    ######################## FDIR infos for port 0      ####################
 339      MODE:   PERFECT
 340      SUPPORTED FLOW TYPE:  ipv4-frag ipv4-tcp ipv4-udp ipv4-sctp ipv4-other
 341                            ipv6-frag ipv6-tcp ipv6-udp ipv6-sctp ipv6-other
 342                            l2_payload
 343      FLEX PAYLOAD INFO:
 344      max_len:       16          payload_limit: 480
 345      payload_unit:  2           payload_seg:   3
 346      bitmask_unit:  2           bitmask_num:   2
 347      MASK:
 348        vlan_tci: 0x0000,
 349        src_ipv4: 0x00000000,
 350        dst_ipv4: 0x00000000,
 351        src_port: 0x0000,
 352        dst_port: 0x0000
 353        src_ipv6: 0x00000000,0x00000000,0x00000000,0x00000000,
 354        dst_ipv6: 0x00000000,0x00000000,0x00000000,0x00000000
 355      FLEX PAYLOAD SRC OFFSET:
 356        L2_PAYLOAD:    0      1      2      3      4      5      6  ...
 357        L3_PAYLOAD:    0      1      2      3      4      5      6  ...
 358        L4_PAYLOAD:    0      1      2      3      4      5      6  ...
 359      FLEX MASK CFG:
 360        ipv4-udp:    00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 361        ipv4-tcp:    00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 362        ipv4-sctp:   00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 363        ipv4-other:  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 364        ipv4-frag:   00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 365        ipv6-udp:    00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 366        ipv6-tcp:    00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 367        ipv6-sctp:   00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 368        ipv6-other:  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 369        ipv6-frag:   00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 370        l2_payload:  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 371      guarant_count: 1           best_count:    0
 372      guarant_space: 512         best_space:    7168
 373      collision:     0           free:          0
 374      maxhash:       0           maxlen:        0
 375      add:           0           remove:        0
 376      f_add:         0           f_remove:      0
 377
 378
 379 Delete all flow director rules on a port:
 380
 381 .. code-block:: console
 382
 383    testpmd> flush_flow_director 0
 384
 385 Floating VEB
 386 ~~~~~~~~~~~~~
 387
 388 The Intel® Ethernet 700 Series support a feature called
 389 "Floating VEB".
 390
 391 A Virtual Ethernet Bridge (VEB) is an IEEE Edge Virtual Bridging (EVB) term
 392 for functionality that allows local switching between virtual endpoints within
 393 a physical endpoint and also with an external bridge/network.
 394
 395 A "Floating" VEB doesn't have an uplink connection to the outside world so all
 396 switching is done internally and remains within the host. As such, this
 397 feature provides security benefits.
 398
 399 In addition, a Floating VEB overcomes a limitation of normal VEBs where they
 400 cannot forward packets when the physical link is down. Floating VEBs don't need
 401 to connect to the NIC port so they can still forward traffic from VF to VF
 402 even when the physical link is down.
 403
 404 Therefore, with this feature enabled VFs can be limited to communicating with
 405 each other but not an outside network, and they can do so even when there is
 406 no physical uplink on the associated NIC port.
 407
 408 To enable this feature, the user should pass a ``devargs`` parameter to the
 409 EAL, for example::
 410
 411     -w 84:00.0,enable_floating_veb=1
 412
 413 In this configuration the PMD will use the floating VEB feature for all the
 414 VFs created by this PF device.
 415
 416 Alternatively, the user can specify which VFs need to connect to this floating
 417 VEB using the ``floating_veb_list`` argument::
 418
 419     -w 84:00.0,enable_floating_veb=1,floating_veb_list=1;3-4
 420
 421 In this example ``VF1``, ``VF3`` and ``VF4`` connect to the floating VEB,
 422 while other VFs connect to the normal VEB.
 423
 424 The current implementation only supports one floating VEB and one regular
 425 VEB. VFs can connect to a floating VEB or a regular VEB according to the
 426 configuration passed on the EAL command line.
 427
 428 The floating VEB functionality requires a NIC firmware version of 5.0
 429 or greater.
 430
 431 Dynamic Device Personalization (DDP)
 432 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 433
 434 The Intel® Ethernet 700 Series except for the Intel Ethernet Connection
 435 X722 support a feature called "Dynamic Device Personalization (DDP)",
 436 which is used to configure hardware by downloading a profile to support
 437 protocols/filters which are not supported by default. The DDP
 438 functionality requires a NIC firmware version of 6.0 or greater.
 439
 440 Current implementation supports GTP-C/GTP-U/PPPoE/PPPoL2TP,
 441 steering can be used with rte_flow API.
 442
 443 GTPv1 package is released, and it can be downloaded from
 444 https://downloadcenter.intel.com/download/27587.
 445
 446 PPPoE package is released, and it can be downloaded from
 447 https://downloadcenter.intel.com/download/28040.
 448
 449 Load a profile which supports GTP and store backup profile:
 450
 451 .. code-block:: console
 452
 453    testpmd> ddp add 0 ./gtp.pkgo,./backup.pkgo
 454
 455 Delete a GTP profile and restore backup profile:
 456
 457 .. code-block:: console
 458
 459    testpmd> ddp del 0 ./backup.pkgo
 460
 461 Get loaded DDP package info list:
 462
 463 .. code-block:: console
 464
 465    testpmd> ddp get list 0
 466
 467 Display information about a GTP profile:
 468
 469 .. code-block:: console
 470
 471    testpmd> ddp get info ./gtp.pkgo
 472
 473 Input set configuration
 474 ~~~~~~~~~~~~~~~~~~~~~~~
 475 Input set for any PCTYPE can be configured with user defined configuration,
 476 For example, to use only 48bit prefix for IPv6 src address for IPv6 TCP RSS:
 477
 478 .. code-block:: console
 479
 480    testpmd> port config 0 pctype 43 hash_inset clear all
 481    testpmd> port config 0 pctype 43 hash_inset set field 13
 482    testpmd> port config 0 pctype 43 hash_inset set field 14
 483    testpmd> port config 0 pctype 43 hash_inset set field 15
 484
 485 Queue region configuration
 486 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 487 The Intel® Ethernet 700 Series supports a feature of queue regions
 488 configuration for RSS in the PF, so that different traffic classes or
 489 different packet classification types can be separated to different
 490 queues in different queue regions. There is an API for configuration
 491 of queue regions in RSS with a command line. It can parse the parameters
 492 of the region index, queue number, queue start index, user priority, traffic
 493 classes and so on. Depending on commands from the command line, it will call
 494 i40e private APIs and start the process of setting or flushing the queue
 495 region configuration. As this feature is specific for i40e only private
 496 APIs are used. These new ``test_pmd`` commands are as shown below. For
 497 details please refer to :doc:`../testpmd_app_ug/index`.
 498
 499 .. code-block:: console
 500
 501    testpmd> set port (port_id) queue-region region_id (value) \
 502                 queue_start_index (value) queue_num (value)
 503    testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
 504    testpmd> set port (port_id) queue-region UP (value) region_id (value)
 505    testpmd> set port (port_id) queue-region flush (on|off)
 506    testpmd> show port (port_id) queue-region
 507
 508 Limitations or Known issues
 509 ---------------------------
 510
 511 MPLS packet classification
 512 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 513
 514 For firmware versions prior to 5.0, MPLS packets are not recognized by the NIC.
 515 The L2 Payload flow type in flow director can be used to classify MPLS packet
 516 by using a command in testpmd like:
 517
 518    testpmd> flow_director_filter 0 mode IP add flow l2_payload ether \
 519             0x8847 flexbytes () fwd pf queue <N> fd_id <M>
 520
 521 With the NIC firmware version 5.0 or greater, some limited MPLS support
 522 is added: Native MPLS (MPLS in Ethernet) skip is implemented, while no
 523 new packet type, no classification or offload are possible. With this change,
 524 L2 Payload flow type in flow director cannot be used to classify MPLS packet
 525 as with previous firmware versions. Meanwhile, the Ethertype filter can be
 526 used to classify MPLS packet by using a command in testpmd like:
 527
 528    testpmd> ethertype_filter 0 add mac_ignr 00:00:00:00:00:00 ethertype \
 529             0x8847 fwd queue <M>
 530
 531 16 Byte RX Descriptor setting on DPDK VF
 532 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 533
 534 Currently the VF's RX descriptor mode is decided by PF. There's no PF-VF
 535 interface for VF to request the RX descriptor mode, also no interface to notify
 536 VF its own RX descriptor mode.
 537 For all available versions of the i40e driver, these drivers don't support 16
 538 byte RX descriptor. If the Linux i40e kernel driver is used as host driver,
 539 while DPDK i40e PMD is used as the VF driver, DPDK cannot choose 16 byte receive
 540 descriptor. The reason is that the RX descriptor is already set to 32 byte by
 541 the i40e kernel driver. That is to say, user should keep
 542 ``CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC=n`` in config file.
 543 In the future, if the Linux i40e driver supports 16 byte RX descriptor, user
 544 should make sure the DPDK VF uses the same RX descriptor mode, 16 byte or 32
 545 byte, as the PF driver.
 546
 547 The same rule for DPDK PF + DPDK VF. The PF and VF should use the same RX
 548 descriptor mode. Or the VF RX will not work.
 549
 550 Receive packets with Ethertype 0x88A8
 551 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 552
 553 Due to the FW limitation, PF can receive packets with Ethertype 0x88A8
 554 only when floating VEB is disabled.
 555
 556 Incorrect Rx statistics when packet is oversize
 557 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 558
 559 When a packet is over maximum frame size, the packet is dropped.
 560 However, the Rx statistics, when calling `rte_eth_stats_get` incorrectly
 561 shows it as received.
 562
 563 VF & TC max bandwidth setting
 564 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 565
 566 The per VF max bandwidth and per TC max bandwidth cannot be enabled in parallel.
 567 The behavior is different when handling per VF and per TC max bandwidth setting.
 568 When enabling per VF max bandwidth, SW will check if per TC max bandwidth is
 569 enabled. If so, return failure.
 570 When enabling per TC max bandwidth, SW will check if per VF max bandwidth
 571 is enabled. If so, disable per VF max bandwidth and continue with per TC max
 572 bandwidth setting.
 573
 574 TC TX scheduling mode setting
 575 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 576
 577 There're 2 TX scheduling modes for TCs, round robin and strict priority mode.
 578 If a TC is set to strict priority mode, it can consume unlimited bandwidth.
 579 It means if APP has set the max bandwidth for that TC, it comes to no
 580 effect.
 581 It's suggested to set the strict priority mode for a TC that is latency
 582 sensitive but no consuming much bandwidth.
 583
 584 VF performance is impacted by PCI extended tag setting
 585 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 586
 587 To reach maximum NIC performance in the VF the PCI extended tag must be
 588 enabled. The DPDK i40e PF driver will set this feature during initialization,
 589 but the kernel PF driver does not. So when running traffic on a VF which is
 590 managed by the kernel PF driver, a significant NIC performance downgrade has
 591 been observed (for 64 byte packets, there is about 25% line-rate downgrade for
 592 a 25GbE device and about 35% for a 40GbE device).
 593
 594 For kernel version >= 4.11, the kernel's PCI driver will enable the extended
 595 tag if it detects that the device supports it. So by default, this is not an
 596 issue. For kernels <= 4.11 or when the PCI extended tag is disabled it can be
 597 enabled using the steps below.
 598
 599 #. Get the current value of the PCI configure register::
 600
 601       setpci -s <XX:XX.X> a8.w
 602
 603 #. Set bit 8::
 604
 605       value = value | 0x100
 606
 607 #. Set the PCI configure register with new value::
 608
 609       setpci -s <XX:XX.X> a8.w=<value>
 610
 611 Vlan strip of VF
 612 ~~~~~~~~~~~~~~~~
 613
 614 The VF vlan strip function is only supported in the i40e kernel driver >= 2.1.26.
 615
 616 DCB function
 617 ~~~~~~~~~~~~
 618
 619 DCB works only when RSS is enabled.
 620
 621 Global configuration warning
 622 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 623
 624 I40E PMD will set some global registers to enable some function or set some
 625 configure. Then when using different ports of the same NIC with Linux kernel
 626 and DPDK, the port with Linux kernel will be impacted by the port with DPDK.
 627 For example, register I40E_GL_SWT_L2TAGCTRL is used to control L2 tag, i40e
 628 PMD uses I40E_GL_SWT_L2TAGCTRL to set vlan TPID. If setting TPID in port A
 629 with DPDK, then the configuration will also impact port B in the NIC with
 630 kernel driver, which don't want to use the TPID.
 631 So PMD reports warning to clarify what is changed by writing global register.
 632
 633 High Performance of Small Packets on 40GbE NIC
 634 ----------------------------------------------
 635
 636 As there might be firmware fixes for performance enhancement in latest version
 637 of firmware image, the firmware update might be needed for getting high performance.
 638 Check the Intel support website for the latest firmware updates.
 639 Users should consult the release notes specific to a DPDK release to identify
 640 the validated firmware version for a NIC using the i40e driver.
 641
 642 Use 16 Bytes RX Descriptor Size
 643 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 644
 645 As i40e PMD supports both 16 and 32 bytes RX descriptor sizes, and 16 bytes size can provide helps to high performance of small packets.
 646 Configuration of ``CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC`` in config files can be changed to use 16 bytes size RX descriptors.
 647
 648 Example of getting best performance with l3fwd example
 649 ------------------------------------------------------
 650
 651 The following is an example of running the DPDK ``l3fwd`` sample application to get high performance with a
 652 server with Intel Xeon processors and Intel Ethernet CNA XL710.
 653
 654 The example scenario is to get best performance with two Intel Ethernet CNA XL710 40GbE ports.
 655 See :numref:`figure_intel_perf_test_setup` for the performance test setup.
 656
 657 .. _figure_intel_perf_test_setup:
 658
 659 .. figure:: img/intel_perf_test_setup.*
 660
 661    Performance Test Setup
 662
 663
 664 1. Add two Intel Ethernet CNA XL710 to the platform, and use one port per card to get best performance.
 665    The reason for using two NICs is to overcome a PCIe v3.0 limitation since it cannot provide 80GbE bandwidth
 666    for two 40GbE ports, but two different PCIe v3.0 x8 slot can.
 667    Refer to the sample NICs output above, then we can select ``82:00.0`` and ``85:00.0`` as test ports::
 668
 669       82:00.0 Ethernet [0200]: Intel XL710 for 40GbE QSFP+ [8086:1583]
 670       85:00.0 Ethernet [0200]: Intel XL710 for 40GbE QSFP+ [8086:1583]
 671
 672 2. Connect the ports to the traffic generator. For high speed testing, it's best to use a hardware traffic generator.
 673
 674 3. Check the PCI devices numa node (socket id) and get the cores number on the exact socket id.
 675    In this case, ``82:00.0`` and ``85:00.0`` are both in socket 1, and the cores on socket 1 in the referenced platform
 676    are 18-35 and 54-71.
 677    Note: Don't use 2 logical cores on the same core (e.g core18 has 2 logical cores, core18 and core54), instead, use 2 logical
 678    cores from different cores (e.g core18 and core19).
 679
 680 4. Bind these two ports to igb_uio.
 681
 682 5. As to Intel Ethernet CNA XL710 40GbE port, we need at least two queue pairs to achieve best performance, then two queues per port
 683    will be required, and each queue pair will need a dedicated CPU core for receiving/transmitting packets.
 684
 685 6. The DPDK sample application ``l3fwd`` will be used for performance testing, with using two ports for bi-directional forwarding.
 686    Compile the ``l3fwd sample`` with the default lpm mode.
 687
 688 7. The command line of running l3fwd would be something like the following::
 689
 690       ./l3fwd -l 18-21 -n 4 -w 82:00.0 -w 85:00.0 \
 691               -- -p 0x3 --config '(0,0,18),(0,1,19),(1,0,20),(1,1,21)'
 692
 693    This means that the application uses core 18 for port 0, queue pair 0 forwarding, core 19 for port 0, queue pair 1 forwarding,
 694    core 20 for port 1, queue pair 0 forwarding, and core 21 for port 1, queue pair 1 forwarding.
 695
 696 8. Configure the traffic at a traffic generator.
 697
 698    * Start creating a stream on packet generator.
 699
 700    * Set the Ethernet II type to 0x0800.