Skip to contentSkip to conversation

virtio: Add virtio-device bindings

PATCH In review Viresh Kumar 4 participants 17 messages Jul 27, 2021 – Aug 31, 2021

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

v4 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.

V3->V4:
- The binding is named "virtio,deviceXXXXXXXX" now.
- The virtio binding doesn't restrict the node names anymore.
- The i2c/gpio nodes are named i2c and gpio now.
- Dropped including gpio.yaml.
- Updated code to match the new binding name.
- Use "type: object" in additional-property.

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 | 59 +++++++++++++++++++
 .../devicetree/bindings/i2c/i2c-virtio.yaml   | 51 ++++++++++++++++
 .../devicetree/bindings/virtio/mmio.yaml      |  3 +-
 .../bindings/virtio/virtio-device.yaml        | 41 +++++++++++++
 drivers/virtio/virtio.c                       | 57 +++++++++++++++++-
 include/uapi/linux/virtio_ids.h               | 12 ++++
 6 files changed, 219 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
#1 lore raw

PATCH v4 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 the format "virtio,device<ID>", where ID is virtio device ID in hexadecimal format.

---
 .../devicetree/bindings/virtio/mmio.yaml      |  3 +-
 .../bindings/virtio/virtio-device.yaml        | 41 +++++++++++++++++++
 2 files changed, 43 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/devicetree/bindings/virtio/virtio-device.yaml
Documentation/devicetree/bindings/virtio/mmio.yaml +2 -1
index d46597028cf1..4b7a0273181c 100644
@@ -36,7 +36,8 @@ title: virtio memory mapped devices
   - reg
   - interrupts
 
-additionalProperties: false
+additionalProperties:
+  type: object
 
 examples:
   - |
Documentation/devicetree/bindings/virtio/virtio-device.yaml new file +41 -0

41 lines not on this page · raw message

Signature · 1 line
2.31.1.272.g89b43f80a514
Reviewed-by on v4 1/5
#2 lore raw

Re: [PATCH V4 1/5] dt-bindings: virtio: Add binding for virtio devices

Quoted 6 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 the format "virtio,device<ID>", where ID is virtio device ID in hexadecimal format.

maintainer Reviewed-by on v4 1/5
#3 lore raw

Re: [PATCH V4 1/5] dt-bindings: virtio: Add binding for virtio devices

In reply to Viresh Kumar
Quoted 11 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 the format "virtio,device<ID>", where ID is virtio device ID in hexadecimal format.

---
 .../devicetree/bindings/virtio/mmio.yaml      |  3 +-
 .../bindings/virtio/virtio-device.yaml        | 41 +++++++++++++++++++
 2 files changed, 43 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/devicetree/bindings/virtio/virtio-device.yaml
#4 lore raw

PATCH v4 2/5 dt-bindings: i2c: Add bindings for i2c-virtio

In reply to Viresh Kumar

This 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
new file mode 100644
index 000000000000..7d87ed855301
@@ -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:
+    const: i2c
+
+  compatible:
+    const: virtio,device22
+
+required:
+  - compatible
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    virtio@3000 {
+        compatible = "virtio,mmio";
+        reg = <0x3000 0x100>;
+        interrupts = <41>;
+
+        i2c {
+            compatible = "virtio,device22";
+
+            #address-cells = <1>;
+            #size-cells = <0>;
+
+            light-sensor@20 {
+                compatible = "dynaimage,al3320a";
+                reg = <0x20>;
+            };
+        };
+    };
+
+...
Signature · 6 lines
2.31.1.272.g89b43f80a514

_______________________________________________
Virtualization mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/virtualization
maintainer Reviewed-by on v4 2/5
#5 lore raw

Re: [PATCH V4 2/5] dt-bindings: i2c: Add bindings for i2c-virtio

Quoted 11 lines · Viresh Kumar

This 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
#6 lore raw

PATCH v4 3/5 dt-bindings: gpio: Add bindings for gpio-virtio

In reply to Viresh Kumar

This patch adds binding for virtio GPIO controller, it is based on virtio-device bindings.

---
 .../devicetree/bindings/gpio/gpio-virtio.yaml | 59 +++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/gpio/gpio-virtio.yaml
Documentation/devicetree/bindings/gpio/gpio-virtio.yaml new file +59 -0
new file mode 100644
index 000000000000..601d85754577
@@ -0,0 +1,59 @@
+# 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/virtio/virtio-device.yaml#
+
+description:
+  Virtio GPIO controller, see /schemas/virtio/virtio-device.yaml for more
+  details.
+
+properties:
+  $nodename:
+    const: gpio
+
+  compatible:
+    const: virtio,device29
+
+  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 {
+            compatible = "virtio,device29";
+            gpio-controller;
+            #gpio-cells = <2>;
+            interrupt-controller;
+            #interrupt-cells = <2>;
+        };
+    };
+
+...
Signature · 1 line
2.31.1.272.g89b43f80a514
maintainer
#7 lore raw

Re: [PATCH V4 3/5] dt-bindings: gpio: Add bindings for gpio-virtio

Quoted 40 lines · Viresh Kumar

This patch adds binding for virtio GPIO controller, it is based on virtio-device bindings.

---
 .../devicetree/bindings/gpio/gpio-virtio.yaml | 59 +++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/gpio/gpio-virtio.yaml
Documentation/devicetree/bindings/gpio/gpio-virtio.yaml new file +24 -0
new file mode 100644
index 000000000000..601d85754577
@@ -0,0 +1,59 @@
+# 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/virtio/virtio-device.yaml#
+
+description:
+  Virtio GPIO controller, see /schemas/virtio/virtio-device.yaml for more
+  details.
+
+properties:
+  $nodename:
+    const: gpio
+
+  compatible:
+    const: virtio,device29

