2022-06-09 07:32:34

by Neeraj Upadhyay

[permalink] [raw]
Subject: [RFC 1/3] dt-bindings: arm: Add document for SCMI Virtio backend device

Document the properties for ARM SCMI Virtio backend device
node.

Signed-off-by: Neeraj Upadhyay <[email protected]>
---
.../firmware/arm,scmi-vio-backend.yaml | 85 +++++++++++++++++++
1 file changed, 85 insertions(+)
create mode 100644 Documentation/devicetree/bindings/firmware/arm,scmi-vio-backend.yaml

diff --git a/Documentation/devicetree/bindings/firmware/arm,scmi-vio-backend.yaml b/Documentation/devicetree/bindings/firmware/arm,scmi-vio-backend.yaml
new file mode 100644
index 000000000000..c95d4e093a3c
--- /dev/null
+++ b/Documentation/devicetree/bindings/firmware/arm,scmi-vio-backend.yaml
@@ -0,0 +1,85 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/firmware/arm,scmi-vio-backend.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: System Control and Management Interface (SCMI) Virtio backend bindings
+
+maintainers:
+ - Neeraj Upadhyay <[email protected]>
+
+description: |
+ This binding defines the interface for configuring the ARM SCMI Virtio
+ backend using device tree.
+
+properties:
+ $nodename:
+ const: scmi-vio-backend
+
+ compatible:
+ const: arm,scmi-vio-backend
+
+ '#address-cells':
+ const: 1
+
+ '#size-cells':
+ const: 0
+
+ protocol@11:
+ type: object
+ properties:
+ reg:
+ const: 0x11
+
+ protocol@13:
+ type: object
+ properties:
+ reg:
+ const: 0x13
+
+ protocol@14:
+ type: object
+ properties:
+ reg:
+ const: 0x14
+
+ protocol@15:
+ type: object
+ properties:
+ reg:
+ const: 0x15
+
+ protocol@16:
+ type: object
+ properties:
+ reg:
+ const: 0x16
+
+ protocol@17:
+ type: object
+ properties:
+ reg:
+ const: 0x17
+
+required:
+ - compatible
+
+examples:
+ - |
+ firmware {
+ scmi-vio-backend {
+ compatible = "arm,scmi-vio-backend";
+
+ scmi_vio_backend_clk: protocol@14 {
+ reg = <0x14>;
+ };
+
+ scmi_vio_backend_voltage: protocol@17 {
+ reg = <0x17>;
+ };
+ };
+ };
+
+...
--
2.17.1


2022-06-13 19:16:20

by Sudeep Holla

[permalink] [raw]
Subject: Re: [RFC 1/3] dt-bindings: arm: Add document for SCMI Virtio backend device

On Thu, Jun 09, 2022 at 12:49:54PM +0530, Neeraj Upadhyay wrote:
> Document the properties for ARM SCMI Virtio backend device
> node.
>
> Signed-off-by: Neeraj Upadhyay <[email protected]>
> ---
> .../firmware/arm,scmi-vio-backend.yaml | 85 +++++++++++++++++++
> 1 file changed, 85 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/firmware/arm,scmi-vio-backend.yaml
>
> diff --git a/Documentation/devicetree/bindings/firmware/arm,scmi-vio-backend.yaml b/Documentation/devicetree/bindings/firmware/arm,scmi-vio-backend.yaml
> new file mode 100644
> index 000000000000..c95d4e093a3c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/firmware/arm,scmi-vio-backend.yaml
> @@ -0,0 +1,85 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/firmware/arm,scmi-vio-backend.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: System Control and Management Interface (SCMI) Virtio backend bindings
> +
> +maintainers:
> + - Neeraj Upadhyay <[email protected]>
> +
> +description: |
> + This binding defines the interface for configuring the ARM SCMI Virtio
> + backend using device tree.
> +
> +properties:
> + $nodename:
> + const: scmi-vio-backend
> +
> + compatible:
> + const: arm,scmi-vio-backend
> +

One only change between this and the existing DT binding is the compatible.
I don't see any explanation here as why this deserves to be separate binding
document. What can't you just add the compatible to the existing one if there
is no other change. If not, please provide details and examples on how it
differs.

--
Regards,
Sudeep