xref: /freebsd/sys/contrib/device-tree/Bindings/mfd/syscon.yaml (revision cb7aa33ac6cd46a5434798e50363136e64f3ae98)
1c66ec88fSEmmanuel Vadot# SPDX-License-Identifier: GPL-2.0
2c66ec88fSEmmanuel Vadot%YAML 1.2
3c66ec88fSEmmanuel Vadot---
4c66ec88fSEmmanuel Vadot$id: http://devicetree.org/schemas/mfd/syscon.yaml#
5c66ec88fSEmmanuel Vadot$schema: http://devicetree.org/meta-schemas/core.yaml#
6c66ec88fSEmmanuel Vadot
77ef62cebSEmmanuel Vadottitle: System Controller Registers R/W
8c66ec88fSEmmanuel Vadot
9c66ec88fSEmmanuel Vadotdescription: |
10c66ec88fSEmmanuel Vadot  System controller node represents a register region containing a set
11c66ec88fSEmmanuel Vadot  of miscellaneous registers. The registers are not cohesive enough to
12c66ec88fSEmmanuel Vadot  represent as any specific type of device. The typical use-case is
13c66ec88fSEmmanuel Vadot  for some other node's driver, or platform-specific code, to acquire
14c66ec88fSEmmanuel Vadot  a reference to the syscon node (e.g. by phandle, node path, or
15c66ec88fSEmmanuel Vadot  search using a specific compatible value), interrogate the node (or
16c66ec88fSEmmanuel Vadot  associated OS driver) to determine the location of the registers,
17c66ec88fSEmmanuel Vadot  and access the registers directly.
18c66ec88fSEmmanuel Vadot
19c66ec88fSEmmanuel Vadotmaintainers:
20b97ee269SEmmanuel Vadot  - Lee Jones <lee@kernel.org>
21c66ec88fSEmmanuel Vadot
22c66ec88fSEmmanuel Vadotselect:
23c66ec88fSEmmanuel Vadot  properties:
24c66ec88fSEmmanuel Vadot    compatible:
25c66ec88fSEmmanuel Vadot      contains:
26c66ec88fSEmmanuel Vadot        enum:
27c66ec88fSEmmanuel Vadot          - syscon
28c66ec88fSEmmanuel Vadot
29c66ec88fSEmmanuel Vadot  required:
30c66ec88fSEmmanuel Vadot    - compatible
31c66ec88fSEmmanuel Vadot
32c66ec88fSEmmanuel Vadotproperties:
33c66ec88fSEmmanuel Vadot  compatible:
34c66ec88fSEmmanuel Vadot    anyOf:
35c66ec88fSEmmanuel Vadot      - items:
36c66ec88fSEmmanuel Vadot          - enum:
37c66ec88fSEmmanuel Vadot              - allwinner,sun8i-a83t-system-controller
38c66ec88fSEmmanuel Vadot              - allwinner,sun8i-h3-system-controller
39c66ec88fSEmmanuel Vadot              - allwinner,sun8i-v3s-system-controller
40c66ec88fSEmmanuel Vadot              - allwinner,sun50i-a64-system-controller
41*cb7aa33aSEmmanuel Vadot              - amd,pensando-elba-syscon
428cc087a1SEmmanuel Vadot              - brcm,cru-clkset
43e67e8565SEmmanuel Vadot              - freecom,fsg-cs2-system-controller
447ef62cebSEmmanuel Vadot              - fsl,imx93-aonmix-ns-syscfg
457ef62cebSEmmanuel Vadot              - fsl,imx93-wakeupmix-syscfg
466be33864SEmmanuel Vadot              - hisilicon,dsa-subctrl
476be33864SEmmanuel Vadot              - hisilicon,hi6220-sramctrl
486be33864SEmmanuel Vadot              - hisilicon,pcie-sas-subctrl
496be33864SEmmanuel Vadot              - hisilicon,peri-subctrl
50*cb7aa33aSEmmanuel Vadot              - hpe,gxp-sysreg
51c9ccf3a3SEmmanuel Vadot              - intel,lgm-syscon
52c9ccf3a3SEmmanuel Vadot              - marvell,armada-3700-usb2-host-misc
53c9ccf3a3SEmmanuel Vadot              - mediatek,mt8135-pctl-a-syscfg
54c9ccf3a3SEmmanuel Vadot              - mediatek,mt8135-pctl-b-syscfg
55*cb7aa33aSEmmanuel Vadot              - mediatek,mt8365-syscfg
56c9ccf3a3SEmmanuel Vadot              - microchip,lan966x-cpu-syscon
57c66ec88fSEmmanuel Vadot              - microchip,sparx5-cpu-syscon
58c66ec88fSEmmanuel Vadot              - mstar,msc313-pmsleep
598bab661aSEmmanuel Vadot              - nuvoton,wpcm450-shm
605def4c47SEmmanuel Vadot              - rockchip,px30-qos
61354d7675SEmmanuel Vadot              - rockchip,rk3036-qos
625def4c47SEmmanuel Vadot              - rockchip,rk3066-qos
63354d7675SEmmanuel Vadot              - rockchip,rk3228-qos
645def4c47SEmmanuel Vadot              - rockchip,rk3288-qos
658cc087a1SEmmanuel Vadot              - rockchip,rk3368-qos
665def4c47SEmmanuel Vadot              - rockchip,rk3399-qos
67354d7675SEmmanuel Vadot              - rockchip,rk3568-qos
687ef62cebSEmmanuel Vadot              - rockchip,rk3588-qos
697ef62cebSEmmanuel Vadot              - rockchip,rv1126-qos
70c66ec88fSEmmanuel Vadot
71c66ec88fSEmmanuel Vadot          - const: syscon
72c66ec88fSEmmanuel Vadot
73c66ec88fSEmmanuel Vadot      - contains:
74c66ec88fSEmmanuel Vadot          const: syscon
75c66ec88fSEmmanuel Vadot        minItems: 2
767ef62cebSEmmanuel Vadot        maxItems: 5  # Should be enough
77c66ec88fSEmmanuel Vadot
78c66ec88fSEmmanuel Vadot  reg:
79c66ec88fSEmmanuel Vadot    maxItems: 1
80c66ec88fSEmmanuel Vadot
81c66ec88fSEmmanuel Vadot  reg-io-width:
82c66ec88fSEmmanuel Vadot    description: |
83c66ec88fSEmmanuel Vadot      The size (in bytes) of the IO accesses that should be performed
84c66ec88fSEmmanuel Vadot      on the device.
85c66ec88fSEmmanuel Vadot    enum: [1, 2, 4, 8]
86c66ec88fSEmmanuel Vadot
87*cb7aa33aSEmmanuel Vadot  resets:
88*cb7aa33aSEmmanuel Vadot    maxItems: 1
89*cb7aa33aSEmmanuel Vadot
90c66ec88fSEmmanuel Vadot  hwlocks:
91c66ec88fSEmmanuel Vadot    maxItems: 1
92c66ec88fSEmmanuel Vadot    description:
93c66ec88fSEmmanuel Vadot      Reference to a phandle of a hardware spinlock provider node.
94c66ec88fSEmmanuel Vadot
95c66ec88fSEmmanuel Vadotrequired:
96c66ec88fSEmmanuel Vadot  - compatible
97c66ec88fSEmmanuel Vadot  - reg
98c66ec88fSEmmanuel Vadot
997ef62cebSEmmanuel VadotallOf:
1007ef62cebSEmmanuel Vadot  - if:
1017ef62cebSEmmanuel Vadot      properties:
1027ef62cebSEmmanuel Vadot        compatible:
1037ef62cebSEmmanuel Vadot          contains:
1047ef62cebSEmmanuel Vadot            const: simple-mfd
1057ef62cebSEmmanuel Vadot    then:
1067ef62cebSEmmanuel Vadot      properties:
1077ef62cebSEmmanuel Vadot        compatible:
1087ef62cebSEmmanuel Vadot          minItems: 3
1097ef62cebSEmmanuel Vadot          maxItems: 5
1107ef62cebSEmmanuel Vadot
1116be33864SEmmanuel VadotadditionalProperties: true
112c66ec88fSEmmanuel Vadot
113c66ec88fSEmmanuel Vadotexamples:
114c66ec88fSEmmanuel Vadot  - |
115c66ec88fSEmmanuel Vadot    syscon: syscon@1c00000 {
116c66ec88fSEmmanuel Vadot        compatible = "allwinner,sun8i-h3-system-controller", "syscon";
117c66ec88fSEmmanuel Vadot        reg = <0x01c00000 0x1000>;
118c66ec88fSEmmanuel Vadot    };
119c66ec88fSEmmanuel Vadot...
120