net/bnxt: add enhancements to TruFlow ULP
[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 ice driver.**
77
78   * Added 1PPS out support by a devargs.
79
80 * **Updated Marvell cnxk ethdev driver.**
81
82   * Added rte_flow support for dual VLAN insert and strip actions.
83
84 * **Updated Marvell cnxk crypto PMD.**
85
86   * Added AES-CBC SHA1-HMAC support in lookaside protocol (IPsec) for CN10K.
87   * Added Transport mode support in lookaside protocol (IPsec) for CN10K.
88   * Added UDP encapsulation support in lookaside protocol (IPsec) for CN10K.
89   * Added support for lookaside protocol (IPsec) offload for CN9K.
90
91 * **Added support for event crypto adapter on Marvell CN10K and CN9K.**
92
93   * Added event crypto adapter OP_FORWARD mode support.
94
95 * **Updated NXP dpaa_sec crypto PMD.**
96
97   * Added DES-CBC, AES-XCBC-MAC, AES-CMAC and non-HMAC algo support.
98   * Added PDCP short MAC-I support.
99
100 * **Updated NXP dpaa2_sec crypto PMD.**
101
102   * Added PDCP short MAC-I support.
103
104 * **Added multi-process support for testpmd.**
105
106   Added command-line options to specify total number of processes and
107   current process ID. Each process owns subset of Rx and Tx queues.
108
109 * **Updated test-crypto-perf application with new cases.**
110
111   * Added support for asymmetric crypto throughput performance measurement.
112     Only modex is supported for now.
113
114 * **Added lookaside protocol (IPsec) tests in dpdk-test.**
115
116   * Added known vector tests (AES-GCM 128, 192, 256).
117   * Added tests to verify error reporting with ICV corruption.
118   * Added tests to verify IV generation.
119   * Added tests to verify UDP encapsulation.
120   * Added tests to validate packets soft expiry.
121   * Added tests to validate packets hard expiry.
122   * Added tests to verify tunnel header verification in IPsec inbound.
123
124
125 Removed Items
126 -------------
127
128 .. This section should contain removed items in this release. Sample format:
129
130    * Add a short 1-2 sentence description of the removed item
131      in the past tense.
132
133    This section is a comment. Do not overwrite or remove it.
134    Also, make sure to start the actual text at the margin.
135    =======================================================
136
137 * eal: Removed the deprecated function ``rte_get_master_lcore()``
138   and the iterator macro ``RTE_LCORE_FOREACH_SLAVE``.
139
140 * eal: The old api arguments that were deprecated for
141   blacklist/whitelist are removed. Users must use the new
142   block/allow list arguments.
143
144
145 API Changes
146 -----------
147
148 .. This section should contain API changes. Sample format:
149
150    * sample: Add a short 1-2 sentence description of the API change
151      which was announced in the previous releases and made in this release.
152      Start with a scope label like "ethdev:".
153      Use fixed width quotes for ``function_names`` or ``struct_names``.
154      Use the past tense.
155
156    This section is a comment. Do not overwrite or remove it.
157    Also, make sure to start the actual text at the margin.
158    =======================================================
159
160 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
161   rte_cryptodev_is_valid_dev as it can be used by the application as
162   well as PMD to check whether the device is valid or not.
163
164 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
165   as it is for drivers only and should be private to DPDK, and not
166   installed for app use.
167
168 * cryptodev: A ``reserved`` byte from structure ``rte_crypto_op`` was
169   renamed to ``aux_flags`` to indicate warnings and other information from
170   the crypto/security operation. This field will be used to communicate
171   events such as soft expiry with IPsec in lookaside mode.
172
173
174 ABI Changes
175 -----------
176
177 .. This section should contain ABI changes. Sample format:
178
179    * sample: Add a short 1-2 sentence description of the ABI 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 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
190   routines used by inline outbound and inline inbound security processing were
191   made inline and enhanced to do simple 64-bit set/get for PMDs that do not
192   have much processing in PMD specific callbacks but just 64-bit set/get.
193   This avoids a per packet function pointer jump overhead for such PMDs.
194
195 * security: A new option ``iv_gen_disable`` was added in structure
196   ``rte_security_ipsec_sa_options`` to disable IV generation inside PMD,
197   so that application can provide its own IV and test known test vectors.
198
199 * security: A new option ``tunnel_hdr_verify`` was added in structure
200   ``rte_security_ipsec_sa_options`` to indicate whether outer header
201   verification need to be done as part of inbound IPsec processing.
202
203 * security: A new structure ``rte_security_ipsec_lifetime`` was added to
204   replace ``esn_soft_limit`` in IPsec configuration structure
205   ``rte_security_ipsec_xform`` to allow applications to configure SA soft
206   and hard expiry limits. Limits can be either in number of packets or bytes.
207
208
209 Known Issues
210 ------------
211
212 .. This section should contain new known issues in this release. Sample format:
213
214    * **Add title in present tense with full stop.**
215
216      Add a short 1-2 sentence description of the known issue
217      in the present tense. Add information on any known workarounds.
218
219    This section is a comment. Do not overwrite or remove it.
220    Also, make sure to start the actual text at the margin.
221    =======================================================
222
223
224 Tested Platforms
225 ----------------
226
227 .. This section should contain a list of platforms that were tested
228    with this release.
229
230    The format is:
231
232    * <vendor> platform with <vendor> <type of devices> combinations
233
234      * List of CPU
235      * List of OS
236      * List of devices
237      * Other relevant details...
238
239    This section is a comment. Do not overwrite or remove it.
240    Also, make sure to start the actual text at the margin.
241    =======================================================