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_19_11.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 * **FreeBSD now supports `--base-virtaddr` EAL option.**
61 FreeBSD version now also supports setting base virtual address for mapping
62 pages and resources into its address space.
64 * **Added Lock-free Stack for aarch64.**
66 The lock-free stack implementation is enabled for aarch64 platforms.
68 * **Updated the enic driver.**
70 * Added support for Geneve with options offload.
71 * Added flow API implementation based on VIC Flow Manager API.
73 * **Added Hisilicon hns3 PMD.**
75 Added the new ``hns3`` net driver for the inbuilt Hisilicon Network
76 Subsystem 3(HNS3) network engine found in the Hisilicon Kunpeng 920 SoC.
77 See the :doc:`../nics/hns3` guide for more details on this new driver.
79 * **Added NXP PFE PMD.**
81 Added the new PFE driver for the NXP LS1012A platform. See the
82 :doc:`../nics/pfe` NIC driver guide for more details on this new driver.
84 * **Updated the Intel e1000 driver.**
86 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
88 * **Updated the Intel ixgbe driver.**
90 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
92 * **Updated the Intel i40e driver.**
94 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
96 * **Updated the Intel fm10k driver.**
98 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
100 * **Updated the Intel ice driver.**
102 Updated the Intel ice driver with new features and improvements, including:
104 * Added support for device-specific DDP package loading.
105 * Added support for handling Receive Flex Descriptor.
106 * Added support for protocol extraction on per Rx queue.
107 * Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
109 * **Added cryptodev asymmetric session-less operation.**
111 Added session-less option to cryptodev asymmetric structure. It works the same
112 way as symmetric crypto, corresponding xform is used directly by the crypto op.
114 * **Updated the Huawei hinic driver.**
116 Updated the Huawei hinic driver with new features and improvements, including:
118 * Enabled SR-IOV - Partially supported at this point, VFIO only.
120 * **Added Marvell NITROX symmetric crypto PMD.**
122 Added a symmetric crypto PMD for Marvell NITROX V security processor.
123 See the :doc:`../cryptodevs/nitrox` guide for more details on this new
125 * **Added asymmetric support to Marvell OCTEON TX crypto PMD.**
127 Added support for asymmetric operations in Marvell OCTEON TX cypto PMD.
128 Supports RSA and modexp operations.
130 * **Added Marvell OCTEON TX2 crypto PMD**
132 Added a new PMD driver for h/w crypto offload block on ``OCTEON TX2`` SoC.
134 See :doc:`../cryptodevs/octeontx2` for more details
136 * **Updated NXP crypto PMDs for PDCP support.**
138 PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
139 Support is added for all sequence number sizes for control and user plane.
140 Test application is updated for unit testing.
142 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
144 Added support for Single Pass GCM, available on QAT GEN3 only (Intel
145 QuickAssist Technology C4xxx). It is automatically chosen instead of the
146 classic 2-pass mode when running on QAT GEN3, significantly improving
147 the performance of AES GCM operations.
149 * **Updated the Intel QuickAssist Technology (QAT) asymmetric crypto PMD.**
151 * Added support for asymmetric session-less operations.
152 * Added support for RSA algorithm with pair (n, d) private key representation.
153 * Added support for RSA algorithm with quintuple private key representation.
155 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
157 Added stateful decompression support in the Intel QuickAssist Technology PMD.
158 Please note that stateful compression is not supported.
160 * **Added external buffers support for dpdk-test-compress-perf tool.**
162 Added a command line option to dpdk-test-compress-perf tool to allocate
163 and use memory zones as external buffers instead of keeping the data directly
166 * **Updated the IPSec library.**
168 Added SA Database API to ``librte_ipsec``. A new test-sad application is also
169 introduced to evaluate and perform custom functional and performance tests
170 for IPsec SAD implementation.
172 * **Introduced FIFO for NTB PMD.**
174 Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
175 packet based processing.
177 * **Added eBPF JIT support for arm64.**
179 Added eBPF JIT support for arm64 architecture to improve the eBPF program
182 * **Updated testpmd.**
184 * Added a console command to testpmd app, ``show port (port_id) ptypes`` which
185 gives ability to print port supported ptypes in different protocol layers.
191 .. This section should contain removed items in this release. Sample format:
193 * Add a short 1-2 sentence description of the removed item
196 This section is a comment. Do not overwrite or remove it.
197 Also, make sure to start the actual text at the margin.
198 =========================================================
200 * Removed duplicated set of commands for Rx offload configuration from testpmd::
202 port config all crc-strip|scatter|rx-cksum|rx-timestamp|
203 hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
205 The testpmd commands set that can be used instead
206 in order to enable or disable Rx offloading on all Rx queues of a port is::
208 port config <port_id> rx_offload crc_strip|scatter|
209 ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
210 vlan_strip|vlan_filter|vlan_extend on|off
216 .. This section should contain API changes. Sample format:
218 * sample: Add a short 1-2 sentence description of the API change
219 which was announced in the previous releases and made in this release.
220 Start with a scope label like "ethdev:".
221 Use fixed width quotes for ``function_names`` or ``struct_names``.
224 This section is a comment. Do not overwrite or remove it.
225 Also, make sure to start the actual text at the margin.
226 =========================================================
228 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
229 ``int`` to provide a way to report various error conditions.
231 * ethdev: changed ``rte_eth_promiscuous_enable`` and
232 ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
233 provide a way to report various error conditions.
235 * ethdev: changed ``rte_eth_allmulticast_enable`` and
236 ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
237 provide a way to report various error conditions.
239 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
240 ``int`` to provide a way to report various error conditions.
242 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
243 return value from ``void`` to ``int`` to provide a way to report various
246 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
247 ``int`` to provide a way to report various error conditions.
249 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
250 ``int`` to provide a way to report various error conditions.
252 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
253 input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
254 has been introduced in this release is used when used when all the packets
255 enqueued in the tx adapter are destined for the same Ethernet port & Tx queue.
261 .. This section should contain ABI changes. Sample format:
263 * sample: Add a short 1-2 sentence description of the ABI change
264 which was announced in the previous releases and made in this release.
265 Start with a scope label like "ethdev:".
266 Use fixed width quotes for ``function_names`` or ``struct_names``.
269 This section is a comment. Do not overwrite or remove it.
270 Also, make sure to start the actual text at the margin.
271 =========================================================
274 Shared Library Versions
275 -----------------------
277 .. Update any library version updated in this release
278 and prepend with a ``+`` sign, like this:
284 This section is a comment. Do not overwrite or remove it.
285 =========================================================
287 The libraries prepended with a plus sign were incremented in this version.
293 librte_bitratestats.so.2
296 librte_bus_fslmc.so.2
297 librte_bus_ifpga.so.2
300 librte_bus_vmbus.so.2
303 librte_compressdev.so.1
304 librte_cryptodev.so.8
305 librte_distributor.so.1
308 + librte_ethdev.so.13
309 + librte_eventdev.so.8
310 librte_flow_classify.so.1
319 librte_latencystats.so.1
333 librte_pmd_ixgbe.so.2
334 librte_pmd_dpaa2_qdma.so.1
336 librte_pmd_softnic.so.1
337 librte_pmd_vhost.so.2
355 .. This section should contain new known issues in this release. Sample format:
357 * **Add title in present tense with full stop.**
359 Add a short 1-2 sentence description of the known issue
360 in the present tense. Add information on any known workarounds.
362 This section is a comment. Do not overwrite or remove it.
363 Also, make sure to start the actual text at the margin.
364 =========================================================
370 .. This section should contain a list of platforms that were tested
375 * <vendor> platform with <vendor> <type of devices> combinations
380 * Other relevant details...
382 This section is a comment. Do not overwrite or remove it.
383 Also, make sure to start the actual text at the margin.
384 =========================================================
386 * **Updated Mellanox mlx5 driver.**
388 Updated Mellanox mlx5 driver with new features and improvements, including:
390 * Added support for VLAN pop flow offload command.
391 * Added support for VLAN push flow offload command.
392 * Added support for VLAN set PCP offload command.
393 * Added support for VLAN set VID offload command.