common/qat: support GEN4 devices
[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 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 * **Updated Solarflare network PMD.**
103
104   Updated the Solarflare ``sfc_efx`` driver with changes including:
105
106   * Added COUNT action support for SN1000 NICs
107
108 * **Updated Intel QuickAssist crypto PMD.**
109
110   Added fourth generation of QuickAssist Technology(QAT) devices support.
111   Only symmetric crypto has been currently enabled, compression and asymmetric
112   crypto PMD will fail to create.
113
114 * **Added support for Marvell CNXK crypto driver.**
115
116   * Added cnxk crypto PMD which provides support for an integrated
117     crypto driver for CN9K and CN10K series of SOCs. Support for
118     symmetric crypto algorithms is added to both the PMDs.
119   * Added support for lookaside protocol (IPsec) offload in cn10k PMD.
120   * Added support for asymmetric crypto operations in cn9k and cn10k PMD.
121
122 * **Updated Marvell OCTEON TX crypto PMD.**
123
124   Added support for crypto adapter OP_FORWARD mode.
125
126 * **Added Baseband PHY CNXK PMD.**
127
128   Added Baseband PHY PMD which allows to configure BPHY hardware block
129   comprising accelerators and DSPs specifically tailored for 5G/LTE inline
130   usecases. Configuration happens via standard rawdev enq/deq operations. See
131   the :doc:`../rawdevs/cnxk_bphy` rawdev guide for more details on this driver.
132
133 * **Added support for Marvell CN10K, CN9K, event Rx/Tx adapter.**
134
135   * Added Rx/Tx adapter support for event/cnxk when the ethernet device requested
136     is net/cnxk.
137   * Added support for event vectorization for Rx/Tx adapter.
138
139 * **Added cppc_cpufreq support to Power Management library.**
140
141   Added support for cppc_cpufreq driver which works on most arm64 platforms.
142
143 * **Added multi-queue support to Ethernet PMD Power Management**
144
145   The experimental PMD power management API now supports managing
146   multiple Ethernet Rx queues per lcore.
147
148
149 Removed Items
150 -------------
151
152 .. This section should contain removed items in this release. Sample format:
153
154    * Add a short 1-2 sentence description of the removed item
155      in the past tense.
156
157    This section is a comment. Do not overwrite or remove it.
158    Also, make sure to start the actual text at the margin.
159    =======================================================
160
161
162 API Changes
163 -----------
164
165 .. This section should contain API changes. Sample format:
166
167    * sample: Add a short 1-2 sentence description of the API change
168      which was announced in the previous releases and made in this release.
169      Start with a scope label like "ethdev:".
170      Use fixed width quotes for ``function_names`` or ``struct_names``.
171      Use the past tense.
172
173    This section is a comment. Do not overwrite or remove it.
174    Also, make sure to start the actual text at the margin.
175    =======================================================
176
177 * eal: ``rte_strscpy`` sets ``rte_errno`` to ``E2BIG`` in case of string
178   truncation.
179
180 * eal: ``rte_power_monitor`` and the ``rte_power_monitor_cond`` struct changed
181   to use a callback mechanism.
182
183 * rte_power: The experimental PMD power management API is no longer considered
184   to be thread safe; all Rx queues affected by the API will now need to be
185   stopped before making any changes to the power management scheme.
186
187
188 ABI Changes
189 -----------
190
191 .. This section should contain ABI changes. Sample format:
192
193    * sample: Add a short 1-2 sentence description of the ABI change
194      which was announced in the previous releases and made in this release.
195      Start with a scope label like "ethdev:".
196      Use fixed width quotes for ``function_names`` or ``struct_names``.
197      Use the past tense.
198
199    This section is a comment. Do not overwrite or remove it.
200    Also, make sure to start the actual text at the margin.
201    =======================================================
202
203 * No ABI change that would break compatibility with 20.11.
204
205
206 Known Issues
207 ------------
208
209 .. This section should contain new known issues in this release. Sample format:
210
211    * **Add title in present tense with full stop.**
212
213      Add a short 1-2 sentence description of the known issue
214      in the present tense. Add information on any known workarounds.
215
216    This section is a comment. Do not overwrite or remove it.
217    Also, make sure to start the actual text at the margin.
218    =======================================================
219
220
221 Tested Platforms
222 ----------------
223
224 .. This section should contain a list of platforms that were tested
225    with this release.
226
227    The format is:
228
229    * <vendor> platform with <vendor> <type of devices> combinations
230
231      * List of CPU
232      * List of OS
233      * List of devices
234      * Other relevant details...
235
236    This section is a comment. Do not overwrite or remove it.
237    Also, make sure to start the actual text at the margin.
238    =======================================================