Commit b806bec5 authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'regulator-fix-v5.16-rc4' of... 

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
parents 55a677b2 6966df48

include/linux/regulator/driver.h

+8 −6
Original line number Diff line number Diff line
@@ -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