From e6d27a79daef306f05b8186c5bf514ddb7998abc Mon Sep 17 00:00:00 2001
From: Laxman Dewangan <ldewangan@nvidia.com>
Date: Mon, 25 Apr 2022 09:20:44 +0000
Subject: [PATCH] documentation: Add DT binding document for
 watchdog-tegra-t18x

Add Device Tree binding document for the NVIDIA Tegra watchdog timer.

Bug 3583627

Change-Id: I242585c8a543d03e0c58bfb9098fdbd1c780886e
Signed-off-by: Laxman Dewangan <ldewangan@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nv-oot/+/2702336
GVS: Gerrit_Virtual_Submit
---
 .../watchdog/watchdog-tegra-t18x.yaml         | 113 ++++++++++++++++++
 1 file changed, 113 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/watchdog/watchdog-tegra-t18x.yaml

diff --git a/Documentation/devicetree/bindings/watchdog/watchdog-tegra-t18x.yaml b/Documentation/devicetree/bindings/watchdog/watchdog-tegra-t18x.yaml
new file mode 100644
index 00000000..e5300c97
--- /dev/null
+++ b/Documentation/devicetree/bindings/watchdog/watchdog-tegra-t18x.yaml
@@ -0,0 +1,113 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/watchdog/watchdog-tegra-t18x.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NVIDIA Tegra186 Watchdog Timer (WDT) Controller
+
+maintainers:
+  - Laxman Dewangan <ldewangan@nvidia.com>
+
+description: |
+   Watchdog timer for the Nvidia Tegra186 SoCs.
+
+allOf:
+  - $ref: "watchdog.yaml#"
+
+properties:
+  compatible:
+    oneOf:
+      - const: nvidia,tegra-wdt-t234
+      - const: nvidia,tegra-wdt-t19x
+      - const: nvidia,tegra-wdt-t18x
+      - const: nvidia,tegra-wdt-t18x-linsim
+
+  reg:
+    maxItems: 3
+    description: |
+       This driver required base register of three controller as
+       first entry is for the watchdog timer 0 address,
+       second entry is for the address of the Timer0 and
+       third entry is for the address of TKE.
+
+  interrupts:
+    maxItems: 1
+    description: |
+       Interrupt of the watchdog timer.
+
+  nvidia,watchdog-index:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+       Index of watchdog timer controller starting from 0.
+
+  nvidia,timer-index:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+       Index of timer used for watchdog timing clock.
+
+  nvidia,enable-on-init:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+       If present, start the watchdog timer during initialisation else not.
+
+  nvidia,extend-watchdog-suspend:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+       If present, extend the watchdog timer during suspend else not.
+
+  nvidia,disable-debug-reset:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+       If present, disable watchdog timer during debug reset.
+
+  nvidia,disable-por-reset:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+       If present, disable the Power-On-Reset of SoCs when it expires.
+
+  nvidia,disallow-wdt-freeze:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+       If present, disable watchdog timer when system freeze. This will help to not reset
+       SoCs during freeze when doing hardware debug.
+
+  nvidia,disable-remote-interrupt:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description: |
+       If present, skip the remote interrupt when watchdog timer expire.
+
+  nvidia,shutdown-timeout:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+       Shutdown timeout in second.
+
+  nvidia,expiry-count:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+       Watchdog expiry count before reset.
+
+required:
+  - compatible
+  - interrupts
+  - reg
+  - timeout-sec
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    watchdog@2190000 {
+       compatible = "nvidia,tegra-wdt-t234";
+       reg = <0x0 0x02190000 0x0 0x10000>, /* WDT0 */
+             <0x0 0x02090000 0x0 0x10000>, /* TMR0 */
+             <0x0 0x02080000 0x0 0x10000>; /* TKE */
+       interrupts = <0 7 0x4 0 8 0x4>; /* TKE shared int */
+       nvidia,watchdog-index = <0>;
+       nvidia,timer-index = <7>;
+       nvidia,enable-on-init;
+       nvidia,extend-watchdog-suspend;
+       timeout-sec = <120>;
+       nvidia,disable-debug-reset;
+    };
+...