b6f915bc1acb22a8e292e28e5ded2bcd41f1765b
[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 * **Updated Hisilicon hns3 driver.**
69
70   Updated Hisilicon hns3 driver with new features and improvements, including:
71
72   * Added support for Rx interrupt.
73   * Added support setting VF MAC address by PF driver.
74
75 * **Updated i40e driver to support L2TPv3 over IP flows.**
76
77   Updated the i40e PMD to support L2TPv3 over IP profiles which can be
78   programmed by the dynamic device personalization (DDP) process.
79
80 * **Updated i40e driver to support ESP.**
81
82   Updated the i40e PMD to support ESP-AH supporting profiles which can be
83   programmed by the dynamic device personalization (DDP) process.
84
85 * **Updated Mellanox mlx5 driver.**
86
87   Updated Mellanox mlx5 driver with new features and improvements, including:
88
89   * Added support for RSS using L3/L4 source/destination only.
90
91 * **Updated testpmd application.**
92
93   Added support for ESP and L2TPv3 over IP rte_flow patterns to the testpmd
94   application.
95
96 * **Added algorithms to cryptodev API.**
97
98   * Chacha20-Poly1305 AEAD algorithm can now be supported in cryptodev.
99   * ECDSA (Elliptic Curve Digital Signature Algorithm) is added to
100     asymmetric crypto library specifications.
101   * ECPM (Elliptic Curve Point Multiplication) is added to
102     asymmetric crypto library specifications.
103
104 * **Added handling of mixed algorithms in encrypted digest requests in QAT PMD.**
105
106   Added handling of mixed algorithms in encrypted digest hash-cipher
107   (generation) and cipher-hash (verification) requests (e.g. SNOW3G + ZUC or
108   ZUC + AES CTR) in QAT PMD possible when running on GEN3 QAT hardware.
109   Such algorithm combinations are not supported on GEN1/GEN2 hardware
110   and executing the request returns RTE_CRYPTO_OP_STATUS_INVALID_SESSION.
111
112 * **Updated the Intel QuickAssist Technology (QAT) symmetric crypto PMD.**
113
114   Added Chacha20-Poly1305 AEAD algorithm.
115
116
117 Removed Items
118 -------------
119
120 .. This section should contain removed items in this release. Sample format:
121
122    * Add a short 1-2 sentence description of the removed item
123      in the past tense.
124
125    This section is a comment. Do not overwrite or remove it.
126    Also, make sure to start the actual text at the margin.
127    =========================================================
128
129
130 API Changes
131 -----------
132
133 .. This section should contain API changes. Sample format:
134
135    * sample: Add a short 1-2 sentence description of the API change
136      which was announced in the previous releases and made in this release.
137      Start with a scope label like "ethdev:".
138      Use fixed width quotes for ``function_names`` or ``struct_names``.
139      Use the past tense.
140
141    This section is a comment. Do not overwrite or remove it.
142    Also, make sure to start the actual text at the margin.
143    =========================================================
144
145
146 ABI Changes
147 -----------
148
149 .. This section should contain ABI changes. Sample format:
150
151    * sample: Add a short 1-2 sentence description of the ABI change
152      which was announced in the previous releases and made in this release.
153      Start with a scope label like "ethdev:".
154      Use fixed width quotes for ``function_names`` or ``struct_names``.
155      Use the past tense.
156
157    This section is a comment. Do not overwrite or remove it.
158    Also, make sure to start the actual text at the margin.
159    =========================================================
160
161 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
162
163
164 Known Issues
165 ------------
166
167 .. This section should contain new known issues in this release. Sample format:
168
169    * **Add title in present tense with full stop.**
170
171      Add a short 1-2 sentence description of the known issue
172      in the present tense. Add information on any known workarounds.
173
174    This section is a comment. Do not overwrite or remove it.
175    Also, make sure to start the actual text at the margin.
176    =========================================================
177
178
179 Tested Platforms
180 ----------------
181
182 .. This section should contain a list of platforms that were tested
183    with this release.
184
185    The format is:
186
187    * <vendor> platform with <vendor> <type of devices> combinations
188
189      * List of CPU
190      * List of OS
191      * List of devices
192      * Other relevant details...
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    =========================================================