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               - amd,pensando-elba-syscon
  42               - brcm,cru-clkset
  43               - freecom,fsg-cs2-system-controller
  44               - fsl,imx93-aonmix-ns-syscfg
  45               - fsl,imx93-wakeupmix-syscfg
  46               - hisilicon,dsa-subctrl
  47               - hisilicon,hi6220-sramctrl
  48               - hisilicon,pcie-sas-subctrl
  49               - hisilicon,peri-subctrl
  50               - hpe,gxp-sysreg
  51               - intel,lgm-syscon
  52               - loongson,ls1b-syscon
  53               - loongson,ls1c-syscon
  54               - marvell,armada-3700-usb2-host-misc
  55               - mediatek,mt8135-pctl-a-syscfg
  56               - mediatek,mt8135-pctl-b-syscfg
  57               - mediatek,mt8365-syscfg
  58               - microchip,lan966x-cpu-syscon
  59               - microchip,sparx5-cpu-syscon
  60               - mstar,msc313-pmsleep
  61               - nuvoton,ma35d1-sys
  62               - nuvoton,wpcm450-shm
  63               - rockchip,px30-qos
  64               - rockchip,rk3036-qos
  65               - rockchip,rk3066-qos
  66               - rockchip,rk3128-qos
  67               - rockchip,rk3228-qos
  68               - rockchip,rk3288-qos
  69               - rockchip,rk3368-qos
  70               - rockchip,rk3399-qos
  71               - rockchip,rk3568-qos
  72               - rockchip,rk3588-qos
  73               - rockchip,rv1126-qos
  74               - starfive,jh7100-sysmain
  75               - ti,am654-dss-oldi-io-ctrl
  76
  77           - const: syscon
  78
  79       - contains:
  80           const: syscon
  81         minItems: 2
  82         maxItems: 5  # Should be enough
  83
  84   reg:
  85     maxItems: 1
  86
  87   reg-io-width:
  88     description: |
  89       The size (in bytes) of the IO accesses that should be performed
  90       on the device.
  91     enum: [1, 2, 4, 8]
  92
  93   resets:
  94     maxItems: 1
  95
  96   hwlocks:
  97     maxItems: 1
  98     description:
  99       Reference to a phandle of a hardware spinlock provider node.
 100
 101 required:
 102   - compatible
 103   - reg
 104
 105 allOf:
 106   - if:
 107       properties:
 108         compatible:
 109           contains:
 110             const: simple-mfd
 111     then:
 112       properties:
 113         compatible:
 114           minItems: 3
 115           maxItems: 5
 116
 117 additionalProperties: true
 118
 119 examples:
 120   - |
 121     syscon: syscon@1c00000 {
 122         compatible = "allwinner,sun8i-h3-system-controller", "syscon";
 123         reg = <0x01c00000 0x1000>;
 124     };
 125 ...