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) compression PMD.**
 129
 130   Added stateful decompression support in the Intel QuickAssist Technology PMD.
 131   Please note that stateful compression is not supported.
 132
 133 * **Added external buffers support for dpdk-test-compress-perf tool.**
 134
 135   Added a command line option to dpdk-test-compress-perf tool to allocate
 136   and use memory zones as external buffers instead of keeping the data directly
 137   in mbuf areas.
 138
 139 * **Introduced FIFO for NTB PMD.**
 140
 141   Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
 142   packet based processing.
 143
 144 * **Added eBPF JIT support for arm64.**
 145
 146   Added eBPF JIT support for arm64 architecture to improve the eBPF program
 147   performance.
 148
 149
 150 Removed Items
 151 -------------
 152
 153 .. This section should contain removed items in this release. Sample format:
 154
 155    * Add a short 1-2 sentence description of the removed item
 156      in the past tense.
 157
 158    This section is a comment. Do not overwrite or remove it.
 159    Also, make sure to start the actual text at the margin.
 160    =========================================================
 161
 162 * Removed duplicated set of commands for Rx offload configuration from testpmd::
 163
 164     port config all crc-strip|scatter|rx-cksum|rx-timestamp|
 165                     hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
 166
 167   The testpmd commands set that can be used instead
 168   in order to enable or disable Rx offloading on all Rx queues of a port is::
 169
 170     port config <port_id> rx_offload crc_strip|scatter|
 171                                      ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
 172                                      vlan_strip|vlan_filter|vlan_extend on|off
 173
 174
 175 API Changes
 176 -----------
 177
 178 .. This section should contain API changes. Sample format:
 179
 180    * sample: Add a short 1-2 sentence description of the API change
 181      which was announced in the previous releases and made in this release.
 182      Start with a scope label like "ethdev:".
 183      Use fixed width quotes for ``function_names`` or ``struct_names``.
 184      Use the past tense.
 185
 186    This section is a comment. Do not overwrite or remove it.
 187    Also, make sure to start the actual text at the margin.
 188    =========================================================
 189
 190 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
 191   ``int`` to provide a way to report various error conditions.
 192
 193 * ethdev: changed ``rte_eth_promiscuous_enable`` and
 194   ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
 195   provide a way to report various error conditions.
 196
 197 * ethdev: changed ``rte_eth_allmulticast_enable`` and
 198   ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
 199   provide a way to report various error conditions.
 200
 201 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
 202   ``int`` to provide a way to report various error conditions.
 203
 204 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
 205   return value from ``void`` to ``int`` to provide a way to report various
 206   error conditions.
 207
 208 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
 209   ``int`` to provide a way to report various error conditions.
 210
 211 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
 212   ``int`` to provide a way to report various error conditions.
 213
 214 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
 215   input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
 216   has been introduced in this release is used when used when all the packets
 217   enqueued in the tx adapter are destined for the same Ethernet port & Tx queue.
 218
 219
 220 ABI Changes
 221 -----------
 222
 223 .. This section should contain ABI changes. Sample format:
 224
 225    * sample: Add a short 1-2 sentence description of the ABI change
 226      which was announced in the previous releases and made in this release.
 227      Start with a scope label like "ethdev:".
 228      Use fixed width quotes for ``function_names`` or ``struct_names``.
 229      Use 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
 236 Shared Library Versions
 237 -----------------------
 238
 239 .. Update any library version updated in this release
 240    and prepend with a ``+`` sign, like this:
 241
 242      libfoo.so.1
 243    + libupdated.so.2
 244      libbar.so.1
 245
 246    This section is a comment. Do not overwrite or remove it.
 247    =========================================================
 248
 249 The libraries prepended with a plus sign were incremented in this version.
 250
 251 .. code-block:: diff
 252
 253      librte_acl.so.2
 254      librte_bbdev.so.1
 255      librte_bitratestats.so.2
 256      librte_bpf.so.1
 257      librte_bus_dpaa.so.2
 258      librte_bus_fslmc.so.2
 259      librte_bus_ifpga.so.2
 260      librte_bus_pci.so.2
 261      librte_bus_vdev.so.2
 262      librte_bus_vmbus.so.2
 263      librte_cfgfile.so.2
 264      librte_cmdline.so.2
 265      librte_compressdev.so.1
 266      librte_cryptodev.so.8
 267      librte_distributor.so.1
 268      librte_eal.so.11
 269      librte_efd.so.1
 270    + librte_ethdev.so.13
 271    + librte_eventdev.so.8
 272      librte_flow_classify.so.1
 273      librte_gro.so.1
 274      librte_gso.so.1
 275      librte_hash.so.2
 276      librte_ip_frag.so.1
 277      librte_ipsec.so.1
 278      librte_jobstats.so.1
 279      librte_kni.so.2
 280      librte_kvargs.so.1
 281      librte_latencystats.so.1
 282      librte_lpm.so.2
 283      librte_mbuf.so.5
 284      librte_member.so.1
 285      librte_mempool.so.5
 286      librte_meter.so.3
 287      librte_metrics.so.1
 288      librte_net.so.1
 289      librte_pci.so.1
 290      librte_pdump.so.3
 291      librte_pipeline.so.3
 292      librte_pmd_bnxt.so.2
 293      librte_pmd_bond.so.2
 294      librte_pmd_i40e.so.2
 295      librte_pmd_ixgbe.so.2
 296      librte_pmd_dpaa2_qdma.so.1
 297      librte_pmd_ring.so.2
 298      librte_pmd_softnic.so.1
 299      librte_pmd_vhost.so.2
 300      librte_port.so.3
 301      librte_power.so.1
 302      librte_rawdev.so.1
 303      librte_rcu.so.1
 304      librte_reorder.so.1
 305      librte_ring.so.2
 306      librte_sched.so.3
 307      librte_security.so.2
 308      librte_stack.so.1
 309      librte_table.so.3
 310      librte_timer.so.1
 311      librte_vhost.so.4
 312
 313
 314 Known Issues
 315 ------------
 316
 317 .. This section should contain new known issues in this release. Sample format:
 318
 319    * **Add title in present tense with full stop.**
 320
 321      Add a short 1-2 sentence description of the known issue
 322      in the present tense. Add information on any known workarounds.
 323
 324    This section is a comment. Do not overwrite or remove it.
 325    Also, make sure to start the actual text at the margin.
 326    =========================================================
 327
 328
 329 Tested Platforms
 330 ----------------
 331
 332 .. This section should contain a list of platforms that were tested
 333    with this release.
 334
 335    The format is:
 336
 337    * <vendor> platform with <vendor> <type of devices> combinations
 338
 339      * List of CPU
 340      * List of OS
 341      * List of devices
 342      * Other relevant details...
 343
 344    This section is a comment. Do not overwrite or remove it.
 345    Also, make sure to start the actual text at the margin.
 346    =========================================================
 347
 348 * **Updated Mellanox mlx5 driver.**
 349
 350   Updated Mellanox mlx5 driver with new features and improvements, including:
 351
 352   * Added support for VLAN pop flow offload command.
 353   * Added support for VLAN push flow offload command.
 354   * Added support for VLAN set PCP offload command.
 355   * Added support for VLAN set VID offload command.
 356