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