aboutsummaryrefslogtreecommitdiff
path: root/Documentation/devicetree/bindings/mfd/syscon.yaml
blob: 7ed12a938baa3e73298188ec3bb1d6c98dac15a2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# SPDX-License-Identifier: GPL-2.0
%YAML 1.2
---
$id: http://devicetree.org/schemas/mfd/syscon.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: System Controller Registers R/W

description: |
  System controller node represents a register region containing a set
  of miscellaneous registers. The registers are not cohesive enough to
  represent as any specific type of device. The typical use-case is
  for some other node's driver, or platform-specific code, to acquire
  a reference to the syscon node (e.g. by phandle, node path, or
  search using a specific compatible value), interrogate the node (or
  associated OS driver) to determine the location of the registers,
  and access the registers directly.

maintainers:
  - Lee Jones <lee@kernel.org>

select:
  properties:
    compatible:
      contains:
        enum:
          - syscon

  required:
    - compatible

properties:
  compatible:
    anyOf:
      - items:
          - enum:
              - allwinner,sun8i-a83t-system-controller
              - allwinner,sun8i-h3-system-controller
              - allwinner,sun8i-v3s-system-controller
              - allwinner,sun50i-a64-system-controller
              - altr,sdr-ctl
              - amd,pensando-elba-syscon
              - apm,xgene-csw
              - apm,xgene-efuse
              - apm,xgene-mcb
              - apm,xgene-rb
              - apm,xgene-scu
              - brcm,cru-clkset
              - brcm,sr-cdru
              - brcm,sr-mhb
              - freecom,fsg-cs2-system-controller
              - fsl,imx93-aonmix-ns-syscfg
              - fsl,imx93-wakeupmix-syscfg
              - fsl,ls1088a-reset
              - hisilicon,dsa-subctrl
              - hisilicon,hi6220-sramctrl
              - hisilicon,pcie-sas-subctrl
              - hisilicon,peri-subctrl
              - hpe,gxp-sysreg
              - intel,lgm-syscon
              - loongson,ls1b-syscon
              - loongson,ls1c-syscon
              - marvell,armada-3700-cpu-misc
              - marvell,armada-3700-nb-pm
              - marvell,armada-3700-avs
              - marvell,armada-3700-usb2-host-misc
              - mediatek,mt2712-pctl-a-syscfg
              - mediatek,mt6397-pctl-pmic-syscfg
              - mediatek,mt8135-pctl-a-syscfg
              - mediatek,mt8135-pctl-b-syscfg
              - mediatek,mt8173-pctl-a-syscfg
              - mediatek,mt8365-syscfg
              - microchip,lan966x-cpu-syscon
              - microchip,sparx5-cpu-syscon
              - mstar,msc313-pmsleep
              - nuvoton,ma35d1-sys
              - nuvoton,wpcm450-shm
              - rockchip,px30-qos
              - rockchip,rk3036-qos
              - rockchip,rk3066-qos
              - rockchip,rk3128-qos
              - rockchip,rk3228-qos
              - rockchip,rk3288-qos
              - rockchip,rk3368-qos
              - rockchip,rk3399-qos
              - rockchip,rk3568-qos
              - rockchip,rk3588-qos
              - rockchip,rv1126-qos
              - starfive,jh7100-sysmain
              - ti,am62-usb-phy-ctrl
              - ti,am62p-cpsw-mac-efuse
              - ti,am654-dss-oldi-io-ctrl
              - ti,am654-serdes-ctrl
              - ti,j784s4-pcie-ctrl

          - const: syscon

      - contains:
          const: syscon
        minItems: 2
        maxItems: 5  # Should be enough

  reg:
    maxItems: 1

  reg-io-width:
    description: |
      The size (in bytes) of the IO accesses that should be performed
      on the device.
    enum: [1, 2, 4, 8]

  resets:
    maxItems: 1

  hwlocks:
    maxItems: 1
    description:
      Reference to a phandle of a hardware spinlock provider node.

required:
  - compatible
  - reg

allOf:
  - if:
      properties:
        compatible:
          contains:
            const: simple-mfd
    then:
      properties:
        compatible:
          minItems: 3
          maxItems: 5

additionalProperties: true

examples:
  - |
    syscon: syscon@1c00000 {
        compatible = "allwinner,sun8i-h3-system-controller", "syscon";
        reg = <0x01c00000 0x1000>;
    };
...