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