From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <andy.yan@rock-chips.com>
Subject: Re: [PATCH v5 1/4] dt-bindings: power: reset: add document for
 reboot-mode driver
References: <1457439716-8084-1-git-send-email-andy.yan@rock-chips.com>
 <1457439785-8133-1-git-send-email-andy.yan@rock-chips.com>
 <20160317155212.GA19171@rob-hp-laptop>
From: Andy Yan <andy.yan@rock-chips.com>
Message-ID: <56EBBA1E.2010709@rock-chips.com>
Date: Fri, 18 Mar 2016 16:19:42 +0800
MIME-Version: 1.0
In-Reply-To: <20160317155212.GA19171@rob-hp-laptop>
Content-Type: multipart/alternative;
 boundary="------------070802070805010501010208"
To: Rob Herring <robh@kernel.org>
Cc: john.stultz@linaro.org, "arnd@arndb.de;moritz.fischer"@ettus.com, heiko@sntech.de, pawel.moll@arm.com, mark.rutland@arm.com, ijc+devicetree@hellion.org.uk, galak@codeaurora.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, catalin.marinas@arm.com, olof@lixom.net, alexandre.belloni@free-electrons.com, dbaryshkov@gmail.com, sre@kernel.org, jun.nie@linaro.org, edubezval@gmail.com, f.fainelli@gmail.com, will.deacon@arm.com, linux-rockchip@lists.infradead.org, wxt@rock-chips.com, matthias.bgg@gmail.com, linux@arm.linux.org.uk, lorenzo.pieralisi@arm.com, moritz.fischer@ettus.com, richard@nod.at, dwmw2@infradead.org, jwerner@google.com
List-ID: <devicetree@vger.kernel.org>

This is a multi-part message in MIME format.
--------------070802070805010501010208
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit

Hi Rob:

On 2016年03月17日 23:52, Rob Herring wrote:
> On Tue, Mar 08, 2016 at 08:23:05PM +0800, Andy Yan wrote:
>> add device tree bindings document for reboot-mode driver
>>
>> Signed-off-by: Andy Yan <andy.yan@rock-chips.com>
>>
>> ---
>>
>> Changes in v5:
>> - delete a unnecessary blank line in syscon-reboot-mode.txt
>> - rename macro BOOT_LOADER to BOOT_BL_DOWNLOAD, which gives a more clear mean
>>
>> Changes in v4:
>> - remove mode-maskrom
>> - rename mode-fastboot to mode-bootloader to keep compatible with the exiting Android device
>>
>> Changes in v3:
>> - descirbe all reboot mode as properity instead of subnode
>>
>> Changes in v2: None
>> Changes in v1: None
>>
>>   .../bindings/power/reset/reboot-mode.txt           | 24 +++++++++++++++
>>   .../bindings/power/reset/syscon-reboot-mode.txt    | 34 ++++++++++++++++++++++
>>   2 files changed, 58 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/power/reset/reboot-mode.txt
>>   create mode 100644 Documentation/devicetree/bindings/power/reset/syscon-reboot-mode.txt
>>
>> diff --git a/Documentation/devicetree/bindings/power/reset/reboot-mode.txt b/Documentation/devicetree/bindings/power/reset/reboot-mode.txt
>> new file mode 100644
>> index 0000000..3457949
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/power/reset/reboot-mode.txt
>> @@ -0,0 +1,24 @@
>> +Generic reboot mode core map driver
>> +
>> +This driver get reboot mode arguments and call the write
>> +interface to stores the magic value in special register
>> +or ram . Then the bootloader can read it and take different
>> +action according the argument stored.
>> +
>> +All mode properties are vendor specific, it is a indication to tell
>> +the bootloder what to do when the system reboot, and should be named
>> +as mode-xxx = <magic> (xxx is mode name).
>> +
>> +- mode-normal: Normal reboot mode, system reboot with command "reboot".
>> +- mode-recovery: Android Recovery mode, it is a mode to format the device or update a new image.
>> +- mode-bootloader: Android fastboot mode, it's a mode to re-flash partitions on the Android based device.
>> +- mode-loader: A bootloader mode, it's a mode used to download image on Rockchip platform,
>> +	       usually used in development.
>> +
>> +Example:
>> +	reboot-mode {
>> +		mode-normal = <BOOT_NORMAL>;
>> +		mode-recovery = <BOOT_RECOVERY>;
>> +		mode-bootloader = <BOOT_FASTBOOT>;
>> +		mode-loader = <BOOT_BL_DOWNLOAD>;
>> +	}
>> diff --git a/Documentation/devicetree/bindings/power/reset/syscon-reboot-mode.txt b/Documentation/devicetree/bindings/power/reset/syscon-reboot-mode.txt
>> new file mode 100644
>> index 0000000..d03cb52
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/power/reset/syscon-reboot-mode.txt
>> @@ -0,0 +1,34 @@
>> +SYSCON reboot mode driver
>> +
>> +This driver get reboot mode magic value form reboot-mode driver
>> +and stores it in a SYSCON mapped register. Then the bootloader
>> +can read it and take different action according to the magic
>> +value stored.
>> +
>> +This DT node should be represented as a sub-node of a "syscon", "simple-mfd"
>> +node.
>> +
>> +Required properties:
>> +- compatible: should be "syscon-reboot-mode"
>> +- offset: offset in the register map for the storage register (in bytes)
>> +
>> +Optional properity:
>> +- mask: the mask bits of the mode magic value, default set to 0xffffffff if missing.
> I can't see how this is used. I would drop it for now.
>
> With that change:
>
> Acked-by: Rob Herring <robh@kernel.org>
>

     The mask is suggested by Moritz Fischer in V2[0]. And I found Tegra 
