diff mbox series

[v2,1/3] watchdog: imx2_wdg: suspend watchdog in WAIT mode

Message ID 20221025072533.2980154-2-andrej.picej@norik.com
State New
Headers
Series Suspending i.MX watchdog in WAIT mode |

Commit Message

Andrej Picej Oct. 25, 2022, 7:25 a.m. UTC 
  Putting device into the "Suspend-To-Idle" mode causes watchdog to
trigger and reset the board after set watchdog timeout period elapses.

Introduce new device-tree property "fsl,suspend-in-wait" which suspends
watchdog in WAIT mode. This is done by setting WDW bit in WCR
(Watchdog Control Register) Watchdog operation is restored after exiting
WAIT mode as expected. WAIT mode coresponds with Linux's
"Suspend-To-Idle".

Signed-off-by: Andrej Picej <andrej.picej@norik.com>
Reviewed-by: Fabio Estevam <festevam@gmail.com>
---
Changes in v2:
 - validate the property with compatible string, as this functionality
   is not supported by all devices.
---
 drivers/watchdog/imx2_wdt.c | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

Comments

Alexander Stein Oct. 25, 2022, 9:38 a.m. UTC | #1 
Am Dienstag, 25. Oktober 2022, 09:25:31 CEST schrieb Andrej Picej:
> Putting device into the "Suspend-To-Idle" mode causes watchdog to
> trigger and reset the board after set watchdog timeout period elapses.
> 
> Introduce new device-tree property "fsl,suspend-in-wait" which suspends
> watchdog in WAIT mode. This is done by setting WDW bit in WCR
> (Watchdog Control Register) Watchdog operation is restored after exiting
> WAIT mode as expected. WAIT mode coresponds with Linux's
> "Suspend-To-Idle".
> 
> Signed-off-by: Andrej Picej <andrej.picej@norik.com>
> Reviewed-by: Fabio Estevam <festevam@gmail.com>
> ---
> Changes in v2:
>  - validate the property with compatible string, as this functionality
>    is not supported by all devices.
> ---
>  drivers/watchdog/imx2_wdt.c | 37 +++++++++++++++++++++++++++++++++++++
>  1 file changed, 37 insertions(+)
> 
> diff --git a/drivers/watchdog/imx2_wdt.c b/drivers/watchdog/imx2_wdt.c
> index d0c5d47ddede..dd9866c6f1e5 100644
> --- a/drivers/watchdog/imx2_wdt.c
> +++ b/drivers/watchdog/imx2_wdt.c
> @@ -35,6 +35,7 @@
> 
>  #define IMX2_WDT_WCR		0x00		/* Control 
Register */
>  #define IMX2_WDT_WCR_WT		(0xFF << 8)	/* -> 
Watchdog Timeout Field */
> +#define IMX2_WDT_WCR_WDW	BIT(7)		/* -> Watchdog disable 
for WAIT */
>  #define IMX2_WDT_WCR_WDA	BIT(5)		/* -> External Reset 
WDOG_B */
>  #define IMX2_WDT_WCR_SRS	BIT(4)		/* -> Software Reset 
Signal */
>  #define IMX2_WDT_WCR_WRE	BIT(3)		/* -> WDOG Reset Enable 
*/
> @@ -67,6 +68,27 @@ struct imx2_wdt_device {
>  	bool ext_reset;
>  	bool clk_is_on;
>  	bool no_ping;
> +	bool sleep_wait;
> +};
> +
> +static const char * const wdw_boards[] __initconst = {
> +	"fsl,imx25-wdt",
> +	"fsl,imx35-wdt",
> +	"fsl,imx50-wdt",
> +	"fsl,imx51-wdt",
> +	"fsl,imx53-wdt",
> +	"fsl,imx6q-wdt",
> +	"fsl,imx6sl-wdt",
> +	"fsl,imx6sll-wdt",
> +	"fsl,imx6sx-wdt",
> +	"fsl,imx6ul-wdt",
> +	"fsl,imx7d-wdt",
> +	"fsl,imx8mm-wdt",
> +	"fsl,imx8mn-wdt",
> +	"fsl,imx8mp-wdt",
> +	"fsl,imx8mq-wdt",
> +	"fsl,vf610-wdt",
> +	NULL
>  };

So the models listed in Documentation/devicetree/bindings/watchdog/fsl-imx-
wdt.yaml not supporting this feature are
* fsl,imx21-wdt
* fsl,imx27-wdt
* fsl,imx31-wdt
* fsl,ls1012a-wdt
* fsl,ls1043a-wdt
?

But all models are listed as compatible to fsl,imx21-wdt. So there is 
something wrong here. IMHO this sounds like the compatible list has to be 
split and updated. Depending on that this feature can be detected. Maintaining 
another list seems error prone to me.

Best regards,
Alexander