Documentation/devicetree/bindings/gpio/gpio-virtio.yaml line 34

Quoted 10 lines
Documentation/devicetree/bindings/gpio/gpio-virtio.yaml new file +10 -0
+
+  gpio-controller: true
+
+  "#gpio-cells":
+    const: 2
+
+  interrupt-controller: true
+
+  "#interrupt-cells":
+    const: 2

Humm, how does one implement interrupts without a parent interrupt? It uses the parent virtio,mmio interrupt?

Quoted 29 lines
Documentation/devicetree/bindings/gpio/gpio-virtio.yaml new file +25 -0
+
+required:
+  - compatible
+  - gpio-controller
+  - "#gpio-cells"
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    virtio@3000 {
+        compatible = "virtio,mmio";
+        reg = <0x3000 0x100>;
+        interrupts = <41>;
+
+        gpio {
+            compatible = "virtio,device29";
+            gpio-controller;
+            #gpio-cells = <2>;
+            interrupt-controller;
+            #interrupt-cells = <2>;
+        };
+    };
+
+...
Signature · 1 line
2.31.1.272.g89b43f80a514
#8 lore raw

Re: [PATCH V4 3/5] dt-bindings: gpio: Add bindings for gpio-virtio

Quoted 2 lines · Rob Herring

Humm, how does one implement interrupts without a parent interrupt? It uses the parent virtio,mmio interrupt?

Kind of, yeah, but not necessarily.

The interrupt information is passed over buffers shared between host and guest. Now the guest may process the buffers when it receives a notification from the host, that will be at downpath of an interrupt for virtio,mmio. Or the guest may poll on the virtqueue and process any buffers as soon as they are made available, no interrupts then.

Signature · 1 line
viresh
maintainer Reviewed-by
#9 lore raw

Re: [PATCH V4 3/5] dt-bindings: gpio: Add bindings for gpio-virtio

Quoted 5 lines · Viresh Kumar
Quoted 2 lines · Rob Herring

Humm, how does one implement interrupts without a parent interrupt? It uses the parent virtio,mmio interrupt?

Quoted 7 lines

Kind of, yeah, but not necessarily.

The interrupt information is passed over buffers shared between host and guest. Now the guest may process the buffers when it receives a notification from the host, that will be at downpath of an interrupt for virtio,mmio. Or the guest may poll on the virtqueue and process any buffers as soon as they are made available, no interrupts then.

Okay, thanks for the explanation.

Rob

#10 lore raw

Re: [PATCH V4 3/5] dt-bindings: gpio: Add bindings for gpio-virtio

Quoted 14 lines · Rob Herring
Quoted 5 lines · Viresh Kumar
Quoted 2 lines · Rob Herring

Humm, how does one implement interrupts without a parent interrupt? It uses the parent virtio,mmio interrupt?

Quoted 7 lines

Kind of, yeah, but not necessarily.

The interrupt information is passed over buffers shared between host and guest. Now the guest may process the buffers when it receives a notification from the host, that will be at downpath of an interrupt for virtio,mmio. Or the guest may poll on the virtqueue and process any buffers as soon as they are made available, no interrupts then.

Quoted 3 lines

Okay, thanks for the explanation.

Thanks for reviewing this Rob.

Signature · 1 line
viresh
#11 lore raw

PATCH v4 4/5 uapi: virtio_ids: Sync ids with specification

In reply to Viresh Kumar

This 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
index 70a8057ad4bb..3c8e11820fdb 100644
@@ -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 · 1 line
2.31.1.272.g89b43f80a514
#12 lore raw

PATCH v4 5/5 virtio: Bind virtio device to device-tree node

In reply to 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.

---
 drivers/virtio/virtio.c | 57 ++++++++++++++++++++++++++++++++++++++---
 1 file changed, 54 insertions(+), 3 deletions(-)
drivers/virtio/virtio.c +54 -3
index 4b15c00c0a0a..5f80786c2aa2 100644
@@ -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,deviceXXXXXXXX";
+	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;
+
+	ret = snprintf(compat, sizeof(compat), "virtio,device%x", dev->id.device);
+	BUG_ON(ret >= 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 · 6 lines
2.31.1.272.g89b43f80a514

_______________________________________________
Virtualization mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/virtualization
#13 lore raw
In reply to Viresh Kumar
Quoted 15 lines · Viresh Kumar

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.

Quoted 8 lines

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.

Michael,

I hope you will be picking this series (Now that it is reviewed by others) ? Just so you know, Wolfram needs the 4th patch, 4/5, to base the virtio-i2c driver over it and has requested an immutable branch for the same.

Thanks.

Signature · 1 line
viresh
#14 lore raw
Quoted 6 lines · Viresh Kumar

Michael,

I hope you will be picking this series (Now that it is reviewed by others) ? Just so you know, Wolfram needs the 4th patch, 4/5, to base the virtio-i2c driver over it and has requested an immutable branch for the same.

Michael, we need an immutable branch with the following patch:

uapi: virtio_ids: Sync ids with specification

This will enable Wolfram to apply the I2C driver for 5.15-rc1 and maybe Linus as well for the GPIO driver.

Signature · 1 line
viresh
#15 lore raw
In reply to Viresh Kumar
Quoted 15 lines · Viresh Kumar

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.

Quoted 8 lines

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.

Michael, are you picking these up for 5.15 ?

Signature · 1 line
viresh
#16 lore raw
Quoted 18 lines · Viresh Kumar
Quoted 17 lines · Viresh Kumar

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.

Quoted 8 lines
Quoted 6 lines

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.

Michael, are you picking these up for 5.15 ?

Okay.

Quoted 2 lines
Signature · 1 line
viresh