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