doc/guides/rel_notes/release_21_08.rst

   1 .. SPDX-License-Identifier: BSD-3-Clause
   2    Copyright 2021 The DPDK contributors
   3
   4 .. include:: <isonum.txt>
   5
   6 DPDK Release 21.08
   7 ==================
   8
   9 .. **Read this first.**
  10
  11    The text in the sections below explains how to update the release notes.
  12
  13    Use proper spelling, capitalization and punctuation in all sections.
  14
  15    Variable and config names should be quoted as fixed width text:
  16    ``LIKE_THIS``.
  17
  18    Build the docs and view the output file to ensure the changes are correct::
  19
  20       make doc-guides-html
  21       xdg-open build/doc/html/guides/rel_notes/release_21_08.html
  22
  23
  24 New Features
  25 ------------
  26
  27 .. This section should contain new features added in this release.
  28    Sample format:
  29
  30    * **Add a title in the past tense with a full stop.**
  31
  32      Add a short 1-2 sentence description in the past tense.
  33      The description should be enough to allow someone scanning
  34      the release notes to understand the new feature.
  35
  36      If the feature adds a lot of sub-features you can use a bullet list
  37      like this:
  38
  39      * Added feature foo to do something.
  40      * Enhanced feature bar to do something else.
  41
  42      Refer to the previous release notes for examples.
  43
  44      Suggested order in release notes items:
  45      * Core libs (EAL, mempool, ring, mbuf, buses)
  46      * Device abstraction libs and PMDs (ordered alphabetically by vendor name)
  47        - ethdev (lib, PMDs)
  48        - cryptodev (lib, PMDs)
  49        - eventdev (lib, PMDs)
  50        - etc
  51      * Other libs
  52      * Apps, Examples, Tools (if significant)
  53
  54      This section is a comment. Do not overwrite or remove it.
  55      Also, make sure to start the actual text at the margin.
  56      =======================================================
  57
  58 * **Added auxiliary bus support.**
  59
  60   Auxiliary bus provides a way to split function into child-devices
  61   representing sub-domains of functionality. Each auxiliary device
  62   represents a part of its parent functionality.
  63
  64 * **Updated Intel iavf driver.**
  65
  66   * Added Tx QoS VF queue TC mapping.
  67
  68 * **Updated Intel ice driver.**
  69
  70   * In AVX2 code, added the new RX and TX paths to use the HW offload
  71     features. When the HW offload features are configured to be used, the
  72     offload paths are chosen automatically. In parallel the support for HW
  73     offload features was removed from the legacy AVX2 paths.
  74   * Added Tx QoS TC bandwidth configuration in DCF.
  75
  76 * **Added support for Marvell CN10K SoC ethernet device.**
  77
  78   * Added net/cnxk driver which provides the support for the integrated ethernet
  79     device.
  80
  81 * **Added Baseband PHY CNXK PMD.**
  82
  83   Added Baseband PHY PMD which allows to configure BPHY hardware block
  84   comprising accelerators and DSPs specifically tailored for 5G/LTE inline
  85   usecases. Configuration happens via standard rawdev enq/deq operations. See
  86   the :doc:`../rawdevs/cnxk_bphy` rawdev guide for more details on this driver.
  87
  88
  89 Removed Items
  90 -------------
  91
  92 .. This section should contain removed items in this release. Sample format:
  93
  94    * Add a short 1-2 sentence description of the removed item
  95      in the past tense.
  96
  97    This section is a comment. Do not overwrite or remove it.
  98    Also, make sure to start the actual text at the margin.
  99    =======================================================
 100
 101
 102 API Changes
 103 -----------
 104
 105 .. This section should contain API changes. Sample format:
 106
 107    * sample: Add a short 1-2 sentence description of the API change
 108      which was announced in the previous releases and made in this release.
 109      Start with a scope label like "ethdev:".
 110      Use fixed width quotes for ``function_names`` or ``struct_names``.
 111      Use the past tense.
 112
 113    This section is a comment. Do not overwrite or remove it.
 114    Also, make sure to start the actual text at the margin.
 115    =======================================================
 116
 117 * eal: ``rte_strscpy`` sets ``rte_errno`` to ``E2BIG`` in case of string
 118   truncation.
 119
 120
 121 ABI Changes
 122 -----------
 123
 124 .. This section should contain ABI changes. Sample format:
 125
 126    * sample: Add a short 1-2 sentence description of the ABI change
 127      which was announced in the previous releases and made in this release.
 128      Start with a scope label like "ethdev:".
 129      Use fixed width quotes for ``function_names`` or ``struct_names``.
 130      Use the past tense.
 131
 132    This section is a comment. Do not overwrite or remove it.
 133    Also, make sure to start the actual text at the margin.
 134    =======================================================
 135
 136 * No ABI change that would break compatibility with 20.11.
 137
 138
 139 Known Issues
 140 ------------
 141
 142 .. This section should contain new known issues in this release. Sample format:
 143
 144    * **Add title in present tense with full stop.**
 145
 146      Add a short 1-2 sentence description of the known issue
 147      in the present tense. Add information on any known workarounds.
 148
 149    This section is a comment. Do not overwrite or remove it.
 150    Also, make sure to start the actual text at the margin.
 151    =======================================================
 152
 153
 154 Tested Platforms
 155 ----------------
 156
 157 .. This section should contain a list of platforms that were tested
 158    with this release.
 159
 160    The format is:
 161
 162    * <vendor> platform with <vendor> <type of devices> combinations
 163
 164      * List of CPU
 165      * List of OS
 166      * List of devices
 167      * Other relevant details...
 168
 169    This section is a comment. Do not overwrite or remove it.
 170    Also, make sure to start the actual text at the margin.
 171    =======================================================