Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

dt: power: Add docs for generic SYSCON poweroff driver.

Add documentation for generic SYSCON poweroff driver.

Signed-off-by: Moritz Fischer <moritz.fischer@ettus.com>
Signed-off-by: Sebastian Reichel <sre@kernel.org>

authored by

Moritz Fischer and committed by
Sebastian Reichel
0db739fa 8a577608

+23
+23
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 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 + - mask: the poweroff value written to the poweroff register (32 bit access) 13 + 14 + Default will be little endian mode, 32 bit access only. 15 + 16 + Examples: 17 + 18 + poweroff { 19 + compatible = "syscon-poweroff"; 20 + regmap = <&regmapnode>; 21 + offset = <0x0>; 22 + mask = <0x7a>; 23 + };