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