219071fd1864e135417ec7aa23ed765e4cfd2f92
[dpdk.git] / doc / guides / rel_notes / release_21_11.rst
1 .. SPDX-License-Identifier: BSD-3-Clause
2    Copyright 2021 The DPDK contributors
3
4 .. include:: <isonum.txt>
5
6 DPDK Release 21.11
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       ninja -C build doc
21       xdg-open build/doc/guides/html/rel_notes/release_21_11.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 * **Enabled new devargs parser.**
59
60   * Enabled devargs syntax
61     ``bus=X,paramX=x/class=Y,paramY=y/driver=Z,paramZ=z``
62   * Added bus-level parsing of the devargs syntax.
63   * Kept compatibility with the legacy syntax as parsing fallback.
64
65 * **Added new RSS offload types for IPv4/L4 checksum in RSS flow.**
66
67   Added macros ETH_RSS_IPV4_CHKSUM and ETH_RSS_L4_CHKSUM, now IPv4 and
68   TCP/UDP/SCTP header checksum field can be used as input set for RSS.
69
70 * **Updated Broadcom bnxt PMD.**
71
72   * Added flow offload support for Thor.
73   * Implement support for tunnel offload.
74   * Updated HWRM API to version 1.10.2.44
75
76 * **Updated Intel iavf driver.**
77
78   * Added Intel iavf support on Windows.
79   * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
80
81 * **Updated Intel ice driver.**
82
83   * Added 1PPS out support by a devargs.
84   * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
85
86 * **Updated Marvell cnxk ethdev driver.**
87
88   * Added rte_flow support for dual VLAN insert and strip actions.
89   * Added rte_tm support.
90
91 * **Updated Marvell cnxk crypto PMD.**
92
93   * Added AES-CBC SHA1-HMAC support in lookaside protocol (IPsec) for CN10K.
94   * Added Transport mode support in lookaside protocol (IPsec) for CN10K.
95   * Added UDP encapsulation support in lookaside protocol (IPsec) for CN10K.
96   * Added support for lookaside protocol (IPsec) offload for CN9K.
97
98 * **Added support for event crypto adapter on Marvell CN10K and CN9K.**
99
100   * Added event crypto adapter OP_FORWARD mode support.
101
102 * **Updated NXP dpaa_sec crypto PMD.**
103
104   * Added DES-CBC, AES-XCBC-MAC, AES-CMAC and non-HMAC algo support.
105   * Added PDCP short MAC-I support.
106
107 * **Updated NXP dpaa2_sec crypto PMD.**
108
109   * Added PDCP short MAC-I support.
110
111 * **Added multi-process support for testpmd.**
112
113   Added command-line options to specify total number of processes and
114   current process ID. Each process owns subset of Rx and Tx queues.
115
116 * **Updated test-crypto-perf application with new cases.**
117
118   * Added support for asymmetric crypto throughput performance measurement.
119     Only modex is supported for now.
120
121 * **Added lookaside protocol (IPsec) tests in dpdk-test.**
122
123   * Added known vector tests (AES-GCM 128, 192, 256).
124   * Added tests to verify error reporting with ICV corruption.
125   * Added tests to verify IV generation.
126   * Added tests to verify UDP encapsulation.
127   * Added tests to validate packets soft expiry.
128   * Added tests to validate packets hard expiry.
129   * Added tests to verify tunnel header verification in IPsec inbound.
130
131
132 Removed Items
133 -------------
134
135 .. This section should contain removed items in this release. Sample format:
136
137    * Add a short 1-2 sentence description of the removed item
138      in the past tense.
139
140    This section is a comment. Do not overwrite or remove it.
141    Also, make sure to start the actual text at the margin.
142    =======================================================
143
144 * eal: Removed the deprecated function ``rte_get_master_lcore()``
145   and the iterator macro ``RTE_LCORE_FOREACH_SLAVE``.
146
147 * eal: The old api arguments that were deprecated for
148   blacklist/whitelist are removed. Users must use the new
149   block/allow list arguments.
150
151
152 API Changes
153 -----------
154
155 .. This section should contain API changes. Sample format:
156
157    * sample: Add a short 1-2 sentence description of the API change
158      which was announced in the previous releases and made in this release.
159      Start with a scope label like "ethdev:".
160      Use fixed width quotes for ``function_names`` or ``struct_names``.
161      Use the past tense.
162
163    This section is a comment. Do not overwrite or remove it.
164    Also, make sure to start the actual text at the margin.
165    =======================================================
166
167 * kvargs: The experimental function ``rte_kvargs_strcmp()`` has been
168   removed. Its usages have been replaced by a new function
169   ``rte_kvargs_get_with_value()``.
170
171 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
172   rte_cryptodev_is_valid_dev as it can be used by the application as
173   well as PMD to check whether the device is valid or not.
174
175 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
176   as it is for drivers only and should be private to DPDK, and not
177   installed for app use.
178
179 * cryptodev: A ``reserved`` byte from structure ``rte_crypto_op`` was
180   renamed to ``aux_flags`` to indicate warnings and other information from
181   the crypto/security operation. This field will be used to communicate
182   events such as soft expiry with IPsec in lookaside mode.
183
184
185 ABI Changes
186 -----------
187
188 .. This section should contain ABI changes. Sample format:
189
190    * sample: Add a short 1-2 sentence description of the ABI change
191      which was announced in the previous releases and made in this release.
192      Start with a scope label like "ethdev:".
193      Use fixed width quotes for ``function_names`` or ``struct_names``.
194      Use the past tense.
195
196    This section is a comment. Do not overwrite or remove it.
197    Also, make sure to start the actual text at the margin.
198    =======================================================
199
200 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
201   routines used by inline outbound and inline inbound security processing were
202   made inline and enhanced to do simple 64-bit set/get for PMDs that do not
203   have much processing in PMD specific callbacks but just 64-bit set/get.
204   This avoids a per packet function pointer jump overhead for such PMDs.
205
206 * security: A new option ``iv_gen_disable`` was added in structure
207   ``rte_security_ipsec_sa_options`` to disable IV generation inside PMD,
208   so that application can provide its own IV and test known test vectors.
209
210 * security: A new option ``tunnel_hdr_verify`` was added in structure
211   ``rte_security_ipsec_sa_options`` to indicate whether outer header
212   verification need to be done as part of inbound IPsec processing.
213
214 * security: A new structure ``rte_security_ipsec_lifetime`` was added to
215   replace ``esn_soft_limit`` in IPsec configuration structure
216   ``rte_security_ipsec_xform`` to allow applications to configure SA soft
217   and hard expiry limits. Limits can be either in number of packets or bytes.
218
219
220 Known Issues
221 ------------
222
223 .. This section should contain new known issues in this release. Sample format:
224
225    * **Add title in present tense with full stop.**
226
227      Add a short 1-2 sentence description of the known issue
228      in the present tense. Add information on any known workarounds.
229
230    This section is a comment. Do not overwrite or remove it.
231    Also, make sure to start the actual text at the margin.
232    =======================================================
233
234
235 Tested Platforms
236 ----------------
237
238 .. This section should contain a list of platforms that were tested
239    with this release.
240
241    The format is:
242
243    * <vendor> platform with <vendor> <type of devices> combinations
244
245      * List of CPU
246      * List of OS
247      * List of devices
248      * Other relevant details...
249
250    This section is a comment. Do not overwrite or remove it.
251    Also, make sure to start the actual text at the margin.
252    =======================================================