common/mlx5: support DevX virtq stats operations
[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
71 * **Added vDPA device APIs to query virtio queue statistics.**
72
73      A new 3 APIs has been added to query virtio queue statistics, to get their
74      names and to reset them by a vDPA device.
75
76 * **Added support for BPF_ABS/BPF_IND load instructions.**
77
78   Added support for two BPF non-generic instructions:
79   ``(BPF_ABS | <size> | BPF_LD)`` and ``(BPF_IND | <size> | BPF_LD)``
80   which are used to access packet data in a safe manner. Currently JIT support
81   for these instructions is implemented for x86 only.
82
83 * **Added flow performance test application.**
84
85   Added new application to test ``rte_flow`` performance, including:
86
87   * Measure ``rte_flow`` insertion rate.
88   * Measure ``rte_flow`` deletion rate.
89   * Dump ``rte_flow`` memory consumption.
90   * Measure packet per second forwarding.
91
92
93 Removed Items
94 -------------
95
96 .. This section should contain removed items in this release. Sample format:
97
98    * Add a short 1-2 sentence description of the removed item
99      in the past tense.
100
101    This section is a comment. Do not overwrite or remove it.
102    Also, make sure to start the actual text at the margin.
103    =========================================================
104
105 * Removed ``RTE_KDRV_NONE`` based PCI device driver probing.
106
107
108 API Changes
109 -----------
110
111 .. This section should contain API changes. Sample format:
112
113    * sample: Add a short 1-2 sentence description of the API change
114      which was announced in the previous releases and made in this release.
115      Start with a scope label like "ethdev:".
116      Use fixed width quotes for ``function_names`` or ``struct_names``.
117      Use 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 * ``rte_page_sizes`` enumeration is replaced with ``RTE_PGSIZE_xxx`` defines.
124
125
126 ABI Changes
127 -----------
128
129 .. This section should contain ABI changes. Sample format:
130
131    * sample: Add a short 1-2 sentence description of the ABI 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 * No ABI change that would break compatibility with 19.11.
142
143
144 Known Issues
145 ------------
146
147 .. This section should contain new known issues in this release. Sample format:
148
149    * **Add title in present tense with full stop.**
150
151      Add a short 1-2 sentence description of the known issue
152      in the present tense. Add information on any known workarounds.
153
154    This section is a comment. Do not overwrite or remove it.
155    Also, make sure to start the actual text at the margin.
156    =========================================================
157
158
159 Tested Platforms
160 ----------------
161
162 .. This section should contain a list of platforms that were tested
163    with this release.
164
165    The format is:
166
167    * <vendor> platform with <vendor> <type of devices> combinations
168
169      * List of CPU
170      * List of OS
171      * List of devices
172      * Other relevant details...
173
174    This section is a comment. Do not overwrite or remove it.
175    Also, make sure to start the actual text at the margin.
176    =========================================================