e2c5ccbf7d90ddb9cfc956b4d049cac08f507dac
[dpdk.git] / 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   * Added FDIR and RSS for GTPoGRE, support filter based on GTPU TEID/QFI,
74     outer most L3 or inner most l3/l4. 
75
76 * **Updated Intel ice driver.**
77
78   * In AVX2 code, added the new RX and TX paths to use the HW offload
79     features. When the HW offload features are configured to be used, the
80     offload paths are chosen automatically. In parallel the support for HW
81     offload features was removed from the legacy AVX2 paths.
82   * Added Tx QoS TC bandwidth configuration in DCF.
83
84 * **Added support for Marvell CN10K SoC ethernet device.**
85
86   * Added net/cnxk driver which provides the support for the integrated ethernet
87     device.
88
89 * **Updated Mellanox mlx5 driver.**
90
91   * Added Sub-Function support based on auxiliary bus.
92   * Added support for meter hierarchy.
93   * Added support for metering policy actions of yellow color.
94   * Added support for metering trTCM RFC2698 and RFC4115.
95   * Added devargs options ``allow_duplicate_pattern``.
96   * Added matching on IPv4 Internet Header Length (IHL).
97   * Added support for matching on VXLAN header last 8-bits reserved field.
98   * Optimized multi-thread flow rule insertion rate.
99
100 * **Added Wangxun ngbe PMD.**
101
102   Added a new PMD driver for Wangxun 1 Gigabit Ethernet NICs.
103   See the :doc:`../nics/ngbe` for more details.
104
105 * **Updated Solarflare network PMD.**
106
107   Updated the Solarflare ``sfc_efx`` driver with changes including:
108
109   * Added COUNT action support for SN1000 NICs
110
111 * **Updated Intel QuickAssist crypto PMD.**
112
113   Added fourth generation of QuickAssist Technology(QAT) devices support.
114   Only symmetric crypto has been currently enabled, compression and asymmetric
115   crypto PMD will fail to create.
116
117 * **Added support for Marvell CNXK crypto driver.**
118
119   * Added cnxk crypto PMD which provides support for an integrated
120     crypto driver for CN9K and CN10K series of SOCs. Support for
121     symmetric crypto algorithms is added to both the PMDs.
122   * Added support for lookaside protocol (IPsec) offload in cn10k PMD.
123   * Added support for asymmetric crypto operations in cn9k and cn10k PMD.
124
125 * **Updated Marvell OCTEON TX crypto PMD.**
126
127   Added support for crypto adapter OP_FORWARD mode.
128
129 * **Added support for Nvidia crypto device driver.**
130
131   Added mlx5 crypto driver to support AES-XTS cipher operations.
132   The first device to support it is ConnectX-6.
133
134 * **Updated ISAL compress device PMD.**
135
136   The ISAL compress device PMD now supports Arm platforms.
137
138 * **Added Baseband PHY CNXK PMD.**
139
140   Added Baseband PHY PMD which allows to configure BPHY hardware block
141   comprising accelerators and DSPs specifically tailored for 5G/LTE inline
142   usecases. Configuration happens via standard rawdev enq/deq operations. See
143   the :doc:`../rawdevs/cnxk_bphy` rawdev guide for more details on this driver.
144
145 * **Added support for Marvell CN10K, CN9K, event Rx/Tx adapter.**
146
147   * Added Rx/Tx adapter support for event/cnxk when the ethernet device requested
148     is net/cnxk.
149   * Added support for event vectorization for Rx/Tx adapter.
150
151 * **Added cppc_cpufreq support to Power Management library.**
152
153   Added support for cppc_cpufreq driver which works on most arm64 platforms.
154
155 * **Added multi-queue support to Ethernet PMD Power Management**
156
157   The experimental PMD power management API now supports managing
158   multiple Ethernet Rx queues per lcore.
159
160
161 Removed Items
162 -------------
163
164 .. This section should contain removed items in this release. Sample format:
165
166    * Add a short 1-2 sentence description of the removed item
167      in the past tense.
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    =======================================================
172
173
174 API Changes
175 -----------
176
177 .. This section should contain API changes. Sample format:
178
179    * sample: Add a short 1-2 sentence description of the API change
180      which was announced in the previous releases and made in this release.
181      Start with a scope label like "ethdev:".
182      Use fixed width quotes for ``function_names`` or ``struct_names``.
183      Use the past tense.
184
185    This section is a comment. Do not overwrite or remove it.
186    Also, make sure to start the actual text at the margin.
187    =======================================================
188
189 * eal: ``rte_strscpy`` sets ``rte_errno`` to ``E2BIG`` in case of string
190   truncation.
191
192 * eal: ``rte_power_monitor`` and the ``rte_power_monitor_cond`` struct changed
193   to use a callback mechanism.
194
195 * rte_power: The experimental PMD power management API is no longer considered
196   to be thread safe; all Rx queues affected by the API will now need to be
197   stopped before making any changes to the power management scheme.
198
199
200 ABI Changes
201 -----------
202
203 .. This section should contain ABI changes. Sample format:
204
205    * sample: Add a short 1-2 sentence description of the ABI change
206      which was announced in the previous releases and made in this release.
207      Start with a scope label like "ethdev:".
208      Use fixed width quotes for ``function_names`` or ``struct_names``.
209      Use the past tense.
210
211    This section is a comment. Do not overwrite or remove it.
212    Also, make sure to start the actual text at the margin.
213    =======================================================
214
215 * No ABI change that would break compatibility with 20.11.
216
217
218 Known Issues
219 ------------
220
221 .. This section should contain new known issues in this release. Sample format:
222
223    * **Add title in present tense with full stop.**
224
225      Add a short 1-2 sentence description of the known issue
226      in the present tense. Add information on any known workarounds.
227
228    This section is a comment. Do not overwrite or remove it.
229    Also, make sure to start the actual text at the margin.
230    =======================================================
231
232
233 Tested Platforms
234 ----------------
235
236 .. This section should contain a list of platforms that were tested
237    with this release.
238
239    The format is:
240
241    * <vendor> platform with <vendor> <type of devices> combinations
242
243      * List of CPU
244      * List of OS
245      * List of devices
246      * Other relevant details...
247
248    This section is a comment. Do not overwrite or remove it.
249    Also, make sure to start the actual text at the margin.
250    =======================================================