From: Andy Yan <andy.yan@rock-chips.com>
To: robh+dt@kernel.org, heiko@sntech.de, john.stultz@linaro.org,
arnd@arndb.de
Cc: k.kozlowski@samsung.com, devicetree@vger.kernel.org,
linux-kernel@vger.kernel.org, bjorn.andersson@linaro.org,
alexandre.belloni@free-electrons.com, dbaryshkov@gmail.com,
sre@kernel.org, matthias.bgg@gmail.com, linux-pm@vger.kernel.org,
mbrugger@suse.com, lorenzo.pieralisi@arm.com,
moritz.fischer@ettus.com, richard@nod.at,
Andy Yan <andy.yan@rock-chips.com>
Subject: [PATCH v9 1/4] dt-bindings: power: reset: add document for reboot-mode driver
Date: Mon, 20 Jun 2016 14:36:42 +0800 [thread overview]
Message-ID: <1466404602-3388-1-git-send-email-andy.yan@rock-chips.com> (raw)
In-Reply-To: <1466404490-3315-1-git-send-email-andy.yan@rock-chips.com>
Add device tree bindings document for reboot-mode driver.
Signed-off-by: Andy Yan <andy.yan@rock-chips.com>
Acked-by: Rob Herring <robh@kernel.org>
Reviewed-by: Krzysztof Kozlowski <k.kozlowski@samsung.com>
---
Changes in v9: None
Changes in v8: None
Changes in v7:
- fix some spelling mistakes
- declare that the mode magic should be none-zero value
Changes in v6:
- fix a typo with "property"
- describe property "mask" more clear
Changes in v5:
- delete a unnecessary blank line in syscon-reboot-mode.txt
- rename mode-fastoboot to mode-bootloader 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 | 25 ++++++++++++++++
.../bindings/power/reset/syscon-reboot-mode.txt | 35 ++++++++++++++++++++++
2 files changed, 60 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..de34f27
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/reset/reboot-mode.txt
@@ -0,0 +1,25 @@
+Generic reboot mode core map driver
+
+This driver get reboot mode arguments and call the write
+interface to store the magic value in special register
+or ram. Then the bootloader can read it and take different
+action according to the argument stored.
+
+All mode properties are vendor specific, it is a indication to tell
+the bootloader what to do when the system reboots, and should be named
+as mode-xxx = <magic> (xxx is mode name, magic should be a none-zero value).
+
+For example modes common on Android platform:
+- 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..f7ce1d8
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/reset/syscon-reboot-mode.txt
@@ -0,0 +1,35 @@
+SYSCON reboot mode driver
+
+This driver gets 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 property:
+- mask: bits mask of the bits in the register to store the reboot mode magic value,
+ default set to 0xffffffff if missing.
+
+The rest of the properties should follow the generic reboot-mode description
+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>;
+ };
+ };
--
2.7.4
next prev parent reply other threads:[~2016-06-20 6:47 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-06-20 6:34 [PATCH v9 0/4] add reboot mode driver Andy Yan
2016-06-20 6:36 ` Andy Yan [this message]
2016-06-20 6:38 ` [PATCH v9 2/4] power: reset: " Andy Yan
2016-06-20 8:09 ` Krzysztof Kozlowski
2016-06-20 8:28 ` Andy Yan
2016-06-20 12:31 ` Krzysztof Kozlowski
2016-06-20 14:40 ` Paul Gortmaker
2016-06-21 6:16 ` Andy Yan
2016-06-21 9:32 ` Krzysztof Kozlowski
2016-07-06 13:39 ` Krzysztof Kozlowski
2016-06-20 6:39 ` [PATCH v9 3/4] ARM: dts: rockchip: add syscon-reboot-mode DT node Andy Yan
2016-06-20 21:55 ` Bjorn Andersson
2016-06-21 6:08 ` Andy Yan
2016-06-20 6:40 ` [PATCH v9 4/4] ARM64: " Andy Yan
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1466404602-3388-1-git-send-email-andy.yan@rock-chips.com \
--to=andy.yan@rock-chips.com \
--cc=alexandre.belloni@free-electrons.com \
--cc=arnd@arndb.de \
--cc=bjorn.andersson@linaro.org \
--cc=dbaryshkov@gmail.com \
--cc=devicetree@vger.kernel.org \
--cc=heiko@sntech.de \
--cc=john.stultz@linaro.org \
--cc=k.kozlowski@samsung.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=lorenzo.pieralisi@arm.com \
--cc=matthias.bgg@gmail.com \
--cc=mbrugger@suse.com \
--cc=moritz.fischer@ettus.com \
--cc=richard@nod.at \
--cc=robh+dt@kernel.org \
--cc=sre@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).