doc/guides/rel_notes/release_19_08.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright 2019 The DPDK contributors
   3
   4 DPDK Release 19.08
   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_08.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 the bnxt PMD.**
  58
  59   Updated the bnxt PMD. The major enhancements include:
  60
  61   * Performance optimizations in non-vector Tx path
  62   * Added support for SSE vector mode
  63   * Updated HWRM API to version 1.10.0.74
  64
  65 * **Added support for Broadcom NetXtreme-E BCM57500 Ethernet controllers.**
  66
  67   Added support to the bnxt PMD for the BCM57500 (a.k.a. "Thor") family
  68   of Ethernet controllers. These controllers support link speeds up to
  69   200Gbps, 50G PAM-4, and PCIe 4.0.
  70
  71 * **Updated the ice driver.**
  72
  73   Updated ice driver with new features and improvements, including:
  74
  75   * Enabled Tx outer/inner L3/L4 checksum offload.
  76
  77 * **Updated Solarflare network PMD.**
  78
  79   Updated the Solarflare ``sfc_efx`` driver with changes including:
  80
  81   * Added support for Rx interrupts.
  82
  83 * **Added memif PMD.**
  84
  85   Added the new Shared Memory Packet Interface (``memif``) PMD.
  86   See the :doc:`../nics/memif` guide for more details on this new driver.
  87
  88 * **Updated the AF_XDP PMD.**
  89
  90   Updated the AF_XDP PMD. The new features include:
  91
  92   * Enabled zero copy through mbuf's external memory mechanism to achieve
  93     high performance
  94   * Added multi-queue support to allow one af_xdp vdev with multiple netdev
  95     queues
  96
  97 * **Updated telemetry library for global metrics support.**
  98
  99   Updated ``librte_telemetry`` to fetch the global metrics from the
 100   ``librte_metrics`` library.
 101
 102
 103 Removed Items
 104 -------------
 105
 106 .. This section should contain removed items in this release. Sample format:
 107
 108    * Add a short 1-2 sentence description of the removed item
 109      in the past tense.
 110
 111    This section is a comment. Do not overwrite or remove it.
 112    Also, make sure to start the actual text at the margin.
 113    =========================================================
 114
 115 * Removed KNI ethtool, CONFIG_RTE_KNI_KMOD_ETHTOOL, support.
 116
 117 * build: armv8 crypto extension is disabled.
 118
 119
 120 API Changes
 121 -----------
 122
 123 .. This section should contain API changes. Sample format:
 124
 125    * sample: Add a short 1-2 sentence description of the API change
 126      which was announced in the previous releases and made in this release.
 127      Start with a scope label like "ethdev:".
 128      Use fixed width quotes for ``function_names`` or ``struct_names``.
 129      Use the past tense.
 130
 131    This section is a comment. Do not overwrite or remove it.
 132    Also, make sure to start the actual text at the margin.
 133    =========================================================
 134
 135 * The network structures, definitions and functions have
 136   been prefixed by ``rte_`` to resolve conflicts with libc headers.
 137
 138
 139 ABI Changes
 140 -----------
 141
 142 .. This section should contain ABI changes. Sample format:
 143
 144    * sample: Add a short 1-2 sentence description of the ABI change
 145      which was announced in the previous releases and made in this release.
 146      Start with a scope label like "ethdev:".
 147      Use fixed width quotes for ``function_names`` or ``struct_names``.
 148      Use the past tense.
 149
 150    This section is a comment. Do not overwrite or remove it.
 151    Also, make sure to start the actual text at the margin.
 152    =========================================================
 153
 154
 155 Shared Library Versions
 156 -----------------------
 157
 158 .. Update any library version updated in this release
 159    and prepend with a ``+`` sign, like this:
 160
 161      libfoo.so.1
 162    + libupdated.so.2
 163      libbar.so.1
 164
 165    This section is a comment. Do not overwrite or remove it.
 166    =========================================================
 167
 168 The libraries prepended with a plus sign were incremented in this version.
 169
 170 .. code-block:: diff
 171
 172      librte_acl.so.2
 173      librte_bbdev.so.1
 174      librte_bitratestats.so.2
 175      librte_bpf.so.1
 176      librte_bus_dpaa.so.2
 177      librte_bus_fslmc.so.2
 178      librte_bus_ifpga.so.2
 179      librte_bus_pci.so.2
 180      librte_bus_vdev.so.2
 181      librte_bus_vmbus.so.2
 182      librte_cfgfile.so.2
 183      librte_cmdline.so.2
 184      librte_compressdev.so.1
 185      librte_cryptodev.so.7
 186      librte_distributor.so.1
 187      librte_eal.so.10
 188      librte_efd.so.1
 189      librte_ethdev.so.12
 190      librte_eventdev.so.6
 191      librte_flow_classify.so.1
 192      librte_gro.so.1
 193      librte_gso.so.1
 194      librte_hash.so.2
 195      librte_ip_frag.so.1
 196      librte_ipsec.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.3
 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_rcu.so.1
 223      librte_reorder.so.1
 224      librte_ring.so.2
 225      librte_sched.so.2
 226      librte_security.so.2
 227      librte_stack.so.1
 228      librte_table.so.3
 229      librte_timer.so.1
 230      librte_vhost.so.4
 231
 232
 233 Known Issues
 234 ------------
 235
 236 .. This section should contain new known issues in this release. Sample format:
 237
 238    * **Add title in present tense with full stop.**
 239
 240      Add a short 1-2 sentence description of the known issue
 241      in the present tense. Add information on any known workarounds.
 242
 243    This section is a comment. Do not overwrite or remove it.
 244    Also, make sure to start the actual text at the margin.
 245    =========================================================
 246
 247
 248 Tested Platforms
 249 ----------------
 250
 251 .. This section should contain a list of platforms that were tested
 252    with this release.
 253
 254    The format is:
 255
 256    * <vendor> platform with <vendor> <type of devices> combinations
 257
 258      * List of CPU
 259      * List of OS
 260      * List of devices
 261      * Other relevant details...
 262
 263    This section is a comment. Do not overwrite or remove it.
 264    Also, make sure to start the actual text at the margin.
 265    =========================================================
 266