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 * **Updated Mellanox mlx5 driver.**
  88
  89   * Added support for meter hierarchy.
  90   * Added devargs options ``allow_duplicate_pattern``.
  91
  92 * **Added support for Marvell CNXK crypto driver.**
  93
  94   * Added cnxk crypto PMD which provides support for an integrated
  95     crypto driver for CN9K and CN10K series of SOCs. Support for
  96     symmetric crypto algorithms is added to both the PMDs.
  97   * Added support for lookaside protocol (IPsec) offload in cn10k PMD.
  98   * Added support for asymmetric crypto operations in cn9k and cn10k PMD.
  99
 100 * **Updated Marvell OCTEON TX crypto PMD.**
 101
 102   Added support for crypto adapter OP_FORWARD mode.
 103
 104 * **Added Baseband PHY CNXK PMD.**
 105
 106   Added Baseband PHY PMD which allows to configure BPHY hardware block
 107   comprising accelerators and DSPs specifically tailored for 5G/LTE inline
 108   usecases. Configuration happens via standard rawdev enq/deq operations. See
 109   the :doc:`../rawdevs/cnxk_bphy` rawdev guide for more details on this driver.
 110
 111 * **Added cppc_cpufreq support to Power Management library.**
 112
 113   Added support for cppc_cpufreq driver which works on most arm64 platforms.
 114
 115
 116 Removed Items
 117 -------------
 118
 119 .. This section should contain removed items in this release. Sample format:
 120
 121    * Add a short 1-2 sentence description of the removed item
 122      in the past tense.
 123
 124    This section is a comment. Do not overwrite or remove it.
 125    Also, make sure to start the actual text at the margin.
 126    =======================================================
 127
 128
 129 API Changes
 130 -----------
 131
 132 .. This section should contain API changes. Sample format:
 133
 134    * sample: Add a short 1-2 sentence description of the API change
 135      which was announced in the previous releases and made in this release.
 136      Start with a scope label like "ethdev:".
 137      Use fixed width quotes for ``function_names`` or ``struct_names``.
 138      Use the past tense.
 139
 140    This section is a comment. Do not overwrite or remove it.
 141    Also, make sure to start the actual text at the margin.
 142    =======================================================
 143
 144 * eal: ``rte_strscpy`` sets ``rte_errno`` to ``E2BIG`` in case of string
 145   truncation.
 146
 147
 148 ABI Changes
 149 -----------
 150
 151 .. This section should contain ABI changes. Sample format:
 152
 153    * sample: Add a short 1-2 sentence description of the ABI change
 154      which was announced in the previous releases and made in this release.
 155      Start with a scope label like "ethdev:".
 156      Use fixed width quotes for ``function_names`` or ``struct_names``.
 157      Use the past tense.
 158
 159    This section is a comment. Do not overwrite or remove it.
 160    Also, make sure to start the actual text at the margin.
 161    =======================================================
 162
 163 * No ABI change that would break compatibility with 20.11.
 164
 165
 166 Known Issues
 167 ------------
 168
 169 .. This section should contain new known issues in this release. Sample format:
 170
 171    * **Add title in present tense with full stop.**
 172
 173      Add a short 1-2 sentence description of the known issue
 174      in the present tense. Add information on any known workarounds.
 175
 176    This section is a comment. Do not overwrite or remove it.
 177    Also, make sure to start the actual text at the margin.
 178    =======================================================
 179
 180
 181 Tested Platforms
 182 ----------------
 183
 184 .. This section should contain a list of platforms that were tested
 185    with this release.
 186
 187    The format is:
 188
 189    * <vendor> platform with <vendor> <type of devices> combinations
 190
 191      * List of CPU
 192      * List of OS
 193      * List of devices
 194      * Other relevant details...
 195
 196    This section is a comment. Do not overwrite or remove it.
 197    Also, make sure to start the actual text at the margin.
 198    =======================================================