Skip to content

Commit 81963d1

Browse files
rddunlapsre
authored andcommitted
power: supply: ab8500_chargalg: improve kernel-doc
Correct "bad line" warnings and add descriptions for missing entries to avoid these warnings: ab8500_chargalg.c:173: warning: bad line: is set ab8500_chargalg.c:179: warning: bad line: increased ab8500_chargalg.c:247: warning: Function parameter or struct member 't_hyst_norm' not described in 'ab8500_chargalg' ab8500_chargalg.c:247: warning: Function parameter or struct member 't_hyst_lowhigh' not described in 'ab8500_chargalg' ab8500_chargalg.c:247: warning: Function parameter or struct member 'ccm' not described in 'ab8500_chargalg' ab8500_chargalg.c:247: warning: Function parameter or struct member 'ac_chg' not described in 'ab8500_chargalg' ab8500_chargalg.c:247: warning: Function parameter or struct member 'usb_chg' not described in 'ab8500_chargalg' ab8500_chargalg.c:308: warning: Function parameter or struct member 'state' not described in 'ab8500_chargalg_state_to' ab8500_chargalg.c:773: warning: Function parameter or struct member 'di' not described in 'ab8500_chargalg_chg_curr_maxim' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Linus Walleij <linus.walleij@linaro.org> Link: https://patch.msgid.link/20251111060009.1959425-1-rdunlap@infradead.org Signed-off-by: Sebastian Reichel <sebastian.reichel@collabora.com>
1 parent 2c7e46e commit 81963d1

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

drivers/power/supply/ab8500_chargalg.c

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -170,13 +170,13 @@ struct ab8500_chargalg_events {
170170
* @original_iset_ua: the non optimized/maximised charger current
171171
* @current_iset_ua: the charging current used at this moment
172172
* @condition_cnt: number of iterations needed before a new charger current
173-
is set
173+
* is set
174174
* @max_current_ua: maximum charger current
175175
* @wait_cnt: to avoid too fast current step down in case of charger
176176
* voltage collapse, we insert this delay between step
177177
* down
178178
* @level: tells in how many steps the charging current has been
179-
increased
179+
* increased
180180
*/
181181
struct ab8500_charge_curr_maximization {
182182
int original_iset_ua;
@@ -199,18 +199,20 @@ enum maxim_ret {
199199
* @charge_status: battery operating status
200200
* @eoc_cnt: counter used to determine end-of_charge
201201
* @maintenance_chg: indicate if maintenance charge is active
202-
* @t_hyst_norm temperature hysteresis when the temperature has been
202+
* @t_hyst_norm: temperature hysteresis when the temperature has been
203203
* over or under normal limits
204-
* @t_hyst_lowhigh temperature hysteresis when the temperature has been
204+
* @t_hyst_lowhigh: temperature hysteresis when the temperature has been
205205
* over or under the high or low limits
206206
* @charge_state: current state of the charging algorithm
207-
* @ccm charging current maximization parameters
207+
* @ccm: charging current maximization parameters
208208
* @chg_info: information about connected charger types
209209
* @batt_data: data of the battery
210210
* @bm: Platform specific battery management information
211211
* @parent: pointer to the struct ab8500
212212
* @chargalg_psy: structure that holds the battery properties exposed by
213213
* the charging algorithm
214+
* @ac_chg: AC charger power supply
215+
* @usb_chg: USB charger power supply
214216
* @events: structure for information about events triggered
215217
* @chargalg_wq: work queue for running the charging algorithm
216218
* @chargalg_periodic_work: work to run the charging algorithm periodically
@@ -300,6 +302,7 @@ ab8500_chargalg_maintenance_timer_expired(struct hrtimer *timer)
300302
/**
301303
* ab8500_chargalg_state_to() - Change charge state
302304
* @di: pointer to the ab8500_chargalg structure
305+
* @state: new charge algorithm state
303306
*
304307
* This function gets called when a charge state change should occur
305308
*/
@@ -763,7 +766,7 @@ static void init_maxim_chg_curr(struct ab8500_chargalg *di)
763766
/**
764767
* ab8500_chargalg_chg_curr_maxim - increases the charger current to
765768
* compensate for the system load
766-
* @di pointer to the ab8500_chargalg structure
769+
* @di: pointer to the ab8500_chargalg structure
767770
*
768771
* This maximization function is used to raise the charger current to get the
769772
* battery current as close to the optimal value as possible. The battery

0 commit comments

Comments
 (0)