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 - ``Number of Queues per VF`` (default ``4``)
 133
 134   The number of queue per VF is determined by its host PF. If the PCI address
 135   of an i40e PF is aaaa:bb.cc, the number of queues per VF can be configured
 136   with EAL parameter like -w aaaa:bb.cc,queue-num-per-vf=n. The value n can be
 137   1, 2, 4, 8 or 16. If no such parameter is configured, the number of queues
 138   per VF is 4 by default.
 139
 140 - ``Support multiple driver`` (default ``disable``)
 141
 142   There was a multiple driver support issue during use of 700 series Ethernet
 143   Adapter with both Linux kernel and DPDK PMD. To fix this issue, ``devargs``
 144   parameter ``support-multi-driver`` is introduced, for example::
 145
 146     -w 84:00.0,support-multi-driver=1
 147
 148   With the above configuration, DPDK PMD will not change global registers, and
 149   will switch PF interrupt from IntN to Int0 to avoid interrupt conflict between
 150   DPDK and Linux Kernel.
 151
 152 - ``Support VF Port Representor`` (default ``not enabled``)
 153
 154   The i40e PF PMD supports the creation of VF port representors for the control
 155   and monitoring of i40e virtual function devices. Each port representor
 156   corresponds to a single virtual function of that device. Using the ``devargs``
 157   option ``representor`` the user can specify which virtual functions to create
 158   port representors for on initialization of the PF PMD by passing the VF IDs of
 159   the VFs which are required.::
 160
 161   -w DBDF,representor=[0,1,4]
 162
 163   Currently hot-plugging of representor ports is not supported so all required
 164   representors must be specified on the creation of the PF.
 165
 166 Driver compilation and testing
 167 ------------------------------
 168
 169 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 170 for details.
 171
 172
 173 SR-IOV: Prerequisites and sample Application Notes
 174 --------------------------------------------------
 175
 176 #. Load the kernel module:
 177
 178    .. code-block:: console
 179
 180       modprobe i40e
 181
 182    Check the output in dmesg:
 183
 184    .. code-block:: console
 185
 186       i40e 0000:83:00.1 ens802f0: renamed from eth0
 187
 188 #. Bring up the PF ports:
 189
 190    .. code-block:: console
 191
 192       ifconfig ens802f0 up
 193
 194 #. Create VF device(s):
 195
 196    Echo the number of VFs to be created into the ``sriov_numvfs`` sysfs entry
 197    of the parent PF.
 198
 199    Example:
 200
 201    .. code-block:: console
 202
 203       echo 2 > /sys/devices/pci0000:00/0000:00:03.0/0000:81:00.0/sriov_numvfs
 204
 205
 206 #. Assign VF MAC address:
 207
 208    Assign MAC address to the VF using iproute2 utility. The syntax is:
 209
 210    .. code-block:: console
 211
 212       ip link set <PF netdev id> vf <VF id> mac <macaddr>
 213
 214    Example:
 215
 216    .. code-block:: console
 217
 218       ip link set ens802f0 vf 0 mac a0:b0:c0:d0:e0:f0
 219
 220 #. Assign VF to VM, and bring up the VM.
 221    Please see the documentation for the *I40E/IXGBE/IGB Virtual Function Driver*.
 222
 223 #. Running testpmd:
 224
 225    Follow instructions available in the document
 226    :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 227    to run testpmd.
 228
 229    Example output:
 230
 231    .. code-block:: console
 232
 233       ...
 234       EAL: PCI device 0000:83:00.0 on NUMA socket 1
 235       EAL: probe driver: 8086:1572 rte_i40e_pmd
 236       EAL: PCI memory mapped at 0x7f7f80000000
 237       EAL: PCI memory mapped at 0x7f7f80800000
 238       PMD: eth_i40e_dev_init(): FW 5.0 API 1.5 NVM 05.00.02 eetrack 8000208a
 239       Interactive-mode selected
 240       Configuring Port 0 (socket 0)
 241       ...
 242
 243       PMD: i40e_dev_rx_queue_setup(): Rx Burst Bulk Alloc Preconditions are
 244       satisfied.Rx Burst Bulk Alloc function will be used on port=0, queue=0.
 245
 246       ...
 247       Port 0: 68:05:CA:26:85:84
 248       Checking link statuses...
 249       Port 0 Link Up - speed 10000 Mbps - full-duplex
 250       Done
 251
 252       testpmd>
 253
 254
 255 Sample Application Notes
 256 ------------------------
 257
 258 Vlan filter
 259 ~~~~~~~~~~~
 260
 261 Vlan filter only works when Promiscuous mode is off.
 262
 263 To start ``testpmd``, and add vlan 10 to port 0:
 264
 265 .. code-block:: console
 266
 267     ./app/testpmd -l 0-15 -n 4 -- -i --forward-mode=mac
 268     ...
 269
 270     testpmd> set promisc 0 off
 271     testpmd> rx_vlan add 10 0
 272
 273
 274 Flow Director
 275 ~~~~~~~~~~~~~
 276
 277 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
 278 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.
 279
 280 The default input set of each flow type is::
 281
 282    ipv4-other : src_ip_address, dst_ip_address
 283    ipv4-frag  : src_ip_address, dst_ip_address
 284    ipv4-tcp   : src_ip_address, dst_ip_address, src_port, dst_port
 285    ipv4-udp   : src_ip_address, dst_ip_address, src_port, dst_port
 286    ipv4-sctp  : src_ip_address, dst_ip_address, src_port, dst_port,
 287                 verification_tag
 288    ipv6-other : src_ip_address, dst_ip_address
 289    ipv6-frag  : src_ip_address, dst_ip_address
 290    ipv6-tcp   : src_ip_address, dst_ip_address, src_port, dst_port
 291    ipv6-udp   : src_ip_address, dst_ip_address, src_port, dst_port
 292    ipv6-sctp  : src_ip_address, dst_ip_address, src_port, dst_port,
 293                 verification_tag
 294    l2_payload : ether_type
 295
 296 The flex payload is selected from offset 0 to 15 of packet's payload by default, while it is masked out from matching.
 297
 298 Start ``testpmd`` with ``--disable-rss`` and ``--pkt-filter-mode=perfect``:
 299
 300 .. code-block:: console
 301
 302    ./app/testpmd -l 0-15 -n 4 -- -i --disable-rss --pkt-filter-mode=perfect \
 303                  --rxq=8 --txq=8 --nb-cores=8 --nb-ports=1
 304
 305 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:
 306
 307 .. code-block:: console
 308
 309    testpmd> flow_director_filter 0 mode IP add flow ipv4-udp  \
 310             src 2.2.2.3 32 dst 2.2.2.5 32 vlan 0 flexbytes () \
 311             fwd pf queue 1 fd_id 1
 312
 313 Check the flow director status:
 314
 315 .. code-block:: console
 316
 317    testpmd> show port fdir 0
 318
 319    ######################## FDIR infos for port 0      ####################
 320      MODE:   PERFECT
 321      SUPPORTED FLOW TYPE:  ipv4-frag ipv4-tcp ipv4-udp ipv4-sctp ipv4-other
 322                            ipv6-frag ipv6-tcp ipv6-udp ipv6-sctp ipv6-other
 323                            l2_payload
 324      FLEX PAYLOAD INFO:
 325      max_len:       16          payload_limit: 480
 326      payload_unit:  2           payload_seg:   3
 327      bitmask_unit:  2           bitmask_num:   2
 328      MASK:
 329        vlan_tci: 0x0000,
 330        src_ipv4: 0x00000000,
 331        dst_ipv4: 0x00000000,
 332        src_port: 0x0000,
 333        dst_port: 0x0000
 334        src_ipv6: 0x00000000,0x00000000,0x00000000,0x00000000,
 335        dst_ipv6: 0x00000000,0x00000000,0x00000000,0x00000000
 336      FLEX PAYLOAD SRC OFFSET:
 337        L2_PAYLOAD:    0      1      2      3      4      5      6  ...
 338        L3_PAYLOAD:    0      1      2      3      4      5      6  ...
 339        L4_PAYLOAD:    0      1      2      3      4      5      6  ...
 340      FLEX MASK CFG:
 341        ipv4-udp:    00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 342        ipv4-tcp:    00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 343        ipv4-sctp:   00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 344        ipv4-other:  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 345        ipv4-frag:   00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 346        ipv6-udp:    00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 347        ipv6-tcp:    00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 348        ipv6-sctp:   00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 349        ipv6-other:  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 350        ipv6-frag:   00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 351        l2_payload:  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
 352      guarant_count: 1           best_count:    0
 353      guarant_space: 512         best_space:    7168
 354      collision:     0           free:          0
 355      maxhash:       0           maxlen:        0
 356      add:           0           remove:        0
 357      f_add:         0           f_remove:      0
 358
 359
 360 Delete all flow director rules on a port:
 361
 362 .. code-block:: console
 363
 364    testpmd> flush_flow_director 0
 365
 366 Floating VEB
 367 ~~~~~~~~~~~~~
 368
 369 The Intel® Ethernet 700 Series support a feature called
 370 "Floating VEB".
 371
 372 A Virtual Ethernet Bridge (VEB) is an IEEE Edge Virtual Bridging (EVB) term
 373 for functionality that allows local switching between virtual endpoints within
 374 a physical endpoint and also with an external bridge/network.
 375
 376 A "Floating" VEB doesn't have an uplink connection to the outside world so all
 377 switching is done internally and remains within the host. As such, this
 378 feature provides security benefits.
 379
 380 In addition, a Floating VEB overcomes a limitation of normal VEBs where they
 381 cannot forward packets when the physical link is down. Floating VEBs don't need
 382 to connect to the NIC port so they can still forward traffic from VF to VF
 383 even when the physical link is down.
 384
 385 Therefore, with this feature enabled VFs can be limited to communicating with
 386 each other but not an outside network, and they can do so even when there is
 387 no physical uplink on the associated NIC port.
 388
 389 To enable this feature, the user should pass a ``devargs`` parameter to the
 390 EAL, for example::
 391
 392     -w 84:00.0,enable_floating_veb=1
 393
 394 In this configuration the PMD will use the floating VEB feature for all the
 395 VFs created by this PF device.
 396
 397 Alternatively, the user can specify which VFs need to connect to this floating
 398 VEB using the ``floating_veb_list`` argument::
 399
 400     -w 84:00.0,enable_floating_veb=1,floating_veb_list=1;3-4
 401
 402 In this example ``VF1``, ``VF3`` and ``VF4`` connect to the floating VEB,
 403 while other VFs connect to the normal VEB.
 404
 405 The current implementation only supports one floating VEB and one regular
 406 VEB. VFs can connect to a floating VEB or a regular VEB according to the
 407 configuration passed on the EAL command line.
 408
 409 The floating VEB functionality requires a NIC firmware version of 5.0
 410 or greater.
 411
 412 Dynamic Device Personalization (DDP)
 413 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 414
 415 The Intel® Ethernet 700 Series except for the Intel Ethernet Connection
 416 X722 support a feature called "Dynamic Device Personalization (DDP)",
 417 which is used to configure hardware by downloading a profile to support
 418 protocols/filters which are not supported by default. The DDP
 419 functionality requires a NIC firmware version of 6.0 or greater.
 420
 421 Current implementation supports GTP-C/GTP-U/PPPoE/PPPoL2TP,
 422 steering can be used with rte_flow API.
 423
 424 Load a profile which supports GTP and store backup profile:
 425
 426 .. code-block:: console
 427
 428    testpmd> ddp add 0 ./gtp.pkgo,./backup.pkgo
 429
 430 Delete a GTP profile and restore backup profile:
 431
 432 .. code-block:: console
 433
 434    testpmd> ddp del 0 ./backup.pkgo
 435
 436 Get loaded DDP package info list:
 437
 438 .. code-block:: console
 439
 440    testpmd> ddp get list 0
 441
 442 Display information about a GTP profile:
 443
 444 .. code-block:: console
 445
 446    testpmd> ddp get info ./gtp.pkgo
 447
 448 Input set configuration
 449 ~~~~~~~~~~~~~~~~~~~~~~~
 450 Input set for any PCTYPE can be configured with user defined configuration,
 451 For example, to use only 48bit prefix for IPv6 src address for IPv6 TCP RSS:
 452
 453 .. code-block:: console
 454
 455    testpmd> port config 0 pctype 43 hash_inset clear all
 456    testpmd> port config 0 pctype 43 hash_inset set field 13
 457    testpmd> port config 0 pctype 43 hash_inset set field 14
 458    testpmd> port config 0 pctype 43 hash_inset set field 15
 459
 460 Queue region configuration
 461 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 462 The Intel® Ethernet 700 Series supports a feature of queue regions
 463 configuration for RSS in the PF, so that different traffic classes or
 464 different packet classification types can be separated to different
 465 queues in different queue regions. There is an API for configuration
 466 of queue regions in RSS with a command line. It can parse the parameters
 467 of the region index, queue number, queue start index, user priority, traffic
 468 classes and so on. Depending on commands from the command line, it will call
 469 i40e private APIs and start the process of setting or flushing the queue
 470 region configuration. As this feature is specific for i40e only private
 471 APIs are used. These new ``test_pmd`` commands are as shown below. For
 472 details please refer to :doc:`../testpmd_app_ug/index`.
 473
 474 .. code-block:: console
 475
 476    testpmd> set port (port_id) queue-region region_id (value) \
 477                 queue_start_index (value) queue_num (value)
 478    testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
 479    testpmd> set port (port_id) queue-region UP (value) region_id (value)
 480    testpmd> set port (port_id) queue-region flush (on|off)
 481    testpmd> show port (port_id) queue-region
 482
 483 Limitations or Known issues
 484 ---------------------------
 485
 486 MPLS packet classification
 487 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 488
 489 For firmware versions prior to 5.0, MPLS packets are not recognized by the NIC.
 490 The L2 Payload flow type in flow director can be used to classify MPLS packet
 491 by using a command in testpmd like:
 492
 493    testpmd> flow_director_filter 0 mode IP add flow l2_payload ether \
 494             0x8847 flexbytes () fwd pf queue <N> fd_id <M>
 495
 496 With the NIC firmware version 5.0 or greater, some limited MPLS support
 497 is added: Native MPLS (MPLS in Ethernet) skip is implemented, while no
 498 new packet type, no classification or offload are possible. With this change,
 499 L2 Payload flow type in flow director cannot be used to classify MPLS packet
 500 as with previous firmware versions. Meanwhile, the Ethertype filter can be
 501 used to classify MPLS packet by using a command in testpmd like:
 502
 503    testpmd> ethertype_filter 0 add mac_ignr 00:00:00:00:00:00 ethertype \
 504             0x8847 fwd queue <M>
 505
 506 16 Byte RX Descriptor setting on DPDK VF
 507 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 508
 509 Currently the VF's RX descriptor mode is decided by PF. There's no PF-VF
 510 interface for VF to request the RX descriptor mode, also no interface to notify
 511 VF its own RX descriptor mode.
 512 For all available versions of the i40e driver, these drivers don't support 16
 513 byte RX descriptor. If the Linux i40e kernel driver is used as host driver,
 514 while DPDK i40e PMD is used as the VF driver, DPDK cannot choose 16 byte receive
 515 descriptor. The reason is that the RX descriptor is already set to 32 byte by
 516 the i40e kernel driver. That is to say, user should keep
 517 ``CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC=n`` in config file.
 518 In the future, if the Linux i40e driver supports 16 byte RX descriptor, user
 519 should make sure the DPDK VF uses the same RX descriptor mode, 16 byte or 32
 520 byte, as the PF driver.
 521
 522 The same rule for DPDK PF + DPDK VF. The PF and VF should use the same RX
 523 descriptor mode. Or the VF RX will not work.
 524
 525 Receive packets with Ethertype 0x88A8
 526 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 527
 528 Due to the FW limitation, PF can receive packets with Ethertype 0x88A8
 529 only when floating VEB is disabled.
 530
 531 Incorrect Rx statistics when packet is oversize
 532 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 533
 534 When a packet is over maximum frame size, the packet is dropped.
 535 However, the Rx statistics, when calling `rte_eth_stats_get` incorrectly
 536 shows it as received.
 537
 538 VF & TC max bandwidth setting
 539 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 540
 541 The per VF max bandwidth and per TC max bandwidth cannot be enabled in parallel.
 542 The behavior is different when handling per VF and per TC max bandwidth setting.
 543 When enabling per VF max bandwidth, SW will check if per TC max bandwidth is
 544 enabled. If so, return failure.
 545 When enabling per TC max bandwidth, SW will check if per VF max bandwidth
 546 is enabled. If so, disable per VF max bandwidth and continue with per TC max
 547 bandwidth setting.
 548
 549 TC TX scheduling mode setting
 550 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 551
 552 There're 2 TX scheduling modes for TCs, round robin and strict priority mode.
 553 If a TC is set to strict priority mode, it can consume unlimited bandwidth.
 554 It means if APP has set the max bandwidth for that TC, it comes to no
 555 effect.
 556 It's suggested to set the strict priority mode for a TC that is latency
 557 sensitive but no consuming much bandwidth.
 558
 559 VF performance is impacted by PCI extended tag setting
 560 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 561
 562 To reach maximum NIC performance in the VF the PCI extended tag must be
 563 enabled. The DPDK i40e PF driver will set this feature during initialization,
 564 but the kernel PF driver does not. So when running traffic on a VF which is
 565 managed by the kernel PF driver, a significant NIC performance downgrade has
 566 been observed (for 64 byte packets, there is about 25% line-rate downgrade for
 567 a 25GbE device and about 35% for a 40GbE device).
 568
 569 For kernel version >= 4.11, the kernel's PCI driver will enable the extended
 570 tag if it detects that the device supports it. So by default, this is not an
 571 issue. For kernels <= 4.11 or when the PCI extended tag is disabled it can be
 572 enabled using the steps below.
 573
 574 #. Get the current value of the PCI configure register::
 575
 576       setpci -s <XX:XX.X> a8.w
 577
 578 #. Set bit 8::
 579
 580       value = value | 0x100
 581
 582 #. Set the PCI configure register with new value::
 583
 584       setpci -s <XX:XX.X> a8.w=<value>
 585
 586 Vlan strip of VF
 587 ~~~~~~~~~~~~~~~~
 588
 589 The VF vlan strip function is only supported in the i40e kernel driver >= 2.1.26.
 590
 591 DCB function
 592 ~~~~~~~~~~~~
 593
 594 DCB works only when RSS is enabled.
 595
 596 Global configuration warning
 597 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 598
 599 I40E PMD will set some global registers to enable some function or set some
 600 configure. Then when using different ports of the same NIC with Linux kernel
 601 and DPDK, the port with Linux kernel will be impacted by the port with DPDK.
 602 For example, register I40E_GL_SWT_L2TAGCTRL is used to control L2 tag, i40e
 603 PMD uses I40E_GL_SWT_L2TAGCTRL to set vlan TPID. If setting TPID in port A
 604 with DPDK, then the configuration will also impact port B in the NIC with
 605 kernel driver, which don't want to use the TPID.
 606 So PMD reports warning to clarify what is changed by writing global register.
 607
 608 High Performance of Small Packets on 40GbE NIC
 609 ----------------------------------------------
 610
 611 As there might be firmware fixes for performance enhancement in latest version
 612 of firmware image, the firmware update might be needed for getting high performance.
 613 Check the Intel support website for the latest firmware updates.
 614 Users should consult the release notes specific to a DPDK release to identify
 615 the validated firmware version for a NIC using the i40e driver.
 616
 617 Use 16 Bytes RX Descriptor Size
 618 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 619
 620 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.
 621 Configuration of ``CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC`` in config files can be changed to use 16 bytes size RX descriptors.
 622
 623 Example of getting best performance with l3fwd example
 624 ------------------------------------------------------
 625
 626 The following is an example of running the DPDK ``l3fwd`` sample application to get high performance with a
 627 server with Intel Xeon processors and Intel Ethernet CNA XL710.
 628
 629 The example scenario is to get best performance with two Intel Ethernet CNA XL710 40GbE ports.
 630 See :numref:`figure_intel_perf_test_setup` for the performance test setup.
 631
 632 .. _figure_intel_perf_test_setup:
 633
 634 .. figure:: img/intel_perf_test_setup.*
 635
 636    Performance Test Setup
 637
 638
 639 1. Add two Intel Ethernet CNA XL710 to the platform, and use one port per card to get best performance.
 640    The reason for using two NICs is to overcome a PCIe v3.0 limitation since it cannot provide 80GbE bandwidth
 641    for two 40GbE ports, but two different PCIe v3.0 x8 slot can.
 642    Refer to the sample NICs output above, then we can select ``82:00.0`` and ``85:00.0`` as test ports::
 643
 644       82:00.0 Ethernet [0200]: Intel XL710 for 40GbE QSFP+ [8086:1583]
 645       85:00.0 Ethernet [0200]: Intel XL710 for 40GbE QSFP+ [8086:1583]
 646
 647 2. Connect the ports to the traffic generator. For high speed testing, it's best to use a hardware traffic generator.
 648
 649 3. Check the PCI devices numa node (socket id) and get the cores number on the exact socket id.
 650    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
 651    are 18-35 and 54-71.
 652    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
 653    cores from different cores (e.g core18 and core19).
 654
 655 4. Bind these two ports to igb_uio.
 656
 657 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
 658    will be required, and each queue pair will need a dedicated CPU core for receiving/transmitting packets.
 659
 660 6. The DPDK sample application ``l3fwd`` will be used for performance testing, with using two ports for bi-directional forwarding.
 661    Compile the ``l3fwd sample`` with the default lpm mode.
 662
 663 7. The command line of running l3fwd would be something like the following::
 664
 665       ./l3fwd -l 18-21 -n 4 -w 82:00.0 -w 85:00.0 \
 666               -- -p 0x3 --config '(0,0,18),(0,1,19),(1,0,20),(1,1,21)'
 667
 668    This means that the application uses core 18 for port 0, queue pair 0 forwarding, core 19 for port 0, queue pair 1 forwarding,
 669    core 20 for port 1, queue pair 0 forwarding, and core 21 for port 1, queue pair 1 forwarding.
 670
 671 8. Configure the traffic at a traffic generator.
 672
 673    * Start creating a stream on packet generator.
 674
 675    * Set the Ethernet II type to 0x0800.