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 * **Added RX/TX packet burst mode get API.**
102 Added two new functions ``rte_eth_rx_burst_mode_get`` and
103 ``rte_eth_tx_burst_mode_get`` that allow an application
104 to retrieve the mode information about RX/TX packet burst
105 such as Scalar or Vector, and Vector technology like AVX2.
106 Another new function ``rte_eth_burst_mode_option_name`` is
107 provided for burst mode options stringification.
109 * **Updated the Intel ice driver.**
111 Updated the Intel ice driver with new features and improvements, including:
113 * Added support for device-specific DDP package loading.
114 * Added support for handling Receive Flex Descriptor.
115 * Added support for protocol extraction on per Rx queue.
116 * Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
118 * **Added cryptodev asymmetric session-less operation.**
120 Added session-less option to cryptodev asymmetric structure. It works the same
121 way as symmetric crypto, corresponding xform is used directly by the crypto op.
123 * **Updated the Huawei hinic driver.**
125 Updated the Huawei hinic driver with new features and improvements, including:
127 * Enabled SR-IOV - Partially supported at this point, VFIO only.
128 * Supported VLAN filter and VLAN offload.
129 * Supported Unicast MAC filter and Multicast MAC filter.
130 * Supported Flow director for LACP, VRRP, BGP and so on.
131 * Supported FW version get.
133 * **Added Marvell NITROX symmetric crypto PMD.**
135 Added a symmetric crypto PMD for Marvell NITROX V security processor.
136 See the :doc:`../cryptodevs/nitrox` guide for more details on this new
138 * **Added asymmetric support to Marvell OCTEON TX crypto PMD.**
140 Added support for asymmetric operations in Marvell OCTEON TX cypto PMD.
141 Supports RSA and modexp operations.
143 * **Added Marvell OCTEON TX2 crypto PMD**
145 Added a new PMD driver for h/w crypto offload block on ``OCTEON TX2`` SoC.
147 See :doc:`../cryptodevs/octeontx2` for more details
149 * **Updated NXP crypto PMDs for PDCP support.**
151 PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
152 Support is added for all sequence number sizes for control and user plane.
153 Test application is updated for unit testing.
155 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
157 Added support for Single Pass GCM, available on QAT GEN3 only (Intel
158 QuickAssist Technology C4xxx). It is automatically chosen instead of the
159 classic 2-pass mode when running on QAT GEN3, significantly improving
160 the performance of AES GCM operations.
162 * **Updated the Intel QuickAssist Technology (QAT) asymmetric crypto PMD.**
164 * Added support for asymmetric session-less operations.
165 * Added support for RSA algorithm with pair (n, d) private key representation.
166 * Added support for RSA algorithm with quintuple private key representation.
168 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
170 Added stateful decompression support in the Intel QuickAssist Technology PMD.
171 Please note that stateful compression is not supported.
173 * **Added external buffers support for dpdk-test-compress-perf tool.**
175 Added a command line option to dpdk-test-compress-perf tool to allocate
176 and use memory zones as external buffers instead of keeping the data directly
179 * **Updated the IPSec library.**
181 Added SA Database API to ``librte_ipsec``. A new test-sad application is also
182 introduced to evaluate and perform custom functional and performance tests
183 for IPsec SAD implementation.
185 * **Introduced FIFO for NTB PMD.**
187 Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
188 packet based processing.
190 * **Added eBPF JIT support for arm64.**
192 Added eBPF JIT support for arm64 architecture to improve the eBPF program
195 * **Updated testpmd.**
197 * Added a console command to testpmd app, ``show port (port_id) ptypes`` which
198 gives ability to print port supported ptypes in different protocol layers.
204 .. This section should contain removed items in this release. Sample format:
206 * Add a short 1-2 sentence description of the removed item
209 This section is a comment. Do not overwrite or remove it.
210 Also, make sure to start the actual text at the margin.
211 =========================================================
213 * Removed duplicated set of commands for Rx offload configuration from testpmd::
215 port config all crc-strip|scatter|rx-cksum|rx-timestamp|
216 hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
218 The testpmd commands set that can be used instead
219 in order to enable or disable Rx offloading on all Rx queues of a port is::
221 port config <port_id> rx_offload crc_strip|scatter|
222 ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
223 vlan_strip|vlan_filter|vlan_extend on|off
229 .. This section should contain API changes. Sample format:
231 * sample: Add a short 1-2 sentence description of the API change
232 which was announced in the previous releases and made in this release.
233 Start with a scope label like "ethdev:".
234 Use fixed width quotes for ``function_names`` or ``struct_names``.
237 This section is a comment. Do not overwrite or remove it.
238 Also, make sure to start the actual text at the margin.
239 =========================================================
241 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
242 ``int`` to provide a way to report various error conditions.
244 * ethdev: changed ``rte_eth_promiscuous_enable`` and
245 ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
246 provide a way to report various error conditions.
248 * ethdev: changed ``rte_eth_allmulticast_enable`` and
249 ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
250 provide a way to report various error conditions.
252 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
253 ``int`` to provide a way to report various error conditions.
255 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
256 return value from ``void`` to ``int`` to provide a way to report various
259 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
260 ``int`` to provide a way to report various error conditions.
262 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
263 ``int`` to provide a way to report various error conditions.
265 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
266 input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
267 has been introduced in this release is used when used when all the packets
268 enqueued in the tx adapter are destined for the same Ethernet port & Tx queue.
274 .. This section should contain ABI changes. Sample format:
276 * sample: Add a short 1-2 sentence description of the ABI change
277 which was announced in the previous releases and made in this release.
278 Start with a scope label like "ethdev:".
279 Use fixed width quotes for ``function_names`` or ``struct_names``.
282 This section is a comment. Do not overwrite or remove it.
283 Also, make sure to start the actual text at the margin.
284 =========================================================
287 Shared Library Versions
288 -----------------------
290 .. Update any library version updated in this release
291 and prepend with a ``+`` sign, like this:
297 This section is a comment. Do not overwrite or remove it.
298 =========================================================
300 The libraries prepended with a plus sign were incremented in this version.
306 librte_bitratestats.so.2
309 librte_bus_fslmc.so.2
310 librte_bus_ifpga.so.2
313 librte_bus_vmbus.so.2
316 librte_compressdev.so.1
317 librte_cryptodev.so.8
318 librte_distributor.so.1
321 + librte_ethdev.so.13
322 + librte_eventdev.so.8
323 librte_flow_classify.so.1
332 librte_latencystats.so.1
346 librte_pmd_ixgbe.so.2
347 librte_pmd_dpaa2_qdma.so.1
349 librte_pmd_softnic.so.1
350 librte_pmd_vhost.so.2
368 .. This section should contain new known issues in this release. Sample format:
370 * **Add title in present tense with full stop.**
372 Add a short 1-2 sentence description of the known issue
373 in the present tense. Add information on any known workarounds.
375 This section is a comment. Do not overwrite or remove it.
376 Also, make sure to start the actual text at the margin.
377 =========================================================
383 .. This section should contain a list of platforms that were tested
388 * <vendor> platform with <vendor> <type of devices> combinations
393 * Other relevant details...
395 This section is a comment. Do not overwrite or remove it.
396 Also, make sure to start the actual text at the margin.
397 =========================================================
399 * **Updated Mellanox mlx5 driver.**
401 Updated Mellanox mlx5 driver with new features and improvements, including:
403 * Added support for VLAN pop flow offload command.
404 * Added support for VLAN push flow offload command.
405 * Added support for VLAN set PCP offload command.
406 * Added support for VLAN set VID offload command.