regulator: bd718x7: Clarify comment by moving it
authorMatti Vaittinen <mazziesaccount@gmail.com>
Tue, 10 Jun 2025 05:32:06 +0000 (08:32 +0300)
committerMark Brown <broonie@kernel.org>
Wed, 11 Jun 2025 11:46:05 +0000 (12:46 +0100)
commit55d9fd9819de09e70401b3b5262ff46d5de951b7
tree50e95998d1c1f137826cc0edc5d2533dc635a579
parentd6fa0ca959db8efd4462d7beef4bdc5568640fd0
regulator: bd718x7: Clarify comment by moving it

The BD718x7 needs to disable voltage monitoring for a duration of
certain voltage changes.

The comment explaining use of msleep(1) instead of a more accurate
delay(), was placed to a function which disabled the protection. The
actual sleeping is done in a different place of the code, after the
voltage has been changed.

Browsing through the comment and code after the years made me to scratch
my head for a second. I may have figured why me and so many fellow
developers are slowly getting bald.

Clarify things a bit and move the comment about required delay directly
above the sleep. Leave only a small comment explaining why the protection
is disabled to the spot where the logic for disabling is.

Signed-off-by: Matti Vaittinen <mazziesaccount@gmail.com>
Link: https://patch.msgid.link/a90cb77e66a253f4055bbb99672dc81c7457de66.1749533040.git.mazziesaccount@gmail.com
Signed-off-by: Mark Brown <broonie@kernel.org>
drivers/regulator/bd718x7-regulator.c