f88d9074ef8222541c13b50c47dab138006d0798
[dpdk.git] / doc / guides / rel_notes / release_20_11.rst
1 .. SPDX-License-Identifier: BSD-3-Clause
2    Copyright 2020 The DPDK contributors
3
4 .. include:: <isonum.txt>
5
6 DPDK Release 20.11
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       xdg-open build/doc/html/guides/rel_notes/release_20_11.html
22
23
24 New Features
25 ------------
26
27 .. This section should contain new features added in this release.
28    Sample format:
29
30    * **Add a title in the past tense with a full stop.**
31
32      Add a short 1-2 sentence description in the past tense.
33      The description should be enough to allow someone scanning
34      the release notes to understand the new feature.
35
36      If the feature adds a lot of sub-features you can use a bullet list
37      like this:
38
39      * Added feature foo to do something.
40      * Enhanced feature bar to do something else.
41
42      Refer to the previous release notes for examples.
43
44      Suggested order in release notes items:
45      * Core libs (EAL, mempool, ring, mbuf, buses)
46      * Device abstraction libs and PMDs
47        - ethdev (lib, PMDs)
48        - cryptodev (lib, PMDs)
49        - eventdev (lib, PMDs)
50        - etc
51      * Other libs
52      * Apps, Examples, Tools (if significant)
53
54      This section is a comment. Do not overwrite or remove it.
55      Also, make sure to start the actual text at the margin.
56      =======================================================
57
58 * **Extended flow-perf application.**
59
60   * Started supporting user order instead of bit mask:
61     Now the user can create any structure of rte_flow
62     using flow performance application with any order,
63     moreover the app also now starts to support inner
64     items matching as well.
65   * Added header modify actions.
66   * Added flag action.
67   * Added raw encap/decap actions.
68   * Added VXLAN encap/decap actions.
69
70
71 Removed Items
72 -------------
73
74 .. This section should contain removed items in this release. Sample format:
75
76    * Add a short 1-2 sentence description of the removed item
77      in the past tense.
78
79    This section is a comment. Do not overwrite or remove it.
80    Also, make sure to start the actual text at the margin.
81    =======================================================
82
83
84 API Changes
85 -----------
86
87 .. This section should contain API changes. Sample format:
88
89    * sample: Add a short 1-2 sentence description of the API change
90      which was announced in the previous releases and made in this release.
91      Start with a scope label like "ethdev:".
92      Use fixed width quotes for ``function_names`` or ``struct_names``.
93      Use the past tense.
94
95    This section is a comment. Do not overwrite or remove it.
96    Also, make sure to start the actual text at the margin.
97    =======================================================
98
99 * eal: The ``rte_logs`` struct and global symbol was made private
100   and is no longer part of the API.
101
102 * eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
103   used it.
104
105 * mem: Removed the unioned field ``phys_addr`` from
106   the structures ``rte_memseg`` and ``rte_memzone``.
107   The field ``iova`` is remaining from the old unions.
108
109 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
110   the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
111   The field ``iova`` is remaining from the old unions.
112   The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
113   while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
114
115 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
116   and the macros ``rte_pktmbuf_mtophys*``.
117   The same functionality is still available with the functions and macros
118   having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
119
120 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
121   The field ``buf_iova`` is remaining from the old union.
122
123 * mbuf: Removed the unioned field ``refcnt_atomic`` from
124   the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
125   The field ``refcnt`` is remaining from the old unions.
126
127 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
128   replaced with a private enum in the PCI subsystem.
129
130 * pci: Removed the PCI resources map API from the public API
131   (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
132   PCI bus driver along with the PCI resources lists and associated structures
133   (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
134   ``mapped_pci_res_list``).
135
136 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
137   structure as it gave no useful abstracted information to the applications.
138
139 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
140
141 * Renamed internal ethdev APIs:
142
143   * ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
144   * ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
145
146 * rawdev: Added a structure size parameter to the functions
147   ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
148   ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
149   allowing limited driver type-checking and ABI compatibility.
150
151 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
152   and the function ``rte_rawdev_queue_conf_get()``
153   from ``void`` to ``int`` allowing the return of error codes from drivers.
154
155 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
156
157
158 ABI Changes
159 -----------
160
161 .. This section should contain ABI changes. Sample format:
162
163    * sample: Add a short 1-2 sentence description of the ABI change
164      which was announced in the previous releases and made in this release.
165      Start with a scope label like "ethdev:".
166      Use fixed width quotes for ``function_names`` or ``struct_names``.
167      Use the past tense.
168
169    This section is a comment. Do not overwrite or remove it.
170    Also, make sure to start the actual text at the margin.
171    =======================================================
172
173 * ``ethdev`` changes
174
175   * Following device operation function pointers moved
176     from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
177
178     * ``eth_rx_queue_count_t       rx_queue_count;``
179     * ``eth_rx_descriptor_done_t   rx_descriptor_done;``
180     * ``eth_rx_descriptor_status_t rx_descriptor_status;``
181     * ``eth_tx_descriptor_status_t tx_descriptor_status;``
182
183   * ``struct eth_dev_ops`` is no more accessible by applications,
184     which was already internal data structure.
185
186   * ``ethdev`` internal functions are marked with ``__rte_internal`` tag.
187
188
189 Known Issues
190 ------------
191
192 .. This section should contain new known issues in this release. Sample format:
193
194    * **Add title in present tense with full stop.**
195
196      Add a short 1-2 sentence description of the known issue
197      in the present tense. Add information on any known workarounds.
198
199    This section is a comment. Do not overwrite or remove it.
200    Also, make sure to start the actual text at the margin.
201    =======================================================
202
203
204 Tested Platforms
205 ----------------
206
207 .. This section should contain a list of platforms that were tested
208    with this release.
209
210    The format is:
211
212    * <vendor> platform with <vendor> <type of devices> combinations
213
214      * List of CPU
215      * List of OS
216      * List of devices
217      * Other relevant details...
218
219    This section is a comment. Do not overwrite or remove it.
220    Also, make sure to start the actual text at the margin.
221    =======================================================