power: supply: Fix external_power_changed race in several drivers
Subsystems (7)
cover power: supply: Fix external_power_changed race in several drivers
Hi All,
I hit this issue where a Lenovo Yoga Book yb1-x90f would hang on boot every couple of boots.
The problem was that bq25890_charger_external_power_changed() dereferences bq->charger, which gets sets in bq25890_power_supply_init() like this:
bq->charger = devm_power_supply_register(bq->dev, &bq->desc, &psy_cfg);
As soon as devm_power_supply_register() has called device_add() the external_power_changed callback can get called. So there is a window where bq25890_charger_external_power_changed() may get called while bq->charger has not been set yet leading to a NULL pointer dereference.
This race hits on the yb1-x90f when the cht_wcove_pwrsrc (extcon) psy is done with detecting the charger, which happens to exactly hit the window:
BUG: kernel NULL pointer dereference, address: 0000000000000018
<snip>
RIP: 0010:__power_supply_is_supplied_by+0xb/0xb0
<snip>
Call Trace:
<TASK>
__power_supply_get_supplier_property+0x19/0x50
class_for_each_device+0xb1/0xe0
power_supply_get_property_from_supplier+0x2e/0x50
bq25890_charger_external_power_changed+0x38/0x1b0 [bq25890_charger]
__power_supply_changed_work+0x30/0x40
class_for_each_device+0xb1/0xe0
power_supply_changed_work+0x5f/0xe0
<snip>This series fixes this issue in the bq25890 + 3 other drivers with the same issue. Patches 5-6 are small cleanup patches for 2 other drivers which I audited for the same issue.
Regards,
Hans
Hans de Goede (6):
power: supply: ab8500: Fix external_power_changed race
power: supply: axp288_fuel_gauge: Fix external_power_changed race
power: supply: bq25890: Fix external_power_changed race
power: supply: sc27xx: Fix external_power_changed race
power: supply: max17042_battery: Refactor
max17042_external_power_changed()
power: supply: twl4030_madc_battery: Refactor
twl4030_madc_bat_ext_changed()drivers/power/supply/ab8500_btemp.c | 6 ++---- drivers/power/supply/ab8500_fg.c | 6 ++---- drivers/power/supply/axp288_fuel_gauge.c | 2 +- drivers/power/supply/bq25890_charger.c | 2 +- drivers/power/supply/max17042_battery.c | 7 +------ drivers/power/supply/sc27xx_fuel_gauge.c | 9 +-------- drivers/power/supply/twl4030_madc_battery.c | 8 +------- 7 files changed, 9 insertions(+), 31 deletions(-)
Signature · 1 line
2.39.1
PATCH 1/6 power: supply: ab8500: Fix external_power_changed race
ab8500_btemp_external_power_changed() dereferences di->btemp_psy, which gets sets in ab8500_btemp_probe() like this:
di->btemp_psy = devm_power_supply_register(dev, &ab8500_btemp_desc,
&psy_cfg);As soon as devm_power_supply_register() has called device_add() the external_power_changed callback can get called. So there is a window where ab8500_btemp_external_power_changed() may get called while di->btemp_psy has not been set yet leading to a NULL pointer dereference.
Fixing this is easy. The external_power_changed callback gets passed the power_supply which will eventually get stored in di->btemp_psy, so ab8500_btemp_external_power_changed() can simply directly use the passed in psy argument which is always valid.
And the same applies to ab8500_fg_external_power_changed().
---
Note this has been compile tested only
--- drivers/power/supply/ab8500_btemp.c | 6 ++---- drivers/power/supply/ab8500_fg.c | 6 ++---- 2 files changed, 4 insertions(+), 8 deletions(-)
drivers/power/supply/ab8500_btemp.c +2 -4
@@ -624,10 +624,8 @@ static int ab8500_btemp_get_ext_psy_data(struct device *dev, void *data)*/ static void ab8500_btemp_external_power_changed (struct power_supply *psy) { -struct ab8500_btemp *di =power_supply_get_drvdata (psy); - -class_for_each_device (power_supply_class,NULL , - di->btemp_psy, ab8500_btemp_get_ext_psy_data); +class_for_each_device (power_supply_class,NULL , psy, + ab8500_btemp_get_ext_psy_data); }/* ab8500 btemp driver interrupts and their respective isr */
drivers/power/supply/ab8500_fg.c +2 -4
@@ -2407,10 +2407,8 @@ static int ab8500_fg_init_hw_registers(struct ab8500_fg *di)*/ static void ab8500_fg_external_power_changed (struct power_supply *psy) { -struct ab8500_fg *di =power_supply_get_drvdata (psy); - -class_for_each_device (power_supply_class,NULL , - di->fg_psy, ab8500_fg_get_ext_psy_data); +class_for_each_device (power_supply_class,NULL , psy, + ab8500_fg_get_ext_psy_data); }/**
Signature · 1 line
2.39.1
Re: [PATCH 1/6] power: supply: ab8500: Fix external_power_changed race
Quoted 16 lines · Hans de Goede
ab8500_btemp_external_power_changed()dereferencesdi->btemp_psy, which gets sets inab8500_btemp_probe()like this:di->btemp_psy = devm_power_supply_register(dev, &ab8500_btemp_desc, &psy_cfg);As soon as
devm_power_supply_register()has calleddevice_add()theexternal_power_changedcallback can get called. So there is a window whereab8500_btemp_external_power_changed()may get called whiledi->btemp_psyhas not been set yet leading to a NULL pointer dereference.Fixing this is easy. The
external_power_changedcallback gets passed thepower_supplywhich will eventually get stored indi->btemp_psy, soab8500_btemp_external_power_changed()can simply directly use the passed in psy argument which is always valid.
Quoted 4 lines
And the same applies to
ab8500_fg_external_power_changed().Cc Linus Walleij <[email protected]>Signed-off-by Hans de Goede <[email protected]>
Oh sweet!
Thanks for fixing this Hans.
Yours,
Linus Walleij
PATCH 2/6 power: supply: axp288_fuel_gauge: Fix external_power_changed race
In reply to Hans de Goedefuel_gauge_external_power_changed() dereferences info->bat, which gets sets in axp288_fuel_gauge_probe() like this:
info->bat = devm_power_supply_register(dev, &fuel_gauge_desc, &psy_cfg);
As soon as devm_power_supply_register() has called device_add() the external_power_changed callback can get called. So there is a window where fuel_gauge_external_power_changed() may get called while info->bat has not been set yet leading to a NULL pointer dereference.
Fixing this is easy. The external_power_changed callback gets passed the power_supply which will eventually get stored in info->bat, so fuel_gauge_external_power_changed() can simply directly use the passed in psy argument which is always valid.
--- drivers/power/supply/axp288_fuel_gauge.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/power/supply/axp288_fuel_gauge.c +1 -1
@@ -507,7 +507,7 @@ static void fuel_gauge_external_power_changed(struct power_supply *psy)mutex_lock (&info->lock); info->valid =0 ;/* Force updating of the cached registers */ mutex_unlock (&info->lock); -power_supply_changed (info->bat); +power_supply_changed (psy); }static struct power_supply_desc fuel_gauge_desc = {
Signature · 1 line
2.39.1
PATCH 3/6 power: supply: bq25890: Fix external_power_changed race
In reply to Hans de Goedebq25890_charger_external_power_changed() dereferences bq->charger, which gets sets in bq25890_power_supply_init() like this:
bq->charger = devm_power_supply_register(bq->dev, &bq->desc, &psy_cfg);
As soon as devm_power_supply_register() has called device_add() the external_power_changed callback can get called. So there is a window where bq25890_charger_external_power_changed() may get called while bq->charger has not been set yet leading to a NULL pointer dereference.
This race hits during boot sometimes on a Lenovo Yoga Book 1 yb1-x90f when the cht_wcove_pwrsrc (extcon) power_supply is done with detecting the connected charger-type which happens to exactly hit the small window:
BUG: kernel NULL pointer dereference, address: 0000000000000018 <snip> RIP: 0010:__power_supply_is_supplied_by+0xb/0xb0 <snip> Call Trace: <TASK> __power_supply_get_supplier_property+0x19/0x50 class_for_each_device+0xb1/0xe0 power_supply_get_property_from_supplier+0x2e/0x50 bq25890_charger_external_power_changed+0x38/0x1b0 [bq25890_charger] __power_supply_changed_work+0x30/0x40 class_for_each_device+0xb1/0xe0 power_supply_changed_work+0x5f/0xe0 <snip>
Fixing this is easy. The external_power_changed callback gets passed the power_supply which will eventually get stored in bq->charger, so bq25890_charger_external_power_changed() can simply directly use the passed in psy argument which is always valid.
--- drivers/power/supply/bq25890_charger.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/power/supply/bq25890_charger.c +1 -1
@@ -750,7 +750,7 @@ static void bq25890_charger_external_power_changed(struct power_supply *psy)if (bq->chip_version !=BQ25892 )return ; - ret =power_supply_get_property_from_supplier (bq->charger, + ret =power_supply_get_property_from_supplier (psy,POWER_SUPPLY_PROP_USB_TYPE , &val);if (ret)
Signature · 1 line
2.39.1
PATCH 4/6 power: supply: sc27xx: Fix external_power_changed race
In reply to Hans de Goedesc27xx_fgu_external_power_changed() dereferences data->battery, which gets sets in ab8500_btemp_probe() like this:
data->battery = devm_power_supply_register(dev, &sc27xx_fgu_desc,
&fgu_cfg);As soon as devm_power_supply_register() has called device_add() the external_power_changed callback can get called. So there is a window where sc27xx_fgu_external_power_changed() may get called while data->battery has not been set yet leading to a NULL pointer dereference.
Fixing this is easy. The external_power_changed callback gets passed the power_supply which will eventually get stored in data->battery, so sc27xx_fgu_external_power_changed() can simply directly use the passed in psy argument which is always valid.
After this change sc27xx_fgu_external_power_changed() is reduced to just "power_supply_changed(psy);" and it has the same prototype. While at it simply replace it with making the external_power_changed callback directly point to power_supply_changed.
---
Note this has been compile tested only
--- drivers/power/supply/sc27xx_fuel_gauge.c | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-)
drivers/power/supply/sc27xx_fuel_gauge.c +1 -8
@@ -733,13 +733,6 @@ static int sc27xx_fgu_set_property(struct power_supply *psy,return ret; } -static void sc27xx_fgu_external_power_changed (struct power_supply *psy) -{ -struct sc27xx_fgu_data *data =power_supply_get_drvdata (psy); - -power_supply_changed (data->battery); -} -static int sc27xx_fgu_property_is_writeable (struct power_supply *psy,enum power_supply_property psp) {
@@ -774,7 +767,7 @@ static const struct power_supply_desc sc27xx_fgu_desc = { .num_properties = ARRAY_SIZE(sc27xx_fgu_props), .get_property = sc27xx_fgu_get_property, .set_property = sc27xx_fgu_set_property, - .external_power_changed = sc27xx_fgu_external_power_changed, + .external_power_changed = power_supply_changed, .property_is_writeable = sc27xx_fgu_property_is_writeable, .no_thermal = true, };
Signature · 1 line
2.39.1
Re: [PATCH 4/6] power: supply: sc27xx: Fix external_power_changed race
Quoted 21 lines · Hans de Goede
sc27xx_fgu_external_power_changed()dereferencesdata->battery, which gets sets inab8500_btemp_probe()like this:data->battery = devm_power_supply_register(dev, &sc27xx_fgu_desc, &fgu_cfg);As soon as
devm_power_supply_register()has calleddevice_add()theexternal_power_changedcallback can get called. So there is a window wheresc27xx_fgu_external_power_changed()may get called whiledata->batteryhas not been set yet leading to a NULL pointer dereference.Fixing this is easy. The
external_power_changedcallback gets passed thepower_supplywhich will eventually get stored indata->battery, sosc27xx_fgu_external_power_changed()can simply directly use the passed in psy argument which is always valid.After this change
sc27xx_fgu_external_power_changed()is reduced to just "power_supply_changed(psy);" and it has the same prototype. While at it simply replace it with making theexternal_power_changedcallback directly point topower_supply_changed.
Quoted 4 lines
Cc Orson Zhai <[email protected]>Cc Baolin Wang <[email protected]>Cc Chunyan Zhang <[email protected]>Signed-off-by Hans de Goede <[email protected]>
Looks good to me. Thanks.
Quoted 33 lines
---
Note this has been compile tested only--- drivers/power/supply/sc27xx_fuel_gauge.c | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-)drivers/power/supply/sc27xx_fuel_gauge.c +1
-8@@ -733,13 +733,6 @@ static int sc27xx_fgu_set_property(struct power_supply *psy,return ret; } -static void sc27xx_fgu_external_power_changed (struct power_supply *psy) -{ -struct sc27xx_fgu_data *data =power_supply_get_drvdata (psy); - -power_supply_changed (data->battery); -} -static int sc27xx_fgu_property_is_writeable (struct power_supply *psy,enum power_supply_property psp) {@@ -774,7 +767,7 @@ static const struct power_supply_desc sc27xx_fgu_desc = { .num_properties = ARRAY_SIZE(sc27xx_fgu_props), .get_property = sc27xx_fgu_get_property, .set_property = sc27xx_fgu_set_property, - .external_power_changed = sc27xx_fgu_external_power_changed, + .external_power_changed = power_supply_changed, .property_is_writeable = sc27xx_fgu_property_is_writeable, .no_thermal = true, };
PATCH 5/6 power: supply: max17042_battery: Refactor max17042_external_power_changed()
In reply to Hans de Goedemax17042_external_power_changed() is a wrapper around "power_supply_changed(psy);" and it has the same prototype.
Remove it, replacing it with making the external_power_changed callback directly point to power_supply_changed.
--- drivers/power/supply/max17042_battery.c | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-)
drivers/power/supply/max17042_battery.c +1 -6
@@ -499,11 +499,6 @@ static int max17042_property_is_writeable(struct power_supply *psy,return ret; } -static void max17042_external_power_changed (struct power_supply *psy) -{ -power_supply_changed (psy); -} -static int max17042_write_verify_reg (struct regmap *map,u8 reg,u32 value) {int retries =8 ;
@@ -1016,7 +1011,7 @@ static const struct power_supply_desc max17042_psy_desc = { .get_property = max17042_get_property, .set_property = max17042_set_property, .property_is_writeable = max17042_property_is_writeable, - .external_power_changed = max17042_external_power_changed, + .external_power_changed = power_supply_changed, .properties = max17042_battery_props, .num_properties = ARRAY_SIZE(max17042_battery_props), };
Signature · 1 line
2.39.1
Re: [PATCH 5/6] power: supply: max17042_battery: Refactor max17042_external_power_changed()
Quoted 5 lines · Hans de Goede
max17042_external_power_changed()is a wrapper around "power_supply_changed(psy);" and it has the same prototype.Remove it, replacing it with making the
external_power_changedcallback directly point topower_supply_changed.
Best regards,
Krzysztof
PATCH 6/6 power: supply: twl4030_madc_battery: Refactor twl4030_madc_bat_ext_changed()
In reply to Hans de Goedetwl4030_madc_bat_ext_changed() is a wrapper around "power_supply_changed(psy);" and it has the same prototype.
Remove it, replacing it with making the external_power_changed callback directly point to power_supply_changed.
---
Note this has been compile tested only
--- drivers/power/supply/twl4030_madc_battery.c | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-)
drivers/power/supply/twl4030_madc_battery.c +1 -7
@@ -168,19 +168,13 @@ static int twl4030_madc_bat_get_property(struct power_supply *psy,return 0 ; } -static void twl4030_madc_bat_ext_changed (struct power_supply *psy) -{ -power_supply_changed (psy); -} -static const struct power_supply_desc twl4030_madc_bat_desc = { .name ="twl4030_battery" , .type =POWER_SUPPLY_TYPE_BATTERY , .properties = twl4030_madc_bat_props, .num_properties =ARRAY_SIZE (twl4030_madc_bat_props), .get_property = twl4030_madc_bat_get_property, - .external_power_changed = twl4030_madc_bat_ext_changed, - + .external_power_changed = power_supply_changed, };static int twl4030_cmp (const void *a,const void *b)
Signature · 1 line
2.39.1
Hi Hans,
Quoted 31 lines · Hans de Goede
I hit this issue where a Lenovo Yoga Book yb1-x90f would hang on boot every couple of boots.
The problem was that
bq25890_charger_external_power_changed()dereferencesbq->charger, which gets sets inbq25890_power_supply_init()like this:bq->charger = devm_power_supply_register(bq->dev, &bq->desc, &psy_cfg);As soon as
devm_power_supply_register()has calleddevice_add()theexternal_power_changedcallback can get called. So there is a window wherebq25890_charger_external_power_changed()may get called whilebq->chargerhas not been set yet leading to a NULL pointer dereference.This race hits on the yb1-x90f when the
cht_wcove_pwrsrc(extcon) psy is done with detecting the charger, which happens to exactly hit the window:BUG: kernel NULL pointer dereference, address: 0000000000000018 <snip> RIP: 0010:__power_supply_is_supplied_by+0xb/0xb0 <snip> Call Trace: <TASK> __power_supply_get_supplier_property+0x19/0x50 class_for_each_device+0xb1/0xe0 power_supply_get_property_from_supplier+0x2e/0x50 bq25890_charger_external_power_changed+0x38/0x1b0 [bq25890_charger] __power_supply_changed_work+0x30/0x40 class_for_each_device+0xb1/0xe0 power_supply_changed_work+0x5f/0xe0 <snip>
Quoted 3 lines
This series fixes this issue in the bq25890 + 3 other drivers with the same issue. Patches 5-6 are small cleanup patches for 2 other drivers which I audited for the same issue.
Thanks, I queued the first 4 patches to my fixes branch and the 2 cleanups to for-next.
-- Sebastian
Quoted 22 lines
Hans de Goede (6):
power: supply: ab8500: Fixexternal_power_changedrace
power: supply:axp288_fuel_gauge: Fixexternal_power_changedrace
power: supply: bq25890: Fixexternal_power_changedrace
power: supply: sc27xx: Fixexternal_power_changedrace
power: supply:max17042_battery: Refactormax17042_external_power_changed() power: supply: twl4030_madc_battery: Refactor twl4030_madc_bat_ext_changed()drivers/power/supply/ab8500_btemp.c | 6 ++---- drivers/power/supply/ab8500_fg.c | 6 ++---- drivers/power/supply/axp288_fuel_gauge.c | 2 +- drivers/power/supply/bq25890_charger.c | 2 +- drivers/power/supply/max17042_battery.c | 7 +------ drivers/power/supply/sc27xx_fuel_gauge.c | 9 +-------- drivers/power/supply/twl4030_madc_battery.c | 8 +------- 7 files changed, 9 insertions(+), 31 deletions(-)Signature · 1 line
2.39.1