a65227eaf1b4d00fb42b1feace910022a206a38a
[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 * **Added Marvell OCTEON TX2 End Point rawdev PMD.**
136
137   Added a new OCTEON TX2 rawdev PMD for End Point mode of operation.
138   See the :doc:`../rawdevs/octeontx2_ep` for more details on this new PMD.
139
140
141 Removed Items
142 -------------
143
144 .. This section should contain removed items in this release. Sample format:
145
146    * Add a short 1-2 sentence description of the removed item
147      in the past tense.
148
149    This section is a comment. Do not overwrite or remove it.
150    Also, make sure to start the actual text at the margin.
151    =========================================================
152
153
154 API Changes
155 -----------
156
157 .. This section should contain API changes. Sample format:
158
159    * sample: Add a short 1-2 sentence description of the API change
160      which was announced in the previous releases and made in this release.
161      Start with a scope label like "ethdev:".
162      Use fixed width quotes for ``function_names`` or ``struct_names``.
163      Use the past tense.
164
165    This section is a comment. Do not overwrite or remove it.
166    Also, make sure to start the actual text at the margin.
167    =========================================================
168
169
170 ABI Changes
171 -----------
172
173 .. This section should contain ABI changes. Sample format:
174
175    * sample: Add a short 1-2 sentence description of the ABI change
176      which was announced in the previous releases and made in this release.
177      Start with a scope label like "ethdev:".
178      Use fixed width quotes for ``function_names`` or ``struct_names``.
179      Use the past tense.
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 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
186
187
188 Known Issues
189 ------------
190
191 .. This section should contain new known issues in this release. Sample format:
192
193    * **Add title in present tense with full stop.**
194
195      Add a short 1-2 sentence description of the known issue
196      in the present tense. Add information on any known workarounds.
197
198    This section is a comment. Do not overwrite or remove it.
199    Also, make sure to start the actual text at the margin.
200    =========================================================
201
202
203 Tested Platforms
204 ----------------
205
206 .. This section should contain a list of platforms that were tested
207    with this release.
208
209    The format is:
210
211    * <vendor> platform with <vendor> <type of devices> combinations
212
213      * List of CPU
214      * List of OS
215      * List of devices
216      * Other relevant details...
217
218    This section is a comment. Do not overwrite or remove it.
219    Also, make sure to start the actual text at the margin.
220    =========================================================