test/crypto: add lookaside IPsec ICV corrupt case
[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 * **Updated Marvell cnxk ethdev driver.**
66
67   * Added rte_flow support for dual VLAN insert and strip actions.
68
69 * **Updated Marvell cnxk crypto PMD.**
70
71   * Added AES-CBC SHA1-HMAC support in lookaside protocol (IPsec) for CN10K.
72   * Added Transport mode support in lookaside protocol (IPsec) for CN10K.
73   * Added UDP encapsulation support in lookaside protocol (IPsec) for CN10K.
74   * Added support for lookaside protocol (IPsec) offload for CN9K.
75
76 * **Added support for event crypto adapter on Marvell CN10K and CN9K.**
77
78   * Added event crypto adapter OP_FORWARD mode support.
79
80 * **Updated NXP dpaa_sec crypto PMD.**
81
82   * Added DES-CBC, AES-XCBC-MAC, AES-CMAC and non-HMAC algo support.
83   * Added PDCP short MAC-I support.
84
85 * **Updated NXP dpaa2_sec crypto PMD.**
86
87   * Added PDCP short MAC-I support.
88
89 * **Added multi-process support for testpmd.**
90
91   Added command-line options to specify total number of processes and
92   current process ID. Each process owns subset of Rx and Tx queues.
93
94 * **Updated test-crypto-perf application with new cases.**
95
96   * Added support for asymmetric crypto throughput performance measurement.
97     Only modex is supported for now.
98
99 * **Added lookaside protocol (IPsec) tests in dpdk-test.**
100
101   * Added known vector tests (AES-GCM 128, 192, 256).
102   * Added tests to verify error reporting with ICV corruption.
103
104
105 Removed Items
106 -------------
107
108 .. This section should contain removed items in this release. Sample format:
109
110    * Add a short 1-2 sentence description of the removed item
111      in the past tense.
112
113    This section is a comment. Do not overwrite or remove it.
114    Also, make sure to start the actual text at the margin.
115    =======================================================
116
117 * eal: Removed the deprecated function ``rte_get_master_lcore()``
118   and the iterator macro ``RTE_LCORE_FOREACH_SLAVE``.
119
120 * eal: The old api arguments that were deprecated for
121   blacklist/whitelist are removed. Users must use the new
122   block/allow list arguments.
123
124
125 API Changes
126 -----------
127
128 .. This section should contain API changes. Sample format:
129
130    * sample: Add a short 1-2 sentence description of the API change
131      which was announced in the previous releases and made in this release.
132      Start with a scope label like "ethdev:".
133      Use fixed width quotes for ``function_names`` or ``struct_names``.
134      Use the past tense.
135
136    This section is a comment. Do not overwrite or remove it.
137    Also, make sure to start the actual text at the margin.
138    =======================================================
139
140 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
141   rte_cryptodev_is_valid_dev as it can be used by the application as
142   well as PMD to check whether the device is valid or not.
143
144 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
145   as it is for drivers only and should be private to DPDK, and not
146   installed for app use.
147
148
149 ABI Changes
150 -----------
151
152 .. This section should contain ABI changes. Sample format:
153
154    * sample: Add a short 1-2 sentence description of the ABI change
155      which was announced in the previous releases and made in this release.
156      Start with a scope label like "ethdev:".
157      Use fixed width quotes for ``function_names`` or ``struct_names``.
158      Use the past tense.
159
160    This section is a comment. Do not overwrite or remove it.
161    Also, make sure to start the actual text at the margin.
162    =======================================================
163
164 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
165   routines used by inline outbound and inline inbound security processing were
166   made inline and enhanced to do simple 64-bit set/get for PMDs that do not
167   have much processing in PMD specific callbacks but just 64-bit set/get.
168   This avoids a per packet function pointer jump overhead for such PMDs.
169
170
171 Known Issues
172 ------------
173
174 .. This section should contain new known issues in this release. Sample format:
175
176    * **Add title in present tense with full stop.**
177
178      Add a short 1-2 sentence description of the known issue
179      in the present tense. Add information on any known workarounds.
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
186 Tested Platforms
187 ----------------
188
189 .. This section should contain a list of platforms that were tested
190    with this release.
191
192    The format is:
193
194    * <vendor> platform with <vendor> <type of devices> combinations
195
196      * List of CPU
197      * List of OS
198      * List of devices
199      * Other relevant details...
200
201    This section is a comment. Do not overwrite or remove it.
202    Also, make sure to start the actual text at the margin.
203    =======================================================