michaelh/zephyr
1
0
Fork 0
Code Releases Activity

drivers: regulator: pca9420: store common config in parent device

Browse source 
Store all common configuration settings in the parent device. This
change should save ROM, since it avoids duplication.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2022-11-17 12:30:43 +01:00 • committed by Carles Cufí
commit 709f7c88f7
2 changed files with 93 additions and 68 deletions
Download patch file Download diff file Expand all files Collapse all files

18
drivers/regulator/Kconfig.pca9420
View file

@ -9,10 +9,20 @@ config REGULATOR_PCA9420
help help
Enable the NXP PCA9420 PMIC regulator driver Enable the NXP PCA9420 PMIC regulator driver
if REGULATOR_PCA9420
config REGULATOR_PCA9420_COMMON_INIT_PRIORITY
int "NXP PCA9420 regulator driver init priority (common part)"
default 75
help
Init priority for the NXP PCA9420 regulator driver (common part). It
must be greater than I2C init priority.
config REGULATOR_PCA9420_INIT_PRIORITY config REGULATOR_PCA9420_INIT_PRIORITY
int "NXP PCA9420 regulator driver init priority" int "NXP PCA9420 regulator driver init priority"
default 75 default 76
depends on REGULATOR_PCA9420
help help
Init priority for the NXP PCA9420 regulator driver. It must be greater Init priority for the NXP PCA9420 regulator driver. It must be
than I2C init priority. greater than REGULATOR_PCA9420_COMMON_INIT_PRIORITY.
endif

143
drivers/regulator/regulator_pca9420.c
View file

