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