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 * **Added XZ compressed firmware support.**
  65
  66   Using ``rte_firmware_read``, a driver can now handle XZ compressed firmware
  67   in a transparent way, with EAL uncompressing using libarchive if this library
  68   is available when building DPDK.
  69
  70 * **Updated Intel iavf driver.**
  71
  72   * Added Tx QoS VF queue TC mapping.
  73
  74 * **Updated Intel ice driver.**
  75
  76   * In AVX2 code, added the new RX and TX paths to use the HW offload
  77     features. When the HW offload features are configured to be used, the
  78     offload paths are chosen automatically. In parallel the support for HW
  79     offload features was removed from the legacy AVX2 paths.
  80   * Added Tx QoS TC bandwidth configuration in DCF.
  81
  82 * **Added support for Marvell CN10K SoC ethernet device.**
  83
  84   * Added net/cnxk driver which provides the support for the integrated ethernet
  85     device.
  86
  87 * **Added Baseband PHY CNXK PMD.**
  88
  89   Added Baseband PHY PMD which allows to configure BPHY hardware block
  90   comprising accelerators and DSPs specifically tailored for 5G/LTE inline
  91   usecases. Configuration happens via standard rawdev enq/deq operations. See
  92   the :doc:`../rawdevs/cnxk_bphy` rawdev guide for more details on this driver.
  93
  94
  95 Removed Items
  96 -------------
  97
  98 .. This section should contain removed items in this release. Sample format:
  99
 100    * Add a short 1-2 sentence description of the removed item
 101      in the past tense.
 102
 103    This section is a comment. Do not overwrite or remove it.
 104    Also, make sure to start the actual text at the margin.
 105    =======================================================
 106
 107
 108 API Changes
 109 -----------
 110
 111 .. This section should contain API changes. Sample format:
 112
 113    * sample: Add a short 1-2 sentence description of the API change
 114      which was announced in the previous releases and made in this release.
 115      Start with a scope label like "ethdev:".
 116      Use fixed width quotes for ``function_names`` or ``struct_names``.
 117      Use the past tense.
 118
 119    This section is a comment. Do not overwrite or remove it.
 120    Also, make sure to start the actual text at the margin.
 121    =======================================================
 122
 123 * eal: ``rte_strscpy`` sets ``rte_errno`` to ``E2BIG`` in case of string
 124   truncation.
 125
 126
 127 ABI Changes
 128 -----------
 129
 130 .. This section should contain ABI changes. Sample format:
 131
 132    * sample: Add a short 1-2 sentence description of the ABI change
 133      which was announced in the previous releases and made in this release.
 134      Start with a scope label like "ethdev:".
 135      Use fixed width quotes for ``function_names`` or ``struct_names``.
 136      Use the past tense.
 137
 138    This section is a comment. Do not overwrite or remove it.
 139    Also, make sure to start the actual text at the margin.
 140    =======================================================
 141
 142 * No ABI change that would break compatibility with 20.11.
 143
 144
 145 Known Issues
 146 ------------
 147
 148 .. This section should contain new known issues in this release. Sample format:
 149
 150    * **Add title in present tense with full stop.**
 151
 152      Add a short 1-2 sentence description of the known issue
 153      in the present tense. Add information on any known workarounds.
 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 Tested Platforms
 161 ----------------
 162
 163 .. This section should contain a list of platforms that were tested
 164    with this release.
 165
 166    The format is:
 167
 168    * <vendor> platform with <vendor> <type of devices> combinations
 169
 170      * List of CPU
 171      * List of OS
 172      * List of devices
 173      * Other relevant details...
 174
 175    This section is a comment. Do not overwrite or remove it.
 176    Also, make sure to start the actual text at the margin.
 177    =======================================================