app/testpmd: increase max raw pattern size to 512
[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 Intel e1000 emulated driver.**
158
159   * Added Intel e1000 support on Windows.
160
161 * **Updated Intel iavf driver.**
162
163   * Added Intel iavf support on Windows.
164   * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
165   * Added PPPoL2TPv2oUDP RSS hash based on inner IP address and TCP/UDP port.
166   * Added Intel iavf inline crypto support.
167
168 * **Updated Intel ice driver.**
169
170   * Added 1PPS out support by a devargs.
171   * Added IPv4 and L4 (TCP/UDP/SCTP) checksum hash support in RSS flow.
172   * Added DEV_RX_OFFLOAD_TIMESTAMP support.
173   * Added timesync API support under scalar path.
174
175 * **Updated Intel ixgbe driver.**
176
177   * Added Intel ixgbe support on Windows.
178
179 * **Updated Marvell cnxk ethdev driver.**
180
181   * Added rte_flow support for dual VLAN insert and strip actions.
182   * Added rte_tm support.
183   * Added support for Inline IPsec for CN9K event mode and CN10K
184     poll mode and event mode.
185   * Added support for ingress meter for CN10K platform.
186
187 * **Updated Mellanox mlx5 driver.**
188
189   Updated the Mellanox mlx5 driver with new features and improvements, including:
190
191   * Added implicit mempool registration to avoid data path hiccups (opt-out).
192   * Added NIC offloads for the PMD on Windows (TSO, VLAN strip, CRC keep).
193   * Added socket direct mode bonding support.
194
195 * **Updated Solarflare network PMD.**
196
197   Updated the Solarflare ``sfc_efx`` driver with changes including:
198
199   * Added port representors support on SN1000 SmartNICs
200   * Added flow API transfer proxy support
201
202 * **Added power monitor API in vhost library.**
203
204   Added an API to support power monitor in vhost library.
205
206 * **Updated vhost PMD.**
207
208   Add power monitor support in vhost PMD.
209
210 * **Updated virtio PMD.**
211
212   * Initial support for RSS receive mode has been added to the Virtio PMD,
213     with the capability for the application to configure the hash key,
214     the RETA and the hash types.
215     Virtio hash reporting is yet to be added.
216   * Added power monitor support in virtio PMD.
217
218 * **Updated Wangxun ngbe driver.**
219
220   * Added offloads and packet type on RxTx.
221   * Added VLAN and MAC filters.
222   * Added device basic statistics and extended stats.
223   * Added multi-queue and RSS.
224   * Added SRIOV.
225   * Added flow control.
226   * Added IEEE 1588.
227
228 * **Updated Marvell cnxk crypto PMD.**
229
230   * Added AES-CBC SHA1-HMAC support in lookaside protocol (IPsec) for CN10K.
231   * Added Transport mode support in lookaside protocol (IPsec) for CN10K.
232   * Added UDP encapsulation support in lookaside protocol (IPsec) for CN10K.
233   * Added support for lookaside protocol (IPsec) offload for CN9K.
234   * Added support for ZUC algorithm with 256-bit key length for CN10K.
235   * Added support for CN98xx dual block.
236   * Added inner checksum support in lookaside protocol (IPsec) for CN10K.
237
238 * **Added support for event crypto adapter on Marvell CN10K and CN9K.**
239
240   * Added event crypto adapter OP_FORWARD mode support.
241
242 * **Updated NXP dpaa_sec crypto PMD.**
243
244   * Added DES-CBC, AES-XCBC-MAC, AES-CMAC and non-HMAC algo support.
245   * Added PDCP short MAC-I support.
246   * Added raw vector datapath API support.
247
248 * **Updated NXP dpaa2_sec crypto PMD.**
249
250   * Added PDCP short MAC-I support.
251   * Added raw vector datapath API support.
252
253 * **Added framework for consolidation of IPsec_MB dependent SW Crypto PMDs.**
254
255   * The IPsec_MB framework was added to share common code between Intel
256     SW Crypto PMDs that depend on the intel-ipsec-mb library.
257   * Multiprocess support was added for the consolidated PMDs,
258     which requires v1.1 of the intel-ipsec-mb library.
259   * The following PMDs were moved into a single source folder,
260     however their usage and EAL options remain unchanged.
261     * AESNI_MB PMD.
262     * AESNI_GCM PMD.
263     * KASUMI PMD.
264     * SNOW3G PMD.
265     * ZUC PMD.
266     * CHACHA20_POLY1305 - A new PMD added.
267
268 * **Updated the aesni_mb crypto PMD.**
269
270   * Added support for ZUC-EEA3-256 and ZUC-EIA3-256.
271
272 * **Added digest appended ops support for Snow3G PMD.**
273
274   * Added support for out-of-place auth-cipher operations that encrypt
275     the digest along with the rest of the raw data.
276   * Added support for partially encrypted digest when using auth-cipher
277     operations.
278
279 * **Updated the ACC100 bbdev PMD.**
280
281   Added support for more comprehensive CRC options.
282
283 * **Updated the turbo_sw bbdev PMD.**
284
285   Added support for more comprehensive CRC options.
286
287 * **Added NXP LA12xx baseband PMD.**
288
289   * Added a new baseband PMD driver for NXP LA12xx Software defined radio.
290   * See the :doc:`../bbdevs/la12xx` for more details.
291
292 * **Updated Mellanox regex driver.**
293
294   * Added support for new ROF file format.
295
296 * **Updated IPsec library.**
297
298   * Added support for more AEAD algorithms AES_CCM, CHACHA20_POLY1305
299     and AES_GMAC.
300   * Added support for NAT-T / UDP encapsulated ESP.
301   * Added support for SA telemetry.
302   * Added support for setting a non default starting ESN value.
303
304 * **Added optimized Toeplitz hash implementation.**
305
306   Added optimized Toeplitz hash implementation using Galois Fields New Instructions.
307
308 * **Added multi-process support for testpmd.**
309
310   Added command-line options to specify total number of processes and
311   current process ID. Each process owns subset of Rx and Tx queues.
312
313 * **Updated test-crypto-perf application with new cases.**
314
315   * Added support for asymmetric crypto throughput performance measurement.
316     Only modex is supported for now.
317   * Added support for lookaside IPsec protocol offload throughput measurement.
318
319 * **Added lookaside protocol (IPsec) tests in dpdk-test.**
320
321   * Added known vector tests (AES-GCM 128, 192, 256).
322   * Added tests to verify error reporting with ICV corruption.
323   * Added tests to verify IV generation.
324   * Added tests to verify UDP encapsulation.
325   * Added tests to verify UDP encapsulation ports.
326   * Added tests to validate packets soft expiry.
327   * Added tests to validate packets hard expiry.
328   * Added tests to verify tunnel header verification in IPsec inbound.
329   * Added tests to verify inner checksum.
330   * Added tests for CHACHA20_POLY1305 PMD, including a new testcase for SGL OOP.
331
332 * **Revised packet capture framework.**
333
334   * New dpdk-dumpcap program that has most of the features
335     of the wireshark dumpcap utility including:
336     capture of multiple interfaces, filtering,
337     and stopping after number of bytes, packets.
338   * New library for writing pcapng packet capture files.
339   * Enhancements to the pdump library to support:
340     * Packet filter with BPF.
341     * Pcapng format with timestamps and meta-data.
342     * Fixes packet capture with stripped VLAN tags.
343
344 * **Added ASan support.**
345
346   `AddressSanitizer
347   <https://github.com/google/sanitizers/wiki/AddressSanitizer>`_ (ASan)
348   is a widely-used debugging tool to detect memory access errors.
349   It helps to detect issues like use-after-free, various kinds of buffer
350   overruns in C/C++ programs, and other similar errors, as well as
351   printing out detailed debug information whenever an error is detected.
352
353
354 Removed Items
355 -------------
356
357 .. This section should contain removed items in this release. Sample format:
358
359    * Add a short 1-2 sentence description of the removed item
360      in the past tense.
361
362    This section is a comment. Do not overwrite or remove it.
363    Also, make sure to start the actual text at the margin.
364    =======================================================
365
366 * eal: Removed the deprecated function ``rte_get_master_lcore()``
367   and the iterator macro ``RTE_LCORE_FOREACH_SLAVE``.
368
369 * eal: The old api arguments that were deprecated for
370   blacklist/whitelist are removed. Users must use the new
371   block/allow list arguments.
372
373 * mbuf: Removed offload flag ``PKT_RX_EIP_CKSUM_BAD``.
374   ``PKT_RX_OUTER_IP_CKSUM_BAD`` should be used as a replacement.
375
376 * ethdev: Removed the port mirroring API. A more fine-grain flow API
377   action ``RTE_FLOW_ACTION_TYPE_SAMPLE`` should be used instead.
378   The structures ``rte_eth_mirror_conf`` and ``rte_eth_vlan_mirror`` and
379   the functions ``rte_eth_mirror_rule_set`` and
380   ``rte_eth_mirror_rule_reset`` along with the associated macros
381   ``ETH_MIRROR_*`` are removed.
382
383 * ethdev: Removed ``rte_eth_rx_descriptor_done`` API function and its
384   driver callback. It is replaced by the more complete function
385   ``rte_eth_rx_descriptor_status``.
386
387 * ethdev: Removed deprecated ``shared`` attribute of the
388   ``struct rte_flow_action_count``. Shared counters should be managed
389   using indirect actions API (``rte_flow_action_handle_create`` etc).
390
391 * i40e: Removed i40evf driver.
392   iavf already became the default VF driver for i40e devices,
393   so there is no need to maintain i40evf.
394
395
396 API Changes
397 -----------
398
399 .. This section should contain API changes. Sample format:
400
401    * sample: Add a short 1-2 sentence description of the API change
402      which was announced in the previous releases and made in this release.
403      Start with a scope label like "ethdev:".
404      Use fixed width quotes for ``function_names`` or ``struct_names``.
405      Use the past tense.
406
407    This section is a comment. Do not overwrite or remove it.
408    Also, make sure to start the actual text at the margin.
409    =======================================================
410
411 * eal: The lcore state ``FINISHED`` is removed from
412   the ``enum rte_lcore_state_t``.
413   The lcore state ``WAIT`` is enough to represent the same state.
414
415 * kvargs: The experimental function ``rte_kvargs_strcmp()`` has been
416   removed. Its usages have been replaced by a new function
417   ``rte_kvargs_get_with_value()``.
418
419 * cmdline: ``cmdline_stdin_exit()`` now frees the ``cmdline`` structure.
420   Calls to ``cmdline_free()`` after it need to be deleted from applications.
421
422 * cmdline: Made ``cmdline`` structure definition hidden on Linux and FreeBSD.
423
424 * cmdline: Made ``rdline`` structure definition hidden. Functions are added
425   to dynamically allocate and free it, and to access user data in callbacks.
426
427 * mempool: Added ``RTE_MEMPOOL_F_NON_IO`` flag to give a hint to DPDK components
428   that objects from this pool will not be used for device IO (e.g. DMA).
429
430 * mempool: The mempool flags ``MEMPOOL_F_*`` will be deprecated in the future.
431   Newly added flags with ``RTE_MEMPOOL_F_`` prefix should be used instead.
432
433 * mempool: Helper macro ``MEMPOOL_HEADER_SIZE()`` is deprecated.
434   The replacement macro ``RTE_MEMPOOL_HEADER_SIZE()`` is internal only.
435
436 * mempool: Macro to register mempool driver ``MEMPOOL_REGISTER_OPS()`` is
437   deprecated.  Use replacement ``RTE_MEMPOOL_REGISTER_OPS()``.
438
439 * mempool: The mempool API macros ``MEMPOOL_PG_*`` are deprecated and
440   will be removed in DPDK 22.11.
441
442 * mbuf: The mbuf offload flags ``PKT_*`` are renamed as ``RTE_MBUF_F_*``. A
443   compatibility layer will be kept until DPDK 22.11.
444 * net: Renamed ``s_addr`` and ``d_addr`` fields of ``rte_ether_hdr`` structure
445   to ``src_addr`` and ``dst_addr``, respectively.
446
447 * net: Added ``version`` and ``ihl`` bit-fields to ``struct rte_ipv4_hdr``.
448   Existing ``version_ihl`` field is kept for backward compatibility.
449
450 * ethdev: Added items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` to
451   flow API.
452
453 * ethdev: Deprecated items and actions ``PF``, ``VF``, ``PHY_PORT``, ``PORT_ID``.
454   Suggested items and actions ``PORT_REPRESENTOR``, ``REPRESENTED_PORT`` instead.
455
456 * ethdev: Deprecated the use of attributes ``ingress`` / ``egress`` combined
457   with ``transfer``. See items ``PORT_REPRESENTOR``, ``REPRESENTED_PORT``.
458
459 * ethdev: ``rte_flow_action_modify_data`` structure updated, immediate data
460   array is extended, data pointer field is explicitly added to union, the
461   action behavior is defined in more strict fashion and documentation updated.
462   The immediate value behavior has been changed, the entire immediate field
463   should be provided, and offset for immediate source bitfield is assigned
464   from destination one.
465
466 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
467   rte_cryptodev_is_valid_dev as it can be used by the application as
468   well as PMD to check whether the device is valid or not.
469
470 * cryptodev: The rte_cryptodev_pmd.* files are renamed as cryptodev_pmd.*
471   as it is for drivers only and should be private to DPDK, and not
472   installed for app use.
473
474 * cryptodev: A ``reserved`` byte from structure ``rte_crypto_op`` was
475   renamed to ``aux_flags`` to indicate warnings and other information from
476   the crypto/security operation. This field will be used to communicate
477   events such as soft expiry with IPsec in lookaside mode.
478
479 * cryptodev: The field ``dataunit_len`` of the ``struct rte_crypto_cipher_xform``
480   moved to the end of the structure and extended to ``uint32_t``.
481
482 * cryptodev: The structure ``rte_crypto_vec`` was updated to add ``tot_len``
483   field to support total buffer length to facilitate protocol offload case.
484
485 * cryptodev: The structure ``rte_crypto_sym_vec`` was updated to add
486   ``dest_sgl`` to support out of place processing.
487
488 * bbdev: Added device info related to data byte endianness processing.
489
490 * eventdev: Moved memory used by timer adapters to hugepage. This will prevent
491   TLB misses if any and aligns to memory structure of other subsystems.
492
493 * fib: Added the ``rib_ext_sz`` field to ``rte_fib_conf`` and ``rte_fib6_conf``
494   so that user can specify the size of the RIB extension inside the FIB.
495
496
497 ABI Changes
498 -----------
499
500 .. This section should contain ABI changes. Sample format:
501
502    * sample: Add a short 1-2 sentence description of the ABI change
503      which was announced in the previous releases and made in this release.
504      Start with a scope label like "ethdev:".
505      Use fixed width quotes for ``function_names`` or ``struct_names``.
506      Use the past tense.
507
508    This section is a comment. Do not overwrite or remove it.
509    Also, make sure to start the actual text at the margin.
510    =======================================================
511
512 * ethdev: All enums & macros updated to have ``RTE_ETH`` prefix and structures
513   updated to have ``rte_eth`` prefix. DPDK components updated to use new names.
514
515 * ethdev: Input parameters for ``eth_rx_queue_count_t`` was changed.
516   Instead of pointer to ``rte_eth_dev`` and queue index, now it accepts pointer
517   to internal queue data as input parameter. While this change is transparent
518   to user, it still counts as an ABI change, as ``eth_rx_queue_count_t``
519   is used by  public inline function ``rte_eth_rx_queue_count``.
520
521 * ethdev: Made ``rte_eth_dev``, ``rte_eth_dev_data``, ``rte_eth_rxtx_callback``
522   private data structures. ``rte_eth_devices[]`` can't be accessed directly
523   by user any more. While it is an ABI breakage, this change is intended
524   to be transparent for both users (no changes in user app is required) and
525   PMD developers (no changes in PMD is required).
526
527 * cryptodev: Made ``rte_cryptodev``, ``rte_cryptodev_data`` private
528   structures internal to DPDK. ``rte_cryptodevs`` can't be accessed directly
529   by user any more. While it is an ABI breakage, this change is intended
530   to be transparent for both users (no changes in user app is required) and
531   PMD developers (no changes in PMD is required).
532
533 * security: ``rte_security_set_pkt_metadata`` and ``rte_security_get_userdata``
534   routines used by inline outbound and inline inbound security processing were
535   made inline and enhanced to do simple 64-bit set/get for PMDs that do not
536   have much processing in PMD specific callbacks but just 64-bit set/get.
537   This avoids a per packet function pointer jump overhead for such PMDs.
538
539 * security: A new option ``iv_gen_disable`` was added in structure
540   ``rte_security_ipsec_sa_options`` to disable IV generation inside PMD,
541   so that application can provide its own IV and test known test vectors.
542
543 * security: A new option ``tunnel_hdr_verify`` was added in structure
544   ``rte_security_ipsec_sa_options`` to indicate whether outer header
545   verification need to be done as part of inbound IPsec processing.
546
547 * security: A new option ``udp_ports_verify`` was added in structure
548   ``rte_security_ipsec_sa_options`` to indicate whether UDP ports
549   verification need to be done as part of inbound IPsec processing.
550
551 * security: A new structure ``rte_security_ipsec_lifetime`` was added to
552   replace ``esn_soft_limit`` in IPsec configuration structure
553   ``rte_security_ipsec_xform`` to allow applications to configure SA soft
554   and hard expiry limits. Limits can be either in number of packets or bytes.
555
556 * security: The new options ``ip_csum_enable`` and ``l4_csum_enable`` were added
557   in structure ``rte_security_ipsec_sa_options`` to indicate whether inner
558   packet IPv4 header checksum and L4 checksum need to be offloaded to
559   security device.
560
561 * security: A new structure ``esn`` was added in structure
562   ``rte_security_ipsec_xform`` to set an initial ESN value. This permits
563   application to start from an arbitrary ESN value for debug and SA lifetime
564   enforcement purposes.
565
566 * security: A new structure ``udp`` was added in structure
567   ``rte_security_ipsec_xform`` to allow setting the source and destination ports
568   for UDP encapsulated IPsec traffic.
569
570 * bbdev: Added capability related to more comprehensive CRC options,
571   shifting values of the ``enum rte_bbdev_op_ldpcdec_flag_bitmasks``.
572
573 * eventdev: New variables ``rx_event_buf_count`` and ``rx_event_buf_size``
574   were added in structure ``rte_event_eth_rx_adapter_stats`` to get additional
575   status.
576
577 * eventdev: A new structure ``rte_event_fp_ops`` has been added which is now used
578   by the fastpath inline functions. The structures ``rte_eventdev``,
579   ``rte_eventdev_data`` have been made internal. ``rte_eventdevs[]`` can't be
580   accessed directly by user any more. This change is transparent to both
581   applications and PMDs.
582
583 * eventdev: Re-arranged fields in ``rte_event_timer`` to remove holes.
584
585
586 Known Issues
587 ------------
588
589 .. This section should contain new known issues in this release. Sample format:
590
591    * **Add title in present tense with full stop.**
592
593      Add a short 1-2 sentence description of the known issue
594      in the present tense. Add information on any known workarounds.
595
596    This section is a comment. Do not overwrite or remove it.
597    Also, make sure to start the actual text at the margin.
598    =======================================================
599
600
601 Tested Platforms
602 ----------------
603
604 .. This section should contain a list of platforms that were tested
605    with this release.
606
607    The format is:
608
609    * <vendor> platform with <vendor> <type of devices> combinations
610
611      * List of CPU
612      * List of OS
613      * List of devices
614      * Other relevant details...
615
616    This section is a comment. Do not overwrite or remove it.
617    Also, make sure to start the actual text at the margin.
618    =======================================================