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