did indeed only use some bits of one register to store the reboot mode[1].

@Heiko: It seems that this patch series can land now, but the dts parts 
belong to  two different branch(arm32 and arm64) . And these
two parts both depends on one head file rockchip_boot-mode.h, So I hope 
some suggestions from you how to deal with it.

    [0] https://lkml.org/lkml/2016/1/27/225
    [1] drivers/soc/tegra/pmc.c  (tegra_pmc_restart_notify)
>> +
>> +The rest of the properties should follow the generic reboot-mode discription
>> +found in reboot-mode.txt
>> +
>> +Example:
>> +	pmu: pmu@20004000 {
>> +		compatible = "rockchip,rk3066-pmu", "syscon", "simple-mfd";
>> +		reg = <0x20004000 0x100>;
>> +
>> +		reboot-mode {
>> +			compatible = "syscon-reboot-mode";
>> +			offset = <0x40>;
>> +			mode-normal = <BOOT_NORMAL>;
>> +			mode-recovery = <BOOT_RECOVERY>;
>> +			mode-bootloader = <BOOT_FASTBOOT>;
>> +			mode-loader = <BOOT_BL_DOWNLOAD>;
>> +		};
>> +	};
>> -- 
>> 1.9.1
>>
>>
>>
>
>


--------------070802070805010501010208
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: 8bit

<html>
  <head>
    <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
  </head>
  <body text="#000000" bgcolor="#FFFFFF">
    Hi Rob:<br>
    <br>
    <div class="moz-cite-prefix">On 2016年03月17日 23:52, Rob Herring
      wrote:<br>
    </div>
    <blockquote cite="mid:20160317155212.GA19171@rob-hp-laptop"
      type="cite">
      <pre wrap="">On Tue, Mar 08, 2016 at 08:23:05PM +0800, Andy Yan wrote:
</pre>
      <blockquote type="cite">
        <pre wrap="">add device tree bindings document for reboot-mode driver

Signed-off-by: Andy Yan <a class="moz-txt-link-rfc2396E" href="mailto:andy.yan@rock-chips.com">&lt;andy.yan@rock-chips.com&gt;</a>

---

Changes in v5:
- delete a unnecessary blank line in syscon-reboot-mode.txt
- rename macro BOOT_LOADER to BOOT_BL_DOWNLOAD, which gives a more clear mean

Changes in v4:
- remove mode-maskrom
- rename mode-fastboot to mode-bootloader to keep compatible with the exiting Android device

Changes in v3:
- descirbe all reboot mode as properity instead of subnode

Changes in v2: None
Changes in v1: None

 .../bindings/power/reset/reboot-mode.txt           | 24 +++++++++++++++
 .../bindings/power/reset/syscon-reboot-mode.txt    | 34 ++++++++++++++++++++++
 2 files changed, 58 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/power/reset/reboot-mode.txt
 create mode 100644 Documentation/devicetree/bindings/power/reset/syscon-reboot-mode.txt

