doc/guides/rel_notes/release_20_02.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2019 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 20.02
   7 ==================
   8
   9 .. **Read this first.**
  10
  11    The text in the sections below explains how to update the release notes.
  12
  13    Use proper spelling, capitalization and punctuation in all sections.
  14
  15    Variable and config names should be quoted as fixed width text:
  16    ``LIKE_THIS``.
  17
  18    Build the docs and view the output file to ensure the changes are correct::
  19
  20       make doc-guides-html
  21
  22       xdg-open build/doc/html/guides/rel_notes/release_20_02.html
  23
  24
  25 New Features
  26 ------------
  27
  28 .. This section should contain new features added in this release.
  29    Sample format:
  30
  31    * **Add a title in the past tense with a full stop.**
  32
  33      Add a short 1-2 sentence description in the past tense.
  34      The description should be enough to allow someone scanning
  35      the release notes to understand the new feature.
  36
  37      If the feature adds a lot of sub-features you can use a bullet list
  38      like this:
  39
  40      * Added feature foo to do something.
  41      * Enhanced feature bar to do something else.
  42
  43      Refer to the previous release notes for examples.
  44
  45      Suggested order in release notes items:
  46      * Core libs (EAL, mempool, ring, mbuf, buses)
  47      * Device abstraction libs and PMDs
  48        - ethdev (lib, PMDs)
  49        - cryptodev (lib, PMDs)
  50        - eventdev (lib, PMDs)
  51        - etc
  52      * Other libs
  53      * Apps, Examples, Tools (if significant)
  54
  55      This section is a comment. Do not overwrite or remove it.
  56      Also, make sure to start the actual text at the margin.
  57      =========================================================
  58
  59 * **Added Wait Until Equal API.**
  60
  61   A new API has been added to wait for a memory location to be updated with a
  62   16-bit, 32-bit, 64-bit value.
  63
  64 * **Added rte_ring_xxx_elem APIs.**
  65
  66   New APIs have been added to support rings with custom element size.
  67
  68 * **Updated rte_flow api to support L2TPv3 over IP flows.**
  69
  70   Added support for new flow item to handle L2TPv3 over IP rte_flow patterns.
  71
  72 * **Added IONIC net PMD.**
  73
  74   Added the new ``ionic`` net driver for Pensando Ethernet Network Adapters.
  75   See the :doc:`../nics/ionic` NIC guide for more details on this new driver.
  76
  77 * **Updated Broadcom bnxt driver**
  78
  79   Updated Broadcom bnxt driver with new features and improvements, including:
  80
  81   * Added support for MARK action.
  82
  83 * **Updated Hisilicon hns3 driver.**
  84
  85   Updated Hisilicon hns3 driver with new features and improvements, including:
  86
  87   * Added support for Rx interrupt.
  88   * Added support setting VF MAC address by PF driver.
  89
  90 * **Updated the Intel ice driver.**
  91
  92   Updated the Intel ice driver with new features and improvements, including:
  93
  94   * Added support for MAC rules on specific port.
  95   * Added support for MAC/VLAN with TCP/UDP in switch rule.
  96   * Added support for 1/10G device.
  97   * Added support for API rte_eth_tx_done_cleanup.
  98
  99 * **Updated Intel iavf driver.**
 100
 101   Updated iavf PMD with new features and improvements, including:
 102
 103   * Added more supported device IDs.
 104   * Updated virtual channel to latest AVF spec.
 105
 106 * **Updated the Intel ixgbe driver.**
 107
 108   * Added support for API rte_eth_tx_done_cleanup.
 109   * Added support setting VF MAC address by PF driver.
 110   * Added support for setting the link to specific speed.
 111
 112 * **Updated Intel i40e driver.**
 113
 114   Updated i40e PMD with new features and improvements, including:
 115
 116   * Added support for L2TPv3 over IP profiles which can be programmed by the
 117     dynamic device personalization (DDP) process.
 118   * Added support for ESP-AH profiles which can be programmed by the
 119     dynamic device personalization (DDP) process.
 120   * Added PF support Malicious Device Drive event catch and notify.
 121   * Added LLDP support.
 122   * Extended PHY access AQ cmd.
 123   * Added support for reading LPI counters.
 124   * Added support for Energy Efficient Ethernet.
 125   * Added support for API rte_eth_tx_done_cleanup.
 126   * Added support for VF multiple queues interrupt.
 127   * Added support for setting the link to specific speed.
 128
 129 * **Updated Mellanox mlx5 driver.**
 130
 131   Updated Mellanox mlx5 driver with new features and improvements, including:
 132
 133   * Added support for RSS using L3/L4 source/destination only.
 134   * Added support for matching on GTP tunnel header item.
 135   * Removed limitation of matching on tagged/untagged packets (when using DV flow engine).
 136   * Added BlueField-2 integrated ConnectX-6 Dx device support.
 137
 138 * **Add new vDPA PMD based on Mellanox devices**
 139
 140   Added a new Mellanox vDPA  (``mlx5_vdpa``) PMD.
 141   See the :doc:`../vdpadevs/mlx5` guide for more details on this driver.
 142
 143 * **Added support for virtio-PMD notification data.**
 144
 145   Added support for virtio-PMD notification data so that the driver
 146   passes extra data (besides identifying the virtqueue) in its device
 147   notifications, expanding the notifications to include the avail index and
 148   avail wrap counter (When split ring is used, the avail wrap counter is not
 149   included in the notification data).
 150
 151 * **Updated testpmd application.**
 152
 153   Added support for ESP and L2TPv3 over IP rte_flow patterns to the testpmd
 154   application.
 155
 156 * **Added algorithms to cryptodev API.**
 157
 158   * ECDSA (Elliptic Curve Digital Signature Algorithm) is added to
 159     asymmetric crypto library specifications.
 160   * ECPM (Elliptic Curve Point Multiplication) is added to
 161     asymmetric crypto library specifications.
 162
 163 * **Added synchronous Crypto burst API.**
 164
 165   A new API is introduced in crypto library to handle synchronous cryptographic
 166   operations allowing to achieve performance gain for cryptodevs which use
 167   CPU based acceleration, such as Intel AES-NI. An implementation for aesni_gcm
 168   cryptodev is provided. The IPsec example application and ipsec library itself
 169   were changed to allow utilization of this new feature.
 170
 171 * **Added handling of mixed algorithms in encrypted digest requests in QAT PMD.**
 172
 173   Added handling of mixed algorithms in encrypted digest hash-cipher
 174   (generation) and cipher-hash (verification) requests (e.g. SNOW3G + ZUC or
 175   ZUC + AES CTR) in QAT PMD possible when running on GEN3 QAT hardware.
 176   Such algorithm combinations are not supported on GEN1/GEN2 hardware
 177   and executing the request returns RTE_CRYPTO_OP_STATUS_INVALID_SESSION.
 178
 179 * **Queue-pairs are now thread-safe on Intel QuickAssist Technology (QAT) PMD.**
 180
 181   Queue-pairs are thread-safe on Intel CPUs but Queues are not (that is, within
 182   a single queue-pair all enqueues to the TX queue must be done from one thread
 183   and all dequeues from the RX queue must be done from one thread, but enqueues
 184   and dequeues may be done in different threads.).
 185
 186 * **Updated the ZUC PMD.**
 187
 188   * Transistioned underlying library from libSSO ZUC to intel-ipsec-mb
 189     library (minimum version required 0.53).
 190   * Removed dynamic library limitation, so PMD can be built as a shared
 191     object now.
 192
 193 * **Updated the KASUMI PMD.**
 194
 195   * Transistioned underlying library from libSSO KASUMI to intel-ipsec-mb
 196     library (minimum version required 0.53).
 197
 198 * **Updated the SNOW3G PMD.**
 199
 200   * Transistioned underlying library from libSSO SNOW3G to intel-ipsec-mb
 201     library (minimum version required 0.53).
 202
 203 * **Changed armv8 crypto PMD external dependency.**
 204
 205   armv8 crypto PMD now depends on Arm crypto library, and Marvell's
 206   armv8 crypto library is not used anymore. Library name is changed
 207   from armv8_crypto to AArch64crypto.
 208
 209 * **Added inline IPsec support to Marvell OCTEON TX2 PMD.**
 210
 211   Added inline IPsec support to Marvell OCTEON TX2 PMD. With the feature,
 212   applications would be able to offload entire IPsec offload to the hardware.
 213   For the configured sessions, hardware will do the lookup and perform
 214   decryption and IPsec transformation. For the outbound path, application
 215   can submit a plain packet to the PMD, and it would be sent out on wire
 216   after doing encryption and IPsec transformation of the packet.
 217
 218 * **Added Marvell OCTEON TX2 End Point rawdev PMD.**
 219
 220   Added a new OCTEON TX2 rawdev PMD for End Point mode of operation.
 221   See the :doc:`../rawdevs/octeontx2_ep` for more details on this new PMD.
 222
 223 * **Added event mode to l3fwd sample application.**
 224
 225   Add event device support for ``l3fwd`` sample application. It demonstrates
 226   usage of poll and event mode IO mechanism under a single application.
 227
 228 * **Added cycle-count mode to the compression performance tool.**
 229
 230   Enhanced the compression performance tool by adding a cycle-count mode
 231   which can be used to help measure and tune hardware and software PMDs.
 232
 233
 234 Removed Items
 235 -------------
 236
 237 .. This section should contain removed items in this release. Sample format:
 238
 239    * Add a short 1-2 sentence description of the removed item
 240      in the past tense.
 241
 242    This section is a comment. Do not overwrite or remove it.
 243    Also, make sure to start the actual text at the margin.
 244    =========================================================
 245
 246 * **Disabled building all the Linux kernel modules by default.**
 247
 248   In order to remove the build time dependency with Linux kernel,
 249   the Technical Board decided to disable all the kernel modules
 250   by default from 20.02 version.
 251
 252 * **Removed coalescing feature from Intel QuickAssist Technology (QAT) PMD.**
 253
 254   The internal tail write coalescing feature was removed as not compatible with
 255   dual-thread feature. It was replaced with a threshold feature. At busy times
 256   if only a small number of packets can be enqueued, each enqueue causes
 257   an expensive MMIO write. These MMIO write occurrences can be optimised by using
 258   the new threshold parameter on process start. Please see qat documentation for
 259   more details.
 260
 261
 262 API Changes
 263 -----------
 264
 265 .. This section should contain API changes. Sample format:
 266
 267    * sample: Add a short 1-2 sentence description of the API change
 268      which was announced in the previous releases and made in this release.
 269      Start with a scope label like "ethdev:".
 270      Use fixed width quotes for ``function_names`` or ``struct_names``.
 271      Use the past tense.
 272
 273    This section is a comment. Do not overwrite or remove it.
 274    Also, make sure to start the actual text at the margin.
 275    =========================================================
 276
 277
 278 ABI Changes
 279 -----------
 280
 281 .. This section should contain ABI changes. Sample format:
 282
 283    * sample: Add a short 1-2 sentence description of the ABI change
 284      which was announced in the previous releases and made in this release.
 285      Start with a scope label like "ethdev:".
 286      Use fixed width quotes for ``function_names`` or ``struct_names``.
 287      Use the past tense.
 288
 289    This section is a comment. Do not overwrite or remove it.
 290    Also, make sure to start the actual text at the margin.
 291    =========================================================
 292
 293 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
 294
 295
 296 Known Issues
 297 ------------
 298
 299 .. This section should contain new known issues in this release. Sample format:
 300
 301    * **Add title in present tense with full stop.**
 302
 303      Add a short 1-2 sentence description of the known issue
 304      in the present tense. Add information on any known workarounds.
 305
 306    This section is a comment. Do not overwrite or remove it.
 307    Also, make sure to start the actual text at the margin.
 308    =========================================================
 309
 310
 311 Tested Platforms
 312 ----------------
 313
 314 .. This section should contain a list of platforms that were tested
 315    with this release.
 316
 317    The format is:
 318
 319    * <vendor> platform with <vendor> <type of devices> combinations
 320
 321      * List of CPU
 322      * List of OS
 323      * List of devices
 324      * Other relevant details...
 325
 326    This section is a comment. Do not overwrite or remove it.
 327    Also, make sure to start the actual text at the margin.
 328    =========================================================
 329
 330 * Intel\ |reg| platforms with Intel\ |reg| NICs combinations
 331
 332   * CPU
 333
 334     * Intel\ |reg| Atom\ |trade| CPU C3758 @ 2.20GHz
 335     * Intel\ |reg| Atom\ |trade| CPU C3858 @ 2.00GHz
 336     * Intel\ |reg| Atom\ |trade| CPU C3958 @ 2.00GHz
 337     * Intel\ |reg| Xeon\ |reg| CPU D-1541 @ 2.10GHz
 338     * Intel\ |reg| Xeon\ |reg| CPU D-1553N @ 2.30GHz
 339     * Intel\ |reg| Xeon\ |reg| CPU E5-2680 0 @ 2.70GHz
 340     * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
 341     * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v3 @ 2.30GHz
 342     * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v4 @ 2.20GHz
 343     * Intel\ |reg| Xeon\ |reg| Gold 6139 CPU @ 2.30GHz
 344     * Intel\ |reg| Xeon\ |reg| Gold 6252N CPU @ 2.30GHz
 345     * Intel\ |reg| Xeon\ |reg| Platinum 8180 CPU @ 2.50GHz
 346     * Intel\ |reg| Xeon\ |reg| Platinum 8280M CPU @ 2.70GHz
 347
 348   * OS:
 349
 350     * CentOS 7.7
 351     * CentOS 8.0
 352     * Fedora 31
 353     * FreeBSD 12.1
 354     * Red Hat Enterprise Linux Server release 8.0
 355     * Red Hat Enterprise Linux Server release 7.7
 356     * Suse15SP1
 357     * Ubuntu 14.04
 358     * Ubuntu 16.04
 359     * Ubuntu 16.10
 360     * Ubuntu 18.04
 361     * Ubuntu 19.04
 362
 363   * NICs:
 364
 365     * Intel\ |reg| Corporation Ethernet Controller E810-C for SFP (4x25G)
 366
 367       * Firmware version: 1.02 0x80002b69
 368       * Device id (pf): 8086:1593
 369       * Driver version: 0.12.34 (ice)
 370
 371     * Intel\ |reg| Corporation Ethernet Controller E810-C for SFP (2x100G)
 372
 373       * Firmware version: 1.02 0x80002b68
 374       * Device id (pf): 8086:1592
 375       * Driver version: 0.12.34 (ice)
 376
 377     * Intel\ |reg| 82599ES 10 Gigabit Ethernet Controller
 378
 379       * Firmware version: 0x61bf0001
 380       * Device id (pf/vf): 8086:10fb / 8086:10ed
 381       * Driver version: 5.6.1 (ixgbe)
 382
 383     * Intel\ |reg| Corporation Ethernet Connection X552/X557-AT 10GBASE-T
 384
 385       * Firmware version: 0x800003e7
 386       * Device id (pf/vf): 8086:15ad / 8086:15a8
 387       * Driver version: 5.1.0 (ixgbe)
 388
 389     * Intel\ |reg| Corporation Ethernet Controller 10G X550T
 390
 391       * Firmware version: 0x80000482
 392       * Device id (pf): 8086:1563
 393       * Driver version: 5.6.1 (ixgbe)
 394
 395     * Intel\ |reg| Ethernet Converged Network Adapter X710-DA4 (4x10G)
 396
 397       * Firmware version: 7.20 0x800079e8
 398       * Device id (pf/vf): 8086:1572 / 8086:154c
 399       * Driver version: 2.10.19.30 (i40e)
 400
 401     * Intel\ |reg| Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G)
 402
 403       * Firmware version: 4.11 0x80001def
 404       * Device id (pf/vf): 8086:37d0 / 8086:37cd
 405       * Driver version: 2.10.19.30 (i40e)
 406
 407     * Intel\ |reg| Corporation Ethernet Connection X722 for 10GBASE-T (2x10G)
 408
 409       * Firmware version: 4.10 0x80001a7a
 410       * Device id (pf/vf): 8086:37d2 / 8086:37cd
 411       * Driver version: 2.10.19.30 (i40e)
 412
 413     * Intel\ |reg| Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
 414
 415       * Firmware version: 7.20 0x80007947
 416       * Device id (pf/vf): 8086:158b / 8086:154c
 417       * Driver version: 2.10.19.30 (i40e)
 418
 419     * Intel\ |reg| Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
 420
 421       * Firmware version: 7.20 0x80007948
 422       * Device id (pf/vf): 8086:1583 / 8086:154c
 423       * Driver version: 2.10.19.30 (i40e)
 424
 425     * Intel\ |reg| Corporation I350 Gigabit Network Connection
 426
 427       * Firmware version: 1.63, 0x80000cbc
 428       * Device id (pf/vf): 8086:1521 / 8086:1520
 429       * Driver version: 5.4.0-k (igb)
 430
 431     * Intel\ |reg| Corporation I210 Gigabit Network Connection
 432
 433       * Firmware version: 3.25, 0x800006eb
 434       * Device id (pf): 8086:1533
 435       * Driver version: 5.4.0-k(igb)