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