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 * Added Double VLAN support for DCF switch QinQ filtering.
99 * **Updated Mellanox mlx5 driver.**
101 Updated the Mellanox mlx5 driver with new features and improvements, including:
103 * Introduced basic support on Windows.
104 * Added GTP PDU session container matching and raw encap/decap.
105 * Added support for RSS action in the sample sub-actions list.
107 * **Updated Wangxun txgbe driver.**
109 Updated the Wangxun txgbe driver with new features and improvements, including:
111 * Add support for generic flow API.
112 * Add support for traffic manager.
113 * Add support for IPsec.
115 * **Updated GSO support.**
117 * Added inner UDP/IPv4 support for VXLAN IPv4 GSO.
119 * **Added enqueue & dequeue callback APIs for cryptodev library.**
121 Cryptodev library is added with enqueue & dequeue callback APIs to
122 enable applications to add/remove user callbacks which gets called
123 for every enqueue/dequeue operation.
125 * **Updated the OCTEON TX2 crypto PMD.**
127 * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
128 ESN and anti-replay support.
129 * Updated the OCTEON TX2 crypto PMD with CN98xx support.
130 * Added support for aes-cbc sha1-hmac cipher combination in OCTEON TX2 crypto
131 PMD lookaside protocol offload for IPsec.
132 * Added support for aes-cbc sha256-128-hmac cipher combination in OCTEON TX2
133 crypto PMD lookaside protocol offload for IPsec.
139 .. This section should contain removed items in this release. Sample format:
141 * Add a short 1-2 sentence description of the removed item
144 This section is a comment. Do not overwrite or remove it.
145 Also, make sure to start the actual text at the margin.
146 =======================================================
148 * Removed support for NetXtreme devices belonging to ``BCM573xx and
149 BCM5740x`` families. Specifically the support for the following Broadcom
150 PCI device IDs ``0x16c8, 0x16c9, 0x16ca, 0x16ce, 0x16cf, 0x16df, 0x16d0,``
151 ``0x16d1, 0x16d2, 0x16d4, 0x16d5, 0x16e7, 0x16e8, 0x16e9`` has been removed.
156 .. This section should contain API changes. Sample format:
158 * sample: Add a short 1-2 sentence description of the API change
159 which was announced in the previous releases and made in this release.
160 Start with a scope label like "ethdev:".
161 Use fixed width quotes for ``function_names`` or ``struct_names``.
164 This section is a comment. Do not overwrite or remove it.
165 Also, make sure to start the actual text at the margin.
166 =======================================================
168 * config: Removed the old macros, included in ``rte_config.h``,
169 to indicate which DPDK libraries and drivers are built.
170 The new macros are generated by meson in a standardized format:
171 ``RTE_LIB_<NAME>`` and ``RTE_<CLASS>_<NAME>``, where ``NAME`` is
172 the upper-case component name, e.g. ``EAL``, ``ETHDEV``, ``VIRTIO``,
173 and ``CLASS`` is the upper-case driver class, e.g. ``NET``, ``CRYPTO``.
175 * cryptodev: The structure ``rte_cryptodev`` has been updated with pointers
176 for adding enqueue and dequeue callbacks.
182 .. This section should contain ABI changes. Sample format:
184 * sample: Add a short 1-2 sentence description of the ABI change
185 which was announced in the previous releases and made in this release.
186 Start with a scope label like "ethdev:".
187 Use fixed width quotes for ``function_names`` or ``struct_names``.
190 This section is a comment. Do not overwrite or remove it.
191 Also, make sure to start the actual text at the margin.
192 =======================================================
194 * No ABI change that would break compatibility with 20.11.
200 .. This section should contain new known issues in this release. Sample format:
202 * **Add title in present tense with full stop.**
204 Add a short 1-2 sentence description of the known issue
205 in the present tense. Add information on any known workarounds.
207 This section is a comment. Do not overwrite or remove it.
208 Also, make sure to start the actual text at the margin.
209 =======================================================
215 .. This section should contain a list of platforms that were tested
220 * <vendor> platform with <vendor> <type of devices> combinations
225 * Other relevant details...
227 This section is a comment. Do not overwrite or remove it.
228 Also, make sure to start the actual text at the margin.
229 =======================================================