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