[v1,4/4] dt-binding: power: reset: Add documentation for MTK RGU (Reset Gernation Unit) reboot driver
diff mbox series

Message ID 1574746490-625-5-git-send-email-freddy.hsin@mediatek.com
State Rejected
Headers show
Series
  • Support MTK reboot mode driver
Related show

Commit Message

freddy.hsin@mediatek.com Nov. 26, 2019, 5:34 a.m. UTC
From: Freddy Hsin <freddy.hsin@mediatek.com>

Add documentation for MTK RGU (Reset Generation Unit) reboot driver.

Signed-off-by: Freddy Hsin <freddy.hsin@mediatek.com>
---
 .../devicetree/bindings/power/reset/mtk-reboot.txt |   30 ++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/power/reset/mtk-reboot.txt

Comments

Rob Herring Dec. 5, 2019, 7:08 p.m. UTC | #1
On Tue, Nov 26, 2019 at 01:34:50PM +0800, freddy.hsin@mediatek.com wrote:
> From: Freddy Hsin <freddy.hsin@mediatek.com>
> 
> Add documentation for MTK RGU (Reset Generation Unit) reboot driver.
> 
> Signed-off-by: Freddy Hsin <freddy.hsin@mediatek.com>
> ---
>  .../devicetree/bindings/power/reset/mtk-reboot.txt |   30 ++++++++++++++++++++
>  1 file changed, 30 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/power/reset/mtk-reboot.txt
> 
> diff --git a/Documentation/devicetree/bindings/power/reset/mtk-reboot.txt b/Documentation/devicetree/bindings/power/reset/mtk-reboot.txt
> new file mode 100644
> index 0000000..708d351
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/power/reset/mtk-reboot.txt
> @@ -0,0 +1,30 @@
> +Generic MTK RGU mapped register reset driver
> +
> +This is a reset driver using toprgu to map its non-volatile register.
> +The reset is generally performed with a write to the non-volatile register
> +defined by the register map pointed by toprgu reference plus the offset
> +with the mask defined in the reboot-mode node.
> +
> +Required properties:
> +- compatible: should contain "toprgu-reboot-mode"

What's wrong with syscon-reboot-mode?

> +- regmap: this is phandle to the register map node

Make this node a child node of the phandle and get rid of this.

> +- offset: offset in the register map for the reboot-mode register (in bytes)
> +- mask: the reset value written to the reboot register (32 bit access)
> +
> +Examples:
> +	reboot-mode {
> +	   compatible = "toprgu-reboot-mode";
> +	   regmap = <&toprgu>;
> +	   offset = <0x24>;
> +	   mask = <0xF>;
> +	};
> +
> +Optional properties - reboot mode value that will keep in toprgu nonrst RG:
> +- mode-charger = <BOOT_CHARGER>;
> +- mode-recovery = <BOOT_RECOVERY>;
> +- mode-bootloader = <BOOT_BOOTLOADER>;
> +- mode-dm-verity-dev-corrupt = <BOOT_DM_VERITY>;
> +- mode-kpoc = <BOOT_KPOC>;
> +- mode-ddr-reserve = <BOOT_DDR_RSVD>;
> +- mode-meta = <BOOT_META>;
> +- mode-rpmbpk = <BOOT_RPMBPK>;
> -- 
> 1.7.9.5

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/power/reset/mtk-reboot.txt b/Documentation/devicetree/bindings/power/reset/mtk-reboot.txt
new file mode 100644
index 0000000..708d351
--- /dev/null
+++ b/Documentation/devicetree/bindings/power/reset/mtk-reboot.txt
@@ -0,0 +1,30 @@ 
+Generic MTK RGU mapped register reset driver
+
+This is a reset driver using toprgu to map its non-volatile register.
+The reset is generally performed with a write to the non-volatile register
+defined by the register map pointed by toprgu reference plus the offset
+with the mask defined in the reboot-mode node.
+
+Required properties:
+- compatible: should contain "toprgu-reboot-mode"
+- regmap: this is phandle to the register map node
+- offset: offset in the register map for the reboot-mode register (in bytes)
+- mask: the reset value written to the reboot register (32 bit access)
+
+Examples:
+	reboot-mode {
+	   compatible = "toprgu-reboot-mode";
+	   regmap = <&toprgu>;
+	   offset = <0x24>;
+	   mask = <0xF>;
+	};
+
+Optional properties - reboot mode value that will keep in toprgu nonrst RG:
+- mode-charger = <BOOT_CHARGER>;
+- mode-recovery = <BOOT_RECOVERY>;
+- mode-bootloader = <BOOT_BOOTLOADER>;
+- mode-dm-verity-dev-corrupt = <BOOT_DM_VERITY>;
+- mode-kpoc = <BOOT_KPOC>;
+- mode-ddr-reserve = <BOOT_DDR_RSVD>;
+- mode-meta = <BOOT_META>;
+- mode-rpmbpk = <BOOT_RPMBPK>;