Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
dt-bindings: power: sysc-rmobile: Convert to json-schema
Convert the Renesas R-Mobile System Controller (SYSC) Device Tree
binding documentation to json-schema.
Document missing properties.
Drop consumer example, as it does not belong here.
Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
Link: https://lore.kernel.org/r/22150cfd2ef9d57e84eb53a5dfed8379627a9423.1620119210.git.geert+renesas@glider.be
Signed-off-by: Rob Herring <robh@kernel.org>
authored by
Geert Uytterhoeven
and committed by
Rob Herring
4d92239b
4fa9ee2e
+121
-100
-100
Documentation/devicetree/bindings/power/renesas,sysc-rmobile.txt
-100
Documentation/devicetree/bindings/power/renesas,sysc-rmobile.txt
···
1
-
DT bindings for the Renesas R-Mobile System Controller
2
-
3
-
== System Controller Node ==
4
-
5
-
The R-Mobile System Controller provides the following functions:
6
-
- Boot mode management,
7
-
- Reset generation,
8
-
- Power management.
9
-
10
-
Required properties:
11
-
- compatible: Should be "renesas,sysc-<soctype>", "renesas,sysc-rmobile" as
12
-
fallback.
13
-
Examples with soctypes are:
14
-
- "renesas,sysc-r8a73a4" (R-Mobile APE6)
15
-
- "renesas,sysc-r8a7740" (R-Mobile A1)
16
-
- "renesas,sysc-sh73a0" (SH-Mobile AG5)
17
-
- reg: Two address start and address range blocks for the device:
18
-
- The first block refers to the normally accessible registers,
19
-
- the second block refers to the registers protected by the HPB
20
-
semaphore.
21
-
22
-
Optional nodes:
23
-
- pm-domains: This node contains a hierarchy of PM domain nodes, which should
24
-
match the Power Area Hierarchy in the Power Domain Specifications section of
25
-
the device's datasheet.
26
-
27
-
28
-
== PM Domain Nodes ==
29
-
30
-
Each of the PM domain nodes represents a PM domain, as documented by the
31
-
generic PM domain bindings in
32
-
Documentation/devicetree/bindings/power/power-domain.yaml.
33
-
34
-
The nodes should be named by the real power area names, and thus their names
35
-
should be unique.
36
-
37
-
Required properties:
38
-
- #power-domain-cells: Must be 0.
39
-
40
-
Optional properties:
41
-
- reg: If the PM domain is not always-on, this property must contain the bit
42
-
index number for the corresponding power area in the various Power
43
-
Control and Status Registers. The parent's node must contain the
44
-
following two properties:
45
-
- #address-cells: Must be 1,
46
-
- #size-cells: Must be 0.
47
-
If the PM domain is always-on, this property must be omitted.
48
-
49
-
50
-
Example:
51
-
52
-
This shows a subset of the r8a7740 PM domain hierarchy, containing the
53
-
C5 "always-on" domain, 2 of its subdomains (A4S and A4SU), and the A3SP domain,
54
-
which is a subdomain of A4S.
55
-
56
-
sysc: system-controller@e6180000 {
57
-
compatible = "renesas,sysc-r8a7740", "renesas,sysc-rmobile";
58
-
reg = <0xe6180000 0x8000>, <0xe6188000 0x8000>;
59
-
60
-
pm-domains {
61
-
pd_c5: c5 {
62
-
#address-cells = <1>;
63
-
#size-cells = <0>;
64
-
#power-domain-cells = <0>;
65
-
66
-
pd_a4s: a4s@10 {
67
-
reg = <10>;
68
-
#address-cells = <1>;
69
-
#size-cells = <0>;
70
-
#power-domain-cells = <0>;
71
-
72
-
pd_a3sp: a3sp@11 {
73
-
reg = <11>;
74
-
#power-domain-cells = <0>;
75
-
};
76
-
};
77
-
78
-
pd_a4su: a4su@20 {
79
-
reg = <20>;
80
-
#power-domain-cells = <0>;
81
-
};
82
-
};
83
-
};
84
-
};
85
-
86
-
87
-
== PM Domain Consumers ==
88
-
89
-
Hardware blocks belonging to a PM domain should contain a "power-domains"
90
-
property that is a phandle pointing to the corresponding PM domain node.
91
-
92
-
Example:
93
-
94
-
tpu: pwm@e6600000 {
95
-
compatible = "renesas,tpu-r8a7740", "renesas,tpu";
96
-
reg = <0xe6600000 0x100>;
97
-
clocks = <&mstp3_clks R8A7740_CLK_TPU0>;
98
-
power-domains = <&pd_a3sp>;
99
-
#pwm-cells = <3>;
100
-
};
+121
Documentation/devicetree/bindings/power/renesas,sysc-rmobile.yaml
+121
Documentation/devicetree/bindings/power/renesas,sysc-rmobile.yaml
···
1
+
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2
+
%YAML 1.2
3
+
---
4
+
$id: http://devicetree.org/schemas/power/renesas,sysc-rmobile.yaml#
5
+
$schema: http://devicetree.org/meta-schemas/core.yaml#
6
+
7
+
title: Renesas R-Mobile System Controller
8
+
9
+
maintainers:
10
+
- Geert Uytterhoeven <geert+renesas@glider.be>
11
+
- Magnus Damm <magnus.damm@gmail.com>
12
+
13
+
description: |
14
+
The R-Mobile System Controller provides the following functions:
15
+
- Boot mode management,
16
+
- Reset generation,
17
+
- Power management.
18
+
19
+
properties:
20
+
compatible:
21
+
items:
22
+
- enum:
23
+
- renesas,sysc-r8a73a4 # R-Mobile APE6
24
+
- renesas,sysc-r8a7740 # R-Mobile A1
25
+
- renesas,sysc-sh73a0 # SH-Mobile AG5
26
+
- const: renesas,sysc-rmobile # Generic SH/R-Mobile
27
+
28
+
reg:
29
+
items:
30
+
- description: Normally accessible register block
31
+
- description: Register block protected by the HPB semaphore
32
+
33
+
pm-domains:
34
+
type: object
35
+
description: |
36
+
This node contains a hierarchy of PM domain nodes, which should match the
37
+
Power Area Hierarchy in the Power Domain Specifications section of the
38
+
device's datasheet.
39
+
40
+
properties:
41
+
'#address-cells':
42
+
const: 1
43
+
44
+
'#size-cells':
45
+
const: 0
46
+
47
+
additionalProperties:
48
+
$ref: "#/$defs/pd-node"
49
+
50
+
required:
51
+
- compatible
52
+
- reg
53
+
- pm-domains
54
+
55
+
additionalProperties: false
56
+
57
+
$defs:
58
+
pd-node:
59
+
type: object
60
+
description:
61
+
PM domain node representing a PM domain. This node hould be named by
62
+
the real power area name, and thus its name should be unique.
63
+
64
+
properties:
65
+
reg:
66
+
maxItems: 1
67
+
description:
68
+
If the PM domain is not always-on, this property must contain the
69
+
bit index number for the corresponding power area in the various
70
+
Power Control and Status Registers.
71
+
If the PM domain is always-on, this property must be omitted.
72
+
73
+
'#address-cells':
74
+
const: 1
75
+
76
+
'#size-cells':
77
+
const: 0
78
+
79
+
'#power-domain-cells':
80
+
const: 0
81
+
82
+
required:
83
+
- '#power-domain-cells'
84
+
85
+
additionalProperties:
86
+
$ref: "#/$defs/pd-node"
87
+
88
+
examples:
89
+
- |
90
+
// This shows a subset of the r8a7740 PM domain hierarchy, containing the
91
+
// C5 "always-on" domain, 2 of its subdomains (A4S and A4SU), and the A3SP
92
+
// domain, which is a subdomain of A4S.
93
+
sysc: system-controller@e6180000 {
94
+
compatible = "renesas,sysc-r8a7740", "renesas,sysc-rmobile";
95
+
reg = <0xe6180000 0x8000>, <0xe6188000 0x8000>;
96
+
97
+
pm-domains {
98
+
pd_c5: c5 {
99
+
#address-cells = <1>;
100
+
#size-cells = <0>;
101
+
#power-domain-cells = <0>;
102
+
103
+
pd_a4s: a4s@10 {
104
+
reg = <10>;
105
+
#address-cells = <1>;
106
+
#size-cells = <0>;
107
+
#power-domain-cells = <0>;
108
+
109
+
pd_a3sp: a3sp@11 {
110
+
reg = <11>;
111
+
#power-domain-cells = <0>;
112
+
};
113
+
};
114
+
115
+
pd_a4su: a4su@20 {
116
+
reg = <20>;
117
+
#power-domain-cells = <0>;
118
+
};
119
+
};
120
+
};
121
+
};