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