Skip to contentSkip to conversation

regulator: drivers: fix return value of get_mode callback

PATCH In review Laxman Dewangan 3 participants 5 messages Jul 14, 2014 – Jul 25, 2014

Subsystems (4)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 regulator: drivers: fix return value of get_mode callback

The function get_mode() should return 0 on error and REGULATOR_MODE_* on success. The return type of this function is defined as unsigned int.

Some of driver who implements this callback return -ve error number when it fails which is incorrect as per function definitions. Correcting the implemnetation on different drivers to return 0 (zero) on error and REGULATOR_MODE_* on success.

---
 drivers/regulator/ab8500-ext.c         | 4 ++--
 drivers/regulator/ab8500.c             | 4 ++--
 drivers/regulator/as3711-regulator.c   | 4 ++--
 drivers/regulator/as3722-regulator.c   | 4 ++--
 drivers/regulator/da9055-regulator.c   | 4 ++--
 drivers/regulator/da9063-regulator.c   | 2 +-
 drivers/regulator/fan53555.c           | 2 +-
 drivers/regulator/lp872x.c             | 4 ++--
 drivers/regulator/lp8788-buck.c        | 2 +-
 drivers/regulator/max8649.c            | 2 +-
 drivers/regulator/max8973-regulator.c  | 2 +-
 drivers/regulator/mc13892-regulator.c  | 2 +-
 drivers/regulator/tps62360-regulator.c | 2 +-
 drivers/regulator/tps65910-regulator.c | 4 ++--
 drivers/regulator/tps65912-regulator.c | 2 +-
 drivers/regulator/wm831x-dcdc.c        | 4 ++--
 drivers/regulator/wm831x-ldo.c         | 8 ++++----
 drivers/regulator/wm8350-regulator.c   | 2 +-
 18 files changed, 29 insertions(+), 29 deletions(-)
drivers/regulator/ab8500-ext.c +2 -2
index 29c0faa..42afcb9 100644
@@ -218,7 +218,7 @@ static unsigned int ab8500_ext_regulator_get_mode(struct regulator_dev *rdev)
 
 	if (info == NULL) {
 		dev_err(rdev_get_dev(rdev), "regulator info null pointer\n");
-		return -EINVAL;
+		return 0;
 	}
 
 	if (info->update_val == info->update_val_hp)
@@ -226,7 +226,7 @@ static unsigned int ab8500_ext_regulator_get_mode(struct regulator_dev *rdev)
 	else if (info->update_val == info->update_val_lp)
 		ret = REGULATOR_MODE_IDLE;
 	else
-		ret = -EINVAL;
+		ret = 0;
 
 	return ret;
 }
drivers/regulator/ab8500.c +2 -2
index 1fda14e..b85f597 100644
@@ -440,7 +440,7 @@ static unsigned int ab8500_regulator_get_mode(struct regulator_dev *rdev)
 
 	if (info == NULL) {
 		dev_err(rdev_get_dev(rdev), "regulator info null pointer\n");
-		return -EINVAL;
+		return 0;
 	}
 
 	/* Need special handling for shared mode */
@@ -471,7 +471,7 @@ static unsigned int ab8500_regulator_get_mode(struct regulator_dev *rdev)
 	else if (val == val_idle)
 		ret = REGULATOR_MODE_IDLE;
 	else
-		ret = -EINVAL;
+		ret = 0;
 
 	return ret;
 }
drivers/regulator/as3711-regulator.c +2 -2
index b47283f..8fcc8ef 100644
@@ -70,7 +70,7 @@ static unsigned int as3711_get_mode_sd(struct regulator_dev *rdev)
 	int ret = regmap_read(rdev->regmap, AS3711_SD_CONTROL_1, &val);
 
 	if (ret < 0)
-		return ret;
+		return 0;
 
 	if ((val & mask) == mask)
 		return REGULATOR_MODE_FAST;
@@ -81,7 +81,7 @@ static unsigned int as3711_get_mode_sd(struct regulator_dev *rdev)
 	if (!(val & mask))
 		return REGULATOR_MODE_IDLE;
 
