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