xref: /linux/Documentation/devicetree/bindings/mfd/syscon.yaml (revision a126eca844353360ebafa9088d22865cb8e022e3) 
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              - intel,lgm-syscon
61              - loongson,ls1b-syscon
62              - loongson,ls1c-syscon
63              - marvell,armada-3700-cpu-misc
64              - marvell,armada-3700-nb-pm
65              - marvell,armada-3700-avs
66              - marvell,armada-3700-usb2-host-misc
67              - mediatek,mt2712-pctl-a-syscfg
68              - mediatek,mt6397-pctl-pmic-syscfg
69              - mediatek,mt8135-pctl-a-syscfg
70              - mediatek,mt8135-pctl-b-syscfg
71              - mediatek,mt8173-pctl-a-syscfg
72              - mediatek,mt8365-syscfg
73              - microchip,lan966x-cpu-syscon
74              - microchip,sparx5-cpu-syscon
75              - mstar,msc313-pmsleep
76              - nuvoton,ma35d1-sys
77              - nuvoton,wpcm450-shm
78              - rockchip,px30-qos
79              - rockchip,rk3036-qos
80              - rockchip,rk3066-qos
81              - rockchip,rk3128-qos
82              - rockchip,rk3228-qos
83              - rockchip,rk3288-qos
84              - rockchip,rk3368-qos
85              - rockchip,rk3399-qos
86              - rockchip,rk3568-qos
87              - rockchip,rk3588-qos
88              - rockchip,rv1126-qos
89              - starfive,jh7100-sysmain
90              - ti,am62-usb-phy-ctrl
91              - ti,am62p-cpsw-mac-efuse
92              - ti,am654-dss-oldi-io-ctrl
93              - ti,am654-serdes-ctrl
94              - ti,j784s4-pcie-ctrl
95
96          - const: syscon
97
98      - contains:
99          const: syscon
100        minItems: 2
101        maxItems: 5  # Should be enough
102
103  reg:
104    maxItems: 1
105
106  reg-io-width:
107    description: |
108      The size (in bytes) of the IO accesses that should be performed
109      on the device.
110    enum: [1, 2, 4, 8]
111
112  resets:
113    maxItems: 1
114
115  hwlocks:
116    maxItems: 1
117    description:
118      Reference to a phandle of a hardware spinlock provider node.
119
120required:
121  - compatible
122  - reg
123
124allOf:
125  - if:
126      properties:
127        compatible:
128          contains:
129            const: simple-mfd
130    then:
131      properties:
132        compatible:
133          minItems: 3
134          maxItems: 5
135
136additionalProperties: true
137
138examples:
139  - |
140    syscon: syscon@1c00000 {
141        compatible = "allwinner,sun8i-h3-system-controller", "syscon";
142        reg = <0x01c00000 0x1000>;
143    };
144...
145