xref: /linux/Documentation/devicetree/bindings/mfd/syscon.yaml (revision 416f99c3b16f582a3fc6d64a1f77f39d94b76de5)
1# SPDX-License-Identifier: GPL-2.0
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/mfd/syscon.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: System Controller Devices
8
9description: |
10  System controller node represents a register region containing a set
11  of miscellaneous registers. The registers are not cohesive enough to
12  represent as any specific type of device. The typical use-case is
13  for some other node's driver, or platform-specific code, to acquire
14  a reference to the syscon node (e.g. by phandle, node path, or
15  search using a specific compatible value), interrogate the node (or
16  associated OS driver) to determine the location of the registers,
17  and access the registers directly.
18
19maintainers:
20  - Lee Jones <lee@kernel.org>
21
22# Need a select with all compatibles listed for compatibility with older
23# dtschema (<2024.02), so this will not be selected for other schemas having
24# syscon fallback.
25select:
26  properties:
27    compatible:
28      contains:
29        enum:
30          - airoha,en7581-pbus-csr
31          - al,alpine-sysfabric-service
32          - allwinner,sun8i-a83t-system-controller
33          - allwinner,sun8i-h3-system-controller
34          - allwinner,sun8i-v3s-system-controller
35          - allwinner,sun50i-a64-system-controller
36          - altr,l3regs
37          - altr,sdr-ctl
38          - amd,pensando-elba-syscon
39          - amlogic,meson-mx-assist
40          - amlogic,meson-mx-bootrom
41          - amlogic,meson8-analog-top
42          - amlogic,meson8b-analog-top
43          - amlogic,meson8-pmu
44          - amlogic,meson8b-pmu
45          - apm,merlin-poweroff-mailbox
46          - apm,mustang-poweroff-mailbox
47          - apm,xgene-csw
48          - apm,xgene-efuse
49          - apm,xgene-mcb
50          - apm,xgene-rb
51          - apm,xgene-scu
52          - atmel,sama5d2-sfrbu
53          - atmel,sama5d3-nfc-io
54          - atmel,sama5d3-sfrbu
55          - atmel,sama5d4-sfrbu
56          - axis,artpec6-syscon
57          - brcm,cru-clkset
58          - brcm,sr-cdru
59          - brcm,sr-mhb
60          - cirrus,ep7209-syscon1
61          - cirrus,ep7209-syscon2
62          - cirrus,ep7209-syscon3
63          - cnxt,cx92755-uc
64          - freecom,fsg-cs2-system-controller
65          - fsl,imx93-aonmix-ns-syscfg
66          - fsl,imx93-wakeupmix-syscfg
67          - fsl,ls1088a-reset
68          - fsl,vf610-anatop
69          - fsl,vf610-mscm-cpucfg
70          - hisilicon,dsa-subctrl
71          - hisilicon,hi6220-sramctrl
72          - hisilicon,hip04-ppe
73          - hisilicon,pcie-sas-subctrl
74          - hisilicon,peri-subctrl
75          - hpe,gxp-sysreg
76          - loongson,ls1b-syscon
77          - loongson,ls1c-syscon
78          - lsi,axxia-syscon
79          - marvell,armada-3700-cpu-misc
80          - marvell,armada-3700-nb-pm
81          - marvell,armada-3700-avs
82          - marvell,armada-3700-usb2-host-device-misc
83          - marvell,armada-3700-usb2-host-misc
84          - marvell,dove-global-config
85          - mediatek,mt2701-pctl-a-syscfg
86          - mediatek,mt2712-pctl-a-syscfg
87          - mediatek,mt6397-pctl-pmic-syscfg
88          - mediatek,mt7981-topmisc
89          - mediatek,mt7988-topmisc
90          - mediatek,mt8135-pctl-a-syscfg
91          - mediatek,mt8135-pctl-b-syscfg
92          - mediatek,mt8173-pctl-a-syscfg
93          - mediatek,mt8365-syscfg
94          - microchip,lan966x-cpu-syscon
95          - microchip,mpfs-control-scb
96          - microchip,mpfs-sysreg-scb
97          - microchip,sam9x60-sfr
98          - microchip,sama7d65-ddr3phy
99          - microchip,sama7d65-sfrbu
100          - microchip,sama7g5-ddr3phy
101          - mscc,ocelot-cpu-syscon
102          - mstar,msc313-pmsleep
103          - nuvoton,ma35d1-sys
104          - nuvoton,wpcm450-shm
105          - qcom,apq8064-mmss-sfpb
106          - qcom,apq8064-sps-sic
107          - rockchip,px30-qos
108          - rockchip,rk3036-qos
109          - rockchip,rk3066-qos
110          - rockchip,rk3128-qos
111          - rockchip,rk3228-qos
112          - rockchip,rk3288-qos
113          - rockchip,rk3368-qos
114          - rockchip,rk3399-qos
115          - rockchip,rk3528-qos
116          - rockchip,rk3562-qos
117          - rockchip,rk3568-qos
118          - rockchip,rk3576-qos
119          - rockchip,rk3588-qos
120          - rockchip,rv1126-qos
121          - st,spear1340-misc
122          - stericsson,nomadik-pmu
123          - starfive,jh7100-sysmain
124          - ti,am62-opp-efuse-table
125          - ti,am62-usb-phy-ctrl
126          - ti,am625-dss-oldi-io-ctrl
127          - ti,am62p-cpsw-mac-efuse
128          - ti,am654-dss-oldi-io-ctrl
129          - ti,j784s4-acspcie-proxy-ctrl
130          - ti,j784s4-pcie-ctrl
131          - ti,keystone-pllctrl
132  required:
133    - compatible
134
135properties:
136  compatible:
137    oneOf:
138      - items:
139          - enum:
140              - airoha,en7581-pbus-csr
141              - al,alpine-sysfabric-service
142              - allwinner,sun8i-a83t-system-controller
143              - allwinner,sun8i-h3-system-controller
144              - allwinner,sun8i-v3s-system-controller
145              - allwinner,sun50i-a64-system-controller
146              - altr,l3regs
147              - altr,sdr-ctl
148              - amd,pensando-elba-syscon
149              - amlogic,meson-mx-assist
150              - amlogic,meson-mx-bootrom
151              - amlogic,meson8-analog-top
152              - amlogic,meson8b-analog-top
153              - amlogic,meson8-pmu
154              - amlogic,meson8b-pmu
155              - apm,merlin-poweroff-mailbox
156              - apm,mustang-poweroff-mailbox
157              - apm,xgene-csw
158              - apm,xgene-efuse
159              - apm,xgene-mcb
160              - apm,xgene-rb
161              - apm,xgene-scu
162              - atmel,sama5d2-sfrbu
163              - atmel,sama5d3-nfc-io
164              - atmel,sama5d3-sfrbu
165              - atmel,sama5d4-sfrbu
166              - axis,artpec6-syscon
167              - brcm,cru-clkset
168              - brcm,sr-cdru
169              - brcm,sr-mhb
170              - cirrus,ep7209-syscon1
171              - cirrus,ep7209-syscon2
172              - cirrus,ep7209-syscon3
173              - cnxt,cx92755-uc
174              - freecom,fsg-cs2-system-controller
175              - fsl,imx93-aonmix-ns-syscfg
176              - fsl,imx93-wakeupmix-syscfg
177              - fsl,ls1088a-reset
178              - fsl,vf610-anatop
179              - fsl,vf610-mscm-cpucfg
180              - hisilicon,dsa-subctrl
181              - hisilicon,hi6220-sramctrl
182              - hisilicon,hip04-ppe
183              - hisilicon,pcie-sas-subctrl
184              - hisilicon,peri-subctrl
185              - hpe,gxp-sysreg
186              - loongson,ls1b-syscon
187              - loongson,ls1c-syscon
188              - lsi,axxia-syscon
189              - marvell,armada-3700-cpu-misc
190              - marvell,armada-3700-nb-pm
191              - marvell,armada-3700-avs
192              - marvell,armada-3700-usb2-host-device-misc
193              - marvell,armada-3700-usb2-host-misc
194              - marvell,dove-global-config
195              - mediatek,mt2701-pctl-a-syscfg
196              - mediatek,mt2712-pctl-a-syscfg
197              - mediatek,mt6397-pctl-pmic-syscfg
198              - mediatek,mt7988-topmisc
199              - mediatek,mt8135-pctl-a-syscfg
200              - mediatek,mt8135-pctl-b-syscfg
201              - mediatek,mt8173-pctl-a-syscfg
202              - mediatek,mt8365-infracfg-nao
203              - mediatek,mt8365-syscfg
204              - microchip,lan966x-cpu-syscon
205              - microchip,mpfs-control-scb
206              - microchip,mpfs-sysreg-scb
207              - microchip,sam9x60-sfr
208              - microchip,sama7d65-ddr3phy
209              - microchip,sama7d65-sfrbu
210              - microchip,sama7g5-ddr3phy
211              - mscc,ocelot-cpu-syscon
212              - mstar,msc313-pmsleep
213              - nuvoton,ma35d1-sys
214              - nuvoton,wpcm450-shm
215              - qcom,apq8064-mmss-sfpb
216              - qcom,apq8064-sps-sic
217              - rockchip,px30-qos
218              - rockchip,rk3036-qos
219              - rockchip,rk3066-qos
220              - rockchip,rk3128-qos
221              - rockchip,rk3228-qos
222              - rockchip,rk3288-qos
223              - rockchip,rk3368-qos
224              - rockchip,rk3399-qos
225              - rockchip,rk3528-qos
226              - rockchip,rk3562-qos
227              - rockchip,rk3568-qos
228              - rockchip,rk3576-qos
229              - rockchip,rk3588-qos
230              - rockchip,rv1126-qos
231              - st,spear1340-misc
232              - stericsson,nomadik-pmu
233              - starfive,jh7100-sysmain
234              - ti,am62-opp-efuse-table
235              - ti,am62-usb-phy-ctrl
236              - ti,am625-dss-oldi-io-ctrl
237              - ti,am62p-cpsw-mac-efuse
238              - ti,am654-dss-oldi-io-ctrl
239              - ti,j784s4-acspcie-proxy-ctrl
240              - ti,j784s4-pcie-ctrl
241              - ti,keystone-pllctrl
242          - const: syscon
243      - items:
244          - enum:
245              - microchip,sama7g5-sfrbu
246              - microchip,sama7d65-sfrbu
247          - const: atmel,sama5d2-sfrbu
248          - const: syscon
249      - items:
250          - const: microchip,pic64gx-control-scb
251          - const: microchip,mpfs-control-scb
252          - const: syscon
253      - items:
254          - const: microchip,pic64gx-sysreg-scb
255          - const: microchip,mpfs-sysreg-scb
256          - const: syscon
257
258  reg:
259    maxItems: 1
260
261  resets:
262    maxItems: 1
263
264required:
265  - compatible
266  - reg
267
268allOf:
269  - $ref: syscon-common.yaml#
270
271unevaluatedProperties: false
272
273examples:
274  - |
275    syscon: syscon@1c00000 {
276        compatible = "allwinner,sun8i-h3-system-controller", "syscon";
277        reg = <0x01c00000 0x1000>;
278    };
279...
280