net/txgbe: add build and doc infrastructure
[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 * **Added write combining store APIs.**
59
60   Added ``rte_write32_wc`` and ``rte_write32_wc_relaxed`` APIs
61   that enable write combining stores (depending on architecture).
62   The functions are provided as a generic stubs and
63   x86 specific implementation.
64
65 * **Added prefetch with intention to write APIs.**
66
67   Added new prefetch function variants e.g. ``rte_prefetch0_write``,
68   which allow the programmer to prefetch a cache line and also indicate
69   the intention to write.
70
71 * **Added the rte_cldemote API.**
72
73   Added a hardware hint CLDEMOTE, which is similar to prefetch in reverse.
74   CLDEMOTE moves the cache line to the more remote cache, where it expects
75   sharing to be efficient. Moving the cache line to a level more distant from
76   the processor helps to accelerate core-to-core communication.
77   This API is specific to x86 and implemented as a stub for other
78   architectures.
79
80 * **Added support for limiting maximum SIMD bitwidth.**
81
82   Added a new EAL config setting ``max_simd_bitwidth`` to limit the vector
83   path selection at runtime. This value can be set by apps using the
84   ``rte_vect_set_max_simd_bitwidth`` function, or by the user with EAL flag
85   ``--force-max-simd-bitwidth``.
86
87 * **Added zero copy APIs for rte_ring.**
88
89   For rings with producer/consumer in ``RTE_RING_SYNC_ST``, ``RTE_RING_SYNC_MT_HTS``
90   modes, these APIs split enqueue/dequeue operation into three phases
91   (enqueue/dequeue start, copy data to/from ring, enqueue/dequeue finish).
92   Along with the advantages of the peek APIs, these provide the ability to
93   copy the data to the ring memory directly without the need for temporary
94   storage.
95
96 * **Updated CRC modules of the net library.**
97
98   * Added runtime selection of the optimal architecture-specific CRC path.
99   * Added optimized implementations of CRC32-Ethernet and CRC16-CCITT
100     using the AVX512 and VPCLMULQDQ instruction sets.
101
102 * **Introduced extended buffer description for receiving.**
103
104   Added the extended Rx buffer description for Rx queue setup routine
105   providing the individual settings for each Rx segment with maximal size,
106   buffer offset and memory pool to allocate data buffers from.
107
108 * **Added the FEC API, for a generic FEC query and config.**
109
110   Added the FEC API which provides functions for query FEC capabilities and
111   current FEC mode from device. Also, API for configuring FEC mode is also provided.
112
113 * **Added thread safety to rte_flow functions.**
114
115   Added ``RTE_ETH_DEV_FLOW_OPS_THREAD_SAFE`` device flag to indicate
116   whether PMD supports thread safe operations. If PMD doesn't set the flag,
117   rte_flow API level functions will protect the flow operations with mutex.
118
119 * **Added flow-based traffic sampling support.**
120
121   Added new action: ``RTE_FLOW_ACTION_TYPE_SAMPLE`` to duplicate the matching
122   packets with specified ratio, and apply with own set of actions with a fate
123   action. When the ratio is set to 1 then the packets will be 100% mirrored.
124
125 * **Added support of shared action in flow API.**
126
127   Added shared action support to utilize single flow action in multiple flow
128   rules. An update of shared action configuration alters the behavior of all
129   flow rules using it.
130
131   * Added new action: ``RTE_FLOW_ACTION_TYPE_SHARED`` to use shared action
132     as flow action.
133   * Added new flow APIs to create/update/destroy/query shared action.
134
135 * **Flow rules allowed to use private PMD items / actions.**
136
137   * Flow rule verification was updated to accept private PMD
138     items and actions.
139
140 * **Added generic API to offload tunneled traffic and restore missed packet.**
141
142   * Added a new hardware independent helper to flow API that
143     offloads tunneled traffic and restores missed packets.
144
145 * **Updated the ethdev library to support hairpin between two ports.**
146
147   New APIs are introduced to support binding / unbinding 2 ports hairpin.
148   Hairpin Tx part flow rules can be inserted explicitly.
149   New API is added to get the hairpin peer ports list.
150
151 * **Updated Broadcom bnxt driver.**
152
153   Updated the Broadcom bnxt driver with new features and improvements, including:
154
155   * Added support for 200G PAM4 link speed.
156   * Added support for RSS hash level selection.
157   * Updated HWRM structures to 1.10.1.70 version.
158   * Added TRUFLOW support for Stingray devices.
159
160 * **Updated Cisco enic driver.**
161
162   * Added support for VF representors with single-queue Tx/Rx and flow API
163   * Added support for egress PORT_ID action
164   * Added support for non-zero priorities for group 0 flows
165   * Added support for VXLAN decap combined with VLAN pop
166
167 * **Added hns3 FEC PMD, for supporting query and config FEC mode.**
168
169   Added the FEC PMD which provides functions for query FEC capabilities and
170   current FEC mode from device. Also, PMD for configuring FEC mode is also provided.
171
172 * **Updated Intel ice driver.**
173
174   * Used write combining stores.
175   * Added ACL filter support for Intel DCF.
176
177 * **Updated Mellanox mlx5 driver.**
178
179   Updated Mellanox mlx5 driver with new features and improvements, including:
180
181   * Added support for matching on fragmented/non-fragmented IPv4/IPv6 packets.
182   * Updated the supported timeout for Age action to the maximal value supported
183     by rte_flow API.
184   * Added support of Age action query.
185
186 * **Updated Solarflare network PMD.**
187
188   Updated the Solarflare ``sfc_efx`` driver with changes including:
189
190   * Added SR-IOV PF support
191   * Added Alveo SN1000 SmartNICs (EF100 architecture) support including
192     flow API transfer rules for switch HW offload
193
194 * **Added Wangxun txgbe PMD.**
195
196   Added a new PMD driver for Wangxun 10 Gigabit Ethernet NICs.
197
198   See the :doc:`../nics/txgbe` for more details.
199
200 * **Updated Virtio driver.**
201
202   * Added support for Vhost-vDPA backend to Virtio-user PMD.
203   * Changed default link speed to unknown.
204   * Added support for 200G link speed.
205
206 * **Updated Intel i40e driver.**
207
208   Updated the Intel i40e driver to use write combining stores.
209
210 * **Updated Intel ixgbe driver.**
211
212   Updated the Intel ixgbe driver to use write combining stores.
213
214 * **Updated Intel qat driver.**
215
216   Updated the Intel qat driver to use write combining stores.
217
218 * **Updated Memif PMD.**
219
220   * Added support for abstract socket address.
221   * Changed default socket address type to abstract.
222
223 * **Added Ice Lake (Gen4) support for Intel NTB.**
224
225   Added NTB device support (4th generation) for Intel Ice Lake platform.
226
227 * **Added UDP/IPv4 GRO support for VxLAN and non-VxLAN packets.**
228
229   For VxLAN packets, added inner UDP/IPv4 support.
230   For non-VxLAN packets, added UDP/IPv4 support.
231
232 * **Extended flow-perf application.**
233
234   * Started supporting user order instead of bit mask:
235     Now the user can create any structure of rte_flow
236     using flow performance application with any order,
237     moreover the app also now starts to support inner
238     items matching as well.
239   * Added header modify actions.
240   * Added flag action.
241   * Added raw encap/decap actions.
242   * Added VXLAN encap/decap actions.
243   * Added ICMP(code/type/identifier/sequence number) and ICMP6(code/type) matching items.
244   * Added option to set port mask for insertion/deletion:
245     ``--portmask=N``
246     where N represents the hexadecimal bitmask of ports used.
247
248 * **Added raw data-path APIs for cryptodev library.**
249
250   Cryptodev is added with raw data-path APIs to accelerate external
251   libraries or applications which need to avail fast cryptodev
252   enqueue/dequeue operations but does not necessarily depends on
253   mbufs and cryptodev operation mempools.
254
255 * **Updated the aesni_mb crypto PMD.**
256
257   * Added support for AES-ECB 128, 192 and 256.
258   * Added support for ZUC-EEA3/EIA3 algorithms.
259   * Added support for SNOW3G-UEA2/UIA2 algorithms.
260   * Added support for KASUMI-F8/F9 algorithms.
261   * Added support for Chacha20-Poly1305.
262   * Added support for AES-256 CCM algorithm.
263
264 * **Updated the aesni_gcm crypto PMD.**
265
266   * Added SGL support for AES-GMAC.
267
268 * **Added Broadcom BCMFS symmetric crypto PMD.**
269
270   Added a symmetric crypto PMD for Broadcom FlexSparc crypto units.
271   See :doc:`../cryptodevs/bcmfs` guide for more details on this new PMD.
272
273 * **Updated DPAA2_SEC crypto PMD.**
274
275   * Added DES-CBC support for cipher_only, chain and ipsec protocol.
276   * Added support for non-HMAC auth algorithms
277     (MD5, SHA1, SHA224, SHA256, SHA384, SHA512).
278
279 * **Updated Marvell NITROX symmetric crypto PMD.**
280
281   * Added AES-GCM support.
282   * Added cipher only offload support.
283
284 * **Updated the OCTEON TX2 crypto PMD.**
285
286   * Updated the OCTEON TX2 crypto PMD lookaside protocol offload for IPsec with
287     IPv6 support.
288
289 * **Updated QAT crypto PMD.**
290
291   * Added Raw Data-path APIs support.
292
293 * **Added Intel ACC100 bbdev PMD.**
294
295   Added a new ``acc100`` bbdev driver for the Intel\ |reg| ACC100 accelerator
296   also known as Mount Bryce.  See the
297   :doc:`../bbdevs/acc100` BBDEV guide for more details on this new driver.
298
299 * **Updated rte_security library to support SDAP.**
300
301   ``rte_security_pdcp_xform`` in ``rte_security`` lib is updated to enable
302   5G NR processing of SDAP header in PMDs.
303
304 * **Added Marvell OCTEON TX2 regex PMD.**
305
306   Added a new PMD driver for hardware regex offload block for OCTEON TX2 SoC.
307
308   See the :doc:`../regexdevs/octeontx2` for more details.
309
310 * **Updated Software Eventdev driver.**
311
312   Added performance tuning arguments to allow tuning the scheduler for
313   better throughtput in high core count use cases.
314
315 * **Added a new driver for the Intel Dynamic Load Balancer v1.0 device.**
316
317   Added the new ``dlb`` eventdev driver for the Intel DLB V1.0 device. See the
318   :doc:`../eventdevs/dlb` eventdev guide for more details on this new driver.
319
320 * **Added a new driver for the Intel Dynamic Load Balancer v2.0 device.**
321
322   Added the new ``dlb2`` eventdev driver for the Intel DLB V2.0 device. See the
323   :doc:`../eventdevs/dlb2` eventdev guide for more details on this new driver.
324
325 * **Updated ioat rawdev driver**
326
327   The ioat rawdev driver has been updated and enhanced. Changes include:
328
329   * Added support for Intel\ |reg| Data Streaming Accelerator hardware.
330     For more information, see https://01.org/blogs/2019/introducing-intel-data-streaming-accelerator
331   * Added support for the fill operation via the API ``rte_ioat_enqueue_fill()``,
332     where the hardware fills an area of memory with a repeating pattern.
333   * Added a per-device configuration flag to disable management
334     of user-provided completion handles.
335   * Renamed the ``rte_ioat_do_copies()`` API to ``rte_ioat_perform_ops()``,
336     and renamed the ``rte_ioat_completed_copies()`` API to ``rte_ioat_completed_ops()``
337     to better reflect the APIs' purposes, and remove the implication that
338     they are limited to copy operations only.
339     [Note: The old API is still provided but marked as deprecated in the code]
340   * Added a new API ``rte_ioat_fence()`` to add a fence between operations.
341     This API replaces the ``fence`` flag parameter in the ``rte_ioat_enqueue_copies()`` function,
342     and is clearer as there is no ambiguity as to whether the flag should be
343     set on the last operation before the fence or the first operation after it.
344
345 * **Updated the pipeline library for alignment with the P4 language.**
346
347   Added new Software Switch (SWX) pipeline type that provides more
348   flexibility through API and feature alignment with the P4 language.
349
350   * The packet headers, meta-data, actions, tables and pipelines are
351     dynamically defined instead of selected from pre-defined set.
352   * The actions and the pipeline are defined with instructions.
353   * Extern objects and functions can be plugged into the pipeline.
354   * Transaction-oriented table updates.
355
356 * **Add new AVX512 specific classify algorithms for ACL library.**
357
358   * Added new ``RTE_ACL_CLASSIFY_AVX512X16`` vector implementation,
359     which can process up to 16 flows in parallel. Requires AVX512 support.
360
361   * Added new ``RTE_ACL_CLASSIFY_AVX512X32`` vector implementation,
362     which can process up to 32 flows in parallel. Requires AVX512 support.
363
364 * **Added AVX512 lookup implementation for FIB.**
365
366   Added a AVX512 lookup functions implementation into FIB and FIB6 libraries.
367
368 * **Added support to update subport bandwidth dynamically.**
369
370    * Added new API ``rte_sched_port_subport_profile_add`` to add new
371      subport bandwidth profile to subport porfile table at runtime.
372
373    * Added support to update subport rate dynamically.
374
375 * **Updated FIPS validation sample application.**
376
377   * Added scatter gather support.
378   * Added NIST GCMVS complaint GMAC test method support.
379
380 * **Updated l3wfd-acl sample application.**
381
382   * Added new optional parameter ``--eth-dest`` for the ``l3fwd-acl`` to allow
383     the user to specify the destination mac address for each ethernet port
384     used.
385   * Replaced ``--scalar`` command-line option with ``--alg=<value>``, to allow
386     the user to select the desired classify method.
387
388 * **Updated vhost sample application.**
389
390   Added vhost asynchronous APIs support, which demonstrated how the application
391   leverage IOAT DMA channel with vhost asynchronous APIs.
392   See the :doc:`../sample_app_ug/vhost` for more details.
393
394
395 Removed Items
396 -------------
397
398 .. This section should contain removed items in this release. Sample format:
399
400    * Add a short 1-2 sentence description of the removed item
401      in the past tense.
402
403    This section is a comment. Do not overwrite or remove it.
404    Also, make sure to start the actual text at the margin.
405    =======================================================
406
407 * build: Support for the Make build system was removed for compiling DPDK,
408   Meson is now the primary build system.
409   Sample applications can still be built with Make standalone, using pkg-config.
410
411 * vhost: Dequeue zero-copy support has been removed.
412
413 * kernel: The module ``igb_uio`` has been moved to the git repository
414   ``dpdk-kmods`` in a new directory ``linux/igb_uio``.
415
416 * Removed Python 2 support since it was EOL'd in January 2020.
417
418 * Removed TEP termination sample application.
419
420
421 API Changes
422 -----------
423
424 .. This section should contain API changes. Sample format:
425
426    * sample: Add a short 1-2 sentence description of the API change
427      which was announced in the previous releases and made in this release.
428      Start with a scope label like "ethdev:".
429      Use fixed width quotes for ``function_names`` or ``struct_names``.
430      Use the past tense.
431
432    This section is a comment. Do not overwrite or remove it.
433    Also, make sure to start the actual text at the margin.
434    =======================================================
435
436 * build macros: The macros defining ``RTE_MACHINE_CPUFLAG_*`` are removed.
437   The information provided by these macros is available through standard
438   compiler macros.
439
440 * eal: Replaced the function ``rte_get_master_lcore()`` to
441   ``rte_get_main_lcore()``. The old function is deprecated.
442
443   The iterator for worker lcores is also changed:
444   ``RTE_LCORE_FOREACH_SLAVE`` is replaced with
445   ``RTE_LCORE_FOREACH_WORKER``.
446
447 * eal: The ``rte_logs`` struct and global symbol was made private
448   and is no longer part of the API.
449
450 * eal: Made the ``rte_dev_event`` structure private to the EAL as no public API
451   used it.
452
453 * eal: ``rte_cio_rmb()`` and ``rte_cio_wmb()`` were deprecated since 20.08
454   and are removed in this release.
455
456 * mem: Removed the unioned field ``phys_addr`` from
457   the structures ``rte_memseg`` and ``rte_memzone``.
458   The field ``iova`` is remaining from the old unions.
459
460 * mempool: Removed the unioned fields ``phys_addr`` and ``physaddr`` from
461   the structures ``rte_mempool_memhdr`` and ``rte_mempool_objhdr``.
462   The field ``iova`` is remaining from the old unions.
463   The flag name ``MEMPOOL_F_NO_PHYS_CONTIG`` is removed,
464   while the aliased flag ``MEMPOOL_F_NO_IOVA_CONTIG`` is kept.
465
466 * mbuf: Removed the functions ``rte_mbuf_data_dma_addr*``
467   and the macros ``rte_pktmbuf_mtophys*``.
468   The same functionality is still available with the functions and macros
469   having ``iova`` in their names instead of ``dma_addr`` or ``mtophys``.
470
471 * mbuf: Removed the unioned field ``buf_physaddr`` from ``rte_mbuf``.
472   The field ``buf_iova`` is remaining from the old union.
473
474 * mbuf: Removed the unioned field ``refcnt_atomic`` from
475   the structures ``rte_mbuf`` and ``rte_mbuf_ext_shared_info``.
476   The field ``refcnt`` is remaining from the old unions.
477
478 * mbuf: Removed the unioned fields ``userdata`` and ``udata64``
479   from the structure ``rte_mbuf``. It is replaced with dynamic fields.
480
481 * mbuf: Removed the field ``seqn`` from the structure ``rte_mbuf``.
482   It is replaced with dynamic fields.
483
484 * mbuf: Removed the field ``timestamp`` from the structure ``rte_mbuf``.
485   It is replaced with the dynamic field RTE_MBUF_DYNFIELD_TIMESTAMP_NAME
486   which was previously used only for Tx.
487
488 * pci: Removed the ``rte_kernel_driver`` enum defined in rte_dev.h and
489   replaced with a private enum in the PCI subsystem.
490
491 * pci: Removed the PCI resources map API from the public API
492   (``pci_map_resource`` and ``pci_unmap_resource``) and moved it to the
493   PCI bus driver along with the PCI resources lists and associated structures
494   (``pci_map``, ``pci_msix_table``, ``mapped_pci_resource`` and
495   ``mapped_pci_res_list``).
496
497 * ethdev: Removed the ``kdrv`` field in the ethdev ``rte_eth_dev_data``
498   structure as it gave no useful abstracted information to the applications.
499
500 * ethdev: ``rte_eth_rx_descriptor_done()`` API has been deprecated.
501
502 * ethdev: Renamed basic statistics per queue. An underscore is inserted
503   between the queue number and the rest of the xstat name:
504
505   * ``rx_qN*`` -> ``rx_qN_*``
506   * ``tx_qN*`` -> ``tx_qN_*``
507
508 * ethdev: Added capability to query age flow action.
509
510 * ethdev: Changed ``rte_eth_dev_stop`` return value from ``void`` to
511   ``int`` to provide a way to report various error conditions.
512
513 * ethdev: Added ``int`` return type to ``rte_eth_dev_close()``.
514
515 * ethdev: Renamed internal functions:
516
517   * ``_rte_eth_dev_callback_process()`` -> ``rte_eth_dev_callback_process()``
518   * ``_rte_eth_dev_reset`` -> ``rte_eth_dev_internal_reset()``
519
520 * ethdev: Modified field type of ``base`` and ``nb_queue`` in struct
521   ``rte_eth_dcb_tc_queue_mapping`` from ``uint8_t`` to ``uint16_t``.
522   As the data of ``uint8_t`` will be truncated when queue number under
523   a TC is greater than 256.
524
525 * vhost: Moved vDPA APIs from experimental to stable.
526
527 * vhost: Add a new function ``rte_vhost_crypto_driver_start`` to be called
528   instead of ``rte_vhost_driver_start`` by crypto applications.
529
530 * cryptodev: The structure ``rte_crypto_sym_vec`` is updated to support both
531   cpu_crypto synchrounous operation and asynchronous raw data-path APIs.
532
533 * cryptodev: ``RTE_CRYPTO_AEAD_LIST_END`` from ``enum rte_crypto_aead_algorithm``,
534   ``RTE_CRYPTO_CIPHER_LIST_END`` from ``enum rte_crypto_cipher_algorithm`` and
535   ``RTE_CRYPTO_AUTH_LIST_END`` from ``enum rte_crypto_auth_algorithm``
536   are removed to avoid future ABI breakage while adding new algorithms.
537
538 * scheduler: Renamed functions ``rte_cryptodev_scheduler_slave_attach``,
539   ``rte_cryptodev_scheduler_slave_detach`` and
540   ``rte_cryptodev_scheduler_slaves_get`` to
541   ``rte_cryptodev_scheduler_worker_attach``,
542   ``rte_cryptodev_scheduler_worker_detach`` and
543   ``rte_cryptodev_scheduler_workers_get`` accordingly.
544
545 * scheduler: Renamed the configuration value
546   ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_SLAVES`` to
547   ``RTE_CRYPTODEV_SCHEDULER_MAX_NB_WORKERS``.
548
549 * security: ``hfn_ovrd`` field in ``rte_security_pdcp_xform`` is changed from
550   ``uint32_t`` to ``uint8_t`` so that a new field ``sdap_enabled`` can be added
551   to support SDAP.
552
553 * security: The API ``rte_security_session_create`` is updated to take two
554   mempool objects one for session and other for session private data.
555   So the application need to create two mempools and get the size of session
556   private data using API ``rte_security_session_get_size`` for private session
557   mempool.
558
559 * ipsec: ``RTE_SATP_LOG2_NUM`` has been dropped from ``enum`` and
560   subsequently moved ``rte_ipsec`` lib from experimental to stable.
561
562 * baseband/fpga_lte_fec: Renamed function ``fpga_lte_fec_configure`` to
563   ``rte_fpga_lte_fec_configure`` and structure ``fpga_lte_fec_conf`` to
564   ``rte_fpga_lte_fec_conf``.
565
566 * baseband/fpga_5gnr_fec: Renamed function ``fpga_5gnr_fec_configure`` to
567   ``rte_fpga_5gnr_fec_configure`` and structure ``fpga_5gnr_fec_conf`` to
568   ``rte_fpga_5gnr_fec_conf``.
569
570 * rawdev: Added a structure size parameter to the functions
571   ``rte_rawdev_queue_setup()``, ``rte_rawdev_queue_conf_get()``,
572   ``rte_rawdev_info_get()`` and ``rte_rawdev_configure()``,
573   allowing limited driver type-checking and ABI compatibility.
574
575 * rawdev: Changed the return type of the function ``rte_dev_info_get()``
576   and the function ``rte_rawdev_queue_conf_get()``
577   from ``void`` to ``int`` allowing the return of error codes from drivers.
578
579 * rawdev: The running of a drivers ``selftest()`` function can now be done
580   using the ``rawdev_autotest`` command in the ``dpdk-test`` binary. This
581   command now calls the self-test function for each rawdev found on the
582   system, and does not require a specific command per device type.
583   Following this change, the ``ioat_rawdev_autotest`` command has been
584   removed as no longer needed.
585
586 * raw/ioat: As noted above, the ``rte_ioat_do_copies()`` and
587   ``rte_ioat_completed_copies()`` functions have been renamed to
588   ``rte_ioat_perform_ops()`` and ``rte_ioat_completed_ops()`` respectively.
589
590 * stack: the experimental tag has been dropped from the stack library, and its
591   interfaces are considered stable as of DPDK 20.11.
592
593 * bpf: ``RTE_BPF_XTYPE_NUM`` has been dropped from ``rte_bpf_xtype``.
594
595 * gso: Changed ``rte_gso_segment`` behaviour and return value:
596
597   * ``pkt`` is not saved to ``pkts_out[0]`` if not GSOed.
598   * Return 0 instead of 1 for the above case.
599   * ``pkt`` is not freed, no matter whether it is GSOed, leaving to the caller.
600
601 * acl: ``RTE_ACL_CLASSIFY_NUM`` enum value has been removed.
602   This enum value was not used inside DPDK, while it prevented to add new
603   classify algorithms without causing an ABI breakage.
604
605 * sched: Added ``subport_profile_id`` as argument
606   to function ``rte_sched_subport_config``.
607
608 * sched: Removed ``tb_rate``, ``tc_rate``, ``tc_period`` and ``tb_size``
609   from ``struct rte_sched_subport_params``.
610
611
612 ABI Changes
613 -----------
614
615 .. This section should contain ABI changes. Sample format:
616
617    * sample: Add a short 1-2 sentence description of the ABI change
618      which was announced in the previous releases and made in this release.
619      Start with a scope label like "ethdev:".
620      Use fixed width quotes for ``function_names`` or ``struct_names``.
621      Use the past tense.
622
623    This section is a comment. Do not overwrite or remove it.
624    Also, make sure to start the actual text at the margin.
625    =======================================================
626
627 * eal: Removed the not implemented function ``rte_dump_registers()``.
628
629 * ``ethdev`` changes
630
631   * Following device operation function pointers moved
632     from ``struct eth_dev_ops`` to ``struct rte_eth_dev``:
633
634     * ``eth_rx_queue_count_t       rx_queue_count;``
635     * ``eth_rx_descriptor_done_t   rx_descriptor_done;``
636     * ``eth_rx_descriptor_status_t rx_descriptor_status;``
637     * ``eth_tx_descriptor_status_t tx_descriptor_status;``
638
639   * ``struct eth_dev_ops`` is no more accessible by applications,
640     which was already internal data structure.
641
642   * ``ethdev`` internal functions are marked with ``__rte_internal`` tag.
643
644   * Added extensions' attributes to struct ``rte_flow_item_ipv6``.
645     A set of additional values added to struct, indicating the existence of
646     every defined extension header type.
647     Applications should use the new values for identification of existing
648     extensions in the packet header.
649
650   * Added fields ``rx_seg`` and ``rx_nseg`` to ``rte_eth_rxconf`` structure
651     to provide extended description of the receiving buffer.
652
653   * ``struct rte_eth_hairpin_conf`` has two new members:
654
655     * ``uint32_t tx_explicit:1;``
656     * ``uint32_t manual_bind:1;``
657
658   * Added new field ``has_vlan`` to structure ``rte_flow_item_eth``,
659     indicating that packet header contains at least one VLAN.
660
661   * Added new field ``has_more_vlan`` to structure
662     ``rte_flow_item_vlan``, indicating that packet header contains
663     at least one more VLAN, after this VLAN.
664
665 * eventdev: Following structures are modified to support DLB/DLB2 PMDs
666   and future extensions:
667
668   * ``rte_event_dev_info``
669   * ``rte_event_dev_config``
670   * ``rte_event_port_conf``
671
672 * sched: Added new fields to ``struct rte_sched_subport_port_params``.
673
674 * lpm: Removed fields other than ``tbl24`` and ``tbl8`` from the struct
675   ``rte_lpm``. The removed fields were made internal.
676
677
678 Known Issues
679 ------------
680
681 .. This section should contain new known issues in this release. Sample format:
682
683    * **Add title in present tense with full stop.**
684
685      Add a short 1-2 sentence description of the known issue
686      in the present tense. Add information on any known workarounds.
687
688    This section is a comment. Do not overwrite or remove it.
689    Also, make sure to start the actual text at the margin.
690    =======================================================
691
692
693 Tested Platforms
694 ----------------
695
696 .. This section should contain a list of platforms that were tested
697    with this release.
698
699    The format is:
700
701    * <vendor> platform with <vendor> <type of devices> combinations
702
703      * List of CPU
704      * List of OS
705      * List of devices
706      * Other relevant details...
707
708    This section is a comment. Do not overwrite or remove it.
709    Also, make sure to start the actual text at the margin.
710    =======================================================