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 * **Added new telemetry mode for l3fwd-power application.**
 103
 104   Added telemetry mode to l3fwd-power application to report
 105   application level busyness, empty and full polls of rte_eth_rx_burst().
 106
 107
 108 Removed Items
 109 -------------
 110
 111 .. This section should contain removed items in this release. Sample format:
 112
 113    * Add a short 1-2 sentence description of the removed item
 114      in 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 * Removed KNI ethtool, CONFIG_RTE_KNI_KMOD_ETHTOOL, support.
 121
 122 * build: armv8 crypto extension is disabled.
 123
 124
 125 API Changes
 126 -----------
 127
 128 .. This section should contain API changes. Sample format:
 129
 130    * sample: Add a short 1-2 sentence description of the API change
 131      which was announced in the previous releases and made in this release.
 132      Start with a scope label like "ethdev:".
 133      Use fixed width quotes for ``function_names`` or ``struct_names``.
 134      Use the past tense.
 135
 136    This section is a comment. Do not overwrite or remove it.
 137    Also, make sure to start the actual text at the margin.
 138    =========================================================
 139
 140 * The network structures, definitions and functions have
 141   been prefixed by ``rte_`` to resolve conflicts with libc headers.
 142
 143
 144 ABI Changes
 145 -----------
 146
 147 .. This section should contain ABI changes. Sample format:
 148
 149    * sample: Add a short 1-2 sentence description of the ABI change
 150      which was announced in the previous releases and made in this release.
 151      Start with a scope label like "ethdev:".
 152      Use fixed width quotes for ``function_names`` or ``struct_names``.
 153      Use the past tense.
 154
 155    This section is a comment. Do not overwrite or remove it.
 156    Also, make sure to start the actual text at the margin.
 157    =========================================================
 158
 159
 160 Shared Library Versions
 161 -----------------------
 162
 163 .. Update any library version updated in this release
 164    and prepend with a ``+`` sign, like this:
 165
 166      libfoo.so.1
 167    + libupdated.so.2
 168      libbar.so.1
 169
 170    This section is a comment. Do not overwrite or remove it.
 171    =========================================================
 172
 173 The libraries prepended with a plus sign were incremented in this version.
 174
 175 .. code-block:: diff
 176
 177      librte_acl.so.2
 178      librte_bbdev.so.1
 179      librte_bitratestats.so.2
 180      librte_bpf.so.1
 181      librte_bus_dpaa.so.2
 182      librte_bus_fslmc.so.2
 183      librte_bus_ifpga.so.2
 184      librte_bus_pci.so.2
 185      librte_bus_vdev.so.2
 186      librte_bus_vmbus.so.2
 187      librte_cfgfile.so.2
 188      librte_cmdline.so.2
 189      librte_compressdev.so.1
 190      librte_cryptodev.so.7
 191      librte_distributor.so.1
 192      librte_eal.so.10
 193      librte_efd.so.1
 194      librte_ethdev.so.12
 195      librte_eventdev.so.6
 196      librte_flow_classify.so.1
 197      librte_gro.so.1
 198      librte_gso.so.1
 199      librte_hash.so.2
 200      librte_ip_frag.so.1
 201      librte_ipsec.so.1
 202      librte_jobstats.so.1
 203      librte_kni.so.2
 204      librte_kvargs.so.1
 205      librte_latencystats.so.1
 206      librte_lpm.so.2
 207      librte_mbuf.so.5
 208      librte_member.so.1
 209      librte_mempool.so.5
 210      librte_meter.so.3
 211      librte_metrics.so.1
 212      librte_net.so.1
 213      librte_pci.so.1
 214      librte_pdump.so.3
 215      librte_pipeline.so.3
 216      librte_pmd_bnxt.so.2
 217      librte_pmd_bond.so.2
 218      librte_pmd_i40e.so.2
 219      librte_pmd_ixgbe.so.2
 220      librte_pmd_dpaa2_qdma.so.1
 221      librte_pmd_ring.so.2
 222      librte_pmd_softnic.so.1
 223      librte_pmd_vhost.so.2
 224      librte_port.so.3
 225      librte_power.so.1
 226      librte_rawdev.so.1
 227      librte_rcu.so.1
 228      librte_reorder.so.1
 229      librte_ring.so.2
 230      librte_sched.so.2
 231      librte_security.so.2
 232      librte_stack.so.1
 233      librte_table.so.3
 234      librte_timer.so.1
 235      librte_vhost.so.4
 236
 237
 238 Known Issues
 239 ------------
 240
 241 .. This section should contain new known issues in this release. Sample format:
 242
 243    * **Add title in present tense with full stop.**
 244
 245      Add a short 1-2 sentence description of the known issue
 246      in the present tense. Add information on any known workarounds.
 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
 253 Tested Platforms
 254 ----------------
 255
 256 .. This section should contain a list of platforms that were tested
 257    with this release.
 258
 259    The format is:
 260
 261    * <vendor> platform with <vendor> <type of devices> combinations
 262
 263      * List of CPU
 264      * List of OS
 265      * List of devices
 266      * Other relevant details...
 267
 268    This section is a comment. Do not overwrite or remove it.
 269    Also, make sure to start the actual text at the margin.
 270    =========================================================
 271