-	return -EINVAL;
+	return 0;
 }
 
 static struct regulator_ops as3711_sd_ops = {
drivers/regulator/as3722-regulator.c +2 -2
index b68f05f..44d6dea 100644
@@ -468,13 +468,13 @@ static unsigned int as3722_sd_get_mode(struct regulator_dev *rdev)
 	int ret;
 
 	if (!as3722_reg_lookup[id].control_reg)
-		return -ENOTSUPP;
+		return 0;
 
 	ret = as3722_read(as3722, as3722_reg_lookup[id].control_reg, &val);
 	if (ret < 0) {
 		dev_err(as3722_regs->dev, "Reg 0x%02x read failed: %d\n",
 			as3722_reg_lookup[id].control_reg, ret);
-		return ret;
+		return 0;
 	}
 
 	if (val & as3722_reg_lookup[id].mode_mask)
drivers/regulator/da9055-regulator.c +2 -2
index 9516317..cc2e746 100644
@@ -90,7 +90,7 @@ static unsigned int da9055_buck_get_mode(struct regulator_dev *rdev)
 
 	ret = da9055_reg_read(regulator->da9055, info->mode.reg);
 	if (ret < 0)
-		return ret;
+		return 0;
 
 	switch ((ret & info->mode.mask) >> info->mode.shift) {
 	case DA9055_BUCK_MODE_SYNC:
@@ -138,7 +138,7 @@ static unsigned int da9055_ldo_get_mode(struct regulator_dev *rdev)
 
 	ret = da9055_reg_read(regulator->da9055, info->volt.reg_b);
 	if (ret < 0)
-		return ret;
+		return 0;
 
 	if (ret >> info->volt.sl_shift)
 		return REGULATOR_MODE_STANDBY;
drivers/regulator/da9063-regulator.c +1 -1
index 7c9461d..6275e00 100644
@@ -233,7 +233,7 @@ static unsigned da9063_buck_get_mode(struct regulator_dev *rdev)
 
 	ret = regmap_field_read(regl->mode, &val);
 	if (ret < 0)
-		return ret;
+		return 0;
 
 	switch (val) {
 	default:
drivers/regulator/fan53555.c +1 -1
index 714fd9a..bb5cc0e 100644
@@ -128,7 +128,7 @@ static unsigned int fan53555_get_mode(struct regulator_dev *rdev)
 
 	ret = regmap_read(di->regmap, di->vol_reg, &val);
 	if (ret < 0)
-		return ret;
+		return 0;
 	if (val & VSEL_MODE)
 		return REGULATOR_MODE_FAST;
 	else
drivers/regulator/lp872x.c +2 -2
index 2e022aa..8229561b 100644
@@ -469,12 +469,12 @@ static unsigned int lp872x_buck_get_mode(struct regulator_dev *rdev)
 		mask = LP8725_BUCK2_FPWM_M;
 		break;
 	default:
-		return -EINVAL;
+		return 0;
 	}
 
 	ret = lp872x_read_byte(lp, addr, &val);
 	if (ret)
-		return ret;
+		return 0;
 
 	return val & mask ? REGULATOR_MODE_FAST : REGULATOR_MODE_NORMAL;
 }
drivers/regulator/lp8788-buck.c +1 -1
index 948afc2..d28c5f4 100644
@@ -338,7 +338,7 @@ static unsigned int lp8788_buck_get_mode(struct regulator_dev *rdev)
 
 	ret = lp8788_read_byte(buck->lp, LP8788_BUCK_PWM, &val);
 	if (ret)
-		return ret;
+		return 0;
 
 	return val & BUCK_FPWM_MASK(id) ?
 				REGULATOR_MODE_FAST : REGULATOR_MODE_NORMAL;
drivers/regulator/max8649.c +1 -1
index c8bddcc..f3519ca 100644
@@ -109,7 +109,7 @@ static unsigned int max8649_get_mode(struct regulator_dev *rdev)
 
 	ret = regmap_read(info->regmap, rdev->desc->vsel_reg, &val);
 	if (ret != 0)
-		return ret;
+		return 0;
 	if (val & MAX8649_FORCE_PWM)
 		return REGULATOR_MODE_FAST;
 	return REGULATOR_MODE_NORMAL;
drivers/regulator/max8973-regulator.c +1 -1
index dbedf17..c4a4cdc2 100644
@@ -236,7 +236,7 @@ static unsigned int max8973_dcdc_get_mode(struct regulator_dev *rdev)
 	if (ret < 0) {
 		dev_err(max->dev, "register %d read failed, err %d\n",
 				MAX8973_CONTROL1, ret);
-		return ret;
+		return 0;
 	}
 	return (data & MAX8973_FPWM_EN_M) ?
 		REGULATOR_MODE_FAST : REGULATOR_MODE_NORMAL;
drivers/regulator/mc13892-regulator.c +1 -1
index f374fa5..fc3ed75 100644
@@ -518,7 +518,7 @@ static unsigned int mc13892_vcam_get_mode(struct regulator_dev *rdev)
 	mc13xxx_unlock(priv->mc13xxx);
 
 	if (ret)
-		return ret;
+		return 0;
 
 	if (val & MC13892_REGULATORMODE1_VCAMCONFIGEN)
 		return REGULATOR_MODE_FAST;
drivers/regulator/tps62360-regulator.c +1 -1
index a167204..42954f9 100644
@@ -227,7 +227,7 @@ static unsigned int tps62360_get_mode(struct regulator_dev *rdev)
 	if (ret < 0) {
 		dev_err(tps->dev, "%s(): register %d read failed with err %d\n",
 			__func__, REG_VSET0 + tps->curr_vset_id, ret);
-		return ret;
+		return 0;
 	}
 	return (data & FORCE_PWM_ENABLE) ?
 				REGULATOR_MODE_FAST : REGULATOR_MODE_NORMAL;
drivers/regulator/tps65910-regulator.c +2 -2
index fa7db88..752e0ca 100644
@@ -423,11 +423,11 @@ static unsigned int tps65910_get_mode(struct regulator_dev *dev)
 
 	reg = pmic->get_ctrl_reg(id);
 	if (reg < 0)
-		return reg;
+		return 0;
 
 	ret = tps65910_reg_read(pmic->mfd, reg, &value);
 	if (ret < 0)
-		return ret;
+		return 0;
 
 	if (!(value & LDO_ST_ON_BIT))
 		return REGULATOR_MODE_STANDBY;
drivers/regulator/tps65912-regulator.c +1 -1
index 9cafaa0..319f1bb 100644
@@ -241,7 +241,7 @@ static int tps65912_get_mode_regiters(struct tps65912_reg *pmic, int id)
 		pmic->eco_reg = TPS65912_DCDC4_AVS;
 		break;
 	default:
-		return -EINVAL;
+		return 0;
 	}
 
 	return 0;
