Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 69279fb9 authored by Mark Brown's avatar Mark Brown Committed by Liam Girdwood
Browse files

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: default avatarMark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: default avatarLiam Girdwood <lrg@slimlogic.co.uk>
parent 8dc5390d
Loading
Loading
Loading
Loading
+22 −22
Original line number Original line Diff line number Diff line
@@ -655,7 +655,7 @@ static void print_constraints(struct regulator_dev *rdev)


/**
/**
 * set_machine_constraints - sets regulator constraints
 * set_machine_constraints - sets regulator constraints
 * @regulator: regulator source
 * @rdev: regulator source
 *
 *
 * Allows platform initialisation code to define and constrain
 * Allows platform initialisation code to define and constrain
 * regulator circuits e.g. valid voltage/current ranges, etc.  NOTE:
 * regulator circuits e.g. valid voltage/current ranges, etc.  NOTE:
@@ -730,8 +730,8 @@ static int set_machine_constraints(struct regulator_dev *rdev,


/**
/**
 * set_supply - set regulator supply regulator
 * set_supply - set regulator supply regulator
 * @regulator: regulator name
 * @rdev: regulator name
 * @supply: supply regulator name
 * @supply_rdev: supply regulator name
 *
 *
 * Called by platform initialisation code to set the supply regulator for this
 * Called by platform initialisation code to set the supply regulator for this
 * regulator. This ensures that a regulators supply will also be enabled by the
 * regulator. This ensures that a regulators supply will also be enabled by the
@@ -758,8 +758,8 @@ static int set_supply(struct regulator_dev *rdev,


/**
/**
 * set_consumer_device_supply: Bind a regulator to a symbolic supply
 * set_consumer_device_supply: Bind a regulator to a symbolic supply
 * @regulator: regulator source
 * @rdev:         regulator source
 * @dev:       device the supply applies to
 * @consumer_dev: device the supply applies to
 * @supply:       symbolic name for supply
 * @supply:       symbolic name for supply
 *
 *
 * Allows platform initialisation code to map physical regulator
 * Allows platform initialisation code to map physical regulator
@@ -1013,9 +1013,8 @@ static int _regulator_enable(struct regulator_dev *rdev)
 *
 *
 * Enable the regulator output at the predefined voltage or current value.
 * Enable the regulator output at the predefined voltage or current value.
 * NOTE: the output value can be set by other drivers, boot loader or may be
 * NOTE: the output value can be set by other drivers, boot loader or may be
 * hardwired in the regulator.
 * hardwired in the regulator.  Calls to regulator_enable() must be balanced
 * NOTE: calls to regulator_enable() must be balanced with calls to
 * with calls to regulator_disable().
 * regulator_disable().
 */
 */
