374b6d3250b508cf0192c734dbc6eb7b6496c681
[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
59 Removed Items
60 -------------
61
62 .. This section should contain removed items in this release. Sample format:
63
64    * Add a short 1-2 sentence description of the removed item
65      in the past tense.
66
67    This section is a comment. Do not overwrite or remove it.
68    Also, make sure to start the actual text at the margin.
69    =======================================================
70
71
72 API Changes
73 -----------
74
75 .. This section should contain API changes. Sample format:
76
77    * sample: Add a short 1-2 sentence description of the API change
78      which was announced in the previous releases and made in this release.
79      Start with a scope label like "ethdev:".
80      Use fixed width quotes for ``function_names`` or ``struct_names``.
81      Use the past tense.
82
83    This section is a comment. Do not overwrite or remove it.
84    Also, make sure to start the actual text at the margin.
85    =======================================================
86
87 * eal: The ``rte_logs`` struct and global symbol was made private
88   and is no longer part of the API.
89
90 * eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
91   used it.
92
93 * mem: Removed the unioned field ``phys_addr`` from
94   the structures ``rte_memseg`` and ``rte_memzone``.
95   The field ``iova`` is remaining from the old unions.
96
97 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
98   the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
99   The field ``iova`` is remaining from the old unions.
100   The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
101   while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
102
103 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
104   and the macros ``rte_pktmbuf_mtophys*``.
105   The same functionality is still available with the functions and macros
106   having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
107
108 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
109   The field ``buf_iova`` is remaining from the old union.
110
111 * mbuf: Removed the unioned field ``refcnt_atomic`` from
112   the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
113   The field ``refcnt`` is remaining from the old unions.
114
115 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
116   replaced with a private enum in the PCI subsystem.
117
118 * pci: Removed the PCI resources map API from the public API
119   (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
120   PCI bus driver along with the PCI resources lists and associated structures
121   (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
122   ``mapped_pci_res_list``).
123
124 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
125   structure as it gave no useful abstracted information to the applications.
126
127 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
128
129 * rawdev: Added a structure size parameter to the functions
130   ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
131   ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
132   allowing limited driver type-checking and ABI compatibility.
133
134 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
135   and the function ``rte_rawdev_queue_conf_get()``
136   from ``void`` to ``int`` allowing the return of error codes from drivers.
137
138 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
139
140
141 ABI Changes
142 -----------
143
144 .. This section should contain ABI changes. Sample format:
145
146    * sample: Add a short 1-2 sentence description of the ABI change
147      which was announced in the previous releases and made in this release.
148      Start with a scope label like "ethdev:".
149      Use fixed width quotes for ``function_names`` or ``struct_names``.
150      Use the past tense.
151
152    This section is a comment. Do not overwrite or remove it.
153    Also, make sure to start the actual text at the margin.
154    =======================================================
155
156 * ``ethdev`` changes
157
158   * Following device operation function pointers moved
159     from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
160
161     * ``eth_rx_queue_count_t       rx_queue_count;``
162     * ``eth_rx_descriptor_done_t   rx_descriptor_done;``
163     * ``eth_rx_descriptor_status_t rx_descriptor_status;``
164     * ``eth_tx_descriptor_status_t tx_descriptor_status;``
165
166
167 Known Issues
168 ------------
169
170 .. This section should contain new known issues in this release. Sample format:
171
172    * **Add title in present tense with full stop.**
173
174      Add a short 1-2 sentence description of the known issue
175      in the present tense. Add information on any known workarounds.
176
177    This section is a comment. Do not overwrite or remove it.
178    Also, make sure to start the actual text at the margin.
179    =======================================================
180
181
182 Tested Platforms
183 ----------------
184
185 .. This section should contain a list of platforms that were tested
186    with this release.
187
188    The format is:
189
190    * <vendor> platform with <vendor> <type of devices> combinations
191
192      * List of CPU
193      * List of OS
194      * List of devices
195      * Other relevant details...
196
197    This section is a comment. Do not overwrite or remove it.
198    Also, make sure to start the actual text at the margin.
199    =======================================================