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