4 .. **Read this first.**
6 The text 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: ``LIKE_THIS``.
12 Build the docs and view the output file to ensure the changes are correct::
16 firefox build/doc/html/guides/rel_notes/release_17_02.html
22 .. This section should contain new features added in this release. Sample format:
24 * **Add a title in the past tense with a full stop.**
26 Add a short 1-2 sentence description in the past tense. The description
27 should be enough to allow someone scanning the release notes to understand
30 If the feature adds a lot of sub-features you can use a bullet list like this.
32 * Added feature foo to do something.
33 * Enhanced feature bar to do something else.
35 Refer to the previous release notes for examples.
37 This section is a comment. do not overwrite or remove it.
38 Also, make sure to start the actual text at the margin.
39 =========================================================
41 * **Added generic flow API (rte_flow).**
43 This API provides a generic means to configure hardware to match specific
44 ingress or egress traffic, alter its fate and query related counters
45 according to any number of user-defined rules.
47 It is slightly higher-level than the legacy filtering framework which it
48 encompasses and supersedes (including all functions and filter types) in
49 order to expose a single interface with an unambiguous behavior that is
50 common to all poll-mode drivers (PMDs).
52 See the :ref:`Generic flow API <Generic_flow_API>` documentation for more
55 * **Added firmware version get API.**
57 Added a new function ``rte_eth_dev_fw_version_get()`` to fetch firmware
58 version by a given device.
60 * **Added APIs for MACsec offload support to the ixgbe PMD.**
62 Six new APIs have been added to the ixgbe PMD for MACsec offload support.
63 The declarations for the APIs can be found in ``rte_pmd_ixgbe.h``.
65 * **Added I219 NICs support.**
67 Added support for I219 Intel 1GbE NICs.
69 * **Added VF Daemon (VFD) on i40e. - EXPERIMENTAL**
71 This's an EXPERIMENTAL feature to enhance the capability of DPDK PF as many
72 VF management features are not supported by kernel PF driver.
73 Some new private APIs are implemented in PMD without abstrction layer.
74 They can be used directly by some users who have the need.
76 The new APIs to control VFs directly from PF include,
77 1) set VF MAC anti-spoofing
78 2) set VF VLAN anti-spoofing
80 4) set VF unicast promiscuous mode
81 5) set VF multicast promiscuous mode
85 9) set VF VLAN stripping
87 12) set VF broadcast mode
89 14) set VF VLAN filter
90 VFD also includes VF to PF mailbox message management by APP.
91 When PF receives mailbox messages from VF, PF should call the callback
92 provided by APP to know if they're permitted to be processed.
94 As an EXPERIMENTAL feature, please aware it can be changed or even
95 removed without prior notice.
97 * **Updated the i40e base driver.**
99 updated the i40e base driver, including the following changes:
101 * replace existing legacy memcpy() calls with i40e_memcpy() calls.
102 * use BIT() macro instead of bit fields
103 * add clear all WoL filters implementation
104 * add broadcast promiscuous control per VLAN
105 * remove unused X722_SUPPORT and I40E_NDIS_SUPPORT MARCOs
107 * **Added Solarflare libefx-based network PMD.**
109 A new network PMD which supports Solarflare SFN7xxx and SFN8xxx family
110 of 10/40 Gbps adapters has been added.
112 * **Added support for Mellanox ConnectX-5 adapters (mlx5).**
114 Support for Mellanox ConnectX-5 family of 10/25/40/50/100 Gbps adapters
115 has been added to the existing mlx5 PMD.
117 * **virtio-user with vhost-kernel as another exceptional path.**
119 Previously, we upstreamed a virtual device, virtio-user with vhost-user
120 as the backend, as a way for IPC (Inter-Process Communication) and user
121 space container networking.
123 Virtio-user with vhost-kernel as the backend is a solution for exceptional
124 path, such as KNI, which exchanges packets with kernel networking stack.
125 This solution is very promising in:
127 * maintenance: vhost and vhost-net (kernel) is upstreamed and extensively
129 * features: vhost-net is born to be a networking solution, which has
130 lots of networking related features, like multi-queue, TSO, multi-seg
132 * performance: similar to KNI, this solution would use one or more
133 kthreads to send/receive packets from user space DPDK applications,
134 which has little impact on user space polling thread (except that
135 it might enter into kernel space to wake up those kthreads if
138 * **Added virtio Rx interrupt suppprt.**
140 This feature enables Rx interrupt mode for virtio pci net devices as
141 binded to VFIO (noiommu mode) and drived by virtio PMD.
143 With this feature, virtio PMD can switch between polling mode and
144 interrupt mode, to achieve best performance, and at the same time save
145 power. It can work on both legacy and modern virtio devices. At this mode,
146 each rxq is mapped with an exluded MSIx interrupt.
148 See the :ref:`Virtio Interrupt Mode <virtio_interrupt_mode>` documentation
149 for more information.
151 * **Updated the QAT PMD.**
153 The QAT PMD was updated with additional support for:
156 * Scatter-gather list (SGL) support.
158 * **Added Elastic Flow Distributor library (rte_efd).**
160 This new library uses perfect hashing to determine a target/value for a
161 given incoming flow key.
163 It does not store the key itself for lookup operations, and therefore,
164 lookup performance is not dependent on the key size. Also, the target/value
165 can be any arbitrary value (8 bits by default). Finally, the storage requirement
166 is much smaller than a hash-based flow table and therefore, it can better fit for
167 CPU cache, being able to scale to millions of flow keys.
169 See the :ref:`Elastic Flow Distributor Library <Efd_Library>` documentation in
170 the Programmers Guide document, for more information.
176 .. This section should contain bug fixes added to the relevant sections. Sample format:
178 * **code/section Fixed issue in the past tense with a full stop.**
180 Add a short 1-2 sentence description of the resolved issue in the past tense.
181 The title should contain the code/lib section like a commit message.
182 Add the entries in alphabetic order in the relevant sections below.
184 This section is a comment. do not overwrite or remove it.
185 Also, make sure to start the actual text at the margin.
186 =========================================================
196 * **net/virtio: Fixed multiple process support.**
198 Fixed few regressions introduced in recent releases that break the virtio
199 multiple process support.
209 * **examples/ethtool: Fixed crash with non-PCI devices.**
211 Querying a non-PCI device was dereferencing non-existent PCI data
212 resulting in a segmentation fault.
222 .. This section should contain new known issues in this release. Sample format:
224 * **Add title in present tense with full stop.**
226 Add a short 1-2 sentence description of the known issue in the present
227 tense. Add information on any known workarounds.
229 This section is a comment. do not overwrite or remove it.
230 Also, make sure to start the actual text at the margin.
231 =========================================================
237 .. This section should contain API changes. Sample format:
239 * Add a short 1-2 sentence description of the API change. Use fixed width
240 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
242 This section is a comment. do not overwrite or remove it.
243 Also, make sure to start the actual text at the margin.
244 =========================================================
246 * **Moved five APIs for VF management from the ethdev to the ixgbe PMD.**
248 The following five APIs for VF management from the PF have been removed from the ethdev,
249 renamed and added to the ixgbe PMD::
251 rte_eth_dev_set_vf_rate_limit
252 rte_eth_dev_set_vf_rx
253 rte_eth_dev_set_vf_rxmode
254 rte_eth_dev_set_vf_tx
255 rte_eth_dev_set_vf_vlan_filter
257 The API's have been renamed to the following::
259 rte_pmd_ixgbe_set_vf_rate_limit
260 rte_pmd_ixgbe_set_vf_rx
261 rte_pmd_ixgbe_set_vf_rxmode
262 rte_pmd_ixgbe_set_vf_tx
263 rte_pmd_ixgbe_set_vf_vlan_filter
265 The declarations for the API’s can be found in ``rte_pmd_ixgbe.h``.
270 .. This section should contain ABI changes. Sample format:
272 * Add a short 1-2 sentence description of the ABI change that was announced in
273 the previous releases and made in this release. Use fixed width quotes for
274 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
276 This section is a comment. do not overwrite or remove it.
277 Also, make sure to start the actual text at the margin.
278 =========================================================
282 Shared Library Versions
283 -----------------------
285 .. Update any library version updated in this release and prepend with a ``+``
289 + librte_cfgfile.so.2
292 This section is a comment. do not overwrite or remove it.
293 =========================================================
296 The libraries prepended with a plus sign were incremented in this version.
303 librte_cryptodev.so.2
304 librte_distributor.so.1
334 .. This section should contain a list of platforms that were tested with this release.
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 =========================================================
351 .. This section should contain a list of NICs that were tested with this release.
360 This section is a comment. do not overwrite or remove it.
361 Also, make sure to start the actual text at the margin.
362 =========================================================
368 .. This section should contain a list of OSes that were tested with this release.
369 The format is as follows, in alphabetical order:
375 * Red Hat Enterprise Linux 7.2
376 * SUSE Enterprise Linux 12
381 This section is a comment. do not overwrite or remove it.
382 Also, make sure to start the actual text at the margin.
383 =========================================================