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_02.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 * **Add function to allow releasing internal EAL resources on exit**
46 During ``rte_eal_init()`` EAL allocates memory from hugepages to enable its
47 core libraries to perform their tasks. The ``rte_eal_cleanup()`` function
48 releases these resources, ensuring that no hugepage memory is leaked. It is
49 expected that all DPDK applications call ``rte_eal_cleanup()`` before
50 exiting. Not calling this function could result in leaking hugepages, leading
51 to failure during initialization of secondary processes.
53 * **Added the ixgbe ethernet driver to support RSS with flow API.**
55 Rte_flow actually defined to include RSS, but till now, RSS is out of
56 rte_flow. This patch is to support igb and ixgbe NIC with existing RSS
57 configuration using rte_flow API.
59 * **Add MAC loopback support for i40e.**
61 Add MAC loopback support for i40e in order to support test task asked by
62 users. According to the device configuration, it will setup TX->RX loopback
65 * **Add the support of run time determination of number of queues per i40e VF**
67 The number of queue per VF is determined by its host PF. If the PCI address
68 of an i40e PF is aaaa:bb.cc, the number of queues per VF can be configured
69 with EAL parameter like -w aaaa:bb.cc,queue-num-per-vf=n. The value n can be
70 1, 2, 4, 8 or 16. If no such parameter is configured, the number of queues
71 per VF is 4 by default.
73 * **Added the i40e ethernet driver to support RSS with flow API.**
75 Rte_flow actually defined to include RSS, but till now, RSS is out of
76 rte_flow. This patch is to support i40e NIC with existing RSS
77 configuration using rte_flow API.It also enable queue region configuration
78 using flow API for i40e.
80 * **Added NVGRE and UDP tunnels support in Solarflare network PMD.**
82 Added support for NVGRE, VXLAN and GENEVE tunnels.
84 * Added support for UDP tunnel ports configuration.
85 * Added tunneled packets classification.
86 * Added inner checksum offload.
88 * **Added the igb ethernet driver to support RSS with flow API.**
90 Rte_flow actually defined to include RSS, but till now, RSS is out of
91 rte_flow. This patch is to support igb NIC with existing RSS configuration
94 * **Add AVF (Adaptive Virtual Function) net PMD.**
96 A new net PMD has been added, which supports IntelĀ® Ethernet Adaptive
97 Virtual Function (AVF) with features list below:
100 * SSE vectorized Rx/Tx burst
105 * Jumbo frame and MTU setting
108 * Rx/Tx descriptor status
109 * Link status update/event
111 * **Updated the AESNI-MB PMD.**
113 The AESNI-MB PMD has been updated with additional support for:
117 * **Updated the DPAA_SEC crypto driver to support rte_security.**
119 Updated the ``dpaa_sec`` crypto PMD to support ``rte_security`` lookaside
120 protocol offload for IPSec.
122 * **Added Wireless Base Band Device (bbdev) abstraction.**
124 The Wireless Baseband Device library is an acceleration abstraction
125 framework for 3gpp Layer 1 processing functions that provides a common
126 programming interface for seamless opeartion on integrated or discrete
127 hardware accelerators or using optimized software libraries for signal
129 The current release only supports 3GPP CRC, Turbo Coding and Rate
130 Matching operations, as specified in 3GPP TS 36.212.
132 See the :doc:`../prog_guide/bbdev` programmer's guide for more details.
134 * **Added New eventdev OPDL PMD**
136 The OPDL (Ordered Packet Distribution Library) eventdev is a specific
137 implementation of the eventdev API. It is particularly suited to packet
138 processing workloads that have high throughput and low latency requirements.
139 All packets follow the same path through the device. The order in which
140 packets follow is determinted by the order in which queues are set up.
141 Events are left on the ring until they are transmitted. As a result packets
142 do not go out of order.
144 With this change, application can use OPDL PMD by eventdev api.
146 * **Added New pipeline use case for dpdk-test-eventdev application**
148 The pipeline case can be used to simulate various stages in a real world
149 application from packet receive to transmit while maintaining the packet
150 ordering also measure the performance of the event device across the stages
153 The pipeline use case has been made generic to work will all the event
154 devices based on the capabilities.
156 * **Updated Eventdev Sample application to support event devices based on capability**
158 Updated Eventdev pipeline sample application to support various types of pipelines
159 based on the capabilities of the attached event and ethernet devices. Also,
160 renamed the application from SW PMD specific ``eventdev_pipeline_sw_pmd``
161 to PMD agnostic ``eventdev_pipeline``.
167 .. This section should contain API changes. Sample format:
169 * Add a short 1-2 sentence description of the API change. Use fixed width
170 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
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 =========================================================
181 .. This section should contain ABI changes. Sample format:
183 * Add a short 1-2 sentence description of the ABI change that was announced
184 in the previous releases and made in this release. Use fixed width quotes
185 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
187 This section is a comment. do not overwrite or remove it.
188 Also, make sure to start the actual text at the margin.
189 =========================================================
195 .. This section should contain removed items in this release. Sample format:
197 * Add a short 1-2 sentence description of the removed item in the past
200 This section is a comment. do not overwrite or remove it.
201 Also, make sure to start the actual text at the margin.
202 =========================================================
208 .. This section should contain new known issues in this release. Sample format:
210 * **Add title in present tense with full stop.**
212 Add a short 1-2 sentence description of the known issue in the present
213 tense. Add information on any known workarounds.
215 This section is a comment. do not overwrite or remove it.
216 Also, make sure to start the actual text at the margin.
217 =========================================================
220 Shared Library Versions
221 -----------------------
223 .. Update any library version updated in this release and prepend with a ``+``
227 + librte_cfgfile.so.2
230 This section is a comment. do not overwrite or remove it.
231 =========================================================
234 The libraries prepended with a plus sign were incremented in this version.
240 librte_bitratestats.so.2
242 librte_bus_fslmc.so.1
247 librte_cryptodev.so.4
248 librte_distributor.so.1
252 librte_flow_classify.so.1
260 librte_latencystats.so.1
273 librte_pmd_ixgbe.so.2
275 librte_pmd_softnic.so.1
276 librte_pmd_vhost.so.2
292 .. This section should contain a list of platforms that were tested with this
297 * <vendor> platform with <vendor> <type of devices> combinations
302 * Other relevant details...
304 This section is a comment. do not overwrite or remove it.
305 Also, make sure to start the actual text at the margin.
306 =========================================================