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 new API for rte_ring.**
61 * New synchronization modes for rte_ring.
63 Introduced new optional MT synchronization modes for rte_ring:
64 Relaxed Tail Sync (RTS) mode and Head/Tail Sync (HTS) mode.
65 With these mode selected, rte_ring shows significant improvements for
66 average enqueue/dequeue times on overcommitted systems.
68 * Added peek style API for rte_ring.
70 For rings with producer/consumer in RTE_RING_SYNC_ST, RTE_RING_SYNC_MT_HTS
71 mode, provide an ability to split enqueue/dequeue operation into two phases
72 (enqueue/dequeue start; enqueue/dequeue finish). That allows user to inspect
73 objects in the ring without removing them from it (aka MT safe peek).
75 * **Updated Mellanox mlx5 driver.**
77 Updated Mellanox mlx5 driver with new features and improvements, including:
79 * Added support for matching on IPv4 Time To Live and IPv6 Hop Limit.
81 * **Updated the AESNI MB crypto PMD.**
83 * Updated the AESNI MB PMD with AES-256 DOCSIS algorithm.
85 * **Added handling of mixed crypto algorithms in QAT PMD for GEN2.**
87 Enabled handling of mixed algorithms in encrypted digest hash-cipher
88 (generation) and cipher-hash (verification) requests in QAT PMD
89 when running on GEN2 QAT hardware with particular firmware versions
90 (GEN3 support was added in DPDK 20.02).
92 * **Updated the turbo_sw bbdev PMD.**
94 Supported large size code blocks which does not fit in one mbuf segment.
96 * **Updated ipsec-secgw sample application with following features.**
98 * Updated ipsec-secgw application to add event based packet processing.
99 The worker thread(s) would receive events and submit them back to the
100 event device after the processing. This way, multicore scaling and HW
101 assisted scheduling is achieved by making use of the event device
102 capabilities. The event mode currently supports only inline IPsec
105 * Updated ipsec-secgw application to support key sizes for AES-192-CBC,
106 AES-192-GCM, AES-256-GCM algorithms.
108 * Added IPsec inbound load-distribution support for ipsec-secgw application
109 using NIC load distribution feature(Flow Director).
115 .. This section should contain removed items in this release. Sample format:
117 * Add a short 1-2 sentence description of the removed item
120 This section is a comment. Do not overwrite or remove it.
121 Also, make sure to start the actual text at the margin.
122 =========================================================
128 .. This section should contain API changes. Sample format:
130 * sample: Add a short 1-2 sentence description of the API change
131 which was announced in the previous releases and made in this release.
132 Start with a scope label like "ethdev:".
133 Use fixed width quotes for ``function_names`` or ``struct_names``.
136 This section is a comment. Do not overwrite or remove it.
137 Also, make sure to start the actual text at the margin.
138 =========================================================
144 .. This section should contain ABI changes. Sample format:
146 * sample: Add a short 1-2 sentence description of the ABI change
147 which was announced in the previous releases and made in this release.
148 Start with a scope label like "ethdev:".
149 Use fixed width quotes for ``function_names`` or ``struct_names``.
152 This section is a comment. Do not overwrite or remove it.
153 Also, make sure to start the actual text at the margin.
154 =========================================================
156 * No ABI change that would break compatibility with DPDK 20.02 and 19.11.
162 .. This section should contain new known issues in this release. Sample format:
164 * **Add title in present tense with full stop.**
166 Add a short 1-2 sentence description of the known issue
167 in the present tense. Add information on any known workarounds.
169 This section is a comment. Do not overwrite or remove it.
170 Also, make sure to start the actual text at the margin.
171 =========================================================
177 .. This section should contain a list of platforms that were tested
182 * <vendor> platform with <vendor> <type of devices> combinations
187 * Other relevant details...
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 =========================================================