diff options
author | Mark Brown <broonie@opensource.wolfsonmicro.com> | 2008-12-31 07:52:41 -0500 |
---|---|---|
committer | Liam Girdwood <lrg@slimlogic.co.uk> | 2009-01-08 15:10:33 -0500 |
commit | 69279fb9a95051971ac03e558c4d46e7ba84ab3a (patch) | |
tree | 40b924b79cc21eeddd579d5e769503f82ee9396a /drivers/regulator | |
parent | 8dc5390d4f3fd8acc73773a56fea13544e7924dc (diff) |
regulator: Clean up kerneldoc warnings
Remove kerneldoc warnings that don't relate to missing documentation,
mostly by renaming parameters in the documentation to match their
actual names.
Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Liam Girdwood <lrg@slimlogic.co.uk>
Diffstat (limited to 'drivers/regulator')
-rw-r--r-- | drivers/regulator/core.c | 44 |
1 files changed, 22 insertions, 22 deletions
diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c index 7ba9491a05cb..ea12c68c327f 100644 --- a/drivers/regulator/core.c +++ b/drivers/regulator/core.c | |||
@@ -655,7 +655,7 @@ static void print_constraints(struct regulator_dev *rdev) | |||
655 | 655 | ||
656 | /** | 656 | /** |
657 | * set_machine_constraints - sets regulator constraints | 657 | * set_machine_constraints - sets regulator constraints |
658 | * @regulator: regulator source | 658 | * @rdev: regulator source |
659 | * | 659 | * |
660 | * Allows platform initialisation code to define and constrain | 660 | * Allows platform initialisation code to define and constrain |
661 | * regulator circuits e.g. valid voltage/current ranges, etc. NOTE: | 661 | * regulator circuits e.g. valid voltage/current ranges, etc. NOTE: |
@@ -730,8 +730,8 @@ out: | |||
730 | 730 | ||
731 | /** | 731 | /** |
732 | * set_supply - set regulator supply regulator | 732 | * set_supply - set regulator supply regulator |
733 | * @regulator: regulator name | 733 | * @rdev: regulator name |
734 | * @supply: supply regulator name | 734 | * @supply_rdev: supply regulator name |
735 | * | 735 | * |
736 | * Called by platform initialisation code to set the supply regulator for this | 736 | * Called by platform initialisation code to set the supply regulator for this |
737 | * regulator. This ensures that a regulators supply will also be enabled by the | 737 | * regulator. This ensures that a regulators supply will also be enabled by the |
@@ -758,9 +758,9 @@ out: | |||
758 | 758 | ||
759 | /** | 759 | /** |
760 | * set_consumer_device_supply: Bind a regulator to a symbolic supply | 760 | * set_consumer_device_supply: Bind a regulator to a symbolic supply |
761 | * @regulator: regulator source | 761 | * @rdev: regulator source |
762 | * @dev: device the supply applies to | 762 | * @consumer_dev: device the supply applies to |
763 | * @supply: symbolic name for supply | 763 | * @supply: symbolic name for supply |
764 | * | 764 | * |
765 | * Allows platform initialisation code to map physical regulator | 765 | * Allows platform initialisation code to map physical regulator |
766 | * sources to symbolic names for supplies for use by devices. Devices | 766 | * sources to symbolic names for supplies for use by devices. Devices |
@@ -1013,9 +1013,8 @@ static int _regulator_enable(struct regulator_dev *rdev) | |||
1013 | * | 1013 | * |
1014 | * Enable the regulator output at the predefined voltage or current value. | 1014 | * Enable the regulator output at the predefined voltage or current value. |
1015 | * NOTE: the output value can be set by other drivers, boot loader or may be | 1015 | * NOTE: the output value can be set by other drivers, boot loader or may be |
1016 | * hardwired in the regulator. | 1016 | * hardwired in the regulator. Calls to regulator_enable() must be balanced |
1017 | * NOTE: calls to regulator_enable() must be balanced with calls to | 1017 | * with calls to regulator_disable(). |
1018 | * regulator_disable(). | ||
1019 | */ | 1018 | */ |
1020 | int regulator_enable(struct regulator *regulator) | 1019 | int regulator_enable(struct regulator *regulator) |
1021 | { | 1020 | { |
@@ -1074,10 +1073,10 @@ static int _regulator_disable(struct regulator_dev *rdev) | |||
1074 | * @regulator: regulator source | 1073 | * @regulator: regulator source |
1075 | * | 1074 | * |
1076 | * Disable the regulator output voltage or current. | 1075 | * Disable the regulator output voltage or current. |
1076 | * | ||
1077 | * NOTE: this will only disable the regulator output if no other consumer | 1077 | * NOTE: this will only disable the regulator output if no other consumer |
1078 | * devices have it enabled. | 1078 | * devices have it enabled. Calls to regulator_enable() must be balanced with |
1079 | * NOTE: calls to regulator_enable() must be balanced with calls to | 1079 | * calls to regulator_disable(). |
1080 | * regulator_disable(). | ||
1081 | */ | 1080 | */ |
1082 | int regulator_disable(struct regulator *regulator) | 1081 | int regulator_disable(struct regulator *regulator) |
1083 | { | 1082 | { |
@@ -1200,7 +1199,7 @@ EXPORT_SYMBOL_GPL(regulator_is_enabled); | |||
1200 | * | 1199 | * |
1201 | * NOTE: If the regulator is shared between several devices then the lowest | 1200 | * NOTE: If the regulator is shared between several devices then the lowest |
1202 | * request voltage that meets the system constraints will be used. | 1201 | * request voltage that meets the system constraints will be used. |
1203 | * NOTE: Regulator system constraints must be set for this regulator before | 1202 | * Regulator system constraints must be set for this regulator before |
1204 | * calling this function otherwise this call will fail. | 1203 | * calling this function otherwise this call will fail. |
1205 | */ | 1204 | */ |
1206 | int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV) | 1205 | int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV) |
@@ -1498,7 +1497,7 @@ EXPORT_SYMBOL_GPL(regulator_set_optimum_mode); | |||
1498 | /** | 1497 | /** |
1499 | * regulator_register_notifier - register regulator event notifier | 1498 | * regulator_register_notifier - register regulator event notifier |
1500 | * @regulator: regulator source | 1499 | * @regulator: regulator source |
1501 | * @notifier_block: notifier block | 1500 | * @nb: notifier block |
1502 | * | 1501 | * |
1503 | * Register notifier block to receive regulator events. | 1502 | * Register notifier block to receive regulator events. |
1504 | */ | 1503 | */ |
@@ -1513,7 +1512,7 @@ EXPORT_SYMBOL_GPL(regulator_register_notifier); | |||
1513 | /** | 1512 | /** |
1514 | * regulator_unregister_notifier - unregister regulator event notifier | 1513 | * regulator_unregister_notifier - unregister regulator event notifier |
1515 | * @regulator: regulator source | 1514 | * @regulator: regulator source |
1516 | * @notifier_block: notifier block | 1515 | * @nb: notifier block |
1517 | * | 1516 | * |
1518 | * Unregister regulator event notifier block. | 1517 | * Unregister regulator event notifier block. |
1519 | */ | 1518 | */ |
@@ -1679,9 +1678,9 @@ EXPORT_SYMBOL_GPL(regulator_bulk_free); | |||
1679 | 1678 | ||
1680 | /** | 1679 | /** |
1681 | * regulator_notifier_call_chain - call regulator event notifier | 1680 | * regulator_notifier_call_chain - call regulator event notifier |
1682 | * @regulator: regulator source | 1681 | * @rdev: regulator source |
1683 | * @event: notifier block | 1682 | * @event: notifier block |
1684 | * @data: | 1683 | * @data: callback-specific data. |
1685 | * | 1684 | * |
1686 | * Called by regulator drivers to notify clients a regulator event has | 1685 | * Called by regulator drivers to notify clients a regulator event has |
1687 | * occurred. We also notify regulator clients downstream. | 1686 | * occurred. We also notify regulator clients downstream. |
@@ -1808,8 +1807,9 @@ static int add_regulator_attributes(struct regulator_dev *rdev) | |||
1808 | 1807 | ||
1809 | /** | 1808 | /** |
1810 | * regulator_register - register regulator | 1809 | * regulator_register - register regulator |
1811 | * @regulator: regulator source | 1810 | * @regulator_desc: regulator to register |
1812 | * @reg_data: private regulator data | 1811 | * @dev: struct device for the regulator |
1812 | * @driver_data: private regulator data | ||
1813 | * | 1813 | * |
1814 | * Called by regulator drivers to register a regulator. | 1814 | * Called by regulator drivers to register a regulator. |
1815 | * Returns 0 on success. | 1815 | * Returns 0 on success. |
@@ -1916,7 +1916,7 @@ EXPORT_SYMBOL_GPL(regulator_register); | |||
1916 | 1916 | ||
1917 | /** | 1917 | /** |
1918 | * regulator_unregister - unregister regulator | 1918 | * regulator_unregister - unregister regulator |
1919 | * @regulator: regulator source | 1919 | * @rdev: regulator to unregister |
1920 | * | 1920 | * |
1921 | * Called by regulator drivers to unregister a regulator. | 1921 | * Called by regulator drivers to unregister a regulator. |
1922 | */ | 1922 | */ |
@@ -1971,7 +1971,7 @@ EXPORT_SYMBOL_GPL(regulator_suspend_prepare); | |||
1971 | 1971 | ||
1972 | /** | 1972 | /** |
1973 | * rdev_get_drvdata - get rdev regulator driver data | 1973 | * rdev_get_drvdata - get rdev regulator driver data |
1974 | * @regulator: regulator | 1974 | * @rdev: regulator |
1975 | * | 1975 | * |
1976 | * Get rdev regulator driver private data. This call can be used in the | 1976 | * Get rdev regulator driver private data. This call can be used in the |
1977 | * regulator driver context. | 1977 | * regulator driver context. |
@@ -2008,7 +2008,7 @@ EXPORT_SYMBOL_GPL(regulator_set_drvdata); | |||
2008 | 2008 | ||
2009 | /** | 2009 | /** |
2010 | * regulator_get_id - get regulator ID | 2010 | * regulator_get_id - get regulator ID |
2011 | * @regulator: regulator | 2011 | * @rdev: regulator |
2012 | */ | 2012 | */ |
2013 | int rdev_get_id(struct regulator_dev *rdev) | 2013 | int rdev_get_id(struct regulator_dev *rdev) |
2014 | { | 2014 | { |