doc/guides/rel_notes/release_17_11.rst

   1 DPDK Release 17.11
   2 ==================
   3
   4 .. **Read this first.**
   5
   6    The text in the sections below explains how to update the release notes.
   7
   8    Use proper spelling, capitalization and punctuation in all sections.
   9
  10    Variable and config names should be quoted as fixed width text:
  11    ``LIKE_THIS``.
  12
  13    Build the docs and view the output file to ensure the changes are correct::
  14
  15       make doc-guides-html
  16
  17       xdg-open build/doc/html/guides/rel_notes/release_17_11.html
  18
  19
  20 New Features
  21 ------------
  22
  23 .. This section should contain new features added in this release. Sample
  24    format:
  25
  26    * **Add a title in the past tense with a full stop.**
  27
  28      Add a short 1-2 sentence description in the past tense. The description
  29      should be enough to allow someone scanning the release notes to
  30      understand the new feature.
  31
  32      If the feature adds a lot of sub-features you can use a bullet list like
  33      this:
  34
  35      * Added feature foo to do something.
  36      * Enhanced feature bar to do something else.
  37
  38      Refer to the previous release notes for examples.
  39
  40      This section is a comment. do not overwrite or remove it.
  41      Also, make sure to start the actual text at the margin.
  42      =========================================================
  43
  44 * **Extended port_id range from uint8_t to uint16_t.**
  45
  46   Increased the ``port_id`` range from 8 bits to 16 bits in order to support
  47   more than 256 ports in DPDK. All ethdev APIs which have ``port_id`` as
  48   parameter have been changed.
  49
  50 * **Modified the return type of rte_eth_stats_reset.**
  51
  52   Changed return type of ``rte_eth_stats_reset`` from ``void`` to ``int`` so
  53   that the caller can determine whether a device supports the operation or not
  54   and if the operation was carried out.
  55
  56 * **Added a new driver for Marvell Armada 7k/8k devices.**
  57
  58   Added the new ``mrvl`` net driver for Marvell Armada 7k/8k devices. See the
  59   :doc:`../nics/mrvl` NIC guide for more details on this new driver.
  60
  61 * **Updated mlx4 driver.**
  62
  63   Updated the mlx4 driver including the following changes:
  64
  65    * Isolated mode (rte_flow) can now be enabled anytime, not only during
  66      initial device configuration.
  67    * Flow rules now support up to 4096 priority levels usable at will by
  68      applications.
  69    * Enhanced error message to help debugging invalid/unsupported flow rules.
  70    * Flow rules matching all multicast and promiscuous traffic are now allowed.
  71    * No more software restrictions on flow rules with the RSS action, their
  72      configuration is much more flexible.
  73    * Significantly reduced memory footprint for Rx and Tx queue objects.
  74    * While supported, UDP RSS is temporarily disabled due to a remaining issue
  75      with its support in the Linux kernel.
  76    * The new RSS implementation does not automatically spread traffic according
  77      to the inner packet of VXLAN frames anymore, only the outer one (like
  78      other PMDs).
  79    * Partial (Tx only) support for secondary processes was broken and had to be
  80      removed.
  81    * Refactored driver to get rid of dependency on the components provided by
  82      Mellanox OFED and instead rely on the current and public rdma-core
  83      package and Linux version from now on.
  84    * Removed compile-time limitation on number of device instances the PMD
  85      can support.
  86
  87 * **Updated mlx5 driver.**
  88
  89   Updated the mlx5 driver including the following changes:
  90
  91    * Enabled the PMD to run on top of upstream Linux kernel and rdma-core
  92      libs, removing the dependency on specific Mellanox OFED libraries.
  93    * Improved PMD latency performance.
  94    * Improved PMD memory footprint.
  95    * Added support for vectorized Rx/Tx burst for ARMv8.
  96    * Added support for secondary process.
  97    * Added support for flow counters.
  98    * Added support for Rx hardware timestamp offload.
  99    * Added support for device removal event.
 100
 101 * **Added SoftNIC PMD.**
 102
 103   Added a new SoftNIC PMD. This virtual device provides applications with
 104   software fallback support for traffic management.
 105
 106 * **Added support for NXP DPAA Devices.**
 107
 108   Added support for NXP's DPAA devices - LS104x series. This includes:
 109
 110   * DPAA Bus driver
 111   * DPAA Mempool driver for supporting offloaded packet memory pool
 112   * DPAA PMD for DPAA devices
 113
 114   See the :doc:`../nics/dpaa` document for more details of this new driver.
 115
 116 * **Updated support for Cavium OCTEONTX Device.**
 117
 118   Updated support for Cavium's OCTEONTX device (CN83xx). This includes:
 119
 120   * OCTEONTX Mempool driver for supporting offloaded packet memory pool
 121   * OCTEONTX Ethdev PMD
 122   * OCTEONTX Eventdev-Ethdev Rx adapter
 123
 124   See the :doc:`../nics/octeontx` document for more details of this new driver.
 125
 126 * **Added PF support to the Netronome NFP PMD.**
 127
 128   Added PF support to the Netronome NFP PMD. Previously the NFP PMD only
 129   supported VFs. PF support is just as a basic DPDK port and has no VF
 130   management yet.
 131
 132   PF support comes with firmware upload support which allows the PMD to
 133   independently work from kernel netdev NFP drivers.
 134
 135   NFP 4000 devices are also now supported along with previous 6000 devices.
 136
 137 * **Updated bnxt PMD.**
 138
 139   Major enhancements include:
 140
 141    * Support for Flow API
 142    * Support for Tx and Rx descriptor status functions
 143
 144 * **Added bus agnostic functions to cryptodev for PMD initialization**
 145
 146   Added new PMD assist, bus independent, functions
 147   ``rte_cryptodev_pmd_parse_input_args()``, ``rte_cryptodev_pmd_create()`` and
 148   ``rte_cryptodev_pmd_destroy()`` for drivers to manage creation and
 149   destruction of new device instances.
 150
 151 * **Updated QAT crypto PMD.**
 152
 153   Added several performance enhancements:
 154
 155   * Removed atomics from the internal queue pair structure.
 156   * Added coalesce writes to HEAD CSR on response processing.
 157   * Added coalesce writes to TAIL CSR on request processing.
 158
 159   In addition support was added for the AES CCM algorithm.
 160
 161 * **Updated the AESNI MB PMD.**
 162
 163   The AESNI MB PMD has been updated with additional support for:
 164
 165   * The DES CBC algorithm.
 166   * The DES DOCSIS BPI algorithm.
 167
 168   This change requires version 0.47 of the IPSec Multi-buffer library. For
 169   more details see the :doc:`../cryptodevs/aesni_mb` documentation.
 170
 171 * **Updated the OpenSSL PMD.**
 172
 173   The OpenSSL PMD has been updated with additional support for:
 174
 175   * The DES CBC algorithm.
 176   * The AES CCM algorithm.
 177
 178 * **Added NXP DPAA SEC crypto PMD.**
 179
 180   A new ``dpaa_sec`` hardware based crypto PMD for NXP DPAA devices has been
 181   added. See the :doc:`../cryptodevs/dpaa_sec` document for more details.
 182
 183 * **Added MRVL crypto PMD.**
 184
 185   A new crypto PMD has been added, which provides several ciphering and hashing
 186   algorithms. All cryptography operations use the MUSDK library crypto API.
 187   See the :doc:`../cryptodevs/mrvl` document for more details.
 188
 189 * **Add new benchmarking mode to dpdk-test-crypto-perf application.**
 190
 191   Added a new "PMD cyclecount" benchmark mode to the ``dpdk-test-crypto-perf``
 192   application to display a detailed breakdown of CPU cycles used by hardware
 193   acceleration.
 194
 195 * **Added the Security Offload Library.**
 196
 197   Added an experimental library - ``rte_security``. This provide security APIs
 198   for protocols like IPSec using inline ipsec offload to ethernet devices or
 199   full protocol offload with lookaside crypto devices.
 200
 201   See the :doc:`../prog_guide/rte_security` section of the DPDK Programmers
 202   Guide document for more information.
 203
 204 * **Updated the DPAA2_SEC crypto driver to support rte_security.**
 205
 206   Updated the ``dpaa2_sec`` crypto PMD to support ``rte_security`` lookaside
 207   protocol offload for IPSec.
 208
 209 * **Updated the IXGBE ethernet driver to support rte_security.**
 210
 211   Updated ixgbe ethernet PMD to support ``rte_security`` inline IPSec offload.
 212
 213 * **Updated i40e driver to support GTP-C/GTP-U.**
 214
 215   Updated i40e PMD to support GTP-C/GTP-U with GTP-C/GTP-U supporting
 216   profiles which can be programmed by dynamic device personalization (DDP)
 217   process.
 218
 219 * **Added the i40e ethernet driver to support queue region feature.**
 220
 221   This feature enable queue regions configuration for RSS in PF,
 222   so that different traffic classes or different packet
 223   classification types can be separated into different queues in
 224   different queue regions.
 225
 226 * **Updated ipsec-secgw application to support rte_security.**
 227
 228   Updated the ``ipsec-secgw`` sample application to support ``rte_security``
 229   actions for ipsec inline and full protocol offload using lookaside crypto
 230   offload.
 231
 232 * **Added IOMMU support to libvhost-user**
 233
 234   Implemented device IOTLB in the Vhost-user backend, and enabled Virtio's
 235   IOMMU feature. The feature is disabled by default, and can be enabled by
 236   setting ``RTE_VHOST_USER_IOMMU_SUPPORT`` flag at vhost device registration
 237   time.
 238
 239 * **Added the Event Ethernet Adapter Library.**
 240
 241   Added the Event Ethernet Adapter library. This library provides APIs for
 242   eventdev applications to configure the ethdev for eventdev packet flow.
 243
 244 * **Updated DPAA2 Event PMD for the Event Ethernet Adapter.**
 245
 246   Added support for the eventdev ethernet adapter for DPAA2.
 247
 248 * **Added Membership library (rte_member).**
 249
 250   Added a new data structure library called the Membership Library.
 251
 252   The Membership Library is an extension and generalization of a traditional
 253   filter (for example Bloom Filter) structure that has multiple usages in a
 254   wide variety of workloads and applications. In general, the Membership
 255   Library is a data structure that provides a "set-summary" and responds to
 256   set-membership queries whether a certain member belongs to a set(s).
 257
 258   The library provides APIs for DPDK applications to insert a new member,
 259   delete an existing member, and query the existence of a member in a given
 260   set, or a group of sets. For the case of a group of sets the library will
 261   return not only whether the element has been inserted in one of the sets but
 262   also which set it belongs to.
 263
 264   See the :doc:`../prog_guide/member_lib` documentation in the Programmers
 265   Guide, for more information.
 266
 267 * **Added the Generic Segmentation Offload Library.**
 268
 269   Added the Generic Segmentation Offload (GSO) library to enable
 270   applications to split large packets (e.g. MTU is 64KB) into small
 271   ones (e.g. MTU is 1500B). Supported packet types are:
 272
 273   * TCP/IPv4 packets.
 274   * VxLAN packets, which must have an outer IPv4 header, and contain
 275     an inner TCP/IPv4 packet.
 276   * GRE packets, which must contain an outer IPv4 header, and inner
 277     TCP/IPv4 headers.
 278
 279   The GSO library doesn't check if the input packets have correct
 280   checksums, and doesn't update checksums for output packets.
 281   Additionally, the GSO library doesn't process IP fragmented packets.
 282
 283 * **Added the Flow Classification Library.**
 284
 285   Added an experimental Flow Classification library to provide APIs for DPDK
 286   applications to classify an input packet by matching it against a set of
 287   flow rules. It uses the ``librte_table`` API to manage the flow rules.
 288
 289
 290 Resolved Issues
 291 ---------------
 292
 293 .. This section should contain bug fixes added to the relevant
 294    sections. Sample format:
 295
 296    * **code/section Fixed issue in the past tense with a full stop.**
 297
 298      Add a short 1-2 sentence description of the resolved issue in the past
 299      tense.
 300
 301      The title should contain the code/lib section like a commit message.
 302
 303      Add the entries in alphabetic order in the relevant sections below.
 304
 305    This section is a comment. do not overwrite or remove it.
 306    Also, make sure to start the actual text at the margin.
 307    =========================================================
 308
 309
 310 * **Service core fails to call service callback due to atomic lock**
 311
 312   In a specific configuration of multi-thread unsafe services and service
 313   cores, a service core previously did not correctly release the atomic lock
 314   on the service. This would result in the cores polling the service, but it
 315   looked like another thread was executing the service callback. The logic for
 316   atomic locking of the services has been fixed and refactored for readability.
 317
 318
 319 API Changes
 320 -----------
 321
 322 .. This section should contain API changes. Sample format:
 323
 324    * Add a short 1-2 sentence description of the API change. Use fixed width
 325      quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
 326      tense.
 327
 328    This section is a comment. do not overwrite or remove it.
 329    Also, make sure to start the actual text at the margin.
 330    =========================================================
 331
 332 * **Ethdev device name length increased.**
 333
 334   The size of internal device name has been increased to 64 characters
 335   to allow for storing longer bus specific names.
 336
 337 * **Removed the Ethdev RTE_ETH_DEV_DETACHABLE flag.**
 338
 339   Removed the Ethdev ``RTE_ETH_DEV_DETACHABLE`` flag. This flag is not
 340   required anymore, with the new hotplug implementation. It has been removed
 341   from the ether library. Its semantics are now expressed at the bus and PMD
 342   level.
 343
 344 * **Service cores API updated for usability**
 345
 346   The service cores API has been changed, removing pointers from the API where
 347   possible, and instead using integer IDs to identify each service. This
 348   simplifies application code, aids debugging, and provides better
 349   encapsulation. A summary of the main changes made is as follows:
 350
 351   * Services identified by ID not by ``rte_service_spec`` pointer
 352   * Reduced API surface by using ``set`` functions instead of enable/disable
 353   * Reworked ``rte_service_register`` to provide the service ID to registrar
 354   * Reworked start and stop APIs into ``rte_service_runstate_set``
 355   * Added API to set runstate of service implementation to indicate readiness
 356
 357 * **The following changes have been made in the mempool library**
 358
 359   * Moved ``flags`` datatype from ``int`` to ``unsigned int`` for
 360     ``rte_mempool``.
 361   * Removed ``__rte_unused int flag`` param from ``rte_mempool_generic_put``
 362     and ``rte_mempool_generic_get`` API.
 363   * Added ``flags`` param in ``rte_mempool_xmem_size`` and
 364     ``rte_mempool_xmem_usage``.
 365   * ``rte_mem_phy2mch`` was used in Xen dom0 to obtain the physical address;
 366     remove this API as Xen dom0 support was removed.
 367
 368 * **Added IOVA aliases related to physical address handling.**
 369
 370   Some data types, structure members and functions related to physical address
 371   handling are deprecated and have new aliases with IOVA wording. For example:
 372
 373   * ``phys_addr_t`` can be often replaced by ``rte_iova_t`` of same size.
 374   * ``RTE_BAD_PHYS_ADDR`` is often replaced by ``RTE_BAD_IOVA`` of same value.
 375   * ``rte_memseg.phys_addr`` is aliased with ``rte_memseg.iova_addr``.
 376   * ``rte_mem_virt2phy()`` can often be replaced by ``rte_mem_virt2iova``.
 377   * ``rte_malloc_virt2phy`` is aliased with ``rte_malloc_virt2iova``.
 378   * ``rte_memzone.phys_addr`` is aliased with ``rte_memzone.iova``.
 379   * ``rte_mempool_objhdr.physaddr`` is aliased with
 380     ``rte_mempool_objhdr.iova``.
 381   * ``rte_mempool_memhdr.phys_addr`` is aliased with
 382     ``rte_mempool_memhdr.iova``.
 383   * ``rte_mempool_virt2phy()`` can be replaced by ``rte_mempool_virt2iova()``.
 384   * ``rte_mempool_populate_phys*()`` are aliased with
 385     ``rte_mempool_populate_iova*()``
 386   * ``rte_mbuf.buf_physaddr`` is aliased with ``rte_mbuf.buf_iova``.
 387   * ``rte_mbuf_data_dma_addr*()`` are aliased with ``rte_mbuf_data_iova*()``.
 388   * ``rte_pktmbuf_mtophys*`` are aliased with ``rte_pktmbuf_iova*()``.
 389
 390 * **PCI bus API moved outside of the EAL**
 391
 392   The PCI bus previously implemented within the EAL has been moved.
 393   A first part has been added as an RTE library providing PCI helpers to
 394   parse device locations or other such utilities.
 395   A second part consisting of the actual bus driver has been moved to its
 396   proper subdirectory, without changing its functionalities.
 397
 398   As such, several PCI-related functions are not exposed by the EAL anymore:
 399
 400   * ``rte_pci_detach``
 401   * ``rte_pci_dump``
 402   * ``rte_pci_ioport_map``
 403   * ``rte_pci_ioport_read``
 404   * ``rte_pci_ioport_unmap``
 405   * ``rte_pci_ioport_write``
 406   * ``rte_pci_map_device``
 407   * ``rte_pci_probe``
 408   * ``rte_pci_probe_one``
 409   * ``rte_pci_read_config``
 410   * ``rte_pci_register``
 411   * ``rte_pci_scan``
 412   * ``rte_pci_unmap_device``
 413   * ``rte_pci_unregister``
 414   * ``rte_pci_write_config``
 415
 416   These functions are made available either as part of ``librte_pci`` or
 417   ``librte_bus_pci``.
 418
 419 * **Moved vdev bus APIs outside of the EAL**
 420
 421   Moved the following APIs from ``librte_eal`` to ``librte_bus_vdev``:
 422
 423   * ``rte_vdev_init``
 424   * ``rte_vdev_register``
 425   * ``rte_vdev_uninit``
 426   * ``rte_vdev_unregister``
 427
 428 * **Add return value to stats_get dev op API**
 429
 430   The ``stats_get`` dev op API return value has been changed to be int.
 431   In this way PMDs can return an error value in case of failure at stats
 432   getting process time.
 433
 434 * **Modified the rte_cryptodev_allocate_driver function.**
 435
 436   Modified the ``rte_cryptodev_allocate_driver()`` function in the cryptodev
 437   library. An extra parameter ``struct cryptodev_driver *crypto_drv`` has been
 438   added.
 439
 440 * **Removed virtual device bus specific functions from librte_cryptodev.**
 441
 442   The functions ``rte_cryptodev_vdev_parse_init_params()`` and
 443   ``rte_cryptodev_vdev_pmd_init()`` have been removed from librte_cryptodev
 444   and have been replaced by non bus specific functions
 445   ``rte_cryptodev_pmd_parse_input_args()`` and ``rte_cryptodev_pmd_create()``.
 446
 447   The ``rte_cryptodev_create_vdev()`` function was removed to avoid the
 448   dependency on vdev in librte_cryptodev; instead, users can call
 449   ``rte_vdev_init()`` directly.
 450
 451 * **Removed PCI device bus specific functions from librte_cryptodev.**
 452
 453   The functions ``rte_cryptodev_pci_generic_probe()`` and
 454   ``rte_cryptodev_pci_generic_remove()`` have been removed from librte_cryptodev
 455   and have been replaced by non bus specific functions
 456   ``rte_cryptodev_pmd_create()`` and ``rte_cryptodev_pmd_destroy()``.
 457
 458 * **Removed deprecated functions to manage log level or type.**
 459
 460   The functions ``rte_set_log_level()``, ``rte_get_log_level()``,
 461   ``rte_set_log_type()`` and ``rte_get_log_type()`` have been removed.
 462
 463   They are respectively replaced by ``rte_log_set_global_level()``,
 464   ``rte_log_get_global_level()``, ``rte_log_set_level()`` and
 465   ``rte_log_get_level()``.
 466
 467 * **Removed mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT.**
 468
 469   The ``mbuf`` flags ``PKT_RX_VLAN_PKT`` and ``PKT_RX_QINQ_PKT`` have
 470   been removed since their behavior was not properly described.
 471
 472 * **Added mbuf flags PKT_RX_VLAN and PKT_RX_QINQ.**
 473
 474   Two ``mbuf`` flags have been added to indicate that the VLAN
 475   identifier has been saved in in the ``mbuf`` structure. For instance:
 476
 477   - If VLAN is not stripped and TCI is saved: ``PKT_RX_VLAN``
 478   - If VLAN is stripped and TCI is saved: ``PKT_RX_VLAN | PKT_RX_VLAN_STRIPPED``
 479
 480 * **Modified the vlan_offload_set_t function prototype in the ethdev library.**
 481
 482   Modified the ``vlan_offload_set_t`` function prototype in the ethdev
 483   library.  The return value has been changed from ``void`` to ``int`` so the
 484   caller can determine whether the backing device supports the operation or if
 485   the operation was successfully performed.
 486
 487
 488 ABI Changes
 489 -----------
 490
 491 .. This section should contain ABI changes. Sample format:
 492
 493    * Add a short 1-2 sentence description of the ABI change that was announced
 494      in the previous releases and made in this release. Use fixed width quotes
 495      for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
 496
 497    This section is a comment. do not overwrite or remove it.
 498    Also, make sure to start the actual text at the margin.
 499    =========================================================
 500
 501 * **Extended port_id range.**
 502
 503   The size of the field ``port_id`` in the ``rte_eth_dev_data`` structure
 504   has changed, as described in the `New Features` section above.
 505
 506 * **New parameter added to rte_eth_dev.**
 507
 508   A new parameter ``security_ctx`` has been added to ``rte_eth_dev`` to
 509   support security operations like IPSec inline.
 510
 511 * **New parameter added to rte_cryptodev.**
 512
 513   A new parameter ``security_ctx`` has been added to ``rte_cryptodev`` to
 514   support security operations like lookaside crypto.
 515
 516
 517 Removed Items
 518 -------------
 519
 520 .. This section should contain removed items in this release. Sample format:
 521
 522    * Add a short 1-2 sentence description of the removed item in the past
 523      tense.
 524
 525    This section is a comment. do not overwrite or remove it.
 526    Also, make sure to start the actual text at the margin.
 527    =========================================================
 528
 529 * Xen dom0 in EAL has been removed, as well as the xenvirt PMD and vhost_xen.
 530
 531 * The crypto performance unit tests have been removed,
 532   replaced by the ``dpdk-test-crypto-perf`` application.
 533
 534
 535 Shared Library Versions
 536 -----------------------
 537
 538 .. Update any library version updated in this release and prepend with a ``+``
 539    sign, like this:
 540
 541      librte_acl.so.2
 542    + librte_cfgfile.so.2
 543      librte_cmdline.so.2
 544
 545    This section is a comment. do not overwrite or remove it.
 546    =========================================================
 547
 548
 549 The libraries prepended with a plus sign were incremented in this version.
 550
 551 .. code-block:: diff
 552
 553      librte_acl.so.2
 554    + librte_bitratestats.so.2
 555    + librte_bus_dpaa.so.1
 556    + librte_bus_fslmc.so.1
 557    + librte_bus_pci.so.1
 558    + librte_bus_vdev.so.1
 559      librte_cfgfile.so.2
 560      librte_cmdline.so.2
 561    + librte_cryptodev.so.4
 562      librte_distributor.so.1
 563    + librte_eal.so.6
 564    + librte_ethdev.so.8
 565    + librte_eventdev.so.3
 566    + librte_flow_classify.so.1
 567      librte_gro.so.1
 568    + librte_gso.so.1
 569      librte_hash.so.2
 570      librte_ip_frag.so.1
 571      librte_jobstats.so.1
 572      librte_kni.so.2
 573      librte_kvargs.so.1
 574      librte_latencystats.so.1
 575      librte_lpm.so.2
 576      librte_mbuf.so.3
 577    + librte_mempool.so.3
 578      librte_meter.so.1
 579      librte_metrics.so.1
 580      librte_net.so.1
 581    + librte_pci.so.1
 582    + librte_pdump.so.2
 583      librte_pipeline.so.3
 584    + librte_pmd_bnxt.so.2
 585    + librte_pmd_bond.so.2
 586    + librte_pmd_i40e.so.2
 587    + librte_pmd_ixgbe.so.2
 588      librte_pmd_ring.so.2
 589    + librte_pmd_softnic.so.1
 590    + librte_pmd_vhost.so.2
 591      librte_port.so.3
 592      librte_power.so.1
 593      librte_reorder.so.1
 594      librte_ring.so.1
 595      librte_sched.so.1
 596    + librte_security.so.1
 597    + librte_table.so.3
 598      librte_timer.so.1
 599      librte_vhost.so.3
 600
 601
 602 Tested Platforms
 603 ----------------
 604
 605 .. This section should contain a list of platforms that were tested with this
 606    release.
 607
 608    The format is:
 609
 610    * <vendor> platform with <vendor> <type of devices> combinations
 611
 612      * List of CPU
 613      * List of OS
 614      * List of devices
 615      * Other relevant details...
 616
 617    This section is a comment. do not overwrite or remove it.
 618    Also, make sure to start the actual text at the margin.
 619    =========================================================
 620
 621 * Intel(R) platforms with Intel(R) NICs combinations
 622
 623    * CPU
 624
 625      * Intel(R) Atom(TM) CPU C2758 @ 2.40GHz
 626      * Intel(R) Xeon(R) CPU D-1540 @ 2.00GHz
 627      * Intel(R) Xeon(R) CPU D-1541 @ 2.10GHz
 628      * Intel(R) Xeon(R) CPU E5-4667 v3 @ 2.00GHz
 629      * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
 630      * Intel(R) Xeon(R) CPU E5-2699 v3 @ 2.30GHz
 631      * Intel(R) Xeon(R) CPU E5-2695 v4 @ 2.10GHz
 632      * Intel(R) Xeon(R) CPU E5-2658 v2 @ 2.40GHz
 633      * Intel(R) Xeon(R) CPU E5-2658 v3 @ 2.20GHz
 634
 635    * OS:
 636
 637      * CentOS 7.2
 638      * Fedora 25
 639      * Fedora 26
 640      * FreeBSD 11
 641      * Red Hat Enterprise Linux Server release 7.3
 642      * SUSE Enterprise Linux 12
 643      * Wind River Linux 8
 644      * Ubuntu 16.04
 645      * Ubuntu 16.10
 646
 647    * NICs:
 648
 649      * Intel(R) 82599ES 10 Gigabit Ethernet Controller
 650
 651        * Firmware version: 0x61bf0001
 652        * Device id (pf/vf): 8086:10fb / 8086:10ed
 653        * Driver version: 5.2.3 (ixgbe)
 654
 655      * Intel(R) Corporation Ethernet Connection X552/X557-AT 10GBASE-T
 656
 657        * Firmware version: 0x800003e7
 658        * Device id (pf/vf): 8086:15ad / 8086:15a8
 659        * Driver version: 4.4.6 (ixgbe)
 660
 661      * Intel(R) Ethernet Converged Network Adapter X710-DA4 (4x10G)
 662
 663        * Firmware version: 6.01 0x80003205
 664        * Device id (pf/vf): 8086:1572 / 8086:154c
 665        * Driver version: 2.1.26 (i40e)
 666
 667      * Intel(R) Ethernet Converged Network Adapter X710-DA2 (2x10G)
 668
 669        * Firmware version: 6.01 0x80003204
 670        * Device id (pf/vf): 8086:1572 / 8086:154c
 671        * Driver version: 2.1.26 (i40e)
 672
 673      * Intel(R) Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
 674
 675        * Firmware version: 6.01 0x80003221
 676        * Device id (pf/vf): 8086:158b
 677        * Driver version: 2.1.26 (i40e)
 678
 679      * Intel(R) Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
 680
 681        * Firmware version: 6.01 0x8000321c
 682        * Device id (pf/vf): 8086:1583 / 8086:154c
 683        * Driver version: 2.1.26 (i40e)
 684
 685      * Intel(R) Corporation I350 Gigabit Network Connection
 686
 687        * Firmware version: 1.63, 0x80000dda
 688        * Device id (pf/vf): 8086:1521 / 8086:1520
 689        * Driver version: 5.3.0-k (igb)
 690
 691 * Intel(R) platforms with Mellanox(R) NICs combinations
 692
 693    * Platform details:
 694
 695      * Intel(R) Xeon(R) CPU E5-2697A v4 @ 2.60GHz
 696      * Intel(R) Xeon(R) CPU E5-2697 v3 @ 2.60GHz
 697      * Intel(R) Xeon(R) CPU E5-2680 v2 @ 2.80GHz
 698      * Intel(R) Xeon(R) CPU E5-2650 v4 @ 2.20GHz
 699      * Intel(R) Xeon(R) CPU E5-2640 @ 2.50GHz
 700      * Intel(R) Xeon(R) CPU E5-2620 v4 @ 2.10GHz
 701
 702    * OS:
 703
 704      * Red Hat Enterprise Linux Server release 7.3 (Maipo)
 705      * Red Hat Enterprise Linux Server release 7.2 (Maipo)
 706      * Ubuntu 16.10
 707      * Ubuntu 16.04
 708      * Ubuntu 14.04
 709
 710    * MLNX_OFED: 4.2-1.0.0.0
 711
 712    * NICs:
 713
 714      * Mellanox(R) ConnectX(R)-3 Pro 40G MCX354A-FCC_Ax (2x40G)
 715
 716        * Host interface: PCI Express 3.0 x8
 717        * Device ID: 15b3:1007
 718        * Firmware version: 2.42.5000
 719
 720      * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
 721
 722        * Host interface: PCI Express 3.0 x8
 723        * Device ID: 15b3:1013
 724        * Firmware version: 12.21.1000
 725
 726      * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
 727
 728        * Host interface: PCI Express 3.0 x8
 729        * Device ID: 15b3:1013
 730        * Firmware version: 12.21.1000
 731
 732      * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
 733
 734        * Host interface: PCI Express 3.0 x8
 735        * Device ID: 15b3:1013
 736        * Firmware version: 12.21.1000
 737
 738      * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
 739
 740        * Host interface: PCI Express 3.0 x8
 741        * Device ID: 15b3:1013
 742        * Firmware version: 12.21.1000
 743
 744      * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT/MCX413A-BCAT (1x40G)
 745
 746        * Host interface: PCI Express 3.0 x8
 747        * Device ID: 15b3:1013
 748        * Firmware version: 12.21.1000
 749
 750      * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
 751
 752        * Host interface: PCI Express 3.0 x16
 753        * Device ID: 15b3:1013
 754        * Firmware version: 12.21.1000
 755
 756      * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT/MCX413A-GCAT (1x50G)
 757
 758        * Host interface: PCI Express 3.0 x8
 759        * Device ID: 15b3:1013
 760        * Firmware version: 12.21.1000
 761
 762      * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
 763
 764        * Host interface: PCI Express 3.0 x8
 765        * Device ID: 15b3:1013
 766        * Firmware version: 12.21.1000
 767
 768      * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT/MCX416A-BCAT/MCX416A-GCAT
 769        (2x50G)
 770
 771        * Host interface: PCI Express 3.0 x16
 772        * Device ID: 15b3:1013
 773        * Firmware version: 12.21.1000
 774
 775      * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
 776
 777        * Host interface: PCI Express 3.0 x16
 778        * Device ID: 15b3:1013
 779        * Firmware version: 12.21.1000
 780
 781      * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
 782
 783        * Host interface: PCI Express 3.0 x16
 784        * Device ID: 15b3:1013
 785        * Firmware version: 12.21.1000
 786
 787      * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
 788
 789        * Host interface: PCI Express 3.0 x8
 790        * Device ID: 15b3:1015
 791        * Firmware version: 14.21.1000
 792
 793      * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
 794
 795        * Host interface: PCI Express 3.0 x8
 796        * Device ID: 15b3:1015
 797        * Firmware version: 14.21.1000
 798
 799      * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
 800
 801        * Host interface: PCI Express 3.0 x16
 802        * Device ID: 15b3:1017
 803        * Firmware version: 16.21.1000
 804
 805      * Mellanox(R) ConnectX-5 Ex EN 100G MCX516A-CDAT (2x100G)
 806
 807        * Host interface: PCI Express 4.0 x16
 808        * Device ID: 15b3:1019
 809        * Firmware version: 16.21.1000
 810
 811 * ARM platforms with Mellanox(R) NICs combinations
 812
 813    * Platform details:
 814
 815      * Qualcomm ARM 1.1 2500MHz
 816
 817    * OS:
 818
 819      * Ubuntu 16.04
 820
 821    * MLNX_OFED: 4.2-1.0.0.0
 822
 823    * NICs:
 824
 825      * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
 826
 827        * Host interface: PCI Express 3.0 x8
 828        * Device ID: 15b3:1015
 829        * Firmware version: 14.21.1000
 830
 831      * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
 832
 833        * Host interface: PCI Express 3.0 x16
 834        * Device ID: 15b3:1017
 835        * Firmware version: 16.21.1000