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