net/bnxt: support VLAN push and pop actions
[dpdk.git] / doc / guides / rel_notes / release_20_08.rst
1 .. SPDX-License-Identifier: BSD-3-Clause
2    Copyright 2020 The DPDK contributors
3
4 .. include:: <isonum.txt>
5
6 DPDK Release 20.08
7 ==================
8
9 .. **Read this first.**
10
11    The text in the sections below explains how to update the release notes.
12
13    Use proper spelling, capitalization and punctuation in all sections.
14
15    Variable and config names should be quoted as fixed width text:
16    ``LIKE_THIS``.
17
18    Build the docs and view the output file to ensure the changes are correct::
19
20       make doc-guides-html
21
22       xdg-open build/doc/html/guides/rel_notes/release_20_08.html
23
24
25 New Features
26 ------------
27
28 .. This section should contain new features added in this release.
29    Sample format:
30
31    * **Add a title in the past tense with a full stop.**
32
33      Add a short 1-2 sentence description in the past tense.
34      The description should be enough to allow someone scanning
35      the release notes to understand the new feature.
36
37      If the feature adds a lot of sub-features you can use a bullet list
38      like this:
39
40      * Added feature foo to do something.
41      * Enhanced feature bar to do something else.
42
43      Refer to the previous release notes for examples.
44
45      Suggested order in release notes items:
46      * Core libs (EAL, mempool, ring, mbuf, buses)
47      * Device abstraction libs and PMDs
48        - ethdev (lib, PMDs)
49        - cryptodev (lib, PMDs)
50        - eventdev (lib, PMDs)
51        - etc
52      * Other libs
53      * Apps, Examples, Tools (if significant)
54
55      This section is a comment. Do not overwrite or remove it.
56      Also, make sure to start the actual text at the margin.
57      =========================================================
58
59 * **Added non-EAL threads registration API.**
60
61   Added a new API to register non-EAL threads as lcores. This can be used by
62   applications to have its threads known of DPDK without suffering from the
63   non-EAL previous limitations in terms of performance.
64
65 * **rte_*mb APIs are updated to use DMB instruction for ARMv8.**
66
67   ARMv8 memory model has been strengthened to require other-multi-copy
68   atomicity. This allows for using DMB instruction instead of DSB for IO
69   barriers. rte_*mb APIs, for ARMv8 platforms, are changed to use DMB
70   instruction to reflect this.
71
72 * **Added the support for vfio-pci new VF token interface.**
73
74   From Linux 5.7, vfio-pci supports to bind both SR-IOV PF and the created VFs,
75   it uses a shared VF token (UUID) to represent the collaboration between PF
76   and VFs. Update DPDK PCI driver to gain the access to the PF and VFs devices
77   by appending the VF token parameter.
78
79 * **Added the RegEx Library, a generic RegEx service library.**
80
81   Added the RegEx library which provides an API for offload of regular
82   expressions search operations to hardware or software accelerator devices.
83
84 * **Updated PCAP driver.**
85
86   Updated PCAP driver with new features and improvements, including:
87
88   * Support software Tx nanosecond timestamps precision.
89
90 * **Updated Broadcom bnxt driver.**
91
92   Updated the Broadcom bnxt driver with new features and improvements, including:
93
94   * Added support for VF representors.
95   * Added support for multiple devices.
96   * Added support for new resource manager API.
97   * Added support for VXLAN encap/decap.
98   * Added support for rte_flow_query for COUNT action.
99   * Added support for rx_burst_mode_get and tx_burst_mode_get.
100   * Added vector mode support for ARM CPUs.
101   * Added support for VLAN push and pop actions.
102
103 * **Updated Mellanox mlx5 driver.**
104
105   Updated Mellanox mlx5 driver with new features and improvements, including:
106
107   * Added new PMD devarg ``reclaim_mem_mode``.
108   * Added new devarg ``lacp_by_user``.
109
110 * **Added vDPA device APIs to query virtio queue statistics.**
111
112      A new 3 APIs has been added to query virtio queue statistics, to get their
113      names and to reset them by a vDPA device.
114
115 * **Updated Mellanox mlx5 vDPA driver.**
116
117   Updated Mellanox mlx5 vDPA driver with new features, including:
118
119   * Added support for virtio queue statistics.
120   * Added support for MTU update.
121
122 * **Updated Marvell octeontx2 ethdev PMD.**
123
124   Updated Marvell octeontx2 driver with cn98xx support.
125
126 * **Updated the Intel ice driver.**
127
128   Updated the Intel ice driver with new features and improvements, including:
129
130   * Added support for DCF datapath configuration.
131   * Added support for more PPPoE packet type for switch filter.
132
133 * **Updated Intel i40e driver.**
134
135   Updated i40e PMD with new features and improvements, including:
136
137   * Supported cloud filter for IPv4/6_TCP/UDP/SCTP with SRC port only or DST port only.
138   * Re-implemented get_fdir_info and get_fdir_stat in private API.
139   * Re-implemented set_gre_key_len in private API.
140   * Added support for flow query RSS.
141
142 * **Updated the Intel ixgbe driver.**
143
144   Updated the Intel ixgbe driver with new features and improvements, including:
145
146   * Re-implemented get_fdir_info and get_fdir_stat in private API.
147
148 * **Updated NXP dpaa ethdev PMD.**
149
150   Updated the NXP dpaa ethdev with new features and improvements, including:
151
152   * Added support for link status and interrupt
153   * Added support to use datapath APIs from non-EAL pthread
154
155 * **Updated NXP dpaa2 ethdev PMD.**
156
157   Updated the NXP dpaa2 ethdev with new features and improvements, including:
158
159   * Added support to use datapath APIs from non-EAL pthread
160   * Added support for dynamic flow management
161
162 * **Added DOCSIS protocol to rte_security.**
163
164   Added support for combined crypto and CRC operations for the DOCSIS protocol
165   to ``rte_security`` API.
166
167 * **Updated the AESNI MB crypto PMD.**
168
169   Added support for lookaside protocol offload for DOCSIS through the
170   ``rte_security`` API.
171
172 * **Updated the QuickAssist Technology (QAT) PMD.**
173
174   * Added support for lookaside protocol offload for DOCSIS through the
175     ``rte_security`` API.
176   * Added Chacha20-Poly1305 AEAD algorithm.
177   * Improved handling of multi process in QAT crypto and compression PMDs.
178
179 * **Updated the OCTEON TX2 crypto PMD.**
180
181   Added Chacha20-Poly1305 AEAD algorithm support in OCTEON TX2 crypto PMD.
182
183 * **Added support for BPF_ABS/BPF_IND load instructions.**
184
185   Added support for two BPF non-generic instructions:
186   ``(BPF_ABS | <size> | BPF_LD)`` and ``(BPF_IND | <size> | BPF_LD)``
187   which are used to access packet data in a safe manner. Currently JIT support
188   for these instructions is implemented for x86 only.
189
190 * **Added flow performance test application.**
191
192   Added new application to test ``rte_flow`` performance, including:
193
194   * Measure ``rte_flow`` insertion rate.
195   * Measure ``rte_flow`` deletion rate.
196   * Dump ``rte_flow`` memory consumption.
197   * Measure packet per second forwarding.
198
199 * **Added --portmap command line parameter to l2fwd example.**
200
201   Added new command line option ``--portmap="(port, port)[,(port, port)]"`` to
202   pass forwarding port details.
203   See the :doc:`../sample_app_ug/l2_forward_real_virtual` for more
204   details of this parameter usage.
205
206
207 Removed Items
208 -------------
209
210 .. This section should contain removed items in this release. Sample format:
211
212    * Add a short 1-2 sentence description of the removed item
213      in the past tense.
214
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    =========================================================
218
219 * Removed ``RTE_KDRV_NONE`` based PCI device driver probing.
220
221
222 API Changes
223 -----------
224
225 .. This section should contain API changes. Sample format:
226
227    * sample: Add a short 1-2 sentence description of the API change
228      which was announced in the previous releases and made in this release.
229      Start with a scope label like "ethdev:".
230      Use fixed width quotes for ``function_names`` or ``struct_names``.
231      Use the past tense.
232
233    This section is a comment. Do not overwrite or remove it.
234    Also, make sure to start the actual text at the margin.
235    =========================================================
236
237 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
238
239 * vhost: The API of ``rte_vhost_host_notifier_ctrl`` was changed to be per
240   queue and not per device, a qid parameter was added to the arguments list.
241
242
243 ABI Changes
244 -----------
245
246 .. This section should contain ABI changes. Sample format:
247
248    * sample: Add a short 1-2 sentence description of the ABI change
249      which was announced in the previous releases and made in this release.
250      Start with a scope label like "ethdev:".
251      Use fixed width quotes for ``function_names`` or ``struct_names``.
252      Use the past tense.
253
254    This section is a comment. Do not overwrite or remove it.
255    Also, make sure to start the actual text at the margin.
256    =========================================================
257
258 * No ABI change that would break compatibility with 19.11.
259
260
261 Known Issues
262 ------------
263
264 .. This section should contain new known issues in this release. Sample format:
265
266    * **Add title in present tense with full stop.**
267
268      Add a short 1-2 sentence description of the known issue
269      in the present tense. Add information on any known workarounds.
270
271    This section is a comment. Do not overwrite or remove it.
272    Also, make sure to start the actual text at the margin.
273    =========================================================
274
275
276 Tested Platforms
277 ----------------
278
279 .. This section should contain a list of platforms that were tested
280    with this release.
281
282    The format is:
283
284    * <vendor> platform with <vendor> <type of devices> combinations
285
286      * List of CPU
287      * List of OS
288      * List of devices
289      * Other relevant details...
290
291    This section is a comment. Do not overwrite or remove it.
292    Also, make sure to start the actual text at the margin.
293    =========================================================