int regulator_enable(struct regulator *regulator)
int regulator_enable(struct regulator *regulator)
{
{
@@ -1074,10 +1073,10 @@ static int _regulator_disable(struct regulator_dev *rdev)
 * @regulator: regulator source
 * @regulator: regulator source
 *
 *
 * Disable the regulator output voltage or current.
 * Disable the regulator output voltage or current.
 *
 * NOTE: this will only disable the regulator output if no other consumer
 * NOTE: this will only disable the regulator output if no other consumer
 * devices have it enabled.
 * devices have it enabled.  Calls to regulator_enable() must be balanced with
 * NOTE: calls to regulator_enable() must be balanced with calls to
 * calls to regulator_disable().
 * regulator_disable().
 */
 */
int regulator_disable(struct regulator *regulator)
int regulator_disable(struct regulator *regulator)
{
{
@@ -1200,7 +1199,7 @@ EXPORT_SYMBOL_GPL(regulator_is_enabled);
 *
 *
 * NOTE: If the regulator is shared between several devices then the lowest
 * NOTE: If the regulator is shared between several devices then the lowest
 * request voltage that meets the system constraints will be used.
 * request voltage that meets the system constraints will be used.
 * NOTE: Regulator system constraints must be set for this regulator before
 * Regulator system constraints must be set for this regulator before
 * calling this function otherwise this call will fail.
 * calling this function otherwise this call will fail.
 */
 */
int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV)
int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV)
@@ -1498,7 +1497,7 @@ EXPORT_SYMBOL_GPL(regulator_set_optimum_mode);
/**
/**
 * regulator_register_notifier - register regulator event notifier
 * regulator_register_notifier - register regulator event notifier
 * @regulator: regulator source
 * @regulator: regulator source
 * @notifier_block: notifier block
 * @nb: notifier block
 *
 *
 * Register notifier block to receive regulator events.
 * Register notifier block to receive regulator events.
 */
 */
@@ -1513,7 +1512,7 @@ EXPORT_SYMBOL_GPL(regulator_register_notifier);
/**
/**
 * regulator_unregister_notifier - unregister regulator event notifier
 * regulator_unregister_notifier - unregister regulator event notifier
 * @regulator: regulator source
 * @regulator: regulator source
 * @notifier_block: notifier block
 * @nb: notifier block
 *
 *
 * Unregister regulator event notifier block.
 * Unregister regulator event notifier block.
 */
 */
@@ -1679,9 +1678,9 @@ EXPORT_SYMBOL_GPL(regulator_bulk_free);


/**
/**
 * regulator_notifier_call_chain - call regulator event notifier
 * regulator_notifier_call_chain - call regulator event notifier
 * @regulator: regulator source
 * @rdev: regulator source
 * @event: notifier block
 * @event: notifier block
 * @data:
 * @data: callback-specific data.
 *
 *
 * Called by regulator drivers to notify clients a regulator event has
 * Called by regulator drivers to notify clients a regulator event has
 * occurred. We also notify regulator clients downstream.
 * occurred. We also notify regulator clients downstream.
@@ -1808,8 +1807,9 @@ static int add_regulator_attributes(struct regulator_dev *rdev)


/**
/**
 * regulator_register - register regulator
 * regulator_register - register regulator
 * @regulator: regulator source
 * @regulator_desc: regulator to register
 * @reg_data: private regulator data
 * @dev: struct device for the regulator
 * @driver_data: private regulator data
 *
 *
 * Called by regulator drivers to register a regulator.
 * Called by regulator drivers to register a regulator.
 * Returns 0 on success.
 * Returns 0 on success.
@@ -1916,7 +1916,7 @@ EXPORT_SYMBOL_GPL(regulator_register);


/**
/**
 * regulator_unregister - unregister regulator
 * regulator_unregister - unregister regulator
 * @regulator: regulator source
 * @rdev: regulator to unregister
 *
 *
 * Called by regulator drivers to unregister a regulator.
 * Called by regulator drivers to unregister a regulator.
 */
 */
@@ -1971,7 +1971,7 @@ EXPORT_SYMBOL_GPL(regulator_suspend_prepare);


/**
/**
 * rdev_get_drvdata - get rdev regulator driver data
 * rdev_get_drvdata - get rdev regulator driver data
 * @regulator: regulator
 * @rdev: regulator
 *
 *
 * Get rdev regulator driver private data. This call can be used in the
 * Get rdev regulator driver private data. This call can be used in the
 * regulator driver context.
 * regulator driver context.
@@ -2008,7 +2008,7 @@ EXPORT_SYMBOL_GPL(regulator_set_drvdata);


/**
/**
 * regulator_get_id - get regulator ID
 * regulator_get_id - get regulator ID
 * @regulator: regulator
 * @rdev: regulator
 */
 */
int rdev_get_id(struct regulator_dev *rdev)
int rdev_get_id(struct regulator_dev *rdev)
{
{
+4 −4
Original line number Original line Diff line number Diff line
@@ -104,9 +104,9 @@ struct regulator;
/**
/**
 * struct regulator_bulk_data - Data used for bulk regulator operations.
 * struct regulator_bulk_data - Data used for bulk regulator operations.
 *
 *
 * @supply   The name of the supply.  Initialised by the user before
 * @supply:   The name of the supply.  Initialised by the user before
 *            using the bulk regulator APIs.
 *            using the bulk regulator APIs.
 * @consumer The regulator consumer for the supply.  This will be managed
 * @consumer: The regulator consumer for the supply.  This will be managed
 *            by the bulk API.
 *            by the bulk API.
 *
 *
 * The regulator APIs provide a series of regulator_bulk_() API calls as
 * The regulator APIs provide a series of regulator_bulk_() API calls as