FROMLIST: dt-bindings: power: reset: add document for reboot-mode driver
authorAndy Yan <andy.yan@rock-chips.com>
Tue, 1 Mar 2016 12:11:22 +0000 (20:11 +0800)
committerGerrit Code Review <gerrit@rock-chips.com>
Fri, 4 Mar 2016 06:24:53 +0000 (14:24 +0800)
add device tree bindings document for reboot-mode driver

Change-Id: I280e24e8c09e688e4f6dc51b7a1a658347f05db5
Signed-off-by: Andy Yan <andy.yan@rock-chips.com>
Documentation/devicetree/bindings/power/reset/reboot-mode.txt [new file with mode: 0644]
Documentation/devicetree/bindings/power/reset/syscon-reboot-mode.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/power/reset/reboot-mode.txt b/Documentation/devicetree/bindings/power/reset/reboot-mode.txt
new file mode 100644 (file)
index 0000000..f131a11
--- /dev/null
@@ -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_LOADER>;
+       }
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 (file)
index 0000000..5a75b14
--- /dev/null
@@ -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.
+
+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-fastboot = <BOOT_FASTBOOT>;
+                       mode-loader = <BOOT_LOADER>;
+               };
+       };