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