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