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