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