net/bnxt: support NEON
[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
102 * **Updated Mellanox mlx5 driver.**
103
104   Updated Mellanox mlx5 driver with new features and improvements, including:
105
106   * Added new PMD devarg ``reclaim_mem_mode``.
107   * Added new devarg ``lacp_by_user``.
108
109 * **Added vDPA device APIs to query virtio queue statistics.**
110
111      A new 3 APIs has been added to query virtio queue statistics, to get their
112      names and to reset them by a vDPA device.
113
114 * **Updated Mellanox mlx5 vDPA driver.**
115
116   Updated Mellanox mlx5 vDPA driver with new features, including:
117
118   * Added support for virtio queue statistics.
119   * Added support for MTU update.
120
121 * **Updated Marvell octeontx2 ethdev PMD.**
122
123   Updated Marvell octeontx2 driver with cn98xx support.
124
125 * **Updated the Intel ice driver.**
126
127   Updated the Intel ice driver with new features and improvements, including:
128
129   * Added support for DCF datapath configuration.
130   * Added support for more PPPoE packet type for switch filter.
131
132 * **Updated Intel i40e driver.**
133
134   Updated i40e PMD with new features and improvements, including:
135
136   * Supported cloud filter for IPv4/6_TCP/UDP/SCTP with SRC port only or DST port only.
137   * Re-implemented get_fdir_info and get_fdir_stat in private API.
138   * Re-implemented set_gre_key_len in private API.
139   * Added support for flow query RSS.
140
141 * **Updated the Intel ixgbe driver.**
142
143   Updated the Intel ixgbe driver with new features and improvements, including:
144
145   * Re-implemented get_fdir_info and get_fdir_stat in private API.
146
147 * **Updated NXP dpaa ethdev PMD.**
148
149   Updated the NXP dpaa ethdev with new features and improvements, including:
150
151   * Added support for link status and interrupt
152   * Added support to use datapath APIs from non-EAL pthread
153
154 * **Updated NXP dpaa2 ethdev PMD.**
155
156   Updated the NXP dpaa2 ethdev with new features and improvements, including:
157
158   * Added support to use datapath APIs from non-EAL pthread
159   * Added support for dynamic flow management
160
161 * **Added DOCSIS protocol to rte_security.**
162
163   Added support for combined crypto and CRC operations for the DOCSIS protocol
164   to ``rte_security`` API.
165
166 * **Updated the AESNI MB crypto PMD.**
167
168   Added support for lookaside protocol offload for DOCSIS through the
169   ``rte_security`` API.
170
171 * **Updated the QuickAssist Technology (QAT) PMD.**
172
173   * Added support for lookaside protocol offload for DOCSIS through the
174     ``rte_security`` API.
175   * Added Chacha20-Poly1305 AEAD algorithm.
176   * Improved handling of multi process in QAT crypto and compression PMDs.
177
178 * **Updated the OCTEON TX2 crypto PMD.**
179
180   Added Chacha20-Poly1305 AEAD algorithm support in OCTEON TX2 crypto PMD.
181
182 * **Added support for BPF_ABS/BPF_IND load instructions.**
183
184   Added support for two BPF non-generic instructions:
185   ``(BPF_ABS | <size> | BPF_LD)`` and ``(BPF_IND | <size> | BPF_LD)``
186   which are used to access packet data in a safe manner. Currently JIT support
187   for these instructions is implemented for x86 only.
188
189 * **Added flow performance test application.**
190
191   Added new application to test ``rte_flow`` performance, including:
192
193   * Measure ``rte_flow`` insertion rate.
194   * Measure ``rte_flow`` deletion rate.
195   * Dump ``rte_flow`` memory consumption.
196   * Measure packet per second forwarding.
197
198 * **Added --portmap command line parameter to l2fwd example.**
199
200   Added new command line option ``--portmap="(port, port)[,(port, port)]"`` to
201   pass forwarding port details.
202   See the :doc:`../sample_app_ug/l2_forward_real_virtual` for more
203   details of this parameter usage.
204
205
206 Removed Items
207 -------------
208
209 .. This section should contain removed items in this release. Sample format:
210
211    * Add a short 1-2 sentence description of the removed item
212      in the past tense.
213
214    This section is a comment. Do not overwrite or remove it.
215    Also, make sure to start the actual text at the margin.
216    =========================================================
217
218 * Removed ``RTE_KDRV_NONE`` based PCI device driver probing.
219
220
221 API Changes
222 -----------
223
224 .. This section should contain API changes. Sample format:
225
226    * sample: Add a short 1-2 sentence description of the API change
227      which was announced in the previous releases and made in this release.
228      Start with a scope label like "ethdev:".
229      Use fixed width quotes for ``function_names`` or ``struct_names``.
230      Use the past tense.
231
232    This section is a comment. Do not overwrite or remove it.
233    Also, make sure to start the actual text at the margin.
234    =========================================================
235
236 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
237
238 * vhost: The API of ``rte_vhost_host_notifier_ctrl`` was changed to be per
239   queue and not per device, a qid parameter was added to the arguments list.
240
241
242 ABI Changes
243 -----------
244
245 .. This section should contain ABI changes. Sample format:
246
247    * sample: Add a short 1-2 sentence description of the ABI change
248      which was announced in the previous releases and made in this release.
249      Start with a scope label like "ethdev:".
250      Use fixed width quotes for ``function_names`` or ``struct_names``.
251      Use the past tense.
252
253    This section is a comment. Do not overwrite or remove it.
254    Also, make sure to start the actual text at the margin.
255    =========================================================
256
257 * No ABI change that would break compatibility with 19.11.
258
259
260 Known Issues
261 ------------
262
263 .. This section should contain new known issues in this release. Sample format:
264
265    * **Add title in present tense with full stop.**
266
267      Add a short 1-2 sentence description of the known issue
268      in the present tense. Add information on any known workarounds.
269
270    This section is a comment. Do not overwrite or remove it.
271    Also, make sure to start the actual text at the margin.
272    =========================================================
273
274
275 Tested Platforms
276 ----------------
277
278 .. This section should contain a list of platforms that were tested
279    with this release.
280
281    The format is:
282
283    * <vendor> platform with <vendor> <type of devices> combinations
284
285      * List of CPU
286      * List of OS
287      * List of devices
288      * Other relevant details...
289
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    =========================================================