diff options
author | Stephen Boyd <sboyd@codeaurora.org> | 2014-05-28 15:41:28 -0400 |
---|---|---|
committer | Mark Brown <broonie@linaro.org> | 2014-05-28 16:25:24 -0400 |
commit | 69c3f7239e29216fbf92a39c86b4e9cc63cd6d74 (patch) | |
tree | cb33c85b08bd96dd6d1fd2c75e556c6107124a9e | |
parent | 366986274c548261c42d5ca24391cb4eef3008c2 (diff) |
regulator: Fix regulator_get_{optional,exclusive}() documentation
regulator_get_optional() doesn't hold an exclusive reference to
the regulator. Fix the documentation and reword the exclusive
documentation to fix the grammatical error "this reference is
held".
Signed-off-by: Stephen Boyd <sboyd@codeaurora.org>
Signed-off-by: Mark Brown <broonie@linaro.org>
-rw-r--r-- | drivers/regulator/core.c | 11 |
1 files changed, 4 insertions, 7 deletions
diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c index 476661117930..d1159badf8ca 100644 --- a/drivers/regulator/core.c +++ b/drivers/regulator/core.c | |||
@@ -1430,9 +1430,9 @@ EXPORT_SYMBOL_GPL(regulator_get); | |||
1430 | * | 1430 | * |
1431 | * Returns a struct regulator corresponding to the regulator producer, | 1431 | * Returns a struct regulator corresponding to the regulator producer, |
1432 | * or IS_ERR() condition containing errno. Other consumers will be | 1432 | * or IS_ERR() condition containing errno. Other consumers will be |
1433 | * unable to obtain this reference is held and the use count for the | 1433 | * unable to obtain this regulator while this reference is held and the |
1434 | * regulator will be initialised to reflect the current state of the | 1434 | * use count for the regulator will be initialised to reflect the current |
1435 | * regulator. | 1435 | * state of the regulator. |
1436 | * | 1436 | * |
1437 | * This is intended for use by consumers which cannot tolerate shared | 1437 | * This is intended for use by consumers which cannot tolerate shared |
1438 | * use of the regulator such as those which need to force the | 1438 | * use of the regulator such as those which need to force the |
@@ -1456,10 +1456,7 @@ EXPORT_SYMBOL_GPL(regulator_get_exclusive); | |||
1456 | * @id: Supply name or regulator ID. | 1456 | * @id: Supply name or regulator ID. |
1457 | * | 1457 | * |
1458 | * Returns a struct regulator corresponding to the regulator producer, | 1458 | * Returns a struct regulator corresponding to the regulator producer, |
1459 | * or IS_ERR() condition containing errno. Other consumers will be | 1459 | * or IS_ERR() condition containing errno. |
1460 | * unable to obtain this reference is held and the use count for the | ||
1461 | * regulator will be initialised to reflect the current state of the | ||
1462 | * regulator. | ||
1463 | * | 1460 | * |
1464 | * This is intended for use by consumers for devices which can have | 1461 | * This is intended for use by consumers for devices which can have |
1465 | * some supplies unconnected in normal use, such as some MMC devices. | 1462 | * some supplies unconnected in normal use, such as some MMC devices. |