4 .. **Read this first.**
6 The text in the sections below explains how to update the release notes.
8 Use proper spelling, capitalization and punctuation in all sections.
10 Variable and config names should be quoted as fixed width text:
13 Build the docs and view the output file to ensure the changes are correct::
17 xdg-open build/doc/html/guides/rel_notes/release_18_08.html
23 .. This section should contain new features added in this release.
26 * **Add a title in the past tense with a full stop.**
28 Add a short 1-2 sentence description in the past tense.
29 The description should be enough to allow someone scanning
30 the release notes to understand the new feature.
32 If the feature adds a lot of sub-features you can use a bullet list
35 * Added feature foo to do something.
36 * Enhanced feature bar to do something else.
38 Refer to the previous release notes for examples.
40 This section is a comment. Do not overwrite or remove it.
41 Also, make sure to start the actual text at the margin.
42 =========================================================
44 * **Added support for Hyper-V netvsc PMD.**
46 The new ``netvsc`` poll mode driver provides native support for
47 networking on Hyper-V. See the :doc:`../nics/netvsc` NIC driver guide
48 for more details on this new driver.
50 * **Added Flow API support for CXGBE PMD.**
52 Flow API support has been added to CXGBE Poll Mode Driver to offload
53 flows to Chelsio T5/T6 NICs. Support added for:
54 * Wildcard (LE-TCAM) and Exact (HASH) match filters.
55 * Match items: physical ingress port, IPv4, IPv6, TCP and UDP.
56 * Action items: queue, drop, count, and physical egress port redirect.
58 * **Added ixgbe preferred Rx/Tx parameters.**
60 Rather than applications providing explicit Rx and Tx parameters such as
61 queue and burst sizes, they can request that the EAL instead uses preferred
62 values provided by the PMD, falling back to defaults within the EAL if the
63 PMD does not provide any. The provision of such tuned values now includes
66 * **Added descriptor status check support for fm10k.**
68 ``rte_eth_rx_descritpr_status`` and ``rte_eth_tx_descriptor_status``
69 are supported by fm10K.
71 * **Updated the enic driver.**
73 * Add low cycle count Tx handler for no-offload Tx.
74 * Add low cycle count Rx handler for non-scattered Rx.
75 * Minor performance improvements to scattered Rx handler.
76 * Add handlers to add/delete VxLAN port number.
77 * Add devarg to specify ingress VLAN rewrite mode.
79 * **Updated mlx5 driver.**
81 Updated the mlx5 driver including the following changes:
83 * Added port representors support.
84 * Added Flow API support for e-switch rules.
85 Supported ACTION_PORT_ID, ACTION_DROP, ACTION_OF_POP_VLAN,
86 ACTION_OF_PUSH_VLAN, ACTION_OF_SET_VLAN_VID, ACTION_OF_SET_VLAN_PCP
88 * Supported 32-bit compilation.
90 * **Added TSO support for mlx4 driver.**
92 The support is from MLNX_OFED_4.4 and above.
94 * **SoftNIC PMD rework.**
96 The SoftNIC PMD infrastructure is restructured to use the Packet Framework,
97 which makes it more flexible, modular and easier to add new functionality
100 * **Updated the AESNI MB PMD.**
102 The AESNI MB PMD has been updated with additional support for:
104 * 3DES for 8, 16 and 24 byte keys.
106 * **Added a new compression PMD using Intel's QuickAssist (QAT) device family.**
108 Added the new ``QAT`` compression driver, for compression and decompression
109 operations in software. See the :doc:`../compressdevs/qat_comp` compression
110 driver guide for details on this new driver.
112 * **Updated the ISA-L PMD.**
114 Added support for chained mbufs (input and output).
120 .. This section should contain API changes. Sample format:
122 * Add a short 1-2 sentence description of the API change.
123 Use fixed width quotes for ``function_names`` or ``struct_names``.
126 This section is a comment. Do not overwrite or remove it.
127 Also, make sure to start the actual text at the margin.
128 =========================================================
130 * Path to runtime config file has changed. The new path is determined as
133 - If DPDK is running as root, ``/var/run/dpdk/<prefix>/config``
134 - If DPDK is not running as root:
136 * If ``$XDG_RUNTIME_DIR`` is set, ``${XDG_RUNTIME_DIR}/dpdk/<prefix>/config``
137 * Otherwise, ``/tmp/dpdk/<prefix>/config``
139 * mempool: Following functions were deprecated and are removed in 18.08:
141 - ``rte_mempool_populate_iova_tab``
142 - ``rte_mempool_populate_phys_tab``
143 - ``rte_mempool_populate_phys`` (``rte_mempool_populate_iova`` should be used)
144 - ``rte_mempool_virt2phy`` (``rte_mempool_virt2iova`` should be used)
145 - ``rte_mempool_xmem_create``
146 - ``rte_mempool_xmem_size``
147 - ``rte_mempool_xmem_usage``
149 * ethdev: The old offload API is removed:
151 - Rx per-port ``rte_eth_conf.rxmode.[bit-fields]``
152 - Tx per-queue ``rte_eth_txconf.txq_flags``
153 - ``ETH_TXQ_FLAGS_NO*``
155 The transition bits are removed:
157 - ``rte_eth_conf.rxmode.ignore_offload_bitfield``
158 - ``ETH_TXQ_FLAGS_IGNORE``
160 * cryptodev: In struct ``struct rte_cryptodev_info``, field ``rte_pci_device *pci_dev``
161 has been replaced with field ``struct rte_device *device``.
162 Value 0 is accepted in ``sym.max_nb_sessions``, meaning that a device
163 supports an unlimited number of sessions.
164 Two new fields of type ``uint16_t`` have been added:
165 ``min_mbuf_headroom_req`` and ``min_mbuf_tailroom_req``.
166 These parameters specify the recommended headroom and tailroom for mbufs
167 to be processed by the PMD.
169 * cryptodev: Following functions were deprecated and are removed in 18.08:
171 - ``rte_cryptodev_queue_pair_start``
172 - ``rte_cryptodev_queue_pair_stop``
173 - ``rte_cryptodev_queue_pair_attach_sym_session``
174 - ``rte_cryptodev_queue_pair_detach_sym_session``
176 * cryptodev: Following functions were deprecated and are replaced by
177 other functions in 18.08:
179 - ``rte_cryptodev_get_header_session_size`` is replaced with
180 ``rte_cryptodev_sym_get_header_session_size``
181 - ``rte_cryptodev_get_private_session_size`` is replaced with
182 ``rte_cryptodev_sym_get_private_session_size``
184 * cryptodev: Feature flag ``RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER`` is
185 replaced with the following more explicit flags:
187 - ``RTE_CRYPTODEV_FF_IN_PLACE_SGL``
188 - ``RTE_CRYPTODEV_FF_OOP_SGL_IN_SGL_OUT``
189 - ``RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT``
190 - ``RTE_CRYPTODEV_FF_OOP_LB_IN_SGL_OUT``
191 - ``RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT``
193 * cryptodev: Renamed cryptodev experimental APIs:
195 Used user_data instead of private_data in following APIs to avoid confusion
196 with the existing session parameter ``sess_private_data[]`` and related APIs.
198 - ``rte_cryptodev_sym_session_set_private_data()`` changed to
199 ``rte_cryptodev_sym_session_set_user_data()``
200 - ``rte_cryptodev_sym_session_get_private_data()`` changed to
201 ``rte_cryptodev_sym_session_get_user_data()``
203 * compressdev: Feature flag ``RTE_COMP_FF_MBUF_SCATTER_GATHER`` is
204 replaced with the following more explicit flags:
206 - ``RTE_COMP_FF_OOP_SGL_IN_SGL_OUT``
207 - ``RTE_COMP_FF_OOP_SGL_IN_LB_OUT``
208 - ``RTE_COMP_FF_OOP_LB_IN_SGL_OUT``
214 .. This section should contain ABI changes. Sample format:
216 * Add a short 1-2 sentence description of the ABI change
217 that was announced in the previous releases and made in this release.
218 Use fixed width quotes for ``function_names`` or ``struct_names``.
221 This section is a comment. Do not overwrite or remove it.
222 Also, make sure to start the actual text at the margin.
223 =========================================================
229 .. This section should contain removed items in this release. Sample format:
231 * Add a short 1-2 sentence description of the removed item
234 This section is a comment. Do not overwrite or remove it.
235 Also, make sure to start the actual text at the margin.
236 =========================================================
239 Shared Library Versions
240 -----------------------
242 .. Update any library version updated in this release
243 and prepend with a ``+`` sign, like this:
246 + librte_cfgfile.so.2
249 This section is a comment. Do not overwrite or remove it.
250 =========================================================
252 The libraries prepended with a plus sign were incremented in this version.
258 librte_bitratestats.so.2
261 librte_bus_fslmc.so.1
264 + librte_bus_vmbus.so.1
267 librte_common_octeontx.so.1
268 librte_compressdev.so.1
269 + librte_cryptodev.so.5
270 librte_distributor.so.1
272 + librte_ethdev.so.10
274 librte_flow_classify.so.1
282 librte_latencystats.so.1
285 + librte_mempool.so.5
295 librte_pmd_ixgbe.so.2
296 librte_pmd_dpaa2_cmdif.so.1
297 librte_pmd_dpaa2_qdma.so.1
299 librte_pmd_softnic.so.1
300 librte_pmd_vhost.so.2
316 .. This section should contain new known issues in this release. Sample format:
318 * **Add title in present tense with full stop.**
320 Add a short 1-2 sentence description of the known issue
321 in the present tense. Add information on any known workarounds.
323 This section is a comment. Do not overwrite or remove it.
324 Also, make sure to start the actual text at the margin.
325 =========================================================
331 .. This section should contain a list of platforms that were tested
336 * <vendor> platform with <vendor> <type of devices> combinations
341 * Other relevant details...
343 This section is a comment. Do not overwrite or remove it.
344 Also, make sure to start the actual text at the margin.
345 =========================================================