Re: [PATCH v4 8/9] watchdog: max77620: add comment to clarify set_timeout procedure

From: Guenter Roeck
Date: Mon Nov 29 2021 - 14:54:43 EST


On 11/29/21 8:08 AM, Luca Ceresoli wrote:
Hi Guenter,

On 29/11/21 17:04, Guenter Roeck wrote:
On Sat, Nov 20, 2021 at 04:57:06PM +0100, Luca Ceresoli wrote:
Clarify why we need to ping the watchdog before changing the timeout by
quoting the MAX77714 datasheet.


Unless I am missing something, this adds confusion instead of clarifying
anything, and it is misleading. The added comment in the code makes it
sound like clearing the watchdog timer is only needed for MAX77614.
However, the code was in place for MAX77620, suggesting that it was needed
for that chip as well and is not MAX77614 specific.

You're right, the comment comes from the max77714-only driver, but now
that it is in a multi-chip driver the confusion started to exist.

Please either drop this patch or rephrase it to clarify that it applies
to both chips.

What if I rephrase to:

/*
* "If the value of TWD needs to be changed, clear the system
* watchdog timer first [...], then change the value of TWD."
- * (MAX77714 datasheet)
+ * (MAX77714 datasheet but applies to MAX77620 too)
*/


Sounds good.

Guenter