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 * **Updated rte_flow api to support L2TPv3 over IP flows.**
  65
  66   Added support for new flow item to handle L2TPv3 over IP rte_flow patterns.
  67
  68 * **Added IONIC net PMD.**
  69
  70   Added the new ``ionic`` net driver for Pensando Ethernet Network Adapters.
  71   See the :doc:`../nics/ionic` NIC guide for more details on this new driver.
  72
  73 * **Updated Broadcom bnxt driver**
  74
  75   Updated Broadcom bnxt driver with new features and improvements, including:
  76
  77   * Added support for MARK action.
  78
  79 * **Updated Hisilicon hns3 driver.**
  80
  81   Updated Hisilicon hns3 driver with new features and improvements, including:
  82
  83   * Added support for Rx interrupt.
  84   * Added support setting VF MAC address by PF driver.
  85
  86 * **Updated the Intel ice driver.**
  87
  88   Updated the Intel ice driver with new features and improvements, including:
  89
  90   * Added support for MAC rules on specific port.
  91   * Added support for MAC/VLAN with TCP/UDP in switch rule.
  92   * Added support for 1/10G device.
  93   * Added support for API rte_eth_tx_done_cleanup.
  94
  95 * **Updated Intel iavf driver.**
  96
  97   Updated iavf PMD with new features and improvements, including:
  98
  99   * Added more supported device IDs.
 100   * Updated virtual channel to latest AVF spec.
 101
 102 * **Updated Intel i40e driver.**
 103
 104   Updated i40e PMD with new features and improvements, including:
 105
 106   * Added support for L2TPv3 over IP profiles which can be programmed by the
 107     dynamic device personalization (DDP) process.
 108   * Added support for ESP-AH profiles which can be programmed by the
 109     dynamic device personalization (DDP) process.
 110   * Added PF support Malicious Device Drive event catch and notify.
 111   * Added LLDP support.
 112   * Extended PHY access AQ cmd.
 113   * Added support for reading LPI counters.
 114   * Added support for Energy Efficient Ethernet.
 115   * Added support for API rte_eth_tx_done_cleanup.
 116   * Added support for VF multiple queues interrupt.
 117   * Added support for setting the link to specific speed.
 118
 119 * **Updated Mellanox mlx5 driver.**
 120
 121   Updated Mellanox mlx5 driver with new features and improvements, including:
 122
 123   * Added support for RSS using L3/L4 source/destination only.
 124   * Added support for matching on GTP tunnel header item.
 125   * Removed limitation of matching on tagged/untagged packets (when using DV flow engine).
 126
 127 * **Add new vDPA PMD based on Mellanox devices**
 128
 129   Added a new Mellanox vDPA  (``mlx5_vdpa``) PMD.
 130   See the :doc:`../vdpadevs/mlx5` guide for more details on this driver.
 131
 132 * **Added support for virtio-PMD notification data.**
 133
 134   Added support for virtio-PMD notification data so that the driver
 135   passes extra data (besides identifying the virtqueue) in its device
 136   notifications, expanding the notifications to include the avail index and
 137   avail wrap counter (When split ring is used, the avail wrap counter is not
 138   included in the notification data).
 139
 140 * **Updated testpmd application.**
 141
 142   Added support for ESP and L2TPv3 over IP rte_flow patterns to the testpmd
 143   application.
 144
 145 * **Added algorithms to cryptodev API.**
 146
 147   * ECDSA (Elliptic Curve Digital Signature Algorithm) is added to
 148     asymmetric crypto library specifications.
 149   * ECPM (Elliptic Curve Point Multiplication) is added to
 150     asymmetric crypto library specifications.
 151
 152 * **Added synchronous Crypto burst API.**
 153
 154   A new API is introduced in crypto library to handle synchronous cryptographic
 155   operations allowing to achieve performance gain for cryptodevs which use
 156   CPU based acceleration, such as Intel AES-NI. An implementation for aesni_gcm
 157   cryptodev is provided. The IPsec example application and ipsec library itself
 158   were changed to allow utilization of this new feature.
 159
 160 * **Added handling of mixed algorithms in encrypted digest requests in QAT PMD.**
 161
 162   Added handling of mixed algorithms in encrypted digest hash-cipher
 163   (generation) and cipher-hash (verification) requests (e.g. SNOW3G + ZUC or
 164   ZUC + AES CTR) in QAT PMD possible when running on GEN3 QAT hardware.
 165   Such algorithm combinations are not supported on GEN1/GEN2 hardware
 166   and executing the request returns RTE_CRYPTO_OP_STATUS_INVALID_SESSION.
 167
 168 * **Queue-pairs are now thread-safe on Intel QuickAssist Technology (QAT) PMD.**
 169
 170   Queue-pairs are thread-safe on Intel CPUs but Queues are not (that is, within
 171   a single queue-pair all enqueues to the TX queue must be done from one thread
 172   and all dequeues from the RX queue must be done from one thread, but enqueues
 173   and dequeues may be done in different threads.).
 174
 175 * **Updated the ZUC PMD.**
 176
 177   * Transistioned underlying library from libSSO ZUC to intel-ipsec-mb
 178     library (minimum version required 0.53).
 179   * Removed dynamic library limitation, so PMD can be built as a shared
 180     object now.
 181
 182 * **Updated the KASUMI PMD.**
 183
 184   * Transistioned underlying library from libSSO KASUMI to intel-ipsec-mb
 185     library (minimum version required 0.53).
 186
 187 * **Updated the SNOW3G PMD.**
 188
 189   * Transistioned underlying library from libSSO SNOW3G to intel-ipsec-mb
 190     library (minimum version required 0.53).
 191
 192 * **Changed armv8 crypto PMD external dependency.**
 193
 194   armv8 crypto PMD now depends on Arm crypto library, and Marvell's
 195   armv8 crypto library is not used anymore. Library name is changed
 196   from armv8_crypto to AArch64crypto.
 197
 198 * **Added inline IPsec support to Marvell OCTEON TX2 PMD.**
 199
 200   Added inline IPsec support to Marvell OCTEON TX2 PMD. With the feature,
 201   applications would be able to offload entire IPsec offload to the hardware.
 202   For the configured sessions, hardware will do the lookup and perform
 203   decryption and IPsec transformation. For the outbound path, application
 204   can submit a plain packet to the PMD, and it would be sent out on wire
 205   after doing encryption and IPsec transformation of the packet.
 206
 207 * **Added Marvell OCTEON TX2 End Point rawdev PMD.**
 208
 209   Added a new OCTEON TX2 rawdev PMD for End Point mode of operation.
 210   See the :doc:`../rawdevs/octeontx2_ep` for more details on this new PMD.
 211
 212 * **Added event mode to l3fwd sample application.**
 213
 214   Add event device support for ``l3fwd`` sample application. It demonstrates
 215   usage of poll and event mode IO mechanism under a single application.
 216
 217 * **Added cycle-count mode to the compression performance tool.**
 218
 219   Enhanced the compression performance tool by adding a cycle-count mode
 220   which can be used to help measure and tune hardware and software PMDs.
 221
 222
 223 Removed Items
 224 -------------
 225
 226 .. This section should contain removed items in this release. Sample format:
 227
 228    * Add a short 1-2 sentence description of the removed item
 229      in the past tense.
 230
 231    This section is a comment. Do not overwrite or remove it.
 232    Also, make sure to start the actual text at the margin.
 233    =========================================================
 234
 235 * **Disabled building all the Linux kernel modules by default.**
 236
 237   In order to remove the build time dependency with Linux kernel,
 238   the Technical Board decided to disable all the kernel modules
 239   by default from 20.02 version.
 240
 241 * **Removed coalescing feature from Intel QuickAssist Technology (QAT) PMD.**
 242
 243   The internal tail write coalescing feature was removed as not compatible with
 244   dual-thread feature. It was replaced with a threshold feature. At busy times
 245   if only a small number of packets can be enqueued, each enqueue causes
 246   an expensive MMIO write. These MMIO write occurrences can be optimised by using
 247   the new threshold parameter on process start. Please see qat documentation for
 248   more details.
 249
 250
 251 API Changes
 252 -----------
 253
 254 .. This section should contain API changes. Sample format:
 255
 256    * sample: Add a short 1-2 sentence description of the API change
 257      which was announced in the previous releases and made in this release.
 258      Start with a scope label like "ethdev:".
 259      Use fixed width quotes for ``function_names`` or ``struct_names``.
 260      Use the past tense.
 261
 262    This section is a comment. Do not overwrite or remove it.
 263    Also, make sure to start the actual text at the margin.
 264    =========================================================
 265
 266
 267 ABI Changes
 268 -----------
 269
 270 .. This section should contain ABI changes. Sample format:
 271
 272    * sample: Add a short 1-2 sentence description of the ABI change
 273      which was announced in the previous releases and made in this release.
 274      Start with a scope label like "ethdev:".
 275      Use fixed width quotes for ``function_names`` or ``struct_names``.
 276      Use the past tense.
 277
 278    This section is a comment. Do not overwrite or remove it.
 279    Also, make sure to start the actual text at the margin.
 280    =========================================================
 281
 282 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
 283
 284
 285 Known Issues
 286 ------------
 287
 288 .. This section should contain new known issues in this release. Sample format:
 289
 290    * **Add title in present tense with full stop.**
 291
 292      Add a short 1-2 sentence description of the known issue
 293      in the present tense. Add information on any known workarounds.
 294
 295    This section is a comment. Do not overwrite or remove it.
 296    Also, make sure to start the actual text at the margin.
 297    =========================================================
 298
 299
 300 Tested Platforms
 301 ----------------
 302
 303 .. This section should contain a list of platforms that were tested
 304    with this release.
 305
 306    The format is:
 307
 308    * <vendor> platform with <vendor> <type of devices> combinations
 309
 310      * List of CPU
 311      * List of OS
 312      * List of devices
 313      * Other relevant details...
 314
 315    This section is a comment. Do not overwrite or remove it.
 316    Also, make sure to start the actual text at the margin.
 317    =========================================================