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