security: add telemetry endpoint for capabilities
[dpdk.git] / doc / guides / rel_notes / release_21_11.rst
1 .. SPDX-License-Identifier: BSD-3-Clause
2    Copyright 2021 The DPDK contributors
3
4 .. include:: <isonum.txt>
5
6 DPDK Release 21.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       ninja -C build doc
21       xdg-open build/doc/guides/html/rel_notes/release_21_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 (ordered alphabetically by vendor name)
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 * **Enabled new devargs parser.**
59
60   * Enabled devargs syntax
61     ``bus=X,paramX=x/class=Y,paramY=y/driver=Z,paramZ=z``
62   * Added bus-level parsing of the devargs syntax.
63   * Kept compatibility with the legacy syntax as parsing fallback.
64
65 * **Updated EAL hugetlbfs mount handling for Linux.**
66
67   * Modified to allow ``--huge-dir`` option to specify a sub-directory
68     within a hugetlbfs mountpoint.
69
70 * **Added dmadev library.**
71
72   * Added a DMA device framework for management and provision of
73     hardware and software DMA devices.
74   * Added generic API which support a number of different DMA
75     operations.
76   * Added multi-process support.
77
78 * **Added IDXD dmadev driver implementation.**
79
80   The IDXD dmadev driver provide device drivers for the Intel DSA devices.
81   This device driver can be used through the generic dmadev API.
82
83 * **Added IOAT dmadev driver implementation.**
84
85   The Intel I/O Acceleration Technology (IOAT) dmadev driver provides a device
86   driver for Intel IOAT devices such as Crystal Beach DMA (CBDMA) on Ice Lake,
87   Skylake and Broadwell. This device driver can be used through the generic dmadev API.
88
89 * **Added support to get all MAC addresses of a device.**
90
91   Added ``rte_eth_macaddrs_get`` to allow user to retrieve all Ethernet
92   addresses assigned to given ethernet port.
93
94 * **Added new RSS offload types for IPv4/L4 checksum in RSS flow.**
95
96   Added macros ETH_RSS_IPV4_CHKSUM and ETH_RSS_L4_CHKSUM, now IPv4 and
97   TCP/UDP/SCTP header checksum field can be used as input set for RSS.
98
99 * **Added L2TPv2 and PPP protocol support in flow API.**
100
101   Added flow pattern items and header formats of L2TPv2 and PPP protocol.
102
103 * **Added flow flex item.**
104
105   The configurable flow flex item provides the capability to introduce
106   an arbitrary user-specified network protocol header,
107   configure the hardware accordingly, and perform match on this header
108   with desired patterns and masks.
109
110 * **Added ethdev support to control delivery of Rx metadata from the HW to the PMD.**
111
112   A new API, ``rte_eth_rx_metadata_negotiate()``, was added.
113   The following parts of Rx metadata were defined:
114
115   * ``RTE_ETH_RX_METADATA_USER_FLAG``
116   * ``RTE_ETH_RX_METADATA_USER_MARK``
117   * ``RTE_ETH_RX_METADATA_TUNNEL_ID``
118
119 * **Added an API to get a proxy port to manage "transfer" flows.**
120
121   A new API, ``rte_flow_pick_transfer_proxy()``, was added.
122
123 * **Added ethdev shared Rx queue support.**
124
125   * Added new device capability flag and Rx domain field to switch info.
126   * Added share group and share queue ID to Rx queue configuration.
127   * Added testpmd support and dedicate forwarding engine.
128
129 * **Updated af_packet ethdev driver.**
130
131   * Default VLAN strip behavior was changed. VLAN tag won't be stripped
132     unless ``DEV_RX_OFFLOAD_VLAN_STRIP`` offload is enabled.
133
134 * **Added API to get device configuration in ethdev.**
135
136   Added an ethdev API which can help users get device configuration.
137
138 * **Updated AF_XDP PMD.**
139
140   * Disabled secondary process support.
141
142 * **Updated Amazon ENA PMD.**
143
144   Updated the Amazon ENA PMD. The new driver version (v2.5.0) introduced
145   bug fixes and improvements, including:
146
147   * Support for the tx_free_thresh and rx_free_thresh configuration parameters.
148   * NUMA aware allocations for the queue helper structures.
149   * Watchdog's feature which is checking for missing Tx completions.
150
151 * **Updated Broadcom bnxt PMD.**
152
153   * Added flow offload support for Thor.
154   * Implement support for tunnel offload.
155   * Updated HWRM API to version 1.10.2.44
156
157 * **Updated Cisco enic driver.**
158
159   * Added rte_flow support for matching GTP, GTP-C and GTP-U headers.
160
161 * **Updated Intel e1000 emulated driver.**
162
163   * Added Intel e1000 support on Windows.
164
165 * **Updated Intel iavf driver.**
166
167   * Added Intel iavf support on Windows.
168   * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
169   * Added PPPoL2TPv2oUDP RSS hash based on inner IP address and TCP/UDP port.
170   * Added Intel iavf inline crypto support.
171
172 * **Updated Intel ice driver.**
173
174   * Added protocol agnostic flow offloading support in Flow Director.
175   * Added protocol agnostic flow offloading support in RSS hash.
176   * Added 1PPS out support by a devargs.
177   * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
178   * Added DEV_RX_OFFLOAD_TIMESTAMP support.
179   * Added timesync API support under scalar path.
180
181 * **Updated Intel ixgbe driver.**
182
183   * Added Intel ixgbe support on Windows.
184
185 * **Updated Marvell cnxk ethdev driver.**
186
187   * Added rte_flow support for dual VLAN insert and strip actions.
188   * Added rte_tm support.
189   * Added support for Inline IPsec for CN9K event mode and CN10K
190     poll mode and event mode.
191   * Added support for ingress meter for CN10K platform.
192
193 * **Updated Mellanox mlx5 driver.**
194
195   Updated the Mellanox mlx5 driver with new features and improvements, including:
196
197   * Added implicit mempool registration to avoid data path hiccups (opt-out).
198   * Added NIC offloads for the PMD on Windows (TSO, VLAN strip, CRC keep).
199   * Added socket direct mode bonding support.
200
201 * **Updated Solarflare network PMD.**
202
203   Updated the Solarflare ``sfc_efx`` driver with changes including:
204
205   * Added port representors support on SN1000 SmartNICs
206   * Added flow API transfer proxy support
207   * Added SN1000 virtual functions (VF) support
208   * Added support for flow counters without service cores
209
210 * **Added power monitor API in vhost library.**
211
212   Added an API to support power monitor in vhost library.
213
214 * **Updated vhost PMD.**
215
216   Add power monitor support in vhost PMD.
217
218 * **Updated virtio PMD.**
219
220   * Initial support for RSS receive mode has been added to the Virtio PMD,
221     with the capability for the application to configure the hash key,
222     the RETA and the hash types.
223     Virtio hash reporting is yet to be added.
224   * Added power monitor support in virtio PMD.
225
226 * **Updated Wangxun ngbe driver.**
227
228   * Added offloads and packet type on RxTx.
229   * Added VLAN and MAC filters.
230   * Added device basic statistics and extended stats.
231   * Added multi-queue and RSS.
232   * Added SRIOV.
233   * Added flow control.
234   * Added IEEE 1588.
235
236 * **Added telemetry callbacks to cryptodev library.**
237
238   Added telemetry callback functions which allow a list of crypto devices,
239   stats for a crypto device, and other device information to be queried.
240   Also added callback to get cryptodev capabilities.
241
242 * **Added telemetry to security library.**
243
244   Added telemetry callback functions to query security capabilities of
245   crypto device.
246
247 * **Updated Marvell cnxk crypto PMD.**
248
249   * Added AES-CBC SHA1-HMAC support in lookaside protocol (IPsec) for CN10K.
250   * Added Transport mode support in lookaside protocol (IPsec) for CN10K.
251   * Added UDP encapsulation support in lookaside protocol (IPsec) for CN10K.
252   * Added support for lookaside protocol (IPsec) offload for CN9K.
253   * Added support for ZUC algorithm with 256-bit key length for CN10K.
254   * Added support for CN98xx dual block.
255   * Added inner checksum support in lookaside protocol (IPsec) for CN10K.
256   * Added AES-CBC NULL auth support in lookaside protocol (IPsec) for CN10K.
257   * Added ESN and anti-replay support in lookaside protocol (IPsec) for CN9K.
258
259 * **Added support for event crypto adapter on Marvell CN10K and CN9K.**
260
261   * Added event crypto adapter OP_FORWARD mode support.
262
263 * **Updated Mellanox mlx5 crypto driver.**
264
265   * Added Windows support.
266
267 * **Updated NXP dpaa_sec crypto PMD.**
268
269   * Added DES-CBC, AES-XCBC-MAC, AES-CMAC and non-HMAC algo support.
270   * Added PDCP short MAC-I support.
271   * Added raw vector datapath API support.
272
273 * **Updated NXP dpaa2_sec crypto PMD.**
274
275   * Added PDCP short MAC-I support.
276   * Added raw vector datapath API support.
277
278 * **Added framework for consolidation of IPsec_MB dependent SW Crypto PMDs.**
279
280   * The IPsec_MB framework was added to share common code between Intel
281     SW Crypto PMDs that depend on the intel-ipsec-mb library.
282   * Multiprocess support was added for the consolidated PMDs,
283     which requires v1.1 of the intel-ipsec-mb library.
284   * The following PMDs were moved into a single source folder,
285     however their usage and EAL options remain unchanged.
286     * AESNI_MB PMD.
287     * AESNI_GCM PMD.
288     * KASUMI PMD.
289     * SNOW3G PMD.
290     * ZUC PMD.
291     * CHACHA20_POLY1305 - A new PMD added.
292
293 * **Updated the aesni_mb crypto PMD.**
294
295   * Added support for ZUC-EEA3-256 and ZUC-EIA3-256.
296
297 * **Added digest appended ops support for Snow3G PMD.**
298
299   * Added support for out-of-place auth-cipher operations that encrypt
300     the digest along with the rest of the raw data.
301   * Added support for partially encrypted digest when using auth-cipher
302     operations.
303
304 * **Updated the ACC100 bbdev PMD.**
305
306   Added support for more comprehensive CRC options.
307
308 * **Updated the turbo_sw bbdev PMD.**
309
310   Added support for more comprehensive CRC options.
311
312 * **Added NXP LA12xx baseband PMD.**
313
314   * Added a new baseband PMD driver for NXP LA12xx Software defined radio.
315   * See the :doc:`../bbdevs/la12xx` for more details.
316
317 * **Updated Mellanox compress driver.**
318
319   * Added devargs option to allow manual setting of Huffman block size.
320
321 * **Updated Mellanox regex driver.**
322
323   * Added support for new ROF file format.
324
325 * **Updated IPsec library.**
326
327   * Added support for more AEAD algorithms AES_CCM, CHACHA20_POLY1305
328     and AES_GMAC.
329   * Added support for NAT-T / UDP encapsulated ESP.
330   * Added support for SA telemetry.
331   * Added support for setting a non default starting ESN value.
332   * Added support for TSO in inline crypto mode.
333
334 * **Added optimized Toeplitz hash implementation.**
335
336   Added optimized Toeplitz hash implementation using Galois Fields New Instructions.
337
338 * **Added multi-process support for testpmd.**
339
340   Added command-line options to specify total number of processes and
341   current process ID. Each process owns subset of Rx and Tx queues.
342
343 * **Updated test-crypto-perf application with new cases.**
344
345   * Added support for asymmetric crypto throughput performance measurement.
346     Only modex is supported for now.
347   * Added support for lookaside IPsec protocol offload throughput measurement.
348
349 * **Added lookaside protocol (IPsec) tests in dpdk-test.**
350
351   * Added known vector tests (AES-GCM 128, 192, 256).
352   * Added tests to verify error reporting with ICV corruption.
353   * Added tests to verify IV generation.
354   * Added tests to verify UDP encapsulation.
355   * Added tests to verify UDP encapsulation ports.
356   * Added tests to validate packets soft expiry.
357   * Added tests to validate packets hard expiry.
358   * Added tests to verify tunnel header verification in IPsec inbound.
359   * Added tests to verify inner checksum.
360   * Added tests for CHACHA20_POLY1305 PMD, including a new testcase for SGL OOP.
361
362 * **Updated IPsec Security Gateway sample application with new features.**
363
364   * Added support for TSO (only for inline crypto TCP packets).
365   * Added support for telemetry.
366   * Added support for more AEAD algorithms: AES-GMAC, AES_CTR, AES_XCBC_MAC,
367     AES_CCM, CHACHA20_POLY1305
368   * Added support for event vectors for inline protocol offload mode.
369
370 * **Revised packet capture framework.**
371
372   * New dpdk-dumpcap program that has most of the features
373     of the wireshark dumpcap utility including:
374     capture of multiple interfaces, filtering,
375     and stopping after number of bytes, packets.
376   * New library for writing pcapng packet capture files.
377   * Enhancements to the pdump library to support:
378     * Packet filter with BPF.
379     * Pcapng format with timestamps and meta-data.
380     * Fixes packet capture with stripped VLAN tags.
381
382 * **Added ASan support.**
383
384   `AddressSanitizer
385   <https://github.com/google/sanitizers/wiki/AddressSanitizer>`_ (ASan)
386   is a widely-used debugging tool to detect memory access errors.
387   It helps to detect issues like use-after-free, various kinds of buffer
388   overruns in C/C++ programs, and other similar errors, as well as
389   printing out detailed debug information whenever an error is detected.
390
391
392 Removed Items
393 -------------
394
395 .. This section should contain removed items in this release. Sample format:
396
397    * Add a short 1-2 sentence description of the removed item
398      in the past tense.
399
400    This section is a comment. Do not overwrite or remove it.
401    Also, make sure to start the actual text at the margin.
402    =======================================================
403
404 * eal: Removed the deprecated function ``rte_get_master_lcore()``
405   and the iterator macro ``RTE_LCORE_FOREACH_SLAVE``.
406
407 * eal: The old api arguments that were deprecated for
408   blacklist/whitelist are removed. Users must use the new
409   block/allow list arguments.
410
411 * mbuf: Removed offload flag ``PKT_RX_EIP_CKSUM_BAD``.
412   ``PKT_RX_OUTER_IP_CKSUM_BAD`` should be used as a replacement.
413
414 * ethdev: Removed the port mirroring API. A more fine-grain flow API
415   action ``RTE_FLOW_ACTION_TYPE_SAMPLE`` should be used instead.
416   The structures ``rte_eth_mirror_conf`` and ``rte_eth_vlan_mirror`` and
417   the functions ``rte_eth_mirror_rule_set`` and
418   ``rte_eth_mirror_rule_reset`` along with the associated macros
419   ``ETH_MIRROR_*`` are removed.
420
421 * ethdev: Removed ``rte_eth_rx_descriptor_done`` API function and its
422   driver callback. It is replaced by the more complete function
423   ``rte_eth_rx_descriptor_status``.
424
425 * ethdev: Removed deprecated ``shared`` attribute of the
426   ``struct rte_flow_action_count``. Shared counters should be managed
427   using indirect actions API (``rte_flow_action_handle_create`` etc).
428
429 * i40e: Removed i40evf driver.
430   iavf already became the default VF driver for i40e devices,
431   so there is no need to maintain i40evf.
432
433
434 API Changes
435 -----------
436
437 .. This section should contain API changes. Sample format:
438
439    * sample: Add a short 1-2 sentence description of the API change
440      which was announced in the previous releases and made in this release.
441      Start with a scope label like "ethdev:".
442      Use fixed width quotes for ``function_names`` or ``struct_names``.
443      Use the past tense.
444
445    This section is a comment. Do not overwrite or remove it.
446    Also, make sure to start the actual text at the margin.
447    =======================================================
448
449 * eal: The lcore state ``FINISHED`` is removed from
450   the ``enum rte_lcore_state_t``.
451   The lcore state ``WAIT`` is enough to represent the same state.
452
453 * eal: Made ``rte_intr_handle`` structure definition hidden.
454
455 * kvargs: The experimental function ``rte_kvargs_strcmp()`` has been
456   removed. Its usages have been replaced by a new function
457   ``rte_kvargs_get_with_value()``.
458
459 * cmdline: ``cmdline_stdin_exit()`` now frees the ``cmdline`` structure.
460   Calls to ``cmdline_free()`` after it need to be deleted from applications.
461
462 * cmdline: Made ``cmdline`` structure definition hidden on Linux and FreeBSD.
463
464 * cmdline: Made ``rdline`` structure definition hidden. Functions are added
465   to dynamically allocate and free it, and to access user data in callbacks.
466
467 * mempool: Added ``RTE_MEMPOOL_F_NON_IO`` flag to give a hint to DPDK components
468   that objects from this pool will not be used for device IO (e.g. DMA).
469
470 * mempool: The mempool flags ``MEMPOOL_F_*`` will be deprecated in the future.
471   Newly added flags with ``RTE_MEMPOOL_F_`` prefix should be used instead.
472
473 * mempool: Helper macro ``MEMPOOL_HEADER_SIZE()`` is deprecated.
474   The replacement macro ``RTE_MEMPOOL_HEADER_SIZE()`` is internal only.
475
476 * mempool: Macro to register mempool driver ``MEMPOOL_REGISTER_OPS()`` is
477   deprecated.  Use replacement ``RTE_MEMPOOL_REGISTER_OPS()``.
478
479 * mempool: The mempool API macros ``MEMPOOL_PG_*`` are deprecated and
480   will be removed in DPDK 22.11.
481
482 * mbuf: The mbuf offload flags ``PKT_*`` are renamed as ``RTE_MBUF_F_*``. A
483   compatibility layer will be kept until DPDK 22.11.
484 * net: Renamed ``s_addr`` and ``d_addr`` fields of ``rte_ether_hdr`` structure
485   to ``src_addr`` and ``dst_addr``, respectively.
486
487 * net: Added ``version`` and ``ihl`` bit-fields to ``struct rte_ipv4_hdr``.
488   Existing ``version_ihl`` field is kept for backward compatibility.
489
490 * ethdev: Added items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` to
491   flow API.
492
493 * ethdev: Deprecated items and actions ``PF``, ``VF``, ``PHY_PORT``, ``PORT_ID``.
494   Suggested items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` instead.
495
496 * ethdev: Deprecated the use of attributes ``ingress`` / ``egress`` combined
497   with ``transfer``. See items ``PORT_REPRESENTOR``, ``REPRESENTED_PORT``.
498
499 * ethdev: ``rte_flow_action_modify_data`` structure updated, immediate data
500   array is extended, data pointer field is explicitly added to union, the
501   action behavior is defined in more strict fashion and documentation updated.
502   The immediate value behavior has been changed, the entire immediate field
503   should be provided, and offset for immediate source bitfield is assigned
504   from destination one.
505
506 * vhost: ``rte_vdpa_register_device``, ``rte_vdpa_unregister_device``,
507   ``rte_vhost_host_notifier_ctrl`` and ``rte_vdpa_relay_vring_used`` vDPA
508   driver interface are marked as internal.
509
510 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
511   rte_cryptodev_is_valid_dev as it can be used by the application as
512   well as PMD to check whether the device is valid or not.
513
514 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
515   as it is for drivers only and should be private to DPDK, and not
516   installed for app use.
517
518 * cryptodev: A ``reserved`` byte from structure ``rte_crypto_op`` was
519   renamed to ``aux_flags`` to indicate warnings and other information from
520   the crypto/security operation. This field will be used to communicate
521   events such as soft expiry with IPsec in lookaside mode.
522
523 * cryptodev: The field ``dataunit_len`` of the ``struct rte_crypto_cipher_xform``
524   moved to the end of the structure and extended to ``uint32_t``.
525
526 * cryptodev: The structure ``rte_crypto_vec`` was updated to add ``tot_len``
527   field to support total buffer length to facilitate protocol offload case.
528
529 * cryptodev: The structure ``rte_crypto_sym_vec`` was updated to add
530   ``dest_sgl`` to support out of place processing.
531
532 * bbdev: Added device info related to data byte endianness processing.
533
534 * eventdev: Moved memory used by timer adapters to hugepage. This will prevent
535   TLB misses if any and aligns to memory structure of other subsystems.
536
537 * fib: Added the ``rib_ext_sz`` field to ``rte_fib_conf`` and ``rte_fib6_conf``
538   so that user can specify the size of the RIB extension inside the FIB.
539
540
541 ABI Changes
542 -----------
543
544 .. This section should contain ABI changes. Sample format:
545
546    * sample: Add a short 1-2 sentence description of the ABI change
547      which was announced in the previous releases and made in this release.
548      Start with a scope label like "ethdev:".
549      Use fixed width quotes for ``function_names`` or ``struct_names``.
550      Use the past tense.
551
552    This section is a comment. Do not overwrite or remove it.
553    Also, make sure to start the actual text at the margin.
554    =======================================================
555
556 * ethdev: All enums & macros updated to have ``RTE_ETH`` prefix and structures
557   updated to have ``rte_eth`` prefix. DPDK components updated to use new names.
558
559 * ethdev: Input parameters for ``eth_rx_queue_count_t`` was changed.
560   Instead of pointer to ``rte_eth_dev`` and queue index, now it accepts pointer
561   to internal queue data as input parameter. While this change is transparent
562   to user, it still counts as an ABI change, as ``eth_rx_queue_count_t``
563   is used by  public inline function ``rte_eth_rx_queue_count``.
564
565 * ethdev: Made ``rte_eth_dev``, ``rte_eth_dev_data``, ``rte_eth_rxtx_callback``
566   private data structures. ``rte_eth_devices[]`` can't be accessed directly
567   by user any more. While it is an ABI breakage, this change is intended
568   to be transparent for both users (no changes in user app is required) and
569   PMD developers (no changes in PMD is required).
570
571 * vhost: rename ``struct vhost_device_ops`` to ``struct rte_vhost_device_ops``.
572
573 * cryptodev: Made ``rte_cryptodev``, ``rte_cryptodev_data`` private
574   structures internal to DPDK. ``rte_cryptodevs`` can't be accessed directly
575   by user any more. While it is an ABI breakage, this change is intended
576   to be transparent for both users (no changes in user app is required) and
577   PMD developers (no changes in PMD is required).
578
579 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
580   routines used by inline outbound and inline inbound security processing were
581   made inline and enhanced to do simple 64-bit set/get for PMDs that do not
582   have much processing in PMD specific callbacks but just 64-bit set/get.
583   This avoids a per packet function pointer jump overhead for such PMDs.
584
585 * security: A new option ``iv_gen_disable`` was added in structure
586   ``rte_security_ipsec_sa_options`` to disable IV generation inside PMD,
587   so that application can provide its own IV and test known test vectors.
588
589 * security: A new option ``tunnel_hdr_verify`` was added in structure
590   ``rte_security_ipsec_sa_options`` to indicate whether outer header
591   verification need to be done as part of inbound IPsec processing.
592
593 * security: A new option ``udp_ports_verify`` was added in structure
594   ``rte_security_ipsec_sa_options`` to indicate whether UDP ports
595   verification need to be done as part of inbound IPsec processing.
596
597 * security: A new structure ``rte_security_ipsec_lifetime`` was added to
598   replace ``esn_soft_limit`` in IPsec configuration structure
599   ``rte_security_ipsec_xform`` to allow applications to configure SA soft
600   and hard expiry limits. Limits can be either in number of packets or bytes.
601
602 * security: The new options ``ip_csum_enable`` and ``l4_csum_enable`` were added
603   in structure ``rte_security_ipsec_sa_options`` to indicate whether inner
604   packet IPv4 header checksum and L4 checksum need to be offloaded to
605   security device.
606
607 * security: A new structure ``esn`` was added in structure
608   ``rte_security_ipsec_xform`` to set an initial ESN value. This permits
609   application to start from an arbitrary ESN value for debug and SA lifetime
610   enforcement purposes.
611
612 * security: A new structure ``udp`` was added in structure
613   ``rte_security_ipsec_xform`` to allow setting the source and destination ports
614   for UDP encapsulated IPsec traffic.
615
616 * bbdev: Added capability related to more comprehensive CRC options,
617   shifting values of the ``enum rte_bbdev_op_ldpcdec_flag_bitmasks``.
618
619 * eventdev: New variables ``rx_event_buf_count`` and ``rx_event_buf_size``
620   were added in structure ``rte_event_eth_rx_adapter_stats`` to get additional
621   status.
622
623 * eventdev: A new structure ``rte_event_fp_ops`` has been added which is now used
624   by the fastpath inline functions. The structures ``rte_eventdev``,
625   ``rte_eventdev_data`` have been made internal. ``rte_eventdevs[]`` can't be
626   accessed directly by user any more. This change is transparent to both
627   applications and PMDs.
628
629 * eventdev: Re-arranged fields in ``rte_event_timer`` to remove holes.
630
631
632 Known Issues
633 ------------
634
635 .. This section should contain new known issues in this release. Sample format:
636
637    * **Add title in present tense with full stop.**
638
639      Add a short 1-2 sentence description of the known issue
640      in the present tense. Add information on any known workarounds.
641
642    This section is a comment. Do not overwrite or remove it.
643    Also, make sure to start the actual text at the margin.
644    =======================================================
645
646
647 Tested Platforms
648 ----------------
649
650 .. This section should contain a list of platforms that were tested
651    with this release.
652
653    The format is:
654
655    * <vendor> platform with <vendor> <type of devices> combinations
656
657      * List of CPU
658      * List of OS
659      * List of devices
660      * Other relevant details...
661
662    This section is a comment. Do not overwrite or remove it.
663    Also, make sure to start the actual text at the margin.
664    =======================================================