regulator: Don't return or expect -errno from of_map_mode()
Subsystems (2)
PATCH v3 1/1 regulator: Don't return or expect -errno from of_map_mode()
In of_get_regulation_constraints() we were taking the result of of_map_mode() (an unsigned int) and assigning it to an int. We were then checking whether this value was -EINVAL. Some implementers of of_map_mode() were returning -EINVAL (even though the return type of their function needed to be unsigned int) because they needed to signal an error back to of_get_regulation_constraints().
In general in the regulator framework the mode is always referred to as an unsigned int. While we could fix this to be a signed int (the highest value we store in there right now is 0x8), it's actually pretty clean to just define the regulator mode 0x0 (the lack of any bits set) as an invalid mode. Let's do that.
---
Changes in v3:
- Move local variable declaration to top of func
- s/to to/to in commit message
- Avoid calling of_map_mode() twice in one case (oops)
- Updated Suggested-by to Javier's redhat address to match review.
Changes in v2:
- Use Javier's suggestion of defining 0x0 as invalid
drivers/regulator/cpcap-regulator.c | 2 +- drivers/regulator/of_regulator.c | 13 +++++++------ drivers/regulator/twl-regulator.c | 2 +- include/linux/regulator/consumer.h | 1 + 4 files changed, 10 insertions(+), 8 deletions(-)
drivers/regulator/cpcap-regulator.c +1 -1
@@ -222,7 +222,7 @@ static unsigned int cpcap_map_mode(unsigned int mode)case CPCAP_BIT_AUDIO_LOW_PWR :return REGULATOR_MODE_STANDBY ;default : -return -EINVAL ; +return REGULATOR_MODE_INVALID ; } }
drivers/regulator/of_regulator.c +7 -6
@@ -31,6 +31,7 @@ static void of_get_regulation_constraints(struct device_node *np,struct regulation_constraints *constraints = &(*init_data)->constraints;struct regulator_state *suspend_state;struct device_node *suspend_np; +unsigned int mode;int ret, i;u32 pval;
@@ -124,11 +125,11 @@ static void of_get_regulation_constraints(struct device_node *np,if (!of_property_read_u32 (np,"regulator-initial-mode" , &pval)) {if (desc && desc->of_map_mode) { - ret = desc->of_map_mode (pval); -if (ret == -EINVAL ) + mode = desc->of_map_mode (pval); +if (mode ==REGULATOR_MODE_INVALID )pr_err ("%s: invalid mode %u\n" , np->name, pval);else - constraints->initial_mode = ret; + constraints->initial_mode = mode; }else {pr_warn ("%s: mapping for mode %d not defined\n" , np->name, pval);
@@ -163,12 +164,12 @@ static void of_get_regulation_constraints(struct device_node *np,if (!of_property_read_u32 (suspend_np,"regulator-mode" , &pval)) {if (desc && desc->of_map_mode) { - ret = desc->of_map_mode (pval); -if (ret == -EINVAL ) + mode = desc->of_map_mode (pval); +if (mode ==REGULATOR_MODE_INVALID )pr_err ("%s: invalid mode %u\n" , np->name, pval);else - suspend_state->mode = ret; + suspend_state->mode = mode; }else {pr_warn ("%s: mapping for mode %d not defined\n" , np->name, pval);
drivers/regulator/twl-regulator.c +1 -1
@@ -274,7 +274,7 @@ static inline unsigned int twl4030reg_map_mode(unsigned int mode)case RES_STATE_SLEEP :return REGULATOR_MODE_STANDBY ;default : -return -EINVAL ; +return REGULATOR_MODE_INVALID ; } }
include/linux/regulator/consumer.h +1 -0
@@ -80,6 +80,7 @@ struct regmap;* These modes can be OR'ed together to make up a mask of valid register modes. */ +#define REGULATOR_MODE_INVALID 0x0#define REGULATOR_MODE_FAST 0x1#define REGULATOR_MODE_NORMAL 0x2#define REGULATOR_MODE_IDLE 0x4
Signature · 1 line
2.17.0.484.g0c8726318c-goog
Mark Brown
maintainerApplied "regulator: Don't return or expect -errno from of_map_mode()" to the regulator tree
The patch
regulator: Don't return or expect -errno from of_map_mode()
has been applied to the regulator tree at
https://git.kernel.org/pub/scm/linux/kernel/git/broonie/regulator.git
All being well this means that it will be integrated into the linux-next tree (usually sometime in the next 24 hours) and sent to Linus during the next merge window (or sooner if it is a bug fix), however if problems are discovered then the patch may be dropped or reverted.
You may get further e-mails resulting from automated or manual testing and review of the tree, please engage with people reporting problems and send followup patches addressing any issues that are reported if needed.
If any updates are required or you are submitting further changes they should be sent as incremental updates against current git, existing patches will not be replaced.
Please add any relevant lists and maintainers to the CCs when replying to this mail.
Thanks,
Mark
Quoted 1 line
From
02f3703934a42417021405ef336fe45add13c3d1Mon Sep 17 00:00:00 2001
From: Douglas Anderson <[email protected]>
Date: Wed, 18 Apr 2018 08:54:18 -0700
Subject: [PATCH] regulator: Don't return or expect -errno from of_map_mode()
In of_get_regulation_constraints() we were taking the result of of_map_mode() (an unsigned int) and assigning it to an int. We were then checking whether this value was -EINVAL. Some implementers of of_map_mode() were returning -EINVAL (even though the return type of their function needed to be unsigned int) because they needed to signal an error back to of_get_regulation_constraints().
In general in the regulator framework the mode is always referred to as an unsigned int. While we could fix this to be a signed int (the highest value we store in there right now is 0x8), it's actually pretty clean to just define the regulator mode 0x0 (the lack of any bits set) as an invalid mode. Let's do that.
--- drivers/regulator/cpcap-regulator.c | 2 +- drivers/regulator/of_regulator.c | 13 +++++++------ drivers/regulator/twl-regulator.c | 2 +- include/linux/regulator/consumer.h | 1 + 4 files changed, 10 insertions(+), 8 deletions(-)
drivers/regulator/cpcap-regulator.c +1 -1
@@ -222,7 +222,7 @@ static unsigned int cpcap_map_mode(unsigned int mode)case CPCAP_BIT_AUDIO_LOW_PWR :return REGULATOR_MODE_STANDBY ;default : -return -EINVAL ; +return REGULATOR_MODE_INVALID ; } }
drivers/regulator/of_regulator.c +7 -6
@@ -31,6 +31,7 @@ static void of_get_regulation_constraints(struct device_node *np,struct regulation_constraints *constraints = &(*init_data)->constraints;struct regulator_state *suspend_state;struct device_node *suspend_np; +unsigned int mode;int ret, i;u32 pval;
@@ -124,11 +125,11 @@ static void of_get_regulation_constraints(struct device_node *np,if (!of_property_read_u32 (np,"regulator-initial-mode" , &pval)) {if (desc && desc->of_map_mode) { - ret = desc->of_map_mode (pval); -if (ret == -EINVAL ) + mode = desc->of_map_mode (pval); +if (mode ==REGULATOR_MODE_INVALID )pr_err ("%s: invalid mode %u\n" , np->name, pval);else - constraints->initial_mode = ret; + constraints->initial_mode = mode; }else {pr_warn ("%s: mapping for mode %d not defined\n" , np->name, pval);
@@ -163,12 +164,12 @@ static void of_get_regulation_constraints(struct device_node *np,if (!of_property_read_u32 (suspend_np,"regulator-mode" , &pval)) {if (desc && desc->of_map_mode) { - ret = desc->of_map_mode (pval); -if (ret == -EINVAL ) + mode = desc->of_map_mode (pval); +if (mode ==REGULATOR_MODE_INVALID )pr_err ("%s: invalid mode %u\n" , np->name, pval);else - suspend_state->mode = ret; + suspend_state->mode = mode; }else {pr_warn ("%s: mapping for mode %d not defined\n" , np->name, pval);
drivers/regulator/twl-regulator.c +1 -1
@@ -274,7 +274,7 @@ static inline unsigned int twl4030reg_map_mode(unsigned int mode)case RES_STATE_SLEEP :return REGULATOR_MODE_STANDBY ;default : -return -EINVAL ; +return REGULATOR_MODE_INVALID ; } }
include/linux/regulator/consumer.h +1 -0
@@ -80,6 +80,7 @@ struct regmap;* These modes can be OR'ed together to make up a mask of valid register modes. */ +#define REGULATOR_MODE_INVALID 0x0#define REGULATOR_MODE_FAST 0x1#define REGULATOR_MODE_NORMAL 0x2#define REGULATOR_MODE_IDLE 0x4
Signature · 1 line
2.17.0