Documentation/devicetree/bindings/mfd/syscon.yaml

   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
   7 title: System Controller Registers R/W
   8
   9 description: |
  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
  19 maintainers:
  20   - Lee Jones <lee@kernel.org>
  21
  22 select:
  23   properties:
  24     compatible:
  25       contains:
  26         enum:
  27           - syscon
  28
  29   required:
  30     - compatible
  31
  32 properties:
  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               - fsl,imx93-aonmix-ns-syscfg
  44               - fsl,imx93-wakeupmix-syscfg
  45               - hisilicon,dsa-subctrl
  46               - hisilicon,hi6220-sramctrl
  47               - hisilicon,pcie-sas-subctrl
  48               - hisilicon,peri-subctrl
  49               - intel,lgm-syscon
  50               - marvell,armada-3700-usb2-host-misc
  51               - mediatek,mt8135-pctl-a-syscfg
  52               - mediatek,mt8135-pctl-b-syscfg
  53               - microchip,lan966x-cpu-syscon
  54               - microchip,sparx5-cpu-syscon
  55               - mstar,msc313-pmsleep
  56               - rockchip,px30-qos
  57               - rockchip,rk3036-qos
  58               - rockchip,rk3066-qos
  59               - rockchip,rk3228-qos
  60               - rockchip,rk3288-qos
  61               - rockchip,rk3368-qos
  62               - rockchip,rk3399-qos
  63               - rockchip,rk3568-qos
  64               - rockchip,rk3588-qos
  65               - rockchip,rv1126-qos
  66               - samsung,exynos3-sysreg
  67               - samsung,exynos4-sysreg
  68               - samsung,exynos5-sysreg
  69               - samsung,exynos5433-sysreg
  70               - samsung,exynos850-sysreg
  71               - samsung,exynosautov9-sysreg
  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   hwlocks:
  90     maxItems: 1
  91     description:
  92       Reference to a phandle of a hardware spinlock provider node.
  93
  94 required:
  95   - compatible
  96   - reg
  97
  98 allOf:
  99   - if:
 100       properties:
 101         compatible:
 102           contains:
 103             const: simple-mfd
 104     then:
 105       properties:
 106         compatible:
 107           minItems: 3
 108           maxItems: 5
 109
 110 additionalProperties: true
 111
 112 examples:
 113   - |
 114     syscon: syscon@1c00000 {
 115         compatible = "allwinner,sun8i-h3-system-controller", "syscon";
 116         reg = <0x01c00000 0x1000>;
 117     };
 118 ...