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 * **Added Hisilicon hns3 PMD.**
  60
  61   Added the new ``hns3`` net driver for the inbuilt Hisilicon Network
  62   Subsystem 3(HNS3) network engine found in the Hisilicon Kunpeng 920 SoC.
  63   See the :doc:`../nics/hns3` guide for more details on this new driver.
  64
  65 * **Updated the Intel e1000 driver.**
  66
  67   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  68
  69 * **Updated the Intel ixgbe driver.**
  70
  71   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  72
  73 * **Updated the Intel i40e driver.**
  74
  75   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  76
  77 * **Updated the Intel fm10k driver.**
  78
  79   Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  80
  81 * **Updated the Intel ice driver.**
  82
  83   Updated the Intel ice driver with new features and improvements, including:
  84
  85   * Added support for device-specific DDP package loading.
  86   * Added support for handling Receive Flex Descriptor.
  87   * Added support for protocol extraction on per Rx queue.
  88   * Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
  89
  90 * **Added Marvell NITROX symmetric crypto PMD.**
  91
  92   Added a symmetric crypto PMD for Marvell NITROX V security processor.
  93   See the :doc:`../cryptodevs/nitrox` guide for more details on this new
  94
  95 * **Updated NXP crypto PMDs for PDCP support.**
  96
  97   PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
  98   Support is added for all sequence number sizes for control and user plane.
  99   Test application is updated for unit testing.
 100
 101 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
 102
 103   Added support for Single Pass GCM, available on QAT GEN3 only (Intel
 104   QuickAssist Technology C4xxx). It is automatically chosen instead of the
 105   classic 2-pass mode when running on QAT GEN3, significantly improving
 106   the performance of AES GCM operations.
 107
 108 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
 109
 110   Added stateful decompression support in the Intel QuickAssist Technology PMD.
 111   Please note that stateful compression is not supported.
 112
 113 * **Added eBPF JIT support for arm64.**
 114
 115   Added eBPF JIT support for arm64 architecture to improve the eBPF program
 116   performance.
 117
 118
 119 Removed Items
 120 -------------
 121
 122 .. This section should contain removed items in this release. Sample format:
 123
 124    * Add a short 1-2 sentence description of the removed item
 125      in the past tense.
 126
 127    This section is a comment. Do not overwrite or remove it.
 128    Also, make sure to start the actual text at the margin.
 129    =========================================================
 130
 131    * Removed duplicated set of commands for RX offloading configuration from app/testpmd:
 132      “port config all crc-strip|scatter|rx-cksum|rx-timestamp|hw-vlan|hw-vlan-filter|
 133      hw-vlan-strip|hw-vlan-extend on|off”.
 134
 135      The testpmd commands set that can be used instead in order to enable or disable Rx
 136      offloading on all Rx queues of a port is:
 137      "port config <port_id> rx_offload crc_strip|scatter|ipv4_cksum|udp_cksum|tcp_cksum|
 138      timestamp|vlan_strip|vlan_filter|vlan_extend on|off"
 139
 140
 141 API Changes
 142 -----------
 143
 144 .. This section should contain API changes. Sample format:
 145
 146    * sample: Add a short 1-2 sentence description of the API change
 147      which was announced in the previous releases and made in this release.
 148      Start with a scope label like "ethdev:".
 149      Use fixed width quotes for ``function_names`` or ``struct_names``.
 150      Use the past tense.
 151
 152    This section is a comment. Do not overwrite or remove it.
 153    Also, make sure to start the actual text at the margin.
 154    =========================================================
 155
 156 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
 157   ``int`` to provide a way to report various error conditions.
 158
 159 * ethdev: changed ``rte_eth_promiscuous_enable`` and
 160   ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
 161   provide a way to report various error conditions.
 162
 163 * ethdev: changed ``rte_eth_allmulticast_enable`` and
 164   ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
 165   provide a way to report various error conditions.
 166
 167 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
 168   ``int`` to provide a way to report various error conditions.
 169
 170 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
 171   return value from ``void`` to ``int`` to provide a way to report various
 172   error conditions.
 173
 174 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
 175   ``int`` to provide a way to report various error conditions.
 176
 177 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
 178   ``int`` to provide a way to report various error conditions.
 179
 180
 181 ABI Changes
 182 -----------
 183
 184 .. This section should contain ABI changes. Sample format:
 185
 186    * sample: Add a short 1-2 sentence description of the ABI change
 187      which was announced in the previous releases and made in this release.
 188      Start with a scope label like "ethdev:".
 189      Use fixed width quotes for ``function_names`` or ``struct_names``.
 190      Use the past tense.
 191
 192    This section is a comment. Do not overwrite or remove it.
 193    Also, make sure to start the actual text at the margin.
 194    =========================================================
 195
 196
 197 Shared Library Versions
 198 -----------------------
 199
 200 .. Update any library version updated in this release
 201    and prepend with a ``+`` sign, like this:
 202
 203      libfoo.so.1
 204    + libupdated.so.2
 205      libbar.so.1
 206
 207    This section is a comment. Do not overwrite or remove it.
 208    =========================================================
 209
 210 The libraries prepended with a plus sign were incremented in this version.
 211
 212 .. code-block:: diff
 213
 214      librte_acl.so.2
 215      librte_bbdev.so.1
 216      librte_bitratestats.so.2
 217      librte_bpf.so.1
 218      librte_bus_dpaa.so.2
 219      librte_bus_fslmc.so.2
 220      librte_bus_ifpga.so.2
 221      librte_bus_pci.so.2
 222      librte_bus_vdev.so.2
 223      librte_bus_vmbus.so.2
 224      librte_cfgfile.so.2
 225      librte_cmdline.so.2
 226      librte_compressdev.so.1
 227      librte_cryptodev.so.8
 228      librte_distributor.so.1
 229      librte_eal.so.11
 230      librte_efd.so.1
 231    + librte_ethdev.so.13
 232      librte_eventdev.so.7
 233      librte_flow_classify.so.1
 234      librte_gro.so.1
 235      librte_gso.so.1
 236      librte_hash.so.2
 237      librte_ip_frag.so.1
 238      librte_ipsec.so.1
 239      librte_jobstats.so.1
 240      librte_kni.so.2
 241      librte_kvargs.so.1
 242      librte_latencystats.so.1
 243      librte_lpm.so.2
 244      librte_mbuf.so.5
 245      librte_member.so.1
 246      librte_mempool.so.5
 247      librte_meter.so.3
 248      librte_metrics.so.1
 249      librte_net.so.1
 250      librte_pci.so.1
 251      librte_pdump.so.3
 252      librte_pipeline.so.3
 253      librte_pmd_bnxt.so.2
 254      librte_pmd_bond.so.2
 255      librte_pmd_i40e.so.2
 256      librte_pmd_ixgbe.so.2
 257      librte_pmd_dpaa2_qdma.so.1
 258      librte_pmd_ring.so.2
 259      librte_pmd_softnic.so.1
 260      librte_pmd_vhost.so.2
 261      librte_port.so.3
 262      librte_power.so.1
 263      librte_rawdev.so.1
 264      librte_rcu.so.1
 265      librte_reorder.so.1
 266      librte_ring.so.2
 267      librte_sched.so.3
 268      librte_security.so.2
 269      librte_stack.so.1
 270      librte_table.so.3
 271      librte_timer.so.1
 272      librte_vhost.so.4
 273
 274
 275 Known Issues
 276 ------------
 277
 278 .. This section should contain new known issues in this release. Sample format:
 279
 280    * **Add title in present tense with full stop.**
 281
 282      Add a short 1-2 sentence description of the known issue
 283      in the present tense. Add information on any known workarounds.
 284
 285    This section is a comment. Do not overwrite or remove it.
 286    Also, make sure to start the actual text at the margin.
 287    =========================================================
 288
 289
 290 Tested Platforms
 291 ----------------
 292
 293 .. This section should contain a list of platforms that were tested
 294    with this release.
 295
 296    The format is:
 297
 298    * <vendor> platform with <vendor> <type of devices> combinations
 299
 300      * List of CPU
 301      * List of OS
 302      * List of devices
 303      * Other relevant details...
 304
 305    This section is a comment. Do not overwrite or remove it.
 306    Also, make sure to start the actual text at the margin.
 307    =========================================================
 308
 309 * **Updated Mellanox mlx5 driver.**
 310
 311   Updated Mellanox mlx5 driver with new features and improvements, including:
 312
 313   * Added support for VLAN pop flow offload command.
 314   * Added support for VLAN push flow offload command.
 315   * Added support for VLAN set PCP offload command.
 316   * Added support for VLAN set VID offload command.
 317