Commit 32c52eff authored by Julia Lawall's avatar Julia Lawall Committed by Sebastian Reichel

power: supply: improve function-level documentation

In drivers/power/supply/ab8500_fg.c, fix two typos and adjust the function
name in two cases to correspond to the names of the defined functions.

In drivers/power/supply/power_supply_core.c, change two variable names to
the names of the corresponding parameters.

Issue detected using Coccinelle (http://coccinelle.lip6.fr/)
Signed-off-by: default avatarJulia Lawall <Julia.Lawall@lip6.fr>
Signed-off-by: default avatarSebastian Reichel <sre@kernel.org>
parent 29676833
...@@ -1900,7 +1900,7 @@ static void ab8500_fg_low_bat_work(struct work_struct *work) ...@@ -1900,7 +1900,7 @@ static void ab8500_fg_low_bat_work(struct work_struct *work)
* ab8500_fg_battok_calc - calculate the bit pattern corresponding * ab8500_fg_battok_calc - calculate the bit pattern corresponding
* to the target voltage. * to the target voltage.
* @di: pointer to the ab8500_fg structure * @di: pointer to the ab8500_fg structure
* @target target voltage * @target: target voltage
* *
* Returns bit pattern closest to the target voltage * Returns bit pattern closest to the target voltage
* valid return values are 0-14. (0-BATT_OK_MAX_NR_INCREMENTS) * valid return values are 0-14. (0-BATT_OK_MAX_NR_INCREMENTS)
...@@ -2391,7 +2391,7 @@ static void ab8500_fg_external_power_changed(struct power_supply *psy) ...@@ -2391,7 +2391,7 @@ static void ab8500_fg_external_power_changed(struct power_supply *psy)
} }
/** /**
* abab8500_fg_reinit_work() - work to reset the FG algorithm * ab8500_fg_reinit_work() - work to reset the FG algorithm
* @work: pointer to the work_struct structure * @work: pointer to the work_struct structure
* *
* Used to reset the current battery capacity to be able to * Used to reset the current battery capacity to be able to
...@@ -2528,7 +2528,7 @@ static struct kobj_type ab8500_fg_ktype = { ...@@ -2528,7 +2528,7 @@ static struct kobj_type ab8500_fg_ktype = {
}; };
/** /**
* ab8500_chargalg_sysfs_exit() - de-init of sysfs entry * ab8500_fg_sysfs_exit() - de-init of sysfs entry
* @di: pointer to the struct ab8500_chargalg * @di: pointer to the struct ab8500_chargalg
* *
* This function removes the entry in sysfs. * This function removes the entry in sysfs.
...@@ -2539,7 +2539,7 @@ static void ab8500_fg_sysfs_exit(struct ab8500_fg *di) ...@@ -2539,7 +2539,7 @@ static void ab8500_fg_sysfs_exit(struct ab8500_fg *di)
} }
/** /**
* ab8500_chargalg_sysfs_init() - init of sysfs entry * ab8500_fg_sysfs_init() - init of sysfs entry
* @di: pointer to the struct ab8500_chargalg * @di: pointer to the struct ab8500_chargalg
* *
* This function adds an entry in sysfs. * This function adds an entry in sysfs.
......
...@@ -413,7 +413,7 @@ static int power_supply_match_device_node(struct device *dev, const void *data) ...@@ -413,7 +413,7 @@ static int power_supply_match_device_node(struct device *dev, const void *data)
/** /**
* power_supply_get_by_phandle() - Search for a power supply and returns its ref * power_supply_get_by_phandle() - Search for a power supply and returns its ref
* @np: Pointer to device node holding phandle property * @np: Pointer to device node holding phandle property
* @phandle_name: Name of property holding a power supply name * @property: Name of property holding a power supply name
* *
* If power supply was found, it increases reference count for the * If power supply was found, it increases reference count for the
* internal power supply's device. The user should power_supply_put() * internal power supply's device. The user should power_supply_put()
...@@ -458,7 +458,7 @@ static void devm_power_supply_put(struct device *dev, void *res) ...@@ -458,7 +458,7 @@ static void devm_power_supply_put(struct device *dev, void *res)
* devm_power_supply_get_by_phandle() - Resource managed version of * devm_power_supply_get_by_phandle() - Resource managed version of
* power_supply_get_by_phandle() * power_supply_get_by_phandle()
* @dev: Pointer to device holding phandle property * @dev: Pointer to device holding phandle property
* @phandle_name: Name of property holding a power supply phandle * @property: Name of property holding a power supply phandle
* *
* Return: On success returns a reference to a power supply with * Return: On success returns a reference to a power supply with
* matching name equals to value under @property, NULL or ERR_PTR otherwise. * matching name equals to value under @property, NULL or ERR_PTR otherwise.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment