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