]> xenbits.xensource.com Git - people/aperard/xen-unstable.git/commitdiff
docs: allow generic virtio device types to contain device-id
authorViresh Kumar <viresh.kumar@linaro.org>
Wed, 3 May 2023 11:35:40 +0000 (13:35 +0200)
committerJan Beulich <jbeulich@suse.com>
Wed, 3 May 2023 11:35:40 +0000 (13:35 +0200)
For generic virtio devices, where we don't need to add compatible or
other special DT properties, the type field is set to "virtio,device".

But this misses the case where the user sets the type with a valid
virtio device id as well, like "virtio,device1a" for file system device.
The complete list of virtio device ids is mentioned here:

https://docs.oasis-open.org/virtio/virtio/v1.2/cs01/virtio-v1.2-cs01.html#x1-2160005

Update documentation to support that as well.

Fixes: dd54ea500be8 ("docs: add documentation for generic virtio devices")
Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org>
Reviewed-by: Oleksandr Tyshchenko <oleksandr_tyshchenko@epam.com>
docs/man/xl.cfg.5.pod.in

index 10f37990be57b7d41db0f47bc118b8ff2251957f..24ac92718288a6e67e5ca9d11fd9f479e6621e1e 100644 (file)
@@ -1608,8 +1608,11 @@ present here:
 
 L<https://www.kernel.org/doc/Documentation/devicetree/bindings/i2c/i2c-virtio.yaml>
 
-For generic virtio devices, where we don't need to set special or compatible
-properties in the Device Tree, the type field must be set to "virtio,device".
+For other generic virtio devices, where we don't need to set special or
+compatible properties in the Device Tree, the type field must be set to
+"virtio,device" or "virtio,device<N>", where "N" is the virtio device id in
+hexadecimal format, without the "0x" prefix and all in lower case, like
+"virtio,device1a" for the file system device.
 
 =item B<transport=STRING>