Re: [RFC][PATCH 2/4] dt-bindings: power: reset: Add document for sram-reboot-mode driver

[Rob Herring]

On Wed, Aug 03, 2016 at 04:05:21PM -0700, John Stultz wrote:
> Add device tree binding document for reboot-mode driver
> 
> Cc: Andy Yan <andy.yan@xxxxxxxxxxxxxx>
> Cc: Rob Herring <robh@xxxxxxxxxx>
> Cc: Arnd Bergmann <arnd@xxxxxxxx>
> Cc: Thierry Reding <treding@xxxxxxxxxx>
> Cc: Heiko Stübner <heiko@xxxxxxxxx>
> Cc: Caesar Wang <wxt@xxxxxxxxxxxxxx>
> Cc: Kees Cook <keescook@xxxxxxxxxxxx>
> Cc: Guodong Xu <guodong.xu@xxxxxxxxxx>
> Cc: Haojian Zhuang <haojian.zhuang@xxxxxxxxxx>
> Cc: Vishal Bhoj <vishal.bhoj@xxxxxxxxxx>
> Cc: Bjorn Andersson <bjorn.andersson@xxxxxxxxxx>
> Cc: devicetree@xxxxxxxxxxxxxxx
> Cc: Android Kernel Team <kernel-team@xxxxxxxxxxx>
> Signed-off-by: John Stultz <john.stultz@xxxxxxxxxx>
> ---
>  .../bindings/power/reset/sram-reboot-mode.txt      | 35 ++++++++++++++++++++++
>  1 file changed, 35 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/power/reset/sram-reboot-mode.txt
> 
> diff --git a/Documentation/devicetree/bindings/power/reset/sram-reboot-mode.txt b/Documentation/devicetree/bindings/power/reset/sram-reboot-mode.txt
> new file mode 100644
> index 0000000..0a0ed05
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/power/reset/sram-reboot-mode.txt
> @@ -0,0 +1,35 @@
> +SRAM reboot mode driver

Bindings don't describe drivers.

> +
> +This driver get reboot mode magic value form reboot-mode driver

s/form/from/

> +and stores it in a SRAM address. Then the bootloader
> +can read it and take different action according to the magic
> +value stored.

Might say "on the next reboot" somewhere in here.

> +
> +This DT node should be represented as a sub-node of a "mmio-sram" node.
> +
> +Required properties:
> +- compatible: should be "sram-reboot-mode"
> +- reg: offset from the sram range where to store the magic value(in bytes)
> +
> +The rest of the properties should follow the generic reboot-mode discription
> +found in reboot-mode.txt
> +
> +Example:
> +
> +	sram@5f01000 {
> +		compatible = "mmio-sram";
> +		reg = <0x0 0x05f01000 0x0 0x00001000>;
> +		ranges = <0x0 0x0 0x05f01000 0x00001000>;
> +
> +		#address-cells = <1>;
> +		#size-cells = <1>;
> +
> +		reboot-mode@0 {
> +			compatible = "sram-reboot-mode";
> +			reg = <0x0 0x4>;
> +
> +			mode-normal     = <0x77665501>;
> +			mode-bootloader = <0x77665500>;
> +			mode-recovery   = <0x77665502>;
> +		};
> +	};
> -- 
> 1.9.1
>