examples/ipsec-secgw: support CPU crypto
[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 * **Added IONIC net PMD.**
69
70   Added the new ``ionic`` net driver for Pensando Ethernet Network Adapters.
71   See the :doc:`../nics/ionic` NIC guide for more details on this new driver.
72
73 * **Updated Hisilicon hns3 driver.**
74
75   Updated Hisilicon hns3 driver with new features and improvements, including:
76
77   * Added support for Rx interrupt.
78   * Added support setting VF MAC address by PF driver.
79
80 * **Updated the Intel ice driver.**
81
82   Updated the Intel ice driver with new features and improvements, including:
83
84   * Added support for MAC rules on specific port.
85   * Added support for MAC/VLAN with TCP/UDP in switch rule.
86   * Added support for 1/10G device.
87
88 * **Updated Intel iavf driver.**
89
90   Updated iavf PMD with new features and improvements, including:
91
92   * Added more supported device IDs.
93   * Updated virtual channel to latest AVF spec.
94
95 * **Updated Intel i40e driver.**
96
97   Updated i40e PMD with new features and improvements, including:
98
99   * Added support for L2TPv3 over IP profiles which can be programmed by the
100     dynamic device personalization (DDP) process.
101   * Added support for ESP-AH profiles which can be programmed by the
102     dynamic device personalization (DDP) process.
103   * Added PF support Malicious Device Drive event catch and notify.
104   * Added LLDP support.
105   * Extended PHY access AQ cmd.
106   * Added support for reading LPI counters.
107   * Added support for Energy Efficient Ethernet
108
109 * **Updated Mellanox mlx5 driver.**
110
111   Updated Mellanox mlx5 driver with new features and improvements, including:
112
113   * Added support for RSS using L3/L4 source/destination only.
114   * Added support for matching on GTP tunnel header item.
115
116 * **Add new vDPA PMD based on Mellanox devices**
117
118   Added a new Mellanox vDPA  (``mlx5_vdpa``) PMD.
119   See the :doc:`../vdpadevs/mlx5` guide for more details on this driver.
120
121 * **Updated testpmd application.**
122
123   Added support for ESP and L2TPv3 over IP rte_flow patterns to the testpmd
124   application.
125
126 * **Added algorithms to cryptodev API.**
127
128   * ECDSA (Elliptic Curve Digital Signature Algorithm) is added to
129     asymmetric crypto library specifications.
130   * ECPM (Elliptic Curve Point Multiplication) is added to
131     asymmetric crypto library specifications.
132
133 * **Added synchronous Crypto burst API.**
134
135   A new API is introduced in crypto library to handle synchronous cryptographic
136   operations allowing to achieve performance gain for cryptodevs which use
137   CPU based acceleration, such as Intel AES-NI. An implementation for aesni_gcm
138   cryptodev is provided. The IPsec example application and ipsec library itself
139   were changed to allow utilization of this new feature.
140
141 * **Added handling of mixed algorithms in encrypted digest requests in QAT PMD.**
142
143   Added handling of mixed algorithms in encrypted digest hash-cipher
144   (generation) and cipher-hash (verification) requests (e.g. SNOW3G + ZUC or
145   ZUC + AES CTR) in QAT PMD possible when running on GEN3 QAT hardware.
146   Such algorithm combinations are not supported on GEN1/GEN2 hardware
147   and executing the request returns RTE_CRYPTO_OP_STATUS_INVALID_SESSION.
148
149 * **Updated the ZUC PMD.**
150
151   * Transistioned underlying library from libSSO ZUC to intel-ipsec-mb
152     library (minimum version required 0.53).
153   * Removed dynamic library limitation, so PMD can be built as a shared
154     object now.
155
156 * **Updated the KASUMI PMD.**
157
158   * Transistioned underlying library from libSSO KASUMI to intel-ipsec-mb
159     library (minimum version required 0.53).
160
161 * **Updated the SNOW3G PMD.**
162
163   * Transistioned underlying library from libSSO SNOW3G to intel-ipsec-mb
164     library (minimum version required 0.53).
165
166 * **Changed armv8 crypto PMD external dependency.**
167
168   armv8 crypto PMD now depends on Arm crypto library, and Marvell's
169   armv8 crypto library is not used anymore. Library name is changed
170   from armv8_crypto to AArch64crypto.
171
172 * **Added inline IPsec support to Marvell OCTEON TX2 PMD.**
173
174   Added inline IPsec support to Marvell OCTEON TX2 PMD. With the feature,
175   applications would be able to offload entire IPsec offload to the hardware.
176   For the configured sessions, hardware will do the lookup and perform
177   decryption and IPsec transformation. For the outbound path, application
178   can submit a plain packet to the PMD, and it would be sent out on wire
179   after doing encryption and IPsec transformation of the packet.
180
181 * **Added Marvell OCTEON TX2 End Point rawdev PMD.**
182
183   Added a new OCTEON TX2 rawdev PMD for End Point mode of operation.
184   See the :doc:`../rawdevs/octeontx2_ep` for more details on this new PMD.
185
186 * **Added event mode to l3fwd sample application.**
187
188   Add event device support for ``l3fwd`` sample application. It demonstrates
189   usage of poll and event mode IO mechanism under a single application.
190
191
192 Removed Items
193 -------------
194
195 .. This section should contain removed items in this release. Sample format:
196
197    * Add a short 1-2 sentence description of the removed item
198      in the past tense.
199
200    This section is a comment. Do not overwrite or remove it.
201    Also, make sure to start the actual text at the margin.
202    =========================================================
203
204 * **Disabled building all the Linux kernel modules by default.**
205
206   In order to remove the build time dependency with Linux kernel,
207   the Technical Board decided to disable all the kernel modules
208   by default from 20.02 version.
209
210
211 API Changes
212 -----------
213
214 .. This section should contain API changes. Sample format:
215
216    * sample: Add a short 1-2 sentence description of the API change
217      which was announced in the previous releases and made in this release.
218      Start with a scope label like "ethdev:".
219      Use fixed width quotes for ``function_names`` or ``struct_names``.
220      Use the past tense.
221
222    This section is a comment. Do not overwrite or remove it.
223    Also, make sure to start the actual text at the margin.
224    =========================================================
225
226
227 ABI Changes
228 -----------
229
230 .. This section should contain ABI changes. Sample format:
231
232    * sample: Add a short 1-2 sentence description of the ABI change
233      which was announced in the previous releases and made in this release.
234      Start with a scope label like "ethdev:".
235      Use fixed width quotes for ``function_names`` or ``struct_names``.
236      Use the past tense.
237
238    This section is a comment. Do not overwrite or remove it.
239    Also, make sure to start the actual text at the margin.
240    =========================================================
241
242 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
243
244
245 Known Issues
246 ------------
247
248 .. This section should contain new known issues in this release. Sample format:
249
250    * **Add title in present tense with full stop.**
251
252      Add a short 1-2 sentence description of the known issue
253      in the present tense. Add information on any known workarounds.
254
255    This section is a comment. Do not overwrite or remove it.
256    Also, make sure to start the actual text at the margin.
257    =========================================================
258
259
260 Tested Platforms
261 ----------------
262
263 .. This section should contain a list of platforms that were tested
264    with this release.
265
266    The format is:
267
268    * <vendor> platform with <vendor> <type of devices> combinations
269
270      * List of CPU
271      * List of OS
272      * List of devices
273      * Other relevant details...
274
275    This section is a comment. Do not overwrite or remove it.
276    Also, make sure to start the actual text at the margin.
277    =========================================================