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