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 * **Added the ixgbe ethernet driver to support RSS with flow API.**
46 Rte_flow actually defined to include RSS, but till now, RSS is out of
47 rte_flow. This patch is to support igb and ixgbe NIC with existing RSS
48 configuration using rte_flow API.
50 * **Add MAC loopback support for i40e.**
52 Add MAC loopback support for i40e in order to support test task asked by
53 users. According to the device configuration, it will setup TX->RX loopback
56 * **Add the support of run time determination of number of queues per i40e VF**
58 The number of queue per VF is determined by its host PF. If the PCI address
59 of an i40e PF is aaaa:bb.cc, the number of queues per VF can be configured
60 with EAL parameter like -w aaaa:bb.cc,queue-num-per-vf=n. The value n can be
61 1, 2, 4, 8 or 16. If no such parameter is configured, the number of queues
62 per VF is 4 by default.
64 * **Added the i40e ethernet driver to support RSS with flow API.**
66 Rte_flow actually defined to include RSS, but till now, RSS is out of
67 rte_flow. This patch is to support i40e NIC with existing RSS
68 configuration using rte_flow API.It also enable queue region configuration
69 using flow API for i40e.
71 * **Added NVGRE and UDP tunnels support in Solarflare network PMD.**
73 Added support for NVGRE, VXLAN and GENEVE tunnels.
75 * Added support for UDP tunnel ports configuration.
76 * Added tunneled packets classification.
77 * Added inner checksum offload.
79 * **Added the igb ethernet driver to support RSS with flow API.**
81 Rte_flow actually defined to include RSS, but till now, RSS is out of
82 rte_flow. This patch is to support igb NIC with existing RSS configuration
85 * **Add AVF (Adaptive Virtual Function) net PMD.**
87 A new net PMD has been added, which supports IntelĀ® Ethernet Adaptive
88 Virtual Function (AVF) with features list below:
91 * SSE vectorized Rx/Tx burst
96 * Jumbo frame and MTU setting
99 * Rx/Tx descriptor status
100 * Link status update/event
102 * **Updated the AESNI-MB PMD.**
104 The AESNI-MB PMD has been updated with additional support for:
108 * **Added Wireless Base Band Device (bbdev) abstraction.**
110 The Wireless Baseband Device library is an acceleration abstraction
111 framework for 3gpp Layer 1 processing functions that provides a common
112 programming interface for seamless opeartion on integrated or discrete
113 hardware accelerators or using optimized software libraries for signal
115 The current release only supports 3GPP CRC, Turbo Coding and Rate
116 Matching operations, as specified in 3GPP TS 36.212.
118 See the :doc:`../prog_guide/bbdev` programmer's guide for more details.
120 * **Added New eventdev OPDL PMD**
122 The OPDL (Ordered Packet Distribution Library) eventdev is a specific
123 implementation of the eventdev API. It is particularly suited to packet
124 processing workloads that have high throughput and low latency requirements.
125 All packets follow the same path through the device. The order in which
126 packets follow is determinted by the order in which queues are set up.
127 Events are left on the ring until they are transmitted. As a result packets
128 do not go out of order.
130 With this change, application can use OPDL PMD by eventdev api.
132 * **Added New pipeline use case for dpdk-test-eventdev application**
134 The pipeline case can be used to simulate various stages in a real world
135 application from packet receive to transmit while maintaining the packet
136 ordering also measure the performance of the event device across the stages
139 The pipeline use case has been made generic to work will all the event
140 devices based on the capabilities.
142 * **Updated Eventdev Sample application to support event devices based on capability**
144 Updated Eventdev pipeline sample application to support various types of pipelines
145 based on the capabilities of the attached event and ethernet devices. Also,
146 renamed the application from SW PMD specific ``eventdev_pipeline_sw_pmd``
147 to PMD agnostic ``eventdev_pipeline``.
153 .. This section should contain API changes. Sample format:
155 * Add a short 1-2 sentence description of the API change. Use fixed width
156 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past
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 =========================================================
167 .. This section should contain ABI changes. Sample format:
169 * Add a short 1-2 sentence description of the ABI change that was announced
170 in the previous releases and made in this release. Use fixed width quotes
171 for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
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 removed items in this release. Sample format:
183 * Add a short 1-2 sentence description of the removed item in the past
186 This section is a comment. do not overwrite or remove it.
187 Also, make sure to start the actual text at the margin.
188 =========================================================
194 .. This section should contain new known issues in this release. Sample format:
196 * **Add title in present tense with full stop.**
198 Add a short 1-2 sentence description of the known issue in the present
199 tense. Add information on any known workarounds.
201 This section is a comment. do not overwrite or remove it.
202 Also, make sure to start the actual text at the margin.
203 =========================================================
206 Shared Library Versions
207 -----------------------
209 .. Update any library version updated in this release and prepend with a ``+``
213 + librte_cfgfile.so.2
216 This section is a comment. do not overwrite or remove it.
217 =========================================================
220 The libraries prepended with a plus sign were incremented in this version.
226 librte_bitratestats.so.2
228 librte_bus_fslmc.so.1
233 librte_cryptodev.so.4
234 librte_distributor.so.1
238 librte_flow_classify.so.1
246 librte_latencystats.so.1
259 librte_pmd_ixgbe.so.2
261 librte_pmd_softnic.so.1
262 librte_pmd_vhost.so.2
278 .. This section should contain a list of platforms that were tested with this
283 * <vendor> platform with <vendor> <type of devices> combinations
288 * Other relevant details...
290 This section is a comment. do not overwrite or remove it.
291 Also, make sure to start the actual text at the margin.
292 =========================================================