regulator: Documentation fix for regulator error notification helper
PATCH 1/1 regulator: Documentation fix for regulator error notification helper
The helper to send IRQ notification for regulator errors had still old description mentioning calling BUG() as a last resort when error status reading has kept failing for more times than a given threshold.
The impementation calling BUG() did never end-up in-tree but was replaced by hopefully more sophisticated handler trying to power-off the system.
Fix the documentation to reflect actual behaviour.
--- drivers/regulator/irq_helpers.c | 2 +- include/linux/regulator/driver.h | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-)
drivers/regulator/irq_helpers.c +1 -1
@@ -184,7 +184,7 @@ static irqreturn_t regulator_notifier_isr(int irq, void *data)* If retry_count exceeds the given safety limit we call IC specific die * handler which can try disabling regulator(s). * -* If no die handler is given we will just bug() as a last resort. +* If no die handler is given we will just power-off as a last resort. * * We could try disabling all associated rdevs - but we might shoot * ourselves in the head and leave the problematic regulator enabled. So
include/linux/regulator/driver.h +4 -3
@@ -527,8 +527,8 @@ struct regulator_irq_data {* active events as core does not clean the map data. * REGULATOR_FAILED_RETRY can be returned to indicate that the * status reading from IC failed. If this is repeated for -* fatal_cnt times the core will call die() callback or BUG() -* as a last resort to protect the HW. +* fatal_cnt times the core will call die() callback or power-off +* the system as a last resort to protect the HW. * @renable: Optional callback to check status (if HW supports that) before * re-enabling IRQ. If implemented this should clear the error * flags so that errors fetched by regulator_get_error_flags()
@@ -537,7 +537,8 @@ struct regulator_irq_data {* REGULATOR_FAILED_RETRY can be returned to * indicate that the status reading from IC failed. If this is * repeated for 'fatal_cnt' times the core will call die() -* callback or BUG() as a last resort to protect the HW. +* callback or if die() is not populated then attempt to power-off +* the system as a last resort to protect the HW. * Returning zero indicates that the problem in HW has been solved * and IRQ will be re-enabled. Returning REGULATOR_ERROR_ON * indicates the error condition is still active and keeps IRQ
base-commit: aa9f92097dcc83848ee7e4ea5ddbdd15db5eff64
Signature · 14 lines
2.25.4 -- Matti Vaittinen, Linux device drivers ROHM Semiconductors, Finland SWDC Kiviharjunlenkki 1E 90220 OULU FINLAND ~~~ "I don't think so," said Rene Descartes. Just then he vanished ~~~ Simon says - in Latin please. ~~~ "non cogito me" dixit Rene Descarte, deinde evanescavit ~~~ Thanks to Simon Glass for the translation =]
Mark Brown
maintainerQuoted 10 lines · Matti Vaittinen
The helper to send IRQ notification for regulator errors had still old description mentioning calling
BUG()as a last resort when error status reading has kept failing for more times than a given threshold.The impementation calling
BUG()did never end-up in-tree but was replaced by hopefully more sophisticated handler trying to power-off the system.[...]
Applied to
https://git.kernel.org/pub/scm/linux/kernel/git/broonie/regulator.git for-next
Thanks!
[1/1] regulator: Documentation fix for regulator error notification helper
commit: ad3ead1efe057029bf112e13d7ef5901915d6abd
All being well this means that it will be integrated into the linux-next tree (usually sometime in the next 24 hours) and sent to Linus during the next merge window (or sooner if it is a bug fix), however if problems are discovered then the patch may be dropped or reverted.
You may get further e-mails resulting from automated or manual testing and review of the tree, please engage with people reporting problems and send followup patches addressing any issues that are reported if needed.
If any updates are required or you are submitting further changes they should be sent as incremental updates against current git, existing patches will not be replaced.
Please add any relevant lists and maintainers to the CCs when replying to this mail.
Thanks,
Mark