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
  42         - const: syscon
  43
  44       - contains:
  45           const: syscon
  46         additionalItems: true
  47
  48   reg:
  49     maxItems: 1
  50
  51   reg-io-width:
  52     description: |
  53       The size (in bytes) of the IO accesses that should be performed
  54       on the device.
  55     allOf:
  56       - $ref: /schemas/types.yaml#/definitions/uint32
  57       - enum: [ 1, 2, 4, 8 ]
  58
  59   hwlocks:
  60     maxItems: 1
  61     description:
  62       Reference to a phandle of a hardware spinlock provider node.
  63
  64 required:
  65   - compatible
  66   - reg
  67
  68 unevaluatedProperties: false
  69
  70 examples:
  71   - |
  72     syscon: syscon@1c00000 {
  73         compatible = "allwinner,sun8i-h3-system-controller", "syscon";
  74         reg = <0x01c00000 0x1000>;
  75     };
  76
  77   - |
  78     gpr: iomuxc-gpr@20e0000 {
  79         compatible = "fsl,imx6q-iomuxc-gpr", "syscon";
  80         reg = <0x020e0000 0x38>;
  81         hwlocks = <&hwlock1 1>;
  82     };
  83
  84 ...