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 * **Added Solarflare libefx-based network PMD.**
99 A new network PMD which supports Solarflare SFN7xxx and SFN8xxx family
100 of 10/40 Gbps adapters has been added.
102 * **Added support for Mellanox ConnectX-5 adapters (mlx5).**
104 Support for Mellanox ConnectX-5 family of 10/25/40/50/100 Gbps adapters
105 has been added to the existing mlx5 PMD.
107 * **virtio-user with vhost-kernel as another exceptional path.**
109 Previously, we upstreamed a virtual device, virtio-user with vhost-user
110 as the backend, as a way for IPC (Inter-Process Communication) and user
111 space container networking.
113 Virtio-user with vhost-kernel as the backend is a solution for exceptional
114 path, such as KNI, which exchanges packets with kernel networking stack.
115 This solution is very promising in:
117 * maintenance: vhost and vhost-net (kernel) is upstreamed and extensively
119 * features: vhost-net is born to be a networking solution, which has
120 lots of networking related features, like multi-queue, TSO, multi-seg
122 * performance: similar to KNI, this solution would use one or more
123 kthreads to send/receive packets from user space DPDK applications,
124 which has little impact on user space polling thread (except that
125 it might enter into kernel space to wake up those kthreads if
128 * **Added virtio Rx interrupt suppprt.**
130 This feature enables Rx interrupt mode for virtio pci net devices as
131 binded to VFIO (noiommu mode) and drived by virtio PMD.
133 With this feature, virtio PMD can switch between polling mode and
134 interrupt mode, to achieve best performance, and at the same time save
135 power. It can work on both legacy and modern virtio devices. At this mode,
136 each rxq is mapped with an exluded MSIx interrupt.
138 See the :ref:`Virtio Interrupt Mode <virtio_interrupt_mode>` documentation
139 for more information.
145 .. This section should contain bug fixes added to the relevant sections. Sample format:
147 * **code/section Fixed issue in the past tense with a full stop.**
149 Add a short 1-2 sentence description of the resolved issue in the past tense.
150 The title should contain the code/lib section like a commit message.
151 Add the entries in alphabetic order in the relevant sections below.
153 This section is a comment. do not overwrite or remove it.
154 Also, make sure to start the actual text at the margin.
155 =========================================================
165 * **net/virtio: Fixed multiple process support.**
167 Fixed few regressions introduced in recent releases that break the virtio
168 multiple process support.
178 * **examples/ethtool: Fixed crash with non-PCI devices.**
180 Querying a non-PCI device was dereferencing non-existent PCI data
181 resulting in a segmentation fault.
191 .. This section should contain new known issues in this release. Sample format:
193 * **Add title in present tense with full stop.**
195 Add a short 1-2 sentence description of the known issue in the present
196 tense. Add information on any known workarounds.
198 This section is a comment. do not overwrite or remove it.
199 Also, make sure to start the actual text at the margin.
200 =========================================================
206 .. This section should contain API changes. Sample format:
208 * Add a short 1-2 sentence description of the API change. Use fixed width
209 quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
211 This section is a comment. do not overwrite or remove it.
212 Also, make sure to start the actual text at the margin.
213 =========================================================
215 * **Moved five APIs for VF management from the ethdev to the ixgbe PMD.**
217 The following five APIs for VF management from the PF have been removed from the ethdev,
218 renamed and added to the ixgbe PMD::
220 rte_eth_dev_set_vf_rate_limit
221 rte_eth_dev_set_vf_rx
222 rte_eth_dev_set_vf_rxmode
223 rte_eth_dev_set_vf_tx
224 rte_eth_dev_set_vf_vlan_filter
226 The API's have been renamed to the following::
228 rte_pmd_ixgbe_set_vf_rate_limit
229 rte_pmd_ixgbe_set_vf_rx
230 rte_pmd_ixgbe_set_vf_rxmode
231 rte_pmd_ixgbe_set_vf_tx
232 rte_pmd_ixgbe_set_vf_vlan_filter
234 The declarations for the API’s can be found in ``rte_pmd_ixgbe.h``.
239 .. This section should contain ABI changes. Sample format:
241 * Add a short 1-2 sentence description of the ABI change that was announced in
242 the previous releases and made in this release. Use fixed width quotes for
243 ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
245 This section is a comment. do not overwrite or remove it.
246 Also, make sure to start the actual text at the margin.
247 =========================================================
251 Shared Library Versions
252 -----------------------
254 .. Update any library version updated in this release and prepend with a ``+``
258 + librte_cfgfile.so.2
261 This section is a comment. do not overwrite or remove it.
262 =========================================================
265 The libraries prepended with a plus sign were incremented in this version.
272 librte_cryptodev.so.2
273 librte_distributor.so.1
303 .. This section should contain a list of platforms that were tested with this release.
312 This section is a comment. do not overwrite or remove it.
313 Also, make sure to start the actual text at the margin.
314 =========================================================
320 .. This section should contain a list of NICs that were tested with this release.
329 This section is a comment. do not overwrite or remove it.
330 Also, make sure to start the actual text at the margin.
331 =========================================================
337 .. This section should contain a list of OSes that were tested with this release.
338 The format is as follows, in alphabetical order:
344 * Red Hat Enterprise Linux 7.2
345 * SUSE Enterprise Linux 12
350 This section is a comment. do not overwrite or remove it.
351 Also, make sure to start the actual text at the margin.
352 =========================================================