xref: /linux/Documentation/devicetree/bindings/mfd/syscon.yaml (revision 59fff63cc2b75dcfe08f9eeb4b2187d73e53843d) 
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              - amd,pensando-elba-syscon
42              - brcm,cru-clkset
43              - freecom,fsg-cs2-system-controller
44              - fsl,imx93-aonmix-ns-syscfg
45              - fsl,imx93-wakeupmix-syscfg
46              - hisilicon,dsa-subctrl
47              - hisilicon,hi6220-sramctrl
48              - hisilicon,pcie-sas-subctrl
49              - hisilicon,peri-subctrl
50              - hpe,gxp-sysreg
51              - intel,lgm-syscon
52              - loongson,ls1b-syscon
53              - loongson,ls1c-syscon
54              - marvell,armada-3700-usb2-host-misc
55              - mediatek,mt8135-pctl-a-syscfg
56              - mediatek,mt8135-pctl-b-syscfg
57              - mediatek,mt8365-syscfg
58              - microchip,lan966x-cpu-syscon
59              - microchip,sparx5-cpu-syscon
60              - mstar,msc313-pmsleep
61              - nuvoton,ma35d1-sys
62              - nuvoton,wpcm450-shm
63              - rockchip,px30-qos
64              - rockchip,rk3036-qos
65              - rockchip,rk3066-qos
66              - rockchip,rk3228-qos
67              - rockchip,rk3288-qos
68              - rockchip,rk3368-qos
69              - rockchip,rk3399-qos
70              - rockchip,rk3568-qos
71              - rockchip,rk3588-qos
72              - rockchip,rv1126-qos
73              - starfive,jh7100-sysmain
74
75          - const: syscon
76
77      - contains:
78          const: syscon
79        minItems: 2
80        maxItems: 5  # Should be enough
81
82  reg:
83    maxItems: 1
84
85  reg-io-width:
86    description: |
87      The size (in bytes) of the IO accesses that should be performed
88      on the device.
89    enum: [1, 2, 4, 8]
90
91  resets:
92    maxItems: 1
93
94  hwlocks:
95    maxItems: 1
96    description:
97      Reference to a phandle of a hardware spinlock provider node.
98
99required:
100  - compatible
101  - reg
102
103allOf:
104  - if:
105      properties:
106        compatible:
107          contains:
108            const: simple-mfd
109    then:
110      properties:
111        compatible:
112          minItems: 3
113          maxItems: 5
114
115additionalProperties: true
116
117examples:
118  - |
119    syscon: syscon@1c00000 {
120        compatible = "allwinner,sun8i-h3-system-controller", "syscon";
121        reg = <0x01c00000 0x1000>;
122    };
123...
124