treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / Documentation / devicetree / bindings / power / reset / syscon-reboot.yaml
blobd38006b1f1f4426ac7d6274b366bf7835a37e1b7
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#
7 title: Generic SYSCON mapped register reset driver
9 maintainers:
10   - Sebastian Reichel <sre@kernel.org>
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 register map pointed by syscon reference plus the offset
16   with the value and mask defined in the reboot node.
17   Default will be little endian mode, 32 bit access only.
19 properties:
20   compatible:
21     const: syscon-reboot
23   mask:
24     $ref: /schemas/types.yaml#/definitions/uint32
25     description: Update only the register bits defined by the mask (32 bit).
27   offset:
28     $ref: /schemas/types.yaml#/definitions/uint32
29     description: Offset in the register map for the reboot register (in bytes).
31   regmap:
32     $ref: /schemas/types.yaml#/definitions/phandle
33     description: Phandle to the register map node.
35   value:
36     $ref: /schemas/types.yaml#/definitions/uint32
37     description: The reset value written to the reboot register (32 bit access).
39 required:
40   - compatible
41   - regmap
42   - offset
44 allOf:
45   - if:
46       not:
47         required:
48           - mask
49     then:
50       required:
51         - value
53 examples:
54   - |
55     reboot {
56         compatible = "syscon-reboot";
57         regmap = <&regmapnode>;
58         offset = <0x0>;
59         mask = <0x1>;
60     };