a7a82889733c3f792d794e7484f8ed99f7e97ad9
[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 the Intel ice driver.**
76
77   Updated the Intel ice driver with new features and improvements, including:
78
79   * Added support for MAC rules on specific port.
80   * Added support for MAC/VLAN with TCP/UDP in switch rule.
81   * Added support for 1/10G device.
82
83 * **Updated Intel iavf driver.**
84
85   Updated iavf PMD with new features and improvements, including:
86
87   * Added more supported device IDs.
88   * Updated virtual channel to latest AVF spec.
89
90 * **Updated Intel i40e driver.**
91
92   Updated i40e PMD with new features and improvements, including:
93
94   * Added support for L2TPv3 over IP profiles which can be programmed by the
95     dynamic device personalization (DDP) process.
96   * Added support for ESP-AH profiles which can be programmed by the
97     dynamic device personalization (DDP) process.
98   * Added PF support Malicious Device Drive event catch and notify.
99   * Added LLDP support.
100   * Extended PHY access AQ cmd.
101   * Added support for reading LPI counters.
102   * Added support for Energy Efficient Ethernet
103
104 * **Updated Mellanox mlx5 driver.**
105
106   Updated Mellanox mlx5 driver with new features and improvements, including:
107
108   * Added support for RSS using L3/L4 source/destination only.
109
110 * **Updated testpmd application.**
111
112   Added support for ESP and L2TPv3 over IP rte_flow patterns to the testpmd
113   application.
114
115 * **Added algorithms to cryptodev API.**
116
117   * Chacha20-Poly1305 AEAD algorithm can now be supported in cryptodev.
118   * ECDSA (Elliptic Curve Digital Signature Algorithm) is added to
119     asymmetric crypto library specifications.
120   * ECPM (Elliptic Curve Point Multiplication) is added to
121     asymmetric crypto library specifications.
122
123 * **Added handling of mixed algorithms in encrypted digest requests in QAT PMD.**
124
125   Added handling of mixed algorithms in encrypted digest hash-cipher
126   (generation) and cipher-hash (verification) requests (e.g. SNOW3G + ZUC or
127   ZUC + AES CTR) in QAT PMD possible when running on GEN3 QAT hardware.
128   Such algorithm combinations are not supported on GEN1/GEN2 hardware
129   and executing the request returns RTE_CRYPTO_OP_STATUS_INVALID_SESSION.
130
131 * **Updated the Intel QuickAssist Technology (QAT) symmetric crypto PMD.**
132
133   Added Chacha20-Poly1305 AEAD algorithm.
134
135
136 Removed Items
137 -------------
138
139 .. This section should contain removed items in this release. Sample format:
140
141    * Add a short 1-2 sentence description of the removed item
142      in the past tense.
143
144    This section is a comment. Do not overwrite or remove it.
145    Also, make sure to start the actual text at the margin.
146    =========================================================
147
148
149 API Changes
150 -----------
151
152 .. This section should contain API changes. Sample format:
153
154    * sample: Add a short 1-2 sentence description of the API 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
165 ABI Changes
166 -----------
167
168 .. This section should contain ABI changes. Sample format:
169
170    * sample: Add a short 1-2 sentence description of the ABI change
171      which was announced in the previous releases and made in this release.
172      Start with a scope label like "ethdev:".
173      Use fixed width quotes for ``function_names`` or ``struct_names``.
174      Use the past tense.
175
176    This section is a comment. Do not overwrite or remove it.
177    Also, make sure to start the actual text at the margin.
178    =========================================================
179
180 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
181
182
183 Known Issues
184 ------------
185
186 .. This section should contain new known issues in this release. Sample format:
187
188    * **Add title in present tense with full stop.**
189
190      Add a short 1-2 sentence description of the known issue
191      in the present tense. Add information on any known workarounds.
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
198 Tested Platforms
199 ----------------
200
201 .. This section should contain a list of platforms that were tested
202    with this release.
203
204    The format is:
205
206    * <vendor> platform with <vendor> <type of devices> combinations
207
208      * List of CPU
209      * List of OS
210      * List of devices
211      * Other relevant details...
212
213    This section is a comment. Do not overwrite or remove it.
214    Also, make sure to start the actual text at the margin.
215    =========================================================