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 * **Added Hisilicon hns3 PMD.**
70 Added the new ``hns3`` net driver for the inbuilt Hisilicon Network
71 Subsystem 3(HNS3) network engine found in the Hisilicon Kunpeng 920 SoC.
72 See the :doc:`../nics/hns3` guide for more details on this new driver.
74 * **Updated the Intel e1000 driver.**
76 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
78 * **Updated the Intel ixgbe driver.**
80 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
82 * **Updated the Intel i40e driver.**
84 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
86 * **Updated the Intel fm10k driver.**
88 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
90 * **Updated the Intel ice driver.**
92 Updated the Intel ice driver with new features and improvements, including:
94 * Added support for device-specific DDP package loading.
95 * Added support for handling Receive Flex Descriptor.
96 * Added support for protocol extraction on per Rx queue.
97 * Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
99 * **Added cryptodev asymmetric session-less operation.**
101 Added session-less option to cryptodev asymmetric structure. It works the same
102 way as symmetric crypto, corresponding xform is used directly by the crypto op.
104 * **Added Marvell NITROX symmetric crypto PMD.**
106 Added a symmetric crypto PMD for Marvell NITROX V security processor.
107 See the :doc:`../cryptodevs/nitrox` guide for more details on this new
109 * **Added asymmetric support to Marvell OCTEON TX crypto PMD.**
111 Added support for asymmetric operations in Marvell OCTEON TX cypto PMD.
112 Supports RSA and modexp operations.
114 * **Added Marvell OCTEON TX2 crypto PMD**
116 Added a new PMD driver for h/w crypto offload block on ``OCTEON TX2`` SoC.
118 See :doc:`../cryptodevs/octeontx2` for more details
120 * **Updated NXP crypto PMDs for PDCP support.**
122 PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
123 Support is added for all sequence number sizes for control and user plane.
124 Test application is updated for unit testing.
126 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
128 Added support for Single Pass GCM, available on QAT GEN3 only (Intel
129 QuickAssist Technology C4xxx). It is automatically chosen instead of the
130 classic 2-pass mode when running on QAT GEN3, significantly improving
131 the performance of AES GCM operations.
133 * **Updated the Intel QuickAssist Technology (QAT) asymmetric crypto PMD.**
135 * Added support for asymmetric session-less operations.
136 * Added support for RSA algorithm with pair (n, d) private key representation.
137 * Added support for RSA algorithm with quintuple private key representation.
139 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
141 Added stateful decompression support in the Intel QuickAssist Technology PMD.
142 Please note that stateful compression is not supported.
144 * **Added external buffers support for dpdk-test-compress-perf tool.**
146 Added a command line option to dpdk-test-compress-perf tool to allocate
147 and use memory zones as external buffers instead of keeping the data directly
150 * **Updated the IPSec library.**
152 Added SA Database API to ``librte_ipsec``. A new test-sad application is also
153 introduced to evaluate and perform custom functional and performance tests
154 for IPsec SAD implementation.
156 * **Introduced FIFO for NTB PMD.**
158 Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
159 packet based processing.
161 * **Added eBPF JIT support for arm64.**
163 Added eBPF JIT support for arm64 architecture to improve the eBPF program
166 * **Updated testpmd.**
168 * Added a console command to testpmd app, ``show port (port_id) ptypes`` which
169 gives ability to print port supported ptypes in different protocol layers.
175 .. This section should contain removed items in this release. Sample format:
177 * Add a short 1-2 sentence description of the removed item
180 This section is a comment. Do not overwrite or remove it.
181 Also, make sure to start the actual text at the margin.
182 =========================================================
184 * Removed duplicated set of commands for Rx offload configuration from testpmd::
186 port config all crc-strip|scatter|rx-cksum|rx-timestamp|
187 hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
189 The testpmd commands set that can be used instead
190 in order to enable or disable Rx offloading on all Rx queues of a port is::
192 port config <port_id> rx_offload crc_strip|scatter|
193 ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
194 vlan_strip|vlan_filter|vlan_extend on|off
200 .. This section should contain API changes. Sample format:
202 * sample: Add a short 1-2 sentence description of the API change
203 which was announced in the previous releases and made in this release.
204 Start with a scope label like "ethdev:".
205 Use fixed width quotes for ``function_names`` or ``struct_names``.
208 This section is a comment. Do not overwrite or remove it.
209 Also, make sure to start the actual text at the margin.
210 =========================================================
212 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
213 ``int`` to provide a way to report various error conditions.
215 * ethdev: changed ``rte_eth_promiscuous_enable`` and
216 ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
217 provide a way to report various error conditions.
219 * ethdev: changed ``rte_eth_allmulticast_enable`` and
220 ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
221 provide a way to report various error conditions.
223 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
224 ``int`` to provide a way to report various error conditions.
226 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
227 return value from ``void`` to ``int`` to provide a way to report various
230 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
231 ``int`` to provide a way to report various error conditions.
233 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
234 ``int`` to provide a way to report various error conditions.
236 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
237 input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
238 has been introduced in this release is used when used when all the packets
239 enqueued in the tx adapter are destined for the same Ethernet port & Tx queue.
245 .. This section should contain ABI changes. Sample format:
247 * sample: Add a short 1-2 sentence description of the ABI change
248 which was announced in the previous releases and made in this release.
249 Start with a scope label like "ethdev:".
250 Use fixed width quotes for ``function_names`` or ``struct_names``.
253 This section is a comment. Do not overwrite or remove it.
254 Also, make sure to start the actual text at the margin.
255 =========================================================
258 Shared Library Versions
259 -----------------------
261 .. Update any library version updated in this release
262 and prepend with a ``+`` sign, like this:
268 This section is a comment. Do not overwrite or remove it.
269 =========================================================
271 The libraries prepended with a plus sign were incremented in this version.
277 librte_bitratestats.so.2
280 librte_bus_fslmc.so.2
281 librte_bus_ifpga.so.2
284 librte_bus_vmbus.so.2
287 librte_compressdev.so.1
288 librte_cryptodev.so.8
289 librte_distributor.so.1
292 + librte_ethdev.so.13
293 + librte_eventdev.so.8
294 librte_flow_classify.so.1
303 librte_latencystats.so.1
317 librte_pmd_ixgbe.so.2
318 librte_pmd_dpaa2_qdma.so.1
320 librte_pmd_softnic.so.1
321 librte_pmd_vhost.so.2
339 .. This section should contain new known issues in this release. Sample format:
341 * **Add title in present tense with full stop.**
343 Add a short 1-2 sentence description of the known issue
344 in the present tense. Add information on any known workarounds.
346 This section is a comment. Do not overwrite or remove it.
347 Also, make sure to start the actual text at the margin.
348 =========================================================
354 .. This section should contain a list of platforms that were tested
359 * <vendor> platform with <vendor> <type of devices> combinations
364 * Other relevant details...
366 This section is a comment. Do not overwrite or remove it.
367 Also, make sure to start the actual text at the margin.
368 =========================================================
370 * **Updated Mellanox mlx5 driver.**
372 Updated Mellanox mlx5 driver with new features and improvements, including:
374 * Added support for VLAN pop flow offload command.
375 * Added support for VLAN push flow offload command.
376 * Added support for VLAN set PCP offload command.
377 * Added support for VLAN set VID offload command.