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