doc/guides/rel_notes/release_19_11.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2019 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 19.11
   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_19_11.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 Lock-free Stack for aarch64.**
  60
  61   The lock-free stack implementation is enabled for aarch64 platforms.
  62
  63 * **Added Hisilicon hns3 PMD.**
  64
  65   Added the new ``hns3`` net driver for the inbuilt Hisilicon Network
  66   Subsystem 3(HNS3) network engine found in the Hisilicon Kunpeng 920 SoC.
  67   See the :doc:`../nics/hns3` guide for more details on this new driver.
  68
  69 * **Updated the Intel e1000 driver.**
  70
  71   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  72
  73 * **Updated the Intel ixgbe driver.**
  74
  75   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  76
  77 * **Updated the Intel i40e driver.**
  78
  79   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  80
  81 * **Updated the Intel fm10k driver.**
  82
  83   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  84
  85 * **Updated the Intel ice driver.**
  86
  87   Updated the Intel ice driver with new features and improvements, including:
  88
  89   * Added support for device-specific DDP package loading.
  90   * Added support for handling Receive Flex Descriptor.
  91   * Added support for protocol extraction on per Rx queue.
  92   * Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  93
  94 * **Added cryptodev asymmetric session-less operation.**
  95
  96   Added session-less option to cryptodev asymmetric structure. It works the same
  97   way as symmetric crypto, corresponding xform is used directly by the crypto op.
  98
  99 * **Added Marvell NITROX symmetric crypto PMD.**
 100
 101   Added a symmetric crypto PMD for Marvell NITROX V security processor.
 102   See the :doc:`../cryptodevs/nitrox` guide for more details on this new
 103
 104 * **Added asymmetric support to Marvell OCTEON TX crypto PMD.**
 105
 106   Added support for asymmetric operations in Marvell OCTEON TX cypto PMD.
 107   Supports RSA and modexp operations.
 108
 109 * **Added Marvell OCTEON TX2 crypto PMD**
 110
 111   Added a new PMD driver for h/w crypto offload block on ``OCTEON TX2`` SoC.
 112
 113   See :doc:`../cryptodevs/octeontx2` for more details
 114
 115 * **Updated NXP crypto PMDs for PDCP support.**
 116
 117   PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
 118   Support is added for all sequence number sizes for control and user plane.
 119   Test application is updated for unit testing.
 120
 121 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
 122
 123   Added support for Single Pass GCM, available on QAT GEN3 only (Intel
 124   QuickAssist Technology C4xxx). It is automatically chosen instead of the
 125   classic 2-pass mode when running on QAT GEN3, significantly improving
 126   the performance of AES GCM operations.
 127
 128 * **Updated the Intel QuickAssist Technology (QAT) asymmetric crypto PMD.**
 129
 130   * Added support for asymmetric session-less operations.
 131   * Added support for RSA algorithm with pair (n, d) private key representation.
 132
 133 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
 134
 135   Added stateful decompression support in the Intel QuickAssist Technology PMD.
 136   Please note that stateful compression is not supported.
 137
 138 * **Added external buffers support for dpdk-test-compress-perf tool.**
 139
 140   Added a command line option to dpdk-test-compress-perf tool to allocate
 141   and use memory zones as external buffers instead of keeping the data directly
 142   in mbuf areas.
 143
 144 * **Updated the IPSec library.**
 145
 146   Added SA Database API to ``librte_ipsec``. A new test-sad application is also
 147   introduced to evaluate and perform custom functional and performance tests
 148   for IPsec SAD implementation.
 149
 150 * **Introduced FIFO for NTB PMD.**
 151
 152   Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
 153   packet based processing.
 154
 155 * **Added eBPF JIT support for arm64.**
 156
 157   Added eBPF JIT support for arm64 architecture to improve the eBPF program
 158   performance.
 159
 160
 161 Removed Items
 162 -------------
 163
 164 .. This section should contain removed items in this release. Sample format:
 165
 166    * Add a short 1-2 sentence description of the removed item
 167      in the past tense.
 168
 169    This section is a comment. Do not overwrite or remove it.
 170    Also, make sure to start the actual text at the margin.
 171    =========================================================
 172
 173 * Removed duplicated set of commands for Rx offload configuration from testpmd::
 174
 175     port config all crc-strip|scatter|rx-cksum|rx-timestamp|
 176                     hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
 177
 178   The testpmd commands set that can be used instead
 179   in order to enable or disable Rx offloading on all Rx queues of a port is::
 180
 181     port config <port_id> rx_offload crc_strip|scatter|
 182                                      ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
 183                                      vlan_strip|vlan_filter|vlan_extend on|off
 184
 185
 186 API Changes
 187 -----------
 188
 189 .. This section should contain API changes. Sample format:
 190
 191    * sample: Add a short 1-2 sentence description of the API change
 192      which was announced in the previous releases and made in this release.
 193      Start with a scope label like "ethdev:".
 194      Use fixed width quotes for ``function_names`` or ``struct_names``.
 195      Use the past tense.
 196
 197    This section is a comment. Do not overwrite or remove it.
 198    Also, make sure to start the actual text at the margin.
 199    =========================================================
 200
 201 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
 202   ``int`` to provide a way to report various error conditions.
 203
 204 * ethdev: changed ``rte_eth_promiscuous_enable`` and
 205   ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
 206   provide a way to report various error conditions.
 207
 208 * ethdev: changed ``rte_eth_allmulticast_enable`` and
 209   ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
 210   provide a way to report various error conditions.
 211
 212 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
 213   ``int`` to provide a way to report various error conditions.
 214
 215 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
 216   return value from ``void`` to ``int`` to provide a way to report various
 217   error conditions.
 218
 219 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
 220   ``int`` to provide a way to report various error conditions.
 221
 222 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
 223   ``int`` to provide a way to report various error conditions.
 224
 225 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
 226   input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
 227   has been introduced in this release is used when used when all the packets
 228   enqueued in the tx adapter are destined for the same Ethernet port & Tx queue.
 229
 230
 231 ABI Changes
 232 -----------
 233
 234 .. This section should contain ABI changes. Sample format:
 235
 236    * sample: Add a short 1-2 sentence description of the ABI change
 237      which was announced in the previous releases and made in this release.
 238      Start with a scope label like "ethdev:".
 239      Use fixed width quotes for ``function_names`` or ``struct_names``.
 240      Use 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
 247 Shared Library Versions
 248 -----------------------
 249
 250 .. Update any library version updated in this release
 251    and prepend with a ``+`` sign, like this:
 252
 253      libfoo.so.1
 254    + libupdated.so.2
 255      libbar.so.1
 256
 257    This section is a comment. Do not overwrite or remove it.
 258    =========================================================
 259
 260 The libraries prepended with a plus sign were incremented in this version.
 261
 262 .. code-block:: diff
 263
 264      librte_acl.so.2
 265      librte_bbdev.so.1
 266      librte_bitratestats.so.2
 267      librte_bpf.so.1
 268      librte_bus_dpaa.so.2
 269      librte_bus_fslmc.so.2
 270      librte_bus_ifpga.so.2
 271      librte_bus_pci.so.2
 272      librte_bus_vdev.so.2
 273      librte_bus_vmbus.so.2
 274      librte_cfgfile.so.2
 275      librte_cmdline.so.2
 276      librte_compressdev.so.1
 277      librte_cryptodev.so.8
 278      librte_distributor.so.1
 279      librte_eal.so.11
 280      librte_efd.so.1
 281    + librte_ethdev.so.13
 282    + librte_eventdev.so.8
 283      librte_flow_classify.so.1
 284      librte_gro.so.1
 285      librte_gso.so.1
 286      librte_hash.so.2
 287      librte_ip_frag.so.1
 288      librte_ipsec.so.1
 289      librte_jobstats.so.1
 290      librte_kni.so.2
 291      librte_kvargs.so.1
 292      librte_latencystats.so.1
 293      librte_lpm.so.2
 294      librte_mbuf.so.5
 295      librte_member.so.1
 296      librte_mempool.so.5
 297      librte_meter.so.3
 298      librte_metrics.so.1
 299      librte_net.so.1
 300      librte_pci.so.1
 301      librte_pdump.so.3
 302      librte_pipeline.so.3
 303      librte_pmd_bnxt.so.2
 304      librte_pmd_bond.so.2
 305      librte_pmd_i40e.so.2
 306      librte_pmd_ixgbe.so.2
 307      librte_pmd_dpaa2_qdma.so.1
 308      librte_pmd_ring.so.2
 309      librte_pmd_softnic.so.1
 310      librte_pmd_vhost.so.2
 311      librte_port.so.3
 312      librte_power.so.1
 313      librte_rawdev.so.1
 314      librte_rcu.so.1
 315      librte_reorder.so.1
 316      librte_ring.so.2
 317      librte_sched.so.3
 318      librte_security.so.2
 319      librte_stack.so.1
 320      librte_table.so.3
 321      librte_timer.so.1
 322      librte_vhost.so.4
 323
 324
 325 Known Issues
 326 ------------
 327
 328 .. This section should contain new known issues in this release. Sample format:
 329
 330    * **Add title in present tense with full stop.**
 331
 332      Add a short 1-2 sentence description of the known issue
 333      in the present tense. Add information on any known workarounds.
 334
 335    This section is a comment. Do not overwrite or remove it.
 336    Also, make sure to start the actual text at the margin.
 337    =========================================================
 338
 339
 340 Tested Platforms
 341 ----------------
 342
 343 .. This section should contain a list of platforms that were tested
 344    with this release.
 345
 346    The format is:
 347
 348    * <vendor> platform with <vendor> <type of devices> combinations
 349
 350      * List of CPU
 351      * List of OS
 352      * List of devices
 353      * Other relevant details...
 354
 355    This section is a comment. Do not overwrite or remove it.
 356    Also, make sure to start the actual text at the margin.
 357    =========================================================
 358
 359 * **Updated Mellanox mlx5 driver.**
 360
 361   Updated Mellanox mlx5 driver with new features and improvements, including:
 362
 363   * Added support for VLAN pop flow offload command.
 364   * Added support for VLAN push flow offload command.
 365   * Added support for VLAN set PCP offload command.
 366   * Added support for VLAN set VID offload command.
 367