| Message ID | 18458fa39433ce4ac950a0a20cc64da93db0b03a.1680771422.git.viresh.kumar@linaro.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [V3,1/2] docs: Allow generic virtio device types to contain device-id | expand |
On Thu, Apr 06, 2023 at 02:28:17PM +0530, Viresh Kumar wrote: > 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> Acked-by: Anthony PERARD <anthony.perard@citrix.com> Thanks,
diff --git a/docs/man/xl.cfg.5.pod.in b/docs/man/xl.cfg.5.pod.in index 10f37990be57..24ac92718288 100644 --- a/docs/man/xl.cfg.5.pod.in +++ b/docs/man/xl.cfg.5.pod.in @@ -1608,8 +1608,11 @@ example, "type=virtio,device22" for the I2C device, whose device-tree binding is 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>
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> --- V2->V3: - Updated commit log and clarified / fixed doc. - Tag from Oleksandr. docs/man/xl.cfg.5.pod.in | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)