@ -96,19 +96,19 @@ struct regulator_pca9420_data {
struct regulator_pca9420_common_config { struct regulator_pca9420_common_config {
struct i2c_dt_spec i2c; struct i2c_dt_spec i2c;
int32_t vin_ilim_ua; int32_t vin_ilim_ua;
uint8_t modesel_reg;
uint8_t modesel_mask;
const uint16_t *allowed_modes;
int num_modes;
uint16_t initial_mode;
}; };
struct regulator_pca9420_config { struct regulator_pca9420_config {
int num_modes; int32_t max_ua;
bool enable_inverted; bool enable_inverted;
bool boot_on; bool boot_on;
struct i2c_dt_spec i2c;
uint16_t initial_mode;
const uint16_t *allowed_modes;
uint8_t modesel_reg;
uint8_t modesel_mask;
const struct regulator_pca9420_desc *desc; const struct regulator_pca9420_desc *desc;
const struct regulator_pca9420_common_config *common; const struct device *parent;
}; };
static const struct linear_range buck1_ranges[] = { static const struct linear_range buck1_ranges[] = {
@ -230,10 +230,12 @@ static int regulator_pca9420_get_voltage_offset(const struct device *dev,
uint32_t off, int32_t *voltage) uint32_t off, int32_t *voltage)
{ {
const struct regulator_pca9420_config *config = dev->config; const struct regulator_pca9420_config *config = dev->config;
const struct regulator_pca9420_common_config *cconfig = config->parent->config;
int ret; int ret;
uint8_t raw_reg; uint8_t raw_reg;
ret = regulator_pca9420_read_register(&config->i2c, ret = regulator_pca9420_read_register(&cconfig->i2c,
config->desc->vsel_reg + off, config->desc->vsel_reg + off,
&raw_reg); &raw_reg);
if (ret < 0) { if (ret < 0) {
@ -257,6 +259,7 @@ static int regulator_set_voltage_offset(const struct device *dev,
uint32_t off) uint32_t off)
{ {
const struct regulator_pca9420_config *config = dev->config; const struct regulator_pca9420_config *config = dev->config;
const struct regulator_pca9420_common_config *cconfig = config->parent->config;
uint16_t idx; uint16_t idx;
int ret; int ret;
@ -269,7 +272,7 @@ static int regulator_set_voltage_offset(const struct device *dev,
idx <<= config->desc->vsel_pos; idx <<= config->desc->vsel_pos;
return regulator_pca9420_modify_register(&config->i2c, return regulator_pca9420_modify_register(&cconfig->i2c,
config->desc->vsel_reg + off, config->desc->vsel_reg + off,
config->desc->vsel_mask, config->desc->vsel_mask,
(uint8_t)idx); (uint8_t)idx);
@ -295,8 +298,9 @@ static int regulator_pca9420_count_voltages(const struct device *dev)
static int regulator_pca9420_count_modes(const struct device *dev) static int regulator_pca9420_count_modes(const struct device *dev)
{ {
const struct regulator_pca9420_config *config = dev->config; const struct regulator_pca9420_config *config = dev->config;
const struct regulator_pca9420_common_config *cconfig = config->parent->config;
return config->num_modes; return cconfig->num_modes;
} }
/** /**
@ -365,12 +369,13 @@ static int32_t regulator_pca9420_get_voltage(const struct device *dev)
static int regulator_pca9420_get_current_limit(const struct device *dev) static int regulator_pca9420_get_current_limit(const struct device *dev)
{ {
const struct regulator_pca9420_config *config = dev->config; const struct regulator_pca9420_config *config = dev->config;
const struct regulator_pca9420_common_config *cconfig = config->parent->config;
if (config->common->vin_ilim_ua == 0U) { if (cconfig->vin_ilim_ua == 0U) {
return config->max_ua; return config->max_ua;
} }
return MIN(config->max_ua, config->common->vin_ilim_ua); return MIN(config->max_ua, cconfig->vin_ilim_ua);
} }
/* /*
@ -385,19 +390,20 @@ static int regulator_pca9420_set_mode_voltage(const struct device *dev,
int32_t max_uv) int32_t max_uv)
{ {
const struct regulator_pca9420_config *config = dev->config; const struct regulator_pca9420_config *config = dev->config;
const struct regulator_pca9420_common_config *cconfig = config->parent->config;
uint8_t i, sel_off; uint8_t i, sel_off;
if (config->num_modes == 0) { if (cconfig->num_modes == 0) {
return -ENOTSUP; return -ENOTSUP;
} }
/* Search for mode ID in allowed modes. */ /* Search for mode ID in allowed modes. */
for (i = 0 ; i < config->num_modes; i++) { for (i = 0 ; i < cconfig->num_modes; i++) {
if (config->allowed_modes[i] == mode) { if (cconfig->allowed_modes[i] == mode) {
break; break;
} }
} }
if (i == config->num_modes) { if (i == cconfig->num_modes) {
/* Mode was not found */ /* Mode was not found */
return -EINVAL; return -EINVAL;
} }
@ -414,26 +420,27 @@ static int regulator_pca9420_mode_disable(const struct device *dev,
uint32_t mode) uint32_t mode)
{ {
const struct regulator_pca9420_config *config = dev->config; const struct regulator_pca9420_config *config = dev->config;
const struct regulator_pca9420_common_config *cconfig = config->parent->config;
uint8_t i, sel_off, dis_val; uint8_t i, sel_off, dis_val;
if (config->num_modes == 0) { if (cconfig->num_modes == 0) {
return -ENOTSUP; return -ENOTSUP;
} }
/* Search for mode ID in allowed modes. */ /* Search for mode ID in allowed modes. */
for (i = 0 ; i < config->num_modes; i++) { for (i = 0 ; i < cconfig->num_modes; i++) {
if (config->allowed_modes[i] == mode) { if (cconfig->allowed_modes[i] == mode) {
break; break;
} }
} }
if (i == config->num_modes) { if (i == cconfig->num_modes) {
/* Mode was not found */ /* Mode was not found */
return -EINVAL; return -EINVAL;
} }
sel_off = ((mode & PMIC_MODE_OFFSET_MASK) >> PMIC_MODE_OFFSET_SHIFT); sel_off = ((mode & PMIC_MODE_OFFSET_MASK) >> PMIC_MODE_OFFSET_SHIFT);
dis_val = config->enable_inverted ? config->desc->enable_val : 0; dis_val = config->enable_inverted ? config->desc->enable_val : 0;
return regulator_pca9420_modify_register( return regulator_pca9420_modify_register(
&config->i2c, config->desc->enable_reg + sel_off, &cconfig->i2c, config->desc->enable_reg + sel_off,
config->desc->enable_mask, dis_val); config->desc->enable_mask, dis_val);
} }
@ -446,26 +453,27 @@ static int regulator_pca9420_mode_enable(const struct device *dev,
uint32_t mode) uint32_t mode)
{ {
const struct regulator_pca9420_config *config = dev->config; const struct regulator_pca9420_config *config = dev->config;
const struct regulator_pca9420_common_config *cconfig = config->parent->config;
uint8_t i, sel_off, en_val; uint8_t i, sel_off, en_val;
if (config->num_modes == 0) { if (cconfig->num_modes == 0) {
return -ENOTSUP; return -ENOTSUP;
} }
/* Search for mode ID in allowed modes. */ /* Search for mode ID in allowed modes. */
for (i = 0 ; i < config->num_modes; i++) { for (i = 0 ; i < cconfig->num_modes; i++) {
if (config->allowed_modes[i] == mode) { if (cconfig->allowed_modes[i] == mode) {
break; break;
} }
} }
if (i == config->num_modes) { if (i == cconfig->num_modes) {
/* Mode was not found */ /* Mode was not found */
return -EINVAL; return -EINVAL;
} }
sel_off = ((mode & PMIC_MODE_OFFSET_MASK) >> PMIC_MODE_OFFSET_SHIFT); sel_off = ((mode & PMIC_MODE_OFFSET_MASK) >> PMIC_MODE_OFFSET_SHIFT);
en_val = config->enable_inverted ? 0 : config->desc->enable_val; en_val = config->enable_inverted ? 0 : config->desc->enable_val;
return regulator_pca9420_modify_register( return regulator_pca9420_modify_register(
&config->i2c, config->desc->enable_reg + sel_off, &cconfig->i2c, config->desc->enable_reg + sel_off,
config->desc->enable_mask, en_val); config->desc->enable_mask, en_val);
} }
@ -479,20 +487,21 @@ static int32_t regulator_pca9420_get_mode_voltage(const struct device *dev,
uint32_t mode) uint32_t mode)
{ {
const struct regulator_pca9420_config *config = dev->config; const struct regulator_pca9420_config *config = dev->config;
const struct regulator_pca9420_common_config *cconfig = config->parent->config;
uint8_t i, sel_off; uint8_t i, sel_off;
int32_t voltage; int32_t voltage;
if (config->num_modes == 0) { if (cconfig->num_modes == 0) {
return -ENOTSUP; return -ENOTSUP;
} }
/* Search for mode ID in allowed modes. */ /* Search for mode ID in allowed modes. */
for (i = 0 ; i < config->num_modes; i++) { for (i = 0 ; i < cconfig->num_modes; i++) {
if (config->allowed_modes[i] == mode) { if (cconfig->allowed_modes[i] == mode) {
break; break;
} }
} }
if (i == config->num_modes) { if (i == cconfig->num_modes) {
/* Mode was not found */ /* Mode was not found */
return -EINVAL; return -EINVAL;
} }
@ -511,20 +520,21 @@ static int32_t regulator_pca9420_get_mode_voltage(const struct device *dev,
static int regulator_pca9420_set_mode(const struct device *dev, uint32_t mode) static int regulator_pca9420_set_mode(const struct device *dev, uint32_t mode)
{ {
const struct regulator_pca9420_config *config = dev->config; const struct regulator_pca9420_config *config = dev->config;
const struct regulator_pca9420_common_config *cconfig = config->parent->config;
int rc; int rc;
uint8_t i, sel_off; uint8_t i, sel_off;
if (config->num_modes == 0) { if (cconfig->num_modes == 0) {
return -ENOTSUP; return -ENOTSUP;
} }
/* Search for mode ID in allowed modes. */ /* Search for mode ID in allowed modes. */
for (i = 0 ; i < config->num_modes; i++) { for (i = 0 ; i < cconfig->num_modes; i++) {
if (config->allowed_modes[i] == mode) { if (cconfig->allowed_modes[i] == mode) {
break; break;
} }
} }
if (i == config->num_modes) { if (i == cconfig->num_modes) {
/* Mode was not found */ /* Mode was not found */
return -EINVAL; return -EINVAL;
} }
@ -533,13 +543,16 @@ static int regulator_pca9420_set_mode(const struct device *dev, uint32_t mode)
if (mode & PMIC_MODE_FLAG_MODESEL_MULTI_REG) { if (mode & PMIC_MODE_FLAG_MODESEL_MULTI_REG) {
/* Select mode with offset calculation */ /* Select mode with offset calculation */
rc = regulator_pca9420_modify_register( rc = regulator_pca9420_modify_register(
&config->i2c, config->modesel_reg + sel_off, &cconfig->i2c,
mode & PMIC_MODE_SELECTOR_MASK, config->modesel_mask); cconfig->modesel_reg + sel_off,
mode & PMIC_MODE_SELECTOR_MASK,
cconfig->modesel_mask);
} else { } else {
/* Select mode without offset to modesel_reg */ /* Select mode without offset to modesel_reg */
rc = regulator_pca9420_modify_register( rc = regulator_pca9420_modify_register(
&config->i2c, config->modesel_reg, &cconfig->i2c, cconfig->modesel_reg,
mode & PMIC_MODE_SELECTOR_MASK, config->modesel_mask); mode & PMIC_MODE_SELECTOR_MASK,
cconfig->modesel_mask);
} }
return rc; return rc;
} }
@ -552,6 +565,7 @@ static int regulator_pca9420_enable(const struct device *dev,
uint8_t en_val; uint8_t en_val;
struct regulator_pca9420_data *data = dev->data; struct regulator_pca9420_data *data = dev->data;
const struct regulator_pca9420_config *config = dev->config; const struct regulator_pca9420_config *config = dev->config;
const struct regulator_pca9420_common_config *cconfig = config->parent->config;
LOG_DBG("Enabling regulator"); LOG_DBG("Enabling regulator");
rc = onoff_sync_lock(&data->srv, &key); rc = onoff_sync_lock(&data->srv, &key);
@ -560,7 +574,7 @@ static int regulator_pca9420_enable(const struct device *dev,
return onoff_sync_finalize(&data->srv, key, cli, rc, true); return onoff_sync_finalize(&data->srv, key, cli, rc, true);
} }
en_val = config->enable_inverted ? 0 : config->desc->enable_val; en_val = config->enable_inverted ? 0 : config->desc->enable_val;
rc = regulator_pca9420_modify_register(&config->i2c, rc = regulator_pca9420_modify_register(&cconfig->i2c,
config->desc->enable_reg, config->desc->enable_reg,
config->desc->enable_mask, config->desc->enable_mask,
en_val); en_val);
@ -574,6 +588,7 @@ static int regulator_pca9420_disable(const struct device *dev)
{ {
struct regulator_pca9420_data *data = dev->data; struct regulator_pca9420_data *data = dev->data;
const struct regulator_pca9420_config *config = dev->config; const struct regulator_pca9420_config *config = dev->config;
const struct regulator_pca9420_common_config *cconfig = config->parent->config;
k_spinlock_key_t key; k_spinlock_key_t key;
uint8_t dis_val; uint8_t dis_val;
int rc; int rc;
@ -587,7 +602,7 @@ static int regulator_pca9420_disable(const struct device *dev)
/* Disable regulator */ /* Disable regulator */
dis_val = config->enable_inverted ? config->desc->enable_val : 0; dis_val = config->enable_inverted ? config->desc->enable_val : 0;
rc = regulator_pca9420_modify_register( rc = regulator_pca9420_modify_register(
&config->i2c, config->desc->enable_reg, &cconfig->i2c, config->desc->enable_reg,
config->desc->enable_mask, dis_val); config->desc->enable_mask, dis_val);
} }
return onoff_sync_finalize(&data->srv, key, NULL, rc, false); return onoff_sync_finalize(&data->srv, key, NULL, rc, false);
@ -596,17 +611,18 @@ static int regulator_pca9420_disable(const struct device *dev)
static int regulator_pca9420_init(const struct device *dev) static int regulator_pca9420_init(const struct device *dev)
{ {
const struct regulator_pca9420_config *config = dev->config; const struct regulator_pca9420_config *config = dev->config;
const struct regulator_pca9420_common_config *cconfig = config->parent->config;
int rc = 0; int rc = 0;
/* Check to verify we have a valid I2C device */ if (!device_is_ready(config->parent)) {
if (!device_is_ready(config->i2c.bus)) {
return -ENODEV; return -ENODEV;
} }
if (config->boot_on) { if (config->boot_on) {
rc = regulator_pca9420_enable(dev, NULL); rc = regulator_pca9420_enable(dev, NULL);
} }
if (config->initial_mode) { if (cconfig->initial_mode) {
rc = regulator_pca9420_set_mode(dev, config->initial_mode); rc = regulator_pca9420_set_mode(dev, cconfig->initial_mode);
} }
return rc; return rc;
} }
@ -650,51 +666,50 @@ static const struct regulator_driver_api api = {
.mode_enable = regulator_pca9420_mode_enable, .mode_enable = regulator_pca9420_mode_enable,
}; };
#define REGULATOR_PCA9420_DEFINE(node_id, id, name, _common) \ #define REGULATOR_PCA9420_DEFINE(node_id, id, name, _parent) \
static const uint16_t allowed_modes_##id[] = \
DT_PROP_OR(DT_PARENT(node_id), regulator_allowed_modes, {}); \
\
static struct regulator_pca9420_data data_##id; \ static struct regulator_pca9420_data data_##id; \
\ \
static const struct regulator_pca9420_config config_##id = { \ static const struct regulator_pca9420_config config_##id = { \
.max_ua = DT_PROP(node_id, regulator_max_microamp), \ .max_ua = DT_PROP(node_id, regulator_max_microamp), \
.enable_inverted = DT_PROP(node_id, enable_inverted), \ .enable_inverted = DT_PROP(node_id, enable_inverted), \
.boot_on = DT_PROP(node_id, regulator_boot_on), \ .boot_on = DT_PROP(node_id, regulator_boot_on), \
.num_modes = ARRAY_SIZE(allowed_modes_##id), \
.initial_mode = DT_PROP_OR(DT_PARENT(node_id), \
regulator_initial_mode, 0), \
.i2c = I2C_DT_SPEC_GET(DT_PARENT(node_id)), \
.allowed_modes = allowed_modes_##id, \
.modesel_reg = DT_PROP_OR(DT_PARENT(node_id), modesel_reg, 0), \
.modesel_mask = \
DT_PROP_OR(DT_PARENT(node_id), modesel_mask, 0), \
.desc = &name ## _desc, \ .desc = &name ## _desc, \
.common = _common, \ .parent = _parent, \
}; \ }; \
\ \
DEVICE_DT_DEFINE(node_id, regulator_pca9420_init, NULL, &data_##id, \ DEVICE_DT_DEFINE(node_id, regulator_pca9420_init, NULL, &data_##id, \
&config_##id, POST_KERNEL, \ &config_##id, POST_KERNEL, \
CONFIG_REGULATOR_PCA9420_INIT_PRIORITY, &api); CONFIG_REGULATOR_PCA9420_INIT_PRIORITY, &api);
#define REGULATOR_PCA9420_DEFINE_COND(inst, child, common) \ #define REGULATOR_PCA9420_DEFINE_COND(inst, child, parent) \
COND_CODE_1(DT_NODE_EXISTS(DT_INST_CHILD(inst, child)), \ COND_CODE_1(DT_NODE_EXISTS(DT_INST_CHILD(inst, child)), \
(REGULATOR_PCA9420_DEFINE(DT_INST_CHILD(inst, child), \ (REGULATOR_PCA9420_DEFINE(DT_INST_CHILD(inst, child), \
child ## inst, child, common)), \ child ## inst, child, parent)), \
()) ())
#define REGULATOR_PCA9420_DEFINE_ALL(inst) \ #define REGULATOR_PCA9420_DEFINE_ALL(inst) \
static const uint16_t allowed_modes_##inst[] = \
DT_INST_PROP_OR(inst, regulator_allowed_modes, {}); \
\
static const struct regulator_pca9420_common_config config_##inst = { \ static const struct regulator_pca9420_common_config config_##inst = { \
.i2c = I2C_DT_SPEC_INST_GET(inst), \ .i2c = I2C_DT_SPEC_INST_GET(inst), \
.vin_ilim_ua = DT_INST_PROP(inst, nxp_vin_ilim_microamp), \ .vin_ilim_ua = DT_INST_PROP(inst, nxp_vin_ilim_microamp), \
.allowed_modes = allowed_modes_##inst, \
.num_modes = ARRAY_SIZE(allowed_modes_##inst), \
.initial_mode = \
DT_INST_PROP_OR(inst, regulator_initial_mode, 0), \
.modesel_reg = DT_INST_PROP_OR(inst, modesel_reg, 0), \
.modesel_mask = DT_INST_PROP_OR(inst, modesel_mask, 0), \
}; \ }; \
\ \
DEVICE_DT_INST_DEFINE(inst, regulator_pca9420_common_init, NULL, NULL, \ DEVICE_DT_INST_DEFINE(inst, regulator_pca9420_common_init, NULL, NULL, \
&config_##inst, POST_KERNEL, \ &config_##inst, POST_KERNEL, \
CONFIG_REGULATOR_PCA9420_INIT_PRIORITY, NULL); \ CONFIG_REGULATOR_PCA9420_COMMON_INIT_PRIORITY, \
NULL); \
\ \
REGULATOR_PCA9420_DEFINE_COND(inst, buck1, &config_##inst) \ REGULATOR_PCA9420_DEFINE_COND(inst, buck1, DEVICE_DT_INST_GET(inst)) \
REGULATOR_PCA9420_DEFINE_COND(inst, buck2, &config_##inst) \ REGULATOR_PCA9420_DEFINE_COND(inst, buck2, DEVICE_DT_INST_GET(inst)) \
REGULATOR_PCA9420_DEFINE_COND(inst, ldo1, &config_##inst) \ REGULATOR_PCA9420_DEFINE_COND(inst, ldo1, DEVICE_DT_INST_GET(inst)) \
REGULATOR_PCA9420_DEFINE_COND(inst, ldo2, &config_##inst) REGULATOR_PCA9420_DEFINE_COND(inst, ldo2, DEVICE_DT_INST_GET(inst))
DT_INST_FOREACH_STATUS_OKAY(REGULATOR_PCA9420_DEFINE_ALL) DT_INST_FOREACH_STATUS_OKAY(REGULATOR_PCA9420_DEFINE_ALL)