>  static bool nowayout = WATCHDOG_NOWAYOUT;
> @@ -129,6 +151,9 @@ static inline void imx2_wdt_setup(struct watchdog_device
> *wdog)
> 
>  	/* Suspend timer in low power mode, write once-only */
>  	val |= IMX2_WDT_WCR_WDZST;
> +	/* Suspend timer in low power WAIT mode, write once-only */
> +	if (wdev->sleep_wait)
> +		val |= IMX2_WDT_WCR_WDW;
>  	/* Strip the old watchdog Time-Out value */
>  	val &= ~IMX2_WDT_WCR_WT;
>  	/* Generate internal chip-level reset if WDOG times out */
> @@ -313,6 +338,18 @@ static int __init imx2_wdt_probe(struct platform_device
> *pdev)
> 
>  	wdev->ext_reset = of_property_read_bool(dev->of_node,
>  						"fsl,ext-
reset-output");
> +
> +	if (of_property_read_bool(dev->of_node, "fsl,suspend-in-wait"))
> +		if (of_device_compatible_match(dev->of_node, 
wdw_boards))
> +			wdev->sleep_wait = 1;
> +		else {
> +			dev_warn(dev, "Warning: Suspending watchdog 
during " \
> +				"WAIT mode is not supported for 
this device.\n");
> +			wdev->sleep_wait = 0;
> +		}
> +	else
> +		wdev->sleep_wait = 0;
> +
>  	/*
>  	 * The i.MX7D doesn't support low power mode, so we need to ping 
the
> watchdog * during suspend.
Andrej Picej Oct. 25, 2022, 11:21 a.m. UTC | #2 
Hi Alexander,

On 25. 10. 22 11:38, Alexander Stein wrote:
> Am Dienstag, 25. Oktober 2022, 09:25:31 CEST schrieb Andrej Picej:
>> Putting device into the "Suspend-To-Idle" mode causes watchdog to
>> trigger and reset the board after set watchdog timeout period elapses.
>>
>> Introduce new device-tree property "fsl,suspend-in-wait" which suspends
>> watchdog in WAIT mode. This is done by setting WDW bit in WCR
>> (Watchdog Control Register) Watchdog operation is restored after exiting
>> WAIT mode as expected. WAIT mode coresponds with Linux's
>> "Suspend-To-Idle".
>>
>> Signed-off-by: Andrej Picej <andrej.picej@norik.com>
>> Reviewed-by: Fabio Estevam <festevam@gmail.com>
>> ---
>> Changes in v2:
>>   - validate the property with compatible string, as this functionality
>>     is not supported by all devices.
>> ---
>>   drivers/watchdog/imx2_wdt.c | 37 +++++++++++++++++++++++++++++++++++++
>>   1 file changed, 37 insertions(+)
>>
>> diff --git a/drivers/watchdog/imx2_wdt.c b/drivers/watchdog/imx2_wdt.c
>> index d0c5d47ddede..dd9866c6f1e5 100644
>> --- a/drivers/watchdog/imx2_wdt.c
>> +++ b/drivers/watchdog/imx2_wdt.c
>> @@ -35,6 +35,7 @@
>>
>>   #define IMX2_WDT_WCR		0x00		/* Control
> Register */
>>   #define IMX2_WDT_WCR_WT		(0xFF << 8)	/* ->
> Watchdog Timeout Field */
>> +#define IMX2_WDT_WCR_WDW	BIT(7)		/* -> Watchdog disable
> for WAIT */
>>   #define IMX2_WDT_WCR_WDA	BIT(5)		/* -> External Reset
> WDOG_B */
>>   #define IMX2_WDT_WCR_SRS	BIT(4)		/* -> Software Reset
> Signal */
>>   #define IMX2_WDT_WCR_WRE	BIT(3)		/* -> WDOG Reset Enable
> */
>> @@ -67,6 +68,27 @@ struct imx2_wdt_device {
>>   	bool ext_reset;
>>   	bool clk_is_on;
>>   	bool no_ping;
>> +	bool sleep_wait;
>> +};
>> +
>> +static const char * const wdw_boards[] __initconst = {
>> +	"fsl,imx25-wdt",
>> +	"fsl,imx35-wdt",
>> +	"fsl,imx50-wdt",
>> +	"fsl,imx51-wdt",
>> +	"fsl,imx53-wdt",
>> +	"fsl,imx6q-wdt",
>> +	"fsl,imx6sl-wdt",
>> +	"fsl,imx6sll-wdt",
>> +	"fsl,imx6sx-wdt",
>> +	"fsl,imx6ul-wdt",
>> +	"fsl,imx7d-wdt",
>> +	"fsl,imx8mm-wdt",
>> +	"fsl,imx8mn-wdt",
>> +	"fsl,imx8mp-wdt",
>> +	"fsl,imx8mq-wdt",
>> +	"fsl,vf610-wdt",
>> +	NULL
>>   };
> 
> So the models listed in Documentation/devicetree/bindings/watchdog/fsl-imx-
> wdt.yaml not supporting this feature are
> * fsl,imx21-wdt
> * fsl,imx27-wdt
> * fsl,imx31-wdt
> * fsl,ls1012a-wdt
> * fsl,ls1043a-wdt
> ?
yes, you are correct.

> 
> But all models are listed as compatible to fsl,imx21-wdt. So there is
> something wrong here. IMHO this sounds like the compatible list has to be
> split and updated. Depending on that this feature can be detected. Maintaining
> another list seems error prone to me.
> 

So basically the compatible lists would be split into two groups, one 
for the devices which support this WDW bit and the rest which don't 
support this?
You got a point here, but...this means that every processors 
device-tree, which has two compatible strings (with "fsl,imx21-wdt") 
should be updated, right? That sounds like quite a lot of changes, which 
I'd like to avoid if possible.

Best regards,
Andrej

> Best regards,
> Alexander
> 
>>   static bool nowayout = WATCHDOG_NOWAYOUT;
>> @@ -129,6 +151,9 @@ static inline void imx2_wdt_setup(struct watchdog_device
>> *wdog)
>>
>>   	/* Suspend timer in low power mode, write once-only */
>>   	val |= IMX2_WDT_WCR_WDZST;
>> +	/* Suspend timer in low power WAIT mode, write once-only */
>> +	if (wdev->sleep_wait)
>> +		val |= IMX2_WDT_WCR_WDW;
>>   	/* Strip the old watchdog Time-Out value */
>>   	val &= ~IMX2_WDT_WCR_WT;
>>   	/* Generate internal chip-level reset if WDOG times out */
>> @@ -313,6 +338,18 @@ static int __init imx2_wdt_probe(struct platform_device
>> *pdev)
>>
>>   	wdev->ext_reset = of_property_read_bool(dev->of_node,
>>   						"fsl,ext-
> reset-output");
>> +
>> +	if (of_property_read_bool(dev->of_node, "fsl,suspend-in-wait"))
>> +		if (of_device_compatible_match(dev->of_node,
> wdw_boards))
>> +			wdev->sleep_wait = 1;
>> +		else {
>> +			dev_warn(dev, "Warning: Suspending watchdog
> during " \
>> +				"WAIT mode is not supported for
> this device.\n");
>> +			wdev->sleep_wait = 0;
>> +		}
>> +	else
>> +		wdev->sleep_wait = 0;
>> +
>>   	/*
>>   	 * The i.MX7D doesn't support low power mode, so we need to ping
> the
>> watchdog * during suspend.
> 
> 
> 
>
Marco Felsch Oct. 25, 2022, 12:27 p.m. UTC | #3 
On 22-10-25, Andrej Picej wrote:
> Putting device into the "Suspend-To-Idle" mode causes watchdog to
> trigger and reset the board after set watchdog timeout period elapses.
> 
> Introduce new device-tree property "fsl,suspend-in-wait" which suspends
> watchdog in WAIT mode. This is done by setting WDW bit in WCR
> (Watchdog Control Register) Watchdog operation is restored after exiting
> WAIT mode as expected. WAIT mode coresponds with Linux's
> "Suspend-To-Idle".
> 
> Signed-off-by: Andrej Picej <andrej.picej@norik.com>
> Reviewed-by: Fabio Estevam <festevam@gmail.com>
> ---
> Changes in v2:
>  - validate the property with compatible string, as this functionality
>    is not supported by all devices.
> ---
>  drivers/watchdog/imx2_wdt.c | 37 +++++++++++++++++++++++++++++++++++++
>  1 file changed, 37 insertions(+)
> 
> diff --git a/drivers/watchdog/imx2_wdt.c b/drivers/watchdog/imx2_wdt.c
> index d0c5d47ddede..dd9866c6f1e5 100644
> --- a/drivers/watchdog/imx2_wdt.c
> +++ b/drivers/watchdog/imx2_wdt.c
> @@ -35,6 +35,7 @@
>  
>  #define IMX2_WDT_WCR		0x00		/* Control Register */
>  #define IMX2_WDT_WCR_WT		(0xFF << 8)	/* -> Watchdog Timeout Field */
> +#define IMX2_WDT_WCR_WDW	BIT(7)		/* -> Watchdog disable for WAIT */
>  #define IMX2_WDT_WCR_WDA	BIT(5)		/* -> External Reset WDOG_B */
>  #define IMX2_WDT_WCR_SRS	BIT(4)		/* -> Software Reset Signal */
>  #define IMX2_WDT_WCR_WRE	BIT(3)		/* -> WDOG Reset Enable */
> @@ -67,6 +68,27 @@ struct imx2_wdt_device {
>  	bool ext_reset;
>  	bool clk_is_on;
>  	bool no_ping;
> +	bool sleep_wait;
> +};
> +
> +static const char * const wdw_boards[] __initconst = {
> +	"fsl,imx25-wdt",
> +	"fsl,imx35-wdt",
> +	"fsl,imx50-wdt",
> +	"fsl,imx51-wdt",
> +	"fsl,imx53-wdt",
> +	"fsl,imx6q-wdt",
> +	"fsl,imx6sl-wdt",
> +	"fsl,imx6sll-wdt",
> +	"fsl,imx6sx-wdt",
> +	"fsl,imx6ul-wdt",
> +	"fsl,imx7d-wdt",
> +	"fsl,imx8mm-wdt",
> +	"fsl,imx8mn-wdt",
> +	"fsl,imx8mp-wdt",
> +	"fsl,imx8mq-wdt",
> +	"fsl,vf610-wdt",
> +	NULL
>  };

For such things we have the data pointer within the struct of_device_id.

>  
>  static bool nowayout = WATCHDOG_NOWAYOUT;
> @@ -129,6 +151,9 @@ static inline void imx2_wdt_setup(struct watchdog_device *wdog)
>  
>  	/* Suspend timer in low power mode, write once-only */
>  	val |= IMX2_WDT_WCR_WDZST;
> +	/* Suspend timer in low power WAIT mode, write once-only */
> +	if (wdev->sleep_wait)
> +		val |= IMX2_WDT_WCR_WDW;
>  	/* Strip the old watchdog Time-Out value */
>  	val &= ~IMX2_WDT_WCR_WT;
>  	/* Generate internal chip-level reset if WDOG times out */
> @@ -313,6 +338,18 @@ static int __init imx2_wdt_probe(struct platform_device *pdev)
>  
>  	wdev->ext_reset = of_property_read_bool(dev->of_node,
>  						"fsl,ext-reset-output");
> +
> +	if (of_property_read_bool(dev->of_node, "fsl,suspend-in-wait"))

Why do we need this special property? If the device has problems when
"freeze" is used as suspend mode and this is fixed by this special bit
then we should enable it if the device supports it.

Regards,
  Marco


> +		if (of_device_compatible_match(dev->of_node, wdw_boards))
> +			wdev->sleep_wait = 1;
> +		else {
> +			dev_warn(dev, "Warning: Suspending watchdog during " \
> +				"WAIT mode is not supported for this device.\n");
> +			wdev->sleep_wait = 0;
> +		}
> +	else
> +		wdev->sleep_wait = 0;
> +
>  	/*
>  	 * The i.MX7D doesn't support low power mode, so we need to ping the watchdog
>  	 * during suspend.
> -- 
> 2.25.1
> 
> 
>
Andrej Picej Oct. 25, 2022, 1:01 p.m. UTC | #4 
Hi Marco,

On 25. 10. 22 14:27, Marco Felsch wrote:
> On 22-10-25, Andrej Picej wrote:
>> Putting device into the "Suspend-To-Idle" mode causes watchdog to
>> trigger and reset the board after set watchdog timeout period elapses.
>>
>> Introduce new device-tree property "fsl,suspend-in-wait" which suspends
>> watchdog in WAIT mode. This is done by setting WDW bit in WCR
>> (Watchdog Control Register) Watchdog operation is restored after exiting
>> WAIT mode as expected. WAIT mode coresponds with Linux's
>> "Suspend-To-Idle".
>>
>> Signed-off-by: Andrej Picej <andrej.picej@norik.com>
>> Reviewed-by: Fabio Estevam <festevam@gmail.com>
>> ---
>> Changes in v2:
>>   - validate the property with compatible string, as this functionality
>>     is not supported by all devices.
>> ---
>>   drivers/watchdog/imx2_wdt.c | 37 +++++++++++++++++++++++++++++++++++++
>>   1 file changed, 37 insertions(+)
>>
>> diff --git a/drivers/watchdog/imx2_wdt.c b/drivers/watchdog/imx2_wdt.c
>> index d0c5d47ddede..dd9866c6f1e5 100644
>> --- a/drivers/watchdog/imx2_wdt.c
>> +++ b/drivers/watchdog/imx2_wdt.c
>> @@ -35,6 +35,7 @@
>>   
>>   #define IMX2_WDT_WCR		0x00		/* Control Register */
>>   #define IMX2_WDT_WCR_WT		(0xFF << 8)	/* -> Watchdog Timeout Field */
>> +#define IMX2_WDT_WCR_WDW	BIT(7)		/* -> Watchdog disable for WAIT */
>>   #define IMX2_WDT_WCR_WDA	BIT(5)		/* -> External Reset WDOG_B */
>>   #define IMX2_WDT_WCR_SRS	BIT(4)		/* -> Software Reset Signal */
>>   #define IMX2_WDT_WCR_WRE	BIT(3)		/* -> WDOG Reset Enable */
>> @@ -67,6 +68,27 @@ struct imx2_wdt_device {
>>   	bool ext_reset;
>>   	bool clk_is_on;
>>   	bool no_ping;
>> +	bool sleep_wait;
>> +};
>> +
>> +static const char * const wdw_boards[] __initconst = {
>> +	"fsl,imx25-wdt",
>> +	"fsl,imx35-wdt",
>> +	"fsl,imx50-wdt",
>> +	"fsl,imx51-wdt",
>> +	"fsl,imx53-wdt",
>> +	"fsl,imx6q-wdt",
>> +	"fsl,imx6sl-wdt",
>> +	"fsl,imx6sll-wdt",
>> +	"fsl,imx6sx-wdt",
>> +	"fsl,imx6ul-wdt",
>> +	"fsl,imx7d-wdt",
>> +	"fsl,imx8mm-wdt",
>> +	"fsl,imx8mn-wdt",
>> +	"fsl,imx8mp-wdt",
>> +	"fsl,imx8mq-wdt",
>> +	"fsl,vf610-wdt",
>> +	NULL
>>   };
> 
> For such things we have the data pointer within the struct of_device_id.
Ok, that might clear it up a bit. Thanks.

> 
>>   
>>   static bool nowayout = WATCHDOG_NOWAYOUT;
>> @@ -129,6 +151,9 @@ static inline void imx2_wdt_setup(struct watchdog_device *wdog)
>>   
>>   	/* Suspend timer in low power mode, write once-only */
>>   	val |= IMX2_WDT_WCR_WDZST;
>> +	/* Suspend timer in low power WAIT mode, write once-only */
>> +	if (wdev->sleep_wait)
>> +		val |= IMX2_WDT_WCR_WDW;
>>   	/* Strip the old watchdog Time-Out value */
>>   	val &= ~IMX2_WDT_WCR_WT;
>>   	/* Generate internal chip-level reset if WDOG times out */
>> @@ -313,6 +338,18 @@ static int __init imx2_wdt_probe(struct platform_device *pdev)
>>   
>>   	wdev->ext_reset = of_property_read_bool(dev->of_node,
>>   						"fsl,ext-reset-output");
>> +
>> +	if (of_property_read_bool(dev->of_node, "fsl,suspend-in-wait"))
> 
> Why do we need this special property? If the device has problems when
> "freeze" is used as suspend mode and this is fixed by this special bit
> then we should enable it if the device supports it.

That was our initial plan and it would be the easiest to do. But since 
it looks like nobody experienced this problem so far, we are somehow 
reluctant to set it by default. What if someone is relying on this 
feature to reset the device if the device is not waken up from "freeze" 
by some other interrupt source?

Best regards,
Andrej
> 
> Regards,
>    Marco
> 
> 
>> +		if (of_device_compatible_match(dev->of_node, wdw_boards))
>> +			wdev->sleep_wait = 1;
>> +		else {
>> +			dev_warn(dev, "Warning: Suspending watchdog during " \
>> +				"WAIT mode is not supported for this device.\n");
>> +			wdev->sleep_wait = 0;
>> +		}
>> +	else
>> +		wdev->sleep_wait = 0;
>> +
>>   	/*
>>   	 * The i.MX7D doesn't support low power mode, so we need to ping the watchdog
>>   	 * during suspend.
>> -- 
>> 2.25.1
>>
>>
>>
Guenter Roeck Oct. 25, 2022, 2:21 p.m. UTC | #5 
On 10/25/22 00:25, Andrej Picej wrote:
> Putting device into the "Suspend-To-Idle" mode causes watchdog to
> trigger and reset the board after set watchdog timeout period elapses.
> 

s/reset/resets/

> Introduce new device-tree property "fsl,suspend-in-wait" which suspends
> watchdog in WAIT mode. This is done by setting WDW bit in WCR
> (Watchdog Control Register) Watchdog operation is restored after exiting

'.' after ')' missing ?

> WAIT mode as expected. WAIT mode coresponds with Linux's

s/coresponds/corresponds/

> "Suspend-To-Idle".
> 
> Signed-off-by: Andrej Picej <andrej.picej@norik.com>
> Reviewed-by: Fabio Estevam <festevam@gmail.com>
> ---
> Changes in v2:
>   - validate the property with compatible string, as this functionality
>     is not supported by all devices.
> ---
>   drivers/watchdog/imx2_wdt.c | 37 +++++++++++++++++++++++++++++++++++++
>   1 file changed, 37 insertions(+)
> 
> diff --git a/drivers/watchdog/imx2_wdt.c b/drivers/watchdog/imx2_wdt.c
> index d0c5d47ddede..dd9866c6f1e5 100644
> --- a/drivers/watchdog/imx2_wdt.c
> +++ b/drivers/watchdog/imx2_wdt.c
> @@ -35,6 +35,7 @@
>   
>   #define IMX2_WDT_WCR		0x00		/* Control Register */
>   #define IMX2_WDT_WCR_WT		(0xFF << 8)	/* -> Watchdog Timeout Field */
> +#define IMX2_WDT_WCR_WDW	BIT(7)		/* -> Watchdog disable for WAIT */
>   #define IMX2_WDT_WCR_WDA	BIT(5)		/* -> External Reset WDOG_B */
>   #define IMX2_WDT_WCR_SRS	BIT(4)		/* -> Software Reset Signal */
>   #define IMX2_WDT_WCR_WRE	BIT(3)		/* -> WDOG Reset Enable */
> @@ -67,6 +68,27 @@ struct imx2_wdt_device {
>   	bool ext_reset;
>   	bool clk_is_on;
>   	bool no_ping;
> +	bool sleep_wait;
> +};
> +
> +static const char * const wdw_boards[] __initconst = {
> +	"fsl,imx25-wdt",
> +	"fsl,imx35-wdt",
> +	"fsl,imx50-wdt",
> +	"fsl,imx51-wdt",
> +	"fsl,imx53-wdt",
> +	"fsl,imx6q-wdt",
> +	"fsl,imx6sl-wdt",
> +	"fsl,imx6sll-wdt",
> +	"fsl,imx6sx-wdt",
> +	"fsl,imx6ul-wdt",
> +	"fsl,imx7d-wdt",
> +	"fsl,imx8mm-wdt",
> +	"fsl,imx8mn-wdt",
> +	"fsl,imx8mp-wdt",
> +	"fsl,imx8mq-wdt",
> +	"fsl,vf610-wdt",
> +	NULL
>   };
>   
>   static bool nowayout = WATCHDOG_NOWAYOUT;
> @@ -129,6 +151,9 @@ static inline void imx2_wdt_setup(struct watchdog_device *wdog)
>   
>   	/* Suspend timer in low power mode, write once-only */
>   	val |= IMX2_WDT_WCR_WDZST;
> +	/* Suspend timer in low power WAIT mode, write once-only */
> +	if (wdev->sleep_wait)
> +		val |= IMX2_WDT_WCR_WDW;
>   	/* Strip the old watchdog Time-Out value */
>   	val &= ~IMX2_WDT_WCR_WT;
>   	/* Generate internal chip-level reset if WDOG times out */
> @@ -313,6 +338,18 @@ static int __init imx2_wdt_probe(struct platform_device *pdev)
>   
>   	wdev->ext_reset = of_property_read_bool(dev->of_node,
>   						"fsl,ext-reset-output");
> +
> +	if (of_property_read_bool(dev->of_node, "fsl,suspend-in-wait"))
> +		if (of_device_compatible_match(dev->of_node, wdw_boards))
> +			wdev->sleep_wait = 1;

Since sleep_wait is bool:
			wdev->sleep_wait = true;

> +		else {
> +			dev_warn(dev, "Warning: Suspending watchdog during " \
> +				"WAIT mode is not supported for this device.\n");

Do not split strings. "Warning:" is redundant. Please handle the error first.

> +			wdev->sleep_wait = 0;

Unnecessary; false by default. Also, this should fail and return -EINVAL.
Devicetree files should be correct, and warning messages tend to be ignored.

> +		}

All branches of if/else need to wither use {} or no {}.

> +	else
> +		wdev->sleep_wait = 0;
> +
Unnecessary.

I would suggest to replace the above code with something like

	if (of_property_read_bool(dev->of_node, "fsl,suspend-in-wait")) {
		if (!of_device_compatible_match(dev->of_node, wdw_boards)) {
			dev_err(dev, "Suspending watchdog in WAIT mode is not supported for this device\n");
			return -EINVAL;
		}
		wdev->sleep_wait = true;
	}

>   	/*
>   	 * The i.MX7D doesn't support low power mode, so we need to ping the watchdog
>   	 * during suspend.

I still wonder how that interacts with fsl,suspend-in-wait, but since we have a
property for that we can leave that for someone else to find out. Maybe add a
comment explaining that interaction with "fsl,suspend-in-wait" is unknown.

Thanks,
Guenter
Alexander Stein Oct. 26, 2022, 6:01 a.m. UTC | #6 
Hello Andrej,

Am Dienstag, 25. Oktober 2022, 13:21:18 CEST schrieb Andrej Picej:
> Hi Alexander,
> 
> On 25. 10. 22 11:38, Alexander Stein wrote:
> > Am Dienstag, 25. Oktober 2022, 09:25:31 CEST schrieb Andrej Picej:
> >> Putting device into the "Suspend-To-Idle" mode causes watchdog to
> >> trigger and reset the board after set watchdog timeout period elapses.
> >> 
> >> Introduce new device-tree property "fsl,suspend-in-wait" which suspends
> >> watchdog in WAIT mode. This is done by setting WDW bit in WCR
> >> (Watchdog Control Register) Watchdog operation is restored after exiting
> >> WAIT mode as expected. WAIT mode coresponds with Linux's
> >> "Suspend-To-Idle".
> >> 
> >> Signed-off-by: Andrej Picej <andrej.picej@norik.com>
> >> Reviewed-by: Fabio Estevam <festevam@gmail.com>
> >> ---
> >> 
> >> Changes in v2:
> >>   - validate the property with compatible string, as this functionality
> >>   
> >>     is not supported by all devices.
> >> 
> >> ---
> >> 
> >>   drivers/watchdog/imx2_wdt.c | 37 +++++++++++++++++++++++++++++++++++++
> >>   1 file changed, 37 insertions(+)
> >> 
> >> diff --git a/drivers/watchdog/imx2_wdt.c b/drivers/watchdog/imx2_wdt.c
> >> index d0c5d47ddede..dd9866c6f1e5 100644
> >> --- a/drivers/watchdog/imx2_wdt.c
> >> +++ b/drivers/watchdog/imx2_wdt.c
> >> @@ -35,6 +35,7 @@
> >> 
> >>   #define IMX2_WDT_WCR		0x00		/* Control
> > 
> > Register */
> > 
> >>   #define IMX2_WDT_WCR_WT		(0xFF << 8)	/* ->
> > 
> > Watchdog Timeout Field */
> > 
> >> +#define IMX2_WDT_WCR_WDW	BIT(7)		/* -> Watchdog disable
> > 
> > for WAIT */
> > 
> >>   #define IMX2_WDT_WCR_WDA	BIT(5)		/* -> External Reset
> > 
> > WDOG_B */
> > 
> >>   #define IMX2_WDT_WCR_SRS	BIT(4)		/* -> Software Reset
> > 
> > Signal */
> > 
> >>   #define IMX2_WDT_WCR_WRE	BIT(3)		/* -> WDOG Reset Enable
> > 
> > */
> > 
> >> @@ -67,6 +68,27 @@ struct imx2_wdt_device {
> >> 
> >>   	bool ext_reset;
> >>   	bool clk_is_on;
> >>   	bool no_ping;
> >> 
> >> +	bool sleep_wait;
> >> +};
> >> +
> >> +static const char * const wdw_boards[] __initconst = {
> >> +	"fsl,imx25-wdt",
> >> +	"fsl,imx35-wdt",
> >> +	"fsl,imx50-wdt",
> >> +	"fsl,imx51-wdt",
> >> +	"fsl,imx53-wdt",
> >> +	"fsl,imx6q-wdt",
> >> +	"fsl,imx6sl-wdt",
> >> +	"fsl,imx6sll-wdt",
> >> +	"fsl,imx6sx-wdt",
> >> +	"fsl,imx6ul-wdt",
> >> +	"fsl,imx7d-wdt",
> >> +	"fsl,imx8mm-wdt",
> >> +	"fsl,imx8mn-wdt",
> >> +	"fsl,imx8mp-wdt",
> >> +	"fsl,imx8mq-wdt",
> >> +	"fsl,vf610-wdt",
> >> +	NULL
> >> 
> >>   };
> > 
> > So the models listed in
> > Documentation/devicetree/bindings/watchdog/fsl-imx-
> > wdt.yaml not supporting this feature are
> > * fsl,imx21-wdt
> > * fsl,imx27-wdt
> > * fsl,imx31-wdt
> > * fsl,ls1012a-wdt
> > * fsl,ls1043a-wdt
> > ?
> 
> yes, you are correct.
> 
> > But all models are listed as compatible to fsl,imx21-wdt. So there is
> > something wrong here. IMHO this sounds like the compatible list has to be
> > split and updated. Depending on that this feature can be detected.
> > Maintaining another list seems error prone to me.
> 
> So basically the compatible lists would be split into two groups, one
> for the devices which support this WDW bit and the rest which don't
> support this?

This was my idea, so only one set has to be maintained.

> You got a point here, but...this means that every processors
> device-tree, which has two compatible strings (with "fsl,imx21-wdt")
> should be updated, right? That sounds like quite a lot of changes, which
> I'd like to avoid if possible.

Well, the compatible list right now doesn't reflect the hardware features/
compatibility correctly, so IMHO it should be fixed.
But apparently Krzysztof is okay having the special property only applicable 
for a specific set of devices. But in this case you will have to maintain two 
sets of device models (bindings + driver) to which WDW applies/does not apply 
to.

Best regards,
Alexander

> Best regards,
> Andrej
> 
> > Best regards,
> > Alexander
> > 
> >>   static bool nowayout = WATCHDOG_NOWAYOUT;
> >> 
> >> @@ -129,6 +151,9 @@ static inline void imx2_wdt_setup(struct
> >> watchdog_device *wdog)
> >> 
> >>   	/* Suspend timer in low power mode, write once-only */
> >>   	val |= IMX2_WDT_WCR_WDZST;
> >> 
> >> +	/* Suspend timer in low power WAIT mode, write once-only */
> >> +	if (wdev->sleep_wait)
> >> +		val |= IMX2_WDT_WCR_WDW;
> >> 
> >>   	/* Strip the old watchdog Time-Out value */
> >>   	val &= ~IMX2_WDT_WCR_WT;
> >>   	/* Generate internal chip-level reset if WDOG times out */
> >> 
> >> @@ -313,6 +338,18 @@ static int __init imx2_wdt_probe(struct
> >> platform_device *pdev)
> >> 
> >>   	wdev->ext_reset = of_property_read_bool(dev->of_node,
> >>   	
> >>   						"fsl,ext-
> > 
> > reset-output");
> > 
> >> +
> >> +	if (of_property_read_bool(dev->of_node, "fsl,suspend-in-wait"))
> >> +		if (of_device_compatible_match(dev->of_node,
> > 
> > wdw_boards))
> > 
> >> +			wdev->sleep_wait = 1;
> >> +		else {
> >> +			dev_warn(dev, "Warning: Suspending watchdog
> > 
> > during " \
> > 
> >> +				"WAIT mode is not supported for
> > 
> > this device.\n");
> > 
> >> +			wdev->sleep_wait = 0;
> >> +		}
> >> +	else
> >> +		wdev->sleep_wait = 0;
> >> +
> >> 
> >>   	/*
> >>   	
> >>   	 * The i.MX7D doesn't support low power mode, so we need to ping
> > 
> > the
> > 
> >> watchdog * during suspend.
Andrej Picej Oct. 26, 2022, 6:59 a.m. UTC | #7 
On 25. 10. 22 16:21, Guenter Roeck wrote:
> On 10/25/22 00:25, Andrej Picej wrote:
>> Putting device into the "Suspend-To-Idle" mode causes watchdog to
>> trigger and reset the board after set watchdog timeout period elapses.
>>
> 
> s/reset/resets/
> 
>> Introduce new device-tree property "fsl,suspend-in-wait" which suspends
>> watchdog in WAIT mode. This is done by setting WDW bit in WCR
>> (Watchdog Control Register) Watchdog operation is restored after exiting
> 
> '.' after ')' missing ?
> 
>> WAIT mode as expected. WAIT mode coresponds with Linux's
> 
> s/coresponds/corresponds/
> 
Will fix this in v3, thank you.

>> "Suspend-To-Idle".
>>
>> Signed-off-by: Andrej Picej <andrej.picej@norik.com>
>> Reviewed-by: Fabio Estevam <festevam@gmail.com>
>> ---
>> Changes in v2:
>>   - validate the property with compatible string, as this functionality
>>     is not supported by all devices.
>> ---
>>   drivers/watchdog/imx2_wdt.c | 37 +++++++++++++++++++++++++++++++++++++
>>   1 file changed, 37 insertions(+)
>>
>> diff --git a/drivers/watchdog/imx2_wdt.c b/drivers/watchdog/imx2_wdt.c
>> index d0c5d47ddede..dd9866c6f1e5 100644
>> --- a/drivers/watchdog/imx2_wdt.c
>> +++ b/drivers/watchdog/imx2_wdt.c
>> @@ -35,6 +35,7 @@
>>   #define IMX2_WDT_WCR        0x00        /* Control Register */
>>   #define IMX2_WDT_WCR_WT        (0xFF << 8)    /* -> Watchdog Timeout 
>> Field */
>> +#define IMX2_WDT_WCR_WDW    BIT(7)        /* -> Watchdog disable for 
>> WAIT */
>>   #define IMX2_WDT_WCR_WDA    BIT(5)        /* -> External Reset 
>> WDOG_B */
>>   #define IMX2_WDT_WCR_SRS    BIT(4)        /* -> Software Reset 
>> Signal */
>>   #define IMX2_WDT_WCR_WRE    BIT(3)        /* -> WDOG Reset Enable */
>> @@ -67,6 +68,27 @@ struct imx2_wdt_device {
>>       bool ext_reset;
>>       bool clk_is_on;
>>       bool no_ping;
>> +    bool sleep_wait;
>> +};
>> +
>> +static const char * const wdw_boards[] __initconst = {
>> +    "fsl,imx25-wdt",
>> +    "fsl,imx35-wdt",
>> +    "fsl,imx50-wdt",
>> +    "fsl,imx51-wdt",
>> +    "fsl,imx53-wdt",
>> +    "fsl,imx6q-wdt",
>> +    "fsl,imx6sl-wdt",
>> +    "fsl,imx6sll-wdt",
>> +    "fsl,imx6sx-wdt",
>> +    "fsl,imx6ul-wdt",
>> +    "fsl,imx7d-wdt",
>> +    "fsl,imx8mm-wdt",
>> +    "fsl,imx8mn-wdt",
>> +    "fsl,imx8mp-wdt",
>> +    "fsl,imx8mq-wdt",
>> +    "fsl,vf610-wdt",
>> +    NULL
>>   };
>>   static bool nowayout = WATCHDOG_NOWAYOUT;
>> @@ -129,6 +151,9 @@ static inline void imx2_wdt_setup(struct 
>> watchdog_device *wdog)
>>       /* Suspend timer in low power mode, write once-only */
>>       val |= IMX2_WDT_WCR_WDZST;
>> +    /* Suspend timer in low power WAIT mode, write once-only */
>> +    if (wdev->sleep_wait)
>> +        val |= IMX2_WDT_WCR_WDW;
>>       /* Strip the old watchdog Time-Out value */
>>       val &= ~IMX2_WDT_WCR_WT;
>>       /* Generate internal chip-level reset if WDOG times out */
>> @@ -313,6 +338,18 @@ static int __init imx2_wdt_probe(struct 
>> platform_device *pdev)
>>       wdev->ext_reset = of_property_read_bool(dev->of_node,
>>                           "fsl,ext-reset-output");
>> +
>> +    if (of_property_read_bool(dev->of_node, "fsl,suspend-in-wait"))
>> +        if (of_device_compatible_match(dev->of_node, wdw_boards))
>> +            wdev->sleep_wait = 1;
> 
> Since sleep_wait is bool:
>              wdev->sleep_wait = true;
> 
>> +        else {
>> +            dev_warn(dev, "Warning: Suspending watchdog during " \
>> +                "WAIT mode is not supported for this device.\n");
> 
> Do not split strings. "Warning:" is redundant. Please handle the error 
> first.
> 
>> +            wdev->sleep_wait = 0;
> 
> Unnecessary; false by default. Also, this should fail and return -EINVAL.
> Devicetree files should be correct, and warning messages tend to be 
> ignored.
> 
>> +        }
> 
> All branches of if/else need to wither use {} or no {}.
> 
>> +    else
>> +        wdev->sleep_wait = 0;
>> +
> Unnecessary.
> 
> I would suggest to replace the above code with something like
> 
>      if (of_property_read_bool(dev->of_node, "fsl,suspend-in-wait")) {
>          if (!of_device_compatible_match(dev->of_node, wdw_boards)) {
>              dev_err(dev, "Suspending watchdog in WAIT mode is not 
> supported for this device\n");
>              return -EINVAL;
>          }
>          wdev->sleep_wait = true;
>      }

OK, this look cleaner, will use this, thanks.

> 
>>       /*
>>        * The i.MX7D doesn't support low power mode, so we need to ping 
>> the watchdog
>>        * during suspend.
> 
> I still wonder how that interacts with fsl,suspend-in-wait, but since we 
> have a
> property for that we can leave that for someone else to find out. Maybe 
> add a
> comment explaining that interaction with "fsl,suspend-in-wait" is unknown.
I'm assuming that i.MX7D doesn't enter any of low-power modes including 
WAIT mode. If this is the case the watchdog wouldn't get disabled.

Anyway, I will add a short comment regarding the unknown behaviour of 
this property with i.MX7D device.

Best regards,
Andrej
Andrej Picej Oct. 26, 2022, 7:03 a.m. UTC | #8 
On 26. 10. 22 08:01, Alexander Stein wrote:
> Hello Andrej,
> 
> Am Dienstag, 25. Oktober 2022, 13:21:18 CEST schrieb Andrej Picej:
>> Hi Alexander,
>>
>> On 25. 10. 22 11:38, Alexander Stein wrote:
>>> Am Dienstag, 25. Oktober 2022, 09:25:31 CEST schrieb Andrej Picej:
>>>> Putting device into the "Suspend-To-Idle" mode causes watchdog to
>>>> trigger and reset the board after set watchdog timeout period elapses.
>>>>
>>>> Introduce new device-tree property "fsl,suspend-in-wait" which suspends
>>>> watchdog in WAIT mode. This is done by setting WDW bit in WCR
>>>> (Watchdog Control Register) Watchdog operation is restored after exiting
>>>> WAIT mode as expected. WAIT mode coresponds with Linux's
>>>> "Suspend-To-Idle".
>>>>
>>>> Signed-off-by: Andrej Picej <andrej.picej@norik.com>
>>>> Reviewed-by: Fabio Estevam <festevam@gmail.com>
>>>> ---
>>>>
>>>> Changes in v2:
>>>>    - validate the property with compatible string, as this functionality
>>>>    
>>>>      is not supported by all devices.
>>>>
>>>> ---
>>>>
>>>>    drivers/watchdog/imx2_wdt.c | 37 +++++++++++++++++++++++++++++++++++++
>>>>    1 file changed, 37 insertions(+)
>>>>
>>>> diff --git a/drivers/watchdog/imx2_wdt.c b/drivers/watchdog/imx2_wdt.c
>>>> index d0c5d47ddede..dd9866c6f1e5 100644
>>>> --- a/drivers/watchdog/imx2_wdt.c
>>>> +++ b/drivers/watchdog/imx2_wdt.c
>>>> @@ -35,6 +35,7 @@
>>>>
>>>>    #define IMX2_WDT_WCR		0x00		/* Control
>>>
>>> Register */
>>>
>>>>    #define IMX2_WDT_WCR_WT		(0xFF << 8)	/* ->
>>>
>>> Watchdog Timeout Field */
>>>
>>>> +#define IMX2_WDT_WCR_WDW	BIT(7)		/* -> Watchdog disable
>>>
>>> for WAIT */
>>>
>>>>    #define IMX2_WDT_WCR_WDA	BIT(5)		/* -> External Reset
>>>
>>> WDOG_B */
>>>
>>>>    #define IMX2_WDT_WCR_SRS	BIT(4)		/* -> Software Reset
>>>
>>> Signal */
>>>
>>>>    #define IMX2_WDT_WCR_WRE	BIT(3)		/* -> WDOG Reset Enable
>>>
>>> */
>>>
>>>> @@ -67,6 +68,27 @@ struct imx2_wdt_device {
>>>>
>>>>    	bool ext_reset;
>>>>    	bool clk_is_on;
>>>>    	bool no_ping;
>>>>
>>>> +	bool sleep_wait;
>>>> +};
>>>> +
>>>> +static const char * const wdw_boards[] __initconst = {
>>>> +	"fsl,imx25-wdt",
>>>> +	"fsl,imx35-wdt",
>>>> +	"fsl,imx50-wdt",
>>>> +	"fsl,imx51-wdt",
>>>> +	"fsl,imx53-wdt",
>>>> +	"fsl,imx6q-wdt",
>>>> +	"fsl,imx6sl-wdt",
>>>> +	"fsl,imx6sll-wdt",
>>>> +	"fsl,imx6sx-wdt",
>>>> +	"fsl,imx6ul-wdt",
>>>> +	"fsl,imx7d-wdt",
>>>> +	"fsl,imx8mm-wdt",
>>>> +	"fsl,imx8mn-wdt",
>>>> +	"fsl,imx8mp-wdt",
>>>> +	"fsl,imx8mq-wdt",
>>>> +	"fsl,vf610-wdt",
>>>> +	NULL
>>>>
>>>>    };
>>>
>>> So the models listed in
>>> Documentation/devicetree/bindings/watchdog/fsl-imx-
>>> wdt.yaml not supporting this feature are
>>> * fsl,imx21-wdt
>>> * fsl,imx27-wdt
>>> * fsl,imx31-wdt
>>> * fsl,ls1012a-wdt
>>> * fsl,ls1043a-wdt
>>> ?
>>
>> yes, you are correct.
>>
>>> But all models are listed as compatible to fsl,imx21-wdt. So there is
>>> something wrong here. IMHO this sounds like the compatible list has to be
>>> split and updated. Depending on that this feature can be detected.
>>> Maintaining another list seems error prone to me.
>>
>> So basically the compatible lists would be split into two groups, one
>> for the devices which support this WDW bit and the rest which don't
>> support this?
> 
> This was my idea, so only one set has to be maintained.
> 
>> You got a point here, but...this means that every processors
>> device-tree, which has two compatible strings (with "fsl,imx21-wdt")
>> should be updated, right? That sounds like quite a lot of changes, which
>> I'd like to avoid if possible.
> 
> Well, the compatible list right now doesn't reflect the hardware features/
> compatibility correctly, so IMHO it should be fixed.
> But apparently Krzysztof is okay having the special property only applicable
> for a specific set of devices. But in this case you will have to maintain two
> sets of device models (bindings + driver) to which WDW applies/does not apply
> to.
> 
Ok, lets see what @Krzysztof has to say about this.

Best regards,
Andrej
diff mbox series

Patch

diff --git a/drivers/watchdog/imx2_wdt.c b/drivers/watchdog/imx2_wdt.c
index d0c5d47ddede..dd9866c6f1e5 100644
--- a/drivers/watchdog/imx2_wdt.c
+++ b/drivers/watchdog/imx2_wdt.c
@@ -35,6 +35,7 @@ 
 
 #define IMX2_WDT_WCR		0x00		/* Control Register */
 #define IMX2_WDT_WCR_WT		(0xFF << 8)	/* -> Watchdog Timeout Field */
+#define IMX2_WDT_WCR_WDW	BIT(7)		/* -> Watchdog disable for WAIT */
 #define IMX2_WDT_WCR_WDA	BIT(5)		/* -> External Reset WDOG_B */
 #define IMX2_WDT_WCR_SRS	BIT(4)		/* -> Software Reset Signal */
 #define IMX2_WDT_WCR_WRE	BIT(3)		/* -> WDOG Reset Enable */
@@ -67,6 +68,27 @@  struct imx2_wdt_device {
 	bool ext_reset;
 	bool clk_is_on;
 	bool no_ping;
+	bool sleep_wait;
+};
+
+static const char * const wdw_boards[] __initconst = {
+	"fsl,imx25-wdt",
+	"fsl,imx35-wdt",
+	"fsl,imx50-wdt",
+	"fsl,imx51-wdt",
+	"fsl,imx53-wdt",
+	"fsl,imx6q-wdt",
+	"fsl,imx6sl-wdt",
+	"fsl,imx6sll-wdt",
+	"fsl,imx6sx-wdt",
+	"fsl,imx6ul-wdt",
+	"fsl,imx7d-wdt",
+	"fsl,imx8mm-wdt",
+	"fsl,imx8mn-wdt",
+	"fsl,imx8mp-wdt",
+	"fsl,imx8mq-wdt",
+	"fsl,vf610-wdt",
+	NULL
 };
 
 static bool nowayout = WATCHDOG_NOWAYOUT;
@@ -129,6 +151,9 @@  static inline void imx2_wdt_setup(struct watchdog_device *wdog)
 
 	/* Suspend timer in low power mode, write once-only */
 	val |= IMX2_WDT_WCR_WDZST;
+	/* Suspend timer in low power WAIT mode, write once-only */
+	if (wdev->sleep_wait)
+		val |= IMX2_WDT_WCR_WDW;
 	/* Strip the old watchdog Time-Out value */
 	val &= ~IMX2_WDT_WCR_WT;
 	/* Generate internal chip-level reset if WDOG times out */
@@ -313,6 +338,18 @@  static int __init imx2_wdt_probe(struct platform_device *pdev)
 
 	wdev->ext_reset = of_property_read_bool(dev->of_node,
 						"fsl,ext-reset-output");
+
+	if (of_property_read_bool(dev->of_node, "fsl,suspend-in-wait"))
+		if (of_device_compatible_match(dev->of_node, wdw_boards))
+			wdev->sleep_wait = 1;
+		else {
+			dev_warn(dev, "Warning: Suspending watchdog during " \
+				"WAIT mode is not supported for this device.\n");
+			wdev->sleep_wait = 0;
+		}
+	else
+		wdev->sleep_wait = 0;
+
 	/*
 	 * The i.MX7D doesn't support low power mode, so we need to ping the watchdog
 	 * during suspend.