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 device event monitor framework.**
74 Added a general device event monitor framework at EAL, for device dynamic management.
75 Such as device hotplug awareness and actions adopted accordingly. The list of new APIs:
77 * ``rte_dev_event_monitor_start`` and ``rte_dev_event_monitor_stop`` are for
78 the event monitor enable and disable.
79 * ``rte_dev_event_callback_register`` and ``rte_dev_event_callback_unregister``
80 are for the user's callbacks register and unregister.
82 Linux uevent is supported as backend of this device event notification framework.
88 .. This section should contain API changes. Sample format:
90 * Add a short 1-2 sentence description of the API change. Use fixed width
91 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
94 This section is a comment. Do not overwrite or remove it.
95 Also, make sure to start the actual text at the margin.
96 =========================================================
98 * mbuf: The control mbuf API has been removed in v18.05. The impacted
99 functions and macros are:
101 - ``rte_ctrlmbuf_init()``
102 - ``rte_ctrlmbuf_alloc()``
103 - ``rte_ctrlmbuf_free()``
104 - ``rte_ctrlmbuf_data()``
105 - ``rte_ctrlmbuf_len()``
106 - ``rte_is_ctrlmbuf()``
109 The packet mbuf API should be used as a replacement.
111 * meter: updated to accommodate configuration profiles.
113 The meter API is changed to support meter configuration profiles. The
114 configuration profile represents the set of configuration parameters
115 for a given meter object, such as the rates and sizes for the token
116 buckets. These configuration parameters were previously the part of meter
117 object internal data strcuture. The separation of the configuration
118 parameters from meter object data structure results in reducing its
119 memory footprint which helps in better cache utilization when large number
120 of meter objects are used.
122 * ethdev, in struct ``struct rte_eth_dev_info``, field ``rte_pci_device *pci_dev``
123 replaced with field ``struct rte_device *device``.
125 * **Changes to semantics of rte_eth_dev_configure() parameters.**
127 If both the ``nb_rx_q`` and ``nb_tx_q`` parameters are zero,
128 ``rte_eth_dev_configure`` will now use PMD-recommended queue sizes, or if
129 recommendations are not provided by the PMD the function will use ethdev
130 fall-back values. Previously setting both of the parameters to zero would
131 have resulted in ``-EINVAL`` being returned.
133 * **Changes to semantics of rte_eth_rx_queue_setup() parameters.**
135 If the ``nb_rx_desc`` parameter is zero, ``rte_eth_rx_queue_setup`` will
136 now use the PMD-recommended Rx ring size, or in the case where the PMD
137 does not provide a recommendation, will use an ethdev-provided
138 fall-back value. Previously, setting ``nb_rx_desc`` to zero would have
139 resulted in an error.
141 * **Changes to semantics of rte_eth_tx_queue_setup() parameters.**
143 If the ``nb_tx_desc`` parameter is zero, ``rte_eth_tx_queue_setup`` will
144 now use the PMD-recommended Tx ring size, or in the case where the PMD
145 does not provide a recoomendation, will use an ethdev-provided
146 fall-back value. Previously, setting ``nb_tx_desc`` to zero would have
147 resulted in an error.
153 .. This section should contain ABI changes. Sample format:
155 * Add a short 1-2 sentence description of the ABI change that was announced
156 in the previous releases and made in this release. Use fixed width quotes
157 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
159 This section is a comment. Do not overwrite or remove it.
160 Also, make sure to start the actual text at the margin.
161 =========================================================
163 * **Additional fields in rte_eth_dev_info.**
165 The ``rte_eth_dev_info`` structure has had two extra entries appended to the
166 end of it: ``default_rxportconf`` and ``default_txportconf``. Each of these
167 in turn are ``rte_eth_dev_portconf`` structures containing three fields of
168 type ``uint16_t``: ``burst_size``, ``ring_size``, and ``nb_queues``. These
169 are parameter values recommended for use by the PMD.
174 .. This section should contain removed items in this release. Sample format:
176 * Add a short 1-2 sentence description of the removed item in the past
179 This section is a comment. Do not overwrite or remove it.
180 Also, make sure to start the actual text at the margin.
181 =========================================================
187 .. This section should contain new known issues in this release. Sample format:
189 * **Add title in present tense with full stop.**
191 Add a short 1-2 sentence description of the known issue in the present
192 tense. Add information on any known workarounds.
194 This section is a comment. Do not overwrite or remove it.
195 Also, make sure to start the actual text at the margin.
196 =========================================================
199 Shared Library Versions
200 -----------------------
202 .. Update any library version updated in this release and prepend with a ``+``
206 + librte_cfgfile.so.2
209 This section is a comment. Do not overwrite or remove it.
210 =========================================================
213 The libraries prepended with a plus sign were incremented in this version.
219 librte_bitratestats.so.2
221 librte_bus_fslmc.so.1
226 + librte_common_octeontx.so.1
227 librte_cryptodev.so.4
228 librte_distributor.so.1
232 librte_flow_classify.so.1
240 librte_latencystats.so.1
253 librte_pmd_ixgbe.so.2
255 librte_pmd_softnic.so.1
256 librte_pmd_vhost.so.2
272 .. This section should contain a list of platforms that were tested with this
277 * <vendor> platform with <vendor> <type of devices> combinations
282 * Other relevant details...
284 This section is a comment. Do not overwrite or remove it.
285 Also, make sure to start the actual text at the margin.
286 =========================================================