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 * **Added Marvell NITROX symmetric crypto PMD.**
116 Added a symmetric crypto PMD for Marvell NITROX V security processor.
117 See the :doc:`../cryptodevs/nitrox` guide for more details on this new
119 * **Added asymmetric support to Marvell OCTEON TX crypto PMD.**
121 Added support for asymmetric operations in Marvell OCTEON TX cypto PMD.
122 Supports RSA and modexp operations.
124 * **Added Marvell OCTEON TX2 crypto PMD**
126 Added a new PMD driver for h/w crypto offload block on ``OCTEON TX2`` SoC.
128 See :doc:`../cryptodevs/octeontx2` for more details
130 * **Updated NXP crypto PMDs for PDCP support.**
132 PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
133 Support is added for all sequence number sizes for control and user plane.
134 Test application is updated for unit testing.
136 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
138 Added support for Single Pass GCM, available on QAT GEN3 only (Intel
139 QuickAssist Technology C4xxx). It is automatically chosen instead of the
140 classic 2-pass mode when running on QAT GEN3, significantly improving
141 the performance of AES GCM operations.
143 * **Updated the Intel QuickAssist Technology (QAT) asymmetric crypto PMD.**
145 * Added support for asymmetric session-less operations.
146 * Added support for RSA algorithm with pair (n, d) private key representation.
147 * Added support for RSA algorithm with quintuple private key representation.
149 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
151 Added stateful decompression support in the Intel QuickAssist Technology PMD.
152 Please note that stateful compression is not supported.
154 * **Added external buffers support for dpdk-test-compress-perf tool.**
156 Added a command line option to dpdk-test-compress-perf tool to allocate
157 and use memory zones as external buffers instead of keeping the data directly
160 * **Updated the IPSec library.**
162 Added SA Database API to ``librte_ipsec``. A new test-sad application is also
163 introduced to evaluate and perform custom functional and performance tests
164 for IPsec SAD implementation.
166 * **Introduced FIFO for NTB PMD.**
168 Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
169 packet based processing.
171 * **Added eBPF JIT support for arm64.**
173 Added eBPF JIT support for arm64 architecture to improve the eBPF program
176 * **Updated testpmd.**
178 * Added a console command to testpmd app, ``show port (port_id) ptypes`` which
179 gives ability to print port supported ptypes in different protocol layers.
185 .. This section should contain removed items in this release. Sample format:
187 * Add a short 1-2 sentence description of the removed item
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 * Removed duplicated set of commands for Rx offload configuration from testpmd::
196 port config all crc-strip|scatter|rx-cksum|rx-timestamp|
197 hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
199 The testpmd commands set that can be used instead
200 in order to enable or disable Rx offloading on all Rx queues of a port is::
202 port config <port_id> rx_offload crc_strip|scatter|
203 ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
204 vlan_strip|vlan_filter|vlan_extend on|off
210 .. This section should contain API changes. Sample format:
212 * sample: Add a short 1-2 sentence description of the API change
213 which was announced in the previous releases and made in this release.
214 Start with a scope label like "ethdev:".
215 Use fixed width quotes for ``function_names`` or ``struct_names``.
218 This section is a comment. Do not overwrite or remove it.
219 Also, make sure to start the actual text at the margin.
220 =========================================================
222 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
223 ``int`` to provide a way to report various error conditions.
225 * ethdev: changed ``rte_eth_promiscuous_enable`` and
226 ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
227 provide a way to report various error conditions.
229 * ethdev: changed ``rte_eth_allmulticast_enable`` and
230 ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
231 provide a way to report various error conditions.
233 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
234 ``int`` to provide a way to report various error conditions.
236 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
237 return value from ``void`` to ``int`` to provide a way to report various
240 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
241 ``int`` to provide a way to report various error conditions.
243 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
244 ``int`` to provide a way to report various error conditions.
246 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
247 input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
248 has been introduced in this release is used when used when all the packets
249 enqueued in the tx adapter are destined for the same Ethernet port & Tx queue.
255 .. This section should contain ABI changes. Sample format:
257 * sample: Add a short 1-2 sentence description of the ABI change
258 which was announced in the previous releases and made in this release.
259 Start with a scope label like "ethdev:".
260 Use fixed width quotes for ``function_names`` or ``struct_names``.
263 This section is a comment. Do not overwrite or remove it.
264 Also, make sure to start the actual text at the margin.
265 =========================================================
268 Shared Library Versions
269 -----------------------
271 .. Update any library version updated in this release
272 and prepend with a ``+`` sign, like this:
278 This section is a comment. Do not overwrite or remove it.
279 =========================================================
281 The libraries prepended with a plus sign were incremented in this version.
287 librte_bitratestats.so.2
290 librte_bus_fslmc.so.2
291 librte_bus_ifpga.so.2
294 librte_bus_vmbus.so.2
297 librte_compressdev.so.1
298 librte_cryptodev.so.8
299 librte_distributor.so.1
302 + librte_ethdev.so.13
303 + librte_eventdev.so.8
304 librte_flow_classify.so.1
313 librte_latencystats.so.1
327 librte_pmd_ixgbe.so.2
328 librte_pmd_dpaa2_qdma.so.1
330 librte_pmd_softnic.so.1
331 librte_pmd_vhost.so.2
349 .. This section should contain new known issues in this release. Sample format:
351 * **Add title in present tense with full stop.**
353 Add a short 1-2 sentence description of the known issue
354 in the present tense. Add information on any known workarounds.
356 This section is a comment. Do not overwrite or remove it.
357 Also, make sure to start the actual text at the margin.
358 =========================================================
364 .. This section should contain a list of platforms that were tested
369 * <vendor> platform with <vendor> <type of devices> combinations
374 * Other relevant details...
376 This section is a comment. Do not overwrite or remove it.
377 Also, make sure to start the actual text at the margin.
378 =========================================================
380 * **Updated Mellanox mlx5 driver.**
382 Updated Mellanox mlx5 driver with new features and improvements, including:
384 * Added support for VLAN pop flow offload command.
385 * Added support for VLAN push flow offload command.
386 * Added support for VLAN set PCP offload command.
387 * Added support for VLAN set VID offload command.