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