Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-12-26 12:52:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

regulator: Documentation fix for v5.16

Browse Source 
A fix for bitrot in the documentation for protection interrupts that
 crept in as the code was revised during review.
 -----BEGIN PGP SIGNATURE-----
 
 iQEzBAABCgAdFiEEreZoqmdXGLWf4p/qJNaLcl1Uh9AFAmGuLzQACgkQJNaLcl1U
 h9CooQf/R65eO6RU0FqfEOP81kMHicfucJF4zcFiEJepGF8Do5ULx7eZpD+KdyLw
 zH2xPVqXlOCX9kEFgd/evYftZG3W9UMFBXUWVwNSl29hqWUkX+VuLZOK2LTpQzNO
 uH+UrYM1z4wg/6j8UrOVeROlQ28fvNwimNLWoNOy4yXJIiXLZpM04oA+2kNxyfmC
 6gG0XP3c/6zGQkqX+qKu9R3Ni5qZzqYESvgJ5d4aCZgTgU6SseDVxeA6awmbPcSf
 35d9T0tX3QNBRQT37WS0Rsdv2aVwcAuHiXwaBNm5hpcy1NrCzRKRxvIj3lQLUHmV
 5/ERi03h62tyNESyd2ik/Wve6I1Igg==
 =gA31
 -----END PGP SIGNATURE-----

Merge tag 'regulator-fix-v5.16-rc4' of git://git.kernel.org/pub/scm/linux/kernel/git/broonie/regulator

Pull regulator fix from Mark Brown:
 "Documentation fix for v5.17.

  A fix for bitrot in the documentation for protection interrupts that
  crept in as the code was revised during review"

* tag 'regulator-fix-v5.16-rc4' of git://git.kernel.org/pub/scm/linux/kernel/git/broonie/regulator:
  regulator: Update protection IRQ helper docs
This commit is contained in:
Linus Torvalds 2021-12-06 10:14:12 -08:00
commit b806bec538
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
include/linux/regulator/driver.h
View File

@ -499,7 +499,8 @@ struct regulator_irq_data {
* best to shut-down regulator(s) or reboot the SOC if error
* handling is repeatedly failing. If fatal_cnt is given the IRQ
* handling is aborted if it fails for fatal_cnt times and die()
* callback (if populated) or BUG() is called to try to prevent
* callback (if populated) is called. If die() is not populated
* poweroff for the system is attempted in order to prevent any
* further damage.
* @reread_ms: The time which is waited before attempting to re-read status
* at the worker if IC reading fails. Immediate re-read is done
@ -516,11 +517,12 @@ struct regulator_irq_data {
* @data: Driver private data pointer which will be passed as such to
* the renable, map_event and die callbacks in regulator_irq_data.
* @die: Protection callback. If IC status reading or recovery actions
* fail fatal_cnt times this callback or BUG() is called. This
* callback should implement a final protection attempt like
* disabling the regulator. If protection succeeded this may
* return 0. If anything else is returned the core assumes final
* protection failed and calls BUG() as a last resort.
* fail fatal_cnt times this callback is called or system is
* powered off. This callback should implement a final protection
* attempt like disabling the regulator. If protection succeeded
* die() may return 0. If anything else is returned the core
* assumes final protection failed and attempts to perform a
* poweroff as a last resort.
* @map_event: Driver callback to map IRQ status into regulator devices with
* events / errors. NOTE: callback MUST initialize both the
* errors and notifs for all rdevs which it signals having