1 # SPDX-License-Identifier: GPL-2.0
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/power/reset/syscon-poweroff.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Generic SYSCON mapped register poweroff driver
8
9 maintainers:
10 - Sebastian Reichel <sre@kernel.org>
11
12 description: |+
13 This is a generic poweroff driver using syscon to map the poweroff register.
14 The poweroff is generally performed with a write to the poweroff register
15 defined by the register map pointed by syscon reference plus the offset
16 with the value and mask defined in the poweroff node.
17 Default will be little endian mode, 32 bit access only.
18 The SYSCON register map is normally retrieved from the parental dt-node. So
19 the SYSCON poweroff node should be represented as a sub-node of a "syscon",
20 "simple-mfd" node.
21
22 properties:
23 compatible:
24 const: syscon-poweroff
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 poweroff 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-poweroff node being a child of a system controller node.
40
41 value:
42 $ref: /schemas/types.yaml#/definitions/uint32
43 description: The poweroff value written to the poweroff 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 poweroff {
63 compatible = "syscon-poweroff";
64 offset = <0x0>;
65 mask = <0x7a>;
66 };
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.