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