virtio: Add virtio-device bindings
Subsystems (4)
v3 cover virtio: Add virtio-device bindings
Hi,
Currently the DT only provides support for following node types for virtio-mmio nodes:
virtio_mmio@a000000 {
dma-coherent;
interrupts = <0x00 0x10 0x01>;
reg = <0x00 0xa000000 0x00 0x200>;
compatible = "virtio,mmio";
};Here, each virtio-mmio corresponds to a virtio-device. But there is no way for other users in the DT to show their dependency on virtio devices.
This patchset provides that support.
The first patch adds virtio-device bindings to allow for device sub-nodes to be present and the second patch updates the virtio core to update the of_node.
Other patches add bindings for i2c and gpio devices.
Tested on x86 with qemu for arm64.
Pending:
- Arnd suggested that "virtio,deviceXX" may be a better compatible string, while I used "virtio,XX" to match what PCI and USB do currently. I didn't change it yet to hear Rob's view on the same before making the change, in case he has any preferences.
V2/2.1->V3:
- Added review-tags from Arnd and Wolfram.
- Only the 5th patch changed otherwise:
- Use of_device_is_compatible() instead of keeping a list of devices.
- Use snprintf (with BUG_ON on return value) to create the compatible string, whose length is fixed using "virtio,XXXXXXXX".
- Use dev_of_node().
V1->V2:
- The changes (both binding and code) are made at virtio level, instead of virtio-mmio. This allows the same to be used by all device types, irrespective of the transport mechanism.
- Dropped the reg property and used compatible in the form "virtio,<DID>".
- Dropped dt-bindings/virtio/virtio_ids.h.
- Add a patch to sync virtio-ids from spec, required for the last patch.
--
Viresh
Viresh Kumar (5):
dt-bindings: virtio: Add binding for virtio devices
dt-bindings: i2c: Add bindings for i2c-virtio
dt-bindings: gpio: Add bindings for gpio-virtio
uapi: virtio_ids: Sync ids with specification
virtio: Bind virtio device to device-tree node
.../devicetree/bindings/gpio/gpio-virtio.yaml | 60 +++++++++++++++++++ .../devicetree/bindings/i2c/i2c-virtio.yaml | 51 ++++++++++++++++ .../devicetree/bindings/virtio/mmio.yaml | 2 +- .../bindings/virtio/virtio-device.yaml | 47 +++++++++++++++ drivers/virtio/virtio.c | 57 +++++++++++++++++- include/uapi/linux/virtio_ids.h | 12 ++++ 6 files changed, 225 insertions(+), 4 deletions(-) create mode 100644 Documentation/devicetree/bindings/gpio/gpio-virtio.yaml create mode 100644 Documentation/devicetree/bindings/i2c/i2c-virtio.yaml create mode 100644 Documentation/devicetree/bindings/virtio/virtio-device.yaml
Signature · 1 line
2.31.1.272.g89b43f80a514
PATCH v3 1/5 dt-bindings: virtio: Add binding for virtio devices
Allow virtio device sub-nodes to be added to the virtio mmio or pci nodes. The compatible property for virtio device must be of format "virtio,<DID>", where DID is virtio device ID in hexadecimal format.
--- .../devicetree/bindings/virtio/mmio.yaml | 2 +- .../bindings/virtio/virtio-device.yaml | 47 +++++++++++++++++++ 2 files changed, 48 insertions(+), 1 deletion(-) create mode 100644 Documentation/devicetree/bindings/virtio/virtio-device.yaml
Documentation/devicetree/bindings/virtio/mmio.yaml +1 -1
@@ -36,7 +36,7 @@ title: virtio memory mapped devices - reg - interrupts -additionalProperties: false +additionalProperties: true examples: - |
Documentation/devicetree/bindings/virtio/virtio-device.yaml new file +47 -0
47 lines not on this page · raw message
Signature · 1 line
2.31.1.272.g89b43f80a514
PATCH v3 2/5 dt-bindings: i2c: Add bindings for i2c-virtio
In reply to Viresh KumarThis patch adds binding for virtio I2C device, it is based on virtio-device bindings.
--- .../devicetree/bindings/i2c/i2c-virtio.yaml | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 Documentation/devicetree/bindings/i2c/i2c-virtio.yaml
Documentation/devicetree/bindings/i2c/i2c-virtio.yaml new file +51 -0
@@ -0,0 +1,51 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/i2c/i2c-virtio.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Virtio I2C Adapter + +maintainers: + - Viresh Kumar <[email protected]> + +allOf: + - $ref: /schemas/i2c/i2c-controller.yaml# + - $ref: /schemas/virtio/virtio-device.yaml# + +description: + Virtio I2C device, see /schemas/virtio/virtio-device.yaml for more details. + +properties: + $nodename: + pattern: '^i2c-virtio(-[a-z0-9]+)?$' + + compatible: + const: virtio,22 + +required: + - compatible + +unevaluatedProperties: false + +examples: + - | + virtio@3000 { + compatible = "virtio,mmio"; + reg = <0x3000 0x100>; + interrupts = <41>; + + i2c-virtio { + compatible = "virtio,22"; + + #address-cells = <1>; + #size-cells = <0>; + + light-sensor@1c { + compatible = "dynaimage,al3320a"; + reg = <0x20>; + }; + }; + }; + +...
Signature · 1 line
2.31.1.272.g89b43f80a514
PATCH v3 3/5 dt-bindings: gpio: Add bindings for gpio-virtio
In reply to Viresh KumarThis patch adds binding for virtio GPIO controller, it is based on virtio-device bindings.
--- .../devicetree/bindings/gpio/gpio-virtio.yaml | 60 +++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 Documentation/devicetree/bindings/gpio/gpio-virtio.yaml
Documentation/devicetree/bindings/gpio/gpio-virtio.yaml new file +60 -0
@@ -0,0 +1,60 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/gpio/gpio-virtio.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Virtio GPIO controller + +maintainers: + - Viresh Kumar <[email protected]> + +allOf: + - $ref: /schemas/gpio/gpio.yaml# + - $ref: /schemas/virtio/virtio-device.yaml# + +description: + Virtio GPIO controller, see /schemas/virtio/virtio-device.yaml for more + details. + +properties: + $nodename: + pattern: '^gpio-virtio(-[a-z0-9]+)?$' + + compatible: + const: virtio,29 + + gpio-controller: true + + "#gpio-cells": + const: 2 + + interrupt-controller: true + + "#interrupt-cells": + const: 2 + +required: + - compatible + - gpio-controller + - "#gpio-cells" + +unevaluatedProperties: false + +examples: + - | + virtio@3000 { + compatible = "virtio,mmio"; + reg = <0x3000 0x100>; + interrupts = <41>; + + gpio: gpio-virtio { + compatible = "virtio,29"; + gpio-controller; + #gpio-cells = <2>; + interrupt-controller; + #interrupt-cells = <2>; + }; + }; + +...
Signature · 1 line
2.31.1.272.g89b43f80a514
PATCH v3 4/5 uapi: virtio_ids: Sync ids with specification
In reply to Viresh KumarThis synchronizes the virtio ids with the latest list from virtio specification.
--- include/uapi/linux/virtio_ids.h | 12 ++++++++++++ 1 file changed, 12 insertions(+)
include/uapi/linux/virtio_ids.h +12 -0
@@ -54,8 +54,20 @@#define VIRTIO_ID_SOUND 25/* virtio sound */ #define VIRTIO_ID_FS 26/* virtio filesystem */ #define VIRTIO_ID_PMEM 27/* virtio pmem */ +#define VIRTIO_ID_RPMB 28/* virtio rpmb */ #define VIRTIO_ID_MAC80211_HWSIM 29/* virtio mac80211-hwsim */ +#define VIRTIO_ID_VIDEO_ENCODER 30/* virtio video encoder */ +#define VIRTIO_ID_VIDEO_DECODER 31/* virtio video decoder */ +#define VIRTIO_ID_SCMI 32/* virtio scmi */ +#define VIRTIO_ID_NITRO_SEC_MOD 33/* virtio nitro secure module*/ +#define VIRTIO_ID_I2C_ADAPTER 34/* virtio i2c adapter */ +#define VIRTIO_ID_WATCHDOG 35/* virtio watchdog */ +#define VIRTIO_ID_CAN 36/* virtio can */ +#define VIRTIO_ID_DMABUF 37/* virtio dmabuf */ +#define VIRTIO_ID_PARAM_SERV 38/* virtio parameter server */ +#define VIRTIO_ID_AUDIO_POLICY 39/* virtio audio policy */ #define VIRTIO_ID_BT 40/* virtio bluetooth */ +#define VIRTIO_ID_GPIO 41/* virtio gpio */ /* * Virtio Transitional IDs
Signature · 6 lines
2.31.1.272.g89b43f80a514 _______________________________________________ Virtualization mailing list [email protected] https://lists.linuxfoundation.org/mailman/listinfo/virtualization
PATCH v3 5/5 virtio: Bind virtio device to device-tree node
In reply to Viresh KumarBind the virtio devices with their of_node. This will help users of the virtio devices to mention their dependencies on the device in the DT itself. Like GPIO pin users can use the phandle of the device node, or the node may contain more subnodes to add i2c or spi eeproms and other users.
--- drivers/virtio/virtio.c | 57 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 54 insertions(+), 3 deletions(-)
drivers/virtio/virtio.c +54 -3
@@ -4,6 +4,7 @@#include <linux/virtio_config.h> #include <linux/module.h> #include <linux/idr.h> +#include <linux/of.h> #include <uapi/linux/virtio_ids.h> /* Unique numbering for virtio devices. */
@@ -292,6 +293,9 @@ static int virtio_dev_remove(struct device *_d)/* Acknowledge the device's existence again. */ virtio_add_status (dev,VIRTIO_CONFIG_S_ACKNOWLEDGE ); + +of_node_put (dev->dev.of_node); +return 0 ; }
@@ -319,6 +323,43 @@ void unregister_virtio_driver(struct virtio_driver *driver) }EXPORT_SYMBOL_GPL (unregister_virtio_driver); +static int virtio_device_of_init (struct virtio_device *dev) +{ +struct device_node *np, *pnode =dev_of_node (dev->dev.parent); +char compat[] ="virtio,XXXXXXXX" ;/* Reserve enough space 32-bit id */ +int ret, count; + +if (!pnode) +return 0 ; + + count =of_get_available_child_count (pnode); +if (!count) +return 0 ; + +/* There can be only 1 child node */ +if (WARN_ON (count >1 )) +return -EINVAL ; + + np =of_get_next_available_child (pnode,NULL ); +if (WARN_ON (!np)) +return -ENODEV ; + +BUG_ON (snprintf (compat,sizeof (compat),"virtio,%x" , dev->id.device) >= +sizeof (compat)); + +if (!of_device_is_compatible (np, compat)) { + ret = -EINVAL ; + goto out; + } + + dev->dev.of_node = np; +return 0 ; + +out: +of_node_put (np); +return ret; +} +/** * register_virtio_device - register virtio device * @dev : virtio device to be registered
@@ -343,6 +384,10 @@ int register_virtio_device(struct virtio_device *dev) dev->index = err;dev_set_name (&dev->dev,"virtio%u" , dev->index); + err =virtio_device_of_init (dev); +if (err) + goto out_ida_remove; +spin_lock_init (&dev->config_lock); dev->config_enabled = false; dev->config_change_pending = false;
@@ -362,10 +407,16 @@ int register_virtio_device(struct virtio_device *dev)*/ err =device_add (&dev->dev);if (err) -ida_simple_remove (&virtio_index_ida, dev->index); + goto out_of_node_put; + +return 0 ; + +out_of_node_put: +of_node_put (dev->dev.of_node); +out_ida_remove: +ida_simple_remove (&virtio_index_ida, dev->index); out: -if (err) -virtio_add_status (dev,VIRTIO_CONFIG_S_FAILED ); +virtio_add_status (dev,VIRTIO_CONFIG_S_FAILED );return err; }EXPORT_SYMBOL_GPL (register_virtio_device);
Signature · 1 line
2.31.1.272.g89b43f80a514
Re: [PATCH V3 2/5] dt-bindings: i2c: Add bindings for i2c-virtio
In reply to Viresh KumarQuoted 6 lines · Viresh Kumar
This patch adds binding for virtio I2C device, it is based on virtio-device bindings.
Acked-by Wolfram Sang <[email protected]>Signed-off-by Viresh Kumar <[email protected]>
Re: [PATCH V3 2/5] dt-bindings: i2c: Add bindings for i2c-virtio
Quoted 10 lines · Arnd Bergmann
Quoted 6 lines · Viresh Kumar
This patch adds binding for virtio I2C device, it is based on virtio-device bindings.
Acked-by Wolfram Sang <[email protected]>Signed-off-by Viresh Kumar <[email protected]>Reviewed-by Arnd Bergmann <[email protected]>
Too quick, after seeing the same issue in the gpio binding I saw it here too:
Documentation/devicetree/bindings/i2c/i2c-virtio.yaml line 39
Quoted 2 lines
Documentation/devicetree/bindings/i2c/i2c-virtio.yaml new file +2
-0+ i2c-virtio { + compatible = "virtio,22";
The node name "i2c-virtio" looks wrong. According to
https://github.com/devicetree-org/dt-schema/blob/master/schemas/i2c/i2c-controller.yaml,
this needs to be plain "i2c".
Arnd
Re: [PATCH V3 3/5] dt-bindings: gpio: Add bindings for gpio-virtio
In reply to Viresh KumarQuoted 5 lines · Viresh Kumar
This patch adds binding for virtio GPIO controller, it is based on virtio-device bindings.
Signed-off-by Viresh Kumar <[email protected]>
Documentation/devicetree/bindings/gpio/gpio-virtio.yaml line 52
Quoted 7 lines
Documentation/devicetree/bindings/gpio/gpio-virtio.yaml new file +7
-0+ +properties: + $nodename: + pattern: '^gpio-virtio(-[a-z0-9]+)?$' + + gpio: gpio-virtio { + compatible = "virtio,29";
The node name here does not appear to be mandated by the schema, but most others name it "gpio", so I would do the same here instead of "gpio-virtio".
Arnd
Re: [PATCH V3 2/5] dt-bindings: i2c: Add bindings for i2c-virtio
In reply to Arnd BergmannQuoted 12 lines · Arnd Bergmann
Quoted 10 lines · Arnd Bergmann
Quoted 6 lines · Viresh Kumar
This patch adds binding for virtio I2C device, it is based on virtio-device bindings.
Acked-by Wolfram Sang <[email protected]>Signed-off-by Viresh Kumar <[email protected]>Reviewed-by Arnd Bergmann <[email protected]>
Quoted 8 lines
Too quick, after seeing the same issue in the gpio binding I saw it here too:
Documentation/devicetree/bindings/i2c/i2c-virtio.yaml line 39
Quoted 2 lines
Documentation/devicetree/bindings/i2c/i2c-virtio.yaml new file +2
-0+ i2c-virtio { + compatible = "virtio,22";The node name "i2c-virtio" looks wrong. According to
https://github.com/devicetree-org/dt-schema/blob/master/schemas/i2c/i2c-controller.yaml,
this needs to be plain "i2c".
Okay, I will move back to simple node names then.
Thanks.
Signature · 1 line
viresh
Re: [PATCH V3 1/5] dt-bindings: virtio: Add binding for virtio devices
In reply to Viresh KumarQuoted 17 lines · Viresh Kumar
Allow virtio device sub-nodes to be added to the virtio mmio or pci nodes. The compatible property for virtio device must be of format "virtio,<DID>", where DID is virtio device ID in hexadecimal format.
Signed-off-by Viresh Kumar <[email protected]>--- .../devicetree/bindings/virtio/mmio.yaml | 2 +- .../bindings/virtio/virtio-device.yaml | 47 +++++++++++++++++++ 2 files changed, 48 insertions(+), 1 deletion(-) create mode 100644 Documentation/devicetree/bindings/virtio/virtio-device.yamlDocumentation/devicetree/bindings/virtio/mmio.yaml +0
-0
Documentation/devicetree/bindings/virtio/mmio.yaml title: virtio memory mapped devices · line 39
Quoted 5 lines
Documentation/devicetree/bindings/virtio/mmio.yaml +1
-1@@ -36,7 +36,7 @@ title: virtio memory mapped devices - reg - interrupts -additionalProperties: false +additionalProperties: true
That just allows for any random property. What you want is child nodes only:
addtionalProperties:
type: object
Or you could reference virtio-device.yaml here.
Quoted 18 lines
Documentation/devicetree/bindings/virtio/mmio.yaml +0
-0examples: - |Documentation/devicetree/bindings/virtio/virtio-device.yaml new file +9
-0@@ -0,0 +1,47 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/virtio/virtio-device.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Virtio device bindings + +maintainers:
Documentation/devicetree/bindings/virtio/virtio-device.yaml line 19
Quoted 10 lines
Documentation/devicetree/bindings/virtio/virtio-device.yaml new file +10
-0+ - Viresh Kumar <[email protected]> + +description: + These bindings are applicable to virtio devices irrespective of the bus they + are bound to, like mmio or pci. + +# We need a select here so we don't match all nodes with 'virtio,mmio' +properties: + $nodename: + pattern: '^[a-z0-9]+-virtio(-[a-z0-9]+)?$'
Node names aren't based on the bus they are on, but their class. You'll need to drop this.
Documentation/devicetree/bindings/virtio/virtio-device.yaml line 25
Quoted 6 lines
Documentation/devicetree/bindings/virtio/virtio-device.yaml new file +6
-0+ description: | + Exactly one node describing the virtio device. The name of the node isn't + significant but its phandle can be used to by a user of the virtio device. + + compatible: + pattern: "^virtio,[0-9a-f]+$"
DID is only 4 chars? If so, "^virtio,[0-9a-f]{1,4}$"
Quoted 25 lines
Documentation/devicetree/bindings/virtio/virtio-device.yaml new file +22
-1+ description: Virtio device nodes. + "virtio,DID", where DID is the virtio device id. The textual + representation of DID shall be in lower case hexadecimal with leading + zeroes suppressed. + +required: + - compatible + +additionalProperties: true + +examples: + - | + virtio@3000 { + compatible = "virtio,mmio"; + reg = <0x3000 0x100>; + interrupts = <43>; + + i2c-virtio { + compatible = "virtio,22"; + }; + }; +... --2.31.1.272.g89b43f80a514
Re: [PATCH V3 2/5] dt-bindings: i2c: Add bindings for i2c-virtio
In reply to Viresh KumarQuoted 28 lines · Viresh Kumar
This patch adds binding for virtio I2C device, it is based on virtio-device bindings.
Acked-by Wolfram Sang <[email protected]>Signed-off-by Viresh Kumar <[email protected]>--- .../devicetree/bindings/i2c/i2c-virtio.yaml | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 Documentation/devicetree/bindings/i2c/i2c-virtio.yamlDocumentation/devicetree/bindings/i2c/i2c-virtio.yaml new file +11
-0@@ -0,0 +1,51 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/i2c/i2c-virtio.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Virtio I2C Adapter + +maintainers: + - Viresh Kumar <[email protected]> +
Documentation/devicetree/bindings/i2c/i2c-virtio.yaml line 21
Quoted 10 lines
Documentation/devicetree/bindings/i2c/i2c-virtio.yaml new file +10
-0+allOf: + - $ref: /schemas/i2c/i2c-controller.yaml# + - $ref: /schemas/virtio/virtio-device.yaml# + +description: + Virtio I2C device, see /schemas/virtio/virtio-device.yaml for more details. + +properties: + $nodename: + pattern: '^i2c-virtio(-[a-z0-9]+)?$'
i2c-controller.yaml already defines the node name. In this case though, it can be restricted a bit more to be just 'i2c' as there's only a single instance.
Quoted 33 lines
Documentation/devicetree/bindings/i2c/i2c-virtio.yaml new file +30
-1+ + compatible: + const: virtio,22 + +required: + - compatible + +unevaluatedProperties: false + +examples: + - | + virtio@3000 { + compatible = "virtio,mmio"; + reg = <0x3000 0x100>; + interrupts = <41>; + + i2c-virtio { + compatible = "virtio,22"; + + #address-cells = <1>; + #size-cells = <0>; + + light-sensor@1c { + compatible = "dynaimage,al3320a"; + reg = <0x20>; + }; + }; + }; + +... --2.31.1.272.g89b43f80a514
Re: [PATCH V3 3/5] dt-bindings: gpio: Add bindings for gpio-virtio
In reply to Viresh KumarQuoted 19 lines · Viresh Kumar
This patch adds binding for virtio GPIO controller, it is based on virtio-device bindings.
Signed-off-by Viresh Kumar <[email protected]>--- .../devicetree/bindings/gpio/gpio-virtio.yaml | 60 +++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 Documentation/devicetree/bindings/gpio/gpio-virtio.yamlDocumentation/devicetree/bindings/gpio/gpio-virtio.yaml new file +3
-0@@ -0,0 +1,60 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +---
Documentation/devicetree/bindings/gpio/gpio-virtio.yaml line 13
Quoted 10 lines
Documentation/devicetree/bindings/gpio/gpio-virtio.yaml new file +10
-0+$id: http://devicetree.org/schemas/gpio/gpio-virtio.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Virtio GPIO controller + +maintainers: + - Viresh Kumar <[email protected]> + +allOf: + - $ref: /schemas/gpio/gpio.yaml#
You don't need to include this.
Quoted 50 lines
Documentation/devicetree/bindings/gpio/gpio-virtio.yaml new file +47
-1+ - $ref: /schemas/virtio/virtio-device.yaml# + +description: + Virtio GPIO controller, see /schemas/virtio/virtio-device.yaml for more + details. + +properties: + $nodename: + pattern: '^gpio-virtio(-[a-z0-9]+)?$' + + compatible: + const: virtio,29 + + gpio-controller: true + + "#gpio-cells": + const: 2 + + interrupt-controller: true + + "#interrupt-cells": + const: 2 + +required: + - compatible + - gpio-controller + - "#gpio-cells" + +unevaluatedProperties: false + +examples: + - | + virtio@3000 { + compatible = "virtio,mmio"; + reg = <0x3000 0x100>; + interrupts = <41>; + + gpio: gpio-virtio { + compatible = "virtio,29"; + gpio-controller; + #gpio-cells = <2>; + interrupt-controller; + #interrupt-cells = <2>; + }; + }; + +... --2.31.1.272.g89b43f80a514
Re: [PATCH V3 1/5] dt-bindings: virtio: Add binding for virtio devices
In reply to Rob HerringQuoted 9 lines · Rob Herring
Documentation/devicetree/bindings/virtio/virtio-device.yaml line 25
Quoted 6 lines · Viresh Kumar
Documentation/devicetree/bindings/virtio/virtio-device.yaml new file +6
-0+ description: | + Exactly one node describing the virtio device. The name of the node isn't + significant but its phandle can be used to by a user of the virtio device. + + compatible: + pattern: "^virtio,[0-9a-f]+$"DID is only 4 chars? If so, "^virtio,[0-9a-f]{1,4}$"
Any opinion on whether this should have any namespace prefix (or infix, I guess) after "virtio,"?
I previously suggested making it "virtio,device[0-9a-f]{1,4}$", which would make it clearer that the following digits are the device ID rather than something
else we might define in the future. Viresh picked this version because it's somewhat more consistent with other subsystems.
Arnd
Re: [PATCH V3 1/5] dt-bindings: virtio: Add binding for virtio devices
Quoted 12 lines · Arnd Bergmann
Quoted 9 lines · Rob Herring
Documentation/devicetree/bindings/virtio/virtio-device.yaml line 25
Quoted 6 lines · Viresh Kumar
Documentation/devicetree/bindings/virtio/virtio-device.yaml new file +6
-0+ description: | + Exactly one node describing the virtio device. The name of the node isn't + significant but its phandle can be used to by a user of the virtio device. + + compatible: + pattern: "^virtio,[0-9a-f]+$"DID is only 4 chars? If so, "^virtio,[0-9a-f]{1,4}$"
Quoted 8 lines
Any opinion on whether this should have any namespace prefix (or infix, I guess) after "virtio,"?
I previously suggested making it "virtio,device[0-9a-f]{1,4}$", which would make it clearer that the following digits are the device ID rather than something
else we might define in the future. Viresh picked this version because it's somewhat more consistent with other subsystems.
I'm fine either way, though I do find just a number a bit strange. So I'd lean toward adding 'device' or even just a 'd'.
BTW, what happens if/when the device protocol is rev'ed? A new DID or is there a separate revision that's discoverable?
Rob
Re: [PATCH V3 1/5] dt-bindings: virtio: Add binding for virtio devices
Quoted 17 lines · Rob Herring
Quoted 15 lines · Arnd Bergmann
Quoted 9 lines · Rob Herring
Documentation/devicetree/bindings/virtio/virtio-device.yaml line 25
Quoted 6 lines · Viresh Kumar
Documentation/devicetree/bindings/virtio/virtio-device.yaml new file +6
-0+ description: | + Exactly one node describing the virtio device. The name of the node isn't + significant but its phandle can be used to by a user of the virtio device. + + compatible: + pattern: "^virtio,[0-9a-f]+$"DID is only 4 chars? If so, "^virtio,[0-9a-f]{1,4}$"
Any opinion on whether this should have any namespace prefix (or infix, I guess) after "virtio,"?
Quoted 8 lines
Quoted 5 lines
I previously suggested making it "virtio,device[0-9a-f]{1,4}$", which would make it clearer that the following digits are the device ID rather than something
else we might define in the future. Viresh picked this version because it's somewhat more consistent with other subsystems.I'm fine either way, though I do find just a number a bit strange. So I'd lean toward adding 'device' or even just a 'd'.
I don't think just 'd' would be a good idea since it is indistinguishable from a hexadecimal character. 'dev' would work though.
Quoted 2 lines
BTW, what happens if/when the device protocol is rev'ed? A new DID or is there a separate revision that's discoverable?
This should normally be done using feature bits that are negotiated between the two sides, and if only one side can do it, they use the old revision.
There could be a new device ID but I don't think that has happened so far.
Arnd
Re: [PATCH V3 1/5] dt-bindings: virtio: Add binding for virtio devices
In reply to Rob HerringQuoted 9 lines · Rob Herring
Documentation/devicetree/bindings/virtio/virtio-device.yaml line 25
Quoted 6 lines · Viresh Kumar
Documentation/devicetree/bindings/virtio/virtio-device.yaml new file +6
-0+ description: | + Exactly one node describing the virtio device. The name of the node isn't + significant but its phandle can be used to by a user of the virtio device. + + compatible: + pattern: "^virtio,[0-9a-f]+$"DID is only 4 chars? If so, "^virtio,[0-9a-f]{1,4}$"
It is 32 bit actually, so making this {1,8}.
Signature · 1 line
viresh
Re: [PATCH V3 5/5] virtio: Bind virtio device to device-tree node
In reply to Viresh KumarQuoted 53 lines · Viresh Kumar
Bind the virtio devices with their
of_node. This will help users of the virtio devices to mention their dependencies on the device in the DT itself. Like GPIO pin users can use the phandle of the device node, or the node may contain more subnodes to add i2c or spi eeproms and other users.Reviewed-by Arnd Bergmann <[email protected]>Signed-off-by Viresh Kumar <[email protected]>--- drivers/virtio/virtio.c | 57 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 54 insertions(+), 3 deletions(-)drivers/virtio/virtio.c +19
-0@@ -4,6 +4,7 @@#include <linux/virtio_config.h> #include <linux/module.h> #include <linux/idr.h> +#include <linux/of.h> #include <uapi/linux/virtio_ids.h> /* Unique numbering for virtio devices. */ @@ -292,6 +293,9 @@ static int virtio_dev_remove(struct device *_d)/* Acknowledge the device's existence again. */ virtio_add_status (dev,VIRTIO_CONFIG_S_ACKNOWLEDGE ); + +of_node_put (dev->dev.of_node); +return 0 ; }@@ -319,6 +323,43 @@ void unregister_virtio_driver(struct virtio_driver *driver) }EXPORT_SYMBOL_GPL (unregister_virtio_driver); +static int virtio_device_of_init (struct virtio_device *dev) +{ +struct device_node *np, *pnode =dev_of_node (dev->dev.parent); +char compat[] ="virtio,XXXXXXXX" ;/* Reserve enough space 32-bit id */ +int ret, count; + +if (!pnode) +return 0 ; + + count =of_get_available_child_count (pnode); +if (!count) +return 0 ; + +/* There can be only 1 child node */ +if (WARN_ON (count >1 ))
drivers/virtio/virtio.c void unregister_virtio_driver(struct virtio_driver *driver) · line 350
Quoted 10 lines
drivers/virtio/virtio.c +10
-0+return -EINVAL ; + + np =of_get_next_available_child (pnode,NULL ); +if (WARN_ON (!np)) +return -ENODEV ; + +BUG_ON (snprintf (compat,sizeof (compat),"virtio,%x" , dev->id.device) >= +sizeof (compat)); + +if (!of_device_is_compatible (np, compat)) {
This broke powerpc/pseries as there these virtio devices are PCI so there is no "compat" - PCI vendor id/device ids play role of "compat". Thanks,
Quoted 47 lines
drivers/virtio/virtio.c +25
-3+ ret = -EINVAL ; + goto out; + } + + dev->dev.of_node = np; +return 0 ; + +out: +of_node_put (np); +return ret; +} +/** * register_virtio_device - register virtio device * @dev : virtio device to be registered @@ -343,6 +384,10 @@ int register_virtio_device(struct virtio_device *dev) dev->index = err;dev_set_name (&dev->dev,"virtio%u" , dev->index); + err =virtio_device_of_init (dev); +if (err) + goto out_ida_remove; +spin_lock_init (&dev->config_lock); dev->config_enabled = false; dev->config_change_pending = false;@@ -362,10 +407,16 @@ int register_virtio_device(struct virtio_device *dev)*/ err =device_add (&dev->dev);if (err) -ida_simple_remove (&virtio_index_ida, dev->index); + goto out_of_node_put; + +return 0 ; + +out_of_node_put: +of_node_put (dev->dev.of_node); +out_ida_remove: +ida_simple_remove (&virtio_index_ida, dev->index); out: -if (err) -virtio_add_status (dev,VIRTIO_CONFIG_S_FAILED ); +virtio_add_status (dev,VIRTIO_CONFIG_S_FAILED );return err; }EXPORT_SYMBOL_GPL (register_virtio_device);
Signature · 1 line
Alexey
Michael S. Tsirkin
maintainerRe: [PATCH V3 5/5] virtio: Bind virtio device to device-tree node
Quoted 63 lines · Alexey Kardashevskiy
Quoted 60 lines · Viresh Kumar
Bind the virtio devices with their
of_node. This will help users of the virtio devices to mention their dependencies on the device in the DT itself. Like GPIO pin users can use the phandle of the device node, or the node may contain more subnodes to add i2c or spi eeproms and other users.Reviewed-by Arnd Bergmann <[email protected]>Signed-off-by Viresh Kumar <[email protected]>--- drivers/virtio/virtio.c | 57 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 54 insertions(+), 3 deletions(-)drivers/virtio/virtio.c +26
-0@@ -4,6 +4,7 @@#include <linux/virtio_config.h> #include <linux/module.h> #include <linux/idr.h> +#include <linux/of.h> #include <uapi/linux/virtio_ids.h> /* Unique numbering for virtio devices. */ @@ -292,6 +293,9 @@ static int virtio_dev_remove(struct device *_d)/* Acknowledge the device's existence again. */ virtio_add_status (dev,VIRTIO_CONFIG_S_ACKNOWLEDGE ); + +of_node_put (dev->dev.of_node); +return 0 ; }@@ -319,6 +323,43 @@ void unregister_virtio_driver(struct virtio_driver *driver) }EXPORT_SYMBOL_GPL (unregister_virtio_driver); +static int virtio_device_of_init (struct virtio_device *dev) +{ +struct device_node *np, *pnode =dev_of_node (dev->dev.parent); +char compat[] ="virtio,XXXXXXXX" ;/* Reserve enough space 32-bit id */ +int ret, count; + +if (!pnode) +return 0 ; + + count =of_get_available_child_count (pnode); +if (!count) +return 0 ; + +/* There can be only 1 child node */ +if (WARN_ON (count >1 )) +return -EINVAL ; + + np =of_get_next_available_child (pnode,NULL ); +if (WARN_ON (!np)) +return -ENODEV ; + + BUG_ON(snprintf(compat, sizeof(compat), "virtio,%x", dev->id.device) >=
Quoted 8 lines
drivers/virtio/virtio.c void unregister_virtio_driver(struct virtio_driver *driver) · line 350
Quoted 3 lines
drivers/virtio/virtio.c +3
-0+ sizeof(compat)); + +if (!of_device_is_compatible (np, compat)) {This broke powerpc/pseries as there these virtio devices are PCI so there is no "compat" - PCI vendor id/device ids play role of "compat". Thanks,
Hmm now that you say this I wonder why do we bother with this check, too. When can this be invoked for something that is not a virtio device? And is it enough to just skip of_node initialization then?
Quoted 4 lines
drivers/virtio/virtio.c void unregister_virtio_driver(struct virtio_driver *driver) · line 351
Quoted 4 lines
drivers/virtio/virtio.c +1
-0+ ret = -EINVAL ;
So basically ret = 0 above?
Quoted 49 lines
Quoted 46 lines
drivers/virtio/virtio.c +24
-3+ goto out; + } + + dev->dev.of_node = np; +return 0 ; + +out: +of_node_put (np); +return ret; +} +/** * register_virtio_device - register virtio device * @dev : virtio device to be registered @@ -343,6 +384,10 @@ int register_virtio_device(struct virtio_device *dev) dev->index = err;dev_set_name (&dev->dev,"virtio%u" , dev->index); + err =virtio_device_of_init (dev); +if (err) + goto out_ida_remove; +spin_lock_init (&dev->config_lock); dev->config_enabled = false; dev->config_change_pending = false;@@ -362,10 +407,16 @@ int register_virtio_device(struct virtio_device *dev)*/ err =device_add (&dev->dev);if (err) -ida_simple_remove (&virtio_index_ida, dev->index); + goto out_of_node_put; + +return 0 ; + +out_of_node_put: +of_node_put (dev->dev.of_node); +out_ida_remove: +ida_simple_remove (&virtio_index_ida, dev->index); out: -if (err) -virtio_add_status (dev,VIRTIO_CONFIG_S_FAILED ); +virtio_add_status (dev,VIRTIO_CONFIG_S_FAILED );return err; }EXPORT_SYMBOL_GPL (register_virtio_device);Signature · 1 line
Alexey
Re: [PATCH V3 5/5] virtio: Bind virtio device to device-tree node
Quoted 73 lines · Michael S. Tsirkin
Quoted 63 lines · Alexey Kardashevskiy
Quoted 60 lines · Viresh Kumar
Bind the virtio devices with their
of_node. This will help users of the virtio devices to mention their dependencies on the device in the DT itself. Like GPIO pin users can use the phandle of the device node, or the node may contain more subnodes to add i2c or spi eeproms and other users.Reviewed-by Arnd Bergmann <[email protected]>Signed-off-by Viresh Kumar <[email protected]>--- drivers/virtio/virtio.c | 57 ++++++++++++++++++++++++++++++++++++++--- 1 file changed, 54 insertions(+), 3 deletions(-)drivers/virtio/virtio.c +26
-0@@ -4,6 +4,7 @@#include <linux/virtio_config.h> #include <linux/module.h> #include <linux/idr.h> +#include <linux/of.h> #include <uapi/linux/virtio_ids.h> /* Unique numbering for virtio devices. */ @@ -292,6 +293,9 @@ static int virtio_dev_remove(struct device *_d)/* Acknowledge the device's existence again. */ virtio_add_status (dev,VIRTIO_CONFIG_S_ACKNOWLEDGE ); + +of_node_put (dev->dev.of_node); +return 0 ; }@@ -319,6 +323,43 @@ void unregister_virtio_driver(struct virtio_driver *driver) }EXPORT_SYMBOL_GPL (unregister_virtio_driver); +static int virtio_device_of_init (struct virtio_device *dev) +{ +struct device_node *np, *pnode =dev_of_node (dev->dev.parent); +char compat[] ="virtio,XXXXXXXX" ;/* Reserve enough space 32-bit id */ +int ret, count; + +if (!pnode) +return 0 ; + + count =of_get_available_child_count (pnode); +if (!count) +return 0 ; + +/* There can be only 1 child node */ +if (WARN_ON (count >1 )) +return -EINVAL ; + + np =of_get_next_available_child (pnode,NULL ); +if (WARN_ON (!np)) +return -ENODEV ; + + BUG_ON(snprintf(compat, sizeof(compat), "virtio,%x", dev->id.device) >=Quoted 8 lines
drivers/virtio/virtio.c void unregister_virtio_driver(struct virtio_driver *driver) · line 350
Quoted 3 lines
drivers/virtio/virtio.c +3
-0+ sizeof(compat)); + +if (!of_device_is_compatible (np, compat)) {This broke powerpc/pseries as there these virtio devices are PCI so there is no "compat" - PCI vendor id/device ids play role of "compat". Thanks,
Quoted 4 lines
Hmm now that you say this I wonder why do we bother with this check, too. When can this be invoked for something that is not a virtio device? And is it enough to just skip
of_nodeinitialization then?
I am not following here, the problem device is virtio-scsi which is virtio-derived, or you meant that virtio which hosts virtio-bus?
Quoted 8 lines
Quoted 5 lines
drivers/virtio/virtio.c void unregister_virtio_driver(struct virtio_driver *driver) · line 351
Quoted 5 lines
drivers/virtio/virtio.c +1
-0+ ret = -EINVAL ;So basically ret = 0 above?
Yup, this does fix it. Thanks,
Quoted 52 lines
Quoted 51 lines
Quoted 48 lines
drivers/virtio/virtio.c +24
-3+ goto out; + } + + dev->dev.of_node = np; +return 0 ; + +out: +of_node_put (np); +return ret; +} +/** * register_virtio_device - register virtio device * @dev : virtio device to be registered @@ -343,6 +384,10 @@ int register_virtio_device(struct virtio_device *dev) dev->index = err;dev_set_name (&dev->dev,"virtio%u" , dev->index); + err =virtio_device_of_init (dev); +if (err) + goto out_ida_remove; +spin_lock_init (&dev->config_lock); dev->config_enabled = false; dev->config_change_pending = false;@@ -362,10 +407,16 @@ int register_virtio_device(struct virtio_device *dev)*/ err =device_add (&dev->dev);if (err) -ida_simple_remove (&virtio_index_ida, dev->index); + goto out_of_node_put; + +return 0 ; + +out_of_node_put: +of_node_put (dev->dev.of_node); +out_ida_remove: +ida_simple_remove (&virtio_index_ida, dev->index); out: -if (err) -virtio_add_status (dev,VIRTIO_CONFIG_S_FAILED ); +virtio_add_status (dev,VIRTIO_CONFIG_S_FAILED );return err; }EXPORT_SYMBOL_GPL (register_virtio_device);Signature · 1 line
Alexey
Signature · 1 line
Alexey
Re: [PATCH V3 5/5] virtio: Bind virtio device to device-tree node
In reply to Viresh KumarQuoted 8 lines · Viresh Kumar
Bind the virtio devices with their
of_node. This will help users of the virtio devices to mention their dependencies on the device in the DT itself. Like GPIO pin users can use the phandle of the device node, or the node may contain more subnodes to add i2c or spi eeproms and other users.Reviewed-by Arnd Bergmann <[email protected]>Signed-off-by Viresh Kumar <[email protected]>
This patch causes a boot failure on sparc64: The virtio device no longer instantiates. Reverting this patch fixes the problem. Bisect log attached.
Guenter
---
# bad: [6880fa6c56601bb8ed59df6c30fd390cc5f6dd8f] Linux 5.15-rc1
# good: [926de8c4326c14fcf35f1de142019043597a4fac] Merge tag 'acpi-5.15-rc1-3' of git://git.kernel.org/pub/scm/linux/kernel/git/rafael/linux-pm
git bisect start 'HEAD' '926de8c4326c'
# good: [8177a5c96229ff24da1e362789e359b68b4f34f5] Merge tag 'libata-5.15-2021-09-11' of git://git.kernel.dk/linux-block
git bisect good 8177a5c96229ff24da1e362789e359b68b4f34f5
# bad: [78e709522d2c012cb0daad2e668506637bffb7c2] Merge tag 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mst/vhost
git bisect bad 78e709522d2c012cb0daad2e668506637bffb7c2
# bad: [7bc7f61897b66bef78bb5952e3d1e9f3aaf9ccca] Documentation: Add documentation for VDUSE
git bisect bad 7bc7f61897b66bef78bb5952e3d1e9f3aaf9ccca
# bad: [41116599a0731f4cd451e9d191d879ab45e31945] virtio/vsock: add 'VIRTIO_VSOCK_SEQ_EOR' bit.
git bisect bad 41116599a0731f4cd451e9d191d879ab45e31945
# good: [5262912ef3cfc5e518892c3d67fb36412cb813e2] vdpa/mlx5: Add support for control VQ and MAC setting
git bisect good 5262912ef3cfc5e518892c3d67fb36412cb813e2
# good: [7f815fce08d563006e43d1b7d2f9a0a4f3b832f3] dt-bindings: i2c: Add bindings for i2c-virtio
git bisect good 7f815fce08d563006e43d1b7d2f9a0a4f3b832f3
# good: [d5a8680dfab0547a4ecd708b1fe9de48598a6757] uapi: virtio_ids: Sync ids with specification
git bisect good d5a8680dfab0547a4ecd708b1fe9de48598a6757
# bad: [9af8f1061646e8e22b66413bedf7b3e2ab3d69e5] virtio/vsock: rename 'EOR' to 'EOM' bit.
git bisect bad 9af8f1061646e8e22b66413bedf7b3e2ab3d69e5
# bad: [694a1116b405d887c893525a6766b390989c8606] virtio: Bind virtio device to device-tree node
git bisect bad 694a1116b405d887c893525a6766b390989c8606
# first bad commit: [694a1116b405d887c893525a6766b390989c8606] virtio: Bind virtio device to device-tree node _______________________________________________ Virtualization mailing list [email protected] https://lists.linuxfoundation.org/mailman/listinfo/virtualization
Re: [PATCH V3 5/5] virtio: Bind virtio device to device-tree node
Quoted 7 lines · Guenter Roeck
Quoted 6 lines · Viresh Kumar
Bind the virtio devices with their
of_node. This will help users of the virtio devices to mention their dependencies on the device in the DT itself. Like GPIO pin users can use the phandle of the device node, or the node may contain more subnodes to add i2c or spi eeproms and other users.
Quoted 6 lines
Quoted 2 lines
Reviewed-by Arnd Bergmann <[email protected]>Signed-off-by Viresh Kumar <[email protected]>This patch causes a boot failure on sparc64: The virtio device no longer instantiates. Reverting this patch fixes the problem. Bisect log attached.
In case it matters: The problem is here:
+ if (!of_device_is_compatible(np, compat)) {
+ ret = -EINVAL;
+ goto out;
+ }
Guenter
Quoted 25 lines
Guenter
---
# bad: [6880fa6c56601bb8ed59df6c30fd390cc5f6dd8f] Linux 5.15-rc1
# good: [926de8c4326c14fcf35f1de142019043597a4fac] Merge tag 'acpi-5.15-rc1-3' ofgit://git.kernel.org/pub/scm/linux/kernel/git/rafael/linux-pm
git bisect start 'HEAD' '926de8c4326c'
# good: [8177a5c96229ff24da1e362789e359b68b4f34f5] Merge tag 'libata-5.15-2021-09-11' ofgit://git.kernel.dk/linux-block
git bisect good8177a5c96229ff24da1e362789e359b68b4f34f5
# bad: [78e709522d2c012cb0daad2e668506637bffb7c2] Merge tag 'for_linus' ofgit://git.kernel.org/pub/scm/linux/kernel/git/mst/vhost
git bisect bad78e709522d2c012cb0daad2e668506637bffb7c2
# bad: [7bc7f61897b66bef78bb5952e3d1e9f3aaf9ccca] Documentation: Add documentation for VDUSE
git bisect bad7bc7f61897b66bef78bb5952e3d1e9f3aaf9ccca
# bad: [41116599a0731f4cd451e9d191d879ab45e31945] virtio/vsock: add 'VIRTIO_VSOCK_SEQ_EOR' bit.
git bisect bad41116599a0731f4cd451e9d191d879ab45e31945
# good: [5262912ef3cfc5e518892c3d67fb36412cb813e2] vdpa/mlx5: Add support for control VQ and MAC setting
git bisect good5262912ef3cfc5e518892c3d67fb36412cb813e2
# good: [7f815fce08d563006e43d1b7d2f9a0a4f3b832f3] dt-bindings: i2c: Add bindings for i2c-virtio
git bisect good7f815fce08d563006e43d1b7d2f9a0a4f3b832f3
# good: [d5a8680dfab0547a4ecd708b1fe9de48598a6757] uapi:virtio_ids: Sync ids with specification
git bisect goodd5a8680dfab0547a4ecd708b1fe9de48598a6757
# bad: [9af8f1061646e8e22b66413bedf7b3e2ab3d69e5] virtio/vsock: rename 'EOR' to 'EOM' bit.
git bisect bad9af8f1061646e8e22b66413bedf7b3e2ab3d69e5
# bad: [694a1116b405d887c893525a6766b390989c8606] virtio: Bind virtio device to device-tree node
git bisect bad694a1116b405d887c893525a6766b390989c8606# first bad commit: [694a1116b405d887c893525a6766b390989c8606] virtio: Bind virtio device to device-tree node