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