| Message ID | c5d2ab978255ca84197c980cbfb9a504e7c625f8.1680653504.git.viresh.kumar@linaro.org (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [V2,1/2] docs: Allow generic virtio device types to contain device-id | expand |
On 05.04.23 03:12, Viresh Kumar wrote: Hello Viresh > 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,device26" for file system device. ok. For the record, a valid virtio device ids can be found at: https://docs.oasis-open.org/virtio/virtio/v1.2/cs01/virtio-v1.2-cs01.html#x1-2160005 I don't know, maybe it is worth adding that link to commit description. Also a NIT, is this example "like "virtio,device26" for file system device" precise? According to https://www.kernel.org/doc/Documentation/devicetree/bindings/virtio/virtio-device.yaml the virtio device id should be in hex, so for file system device it should be "virtio,device1a", or I really missed something? With updating description if NIT is correct (I don't know, maybe this could be done on commit): Reviewed-by: Oleksandr Tyshchenko <oleksandr_tyshchenko@epam.com> > > 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> > --- > V1->V2: New patch. > > docs/man/xl.cfg.5.pod.in | 5 +++-- > 1 file changed, 3 insertions(+), 2 deletions(-) > > diff --git a/docs/man/xl.cfg.5.pod.in b/docs/man/xl.cfg.5.pod.in > index 10f37990be57..ea20eac0ba32 100644 > --- a/docs/man/xl.cfg.5.pod.in > +++ b/docs/man/xl.cfg.5.pod.in > @@ -1608,8 +1608,9 @@ 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. > > =item B<transport=STRING> >
On 05-04-23, 11:36, Oleksandr Tyshchenko wrote: > Also a NIT, is this example "like "virtio,device26" for file system device" > precise? No :( I will send the patch again later, this is how it looks now. I have also updated the documentation to contain the hexadecimal format for N. Author: Viresh Kumar <viresh.kumar@linaro.org> Date: Wed Apr 5 05:36:19 2023 +0530 docs: Allow generic virtio device types to contain device-id 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 | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/man/xl.cfg.5.pod.in b/docs/man/xl.cfg.5.pod.in index 10f37990be57..938aea22c798 100644 --- a/docs/man/xl.cfg.5.pod.in +++ b/docs/man/xl.cfg.5.pod.in @@ -1608,8 +1608,10 @@ 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. =item B<transport=STRING>
On 05.04.2023 10:51, Viresh Kumar wrote: > --- a/docs/man/xl.cfg.5.pod.in > +++ b/docs/man/xl.cfg.5.pod.in > @@ -1608,8 +1608,10 @@ 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. Are "virtio,device0x1a" or "virtio,device1A" valid, too? If so, all is fine, but if not, constraints on the hex representation may want mentioning. Jan
On 05-04-23, 11:15, Jan Beulich wrote: > On 05.04.2023 10:51, Viresh Kumar wrote: > > --- a/docs/man/xl.cfg.5.pod.in > > +++ b/docs/man/xl.cfg.5.pod.in > > @@ -1608,8 +1608,10 @@ 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. > > Are "virtio,device0x1a" or "virtio,device1A" valid, too? If so, all is fine, > but if not, constraints on the hex representation may want mentioning. From [1], both above are invalid. Updated doc as: 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.
diff --git a/docs/man/xl.cfg.5.pod.in b/docs/man/xl.cfg.5.pod.in index 10f37990be57..ea20eac0ba32 100644 --- a/docs/man/xl.cfg.5.pod.in +++ b/docs/man/xl.cfg.5.pod.in @@ -1608,8 +1608,9 @@ 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. =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,device26" for file system device. 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> --- V1->V2: New patch. docs/man/xl.cfg.5.pod.in | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)