xref: /freebsd/sys/contrib/device-tree/Bindings/mfd/syscon.yaml (revision 734e82fe33aa764367791a7d603b383996c6b40b) 
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              - marvell,armada-3700-usb2-host-misc
53              - mediatek,mt8135-pctl-a-syscfg
54              - mediatek,mt8135-pctl-b-syscfg
55              - mediatek,mt8365-syscfg
56              - microchip,lan966x-cpu-syscon
57              - microchip,sparx5-cpu-syscon
58              - mstar,msc313-pmsleep
59              - nuvoton,ma35d1-sys
60              - nuvoton,wpcm450-shm
61              - rockchip,px30-qos
62              - rockchip,rk3036-qos
63              - rockchip,rk3066-qos
64              - rockchip,rk3228-qos
65              - rockchip,rk3288-qos
66              - rockchip,rk3368-qos
67              - rockchip,rk3399-qos
68              - rockchip,rk3568-qos
69              - rockchip,rk3588-qos
70              - rockchip,rv1126-qos
71              - starfive,jh7100-sysmain
72
73          - const: syscon
74
75      - contains:
76          const: syscon
77        minItems: 2
78        maxItems: 5  # Should be enough
79
80  reg:
81    maxItems: 1
82
83  reg-io-width:
84    description: |
85      The size (in bytes) of the IO accesses that should be performed
86      on the device.
87    enum: [1, 2, 4, 8]
88
89  resets:
90    maxItems: 1
91
92  hwlocks:
93    maxItems: 1
94    description:
95      Reference to a phandle of a hardware spinlock provider node.
96
97required:
98  - compatible
99  - reg
100
101allOf:
102  - if:
103      properties:
104        compatible:
105          contains:
106            const: simple-mfd
107    then:
108      properties:
109        compatible:
110          minItems: 3
111          maxItems: 5
112
113additionalProperties: true
114
115examples:
116  - |
117    syscon: syscon@1c00000 {
118        compatible = "allwinner,sun8i-h3-system-controller", "syscon";
119        reg = <0x01c00000 0x1000>;
120    };
121...
122