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