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 support of dynamic fields and flags in mbuf.**
70 This new feature adds the ability to dynamically register some room
71 for a field or a flag in the mbuf structure. This is typically used
72 for specific offload features, where adding a static field or flag
73 in the mbuf is not justified.
75 * **Updated the enic driver.**
77 * Added support for Geneve with options offload.
78 * Added flow API implementation based on VIC Flow Manager API.
80 * **Added Hisilicon hns3 PMD.**
82 Added the new ``hns3`` net driver for the inbuilt Hisilicon Network
83 Subsystem 3(HNS3) network engine found in the Hisilicon Kunpeng 920 SoC.
84 See the :doc:`../nics/hns3` guide for more details on this new driver.
86 * **Added NXP PFE PMD.**
88 Added the new PFE driver for the NXP LS1012A platform. See the
89 :doc:`../nics/pfe` NIC driver guide for more details on this new driver.
91 * **Updated iavf PMD.**
93 Enable AVX2 data path for iavf PMD.
95 * **Updated the Intel e1000 driver.**
97 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
99 * **Updated the Intel ixgbe driver.**
101 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
103 * **Updated the Intel i40e driver.**
105 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
107 * **Updated the Intel fm10k driver.**
109 Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
111 * **Added RX/TX packet burst mode get API.**
113 Added two new functions ``rte_eth_rx_burst_mode_get`` and
114 ``rte_eth_tx_burst_mode_get`` that allow an application
115 to retrieve the mode information about RX/TX packet burst
116 such as Scalar or Vector, and Vector technology like AVX2.
117 Another new function ``rte_eth_burst_mode_option_name`` is
118 provided for burst mode options stringification.
120 * **Updated the Intel ice driver.**
122 Updated the Intel ice driver with new features and improvements, including:
124 * Added support for device-specific DDP package loading.
125 * Added support for handling Receive Flex Descriptor.
126 * Added support for protocol extraction on per Rx queue.
127 * Added support for Flow Director filter based on generic filter framework.
128 * Added support for the ``RTE_ETH_DEV_CLOSE_REMOVE`` flag.
129 * Generic filter enhancement
130 - Supported pipeline mode.
131 - Supported new packet type like PPPoE for switch filter.
132 * Supported input set change and symmetric hash by rte_flow RSS action.
133 * Added support for GTP Tx checksum offload.
135 * **Added cryptodev asymmetric session-less operation.**
137 Added session-less option to cryptodev asymmetric structure. It works the same
138 way as symmetric crypto, corresponding xform is used directly by the crypto op.
140 * **Updated the Huawei hinic driver.**
142 Updated the Huawei hinic driver with new features and improvements, including:
144 * Enabled SR-IOV - Partially supported at this point, VFIO only.
145 * Supported VLAN filter and VLAN offload.
146 * Supported Unicast MAC filter and Multicast MAC filter.
147 * Supported Flow director for LACP, VRRP, BGP and so on.
148 * Supported FW version get.
150 * **Updated Mellanox mlx5 driver.**
152 Updated Mellanox mlx5 driver with new features and improvements, including:
154 * Added support for VLAN pop flow offload command.
155 * Added support for VLAN push flow offload command.
156 * Added support for VLAN set PCP offload command.
157 * Added support for VLAN set VID offload command.
158 * Added support for matching on packets withe Geneve tunnel header.
160 * **Updated the AF_XDP PMD.**
162 Updated the AF_XDP PMD. The new features include:
164 * Enabled zero copy between application mempools and UMEM by enabling the
165 XDP_UMEM_UNALIGNED_CHUNKS UMEM flag.
167 * **Added Marvell NITROX symmetric crypto PMD.**
169 Added a symmetric crypto PMD for Marvell NITROX V security processor.
170 See the :doc:`../cryptodevs/nitrox` guide for more details on this new
172 * **Added asymmetric support to Marvell OCTEON TX crypto PMD.**
174 Added support for asymmetric operations in Marvell OCTEON TX cypto PMD.
175 Supports RSA and modexp operations.
177 * **Added Marvell OCTEON TX2 crypto PMD**
179 Added a new PMD driver for h/w crypto offload block on ``OCTEON TX2`` SoC.
181 See :doc:`../cryptodevs/octeontx2` for more details
183 * **Updated NXP crypto PMDs for PDCP support.**
185 PDCP support is added to DPAA_SEC and DPAA2_SEC PMDs using rte_security APIs.
186 Support is added for all sequence number sizes for control and user plane.
187 Test application is updated for unit testing.
189 * **Enabled Single Pass GCM acceleration on QAT GEN3.**
191 Added support for Single Pass GCM, available on QAT GEN3 only (Intel
192 QuickAssist Technology C4xxx). It is automatically chosen instead of the
193 classic 2-pass mode when running on QAT GEN3, significantly improving
194 the performance of AES GCM operations.
196 * **Updated the Intel QuickAssist Technology (QAT) asymmetric crypto PMD.**
198 * Added support for asymmetric session-less operations.
199 * Added support for RSA algorithm with pair (n, d) private key representation.
200 * Added support for RSA algorithm with quintuple private key representation.
202 * **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
204 Added stateful decompression support in the Intel QuickAssist Technology PMD.
205 Please note that stateful compression is not supported.
207 * **Added external buffers support for dpdk-test-compress-perf tool.**
209 Added a command line option to dpdk-test-compress-perf tool to allocate
210 and use memory zones as external buffers instead of keeping the data directly
213 * **Updated the IPSec library.**
215 Added SA Database API to ``librte_ipsec``. A new test-sad application is also
216 introduced to evaluate and perform custom functional and performance tests
217 for IPsec SAD implementation.
219 * **Introduced FIFO for NTB PMD.**
221 Introduced FIFO for NTB (Non-transparent Bridge) PMD to support
222 packet based processing.
224 * **Added eBPF JIT support for arm64.**
226 Added eBPF JIT support for arm64 architecture to improve the eBPF program
229 * **Updated testpmd.**
231 * Added a console command to testpmd app, ``show port (port_id) ptypes`` which
232 gives ability to print port supported ptypes in different protocol layers.
238 .. This section should contain removed items in this release. Sample format:
240 * Add a short 1-2 sentence description of the removed item
243 This section is a comment. Do not overwrite or remove it.
244 Also, make sure to start the actual text at the margin.
245 =========================================================
247 * Removed duplicated set of commands for Rx offload configuration from testpmd::
249 port config all crc-strip|scatter|rx-cksum|rx-timestamp|
250 hw-vlan|hw-vlan-filter|hw-vlan-strip|hw-vlan-extend on|off
252 The testpmd commands set that can be used instead
253 in order to enable or disable Rx offloading on all Rx queues of a port is::
255 port config <port_id> rx_offload crc_strip|scatter|
256 ipv4_cksum|udp_cksum|tcp_cksum|timestamp|
257 vlan_strip|vlan_filter|vlan_extend on|off
259 * Removed AF_XDP pmd_zero copy vdev argument. Support is now auto-detected.
261 * The following sample applications have been removed in this release:
264 * L3 Forwarding in a Virtualization Environment
266 * Netmap Compatibility
267 * Quota and Watermark
274 .. This section should contain API changes. Sample format:
276 * sample: Add a short 1-2 sentence description of the API 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 =========================================================
286 * The network structure ``esp_tail`` has been prefixed by ``rte_``.
288 * The network definitions of PPPoE ethertypes have been prefixed by ``RTE_``.
290 * The network structure for MPLS has been prefixed by ``rte_``.
292 * ethdev: changed ``rte_eth_dev_infos_get`` return value from ``void`` to
293 ``int`` to provide a way to report various error conditions.
295 * ethdev: changed ``rte_eth_promiscuous_enable`` and
296 ``rte_eth_promiscuous_disable`` return value from ``void`` to ``int`` to
297 provide a way to report various error conditions.
299 * ethdev: changed ``rte_eth_allmulticast_enable`` and
300 ``rte_eth_allmulticast_disable`` return value from ``void`` to ``int`` to
301 provide a way to report various error conditions.
303 * ethdev: changed ``rte_eth_dev_xstats_reset`` return value from ``void`` to
304 ``int`` to provide a way to report various error conditions.
306 * ethdev: changed ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
307 return value from ``void`` to ``int`` to provide a way to report various
310 * ethdev: changed ``rte_eth_macaddr_get`` return value from ``void`` to
311 ``int`` to provide a way to report various error conditions.
313 * ethdev: changed ``rte_eth_dev_owner_delete`` return value from ``void`` to
314 ``int`` to provide a way to report various error conditions.
316 * event: The function ``rte_event_eth_tx_adapter_enqueue`` takes an additional
317 input as ``flags``. Flag ``RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST`` which
318 has been introduced in this release is used when used when all the packets
319 enqueued in the tx adapter are destined for the same Ethernet port & Tx queue.
321 * sched: The pipe nodes configuration parameters such as number of pipes,
322 pipe queue sizes, pipe profiles, etc., are moved from port level structure
323 to subport level. This allows different subports of the same port to
324 have different configuration for the pipe nodes.
330 .. This section should contain ABI changes. Sample format:
332 * sample: Add a short 1-2 sentence description of the ABI change
333 which was announced in the previous releases and made in this release.
334 Start with a scope label like "ethdev:".
335 Use fixed width quotes for ``function_names`` or ``struct_names``.
338 This section is a comment. Do not overwrite or remove it.
339 Also, make sure to start the actual text at the margin.
340 =========================================================
343 Shared Library Versions
344 -----------------------
346 .. Update any library version updated in this release
347 and prepend with a ``+`` sign, like this:
353 This section is a comment. Do not overwrite or remove it.
354 =========================================================
356 The libraries prepended with a plus sign were incremented in this version.
362 librte_bitratestats.so.2
365 librte_bus_fslmc.so.2
366 librte_bus_ifpga.so.2
369 librte_bus_vmbus.so.2
372 librte_compressdev.so.1
373 librte_cryptodev.so.8
374 librte_distributor.so.1
377 + librte_ethdev.so.13
378 + librte_eventdev.so.8
379 librte_flow_classify.so.1
388 librte_latencystats.so.1
402 librte_pmd_ixgbe.so.2
403 librte_pmd_dpaa2_qdma.so.1
405 librte_pmd_softnic.so.1
406 librte_pmd_vhost.so.2
424 .. This section should contain new known issues in this release. Sample format:
426 * **Add title in present tense with full stop.**
428 Add a short 1-2 sentence description of the known issue
429 in the present tense. Add information on any known workarounds.
431 This section is a comment. Do not overwrite or remove it.
432 Also, make sure to start the actual text at the margin.
433 =========================================================
439 .. This section should contain a list of platforms that were tested
444 * <vendor> platform with <vendor> <type of devices> combinations
449 * Other relevant details...
451 This section is a comment. Do not overwrite or remove it.
452 Also, make sure to start the actual text at the margin.
453 =========================================================