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