diff mbox series

[5/5] dt-bindings: gpio: Add bindings for gpio-virtio

Message ID 268086e273df0c53e3a9a1e751304c63e50ebe12.1626173013.git.viresh.kumar@linaro.org
State New
Headers show
Series virtio: Parse virtio-device nodes from DT | expand

Commit Message

Viresh Kumar July 13, 2021, 10:50 a.m. UTC
gpio-virtio represents a virtio GPIO controller and this patch adds
binding for the same. The gpio-virtio subnode can be part of a
virtio,mmio node and is based on its binding.

Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org>

---
Depends on:

https://lore.kernel.org/lkml/7c716c2eb7ace5b5a560d8502af93101dbb53d24.1626170146.git.viresh.kumar@linaro.org/
---
 .../devicetree/bindings/gpio/gpio-virtio.yaml | 67 +++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/gpio/gpio-virtio.yaml

-- 
2.31.1.272.g89b43f80a514

Comments

Rob Herring (Arm) July 13, 2021, 2:03 p.m. UTC | #1
On Tue, 13 Jul 2021 16:20:34 +0530, Viresh Kumar wrote:
> gpio-virtio represents a virtio GPIO controller and this patch adds
> binding for the same. The gpio-virtio subnode can be part of a
> virtio,mmio node and is based on its binding.
> 
> Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org>
> ---
> Depends on:
> 
> https://lore.kernel.org/lkml/7c716c2eb7ace5b5a560d8502af93101dbb53d24.1626170146.git.viresh.kumar@linaro.org/
> ---
>  .../devicetree/bindings/gpio/gpio-virtio.yaml | 67 +++++++++++++++++++
>  1 file changed, 67 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/gpio/gpio-virtio.yaml
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
Unknown file referenced: [Errno 2] No such file or directory: '/usr/local/lib/python3.8/dist-packages/dtschema/schemas/virtio/mmio.yaml'
xargs: dt-doc-validate: exited with status 255; aborting
Documentation/devicetree/bindings/gpio/gpio-virtio.example.dts:19:18: fatal error: dt-bindings/virtio/virtio_ids.h: No such file or directory
   19 |         #include <dt-bindings/virtio/virtio_ids.h>
      |                  ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
compilation terminated.
make[1]: *** [scripts/Makefile.lib:380: Documentation/devicetree/bindings/gpio/gpio-virtio.example.dt.yaml] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:1416: dt_binding_check] Error 2
\ndoc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/patch/1504545

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit.
Rob Herring July 13, 2021, 2:46 p.m. UTC | #2
On Tue, Jul 13, 2021 at 4:51 AM Viresh Kumar <viresh.kumar@linaro.org> wrote:
>

> gpio-virtio represents a virtio GPIO controller and this patch adds

> binding for the same. The gpio-virtio subnode can be part of a

> virtio,mmio node and is based on its binding.

>

> Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org>

> ---

> Depends on:

>

> https://lore.kernel.org/lkml/7c716c2eb7ace5b5a560d8502af93101dbb53d24.1626170146.git.viresh.kumar@linaro.org/

> ---

>  .../devicetree/bindings/gpio/gpio-virtio.yaml | 67 +++++++++++++++++++

>  1 file changed, 67 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/gpio/gpio-virtio.yaml

>

> diff --git a/Documentation/devicetree/bindings/gpio/gpio-virtio.yaml b/Documentation/devicetree/bindings/gpio/gpio-virtio.yaml

> new file mode 100644

> index 000000000000..c813cdfd60fd

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/gpio/gpio-virtio.yaml

> @@ -0,0 +1,67 @@

> +# 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 memory mapped GPIO controller

> +

> +maintainers:

> +  - Viresh Kumar <viresh.kumar@linaro.org>

> +

> +description:

> +  Virtio GPIO controller, see /schemas/virtio/mmio.yaml for more details.

> +

> +allOf:

> +  - $ref: /schemas/gpio/gpio.yaml#

> +

> +properties:

> +  $nodename:

> +    pattern: '^gpio-virtio@[0-9]+$'

> +

> +  reg:

> +    description:

> +      The cell is the device ID of the GPIO device (VIRTIO_ID_GPIO) as per

> +      dt-bindings/virtio/virtio_ids.h.

> +    const: 41

> +    $ref: /schemas/virtio/mmio.yaml#/properties/reg

> +

> +  gpio-controller: true

> +

> +  "#gpio-cells":

> +    const: 2

> +

> +  interrupt-controller: true

> +

> +  "#interrupt-cells":

> +    const: 2

> +

> +required:

> +  - reg

> +  - gpio-controller

> +  - "#gpio-cells"

> +

> +additionalProperties: false

> +

> +examples:

> +  - |

> +    #include <dt-bindings/virtio/virtio_ids.h>

> +

> +    virtio@3000 {

> +        compatible = "virtio,mmio";

> +        reg = <0x3000 0x100>;

> +        interrupts = <41>;

> +

> +        #address-cells = <1>;

> +        #size-cells = <0>;

> +

> +        gpio-virtio@0 {

> +            reg = <VIRTIO_ID_GPIO>;

> +            gpio-controller;

> +            #gpio-cells = <2>;

> +            interrupt-controller;

> +            #interrupt-cells = <2>;


Similar to I2C, all this can just be added to the parent node.

Rob
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/gpio/gpio-virtio.yaml b/Documentation/devicetree/bindings/gpio/gpio-virtio.yaml
new file mode 100644
index 000000000000..c813cdfd60fd
--- /dev/null
+++ b/Documentation/devicetree/bindings/gpio/gpio-virtio.yaml
@@ -0,0 +1,67 @@ 
+# 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 memory mapped GPIO controller
+
+maintainers:
+  - Viresh Kumar <viresh.kumar@linaro.org>
+
+description:
+  Virtio GPIO controller, see /schemas/virtio/mmio.yaml for more details.
+
+allOf:
+  - $ref: /schemas/gpio/gpio.yaml#
+
+properties:
+  $nodename:
+    pattern: '^gpio-virtio@[0-9]+$'
+
+  reg:
+    description:
+      The cell is the device ID of the GPIO device (VIRTIO_ID_GPIO) as per
+      dt-bindings/virtio/virtio_ids.h.
+    const: 41
+    $ref: /schemas/virtio/mmio.yaml#/properties/reg
+
+  gpio-controller: true
+
+  "#gpio-cells":
+    const: 2
+
+  interrupt-controller: true
+
+  "#interrupt-cells":
+    const: 2
+
+required:
+  - reg
+  - gpio-controller
+  - "#gpio-cells"
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/virtio/virtio_ids.h>
+
+    virtio@3000 {
+        compatible = "virtio,mmio";
+        reg = <0x3000 0x100>;
+        interrupts = <41>;
+
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        gpio-virtio@0 {
+            reg = <VIRTIO_ID_GPIO>;
+            gpio-controller;
+            #gpio-cells = <2>;
+            interrupt-controller;
+            #interrupt-cells = <2>;
+        };
+    };
+
+...