drivers/regulator/wm831x-dcdc.c +2 -2
index 0d88a82..0188def 100644
@@ -71,7 +71,7 @@ static unsigned int wm831x_dcdc_get_mode(struct regulator_dev *rdev)
 
 	val = wm831x_reg_read(wm831x, reg);
 	if (val < 0)
-		return val;
+		return 0;
 
 	val = (val & WM831X_DC1_ON_MODE_MASK) >> WM831X_DC1_ON_MODE_SHIFT;
 
@@ -86,7 +86,7 @@ static unsigned int wm831x_dcdc_get_mode(struct regulator_dev *rdev)
 		return REGULATOR_MODE_IDLE;
 	default:
 		BUG();
-		return -EINVAL;
+		return 0;
 	}
 }
 
drivers/regulator/wm831x-ldo.c +4 -4
index eca0eeb..16a5692 100644
@@ -91,14 +91,14 @@ static unsigned int wm831x_gp_ldo_get_mode(struct regulator_dev *rdev)
 
 	ret = wm831x_reg_read(wm831x, on_reg);
 	if (ret < 0)
-		return ret;
+		return 0;
 
 	if (!(ret & WM831X_LDO1_ON_MODE))
 		return REGULATOR_MODE_NORMAL;
 
 	ret = wm831x_reg_read(wm831x, ctrl_reg);
 	if (ret < 0)
-		return ret;
+		return 0;
 
 	if (ret & WM831X_LDO1_LP_MODE)
 		return REGULATOR_MODE_STANDBY;
@@ -180,8 +180,8 @@ static int wm831x_gp_ldo_get_status(struct regulator_dev *rdev)
 		return REGULATOR_STATUS_ERROR;
 
 	ret = wm831x_gp_ldo_get_mode(rdev);
-	if (ret < 0)
-		return ret;
+	if (!ret)
+		return -EINVAL;
 	else
 		return regulator_mode_to_status(ret);
 }
