1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2018 The DPDK contributors
7 .. **Read this first.**
9 The text in the sections below explains how to update the release notes.
11 Use proper spelling, capitalization and punctuation in all sections.
13 Variable and config names should be quoted as fixed width text:
16 Build the docs and view the output file to ensure the changes are correct::
20 xdg-open build/doc/html/guides/rel_notes/release_18_11.html
26 .. This section should contain new features added in this release.
29 * **Add a title in the past tense with a full stop.**
31 Add a short 1-2 sentence description in the past tense.
32 The description should be enough to allow someone scanning
33 the release notes to understand the new feature.
35 If the feature adds a lot of sub-features you can use a bullet list
38 * Added feature foo to do something.
39 * Enhanced feature bar to do something else.
41 Refer to the previous release notes for examples.
43 Suggested order in release notes items:
44 * Core libs (EAL, mempool, ring, mbuf, buses)
45 * Device abstraction libs and PMDs
47 - cryptodev (lib, PMDs)
48 - eventdev (lib, PMDs)
51 * Apps, Examples, Tools (if significative)
53 This section is a comment. Do not overwrite or remove it.
54 Also, make sure to start the actual text at the margin.
55 =========================================================
57 * **Add support to offload more flow match and actions for CXGBE PMD**
59 Flow API support has been enhanced for CXGBE Poll Mode Driver to offload:
61 * Match items: destination MAC address.
62 * Action items: push/pop/rewrite vlan header.
64 * **Added a devarg to use the latest supported vector path in i40e.**
65 A new devarg ``use-latest-supported-vec`` was introduced to allow users to
66 choose the latest vector path that the platform supported. For example, users
67 can use AVX2 vector path on BDW/HSW to get better performance.
69 * **Added support for SR-IOV in netvsc PMD.**
71 The ``netvsc`` poll mode driver now supports the Accelerated Networking
72 SR-IOV option in Hyper-V and Azure. This is an alternative to the previous
73 vdev_netvsc, tap, and failsafe drivers combination.
75 * **Updated failsafe driver.**
77 Updated the failsafe driver including the following changes:
79 * Support for Rx and Tx queues start and stop.
80 * Support for Rx and Tx queues deferred start.
81 * Support for runtime Rx and Tx queues setup.
82 * Support multicast MAC address set.
84 * **Added Event Ethernet Tx Adapter.**
86 Added event ethernet Tx adapter library that provides configuration and
87 data path APIs for the ethernet transmit stage of an event driven packet
88 processing application. These APIs abstract the implementation of the
89 transmit stage and allow the application to use eventdev PMD support or
90 a common implementation.
92 * **Added Distributed Software Eventdev PMD.**
94 Added the new Distributed Software Event Device (DSW), which is a
95 pure-software eventdev driver distributing the work of scheduling
96 among all eventdev ports and the lcores using them. DSW, compared to
97 the SW eventdev PMD, sacrifices load balancing performance to
98 gain better event scheduling throughput and scalability.
100 * **Added ability to switch queue deferred start flag on testpmd app.**
102 Added a console command to testpmd app, giving ability to switch
103 ``rx_deferred_start`` or ``tx_deferred_start`` flag of the specified queue of
104 the specified port. The port must be stopped before the command call in order
105 to reconfigure queues.
111 .. This section should contain API changes. Sample format:
113 * Add a short 1-2 sentence description of the API change.
114 Use fixed width quotes for ``function_names`` or ``struct_names``.
117 This section is a comment. Do not overwrite or remove it.
118 Also, make sure to start the actual text at the margin.
119 =========================================================
121 * mbuf: The ``__rte_mbuf_raw_free()`` and ``__rte_pktmbuf_prefree_seg()``
122 functions were deprecated since 17.05 and are replaced by
123 ``rte_mbuf_raw_free()`` and ``rte_pktmbuf_prefree_seg()``.
125 * A new device flag, RTE_ETH_DEV_NOLIVE_MAC_ADDR, changes the order of
126 actions inside rte_eth_dev_start regarding MAC set. Some NICs do not
127 support MAC changes once the port has started and with this new device
128 flag the MAC can be properly configured in any case. This is particularly
129 important for bonding.
131 * The default behaviour of CRC strip offload changed. Without any specific Rx
132 offload flag, default behavior by PMD is now to strip CRC.
133 DEV_RX_OFFLOAD_CRC_STRIP offload flag has been removed.
134 To request keeping CRC, application should set ``DEV_RX_OFFLOAD_KEEP_CRC`` Rx
137 * eventdev: Type of 2nd parameter to ``rte_event_eth_rx_adapter_caps_get()``
138 has been changed from uint8_t to uint16_t.
144 .. This section should contain ABI changes. Sample format:
146 * Add a short 1-2 sentence description of the ABI change
147 that was announced in the previous releases and made in this release.
148 Use fixed width quotes for ``function_names`` or ``struct_names``.
151 This section is a comment. Do not overwrite or remove it.
152 Also, make sure to start the actual text at the margin.
153 =========================================================
155 * eal: added ``legacy_mem`` and ``single_file_segments`` values to
156 ``rte_config`` structure on account of improving DPDK usability when
157 using either ``--legacy-mem`` or ``--single-file-segments`` flags.
159 * eal: EAL library ABI version was changed due to previously announced work on
160 supporting external memory in DPDK:
161 - structure ``rte_memseg_list`` now has a new field indicating length
162 of memory addressed by the segment list
168 .. This section should contain removed items in this release. Sample format:
170 * Add a short 1-2 sentence description of the removed item
173 This section is a comment. Do not overwrite or remove it.
174 Also, make sure to start the actual text at the margin.
175 =========================================================
178 Shared Library Versions
179 -----------------------
181 .. Update any library version updated in this release
182 and prepend with a ``+`` sign, like this:
185 + librte_cfgfile.so.2
188 This section is a comment. Do not overwrite or remove it.
189 =========================================================
191 The libraries prepended with a plus sign were incremented in this version.
197 librte_bitratestats.so.2
200 librte_bus_fslmc.so.1
203 + librte_bus_vmbus.so.1
206 librte_common_octeontx.so.1
207 librte_compressdev.so.1
208 librte_cryptodev.so.5
209 librte_distributor.so.1
212 + librte_eventdev.so.6
213 librte_flow_classify.so.1
221 librte_latencystats.so.1
234 librte_pmd_ixgbe.so.2
235 librte_pmd_dpaa2_cmdif.so.1
236 librte_pmd_dpaa2_qdma.so.1
238 librte_pmd_softnic.so.1
239 librte_pmd_vhost.so.2
240 + librte_pmd_netvsc.so.1
256 .. This section should contain new known issues in this release. Sample format:
258 * **Add title in present tense with full stop.**
260 Add a short 1-2 sentence description of the known issue
261 in the present tense. Add information on any known workarounds.
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 =========================================================
267 * When using SR-IOV (VF) support with netvsc PMD and the Mellanox mlx5 bifurcated
268 driver; the Linux netvsc device must be brought up before the netvsc device is
269 unbound and passed to the DPDK.
275 .. This section should contain a list of platforms that were tested
280 * <vendor> platform with <vendor> <type of devices> combinations
285 * Other relevant details...
287 This section is a comment. Do not overwrite or remove it.
288 Also, make sure to start the actual text at the margin.
289 =========================================================