[RFC PATCH 4/5] regulator: act8945: Implement PM functionalities
From: Boris Brezillon <hidden>
Date: 2016-12-02 13:57:15
Also in:
linux-arm-kernel
Subsystem:
the rest, voltage and current regulator framework · Maintainers:
Linus Torvalds, Liam Girdwood, Mark Brown
The regulator supports a dedicated suspend mode. Implement the appropriate ->set_suspend_xx() hooks, add support for ->set_mode(), and provide basic PM ops (suspend/resume) to setup the regulator in a suspend state when the system is entering suspend. Note that this PMIC is not able to store a new voltage or a new mode in its internal suspend state description, which forces us to ask the regulator framework to apply suspend voltage and suspend mode at runtime (when calling regulator_apply_suspend_state()). We also implement the ->shutdown() method to make sure the PMIC will not enter the suspend state when the system is shutdown. Signed-off-by: Boris Brezillon <redacted> --- drivers/regulator/act8945a-regulator.c | 255 ++++++++++++++++++++++++++++++++- 1 file changed, 254 insertions(+), 1 deletion(-)
diff --git a/drivers/regulator/act8945a-regulator.c b/drivers/regulator/act8945a-regulator.c
index 441864b9fece..26458cbed15c 100644
--- a/drivers/regulator/act8945a-regulator.c
+++ b/drivers/regulator/act8945a-regulator.c@@ -15,6 +15,7 @@ #include <linux/module.h> #include <linux/of_device.h> #include <linux/platform_device.h> +#include <linux/regmap.h> #include <linux/regulator/driver.h> #include <linux/regulator/machine.h>
@@ -23,23 +24,37 @@ */ #define ACT8945A_SYS_MODE 0x00 #define ACT8945A_SYS_CTRL 0x01 +#define ACT8945A_SYS_UNLK_REGS 0x0b #define ACT8945A_DCDC1_VSET1 0x20 #define ACT8945A_DCDC1_VSET2 0x21 #define ACT8945A_DCDC1_CTRL 0x22 +#define ACT8945A_DCDC1_SUS 0x24 #define ACT8945A_DCDC2_VSET1 0x30 #define ACT8945A_DCDC2_VSET2 0x31 #define ACT8945A_DCDC2_CTRL 0x32 +#define ACT8945A_DCDC2_SUS 0x34 #define ACT8945A_DCDC3_VSET1 0x40 #define ACT8945A_DCDC3_VSET2 0x41 #define ACT8945A_DCDC3_CTRL 0x42 +#define ACT8945A_DCDC3_SUS 0x44 + +#define ACT8945A_DCDC_MODE_MSK BIT(5) +#define ACT8945A_DCDC_MODE_FIXED (1 << 5) +#define ACT8945A_DCDC_MODE_POWER_SAVING (0 << 5) + + #define ACT8945A_LDO1_VSET 0x50 #define ACT8945A_LDO1_CTRL 0x51 +#define ACT8945A_LDO1_SUS 0x52 #define ACT8945A_LDO2_VSET 0x54 #define ACT8945A_LDO2_CTRL 0x55 +#define ACT8945A_LDO2_SUS 0x56 #define ACT8945A_LDO3_VSET 0x60 #define ACT8945A_LDO3_CTRL 0x61 +#define ACT8945A_LDO3_SUS 0x62 #define ACT8945A_LDO4_VSET 0x64 #define ACT8945A_LDO4_CTRL 0x65 +#define ACT8945A_LDO4_SUS 0x66 /** * Field Definitions.
@@ -63,12 +78,155 @@ enum { ACT8945A_REG_NUM, }; +struct act8945a_pmic { + struct regulator_dev *rdevs[ACT8945A_REG_NUM]; + struct regmap *regmap; +}; + static const struct regulator_linear_range act8945a_voltage_ranges[] = { REGULATOR_LINEAR_RANGE(600000, 0, 23, 25000), REGULATOR_LINEAR_RANGE(1200000, 24, 47, 50000), REGULATOR_LINEAR_RANGE(2400000, 48, 63, 100000), }; + +static int act8945a_set_suspend_state(struct regulator_dev *rdev, bool enable) +{ + struct regmap *regmap = rdev->regmap; + int id = rdev->desc->id, ret, reg, val; + + switch (id) { + case ACT8945A_ID_DCDC1: + reg = ACT8945A_DCDC1_SUS; + val = 0xa8; + break; + case ACT8945A_ID_DCDC2: + reg = ACT8945A_DCDC2_SUS; + val = 0xa8; + break; + case ACT8945A_ID_DCDC3: + reg = ACT8945A_DCDC3_SUS; + val = 0xa8; + break; + case ACT8945A_ID_LDO1: + reg = ACT8945A_LDO1_SUS; + val = 0xe8; + break; + case ACT8945A_ID_LDO2: + reg = ACT8945A_LDO2_SUS; + val = 0xe8; + break; + case ACT8945A_ID_LDO3: + reg = ACT8945A_LDO3_SUS; + val = 0xe8; + break; + case ACT8945A_ID_LDO4: + reg = ACT8945A_LDO4_SUS; + val = 0xe8; + break; + default: + return -EINVAL; + } + + if (enable) + val |= BIT(4); + + /* + * Ask the PMIC to enable/disable this output when entering hibernate + * mode. + */ + ret = regmap_write(regmap, reg, val); + if (ret < 0) + return ret; + + /* + * Ask the PMIC to enter the suspend mode on the next PWRHLD + * transition. + */ + return regmap_write(regmap, ACT8945A_SYS_CTRL, 0x42); +} + +static int act8945a_set_suspend_enable(struct regulator_dev *rdev) +{ + return act8945a_set_suspend_state(rdev, true); +} + +static int act8945a_set_suspend_disable(struct regulator_dev *rdev) +{ + return act8945a_set_suspend_state(rdev, false); +} + +static unsigned int act8945a_of_map_mode(unsigned int mode) +{ + if (mode == ACT8945A_DCDC_MODE_POWER_SAVING) + return REGULATOR_MODE_STANDBY; + + return REGULATOR_MODE_NORMAL; +} + +static int act8945a_set_mode(struct regulator_dev *rdev, unsigned int mode) +{ + struct regmap *regmap = rdev->regmap; + int id = rdev->desc->id; + int reg, val; + + switch (mode) { + case REGULATOR_MODE_STANDBY: + val = ACT8945A_DCDC_MODE_POWER_SAVING; + break; + case REGULATOR_MODE_NORMAL: + val = ACT8945A_DCDC_MODE_FIXED; + break; + default: + return -EINVAL; + } + + switch (id) { + case ACT8945A_ID_DCDC1: + reg = ACT8945A_DCDC1_CTRL; + break; + case ACT8945A_ID_DCDC2: + reg = ACT8945A_DCDC2_CTRL; + break; + case ACT8945A_ID_DCDC3: + reg = ACT8945A_DCDC3_CTRL; + break; + default: + return -EINVAL; + } + + return regmap_update_bits(regmap, reg, ACT8945A_DCDC_MODE_MSK, val); +} + +static unsigned int act8945a_get_mode(struct regulator_dev *rdev) +{ + struct regmap *regmap = rdev->regmap; + int id = rdev->desc->id; + unsigned int val; + int reg; + + switch (id) { + case ACT8945A_ID_DCDC1: + reg = ACT8945A_DCDC1_CTRL; + break; + case ACT8945A_ID_DCDC2: + reg = ACT8945A_DCDC2_CTRL; + break; + case ACT8945A_ID_DCDC3: + reg = ACT8945A_DCDC3_CTRL; + break; + default: + return -EINVAL; + } + + regmap_read(regmap, reg, &val); + + if ((val & ACT8945A_DCDC_MODE_MSK) == ACT8945A_DCDC_MODE_POWER_SAVING) + return REGULATOR_MODE_STANDBY; + + return REGULATOR_MODE_NORMAL; +} + static struct regulator_ops act8945a_ops = { .list_voltage = regulator_list_voltage_linear_range, .map_voltage = regulator_map_voltage_linear_range,
@@ -76,7 +234,11 @@ static struct regulator_ops act8945a_ops = { .set_voltage_sel = regulator_set_voltage_sel_regmap, .enable = regulator_enable_regmap, .disable = regulator_disable_regmap, + .set_mode = act8945a_set_mode, + .get_mode = act8945a_get_mode, .is_enabled = regulator_is_enabled_regmap, + .set_suspend_enable = act8945a_set_suspend_enable, + .set_suspend_disable = act8945a_set_suspend_disable, }; #define ACT89xx_REG(_name, _family, _id, _vsel_reg, _supply) \
@@ -84,6 +246,7 @@ static struct regulator_ops act8945a_ops = { .name = _name, \ .supply_name = _supply, \ .of_match = of_match_ptr("REG_"#_id), \ + .of_map_mode = act8945a_of_map_mode, \ .regulators_node = of_match_ptr("regulators"), \ .id = _family##_ID_##_id, \ .type = REGULATOR_VOLTAGE, \
@@ -118,14 +281,97 @@ static const struct regulator_desc act8945a_alt_regulators[] = { ACT89xx_REG("LDO_REG4", ACT8945A, LDO4, VSET, "inl67"), }; +static int act8945a_pmic_suspend(struct device *dev) +{ + struct act8945a_pmic *act8945a = dev_get_drvdata(dev); + int i, ret; + + for (i = 0; i < ARRAY_SIZE(act8945a->rdevs); i++) { + struct regulator_dev *rdev; + + rdev = act8945a->rdevs[i]; + if (!rdev) + break; + + /* + * FIXME: maybe we should continue applying suspend state to + * other regulators. + */ + ret = regulator_apply_suspend_state(rdev); + if (ret) + return ret; + + act8945a->rdevs[i] = rdev; + } + + return 0; +} + +static int act8945a_pmic_resume(struct device *dev) +{ + struct act8945a_pmic *act8945a = dev_get_drvdata(dev); + int i, ret; + + for (i = 0; i < ARRAY_SIZE(act8945a->rdevs); i++) { + struct regulator_dev *rdev; + + rdev = act8945a->rdevs[i]; + if (!rdev) + break; + + /* + * FIXME: maybe we should continue restoring runtime states on + * other regulators. + */ + ret = regulator_restore_runtime_state(rdev); + if (ret) + return ret; + + act8945a->rdevs[i] = rdev; + } + + return 0; +} + +static const struct dev_pm_ops act8945a_pmic_pm_ops = { + .suspend = act8945a_pmic_suspend, + .resume = act8945a_pmic_resume, +}; + +static void act8945a_pmic_shutdown(struct platform_device *pdev) +{ + struct act8945a_pmic *act8945a = platform_get_drvdata(pdev); + struct regmap *regmap = act8945a->regmap; + + /* + * Ask the PMIC to shutdown everything on the next PWRHLD transition. + */ + regmap_write(regmap, ACT8945A_SYS_CTRL, 0x0); +} + static int act8945a_pmic_probe(struct platform_device *pdev) { struct regulator_config config = { }; const struct regulator_desc *regulators; struct regulator_dev *rdev; + struct act8945a_pmic *act8945a; int i, num_regulators; bool voltage_select; + act8945a = devm_kzalloc(&pdev->dev, sizeof(*act8945a), GFP_KERNEL); + if (!act8945a) { + dev_err(&pdev->dev, + "could not allocated the act8945a object\n"); + return -ENOMEM; + } + + act8945a->regmap = dev_get_regmap(pdev->dev.parent, NULL); + if (!act8945a->regmap) { + dev_err(&pdev->dev, + "could not retrieve regmap from parent device\n"); + return -EINVAL; + } + voltage_select = of_property_read_bool(pdev->dev.parent->of_node, "active-semi,vsel-high");
@@ -147,16 +393,23 @@ static int act8945a_pmic_probe(struct platform_device *pdev) regulators[i].name); return PTR_ERR(rdev); } + + act8945a->rdevs[i] = rdev; } - return 0; + platform_set_drvdata(pdev, act8945a); + + /* Unlock expert registers. */ + return regmap_write(act8945a->regmap, ACT8945A_SYS_UNLK_REGS, 0xef); } static struct platform_driver act8945a_pmic_driver = { .driver = { .name = "act8945a-regulator", + .pm = &act8945a_pmic_pm_ops, }, .probe = act8945a_pmic_probe, + .shutdown = act8945a_pmic_shutdown, }; module_platform_driver(act8945a_pmic_driver);
--
2.7.4