drivers/regulator/rt5759-regulator.c

0001 // SPDX-License-Identifier: GPL-2.0+
0002
0003 #include <linux/bits.h>
0004 #include <linux/i2c.h>
0005 #include <linux/kernel.h>
0006 #include <linux/module.h>
0007 #include <linux/of_device.h>
0008 #include <linux/regmap.h>
0009 #include <linux/regulator/driver.h>
0010 #include <linux/regulator/of_regulator.h>
0011
0012 #define RT5759_REG_VENDORINFO   0x00
0013 #define RT5759_REG_FREQ     0x01
0014 #define RT5759_REG_VSEL     0x02
0015 #define RT5759_REG_DCDCCTRL 0x03
0016 #define RT5759_REG_STATUS   0x04
0017 #define RT5759_REG_DCDCSET  0x05
0018 #define RT5759A_REG_WDTEN   0x42
0019
0020 #define RT5759_TSTEP_MASK   GENMASK(3, 2)
0021 #define RT5759_VSEL_MASK    GENMASK(6, 0)
0022 #define RT5759_DISCHARGE_MASK   BIT(3)
0023 #define RT5759_FPWM_MASK    BIT(2)
0024 #define RT5759_ENABLE_MASK  BIT(1)
0025 #define RT5759_OT_MASK      BIT(1)
0026 #define RT5759_UV_MASK      BIT(0)
0027 #define RT5957_OCLVL_MASK   GENMASK(7, 6)
0028 #define RT5759_OCLVL_SHIFT  6
0029 #define RT5957_OTLVL_MASK   GENMASK(5, 4)
0030 #define RT5759_OTLVL_SHIFT  4
0031 #define RT5759A_WDTEN_MASK  BIT(1)
0032
0033 #define RT5759_MANUFACTURER_ID  0x82
0034 /* vsel range 0x00 ~ 0x5A */
0035 #define RT5759_NUM_VOLTS    91
0036 #define RT5759_MIN_UV       600000
0037 #define RT5759_STEP_UV      10000
0038 #define RT5759A_STEP_UV     12500
0039 #define RT5759_MINSS_TIMEUS 1500
0040
0041 #define RT5759_PSKIP_MODE   0
0042 #define RT5759_FPWM_MODE    1
0043
0044 enum {
0045     CHIP_TYPE_RT5759 = 0,
0046     CHIP_TYPE_RT5759A,
0047     CHIP_TYPE_MAX
0048 };
0049
0050 struct rt5759_priv {
0051     struct device *dev;
0052     struct regmap *regmap;
0053     struct regulator_desc desc;
0054     unsigned long chip_type;
0055 };
0056
0057 static int rt5759_set_mode(struct regulator_dev *rdev, unsigned int mode)
0058 {
0059     struct regmap *regmap = rdev_get_regmap(rdev);
0060     unsigned int mode_val;
0061
0062     switch (mode) {
0063     case REGULATOR_MODE_NORMAL:
0064         mode_val = 0;
0065         break;
0066     case REGULATOR_MODE_FAST:
0067         mode_val = RT5759_FPWM_MASK;
0068         break;
0069     default:
0070         return -EINVAL;
0071     }
0072
0073     return regmap_update_bits(regmap, RT5759_REG_STATUS, RT5759_FPWM_MASK,
0074                   mode_val);
0075 }
0076
0077 static unsigned int rt5759_get_mode(struct regulator_dev *rdev)
0078 {
0079     struct regmap *regmap = rdev_get_regmap(rdev);
0080     unsigned int regval;
0081     int ret;
0082
0083     ret = regmap_read(regmap, RT5759_REG_DCDCCTRL, &regval);
0084     if (ret)
0085         return REGULATOR_MODE_INVALID;
0086
0087     if (regval & RT5759_FPWM_MASK)
0088         return REGULATOR_MODE_FAST;
0089
0090     return REGULATOR_MODE_NORMAL;
0091 }
0092
0093 static int rt5759_get_error_flags(struct regulator_dev *rdev,
0094                   unsigned int *flags)
0095 {
0096     struct regmap *regmap = rdev_get_regmap(rdev);
0097     unsigned int status, events = 0;
0098     int ret;
0099
0100     ret = regmap_read(regmap, RT5759_REG_STATUS, &status);
0101     if (ret)
0102         return ret;
0103
0104     if (status & RT5759_OT_MASK)
0105         events |= REGULATOR_ERROR_OVER_TEMP;
0106
0107     if (status & RT5759_UV_MASK)
0108         events |= REGULATOR_ERROR_UNDER_VOLTAGE;
0109
0110     *flags = events;
0111     return 0;
0112 }
0113
0114 static int rt5759_set_ocp(struct regulator_dev *rdev, int lim_uA, int severity,
0115               bool enable)
0116 {
0117     struct regmap *regmap = rdev_get_regmap(rdev);
0118     int ocp_lvl[] = { 9800000, 10800000, 11800000 };
0119     unsigned int ocp_regval;
0120     int i;
0121
0122     /* Only support over current protection parameter */
0123     if (severity != REGULATOR_SEVERITY_PROT)
0124         return 0;
0125
0126     if (enable) {
0127         /* Default ocp level is 10.8A */
0128         if (lim_uA == 0)
0129             lim_uA = 10800000;
0130
0131         for (i = 0; i < ARRAY_SIZE(ocp_lvl); i++) {
0132             if (lim_uA <= ocp_lvl[i])
0133                 break;
0134         }
0135
0136         if (i == ARRAY_SIZE(ocp_lvl))
0137             i = ARRAY_SIZE(ocp_lvl) - 1;
0138
0139         ocp_regval = i + 1;
0140     } else
0141         ocp_regval = 0;
0142
0143     return regmap_update_bits(regmap, RT5759_REG_DCDCSET, RT5957_OCLVL_MASK,
0144                   ocp_regval << RT5759_OCLVL_SHIFT);
0145 }
0146
0147 static int rt5759_set_otp(struct regulator_dev *rdev, int lim, int severity,
0148               bool enable)
0149 {
0150     struct regmap *regmap = rdev_get_regmap(rdev);
0151     int otp_lvl[] = { 140, 150, 170 };
0152     unsigned int otp_regval;
0153     int i;
0154
0155     /* Only support over temperature protection parameter */
0156     if (severity != REGULATOR_SEVERITY_PROT)
0157         return 0;
0158
0159     if (enable) {
0160         /* Default otp level is 150'c */
0161         if (lim == 0)
0162             lim = 150;
0163
0164         for (i = 0; i < ARRAY_SIZE(otp_lvl); i++) {
0165             if (lim <= otp_lvl[i])
0166                 break;
0167         }
0168
0169         if (i == ARRAY_SIZE(otp_lvl))
0170             i = ARRAY_SIZE(otp_lvl) - 1;
0171
0172         otp_regval = i + 1;
0173     } else
0174         otp_regval = 0;
0175
0176     return regmap_update_bits(regmap, RT5759_REG_DCDCSET, RT5957_OTLVL_MASK,
0177                   otp_regval << RT5759_OTLVL_SHIFT);
0178 }
0179
0180 static const struct regulator_ops rt5759_regulator_ops = {
0181     .list_voltage = regulator_list_voltage_linear,
0182     .set_voltage_sel = regulator_set_voltage_sel_regmap,
0183     .get_voltage_sel = regulator_get_voltage_sel_regmap,
0184     .enable = regulator_enable_regmap,
0185     .disable = regulator_disable_regmap,
0186     .is_enabled = regulator_is_enabled_regmap,
0187     .set_active_discharge = regulator_set_active_discharge_regmap,
0188     .set_mode = rt5759_set_mode,
0189     .get_mode = rt5759_get_mode,
0190     .set_ramp_delay = regulator_set_ramp_delay_regmap,
0191     .get_error_flags = rt5759_get_error_flags,
0192     .set_over_current_protection = rt5759_set_ocp,
0193     .set_thermal_protection = rt5759_set_otp,
0194 };
0195
0196 static unsigned int rt5759_of_map_mode(unsigned int mode)
0197 {
0198     switch (mode) {
0199     case RT5759_FPWM_MODE:
0200         return REGULATOR_MODE_FAST;
0201     case RT5759_PSKIP_MODE:
0202         return REGULATOR_MODE_NORMAL;
0203     default:
0204         return REGULATOR_MODE_INVALID;
0205     }
0206 }
0207
0208 static const unsigned int rt5759_ramp_table[] = { 20000, 15000, 10000, 5000 };
0209
0210 static int rt5759_regulator_register(struct rt5759_priv *priv)
0211 {
0212     struct device_node *np = priv->dev->of_node;
0213     struct regulator_desc *reg_desc = &priv->desc;
0214     struct regulator_config reg_cfg;
0215     struct regulator_dev *rdev;
0216     int ret;
0217
0218     reg_desc->name = "rt5759-buck";
0219     reg_desc->type = REGULATOR_VOLTAGE;
0220     reg_desc->owner = THIS_MODULE;
0221     reg_desc->ops = &rt5759_regulator_ops;
0222     reg_desc->n_voltages = RT5759_NUM_VOLTS;
0223     reg_desc->min_uV = RT5759_MIN_UV;
0224     reg_desc->uV_step = RT5759_STEP_UV;
0225     reg_desc->vsel_reg = RT5759_REG_VSEL;
0226     reg_desc->vsel_mask = RT5759_VSEL_MASK;
0227     reg_desc->enable_reg = RT5759_REG_DCDCCTRL;
0228     reg_desc->enable_mask = RT5759_ENABLE_MASK;
0229     reg_desc->active_discharge_reg = RT5759_REG_DCDCCTRL;
0230     reg_desc->active_discharge_mask = RT5759_DISCHARGE_MASK;
0231     reg_desc->active_discharge_on = RT5759_DISCHARGE_MASK;
0232     reg_desc->ramp_reg = RT5759_REG_FREQ;
0233     reg_desc->ramp_mask = RT5759_TSTEP_MASK;
0234     reg_desc->ramp_delay_table = rt5759_ramp_table;
0235     reg_desc->n_ramp_values = ARRAY_SIZE(rt5759_ramp_table);
0236     reg_desc->enable_time = RT5759_MINSS_TIMEUS;
0237     reg_desc->of_map_mode = rt5759_of_map_mode;
0238
0239     /*
0240      * RT5759 step uV = 10000
0241      * RT5759A step uV = 12500
0242      */
0243     if (priv->chip_type == CHIP_TYPE_RT5759A)
0244         reg_desc->uV_step = RT5759A_STEP_UV;
0245
0246     reg_cfg.dev = priv->dev;
0247     reg_cfg.of_node = np;
0248     reg_cfg.init_data = of_get_regulator_init_data(priv->dev, np, reg_desc);
0249     reg_cfg.regmap = priv->regmap;
0250
0251     rdev = devm_regulator_register(priv->dev, reg_desc, &reg_cfg);
0252     if (IS_ERR(rdev)) {
0253         ret = PTR_ERR(rdev);
0254         dev_err(priv->dev, "Failed to register regulator (%d)\n", ret);
0255         return ret;
0256     }
0257
0258     return 0;
0259 }
0260
0261 static int rt5759_init_device_property(struct rt5759_priv *priv)
0262 {
0263     unsigned int val = 0;
0264
0265     /*
0266      * Only RT5759A support external watchdog input
0267      */
0268     if (priv->chip_type != CHIP_TYPE_RT5759A)
0269         return 0;
0270
0271     if (device_property_read_bool(priv->dev, "richtek,watchdog-enable"))
0272         val = RT5759A_WDTEN_MASK;
0273
0274     return regmap_update_bits(priv->regmap, RT5759A_REG_WDTEN,
0275                   RT5759A_WDTEN_MASK, val);
0276 }
0277
0278 static int rt5759_manufacturer_check(struct rt5759_priv *priv)
0279 {
0280     unsigned int vendor;
0281     int ret;
0282
0283     ret = regmap_read(priv->regmap, RT5759_REG_VENDORINFO, &vendor);
0284     if (ret)
0285         return ret;
0286
0287     if (vendor != RT5759_MANUFACTURER_ID) {
0288         dev_err(priv->dev, "vendor info not correct (%d)\n", vendor);
0289         return -EINVAL;
0290     }
0291
0292     return 0;
0293 }
0294
0295 static bool rt5759_is_accessible_reg(struct device *dev, unsigned int reg)
0296 {
0297     struct rt5759_priv *priv = dev_get_drvdata(dev);
0298
0299     if (reg <= RT5759_REG_DCDCSET)
0300         return true;
0301
0302     if (priv->chip_type == CHIP_TYPE_RT5759A && reg == RT5759A_REG_WDTEN)
0303         return true;
0304
0305     return false;
0306 }
0307
0308 static const struct regmap_config rt5759_regmap_config = {
0309     .reg_bits = 8,
0310     .val_bits = 8,
0311     .max_register = RT5759A_REG_WDTEN,
0312     .readable_reg = rt5759_is_accessible_reg,
0313     .writeable_reg = rt5759_is_accessible_reg,
0314 };
0315
0316 static int rt5759_probe(struct i2c_client *i2c)
0317 {
0318     struct rt5759_priv *priv;
0319     int ret;
0320
0321     priv = devm_kzalloc(&i2c->dev, sizeof(*priv), GFP_KERNEL);
0322     if (!priv)
0323         return -ENOMEM;
0324
0325     priv->dev = &i2c->dev;
0326     priv->chip_type = (unsigned long)of_device_get_match_data(&i2c->dev);
0327     i2c_set_clientdata(i2c, priv);
0328
0329     priv->regmap = devm_regmap_init_i2c(i2c, &rt5759_regmap_config);
0330     if (IS_ERR(priv->regmap)) {
0331         ret = PTR_ERR(priv->regmap);
0332         dev_err(&i2c->dev, "Failed to allocate regmap (%d)\n", ret);
0333         return ret;
0334     }
0335
0336     ret = rt5759_manufacturer_check(priv);
0337     if (ret) {
0338         dev_err(&i2c->dev, "Failed to check device (%d)\n", ret);
0339         return ret;
0340     }
0341
0342     ret = rt5759_init_device_property(priv);
0343     if (ret) {
0344         dev_err(&i2c->dev, "Failed to init device (%d)\n", ret);
0345         return ret;
0346     }
0347
0348     return rt5759_regulator_register(priv);
0349 }
0350
0351 static const struct of_device_id __maybe_unused rt5759_device_table[] = {
0352     { .compatible = "richtek,rt5759", .data = (void *)CHIP_TYPE_RT5759 },
0353     { .compatible = "richtek,rt5759a", .data = (void *)CHIP_TYPE_RT5759A },
0354     {}
0355 };
0356 MODULE_DEVICE_TABLE(of, rt5759_device_table);
0357
0358 static struct i2c_driver rt5759_driver = {
0359     .driver = {
0360         .name = "rt5759",
0361         .of_match_table = of_match_ptr(rt5759_device_table),
0362     },
0363     .probe_new = rt5759_probe,
0364 };
0365 module_i2c_driver(rt5759_driver);
0366
0367 MODULE_AUTHOR("ChiYuan Huang <cy_huang@richtek.com>");
0368 MODULE_DESCRIPTION("Richtek RT5759 Regulator Driver");
0369 MODULE_LICENSE("GPL v2");