Documentation/devicetree/bindings/power/reset/syscon-reboot.yaml

   1 # SPDX-License-Identifier: GPL-2.0
   2 %YAML 1.2
   3 ---
   4 $id: http://devicetree.org/schemas/power/reset/syscon-reboot.yaml#
   5 $schema: http://devicetree.org/meta-schemas/core.yaml#
   6
   7 title: Generic SYSCON mapped register reset driver
   8
   9 maintainers:
  10   - Sebastian Reichel <sre@kernel.org>
  11
  12 description: |+
  13   This is a generic reset driver using syscon to map the reset register.
  14   The reset is generally performed with a write to the reset register
  15   defined by the SYSCON register map base plus the offset with the value and
  16   mask defined in the reboot node. Default will be little endian mode, 32 bit
  17   access only. The SYSCON registers map is normally retrieved from the
  18   parental dt-node. So the SYSCON reboot node should be represented as a
  19   sub-node of a "syscon", "simple-mfd" node. Though the regmap property
  20   pointing to the system controller node is also supported.
  21
  22 properties:
  23   compatible:
  24     const: syscon-reboot
  25
  26   mask:
  27     $ref: /schemas/types.yaml#/definitions/uint32
  28     description: Update only the register bits defined by the mask (32 bit).
  29
  30   offset:
  31     $ref: /schemas/types.yaml#/definitions/uint32
  32     description: Offset in the register map for the reboot register (in bytes).
  33
  34   regmap:
  35     $ref: /schemas/types.yaml#/definitions/phandle
  36     deprecated: true
  37     description: |
  38       Phandle to the register map node. This property is deprecated in favor of
  39       the syscon-reboot node been a child of a system controller node.
  40
  41   value:
  42     $ref: /schemas/types.yaml#/definitions/uint32
  43     description: The reset value written to the reboot register (32 bit access).
  44
  45 required:
  46   - compatible
  47   - offset
  48
  49 additionalProperties: false
  50
  51 allOf:
  52   - if:
  53       not:
  54         required:
  55           - mask
  56     then:
  57       required:
  58         - value
  59
  60 examples:
  61   - |
  62     reboot {
  63         compatible = "syscon-reboot";
  64         regmap = <&regmapnode>;
  65         offset = <0x0>;
  66         mask = <0x1>;
  67     };