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