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 Device Tree Bindings
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.jones@linaro.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              - hisilicon,dsa-subctrl
43              - hisilicon,hi6220-sramctrl
44              - hisilicon,pcie-sas-subctrl
45              - hisilicon,peri-subctrl
46              - microchip,sparx5-cpu-syscon
47              - mstar,msc313-pmsleep
48              - rockchip,px30-qos
49              - rockchip,rk3036-qos
50              - rockchip,rk3066-qos
51              - rockchip,rk3228-qos
52              - rockchip,rk3288-qos
53              - rockchip,rk3368-qos
54              - rockchip,rk3399-qos
55              - rockchip,rk3568-qos
56              - samsung,exynos3-sysreg
57              - samsung,exynos4-sysreg
58              - samsung,exynos5-sysreg
59              - samsung,exynos5433-sysreg
60              - samsung,exynosautov9-sysreg
61
62          - const: syscon
63
64      - contains:
65          const: syscon
66        minItems: 2
67        maxItems: 4  # Should be enough
68
69  reg:
70    maxItems: 1
71
72  reg-io-width:
73    description: |
74      The size (in bytes) of the IO accesses that should be performed
75      on the device.
76    $ref: /schemas/types.yaml#/definitions/uint32
77    enum: [1, 2, 4, 8]
78
79  hwlocks:
80    maxItems: 1
81    description:
82      Reference to a phandle of a hardware spinlock provider node.
83
84required:
85  - compatible
86  - reg
87
88additionalProperties: true
89
90examples:
91  - |
92    syscon: syscon@1c00000 {
93        compatible = "allwinner,sun8i-h3-system-controller", "syscon";
94        reg = <0x01c00000 0x1000>;
95    };
96
97  - |
98    gpr: iomuxc-gpr@20e0000 {
99        compatible = "fsl,imx6q-iomuxc-gpr", "syscon";
100        reg = <0x020e0000 0x38>;
101        hwlocks = <&hwlock1 1>;
102    };
103
104...
105