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