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_05.html
23 .. This section should contain new features added in this release. Sample
26 * **Add a title in the past tense with a full stop.**
28 Add a short 1-2 sentence description in the past tense. The description
29 should be enough to allow someone scanning the release notes to
30 understand the new feature.
32 If the feature adds a lot of sub-features you can use a bullet list like
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 PMD-recommended Tx and Rx parameters**
46 Applications can now query drivers for device-tuned values of
47 ring sizes, burst sizes, and number of queues.
49 * **Added RSS hash and key update to CXGBE PMD.**
51 Support to update RSS hash and key has been added to CXGBE PMD.
53 * **Added CXGBE VF PMD.**
55 CXGBE VF Poll Mode Driver has been added to run DPDK over Chelsio
56 T5/T6 NIC VF instances.
58 * **Updated Solarflare network PMD.**
60 Updated the sfc_efx driver including the following changes:
62 * Added support for Solarflare XtremeScale X2xxx family adapters.
63 * Added support for NVGRE, VXLAN and GENEVE filters in flow API.
64 * Added support for DROP action in flow API.
66 * **Added Ethernet poll mode driver for AMD XGBE devices.**
68 Added the new ``axgbe`` ethernet poll mode driver for AMD XGBE devices.
69 See the :doc:`../nics/axgbe` nic driver guide for more details on this
72 * **Added support for virtio-user server mode.**
73 In a container environment if the vhost-user backend restarts, there's no way
74 for it to reconnect to virtio-user. To address this, support for server mode
75 is added. In this mode the socket file is created by virtio-user, which the
76 backend connects to. This means that if the backend restarts, it can reconnect
77 to virtio-user and continue communications.
79 * **Added crypto workload support to vhost library.**
81 New APIs are introduced in vhost library to enable virtio crypto support
82 including session creation/deletion handling and translating virtio-crypto
83 request into DPDK crypto operations. A sample application is also introduced.
85 * **Added device event monitor framework.**
87 Added a general device event monitor framework at EAL, for device dynamic management.
88 Such as device hotplug awareness and actions adopted accordingly. The list of new APIs:
90 * ``rte_dev_event_monitor_start`` and ``rte_dev_event_monitor_stop`` are for
91 the event monitor enable and disable.
92 * ``rte_dev_event_callback_register`` and ``rte_dev_event_callback_unregister``
93 are for the user's callbacks register and unregister.
95 Linux uevent is supported as backend of this device event notification framework.
101 .. This section should contain API changes. Sample format:
103 * Add a short 1-2 sentence description of the API change. Use fixed width
104 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
107 This section is a comment. Do not overwrite or remove it.
108 Also, make sure to start the actual text at the margin.
109 =========================================================
111 * mbuf: The control mbuf API has been removed in v18.05. The impacted
112 functions and macros are:
114 - ``rte_ctrlmbuf_init()``
115 - ``rte_ctrlmbuf_alloc()``
116 - ``rte_ctrlmbuf_free()``
117 - ``rte_ctrlmbuf_data()``
118 - ``rte_ctrlmbuf_len()``
119 - ``rte_is_ctrlmbuf()``
122 The packet mbuf API should be used as a replacement.
124 * meter: updated to accommodate configuration profiles.
126 The meter API is changed to support meter configuration profiles. The
127 configuration profile represents the set of configuration parameters
128 for a given meter object, such as the rates and sizes for the token
129 buckets. These configuration parameters were previously the part of meter
130 object internal data strcuture. The separation of the configuration
131 parameters from meter object data structure results in reducing its
132 memory footprint which helps in better cache utilization when large number
133 of meter objects are used.
135 * ethdev, in struct ``struct rte_eth_dev_info``, field ``rte_pci_device *pci_dev``
136 replaced with field ``struct rte_device *device``.
138 * **Changes to semantics of rte_eth_dev_configure() parameters.**
140 If both the ``nb_rx_q`` and ``nb_tx_q`` parameters are zero,
141 ``rte_eth_dev_configure`` will now use PMD-recommended queue sizes, or if
142 recommendations are not provided by the PMD the function will use ethdev
143 fall-back values. Previously setting both of the parameters to zero would
144 have resulted in ``-EINVAL`` being returned.
146 * **Changes to semantics of rte_eth_rx_queue_setup() parameters.**
148 If the ``nb_rx_desc`` parameter is zero, ``rte_eth_rx_queue_setup`` will
149 now use the PMD-recommended Rx ring size, or in the case where the PMD
150 does not provide a recommendation, will use an ethdev-provided
151 fall-back value. Previously, setting ``nb_rx_desc`` to zero would have
152 resulted in an error.
154 * **Changes to semantics of rte_eth_tx_queue_setup() parameters.**
156 If the ``nb_tx_desc`` parameter is zero, ``rte_eth_tx_queue_setup`` will
157 now use the PMD-recommended Tx ring size, or in the case where the PMD
158 does not provide a recoomendation, will use an ethdev-provided
159 fall-back value. Previously, setting ``nb_tx_desc`` to zero would have
160 resulted in an error.
166 .. This section should contain ABI changes. Sample format:
168 * Add a short 1-2 sentence description of the ABI change that was announced
169 in the previous releases and made in this release. Use fixed width quotes
170 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
172 This section is a comment. Do not overwrite or remove it.
173 Also, make sure to start the actual text at the margin.
174 =========================================================
176 * **Additional fields in rte_eth_dev_info.**
178 The ``rte_eth_dev_info`` structure has had two extra entries appended to the
179 end of it: ``default_rxportconf`` and ``default_txportconf``. Each of these
180 in turn are ``rte_eth_dev_portconf`` structures containing three fields of
181 type ``uint16_t``: ``burst_size``, ``ring_size``, and ``nb_queues``. These
182 are parameter values recommended for use by the PMD.
187 .. This section should contain removed items in this release. Sample format:
189 * Add a short 1-2 sentence description of the removed item in the past
192 This section is a comment. Do not overwrite or remove it.
193 Also, make sure to start the actual text at the margin.
194 =========================================================
200 .. This section should contain new known issues in this release. Sample format:
202 * **Add title in present tense with full stop.**
204 Add a short 1-2 sentence description of the known issue in the present
205 tense. Add information on any known workarounds.
207 This section is a comment. Do not overwrite or remove it.
208 Also, make sure to start the actual text at the margin.
209 =========================================================
212 Shared Library Versions
213 -----------------------
215 .. Update any library version updated in this release and prepend with a ``+``
219 + librte_cfgfile.so.2
222 This section is a comment. Do not overwrite or remove it.
223 =========================================================
226 The libraries prepended with a plus sign were incremented in this version.
232 librte_bitratestats.so.2
234 librte_bus_fslmc.so.1
239 + librte_common_octeontx.so.1
240 librte_cryptodev.so.4
241 librte_distributor.so.1
245 librte_flow_classify.so.1
253 librte_latencystats.so.1
266 librte_pmd_ixgbe.so.2
268 librte_pmd_softnic.so.1
269 librte_pmd_vhost.so.2
285 .. This section should contain a list of platforms that were tested with this
290 * <vendor> platform with <vendor> <type of devices> combinations
295 * Other relevant details...
297 This section is a comment. Do not overwrite or remove it.
298 Also, make sure to start the actual text at the margin.
299 =========================================================