1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2020 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::
21 xdg-open build/doc/html/guides/rel_notes/release_21_02.html
27 .. This section should contain new features added in this release.
30 * **Add a title in the past tense with a full stop.**
32 Add a short 1-2 sentence description in the past tense.
33 The description should be enough to allow someone scanning
34 the release notes to understand the new feature.
36 If the feature adds a lot of sub-features you can use a bullet list
39 * Added feature foo to do something.
40 * Enhanced feature bar to do something else.
42 Refer to the previous release notes for examples.
44 Suggested order in release notes items:
45 * Core libs (EAL, mempool, ring, mbuf, buses)
46 * Device abstraction libs and PMDs
48 - cryptodev (lib, PMDs)
49 - eventdev (lib, PMDs)
52 * Apps, Examples, Tools (if significant)
54 This section is a comment. Do not overwrite or remove it.
55 Also, make sure to start the actual text at the margin.
56 =======================================================
58 * **Added new ethdev API for PMD power management.**
60 Added ``rte_eth_get_monitor_addr()``, to be used in conjunction with
61 ``rte_power_monitor()`` to enable automatic power management for PMDs.
63 * **Added Ethernet PMD power management helper API.**
65 A new helper API has been added to make using Ethernet PMD power management
66 easier for the user: ``rte_power_ethdev_pmgmt_queue_enable()``. Three power
67 management schemes are supported initially:
69 * Power saving based on UMWAIT instruction (x86 only)
70 * Power saving based on ``rte_pause()`` (generic) or TPAUSE instruction (x86 only)
71 * Power saving based on frequency scaling through the ``librte_power`` library
73 * **Added GENEVE TLV option in rte_flow.**
75 Added support for matching and raw encap/decap of GENEVE TLV option.
77 * **Added support of modify field action in the flow API.**
79 Added modify action support to perform various operations on
80 any arbitrary header field (as well as mark, metadata or tag values):
81 ``RTE_FLOW_ACTION_TYPE_MODIFY_FIELD``.
82 Supported operations are: overwriting a field with the content from
83 another field, addition and subtraction using an immediate value.
85 * **Updated Broadcom bnxt driver.**
87 Updated the Broadcom bnxt driver with fixes and improvements, including:
89 * Added support for Stingray2 device.
91 * **Updated Cisco enic driver.**
93 * Added support for 64B completion queue entries
95 * **Updated Intel ice driver.**
97 Updated the Intel ice driver with new features and improvements, including:
99 * Added Double VLAN support for DCF switch QinQ filtering.
100 * Added support for UDP dynamic port assignment for eCPRI tunnel in DCF.
102 * **Updated Intel iavf driver.**
104 Updated iavf PMD with new features and improvements, including:
106 * Added support for FDIR/RSS packet steering for eCPRI flow.
107 * Added support for FDIR TCP/UDP pattern without input set.
109 * **Updated Mellanox mlx5 driver.**
111 Updated the Mellanox mlx5 driver with new features and improvements, including:
113 * Introduced basic support on Windows.
114 * Added GTP PDU session container matching and raw encap/decap.
115 * Added support for RSS action in the sample sub-actions list.
116 * Added support for E-Switch mirroring and jump action in the same flow.
117 * Added support to handle modify action in correct order regarding the
118 mirroring action on E-Switch.
119 * Enlarged the number of flow priorities to 21844 (0 - 21843) for ingress or
120 egress flow groups greater than 0 and for any transfer flow group.
121 * Added support for the Tx mbuf fast free offload.
122 * Added support for flow modify field action.
124 * **Updated Wangxun txgbe driver.**
126 Updated the Wangxun txgbe driver with new features and improvements, including:
128 * Add support for generic flow API.
129 * Add support for traffic manager.
130 * Add support for IPsec.
132 * **Updated GSO support.**
134 * Added inner UDP/IPv4 support for VXLAN IPv4 GSO.
136 * **Added enqueue & dequeue callback APIs for cryptodev library.**
138 Cryptodev library is added with enqueue & dequeue callback APIs to
139 enable applications to add/remove user callbacks which gets called
140 for every enqueue/dequeue operation.
142 * **Updated the OCTEON TX2 crypto PMD.**
144 * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
145 ESN and anti-replay support.
146 * Updated the OCTEON TX2 crypto PMD with CN98xx support.
147 * Added support for aes-cbc sha1-hmac cipher combination in OCTEON TX2 crypto
148 PMD lookaside protocol offload for IPsec.
149 * Added support for aes-cbc sha256-128-hmac cipher combination in OCTEON TX2
150 crypto PMD lookaside protocol offload for IPsec.
152 * **Added mlx5 compress PMD.**
154 Added a new compress PMD driver for Bluefield 2 adapters.
156 See the :doc:`../compressdevs/mlx5` for more details.
158 * **Added support for build-time checking of header includes.**
160 A new build option ``check_includes`` has been added, which, when enabled,
161 will perform build-time checking on DPDK public header files, to ensure none
162 are missing dependent header includes. This feature, disabled by default, is
163 intended for use by developers contributing to the DPDK SDK itself, and is
164 integrated into the build scripts and automated CI for patch contributions.
170 .. This section should contain removed items in this release. Sample format:
172 * Add a short 1-2 sentence description of the removed item
175 This section is a comment. Do not overwrite or remove it.
176 Also, make sure to start the actual text at the margin.
177 =======================================================
179 * The internal header files ``rte_ethdev_driver.h``, ``rte_ethdev_vdev.h`` and
180 ``rte_ethdev_pci.h`` are no longer installed as part of the DPDK
181 ``ninja install`` action and are renamed to ``ethdev_driver.h``,
182 ``ethdev_vdev.h`` and ``ethdev_pci.h`` respectively in the source tree, to
183 reflect the fact that they are non-public headers.
185 * The internal header files ``rte_eventdev_pmd.h``, ``rte_eventdev_pmd_vdev.h``
186 and ``rte_eventdev_pmd_pci.h`` are no longer installed as part of the DPDK
187 ``ninja install`` action and are renamed to ``eventdev_pmd.h``,
188 ``eventdev_pmd_vdev.h`` and ``eventdev_pmd_pci.h`` respectively in the source
189 tree, to reflect the fact that they are non-public headers.
191 * Removed support for NetXtreme devices belonging to ``BCM573xx and
192 BCM5740x`` families. Specifically the support for the following Broadcom
193 PCI device IDs ``0x16c8, 0x16c9, 0x16ca, 0x16ce, 0x16cf, 0x16df, 0x16d0,``
194 ``0x16d1, 0x16d2, 0x16d4, 0x16d5, 0x16e7, 0x16e8, 0x16e9`` has been removed.
196 * The ``check-includes.sh`` script for checking DPDK header files has been
197 removed, being replaced by the ``check_includes`` build option described
204 .. This section should contain API changes. Sample format:
206 * sample: Add a short 1-2 sentence description of the API change
207 which was announced in the previous releases and made in this release.
208 Start with a scope label like "ethdev:".
209 Use fixed width quotes for ``function_names`` or ``struct_names``.
212 This section is a comment. Do not overwrite or remove it.
213 Also, make sure to start the actual text at the margin.
214 =======================================================
216 * config: Removed the old macros, included in ``rte_config.h``,
217 to indicate which DPDK libraries and drivers are built.
218 The new macros are generated by meson in a standardized format:
219 ``RTE_LIB_<NAME>`` and ``RTE_<CLASS>_<NAME>``, where ``NAME`` is
220 the upper-case component name, e.g. ``EAL``, ``ETHDEV``, ``VIRTIO``,
221 and ``CLASS`` is the upper-case driver class, e.g. ``NET``, ``CRYPTO``.
223 * cryptodev: The structure ``rte_cryptodev`` has been updated with pointers
224 for adding enqueue and dequeue callbacks.
230 .. This section should contain ABI changes. Sample format:
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``.
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 =======================================================
242 * No ABI change that would break compatibility with 20.11.
248 .. This section should contain new known issues in this release. Sample format:
250 * **Add title in present tense with full stop.**
252 Add a short 1-2 sentence description of the known issue
253 in the present tense. Add information on any known workarounds.
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 =======================================================
263 .. This section should contain a list of platforms that were tested
268 * <vendor> platform with <vendor> <type of devices> combinations
273 * Other relevant details...
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 =======================================================