[v5,1/6] dt-bindings: arm: keystone: Add common TI SCI bindings

Commit Message

Suman Anna July 21, 2020, 10:36 p.m. UTC

Add a bindings document that defines the common TI SCI properties
used by various K3 device management nodes such as clock controllers,
interrupt controllers, reset controllers or remoteproc devices.

The required properties for each device management node shall be
specified in the respective binding document.

Signed-off-by: Suman Anna <[e-mail]>
---
v5:
 - New patch refactored out for usage by remoteproc and other TI SCI
   interrupt controller bindings
 - Patch based on remoteproc ti,k3-sci-proc.yaml binding (v4 patch 3)
   with revised overall description and ti,sci-dev-id and no required
   properties
v4: https://patchwork.kernel.org/patch/11671455/
 - Addressed both of Rob's review comments on ti,sci-proc-ids property
v3: https://patchwork.kernel.org/patch/11602317/

 .../arm/keystone/ti,k3-sci-common.yaml        | 44 +++++++++++++++++++
 MAINTAINERS                                   |  1 +
 2 files changed, 45 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/arm/keystone/ti,k3-sci-common.yaml

Comments

Rob Herring (Arm) July 23, 2020, 5:02 p.m. UTC | #1

On Tue, 21 Jul 2020 17:36:12 -0500, Suman Anna wrote:
> Add a bindings document that defines the common TI SCI properties
> used by various K3 device management nodes such as clock controllers,
> interrupt controllers, reset controllers or remoteproc devices.
> 
> The required properties for each device management node shall be
> specified in the respective binding document.
> 
> Signed-off-by: Suman Anna <[e-mail]>
> ---
> v5:
>  - New patch refactored out for usage by remoteproc and other TI SCI
>    interrupt controller bindings
>  - Patch based on remoteproc ti,k3-sci-proc.yaml binding (v4 patch 3)
>    with revised overall description and ti,sci-dev-id and no required
>    properties
> v4: https://patchwork.kernel.org/patch/11671455/
>  - Addressed both of Rob's review comments on ti,sci-proc-ids property
> v3: https://patchwork.kernel.org/patch/11602317/
> 
>  .../arm/keystone/ti,k3-sci-common.yaml        | 44 +++++++++++++++++++
>  MAINTAINERS                                   |  1 +
>  2 files changed, 45 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/arm/keystone/ti,k3-sci-common.yaml
> 

Reviewed-by: Rob Herring <[e-mail]>

Patch

diff --git a/Documentation/devicetree/bindings/arm/keystone/ti,k3-sci-common.yaml b/Documentation/devicetree/bindings/arm/keystone/ti,k3-sci-common.yaml
new file mode 100644
index 000000000000..7597bc93a55f
--- /dev/null
+++ b/Documentation/devicetree/bindings/arm/keystone/ti,k3-sci-common.yaml
@@ -0,0 +1,44 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only or BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/arm/keystone/ti,k3-sci-common.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Common K3 TI-SCI bindings
+
+maintainers:
+  - Nishanth Menon <[e-mail]>
+
+description: |
+  The TI K3 family of SoCs usually have a central System Controller Processor
+  that is responsible for managing various SoC-level resources like clocks,
+  resets, interrupts etc. The communication with that processor is performed
+  through the TI-SCI protocol.
+
+  Each specific device management node like a clock controller node, a reset
+  controller node or an interrupt-controller node should define a common set
+  of properties that enables them to implement the corresponding functionality
+  over the TI-SCI protocol. The following are some of the common properties
+  needed by such individual nodes. The required properties for each device
+  management node is defined in the respective binding.
+
+properties:
+  ti,sci:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description:
+      Should be a phandle to the TI-SCI System Controller node
+
+  ti,sci-dev-id:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      Should contain the TI-SCI device id corresponding to the device. Please
+      refer to the corresponding System Controller documentation for valid
+      values for the desired device.
+
+  ti,sci-proc-ids:
+    description: Should contain a single tuple of <proc_id host_id>.
+    $ref: /schemas/types.yaml#/definitions/uint32-array
+    items:
+      - description: TI-SCI processor id for the remote processor device
+      - description: TI-SCI host id to which processor control ownership
+                     should be transferred to
diff --git a/MAINTAINERS b/MAINTAINERS
index d53db30d1365..61ab0b7ed54d 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -16902,6 +16902,7 @@  M:	Tero Kristo <[e-mail]>
 M:	Santosh Shilimkar <[e-mail]>
 L:	[e-mail]
 S:	Maintained
+F:	Documentation/devicetree/bindings/arm/keystone/ti,k3-sci-common.yaml
 F:	Documentation/devicetree/bindings/arm/keystone/ti,sci.txt
 F:	Documentation/devicetree/bindings/clock/ti,sci-clk.txt
 F:	Documentation/devicetree/bindings/interrupt-controller/ti,sci-inta.txt