cryptodev: revert Chacha20-Poly1305 AEAD algorithm
[dpdk.git] / doc / guides / rel_notes / release_20_02.rst
1 .. SPDX-License-Identifier: BSD-3-Clause
2    Copyright 2019 The DPDK contributors
3
4 .. include:: <isonum.txt>
5
6 DPDK Release 20.02
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
22       xdg-open build/doc/html/guides/rel_notes/release_20_02.html
23
24
25 New Features
26 ------------
27
28 .. This section should contain new features added in this release.
29    Sample format:
30
31    * **Add a title in the past tense with a full stop.**
32
33      Add a short 1-2 sentence description in the past tense.
34      The description should be enough to allow someone scanning
35      the release notes to understand the new feature.
36
37      If the feature adds a lot of sub-features you can use a bullet list
38      like this:
39
40      * Added feature foo to do something.
41      * Enhanced feature bar to do something else.
42
43      Refer to the previous release notes for examples.
44
45      Suggested order in release notes items:
46      * Core libs (EAL, mempool, ring, mbuf, buses)
47      * Device abstraction libs and PMDs
48        - ethdev (lib, PMDs)
49        - cryptodev (lib, PMDs)
50        - eventdev (lib, PMDs)
51        - etc
52      * Other libs
53      * Apps, Examples, Tools (if significant)
54
55      This section is a comment. Do not overwrite or remove it.
56      Also, make sure to start the actual text at the margin.
57      =========================================================
58
59 * **Added Wait Until Equal API.**
60
61   A new API has been added to wait for a memory location to be updated with a
62   16-bit, 32-bit, 64-bit value.
63
64 * **Updated rte_flow api to support L2TPv3 over IP flows.**
65
66   Added support for new flow item to handle L2TPv3 over IP rte_flow patterns.
67
68 * **Added IONIC net PMD.**
69
70   Added the new ``ionic`` net driver for Pensando Ethernet Network Adapters.
71   See the :doc:`../nics/ionic` NIC guide for more details on this new driver.
72
73 * **Updated Hisilicon hns3 driver.**
74
75   Updated Hisilicon hns3 driver with new features and improvements, including:
76
77   * Added support for Rx interrupt.
78   * Added support setting VF MAC address by PF driver.
79
80 * **Updated the Intel ice driver.**
81
82   Updated the Intel ice driver with new features and improvements, including:
83
84   * Added support for MAC rules on specific port.
85   * Added support for MAC/VLAN with TCP/UDP in switch rule.
86   * Added support for 1/10G device.
87
88 * **Updated Intel iavf driver.**
89
90   Updated iavf PMD with new features and improvements, including:
91
92   * Added more supported device IDs.
93   * Updated virtual channel to latest AVF spec.
94
95 * **Updated Intel i40e driver.**
96
97   Updated i40e PMD with new features and improvements, including:
98
99   * Added support for L2TPv3 over IP profiles which can be programmed by the
100     dynamic device personalization (DDP) process.
101   * Added support for ESP-AH profiles which can be programmed by the
102     dynamic device personalization (DDP) process.
103   * Added PF support Malicious Device Drive event catch and notify.
104   * Added LLDP support.
105   * Extended PHY access AQ cmd.
106   * Added support for reading LPI counters.
107   * Added support for Energy Efficient Ethernet
108
109 * **Updated Mellanox mlx5 driver.**
110
111   Updated Mellanox mlx5 driver with new features and improvements, including:
112
113   * Added support for RSS using L3/L4 source/destination only.
114   * Added support for matching on GTP tunnel header item.
115
116 * **Updated testpmd application.**
117
118   Added support for ESP and L2TPv3 over IP rte_flow patterns to the testpmd
119   application.
120
121 * **Added algorithms to cryptodev API.**
122
123   * ECDSA (Elliptic Curve Digital Signature Algorithm) is added to
124     asymmetric crypto library specifications.
125   * ECPM (Elliptic Curve Point Multiplication) is added to
126     asymmetric crypto library specifications.
127
128 * **Added handling of mixed algorithms in encrypted digest requests in QAT PMD.**
129
130   Added handling of mixed algorithms in encrypted digest hash-cipher
131   (generation) and cipher-hash (verification) requests (e.g. SNOW3G + ZUC or
132   ZUC + AES CTR) in QAT PMD possible when running on GEN3 QAT hardware.
133   Such algorithm combinations are not supported on GEN1/GEN2 hardware
134   and executing the request returns RTE_CRYPTO_OP_STATUS_INVALID_SESSION.
135
136 * **Added Marvell OCTEON TX2 End Point rawdev PMD.**
137
138   Added a new OCTEON TX2 rawdev PMD for End Point mode of operation.
139   See the :doc:`../rawdevs/octeontx2_ep` for more details on this new PMD.
140
141 * **Added event mode to l3fwd sample application.**
142
143   Add event device support for ``l3fwd`` sample application. It demonstrates
144   usage of poll and event mode IO mechanism under a single application.
145
146
147 Removed Items
148 -------------
149
150 .. This section should contain removed items in this release. Sample format:
151
152    * Add a short 1-2 sentence description of the removed item
153      in the past tense.
154
155    This section is a comment. Do not overwrite or remove it.
156    Also, make sure to start the actual text at the margin.
157    =========================================================
158
159 * **Disabled building all the Linux kernel modules by default.**
160
161   In order to remove the build time dependency with Linux kernel,
162   the Technical Board decided to disable all the kernel modules
163   by default from 20.02 version.
164
165
166 API Changes
167 -----------
168
169 .. This section should contain API changes. Sample format:
170
171    * sample: Add a short 1-2 sentence description of the API change
172      which was announced in the previous releases and made in this release.
173      Start with a scope label like "ethdev:".
174      Use fixed width quotes for ``function_names`` or ``struct_names``.
175      Use the past tense.
176
177    This section is a comment. Do not overwrite or remove it.
178    Also, make sure to start the actual text at the margin.
179    =========================================================
180
181
182 ABI Changes
183 -----------
184
185 .. This section should contain ABI changes. Sample format:
186
187    * sample: Add a short 1-2 sentence description of the ABI change
188      which was announced in the previous releases and made in this release.
189      Start with a scope label like "ethdev:".
190      Use fixed width quotes for ``function_names`` or ``struct_names``.
191      Use the past tense.
192
193    This section is a comment. Do not overwrite or remove it.
194    Also, make sure to start the actual text at the margin.
195    =========================================================
196
197 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
198
199
200 Known Issues
201 ------------
202
203 .. This section should contain new known issues in this release. Sample format:
204
205    * **Add title in present tense with full stop.**
206
207      Add a short 1-2 sentence description of the known issue
208      in the present tense. Add information on any known workarounds.
209
210    This section is a comment. Do not overwrite or remove it.
211    Also, make sure to start the actual text at the margin.
212    =========================================================
213
214
215 Tested Platforms
216 ----------------
217
218 .. This section should contain a list of platforms that were tested
219    with this release.
220
221    The format is:
222
223    * <vendor> platform with <vendor> <type of devices> combinations
224
225      * List of CPU
226      * List of OS
227      * List of devices
228      * Other relevant details...
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    =========================================================