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