doc/guides/rel_notes/release_19_05.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2019 The DPDK contributors
   3
   4 DPDK Release 19.05
   5 ==================
   6
   7 .. **Read this first.**
   8
   9    The text in the sections below explains how to update the release notes.
  10
  11    Use proper spelling, capitalization and punctuation in all sections.
  12
  13    Variable and config names should be quoted as fixed width text:
  14    ``LIKE_THIS``.
  15
  16    Build the docs and view the output file to ensure the changes are correct::
  17
  18       make doc-guides-html
  19
  20       xdg-open build/doc/html/guides/rel_notes/release_19_05.html
  21
  22
  23 New Features
  24 ------------
  25
  26 .. This section should contain new features added in this release.
  27    Sample format:
  28
  29    * **Add a title in the past tense with a full stop.**
  30
  31      Add a short 1-2 sentence description in the past tense.
  32      The description should be enough to allow someone scanning
  33      the release notes to understand the new feature.
  34
  35      If the feature adds a lot of sub-features you can use a bullet list
  36      like this:
  37
  38      * Added feature foo to do something.
  39      * Enhanced feature bar to do something else.
  40
  41      Refer to the previous release notes for examples.
  42
  43      Suggested order in release notes items:
  44      * Core libs (EAL, mempool, ring, mbuf, buses)
  45      * Device abstraction libs and PMDs
  46        - ethdev (lib, PMDs)
  47        - cryptodev (lib, PMDs)
  48        - eventdev (lib, PMDs)
  49        - etc
  50      * Other libs
  51      * Apps, Examples, Tools (if significant)
  52
  53      This section is a comment. Do not overwrite or remove it.
  54      Also, make sure to start the actual text at the margin.
  55      =========================================================
  56
  57 * **Updated Solarflare network PMD.**
  58
  59   Updated the sfc_efx driver including the following changes:
  60
  61   * Added support for Rx descriptor status and related API in a secondary
  62     process.
  63   * Added support for Tx descriptor status API in a secondary process.
  64   * Added support for RSS RETA and hash configuration get API in a secondary
  65     process.
  66   * Added support for Rx packet types list in a secondary process.
  67
  68 * **Updated Mellanox drivers.**
  69
  70    New features and improvements were done in mlx4 and mlx5 PMDs:
  71
  72    * Added firmware version reading.
  73
  74 * **Renamed avf to iavf.**
  75
  76   Renamed Intel Ethernet Adaptive Virtual Function driver ``avf`` to ``iavf``,
  77   which includes the directory name, lib name, filenames, makefile, docs,
  78   macros, functions, structs and any other strings in the code.
  79
  80 * **Updated the enic driver.**
  81
  82   * Fixed several flow (director) bugs related to MARK, SCTP, VLAN, VXLAN, and
  83     inner packet matching.
  84   * Added limited support for RAW.
  85   * Added limited support for RSS.
  86   * Added limited support for PASSTHRU.
  87
  88 * **Updated the ixgbe driver.**
  89
  90   New features for VF:
  91
  92   * Added promiscuous mode support.
  93
  94 * **Updated the QuickAssist Technology PMD.**
  95
  96   Added support for AES-XTS with 128 and 256 bit AES keys.
  97
  98 * **Updated the testpmd application.**
  99
 100   Improved testpmd application performance on ARM platform. For ``macswap``
 101   forwarding mode, NEON intrinsics were used to do swap to save CPU cycles.
 102
 103
 104 Removed Items
 105 -------------
 106
 107 .. This section should contain removed items in this release. Sample format:
 108
 109    * Add a short 1-2 sentence description of the removed item
 110      in the past tense.
 111
 112    This section is a comment. Do not overwrite or remove it.
 113    Also, make sure to start the actual text at the margin.
 114    =========================================================
 115
 116
 117 API Changes
 118 -----------
 119
 120 .. This section should contain API changes. Sample format:
 121
 122    * sample: Add a short 1-2 sentence description of the API change
 123      which was announced in the previous releases and made in this release.
 124      Start with a scope label like "ethdev:".
 125      Use fixed width quotes for ``function_names`` or ``struct_names``.
 126      Use the past tense.
 127
 128    This section is a comment. Do not overwrite or remove it.
 129    Also, make sure to start the actual text at the margin.
 130    =========================================================
 131
 132
 133 ABI Changes
 134 -----------
 135
 136 .. This section should contain ABI changes. Sample format:
 137
 138    * sample: Add a short 1-2 sentence description of the ABI change
 139      which was announced in the previous releases and made in this release.
 140      Start with a scope label like "ethdev:".
 141      Use fixed width quotes for ``function_names`` or ``struct_names``.
 142      Use the past tense.
 143
 144    This section is a comment. Do not overwrite or remove it.
 145    Also, make sure to start the actual text at the margin.
 146    =========================================================
 147
 148 * cryptodev: in 18.08 new structure ``rte_crypto_asym_op`` was introduced and
 149   included into ``rte_crypto_op``. As ``rte_crypto_asym_op`` structure was
 150   defined as cache-line aligned that caused unintended changes in
 151   ``rte_crypto_op`` structure layout and alignment. Remove cache-line
 152   alignment for ``rte_crypto_asym_op`` to restore expected ``rte_crypto_op``
 153   layout and alignment.
 154
 155
 156 Shared Library Versions
 157 -----------------------
 158
 159 .. Update any library version updated in this release
 160    and prepend with a ``+`` sign, like this:
 161
 162      libfoo.so.1
 163    + libupdated.so.2
 164      libbar.so.1
 165
 166    This section is a comment. Do not overwrite or remove it.
 167    =========================================================
 168
 169 The libraries prepended with a plus sign were incremented in this version.
 170
 171 .. code-block:: diff
 172
 173      librte_acl.so.2
 174      librte_bbdev.so.1
 175      librte_bitratestats.so.2
 176      librte_bpf.so.1
 177      librte_bus_dpaa.so.2
 178      librte_bus_fslmc.so.2
 179      librte_bus_ifpga.so.2
 180      librte_bus_pci.so.2
 181      librte_bus_vdev.so.2
 182      librte_bus_vmbus.so.2
 183      librte_cfgfile.so.2
 184      librte_cmdline.so.2
 185      librte_compressdev.so.1
 186    + librte_cryptodev.so.7
 187      librte_distributor.so.1
 188      librte_eal.so.9
 189      librte_efd.so.1
 190      librte_ethdev.so.11
 191      librte_eventdev.so.6
 192      librte_flow_classify.so.1
 193      librte_gro.so.1
 194      librte_gso.so.1
 195      librte_hash.so.2
 196      librte_ip_frag.so.1
 197      librte_jobstats.so.1
 198      librte_kni.so.2
 199      librte_kvargs.so.1
 200      librte_latencystats.so.1
 201      librte_lpm.so.2
 202      librte_mbuf.so.5
 203      librte_member.so.1
 204      librte_mempool.so.5
 205      librte_meter.so.2
 206      librte_metrics.so.1
 207      librte_net.so.1
 208      librte_pci.so.1
 209      librte_pdump.so.3
 210      librte_pipeline.so.3
 211      librte_pmd_bnxt.so.2
 212      librte_pmd_bond.so.2
 213      librte_pmd_i40e.so.2
 214      librte_pmd_ixgbe.so.2
 215      librte_pmd_dpaa2_qdma.so.1
 216      librte_pmd_ring.so.2
 217      librte_pmd_softnic.so.1
 218      librte_pmd_vhost.so.2
 219      librte_port.so.3
 220      librte_power.so.1
 221      librte_rawdev.so.1
 222      librte_reorder.so.1
 223      librte_ring.so.2
 224      librte_sched.so.2
 225      librte_security.so.2
 226      librte_table.so.3
 227      librte_timer.so.1
 228      librte_vhost.so.4
 229
 230
 231 Known Issues
 232 ------------
 233
 234 .. This section should contain new known issues in this release. Sample format:
 235
 236    * **Add title in present tense with full stop.**
 237
 238      Add a short 1-2 sentence description of the known issue
 239      in the present tense. Add information on any known workarounds.
 240
 241    This section is a comment. Do not overwrite or remove it.
 242    Also, make sure to start the actual text at the margin.
 243    =========================================================
 244
 245 * **No software AES-XTS implementation.**
 246
 247   There are currently no cryptodev software PMDs available which implement
 248   support for the AES-XTS algorithm, so this feature can only be used
 249   if compatible hardware and an associated PMD is available.
 250
 251
 252 Tested Platforms
 253 ----------------
 254
 255 .. This section should contain a list of platforms that were tested
 256    with this release.
 257
 258    The format is:
 259
 260    * <vendor> platform with <vendor> <type of devices> combinations
 261
 262      * List of CPU
 263      * List of OS
 264      * List of devices
 265      * Other relevant details...
 266
 267    This section is a comment. Do not overwrite or remove it.
 268    Also, make sure to start the actual text at the margin.
 269    =========================================================