mirrors/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2024-10-02 07:04:24 +00:00
Code Issues Releases Wiki Activity

regulator: devres: Standardise on function documentation headers

Browse source 
Line up descriptions, start description with a lower-case character and
omit old definitions such as quoting the old argument "consumer".

Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200708124832.3441649-4-lee.jones@linaro.org
Signed-off-by: Mark Brown <broonie@kernel.org>
This commit is contained in:
Lee Jones 2020-07-08 13:48:32 +01:00 committed by Mark Brown
parent 45e8446e7a
commit a7c15187b3
No known key found for this signature in database
GPG key ID: 24D68B725D5487D0
1 changed files with 26 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
drivers/regulator/devres.c
View file

@ -41,8 +41,8 @@ static struct regulator *_devm_regulator_get(struct device *dev, const char *id,
/** /**
* devm_regulator_get - Resource managed regulator_get() * devm_regulator_get - Resource managed regulator_get()
* @dev: device for regulator "consumer" * @dev: device to supply
* @id: Supply name or regulator ID. * @id: supply name or regulator ID.
* *
* Managed regulator_get(). Regulators returned from this function are * Managed regulator_get(). Regulators returned from this function are
* automatically regulator_put() on driver detach. See regulator_get() for more * automatically regulator_put() on driver detach. See regulator_get() for more
@ -56,8 +56,8 @@ EXPORT_SYMBOL_GPL(devm_regulator_get);
/** /**
* devm_regulator_get_exclusive - Resource managed regulator_get_exclusive() * devm_regulator_get_exclusive - Resource managed regulator_get_exclusive()
* @dev: device for regulator "consumer" * @dev: device to supply
* @id: Supply name or regulator ID. * @id: supply name or regulator ID.
* *
* Managed regulator_get_exclusive(). Regulators returned from this function * Managed regulator_get_exclusive(). Regulators returned from this function
* are automatically regulator_put() on driver detach. See regulator_get() for * are automatically regulator_put() on driver detach. See regulator_get() for
@ -72,8 +72,8 @@ EXPORT_SYMBOL_GPL(devm_regulator_get_exclusive);
/** /**
* devm_regulator_get_optional - Resource managed regulator_get_optional() * devm_regulator_get_optional - Resource managed regulator_get_optional()
* @dev: device for regulator "consumer" * @dev: device to supply
* @id: Supply name or regulator ID. * @id: supply name or regulator ID.
* *
* Managed regulator_get_optional(). Regulators returned from this * Managed regulator_get_optional(). Regulators returned from this
* function are automatically regulator_put() on driver detach. See * function are automatically regulator_put() on driver detach. See
@ -130,9 +130,9 @@ static void devm_regulator_bulk_release(struct device *dev, void *res)
/** /**
* devm_regulator_bulk_get - managed get multiple regulator consumers * devm_regulator_bulk_get - managed get multiple regulator consumers
* *
* @dev: Device to supply * @dev: device to supply
* @num_consumers: Number of consumers to register * @num_consumers: number of consumers to register
* @consumers: Configuration of consumers; clients are stored here. * @consumers: configuration of consumers; clients are stored here.
* *
* @return 0 on success, an errno on failure. * @return 0 on success, an errno on failure.
* *
@ -173,9 +173,9 @@ static void devm_rdev_release(struct device *dev, void *res)
/** /**
* devm_regulator_register - Resource managed regulator_register() * devm_regulator_register - Resource managed regulator_register()
* @dev: device to supply * @dev: device to supply
* @regulator_desc: regulator to register * @regulator_desc: regulator to register
* @config: runtime configuration for regulator * @config: runtime configuration for regulator
* *
* Called by regulator drivers to register a regulator. Returns a * Called by regulator drivers to register a regulator. Returns a
* valid pointer to struct regulator_dev on success or an ERR_PTR() on * valid pointer to struct regulator_dev on success or an ERR_PTR() on
@ -259,10 +259,10 @@ static void devm_regulator_destroy_supply_alias(struct device *dev, void *res)
* devm_regulator_register_supply_alias - Resource managed * devm_regulator_register_supply_alias - Resource managed
* regulator_register_supply_alias() * regulator_register_supply_alias()
* *
* @dev: device that will be given as the regulator "consumer" * @dev: device to supply
* @id: Supply name or regulator ID * @id: supply name or regulator ID
* @alias_dev: device that should be used to lookup the supply * @alias_dev: device that should be used to lookup the supply
* @alias_id: Supply name or regulator ID that should be used to lookup the * @alias_id: supply name or regulator ID that should be used to lookup the
* supply * supply
* *
* The supply alias will automatically be unregistered when the source * The supply alias will automatically be unregistered when the source
@ -300,8 +300,8 @@ EXPORT_SYMBOL_GPL(devm_regulator_register_supply_alias);
* devm_regulator_unregister_supply_alias - Resource managed * devm_regulator_unregister_supply_alias - Resource managed
* regulator_unregister_supply_alias() * regulator_unregister_supply_alias()
* *
* @dev: device that will be given as the regulator "consumer" * @dev: device to supply
* @id: Supply name or regulator ID * @id: supply name or regulator ID
* *
* Unregister an alias registered with * Unregister an alias registered with
* devm_regulator_register_supply_alias(). Normally this function * devm_regulator_register_supply_alias(). Normally this function
@ -327,12 +327,12 @@ EXPORT_SYMBOL_GPL(devm_regulator_unregister_supply_alias);
* devm_regulator_bulk_register_supply_alias - Managed register * devm_regulator_bulk_register_supply_alias - Managed register
* multiple aliases * multiple aliases
* *
* @dev: device that will be given as the regulator "consumer" * @dev: device to supply
* @id: List of supply names or regulator IDs * @id: list of supply names or regulator IDs
* @alias_dev: device that should be used to lookup the supply * @alias_dev: device that should be used to lookup the supply
* @alias_id: List of supply names or regulator IDs that should be used to * @alias_id: list of supply names or regulator IDs that should be used to
* lookup the supply * lookup the supply
* @num_id: Number of aliases to register * @num_id: number of aliases to register
* *
* @return 0 on success, an errno on failure. * @return 0 on success, an errno on failure.
* *
@ -377,9 +377,9 @@ EXPORT_SYMBOL_GPL(devm_regulator_bulk_register_supply_alias);
* devm_regulator_bulk_unregister_supply_alias - Managed unregister * devm_regulator_bulk_unregister_supply_alias - Managed unregister
* multiple aliases * multiple aliases
* *
* @dev: device that will be given as the regulator "consumer" * @dev: device to supply
* @id: List of supply names or regulator IDs * @id: list of supply names or regulator IDs
* @num_id: Number of aliases to unregister * @num_id: number of aliases to unregister
* *
* Unregister aliases registered with * Unregister aliases registered with
* devm_regulator_bulk_register_supply_alias(). Normally this function * devm_regulator_bulk_register_supply_alias(). Normally this function
@ -423,7 +423,7 @@ static void devm_regulator_destroy_notifier(struct device *dev, void *res)
* regulator_register_notifier * regulator_register_notifier
* *
* @regulator: regulator source * @regulator: regulator source
* @nb: notifier block * @nb: notifier block
* *
* The notifier will be registers under the consumer device and be * The notifier will be registers under the consumer device and be
* automatically be unregistered when the source device is unbound. * automatically be unregistered when the source device is unbound.
@ -460,7 +460,7 @@ EXPORT_SYMBOL_GPL(devm_regulator_register_notifier);
* regulator_unregister_notifier() * regulator_unregister_notifier()
* *
* @regulator: regulator source * @regulator: regulator source
* @nb: notifier block * @nb: notifier block
* *
* Unregister a notifier registered with devm_regulator_register_notifier(). * Unregister a notifier registered with devm_regulator_register_notifier().
* Normally this function will not need to be called and the resource * Normally this function will not need to be called and the resource