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