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 Device Tree Bindings
   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.jones@linaro.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               - hisilicon,dsa-subctrl
  42               - hisilicon,hi6220-sramctrl
  43               - hisilicon,pcie-sas-subctrl
  44               - hisilicon,peri-subctrl
  45               - microchip,sparx5-cpu-syscon
  46               - mstar,msc313-pmsleep
  47               - rockchip,px30-qos
  48               - rockchip,rk3066-qos
  49               - rockchip,rk3288-qos
  50               - rockchip,rk3399-qos
  51               - samsung,exynos3-sysreg
  52               - samsung,exynos4-sysreg
  53               - samsung,exynos5-sysreg
  54               - samsung,exynos5433-sysreg
  55
  56           - const: syscon
  57
  58       - contains:
  59           const: syscon
  60         minItems: 2
  61         maxItems: 4  # Should be enough
  62
  63   reg:
  64     maxItems: 1
  65
  66   reg-io-width:
  67     description: |
  68       The size (in bytes) of the IO accesses that should be performed
  69       on the device.
  70     $ref: /schemas/types.yaml#/definitions/uint32
  71     enum: [1, 2, 4, 8]
  72
  73   hwlocks:
  74     maxItems: 1
  75     description:
  76       Reference to a phandle of a hardware spinlock provider node.
  77
  78 required:
  79   - compatible
  80   - reg
  81
  82 additionalProperties: true
  83
  84 examples:
  85   - |
  86     syscon: syscon@1c00000 {
  87         compatible = "allwinner,sun8i-h3-system-controller", "syscon";
  88         reg = <0x01c00000 0x1000>;
  89     };
  90
  91   - |
  92     gpr: iomuxc-gpr@20e0000 {
  93         compatible = "fsl,imx6q-iomuxc-gpr", "syscon";
  94         reg = <0x020e0000 0x38>;
  95         hwlocks = <&hwlock1 1>;
  96     };
  97
  98 ...