vfio: support VF token
[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 the support for vfio-pci new VF token interface.**
60
61   From Linux 5.7, vfio-pci supports to bind both SR-IOV PF and the created VFs,
62   it uses a shared VF token (UUID) to represent the collaboration between PF
63   and VFs. Update DPDK PCI driver to gain the access to the PF and VFs devices
64   by appending the VF token parameter.
65
66 * **Added the RegEx Library, a generic RegEx service library.**
67
68   Added the RegEx library which provides an API for offload of regular
69   expressions search operations to hardware or software accelerator devices.
70
71 * **Updated PCAP driver.**
72
73   Updated PCAP driver with new features and improvements, including:
74
75   * Support software Tx nanosecond timestamps precision.
76
77 * **Updated Mellanox mlx5 driver.**
78
79   Updated Mellanox mlx5 driver with new features and improvements, including:
80
81   * Added new PMD devarg ``reclaim_mem_mode``.
82   * Added new devarg ``lacp_by_user``.
83
84 * **Added vDPA device APIs to query virtio queue statistics.**
85
86      A new 3 APIs has been added to query virtio queue statistics, to get their
87      names and to reset them by a vDPA device.
88
89 * **Updated Mellanox mlx5 vDPA driver.**
90
91   Updated Mellanox mlx5 vDPA driver with new features, including:
92
93   * Added support for virtio queue statistics.
94   * Added support for MTU update.
95
96 * **Updated Marvell octeontx2 ethdev PMD.**
97
98   Updated Marvell octeontx2 driver with cn98xx support.
99
100 * **Updated the Intel ice driver.**
101
102   Updated the Intel ice driver with new features and improvements, including:
103
104   * Added support for DCF datapath configuration.
105
106 * **Added support for BPF_ABS/BPF_IND load instructions.**
107
108   Added support for two BPF non-generic instructions:
109   ``(BPF_ABS | <size> | BPF_LD)`` and ``(BPF_IND | <size> | BPF_LD)``
110   which are used to access packet data in a safe manner. Currently JIT support
111   for these instructions is implemented for x86 only.
112
113 * **Added flow performance test application.**
114
115   Added new application to test ``rte_flow`` performance, including:
116
117   * Measure ``rte_flow`` insertion rate.
118   * Measure ``rte_flow`` deletion rate.
119   * Dump ``rte_flow`` memory consumption.
120   * Measure packet per second forwarding.
121
122 * **Added --portmap command line parameter to l2fwd example.**
123
124   Added new command line option ``--portmap="(port, port)[,(port, port)]"`` to
125   pass forwarding port details.
126   See the :doc:`../sample_app_ug/l2_forward_real_virtual` for more
127   details of this parameter usage.
128
129
130 Removed Items
131 -------------
132
133 .. This section should contain removed items in this release. Sample format:
134
135    * Add a short 1-2 sentence description of the removed item
136      in the past tense.
137
138    This section is a comment. Do not overwrite or remove it.
139    Also, make sure to start the actual text at the margin.
140    =========================================================
141
142 * Removed ``RTE_KDRV_NONE`` based PCI device driver probing.
143
144
145 API Changes
146 -----------
147
148 .. This section should contain API changes. Sample format:
149
150    * sample: Add a short 1-2 sentence description of the API change
151      which was announced in the previous releases and made in this release.
152      Start with a scope label like "ethdev:".
153      Use fixed width quotes for ``function_names`` or ``struct_names``.
154      Use the past tense.
155
156    This section is a comment. Do not overwrite or remove it.
157    Also, make sure to start the actual text at the margin.
158    =========================================================
159
160 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
161
162 * vhost: The API of ``rte_vhost_host_notifier_ctrl`` was changed to be per
163   queue and not per device, a qid parameter was added to the arguments list.
164
165
166 ABI Changes
167 -----------
168
169 .. This section should contain ABI changes. Sample format:
170
171    * sample: Add a short 1-2 sentence description of the ABI change
172      which was announced in the previous releases and made in this release.
173      Start with a scope label like "ethdev:".
174      Use fixed width quotes for ``function_names`` or ``struct_names``.
175      Use the past tense.
176
177    This section is a comment. Do not overwrite or remove it.
178    Also, make sure to start the actual text at the margin.
179    =========================================================
180
181 * No ABI change that would break compatibility with 19.11.
182
183
184 Known Issues
185 ------------
186
187 .. This section should contain new known issues in this release. Sample format:
188
189    * **Add title in present tense with full stop.**
190
191      Add a short 1-2 sentence description of the known issue
192      in the present tense. Add information on any known workarounds.
193
194    This section is a comment. Do not overwrite or remove it.
195    Also, make sure to start the actual text at the margin.
196    =========================================================
197
198
199 Tested Platforms
200 ----------------
201
202 .. This section should contain a list of platforms that were tested
203    with this release.
204
205    The format is:
206
207    * <vendor> platform with <vendor> <type of devices> combinations
208
209      * List of CPU
210      * List of OS
211      * List of devices
212      * Other relevant details...
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    =========================================================