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 KNI module and PMD.**
  58
  59   Updated the KNI kernel module to set the max_mtu according to the given
  60   initial MTU size. Without it, the maximum MTU was 1500.
  61
  62   Updated the KNI PMD driver to set the mbuf_size and MTU based on
  63   the given mb-pool. This provide the ability to pass jumbo frames
  64   if the mb-pool contains suitable buffers' size.
  65
  66 * **Updated Solarflare network PMD.**
  67
  68   Updated the sfc_efx driver including the following changes:
  69
  70   * Added support for Rx descriptor status and related API in a secondary
  71     process.
  72   * Added support for Tx descriptor status API in a secondary process.
  73   * Added support for RSS RETA and hash configuration get API in a secondary
  74     process.
  75   * Added support for Rx packet types list in a secondary process.
  76
  77 * **Updated Mellanox drivers.**
  78
  79    New features and improvements were done in mlx4 and mlx5 PMDs:
  80
  81    * Added firmware version reading.
  82
  83 * **Renamed avf to iavf.**
  84
  85   Renamed Intel Ethernet Adaptive Virtual Function driver ``avf`` to ``iavf``,
  86   which includes the directory name, lib name, filenames, makefile, docs,
  87   macros, functions, structs and any other strings in the code.
  88
  89 * **Updated the enic driver.**
  90
  91   * Fixed several flow (director) bugs related to MARK, SCTP, VLAN, VXLAN, and
  92     inner packet matching.
  93   * Added limited support for RAW.
  94   * Added limited support for RSS.
  95   * Added limited support for PASSTHRU.
  96
  97 * **Updated the ixgbe driver.**
  98
  99   New features for VF:
 100
 101   * Added promiscuous mode support.
 102
 103 * **Updated the QuickAssist Technology PMD.**
 104
 105   Added support for AES-XTS with 128 and 256 bit AES keys.
 106
 107 * **Updated the IPsec library.**
 108
 109   The IPsec library has been updated with AES-CTR and 3DES-CBC cipher algorithms
 110   support. The related ipsec-secgw test scripts have been added.
 111
 112 * **Updated the testpmd application.**
 113
 114   Improved testpmd application performance on ARM platform. For ``macswap``
 115   forwarding mode, NEON intrinsics were used to do swap to save CPU cycles.
 116
 117
 118 Removed Items
 119 -------------
 120
 121 .. This section should contain removed items in this release. Sample format:
 122
 123    * Add a short 1-2 sentence description of the removed item
 124      in the past tense.
 125
 126    This section is a comment. Do not overwrite or remove it.
 127    Also, make sure to start the actual text at the margin.
 128    =========================================================
 129
 130
 131 API Changes
 132 -----------
 133
 134 .. This section should contain API changes. Sample format:
 135
 136    * sample: Add a short 1-2 sentence description of the API change
 137      which was announced in the previous releases and made in this release.
 138      Start with a scope label like "ethdev:".
 139      Use fixed width quotes for ``function_names`` or ``struct_names``.
 140      Use the past tense.
 141
 142    This section is a comment. Do not overwrite or remove it.
 143    Also, make sure to start the actual text at the margin.
 144    =========================================================
 145
 146 * eal: the type of the ``attr_value`` parameter of the function
 147   ``rte_service_attr_get()`` has been changed
 148   from ``uint32_t *`` to ``uint64_t *``.
 149
 150
 151 ABI Changes
 152 -----------
 153
 154 .. This section should contain ABI changes. Sample format:
 155
 156    * sample: Add a short 1-2 sentence description of the ABI change
 157      which was announced in the previous releases and made in this release.
 158      Start with a scope label like "ethdev:".
 159      Use fixed width quotes for ``function_names`` or ``struct_names``.
 160      Use the past tense.
 161
 162    This section is a comment. Do not overwrite or remove it.
 163    Also, make sure to start the actual text at the margin.
 164    =========================================================
 165
 166 * cryptodev: in 18.08 new structure ``rte_crypto_asym_op`` was introduced and
 167   included into ``rte_crypto_op``. As ``rte_crypto_asym_op`` structure was
 168   defined as cache-line aligned that caused unintended changes in
 169   ``rte_crypto_op`` structure layout and alignment. Remove cache-line
 170   alignment for ``rte_crypto_asym_op`` to restore expected ``rte_crypto_op``
 171   layout and alignment.
 172
 173
 174 Shared Library Versions
 175 -----------------------
 176
 177 .. Update any library version updated in this release
 178    and prepend with a ``+`` sign, like this:
 179
 180      libfoo.so.1
 181    + libupdated.so.2
 182      libbar.so.1
 183
 184    This section is a comment. Do not overwrite or remove it.
 185    =========================================================
 186
 187 The libraries prepended with a plus sign were incremented in this version.
 188
 189 .. code-block:: diff
 190
 191      librte_acl.so.2
 192      librte_bbdev.so.1
 193      librte_bitratestats.so.2
 194      librte_bpf.so.1
 195      librte_bus_dpaa.so.2
 196      librte_bus_fslmc.so.2
 197      librte_bus_ifpga.so.2
 198      librte_bus_pci.so.2
 199      librte_bus_vdev.so.2
 200      librte_bus_vmbus.so.2
 201      librte_cfgfile.so.2
 202      librte_cmdline.so.2
 203      librte_compressdev.so.1
 204    + librte_cryptodev.so.7
 205      librte_distributor.so.1
 206    + librte_eal.so.10
 207      librte_efd.so.1
 208      librte_ethdev.so.11
 209      librte_eventdev.so.6
 210      librte_flow_classify.so.1
 211      librte_gro.so.1
 212      librte_gso.so.1
 213      librte_hash.so.2
 214      librte_ip_frag.so.1
 215      librte_jobstats.so.1
 216      librte_kni.so.2
 217      librte_kvargs.so.1
 218      librte_latencystats.so.1
 219      librte_lpm.so.2
 220      librte_mbuf.so.5
 221      librte_member.so.1
 222      librte_mempool.so.5
 223      librte_meter.so.2
 224      librte_metrics.so.1
 225      librte_net.so.1
 226      librte_pci.so.1
 227      librte_pdump.so.3
 228      librte_pipeline.so.3
 229      librte_pmd_bnxt.so.2
 230      librte_pmd_bond.so.2
 231      librte_pmd_i40e.so.2
 232      librte_pmd_ixgbe.so.2
 233      librte_pmd_dpaa2_qdma.so.1
 234      librte_pmd_ring.so.2
 235      librte_pmd_softnic.so.1
 236      librte_pmd_vhost.so.2
 237      librte_port.so.3
 238      librte_power.so.1
 239      librte_rawdev.so.1
 240      librte_reorder.so.1
 241      librte_ring.so.2
 242      librte_sched.so.2
 243      librte_security.so.2
 244      librte_table.so.3
 245      librte_timer.so.1
 246      librte_vhost.so.4
 247
 248
 249 Known Issues
 250 ------------
 251
 252 .. This section should contain new known issues in this release. Sample format:
 253
 254    * **Add title in present tense with full stop.**
 255
 256      Add a short 1-2 sentence description of the known issue
 257      in the present tense. Add information on any known workarounds.
 258
 259    This section is a comment. Do not overwrite or remove it.
 260    Also, make sure to start the actual text at the margin.
 261    =========================================================
 262
 263 * **No software AES-XTS implementation.**
 264
 265   There are currently no cryptodev software PMDs available which implement
 266   support for the AES-XTS algorithm, so this feature can only be used
 267   if compatible hardware and an associated PMD is available.
 268
 269
 270 Tested Platforms
 271 ----------------
 272
 273 .. This section should contain a list of platforms that were tested
 274    with this release.
 275
 276    The format is:
 277
 278    * <vendor> platform with <vendor> <type of devices> combinations
 279
 280      * List of CPU
 281      * List of OS
 282      * List of devices
 283      * Other relevant details...
 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    =========================================================