Unverified Commit e55f45b0 authored by Jerome Brunet's avatar Jerome Brunet Committed by Mark Brown
Browse files

regulator: doc: add missing documentation for init_cb 



Add comment documenting introduced init_cb.
This solves the following warning when building the kernel documentation:

./include/linux/regulator/driver.h:435: warning: Function parameter or struct member 'init_cb' not described in 'regulator_desc'

Fixes: cfcdf395 ("regulator: core: add callback to perform runtime init")
Reported-by: default avatarStephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/lkml/20241023155120.6c4fea20@canb.auug.org.au/


Signed-off-by: default avatarJerome Brunet <jbrunet@baylibre.com>
Link: https://patch.msgid.link/20241023-regulator-doc-fixup-v1-1-ec018742ad73@baylibre.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 5ddc236d

include/linux/regulator/driver.h

+5 −0
Original line number Diff line number Diff line
@@ -269,6 +269,11 @@ enum regulator_type { 
 *               config but it cannot store it for later usage.

 *               Callback should return 0 on success or negative ERRNO

 *               indicating failure.

 * @init_cb: Optional callback called after the parsing of init_data.

 *           Allows the regulator to perform runtime init if necessary,

 *           such as synching the regulator and the parsed constraints.

 *           Callback should return 0 on success or negative ERRNO

 *           indicating failure.

 * @id: Numerical identifier for the regulator.

 * @ops: Regulator operations table.

 * @irq: Interrupt number for the regulator.