e831c294ca4b0775c4005fe431165cdd828b996f
[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 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 support for meter hierarchy.
92   * Added devargs options ``allow_duplicate_pattern``.
93   * Added matching on IPv4 Internet Header Length (IHL).
94   * Added support for matching on VXLAN header last 8-bits reserved field.
95   * Optimized multi-thread flow rule insertion rate.
96
97 * **Added Wangxun ngbe PMD.**
98
99   Added a new PMD driver for Wangxun 1 Gigabit Ethernet NICs.
100   See the :doc:`../nics/ngbe` for more details.
101
102 * **Added support for Marvell CNXK crypto driver.**
103
104   * Added cnxk crypto PMD which provides support for an integrated
105     crypto driver for CN9K and CN10K series of SOCs. Support for
106     symmetric crypto algorithms is added to both the PMDs.
107   * Added support for lookaside protocol (IPsec) offload in cn10k PMD.
108   * Added support for asymmetric crypto operations in cn9k and cn10k PMD.
109
110 * **Updated Marvell OCTEON TX crypto PMD.**
111
112   Added support for crypto adapter OP_FORWARD mode.
113
114 * **Added Baseband PHY CNXK PMD.**
115
116   Added Baseband PHY PMD which allows to configure BPHY hardware block
117   comprising accelerators and DSPs specifically tailored for 5G/LTE inline
118   usecases. Configuration happens via standard rawdev enq/deq operations. See
119   the :doc:`../rawdevs/cnxk_bphy` rawdev guide for more details on this driver.
120
121 * **Added cppc_cpufreq support to Power Management library.**
122
123   Added support for cppc_cpufreq driver which works on most arm64 platforms.
124
125 * **Added multi-queue support to Ethernet PMD Power Management**
126
127   The experimental PMD power management API now supports managing
128   multiple Ethernet Rx queues per lcore.
129
130
131 Removed Items
132 -------------
133
134 .. This section should contain removed items in this release. Sample format:
135
136    * Add a short 1-2 sentence description of the removed item
137      in the past tense.
138
139    This section is a comment. Do not overwrite or remove it.
140    Also, make sure to start the actual text at the margin.
141    =======================================================
142
143
144 API Changes
145 -----------
146
147 .. This section should contain API changes. Sample format:
148
149    * sample: Add a short 1-2 sentence description of the API change
150      which was announced in the previous releases and made in this release.
151      Start with a scope label like "ethdev:".
152      Use fixed width quotes for ``function_names`` or ``struct_names``.
153      Use the past tense.
154
155    This section is a comment. Do not overwrite or remove it.
156    Also, make sure to start the actual text at the margin.
157    =======================================================
158
159 * eal: ``rte_strscpy`` sets ``rte_errno`` to ``E2BIG`` in case of string
160   truncation.
161
162 * eal: ``rte_power_monitor`` and the ``rte_power_monitor_cond`` struct changed
163   to use a callback mechanism.
164
165 * rte_power: The experimental PMD power management API is no longer considered
166   to be thread safe; all Rx queues affected by the API will now need to be
167   stopped before making any changes to the power management scheme.
168
169
170 ABI Changes
171 -----------
172
173 .. This section should contain ABI changes. Sample format:
174
175    * sample: Add a short 1-2 sentence description of the ABI change
176      which was announced in the previous releases and made in this release.
177      Start with a scope label like "ethdev:".
178      Use fixed width quotes for ``function_names`` or ``struct_names``.
179      Use the past tense.
180
181    This section is a comment. Do not overwrite or remove it.
182    Also, make sure to start the actual text at the margin.
183    =======================================================
184
185 * No ABI change that would break compatibility with 20.11.
186
187
188 Known Issues
189 ------------
190
191 .. This section should contain new known issues in this release. Sample format:
192
193    * **Add title in present tense with full stop.**
194
195      Add a short 1-2 sentence description of the known issue
196      in the present tense. Add information on any known workarounds.
197
198    This section is a comment. Do not overwrite or remove it.
199    Also, make sure to start the actual text at the margin.
200    =======================================================
201
202
203 Tested Platforms
204 ----------------
205
206 .. This section should contain a list of platforms that were tested
207    with this release.
208
209    The format is:
210
211    * <vendor> platform with <vendor> <type of devices> combinations
212
213      * List of CPU
214      * List of OS
215      * List of devices
216      * Other relevant details...
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    =======================================================