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