Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
dt-bindings: bus: ti-sysc: Update to use yaml binding
Update the binding for ti-sysc interconnect target module driver to yaml
format.
Note that the old binding was never updated for the need to always specify
also the generic compatible "ti,sysc". This is needed for the auxdata
for platform clockdomain autoidle related functions.
Cc: Rob Herring <robh@kernel.org>
Cc: Suman Anna <s-anna@ti.com>
Signed-off-by: Tony Lindgren <tony@atomide.com>
Link: https://lore.kernel.org/r/20211015113350.35830-1-tony@atomide.com
[robh: dedupe reg-names and clock-names entries]
Signed-off-by: Rob Herring <robh@kernel.org>
authored by
Tony Lindgren
and committed by
Rob Herring
b63c87a1
f99e2bf5
+216
-139
-139
Documentation/devicetree/bindings/bus/ti-sysc.txt
-139
Documentation/devicetree/bindings/bus/ti-sysc.txt
···
1
-
Texas Instruments sysc interconnect target module wrapper binding
2
-
3
-
Texas Instruments SoCs can have a generic interconnect target module
4
-
hardware for devices connected to various interconnects such as L3
5
-
interconnect (Arteris NoC) and L4 interconnect (Sonics s3220). The sysc
6
-
is mostly used for interaction between module and PRCM. It participates
7
-
in the OCP Disconnect Protocol but other than that is mostly independent
8
-
of the interconnect.
9
-
10
-
Each interconnect target module can have one or more devices connected to
11
-
it. There is a set of control registers for managing interconnect target
12
-
module clocks, idle modes and interconnect level resets for the module.
13
-
14
-
These control registers are sprinkled into the unused register address
15
-
space of the first child device IP block managed by the interconnect
16
-
target module and typically are named REVISION, SYSCONFIG and SYSSTATUS.
17
-
18
-
Required standard properties:
19
-
20
-
- compatible shall be one of the following generic types:
21
-
22
-
"ti,sysc"
23
-
"ti,sysc-omap2"
24
-
"ti,sysc-omap4"
25
-
"ti,sysc-omap4-simple"
26
-
27
-
or one of the following derivative types for hardware
28
-
needing special workarounds:
29
-
30
-
"ti,sysc-omap2-timer"
31
-
"ti,sysc-omap4-timer"
32
-
"ti,sysc-omap3430-sr"
33
-
"ti,sysc-omap3630-sr"
34
-
"ti,sysc-omap4-sr"
35
-
"ti,sysc-omap3-sham"
36
-
"ti,sysc-omap-aes"
37
-
"ti,sysc-mcasp"
38
-
"ti,sysc-dra7-mcasp"
39
-
"ti,sysc-usb-host-fs"
40
-
"ti,sysc-dra7-mcan"
41
-
"ti,sysc-pruss"
42
-
43
-
- reg shall have register areas implemented for the interconnect
44
-
target module in question such as revision, sysc and syss
45
-
46
-
- reg-names shall contain the register names implemented for the
47
-
interconnect target module in question such as
48
-
"rev, "sysc", and "syss"
49
-
50
-
- ranges shall contain the interconnect target module IO range
51
-
available for one or more child device IP blocks managed
52
-
by the interconnect target module, the ranges may include
53
-
multiple ranges such as device L4 range for control and
54
-
parent L3 range for DMA access
55
-
56
-
Optional properties:
57
-
58
-
- ti,sysc-mask shall contain mask of supported register bits for the
59
-
SYSCONFIG register as documented in the Technical Reference
60
-
Manual (TRM) for the interconnect target module
61
-
62
-
- ti,sysc-midle list of master idle modes supported by the interconnect
63
-
target module as documented in the TRM for SYSCONFIG
64
-
register MIDLEMODE bits
65
-
66
-
- ti,sysc-sidle list of slave idle modes supported by the interconnect
67
-
target module as documented in the TRM for SYSCONFIG
68
-
register SIDLEMODE bits
69
-
70
-
- ti,sysc-delay-us delay needed after OCP softreset before accssing
71
-
SYSCONFIG register again
72
-
73
-
- ti,syss-mask optional mask of reset done status bits as described in the
74
-
TRM for SYSSTATUS registers, typically 1 with some devices
75
-
having separate reset done bits for children like OHCI and
76
-
EHCI
77
-
78
-
- clocks clock specifier for each name in the clock-names as
79
-
specified in the binding documentation for ti-clkctrl,
80
-
typically available for all interconnect targets on TI SoCs
81
-
based on omap4 except if it's read-only register in hwauto
82
-
mode as for example omap4 L4_CFG_CLKCTRL
83
-
84
-
- clock-names should contain at least "fck", and optionally also "ick"
85
-
depending on the SoC and the interconnect target module,
86
-
some interconnect target modules also need additional
87
-
optional clocks that can be specified as listed in TRM
88
-
for the related CLKCTRL register bits 8 to 15 such as
89
-
"dbclk" or "clk32k" depending on their role
90
-
91
-
- ti,hwmods optional TI interconnect module name to use legacy
92
-
hwmod platform data
93
-
94
-
- ti,no-reset-on-init interconnect target module should not be reset at init
95
-
96
-
- ti,no-idle-on-init interconnect target module should not be idled at init
97
-
98
-
- ti,no-idle interconnect target module should not be idled
99
-
100
-
Example: Single instance of MUSB controller on omap4 using interconnect ranges
101
-
using offsets from l4_cfg second segment (0x4a000000 + 0x80000 = 0x4a0ab000):
102
-
103
-
target-module@2b000 { /* 0x4a0ab000, ap 84 12.0 */
104
-
compatible = "ti,sysc-omap2";
105
-
ti,hwmods = "usb_otg_hs";
106
-
reg = <0x2b400 0x4>,
107
-
<0x2b404 0x4>,
108
-
<0x2b408 0x4>;
109
-
reg-names = "rev", "sysc", "syss";
110
-
clocks = <&l3_init_clkctrl OMAP4_USB_OTG_HS_CLKCTRL 0>;
111
-
clock-names = "fck";
112
-
ti,sysc-mask = <(SYSC_OMAP2_ENAWAKEUP |
113
-
SYSC_OMAP2_SOFTRESET |
114
-
SYSC_OMAP2_AUTOIDLE)>;
115
-
ti,sysc-midle = <SYSC_IDLE_FORCE>,
116
-
<SYSC_IDLE_NO>,
117
-
<SYSC_IDLE_SMART>;
118
-
ti,sysc-sidle = <SYSC_IDLE_FORCE>,
119
-
<SYSC_IDLE_NO>,
120
-
<SYSC_IDLE_SMART>,
121
-
<SYSC_IDLE_SMART_WKUP>;
122
-
ti,syss-mask = <1>;
123
-
#address-cells = <1>;
124
-
#size-cells = <1>;
125
-
ranges = <0 0x2b000 0x1000>;
126
-
127
-
usb_otg_hs: otg@0 {
128
-
compatible = "ti,omap4-musb";
129
-
reg = <0x0 0x7ff>;
130
-
interrupts = <GIC_SPI 92 IRQ_TYPE_LEVEL_HIGH>,
131
-
<GIC_SPI 93 IRQ_TYPE_LEVEL_HIGH>;
132
-
usb-phy = <&usb2_phy>;
133
-
...
134
-
};
135
-
};
136
-
137
-
Note that other SoCs, such as am335x can have multiple child devices. On am335x
138
-
there are two MUSB instances, two USB PHY instances, and a single CPPI41 DMA
139
-
instance as children of a single interconnect target module.
+216
Documentation/devicetree/bindings/bus/ti-sysc.yaml
+216
Documentation/devicetree/bindings/bus/ti-sysc.yaml
···
1
+
# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2
+
%YAML 1.2
3
+
---
4
+
$id: http://devicetree.org/schemas/bus/ti-sysc.yaml#
5
+
$schema: http://devicetree.org/meta-schemas/core.yaml#
6
+
7
+
title: Texas Instruments interconnect target module binding
8
+
9
+
maintainers:
10
+
- Tony Lindgren <tony@atomide.com>
11
+
12
+
description:
13
+
Texas Instruments SoCs can have a generic interconnect target module
14
+
for devices connected to various interconnects such as L3 interconnect
15
+
using Arteris NoC, and L4 interconnect using Sonics s3220. This module
16
+
is mostly used for interaction between module and Power, Reset and Clock
17
+
Manager PRCM. It participates in the OCP Disconnect Protocol, but other
18
+
than that it is mostly independent of the interconnect.
19
+
20
+
Each interconnect target module can have one or more devices connected to
21
+
it. There is a set of control registers for managing the interconnect target
22
+
module clocks, idle modes and interconnect level resets.
23
+
24
+
The interconnect target module control registers are sprinkled into the
25
+
unused register address space of the first child device IP block managed by
26
+
the interconnect target module. Typically the register names are REVISION,
27
+
SYSCONFIG and SYSSTATUS.
28
+
29
+
properties:
30
+
$nodename:
31
+
pattern: "^target-module(@[0-9a-f]+)?$"
32
+
33
+
compatible:
34
+
oneOf:
35
+
- items:
36
+
- enum:
37
+
- ti,sysc-omap2
38
+
- ti,sysc-omap2
39
+
- ti,sysc-omap4
40
+
- ti,sysc-omap4-simple
41
+
- ti,sysc-omap2-timer
42
+
- ti,sysc-omap4-timer
43
+
- ti,sysc-omap3430-sr
44
+
- ti,sysc-omap3630-sr
45
+
- ti,sysc-omap4-sr
46
+
- ti,sysc-omap3-sham
47
+
- ti,sysc-omap-aes
48
+
- ti,sysc-mcasp
49
+
- ti,sysc-dra7-mcasp
50
+
- ti,sysc-usb-host-fs
51
+
- ti,sysc-dra7-mcan
52
+
- ti,sysc-pruss
53
+
- const: ti,sysc
54
+
- items:
55
+
- const: ti,sysc
56
+
57
+
reg:
58
+
description:
59
+
Interconnect target module control registers consisting of
60
+
REVISION, SYSCONFIG and SYSSTATUS registers as defined in the
61
+
Technical Reference Manual for the SoC.
62
+
minItems: 1
63
+
maxItems: 3
64
+
65
+
reg-names:
66
+
description:
67
+
Interconnect target module control register names consisting
68
+
of "rev", "sysc" and "syss".
69
+
oneOf:
70
+
- minItems: 1
71
+
items:
72
+
- const: rev
73
+
- const: sysc
74
+
- const: syss
75
+
- items:
76
+
- const: rev
77
+
- const: syss
78
+
- enum: [ sysc, syss ]
79
+
80
+
power-domains:
81
+
description: Target module power domain if available.
82
+
maxItems: 1
83
+
84
+
clocks:
85
+
description:
86
+
Target module clocks consisting of one functional clock, one
87
+
interface clock, and up to 8 module specific optional clocks.
88
+
Some modules may have only the functional clock, and some have
89
+
no configurable clocks.
90
+
minItems: 1
91
+
maxItems: 4
92
+
93
+
clock-names:
94
+
description:
95
+
Target module clock names like "fck", "ick", "optck1", "optck2"
96
+
if the clocks are configurable.
97
+
oneOf:
98
+
- enum: [ ick, fck, sys_clk ]
99
+
- items:
100
+
- const: fck
101
+
- enum: [ ick. dbclk, osc, sys_clk, dss_clk, ahclkx ]
102
+
- items:
103
+
- const: fck
104
+
- const: phy-clk
105
+
- const: phy-clk-div
106
+
- items:
107
+
- const: fck
108
+
- const: hdmi_clk
109
+
- const: sys_clk
110
+
- const: tv_clk
111
+
- items:
112
+
- const: fck
113
+
- const: ahclkx
114
+
- const: ahclkr
115
+
116
+
resets:
117
+
description:
118
+
Target module reset bit in the RSTCTRL register if wired for the module.
119
+
Note that the other reset bits should be mapped for the child device
120
+
driver to use.
121
+
maxItems: 1
122
+
123
+
reset-names:
124
+
description:
125
+
Target module reset names in the RSTCTRL register, typically named
126
+
"rstctrl" if only one reset bit is wired for the module.
127
+
items:
128
+
- const: rstctrl
129
+
130
+
'#address-cells':
131
+
enum: [ 1, 2 ]
132
+
133
+
'#size-cells':
134
+
enum: [ 1, 2 ]
135
+
136
+
ranges: true
137
+
138
+
dma-ranges: true
139
+
140
+
ti,sysc-mask:
141
+
description: Mask of supported register bits for the SYSCONFIG register
142
+
$ref: /schemas/types.yaml#/definitions/uint32
143
+
144
+
ti,sysc-midle:
145
+
description: List of hardware supported idle modes
146
+
$ref: /schemas/types.yaml#/definitions/uint32-array
147
+
148
+
ti,sysc-sidle:
149
+
description: List of hardware supported idle modes
150
+
$ref: /schemas/types.yaml#/definitions/uint32-array
151
+
152
+
ti,syss-mask:
153
+
description: Mask of supported register bits for the SYSSTATUS register
154
+
$ref: /schemas/types.yaml#/definitions/uint32
155
+
156
+
ti,sysc-delay-us:
157
+
description: Delay needed after OCP softreset before accessing SYCONFIG
158
+
default: 0
159
+
minimum: 0
160
+
maximum: 2
161
+
162
+
ti,no-reset-on-init:
163
+
description: Interconnect target module shall not be reset at init
164
+
type: boolean
165
+
166
+
ti,no-idle-on-init:
167
+
description: Interconnect target module shall not be idled at init
168
+
type: boolean
169
+
170
+
ti,no-idle:
171
+
description: Interconnect target module shall not be idled
172
+
type: boolean
173
+
174
+
ti,hwmods:
175
+
description: Interconnect module name to use with legacy hwmod data
176
+
$ref: /schemas/types.yaml#/definitions/string
177
+
deprecated: true
178
+
179
+
required:
180
+
- compatible
181
+
- '#address-cells'
182
+
- '#size-cells'
183
+
- ranges
184
+
185
+
additionalProperties:
186
+
type: object
187
+
188
+
examples:
189
+
- |
190
+
#include <dt-bindings/bus/ti-sysc.h>
191
+
#include <dt-bindings/clock/omap4.h>
192
+
193
+
target-module@2b000 {
194
+
compatible = "ti,sysc-omap2", "ti,sysc";
195
+
ti,hwmods = "usb_otg_hs";
196
+
reg = <0x2b400 0x4>,
197
+
<0x2b404 0x4>,
198
+
<0x2b408 0x4>;
199
+
reg-names = "rev", "sysc", "syss";
200
+
clocks = <&l3_init_clkctrl OMAP4_USB_OTG_HS_CLKCTRL 0>;
201
+
clock-names = "fck";
202
+
ti,sysc-mask = <(SYSC_OMAP2_ENAWAKEUP |
203
+
SYSC_OMAP2_SOFTRESET |
204
+
SYSC_OMAP2_AUTOIDLE)>;
205
+
ti,sysc-midle = <SYSC_IDLE_FORCE>,
206
+
<SYSC_IDLE_NO>,
207
+
<SYSC_IDLE_SMART>;
208
+
ti,sysc-sidle = <SYSC_IDLE_FORCE>,
209
+
<SYSC_IDLE_NO>,
210
+
<SYSC_IDLE_SMART>,
211
+
<SYSC_IDLE_SMART_WKUP>;
212
+
ti,syss-mask = <1>;
213
+
#address-cells = <1>;
214
+
#size-cells = <1>;
215
+
ranges = <0 0x2b000 0x1000>;
216
+
};