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 IPsec library.**
  99
 100   The IPsec library has been updated with AES-CTR and 3DES-CBC cipher algorithms
 101   support. The related ipsec-secgw test scripts have been added.
 102
 103 * **Updated the testpmd application.**
 104
 105   Improved testpmd application performance on ARM platform. For ``macswap``
 106   forwarding mode, NEON intrinsics were used to do swap to save CPU cycles.
 107
 108
 109 Removed Items
 110 -------------
 111
 112 .. This section should contain removed items in this release. Sample format:
 113
 114    * Add a short 1-2 sentence description of the removed item
 115      in the past tense.
 116
 117    This section is a comment. Do not overwrite or remove it.
 118    Also, make sure to start the actual text at the margin.
 119    =========================================================
 120
 121
 122 API Changes
 123 -----------
 124
 125 .. This section should contain API changes. Sample format:
 126
 127    * sample: Add a short 1-2 sentence description of the API change
 128      which was announced in the previous releases and made in this release.
 129      Start with a scope label like "ethdev:".
 130      Use fixed width quotes for ``function_names`` or ``struct_names``.
 131      Use the past tense.
 132
 133    This section is a comment. Do not overwrite or remove it.
 134    Also, make sure to start the actual text at the margin.
 135    =========================================================
 136
 137 * eal: the type of the ``attr_value`` parameter of the function
 138   ``rte_service_attr_get()`` has been changed
 139   from ``uint32_t *`` to ``uint64_t *``.
 140
 141
 142 ABI Changes
 143 -----------
 144
 145 .. This section should contain ABI changes. Sample format:
 146
 147    * sample: Add a short 1-2 sentence description of the ABI change
 148      which was announced in the previous releases and made in this release.
 149      Start with a scope label like "ethdev:".
 150      Use fixed width quotes for ``function_names`` or ``struct_names``.
 151      Use the past tense.
 152
 153    This section is a comment. Do not overwrite or remove it.
 154    Also, make sure to start the actual text at the margin.
 155    =========================================================
 156
 157 * cryptodev: in 18.08 new structure ``rte_crypto_asym_op`` was introduced and
 158   included into ``rte_crypto_op``. As ``rte_crypto_asym_op`` structure was
 159   defined as cache-line aligned that caused unintended changes in
 160   ``rte_crypto_op`` structure layout and alignment. Remove cache-line
 161   alignment for ``rte_crypto_asym_op`` to restore expected ``rte_crypto_op``
 162   layout and alignment.
 163
 164
 165 Shared Library Versions
 166 -----------------------
 167
 168 .. Update any library version updated in this release
 169    and prepend with a ``+`` sign, like this:
 170
 171      libfoo.so.1
 172    + libupdated.so.2
 173      libbar.so.1
 174
 175    This section is a comment. Do not overwrite or remove it.
 176    =========================================================
 177
 178 The libraries prepended with a plus sign were incremented in this version.
 179
 180 .. code-block:: diff
 181
 182      librte_acl.so.2
 183      librte_bbdev.so.1
 184      librte_bitratestats.so.2
 185      librte_bpf.so.1
 186      librte_bus_dpaa.so.2
 187      librte_bus_fslmc.so.2
 188      librte_bus_ifpga.so.2
 189      librte_bus_pci.so.2
 190      librte_bus_vdev.so.2
 191      librte_bus_vmbus.so.2
 192      librte_cfgfile.so.2
 193      librte_cmdline.so.2
 194      librte_compressdev.so.1
 195    + librte_cryptodev.so.7
 196      librte_distributor.so.1
 197    + librte_eal.so.10
 198      librte_efd.so.1
 199      librte_ethdev.so.11
 200      librte_eventdev.so.6
 201      librte_flow_classify.so.1
 202      librte_gro.so.1
 203      librte_gso.so.1
 204      librte_hash.so.2
 205      librte_ip_frag.so.1
 206      librte_jobstats.so.1
 207      librte_kni.so.2
 208      librte_kvargs.so.1
 209      librte_latencystats.so.1
 210      librte_lpm.so.2
 211      librte_mbuf.so.5
 212      librte_member.so.1
 213      librte_mempool.so.5
 214      librte_meter.so.2
 215      librte_metrics.so.1
 216      librte_net.so.1
 217      librte_pci.so.1
 218      librte_pdump.so.3
 219      librte_pipeline.so.3
 220      librte_pmd_bnxt.so.2
 221      librte_pmd_bond.so.2
 222      librte_pmd_i40e.so.2
 223      librte_pmd_ixgbe.so.2
 224      librte_pmd_dpaa2_qdma.so.1
 225      librte_pmd_ring.so.2
 226      librte_pmd_softnic.so.1
 227      librte_pmd_vhost.so.2
 228      librte_port.so.3
 229      librte_power.so.1
 230      librte_rawdev.so.1
 231      librte_reorder.so.1
 232      librte_ring.so.2
 233      librte_sched.so.2
 234      librte_security.so.2
 235      librte_table.so.3
 236      librte_timer.so.1
 237      librte_vhost.so.4
 238
 239
 240 Known Issues
 241 ------------
 242
 243 .. This section should contain new known issues in this release. Sample format:
 244
 245    * **Add title in present tense with full stop.**
 246
 247      Add a short 1-2 sentence description of the known issue
 248      in the present tense. Add information on any known workarounds.
 249
 250    This section is a comment. Do not overwrite or remove it.
 251    Also, make sure to start the actual text at the margin.
 252    =========================================================
 253
 254 * **No software AES-XTS implementation.**
 255
 256   There are currently no cryptodev software PMDs available which implement
 257   support for the AES-XTS algorithm, so this feature can only be used
 258   if compatible hardware and an associated PMD is available.
 259
 260
 261 Tested Platforms
 262 ----------------
 263
 264 .. This section should contain a list of platforms that were tested
 265    with this release.
 266
 267    The format is:
 268
 269    * <vendor> platform with <vendor> <type of devices> combinations
 270
 271      * List of CPU
 272      * List of OS
 273      * List of devices
 274      * Other relevant details...
 275
 276    This section is a comment. Do not overwrite or remove it.
 277    Also, make sure to start the actual text at the margin.
 278    =========================================================