From:   Sander Vanheule <sander@svanheule.net>
To:     linux-pm@vger.kernel.org, devicetree@vger.kernel.org
Cc:     Sebastian Reichel <sre@kernel.org>,
        Rob Herring <robh+dt@kernel.org>, linux-kernel@vger.kernel.org,
        Sander Vanheule <sander@svanheule.net>
Subject: [PATCH] dt-bindings: power: reset: gpio-restart: Correct default priority
Date:   Mon, 10 Jan 2022 22:44:56 +0100
Message-Id: <20220110214456.67087-1-sander@svanheule.net>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

Commit bcd56fe1aa97 ("power: reset: gpio-restart: increase priority
slightly") changed the default restart priority 129, but did not update
the documentation. Correct this, so the driver and documentation have
the same default value.

Signed-off-by: Sander Vanheule <sander@svanheule.net>
---
This is a resubmission of RFC:
https://lore.kernel.org/all/cfcd00257daba5aa30b8d20a62ba542be1a6914c.1640887456.git.sander@svanheule.net/

The commit message for bcd56fe1aa97 mentions that it is a workaround for
rk3288-veryon boards. However, commit e28ea9dbc52d3 ("ARM: dts:
rockchip: add shared rk3288-veyron files") later adds a gpio-restart
node with a priority value of <200> for those boards, effectively
rendering bcd56fe1aa97 obsolete (for their use case).

Perhaps bcd56fe1aa97 could just be reverted instead of updating the
documentation.

An argument against reverting (a 6 year old patch) is that other boards
may have come to depend on the default value of 129. I don't know about
out-of-tree user of gpio-restart, but there are a few in-tree users of
gpio-restart /without/ an explicit priority:

arch/arm/boot/dts/imx53-ppd.dts (commit 2952d67637716)
  DTS submitted after changed default, but DTS copyright predates the
  changed default.

arch/microblaze/boot/dts/system.dts (commit 7cca9b8b7c5bc)
  The original DTS commit predates the changed default, but didn't use
  gpio-restart. The commit adding gpio-restart appears to indicate no
  other restart handlers are present on this platform, although it could
  be these were just being shadowed by the custom restart code.

arch/riscv/boot/dts/sifive/hifive-unleashed-a00.dts (commit 0a91330b2af9f)
  Recently added board; couldn't find any obvious alternative restart
  handlers.

Best,
Sander

 .../devicetree/bindings/power/reset/gpio-restart.yaml         | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/devicetree/bindings/power/reset/gpio-restart.yaml b/Documentation/devicetree/bindings/power/reset/gpio-restart.yaml
index 3dd22220cb5f..a72d5c721516 100644
--- a/Documentation/devicetree/bindings/power/reset/gpio-restart.yaml
+++ b/Documentation/devicetree/bindings/power/reset/gpio-restart.yaml
@@ -43,7 +43,7 @@ properties:
   priority:
     $ref: /schemas/types.yaml#/definitions/uint32
     description: |
-      A priority ranging from 0 to 255 (default 128) according to the following guidelines:
+      A priority ranging from 0 to 255 (default 129) according to the following guidelines:
 
         0:   Restart handler of last resort, with limited restart capabilities.
         128: Default restart handler; use if no other restart handler is expected to be available,
@@ -51,7 +51,7 @@ properties:
         255: Highest priority restart handler, will preempt all other restart handlers.
     minimum: 0
     maximum: 255
-    default: 128
+    default: 129
 
   active-delay:
     $ref: /schemas/types.yaml#/definitions/uint32
-- 
2.33.1