Commit 1f90e9a3 authored by Wolfram Sang's avatar Wolfram Sang Committed by Ulf Hansson
Browse files

mmc: add kerneldoc to mmc_regulator_get_supply() 



Especially, make clear what the return value means.

Signed-off-by: default avatarWolfram Sang <wsa+renesas@sang-engineering.com>
Signed-off-by: default avatarUlf Hansson <ulf.hansson@linaro.org>
parent f02cebdf

drivers/mmc/core/core.c

+10 −0
Original line number Diff line number Diff line
@@ -1588,6 +1588,16 @@ EXPORT_SYMBOL_GPL(mmc_regulator_set_vqmmc); 


#endif /* CONFIG_REGULATOR */



/**

 * mmc_regulator_get_supply - try to get VMMC and VQMMC regulators for a host

 * @mmc: the host to regulate

 *

 * Returns 0 or errno. errno should be handled, it is either a critical error

 * or -EPROBE_DEFER. 0 means no critical error but it does not mean all

 * regulators have been found because they all are optional. If you require

 * certain regulators, you need to check separately in your driver if they got

 * populated after calling this function.

 */

int mmc_regulator_get_supply(struct mmc_host *mmc)

{

	struct device *dev = mmc_dev(mmc);