From: Wolfram Sang Date: Sat, 14 Oct 2017 19:17:09 +0000 (+0200) Subject: mmc: add kerneldoc to mmc_regulator_get_supply() X-Git-Tag: v4.15-rc1~170^2~41 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=1f90e9a38c469e5abc1c7e06a8dd33dd9d2b922d;p=thirdparty%2Flinux.git mmc: add kerneldoc to mmc_regulator_get_supply() Especially, make clear what the return value means. Signed-off-by: Wolfram Sang Signed-off-by: Ulf Hansson --- diff --git a/drivers/mmc/core/core.c b/drivers/mmc/core/core.c index 12b271c2a9122..1f0f44f4dd5f3 100644 --- a/drivers/mmc/core/core.c +++ b/drivers/mmc/core/core.c @@ -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);