diff mbox

[2/2] dt: power: Add docs for generic SYSCON poweroff driver.

Message ID 1426029670-31775-3-git-send-email-moritz.fischer@ettus.com
State Superseded, archived
Headers show

Commit Message

Moritz Fischer March 10, 2015, 11:21 p.m. UTC
Add documentation for generic SYSCON poweroff driver.

Signed-off-by: Moritz Fischer <moritz.fischer@ettus.com>
---
 .../bindings/power/reset/syscon-poweroff.txt       | 23 ++++++++++++++++++++++
 1 file changed, 23 insertions(+)

Comments

Moritz Fischer March 10, 2015, 11:23 p.m. UTC | #1
On Tue, Mar 10, 2015 at 4:21 PM, Moritz Fischer
<moritz.fischer@ettus.com> wrote:
> Add documentation for generic SYSCON poweroff driver.
>
> Signed-off-by: Moritz Fischer <moritz.fischer@ettus.com>
> ---
>  .../bindings/power/reset/syscon-poweroff.txt       | 23 ++++++++++++++++++++++
>  1 file changed, 23 insertions(+)
>
> diff --git a/Documentation/devicetree/bindings/power/reset/syscon-poweroff.txt b/Documentation/devicetree/bindings/power/reset/syscon-poweroff.txt
> new file mode 100644
> index 0000000..1422cee
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/power/reset/syscon-poweroff.txt
> @@ -0,0 +1,23 @@
> +Generic SYSCON mapped register poweroff driver
> +
> +This is a generic poweroff driver using syscon to map the poweroff register.
> +The poweroff is generally performed with a write to the poweroff register
> +defined by the register map pointed by syscon reference plus the offset
> +with the mask defined in the poweroff node.
> +
> +Required properties:
> +- compatible: should contain "syscon-poweroff"
> +- regmap: this is phandle to the register map node
> +- offset: offset in the register map for the poweroff register (in bytes)
> +- mask: the poweroff value written to the poweroff register (32 bit access)
> +
> +Default will be little endian mode, 32 bit access only.
> +
> +Examples:
> +
> +       reboot {

Arghhh ...
> +          compatible = "syscon-reboot";
Arghhhh.....
> +          regmap = <&regmapnode>;
> +          offset = <0x0>;
> +          mask = <0x7a>;
> +       };
> --
> 1.9.3
>

Will collect feedback and resubmit, sorry about that.

Moritz
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/power/reset/syscon-poweroff.txt b/Documentation/devicetree/bindings/power/reset/syscon-poweroff.txt
new file mode 100644
index 0000000..1422cee
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/reset/syscon-poweroff.txt
@@ -0,0 +1,23 @@ 
+Generic SYSCON mapped register poweroff driver
+
+This is a generic poweroff driver using syscon to map the poweroff register.
+The poweroff is generally performed with a write to the poweroff register
+defined by the register map pointed by syscon reference plus the offset
+with the mask defined in the poweroff node.
+
+Required properties:
+- compatible: should contain "syscon-poweroff"
+- regmap: this is phandle to the register map node
+- offset: offset in the register map for the poweroff register (in bytes)
+- mask: the poweroff value written to the poweroff register (32 bit access)
+
+Default will be little endian mode, 32 bit access only.
+
+Examples:
+
+	reboot {
+	   compatible = "syscon-reboot";
+	   regmap = <&regmapnode>;
+	   offset = <0x0>;
+	   mask = <0x7a>;
+	};