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