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
 137 * **Add new vDPA PMD based on Mellanox devices**
 138
 139   Added a new Mellanox vDPA  (``mlx5_vdpa``) PMD.
 140   See the :doc:`../vdpadevs/mlx5` guide for more details on this driver.
 141
 142 * **Added support for virtio-PMD notification data.**
 143
 144   Added support for virtio-PMD notification data so that the driver
 145   passes extra data (besides identifying the virtqueue) in its device
 146   notifications, expanding the notifications to include the avail index and
 147   avail wrap counter (When split ring is used, the avail wrap counter is not
 148   included in the notification data).
 149
 150 * **Updated testpmd application.**
 151
 152   Added support for ESP and L2TPv3 over IP rte_flow patterns to the testpmd
 153   application.
 154
 155 * **Added algorithms to cryptodev API.**
 156
 157   * ECDSA (Elliptic Curve Digital Signature Algorithm) is added to
 158     asymmetric crypto library specifications.
 159   * ECPM (Elliptic Curve Point Multiplication) is added to
 160     asymmetric crypto library specifications.
 161
 162 * **Added synchronous Crypto burst API.**
 163
 164   A new API is introduced in crypto library to handle synchronous cryptographic
 165   operations allowing to achieve performance gain for cryptodevs which use
 166   CPU based acceleration, such as Intel AES-NI. An implementation for aesni_gcm
 167   cryptodev is provided. The IPsec example application and ipsec library itself
 168   were changed to allow utilization of this new feature.
 169
 170 * **Added handling of mixed algorithms in encrypted digest requests in QAT PMD.**
 171
 172   Added handling of mixed algorithms in encrypted digest hash-cipher
 173   (generation) and cipher-hash (verification) requests (e.g. SNOW3G + ZUC or
 174   ZUC + AES CTR) in QAT PMD possible when running on GEN3 QAT hardware.
 175   Such algorithm combinations are not supported on GEN1/GEN2 hardware
 176   and executing the request returns RTE_CRYPTO_OP_STATUS_INVALID_SESSION.
 177
 178 * **Queue-pairs are now thread-safe on Intel QuickAssist Technology (QAT) PMD.**
 179
 180   Queue-pairs are thread-safe on Intel CPUs but Queues are not (that is, within
 181   a single queue-pair all enqueues to the TX queue must be done from one thread
 182   and all dequeues from the RX queue must be done from one thread, but enqueues
 183   and dequeues may be done in different threads.).
 184
 185 * **Updated the ZUC PMD.**
 186
 187   * Transistioned underlying library from libSSO ZUC to intel-ipsec-mb
 188     library (minimum version required 0.53).
 189   * Removed dynamic library limitation, so PMD can be built as a shared
 190     object now.
 191
 192 * **Updated the KASUMI PMD.**
 193
 194   * Transistioned underlying library from libSSO KASUMI to intel-ipsec-mb
 195     library (minimum version required 0.53).
 196
 197 * **Updated the SNOW3G PMD.**
 198
 199   * Transistioned underlying library from libSSO SNOW3G to intel-ipsec-mb
 200     library (minimum version required 0.53).
 201
 202 * **Changed armv8 crypto PMD external dependency.**
 203
 204   armv8 crypto PMD now depends on Arm crypto library, and Marvell's
 205   armv8 crypto library is not used anymore. Library name is changed
 206   from armv8_crypto to AArch64crypto.
 207
 208 * **Added inline IPsec support to Marvell OCTEON TX2 PMD.**
 209
 210   Added inline IPsec support to Marvell OCTEON TX2 PMD. With the feature,
 211   applications would be able to offload entire IPsec offload to the hardware.
 212   For the configured sessions, hardware will do the lookup and perform
 213   decryption and IPsec transformation. For the outbound path, application
 214   can submit a plain packet to the PMD, and it would be sent out on wire
 215   after doing encryption and IPsec transformation of the packet.
 216
 217 * **Added Marvell OCTEON TX2 End Point rawdev PMD.**
 218
 219   Added a new OCTEON TX2 rawdev PMD for End Point mode of operation.
 220   See the :doc:`../rawdevs/octeontx2_ep` for more details on this new PMD.
 221
 222 * **Added event mode to l3fwd sample application.**
 223
 224   Add event device support for ``l3fwd`` sample application. It demonstrates
 225   usage of poll and event mode IO mechanism under a single application.
 226
 227 * **Added cycle-count mode to the compression performance tool.**
 228
 229   Enhanced the compression performance tool by adding a cycle-count mode
 230   which can be used to help measure and tune hardware and software PMDs.
 231
 232
 233 Removed Items
 234 -------------
 235
 236 .. This section should contain removed items in this release. Sample format:
 237
 238    * Add a short 1-2 sentence description of the removed item
 239      in the past tense.
 240
 241    This section is a comment. Do not overwrite or remove it.
 242    Also, make sure to start the actual text at the margin.
 243    =========================================================
 244
 245 * **Disabled building all the Linux kernel modules by default.**
 246
 247   In order to remove the build time dependency with Linux kernel,
 248   the Technical Board decided to disable all the kernel modules
 249   by default from 20.02 version.
 250
 251 * **Removed coalescing feature from Intel QuickAssist Technology (QAT) PMD.**
 252
 253   The internal tail write coalescing feature was removed as not compatible with
 254   dual-thread feature. It was replaced with a threshold feature. At busy times
 255   if only a small number of packets can be enqueued, each enqueue causes
 256   an expensive MMIO write. These MMIO write occurrences can be optimised by using
 257   the new threshold parameter on process start. Please see qat documentation for
 258   more details.
 259
 260
 261 API Changes
 262 -----------
 263
 264 .. This section should contain API changes. Sample format:
 265
 266    * sample: Add a short 1-2 sentence description of the API change
 267      which was announced in the previous releases and made in this release.
 268      Start with a scope label like "ethdev:".
 269      Use fixed width quotes for ``function_names`` or ``struct_names``.
 270      Use the past tense.
 271
 272    This section is a comment. Do not overwrite or remove it.
 273    Also, make sure to start the actual text at the margin.
 274    =========================================================
 275
 276
 277 ABI Changes
 278 -----------
 279
 280 .. This section should contain ABI changes. Sample format:
 281
 282    * sample: Add a short 1-2 sentence description of the ABI change
 283      which was announced in the previous releases and made in this release.
 284      Start with a scope label like "ethdev:".
 285      Use fixed width quotes for ``function_names`` or ``struct_names``.
 286      Use the past tense.
 287
 288    This section is a comment. Do not overwrite or remove it.
 289    Also, make sure to start the actual text at the margin.
 290    =========================================================
 291
 292 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
 293
 294
 295 Known Issues
 296 ------------
 297
 298 .. This section should contain new known issues in this release. Sample format:
 299
 300    * **Add title in present tense with full stop.**
 301
 302      Add a short 1-2 sentence description of the known issue
 303      in the present tense. Add information on any known workarounds.
 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 Tested Platforms
 311 ----------------
 312
 313 .. This section should contain a list of platforms that were tested
 314    with this release.
 315
 316    The format is:
 317
 318    * <vendor> platform with <vendor> <type of devices> combinations
 319
 320      * List of CPU
 321      * List of OS
 322      * List of devices
 323      * Other relevant details...
 324
 325    This section is a comment. Do not overwrite or remove it.
 326    Also, make sure to start the actual text at the margin.
 327    =========================================================
 328
 329 * Intel\ |reg| platforms with Intel\ |reg| NICs combinations
 330
 331   * CPU
 332
 333     * Intel\ |reg| Atom\ |trade| CPU C3758 @ 2.20GHz
 334     * Intel\ |reg| Atom\ |trade| CPU C3858 @ 2.00GHz
 335     * Intel\ |reg| Atom\ |trade| CPU C3958 @ 2.00GHz
 336     * Intel\ |reg| Xeon\ |reg| CPU D-1541 @ 2.10GHz
 337     * Intel\ |reg| Xeon\ |reg| CPU D-1553N @ 2.30GHz
 338     * Intel\ |reg| Xeon\ |reg| CPU E5-2680 0 @ 2.70GHz
 339     * Intel\ |reg| Xeon\ |reg| CPU E5-2680 v2 @ 2.80GHz
 340     * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v3 @ 2.30GHz
 341     * Intel\ |reg| Xeon\ |reg| CPU E5-2699 v4 @ 2.20GHz
 342     * Intel\ |reg| Xeon\ |reg| Gold 6139 CPU @ 2.30GHz
 343     * Intel\ |reg| Xeon\ |reg| Gold 6252N CPU @ 2.30GHz
 344     * Intel\ |reg| Xeon\ |reg| Platinum 8180 CPU @ 2.50GHz
 345     * Intel\ |reg| Xeon\ |reg| Platinum 8280M CPU @ 2.70GHz
 346
 347   * OS:
 348
 349     * CentOS 7.7
 350     * CentOS 8.0
 351     * Fedora 31
 352     * FreeBSD 12.1
 353     * Red Hat Enterprise Linux Server release 8.0
 354     * Red Hat Enterprise Linux Server release 7.7
 355     * Suse15SP1
 356     * Ubuntu 14.04
 357     * Ubuntu 16.04
 358     * Ubuntu 16.10
 359     * Ubuntu 18.04
 360     * Ubuntu 19.04
 361
 362   * NICs:
 363
 364     * Intel\ |reg| Corporation Ethernet Controller E810-C for SFP (4x25G)
 365
 366       * Firmware version: 1.02 0x80002b69
 367       * Device id (pf): 8086:1593
 368       * Driver version: 0.12.34 (ice)
 369
 370     * Intel\ |reg| Corporation Ethernet Controller E810-C for SFP (2x100G)
 371
 372       * Firmware version: 1.02 0x80002b68
 373       * Device id (pf): 8086:1592
 374       * Driver version: 0.12.34 (ice)
 375
 376     * Intel\ |reg| 82599ES 10 Gigabit Ethernet Controller
 377
 378       * Firmware version: 0x61bf0001
 379       * Device id (pf/vf): 8086:10fb / 8086:10ed
 380       * Driver version: 5.6.1 (ixgbe)
 381
 382     * Intel\ |reg| Corporation Ethernet Connection X552/X557-AT 10GBASE-T
 383
 384       * Firmware version: 0x800003e7
 385       * Device id (pf/vf): 8086:15ad / 8086:15a8
 386       * Driver version: 5.1.0 (ixgbe)
 387
 388     * Intel\ |reg| Corporation Ethernet Controller 10G X550T
 389
 390       * Firmware version: 0x80000482
 391       * Device id (pf): 8086:1563
 392       * Driver version: 5.6.1 (ixgbe)
 393
 394     * Intel\ |reg| Ethernet Converged Network Adapter X710-DA4 (4x10G)
 395
 396       * Firmware version: 7.20 0x800079e8
 397       * Device id (pf/vf): 8086:1572 / 8086:154c
 398       * Driver version: 2.10.19.30 (i40e)
 399
 400     * Intel\ |reg| Corporation Ethernet Connection X722 for 10GbE SFP+ (4x10G)
 401
 402       * Firmware version: 4.11 0x80001def
 403       * Device id (pf/vf): 8086:37d0 / 8086:37cd
 404       * Driver version: 2.10.19.30 (i40e)
 405
 406     * Intel\ |reg| Corporation Ethernet Connection X722 for 10GBASE-T (2x10G)
 407
 408       * Firmware version: 4.10 0x80001a7a
 409       * Device id (pf/vf): 8086:37d2 / 8086:37cd
 410       * Driver version: 2.10.19.30 (i40e)
 411
 412     * Intel\ |reg| Ethernet Converged Network Adapter XXV710-DA2 (2x25G)
 413
 414       * Firmware version: 7.20 0x80007947
 415       * Device id (pf/vf): 8086:158b / 8086:154c
 416       * Driver version: 2.10.19.30 (i40e)
 417
 418     * Intel\ |reg| Ethernet Converged Network Adapter XL710-QDA2 (2X40G)
 419
 420       * Firmware version: 7.20 0x80007948
 421       * Device id (pf/vf): 8086:1583 / 8086:154c
 422       * Driver version: 2.10.19.30 (i40e)
 423
 424     * Intel\ |reg| Corporation I350 Gigabit Network Connection
 425
 426       * Firmware version: 1.63, 0x80000cbc
 427       * Device id (pf/vf): 8086:1521 / 8086:1520
 428       * Driver version: 5.4.0-k (igb)
 429
 430     * Intel\ |reg| Corporation I210 Gigabit Network Connection
 431
 432       * Firmware version: 3.25, 0x800006eb
 433       * Device id (pf): 8086:1533
 434       * Driver version: 5.4.0-k(igb)