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::
22 xdg-open build/doc/html/guides/rel_notes/release_20_05.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 Trace Library and Tracepoints**
61 A native implementation of ``common trace format(CTF)`` based trace library
62 has been added to provide the ability to add tracepoints in
63 application/library to get runtime trace/debug information for control and
64 fast APIs with minimum impact on fast path performance.
65 Typical trace overhead is ~20 cycles and instrumentation overhead is 1 cycle.
66 Added tracepoints in ``EAL``, ``ethdev``, ``cryptodev``, ``eventdev`` and
67 ``mempool`` libraries for important functions.
69 * **Added new API for rte_ring.**
71 * New synchronization modes for rte_ring.
73 Introduced new optional MT synchronization modes for rte_ring:
74 Relaxed Tail Sync (RTS) mode and Head/Tail Sync (HTS) mode.
75 With these mode selected, rte_ring shows significant improvements for
76 average enqueue/dequeue times on overcommitted systems.
78 * Added peek style API for rte_ring.
80 For rings with producer/consumer in RTE_RING_SYNC_ST, RTE_RING_SYNC_MT_HTS
81 mode, provide an ability to split enqueue/dequeue operation into two phases
82 (enqueue/dequeue start; enqueue/dequeue finish). That allows user to inspect
83 objects in the ring without removing them from it (aka MT safe peek).
85 * **Updated the Intel ice driver.**
87 Updated the Intel ice driver with new features and improvements, including:
89 * Added support for DCF (Device Config Function) feature.
90 * Added switch filter support for intel DCF.
92 * **Updated Marvell OCTEON TX2 ethdev driver.**
94 Updated Marvell OCTEON TX2 ethdev driver with traffic manager support with
97 * Hierarchial Scheduling with DWRR and SP.
98 * Single rate - Two color, Two rate - Three color shaping.
100 * **Updated Mellanox mlx5 driver.**
102 Updated Mellanox mlx5 driver with new features and improvements, including:
104 * Added support for matching on IPv4 Time To Live and IPv6 Hop Limit.
105 * Added support for creating Relaxed Ordering Memory Regions.
107 * **Updated the AESNI MB crypto PMD.**
109 * Added support for intel-ipsec-mb version 0.54.
110 * Updated the AESNI MB PMD with AES-256 DOCSIS algorithm.
111 * Added support for synchronous Crypto burst API.
113 * **Updated the AESNI GCM crypto PMD.**
115 * Added support for intel-ipsec-mb version 0.54.
117 * **Added handling of mixed crypto algorithms in QAT PMD for GEN2.**
119 Enabled handling of mixed algorithms in encrypted digest hash-cipher
120 (generation) and cipher-hash (verification) requests in QAT PMD
121 when running on GEN2 QAT hardware with particular firmware versions
122 (GEN3 support was added in DPDK 20.02).
124 * **Added plain SHA-1,224,256,384,512 support to QAT PMD.**
126 Added support for plain SHA-1, SHA-224, SHA-256, SHA-384 and SHA-512 hashes
129 * **Added QAT intermediate buffer too small handling in QAT compression PMD.**
131 Added a special way of buffer handling when internal QAT intermediate buffer
132 is too small for Huffman dynamic compression operation. Instead of falling
133 back to fixed compression, the operation is now split into multiple smaller
134 dynamic compression requests (possible to execute on QAT) and their results
135 are then combined and copied into the output buffer. This is not possible if
136 any checksum calculation was requested - in such case the code falls back to
137 fixed compression as before.
139 * **Updated the turbo_sw bbdev PMD.**
141 Supported large size code blocks which does not fit in one mbuf segment.
143 * **Added Intel FPGA_5GNR_FEC bbdev PMD.**
145 Added a new ``fpga_5gnr_fec`` bbdev driver for the Intel\ |reg| FPGA PAC
146 (Programmable Acceleration Card) N3000. See the
147 :doc:`../bbdevs/fpga_5gnr_fec` BBDEV guide for more details on this new driver.
149 * **Updated ipsec-secgw sample application with following features.**
151 * Updated ipsec-secgw application to add event based packet processing.
152 The worker thread(s) would receive events and submit them back to the
153 event device after the processing. This way, multicore scaling and HW
154 assisted scheduling is achieved by making use of the event device
155 capabilities. The event mode currently supports only inline IPsec
158 * Updated ipsec-secgw application to support key sizes for AES-192-CBC,
159 AES-192-GCM, AES-256-GCM algorithms.
161 * Added IPsec inbound load-distribution support for ipsec-secgw application
162 using NIC load distribution feature(Flow Director).
168 .. This section should contain removed items in this release. Sample format:
170 * Add a short 1-2 sentence description of the removed item
173 This section is a comment. Do not overwrite or remove it.
174 Also, make sure to start the actual text at the margin.
175 =========================================================
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 ABI change that would break compatibility with DPDK 20.02 and 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 =========================================================