drivers/regulator/wm8350-regulator.c +1 -1
index 7ec7c39..b76d51d 100644
@@ -855,7 +855,7 @@ static unsigned int wm8350_dcdc_get_mode(struct regulator_dev *rdev)
 		reg = WM8350_DCDC6_FORCE_PWM;
 		break;
 	default:
-		return -EINVAL;
+		return 0;
 	}
 
 	mask = 1 << (dcdc - WM8350_DCDC_1);
Signature · 1 line
1.8.1.5
#1 lore raw
Quoted 21 lines · Laxman Dewangan

The function get_mode() should return 0 on error and REGULATOR_MODE_* on success. The return type of this function is defined as unsigned int.

Some of driver who implements this callback return -ve error number when it fails which is incorrect as per function definitions. Correcting the implemnetation on different drivers to return 0 (zero) on error and REGULATOR_MODE_* on success.

---
 drivers/regulator/ab8500-ext.c         | 4 ++--
 drivers/regulator/ab8500.c             | 4 ++--
 drivers/regulator/as3711-regulator.c   | 4 ++--
 drivers/regulator/as3722-regulator.c   | 4 ++--
 drivers/regulator/da9055-regulator.c   | 4 ++--
 drivers/regulator/da9063-regulator.c   | 2 +-
 drivers/regulator/fan53555.c           | 2 +-
 drivers/regulator/lp872x.c             | 4 ++--
 drivers/regulator/lp8788-buck.c        | 2 +-
 drivers/regulator/max8649.c            | 2 +-
 drivers/regulator/max8973-regulator.c  | 2 +-
Quoted 8 lines
 drivers/regulator/mc13892-regulator.c  | 2 +-
 drivers/regulator/tps62360-regulator.c | 2 +-
 drivers/regulator/tps65910-regulator.c | 4 ++--
 drivers/regulator/tps65912-regulator.c | 2 +-
 drivers/regulator/wm831x-dcdc.c        | 4 ++--
 drivers/regulator/wm831x-ldo.c         | 8 ++++----
 drivers/regulator/wm8350-regulator.c   | 2 +-
 18 files changed, 29 insertions(+), 29 deletions(-)

Looks like _regulator_get_mode in core.c would need updated too. I can't help but wonder if it might be better to just make get/set mode use an int instead, although I don't know for what reasons an unsigned int was choosen in the first place so I might be missing something.

Thanks,
Charles

maintainer
#2 lore raw
Quoted 10 lines · Charles Keepax
Quoted 2 lines · Laxman Dewangan

The function get_mode() should return 0 on error and REGULATOR_MODE_* on success. The return type of this function is defined as unsigned int.

Looks like _regulator_get_mode in core.c would need updated too. I can't help but wonder if it might be better to just make get/set mode use an int instead, although I don't know for what reasons an unsigned int was choosen in the first place so I might be missing something.

It's because it's returning something defined as a bitmask, though since we don't even have enough modes for 8 bits that's not really a strong reason and we should just be returning an error code as everyone is clearly already assuming we do.

#3 lore raw

Hi Mark

Quoted 9 lines · Mark Brown

* PGP Signed by an unknown key

Quoted 1 line · Charles Keepax

On Mon, Jul 14, 2014 at 04:03:17PM +0530, Laxman Dewangan wrote:

It's because it's returning something defined as a bitmask, though since we don't even have enough modes for 8 bits that's not really a strong reason and we should just be returning an error code as everyone is clearly already assuming we do.

Just to confirm, do you want to change the return type of get_mode() to "int" instead of unsigned int? And then return proper error type?

In this case I think it should be single patch (core + driver).

maintainer
#4 lore raw
Quoted 4 lines · Laxman Dewangan
Quoted 2 lines · Mark Brown
Quoted 1 line · Charles Keepax

On Mon, Jul 14, 2014 at 04:03:17PM +0530, Laxman Dewangan wrote:

Quoted 8 lines
Quoted 4 lines

It's because it's returning something defined as a bitmask, though since we don't even have enough modes for 8 bits that's not really a strong reason and we should just be returning an error code as everyone is clearly already assuming we do.

Just to confirm, do you want to change the return type of get_mode() to "int" instead of
unsigned int? And then return proper error type?

Yes.