xref: /linux/Documentation/devicetree/bindings/mfd/syscon.yaml (revision c94ee67abd9d22d2f8cff93b3581d99695babe9f)
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 Registers R/W
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
22select:
23  properties:
24    compatible:
25      contains:
26        enum:
27          - syscon
28
29  required:
30    - compatible
31
32properties:
33  compatible:
34    anyOf:
35      - items:
36          - enum:
37              - allwinner,sun8i-a83t-system-controller
38              - allwinner,sun8i-h3-system-controller
39              - allwinner,sun8i-v3s-system-controller
40              - allwinner,sun50i-a64-system-controller
41              - altr,sdr-ctl
42              - amd,pensando-elba-syscon
43              - apm,xgene-csw
44              - apm,xgene-efuse
45              - apm,xgene-mcb
46              - apm,xgene-rb
47              - apm,xgene-scu
48              - brcm,cru-clkset
49              - brcm,sr-cdru
50              - brcm,sr-mhb
51              - freecom,fsg-cs2-system-controller
52              - fsl,imx93-aonmix-ns-syscfg
53              - fsl,imx93-wakeupmix-syscfg
54              - fsl,ls1088a-reset
55              - hisilicon,dsa-subctrl
56              - hisilicon,hi6220-sramctrl
57              - hisilicon,pcie-sas-subctrl
58              - hisilicon,peri-subctrl
59              - hpe,gxp-sysreg
60              - loongson,ls1b-syscon
61              - loongson,ls1c-syscon
62              - marvell,armada-3700-cpu-misc
63              - marvell,armada-3700-nb-pm
64              - marvell,armada-3700-avs
65              - marvell,armada-3700-usb2-host-misc
66              - mediatek,mt2712-pctl-a-syscfg
67              - mediatek,mt6397-pctl-pmic-syscfg
68              - mediatek,mt8135-pctl-a-syscfg
69              - mediatek,mt8135-pctl-b-syscfg
70              - mediatek,mt8173-pctl-a-syscfg
71              - mediatek,mt8365-syscfg
72              - microchip,lan966x-cpu-syscon
73              - microchip,sparx5-cpu-syscon
74              - mstar,msc313-pmsleep
75              - nuvoton,ma35d1-sys
76              - nuvoton,wpcm450-shm
77              - rockchip,px30-qos
78              - rockchip,rk3036-qos
79              - rockchip,rk3066-qos
80              - rockchip,rk3128-qos
81              - rockchip,rk3228-qos
82              - rockchip,rk3288-qos
83              - rockchip,rk3368-qos
84              - rockchip,rk3399-qos
85              - rockchip,rk3568-qos
86              - rockchip,rk3588-qos
87              - rockchip,rv1126-qos
88              - starfive,jh7100-sysmain
89              - ti,am62-usb-phy-ctrl
90              - ti,am62p-cpsw-mac-efuse
91              - ti,am654-dss-oldi-io-ctrl
92              - ti,am654-serdes-ctrl
93              - ti,j784s4-pcie-ctrl
94
95          - const: syscon
96
97      - contains:
98          const: syscon
99        minItems: 2
100        maxItems: 5  # Should be enough
101
102  reg:
103    maxItems: 1
104
105  reg-io-width:
106    description: |
107      The size (in bytes) of the IO accesses that should be performed
108      on the device.
109    enum: [1, 2, 4, 8]
110
111  resets:
112    maxItems: 1
113
114required:
115  - compatible
116  - reg
117
118allOf:
119  - if:
120      properties:
121        compatible:
122          contains:
123            const: simple-mfd
124    then:
125      properties:
126        compatible:
127          minItems: 3
128          maxItems: 5
129
130additionalProperties: true
131
132examples:
133  - |
134    syscon: syscon@1c00000 {
135        compatible = "allwinner,sun8i-h3-system-controller", "syscon";
136        reg = <0x01c00000 0x1000>;
137    };
138...
139