Linux-libre 5.3.12-gnu
[librecmc/linux-libre.git] / Documentation / devicetree / bindings / power / reset / syscon-poweroff.txt
1 Generic SYSCON mapped register poweroff driver
2
3 This is a generic poweroff driver using syscon to map the poweroff register.
4 The poweroff is generally performed with a write to the poweroff register
5 defined by the register map pointed by syscon reference plus the offset
6 with the value and mask defined in the poweroff node.
7
8 Required properties:
9 - compatible: should contain "syscon-poweroff"
10 - regmap: this is phandle to the register map node
11 - offset: offset in the register map for the poweroff register (in bytes)
12 - value: the poweroff value written to the poweroff register (32 bit access)
13
14 Optional properties:
15 - mask: update only the register bits defined by the mask (32 bit)
16
17 Legacy usage:
18 If a node doesn't contain a value property but contains a mask property, the
19 mask property is used as the value.
20
21 Default will be little endian mode, 32 bit access only.
22
23 Examples:
24
25         poweroff {
26            compatible = "syscon-poweroff";
27            regmap = <&regmapnode>;
28            offset = <0x0>;
29            mask = <0x7a>;
30         };