1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2019 The DPDK contributors
4 .. include:: <isonum.txt>
9 .. **Read this first.**
11 The text in the sections below explains how to update the release notes.
13 Use proper spelling, capitalization and punctuation in all sections.
15 Variable and config names should be quoted as fixed width text:
18 Build the docs and view the output file to ensure the changes are correct::
22 xdg-open build/doc/html/guides/rel_notes/release_20_02.html
28 .. This section should contain new features added in this release.
31 * **Add a title in the past tense with a full stop.**
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.
37 If the feature adds a lot of sub-features you can use a bullet list
40 * Added feature foo to do something.
41 * Enhanced feature bar to do something else.
43 Refer to the previous release notes for examples.
45 Suggested order in release notes items:
46 * Core libs (EAL, mempool, ring, mbuf, buses)
47 * Device abstraction libs and PMDs
49 - cryptodev (lib, PMDs)
50 - eventdev (lib, PMDs)
53 * Apps, Examples, Tools (if significant)
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 =========================================================
59 * **Added Wait Until Equal API.**
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.
64 * **Updated rte_flow api to support L2TPv3 over IP flows.**
66 Added support for new flow item to handle L2TPv3 over IP rte_flow patterns.
68 * **Added IONIC net PMD.**
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.
73 * **Updated Hisilicon hns3 driver.**
75 Updated Hisilicon hns3 driver with new features and improvements, including:
77 * Added support for Rx interrupt.
78 * Added support setting VF MAC address by PF driver.
80 * **Updated the Intel ice driver.**
82 Updated the Intel ice driver with new features and improvements, including:
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.
88 * **Updated Intel iavf driver.**
90 Updated iavf PMD with new features and improvements, including:
92 * Added more supported device IDs.
93 * Updated virtual channel to latest AVF spec.
95 * **Updated Intel i40e driver.**
97 Updated i40e PMD with new features and improvements, including:
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
109 * **Updated Mellanox mlx5 driver.**
111 Updated Mellanox mlx5 driver with new features and improvements, including:
113 * Added support for RSS using L3/L4 source/destination only.
114 * Added support for matching on GTP tunnel header item.
116 * **Add new vDPA PMD based on Mellanox devices**
118 Added a new Mellanox vDPA (``mlx5_vdpa``) PMD.
119 See the :doc:`../vdpadevs/mlx5` guide for more details on this driver.
121 * **Updated testpmd application.**
123 Added support for ESP and L2TPv3 over IP rte_flow patterns to the testpmd
126 * **Added algorithms to cryptodev API.**
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.
133 * **Added handling of mixed algorithms in encrypted digest requests in QAT PMD.**
135 Added handling of mixed algorithms in encrypted digest hash-cipher
136 (generation) and cipher-hash (verification) requests (e.g. SNOW3G + ZUC or
137 ZUC + AES CTR) in QAT PMD possible when running on GEN3 QAT hardware.
138 Such algorithm combinations are not supported on GEN1/GEN2 hardware
139 and executing the request returns RTE_CRYPTO_OP_STATUS_INVALID_SESSION.
141 * **Updated the ZUC PMD.**
143 * Transistioned underlying library from libSSO ZUC to intel-ipsec-mb
144 library (minimum version required 0.53).
145 * Removed dynamic library limitation, so PMD can be built as a shared
148 * **Added Marvell OCTEON TX2 End Point rawdev PMD.**
150 Added a new OCTEON TX2 rawdev PMD for End Point mode of operation.
151 See the :doc:`../rawdevs/octeontx2_ep` for more details on this new PMD.
153 * **Added event mode to l3fwd sample application.**
155 Add event device support for ``l3fwd`` sample application. It demonstrates
156 usage of poll and event mode IO mechanism under a single application.
162 .. This section should contain removed items in this release. Sample format:
164 * Add a short 1-2 sentence description of the removed item
167 This section is a comment. Do not overwrite or remove it.
168 Also, make sure to start the actual text at the margin.
169 =========================================================
171 * **Disabled building all the Linux kernel modules by default.**
173 In order to remove the build time dependency with Linux kernel,
174 the Technical Board decided to disable all the kernel modules
175 by default from 20.02 version.
181 .. This section should contain API changes. Sample format:
183 * sample: Add a short 1-2 sentence description of the API change
184 which was announced in the previous releases and made in this release.
185 Start with a scope label like "ethdev:".
186 Use fixed width quotes for ``function_names`` or ``struct_names``.
189 This section is a comment. Do not overwrite or remove it.
190 Also, make sure to start the actual text at the margin.
191 =========================================================
197 .. This section should contain ABI changes. Sample format:
199 * sample: Add a short 1-2 sentence description of the ABI change
200 which was announced in the previous releases and made in this release.
201 Start with a scope label like "ethdev:".
202 Use fixed width quotes for ``function_names`` or ``struct_names``.
205 This section is a comment. Do not overwrite or remove it.
206 Also, make sure to start the actual text at the margin.
207 =========================================================
209 * No change, kept ABI v20. DPDK 20.02 is compatible with DPDK 19.11.
215 .. This section should contain new known issues in this release. Sample format:
217 * **Add title in present tense with full stop.**
219 Add a short 1-2 sentence description of the known issue
220 in the present tense. Add information on any known workarounds.
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 =========================================================
230 .. This section should contain a list of platforms that were tested
235 * <vendor> platform with <vendor> <type of devices> combinations
240 * Other relevant details...
242 This section is a comment. Do not overwrite or remove it.
243 Also, make sure to start the actual text at the margin.
244 =========================================================