diff --git a/Documentation/devicetree/bindings/power/reset/reboot-mode.txt b/Documentation/devicetree/bindings/power/reset/reboot-mode.txt
new file mode 100644
index 0000000..3457949
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/reset/reboot-mode.txt
@@ -0,0 +1,24 @@
+Generic reboot mode core map driver
+
+This driver get reboot mode arguments and call the write
+interface to stores the magic value in special register
+or ram . Then the bootloader can read it and take different
+action according the argument stored.
+
+All mode properties are vendor specific, it is a indication to tell
+the bootloder what to do when the system reboot, and should be named
+as mode-xxx = &lt;magic&gt; (xxx is mode name).
+
+- mode-normal: Normal reboot mode, system reboot with command "reboot".
+- mode-recovery: Android Recovery mode, it is a mode to format the device or update a new image.
+- mode-bootloader: Android fastboot mode, it's a mode to re-flash partitions on the Android based device.
+- mode-loader: A bootloader mode, it's a mode used to download image on Rockchip platform,
+	       usually used in development.
+
+Example:
+	reboot-mode {
+		mode-normal = &lt;BOOT_NORMAL&gt;;
+		mode-recovery = &lt;BOOT_RECOVERY&gt;;
+		mode-bootloader = &lt;BOOT_FASTBOOT&gt;;
+		mode-loader = &lt;BOOT_BL_DOWNLOAD&gt;;
+	}
diff --git a/Documentation/devicetree/bindings/power/reset/syscon-reboot-mode.txt b/Documentation/devicetree/bindings/power/reset/syscon-reboot-mode.txt
new file mode 100644
index 0000000..d03cb52
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/reset/syscon-reboot-mode.txt
@@ -0,0 +1,34 @@
+SYSCON reboot mode driver
+
+This driver get reboot mode magic value form reboot-mode driver
+and stores it in a SYSCON mapped register. Then the bootloader
+can read it and take different action according to the magic
+value stored.
+
+This DT node should be represented as a sub-node of a "syscon", "simple-mfd"
+node.
+
+Required properties:
+- compatible: should be "syscon-reboot-mode"
+- offset: offset in the register map for the storage register (in bytes)
+
+Optional properity:
+- mask: the mask bits of the mode magic value, default set to 0xffffffff if missing.
</pre>
      </blockquote>
      <pre wrap="">
I can't see how this is used. I would drop it for now.

With that change:

Acked-by: Rob Herring <a class="moz-txt-link-rfc2396E" href="mailto:robh@kernel.org">&lt;robh@kernel.org&gt;</a>

</pre>
    </blockquote>
        <br>
        The mask is suggested by
    <meta http-equiv="content-type" content="text/html; charset=UTF-8">
    <span style="color: rgb(0, 0, 0); font-family: courier, monospace;
      font-size: medium; font-style: normal; font-variant: normal;
      font-weight: normal; letter-spacing: normal; line-height: normal;
      orphans: auto; text-align: start; text-indent: 0px;
      text-transform: none; white-space: normal; widows: 1;
      word-spacing: 0px; -webkit-text-stroke-width: 0px; display: inline
      !important; float: none;">Moritz Fischer in V2[0]. And I found
      Tegra did indeed only use some bits of one register to store the
      reboot mode[1].<br>
      <br>
      @Heiko: It seems that this patch series can land now, but the dts
      parts belong to  two different branch(arm32 and arm64) . And these<br>
      two parts both depends on one head file rockchip_boot-mode.h, So I
      hope some suggestions from you how to deal with it.<br>
      <br>
    </span>   [0] <a class="moz-txt-link-freetext" href="https://lkml.org/lkml/2016/1/27/225">https://lkml.org/lkml/2016/1/27/225</a><br>
       [1] drivers/soc/tegra/pmc.c  (tegra_pmc_restart_notify)<br>
    <blockquote cite="mid:20160317155212.GA19171@rob-hp-laptop"
      type="cite">
      <blockquote type="cite">
        <pre wrap="">+
+The rest of the properties should follow the generic reboot-mode discription
+found in reboot-mode.txt
+
+Example:
+	pmu: pmu@20004000 {
+		compatible = "rockchip,rk3066-pmu", "syscon", "simple-mfd";
+		reg = &lt;0x20004000 0x100&gt;;
+
+		reboot-mode {
+			compatible = "syscon-reboot-mode";
+			offset = &lt;0x40&gt;;
+			mode-normal = &lt;BOOT_NORMAL&gt;;
+			mode-recovery = &lt;BOOT_RECOVERY&gt;;
+			mode-bootloader = &lt;BOOT_FASTBOOT&gt;;
+			mode-loader = &lt;BOOT_BL_DOWNLOAD&gt;;
+		};
+	};
-- 
1.9.1



</pre>
      </blockquote>
      <pre wrap="">


</pre>
    </blockquote>
    <br>
  </body>
</html>

--------------070802070805010501010208--