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 iavf PMD.**
86 Enable AVX2 data path for iavf PMD.
88 * **Updated the Intel e1000 driver.**
90 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
92 * **Updated the Intel ixgbe driver.**
94 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
96 * **Updated the Intel i40e driver.**
98 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
100 * **Updated the Intel fm10k driver.**
102 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
104 * **Added RX/TX packet burst mode get API.**
106 Added two new functions ``rte_eth_rx_burst_mode_get`` and
107 ``rte_eth_tx_burst_mode_get`` that allow an application
108 to retrieve the mode information about RX/TX packet burst
109 such as Scalar or Vector, and Vector technology like AVX2.
110 Another new function ``rte_eth_burst_mode_option_name`` is
111 provided for burst mode options stringification.
113 * **Updated the Intel ice driver.**
115 Updated the Intel ice driver with new features and improvements, including:
117 * Added support for device-specific DDP package loading.
118 * Added support for handling Receive Flex Descriptor.
119 * Added support for protocol extraction on per Rx queue.
120 * Added support for Flow Director filter based on generic filter framework.
121 * Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
122 * Generic filter enhancement
123 - Supported pipeline mode.
124 - Supported new packet type like PPPoE for switch filter.
125 * Supported input set change and symmetric hash by rte_flow RSS action.
127 * **Added cryptodev asymmetric session-less operation.**
129 Added session-less option to cryptodev asymmetric structure. It works the same
130 way as symmetric crypto, corresponding xform is used directly by the crypto op.
132 * **Updated the Huawei hinic driver.**
134 Updated the Huawei hinic driver with new features and improvements, including:
136 * Enabled SR-IOV - Partially supported at this point, VFIO only.
137 * Supported VLAN filter and VLAN offload.
138 * Supported Unicast MAC filter and Multicast MAC filter.
139 * Supported Flow director for LACP, VRRP, BGP and so on.
140 * Supported FW version get.
142 * **Updated Mellanox mlx5 driver.**
144 Updated Mellanox mlx5 driver with new features and improvements, including:
146 * Added support for VLAN pop flow offload command.
147 * Added support for VLAN push flow offload command.
148 * Added support for VLAN set PCP offload command.
149 * Added support for VLAN set VID offload command.
150 * Added support for matching on packets withe Geneve tunnel header.
152 * **Added Marvell NITROX symmetric crypto PMD.**
154 Added a symmetric crypto PMD for Marvell NITROX V security processor.
155 See the :doc:`../cryptodevs/nitrox` guide for more details on this new
157 * **Added asymmetric support to Marvell OCTEON TX crypto PMD.**
159 Added support for asymmetric operations in Marvell OCTEON TX cypto PMD.
160 Supports RSA and modexp operations.
162 * **Added Marvell OCTEON TX2 crypto PMD**
164 Added a new PMD driver for h/w crypto offload block on ``OCTEON TX2`` SoC.
166 See :doc:`../cryptodevs/octeontx2` for more details
168 * **Updated NXP crypto PMDs for PDCP support.**
170 PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
171 Support is added for all sequence number sizes for control and user plane.
172 Test application is updated for unit testing.
174 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
176 Added support for Single Pass GCM, available on QAT GEN3 only (Intel
177 QuickAssist Technology C4xxx). It is automatically chosen instead of the
178 classic 2-pass mode when running on QAT GEN3, significantly improving
179 the performance of AES GCM operations.
181 * **Updated the Intel QuickAssist Technology (QAT) asymmetric crypto PMD.**
183 * Added support for asymmetric session-less operations.
184 * Added support for RSA algorithm with pair (n, d) private key representation.
185 * Added support for RSA algorithm with quintuple private key representation.
187 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
189 Added stateful decompression support in the Intel QuickAssist Technology PMD.
190 Please note that stateful compression is not supported.
192 * **Added external buffers support for dpdk-test-compress-perf tool.**
194 Added a command line option to dpdk-test-compress-perf tool to allocate
195 and use memory zones as external buffers instead of keeping the data directly
198 * **Updated the IPSec library.**
200 Added SA Database API to ``librte_ipsec``. A new test-sad application is also
201 introduced to evaluate and perform custom functional and performance tests
202 for IPsec SAD implementation.
204 * **Introduced FIFO for NTB PMD.**
206 Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
207 packet based processing.
209 * **Added eBPF JIT support for arm64.**
211 Added eBPF JIT support for arm64 architecture to improve the eBPF program
214 * **Updated testpmd.**
216 * Added a console command to testpmd app, ``show port (port_id) ptypes`` which
217 gives ability to print port supported ptypes in different protocol layers.
223 .. This section should contain removed items in this release. Sample format:
225 * Add a short 1-2 sentence description of the removed item
228 This section is a comment. Do not overwrite or remove it.
229 Also, make sure to start the actual text at the margin.
230 =========================================================
232 * Removed duplicated set of commands for Rx offload configuration from testpmd::
234 port config all crc-strip|scatter|rx-cksum|rx-timestamp|
235 hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
237 The testpmd commands set that can be used instead
238 in order to enable or disable Rx offloading on all Rx queues of a port is::
240 port config <port_id> rx_offload crc_strip|scatter|
241 ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
242 vlan_strip|vlan_filter|vlan_extend on|off
248 .. This section should contain API changes. Sample format:
250 * sample: Add a short 1-2 sentence description of the API change
251 which was announced in the previous releases and made in this release.
252 Start with a scope label like "ethdev:".
253 Use fixed width quotes for ``function_names`` or ``struct_names``.
256 This section is a comment. Do not overwrite or remove it.
257 Also, make sure to start the actual text at the margin.
258 =========================================================
260 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
261 ``int`` to provide a way to report various error conditions.
263 * ethdev: changed ``rte_eth_promiscuous_enable`` and
264 ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
265 provide a way to report various error conditions.
267 * ethdev: changed ``rte_eth_allmulticast_enable`` and
268 ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
269 provide a way to report various error conditions.
271 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
272 ``int`` to provide a way to report various error conditions.
274 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
275 return value from ``void`` to ``int`` to provide a way to report various
278 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
279 ``int`` to provide a way to report various error conditions.
281 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
282 ``int`` to provide a way to report various error conditions.
284 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
285 input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
286 has been introduced in this release is used when used when all the packets
287 enqueued in the tx adapter are destined for the same Ethernet port & Tx queue.
293 .. This section should contain ABI changes. Sample format:
295 * sample: Add a short 1-2 sentence description of the ABI change
296 which was announced in the previous releases and made in this release.
297 Start with a scope label like "ethdev:".
298 Use fixed width quotes for ``function_names`` or ``struct_names``.
301 This section is a comment. Do not overwrite or remove it.
302 Also, make sure to start the actual text at the margin.
303 =========================================================
306 Shared Library Versions
307 -----------------------
309 .. Update any library version updated in this release
310 and prepend with a ``+`` sign, like this:
316 This section is a comment. Do not overwrite or remove it.
317 =========================================================
319 The libraries prepended with a plus sign were incremented in this version.
325 librte_bitratestats.so.2
328 librte_bus_fslmc.so.2
329 librte_bus_ifpga.so.2
332 librte_bus_vmbus.so.2
335 librte_compressdev.so.1
336 librte_cryptodev.so.8
337 librte_distributor.so.1
340 + librte_ethdev.so.13
341 + librte_eventdev.so.8
342 librte_flow_classify.so.1
351 librte_latencystats.so.1
365 librte_pmd_ixgbe.so.2
366 librte_pmd_dpaa2_qdma.so.1
368 librte_pmd_softnic.so.1
369 librte_pmd_vhost.so.2
387 .. This section should contain new known issues in this release. Sample format:
389 * **Add title in present tense with full stop.**
391 Add a short 1-2 sentence description of the known issue
392 in the present tense. Add information on any known workarounds.
394 This section is a comment. Do not overwrite or remove it.
395 Also, make sure to start the actual text at the margin.
396 =========================================================
402 .. This section should contain a list of platforms that were tested
407 * <vendor> platform with <vendor> <type of devices> combinations
412 * Other relevant details...
414 This section is a comment. Do not overwrite or remove it.
415 Also, make sure to start the actual text at the margin.
416 =========================================================