drivers/regulator/max77686.c

   1 /*
   2  * max77686.c - Regulator driver for the Maxim 77686
   3  *
   4  * Copyright (C) 2012 Samsung Electronics
   5  * Chiwoong Byun <woong.byun@smasung.com>
   6  * Jonghwa Lee <jonghwa3.lee@samsung.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  * This driver is based on max8997.c
  23  */
  24
  25 #include <linux/kernel.h>
  26 #include <linux/bug.h>
  27 #include <linux/delay.h>
  28 #include <linux/err.h>
  29 #include <linux/gpio.h>
  30 #include <linux/slab.h>
  31 #include <linux/platform_device.h>
  32 #include <linux/regulator/driver.h>
  33 #include <linux/regulator/machine.h>
  34 #include <linux/mfd/max77686.h>
  35 #include <linux/mfd/max77686-private.h>
  36
  37 #define MAX77686_LDO_MINUV      800000
  38 #define MAX77686_LDO_UVSTEP     50000
  39 #define MAX77686_LDO_LOW_MINUV  800000
  40 #define MAX77686_LDO_LOW_UVSTEP 25000
  41 #define MAX77686_BUCK_MINUV     750000
  42 #define MAX77686_BUCK_UVSTEP    50000
  43 #define MAX77686_RAMP_DELAY     100000                  /* uV/us */
  44 #define MAX77686_DVS_RAMP_DELAY 27500                   /* uV/us */
  45 #define MAX77686_DVS_MINUV      600000
  46 #define MAX77686_DVS_UVSTEP     12500
  47
  48 #define MAX77686_OPMODE_SHIFT   6
  49 #define MAX77686_OPMODE_BUCK234_SHIFT   4
  50 #define MAX77686_OPMODE_MASK    0x3
  51
  52 #define MAX77686_VSEL_MASK      0x3F
  53 #define MAX77686_DVS_VSEL_MASK  0xFF
  54
  55 #define MAX77686_RAMP_RATE_MASK 0xC0
  56
  57 #define MAX77686_REGULATORS     MAX77686_REG_MAX
  58 #define MAX77686_LDOS           26
  59
  60 enum max77686_ramp_rate {
  61         RAMP_RATE_13P75MV,
  62         RAMP_RATE_27P5MV,
  63         RAMP_RATE_55MV,
  64         RAMP_RATE_NO_CTRL,      /* 100mV/us */
  65 };
  66
  67 struct max77686_data {
  68         struct device *dev;
  69         struct max77686_dev *iodev;
  70         struct regulator_dev **rdev;
  71 };
  72
  73 static struct regulator_ops max77686_ops = {
  74         .list_voltage           = regulator_list_voltage_linear,
  75         .map_voltage            = regulator_map_voltage_linear,
  76         .is_enabled             = regulator_is_enabled_regmap,
  77         .enable                 = regulator_enable_regmap,
  78         .disable                = regulator_disable_regmap,
  79         .get_voltage_sel        = regulator_get_voltage_sel_regmap,
  80         .set_voltage_sel        = regulator_set_voltage_sel_regmap,
  81         .set_voltage_time_sel   = regulator_set_voltage_time_sel,
  82 };
  83
  84 static struct regulator_ops max77686_buck_dvs_ops = {
  85         .list_voltage           = regulator_list_voltage_linear,
  86         .map_voltage            = regulator_map_voltage_linear,
  87         .is_enabled             = regulator_is_enabled_regmap,
  88         .enable                 = regulator_enable_regmap,
  89         .disable                = regulator_disable_regmap,
  90         .get_voltage_sel        = regulator_get_voltage_sel_regmap,
  91         .set_voltage_sel        = regulator_set_voltage_sel_regmap,
  92         .set_voltage_time_sel   = regulator_set_voltage_time_sel,
  93 };
  94
  95 #define regulator_desc_ldo(num)         {                               \
  96         .name           = "LDO"#num,                                    \
  97         .id             = MAX77686_LDO##num,                            \
  98         .ops            = &max77686_ops,                                \
  99         .type           = REGULATOR_VOLTAGE,                            \
 100         .owner          = THIS_MODULE,                                  \
 101         .min_uV         = MAX77686_LDO_MINUV,                           \
 102         .uV_step        = MAX77686_LDO_UVSTEP,                          \
 103         .ramp_delay     = MAX77686_RAMP_DELAY,                          \
 104         .n_voltages     = MAX77686_VSEL_MASK + 1,                       \
 105         .vsel_reg       = MAX77686_REG_LDO1CTRL1 + num - 1,             \
 106         .vsel_mask      = MAX77686_VSEL_MASK,                           \
 107         .enable_reg     = MAX77686_REG_LDO1CTRL1 + num - 1,             \
 108         .enable_mask    = MAX77686_OPMODE_MASK                          \
 109                         << MAX77686_OPMODE_SHIFT,                       \
 110 }
 111 #define regulator_desc_ldo_low(num)             {                       \
 112         .name           = "LDO"#num,                                    \
 113         .id             = MAX77686_LDO##num,                            \
 114         .ops            = &max77686_ops,                                \
 115         .type           = REGULATOR_VOLTAGE,                            \
 116         .owner          = THIS_MODULE,                                  \
 117         .min_uV         = MAX77686_LDO_LOW_MINUV,                       \
 118         .uV_step        = MAX77686_LDO_LOW_UVSTEP,                      \
 119         .ramp_delay     = MAX77686_RAMP_DELAY,                          \
 120         .n_voltages     = MAX77686_VSEL_MASK + 1,                       \
 121         .vsel_reg       = MAX77686_REG_LDO1CTRL1 + num - 1,             \
 122         .vsel_mask      = MAX77686_VSEL_MASK,                           \
 123         .enable_reg     = MAX77686_REG_LDO1CTRL1 + num - 1,             \
 124         .enable_mask    = MAX77686_OPMODE_MASK                          \
 125                         << MAX77686_OPMODE_SHIFT,                       \
 126 }
 127 #define regulator_desc_buck(num)                {                       \
 128         .name           = "BUCK"#num,                                   \
 129         .id             = MAX77686_BUCK##num,                           \
 130         .ops            = &max77686_ops,                                \
 131         .type           = REGULATOR_VOLTAGE,                            \
 132         .owner          = THIS_MODULE,                                  \
 133         .min_uV         = MAX77686_BUCK_MINUV,                          \
 134         .uV_step        = MAX77686_BUCK_UVSTEP,                         \
 135         .ramp_delay     = MAX77686_RAMP_DELAY,                          \
 136         .n_voltages     = MAX77686_VSEL_MASK + 1,                       \
 137         .vsel_reg       = MAX77686_REG_BUCK5OUT + (num - 5) * 2,        \
 138         .vsel_mask      = MAX77686_VSEL_MASK,                           \
 139         .enable_reg     = MAX77686_REG_BUCK5CTRL + (num - 5) * 2,       \
 140         .enable_mask    = MAX77686_OPMODE_MASK,                         \
 141 }
 142 #define regulator_desc_buck1(num)               {                       \
 143         .name           = "BUCK"#num,                                   \
 144         .id             = MAX77686_BUCK##num,                           \
 145         .ops            = &max77686_ops,                                \
 146         .type           = REGULATOR_VOLTAGE,                            \
 147         .owner          = THIS_MODULE,                                  \
 148         .min_uV         = MAX77686_BUCK_MINUV,                          \
 149         .uV_step        = MAX77686_BUCK_UVSTEP,                         \
 150         .ramp_delay     = MAX77686_RAMP_DELAY,                          \
 151         .n_voltages     = MAX77686_VSEL_MASK + 1,                       \
 152         .vsel_reg       = MAX77686_REG_BUCK1OUT,                        \
 153         .vsel_mask      = MAX77686_VSEL_MASK,                           \
 154         .enable_reg     = MAX77686_REG_BUCK1CTRL,                       \
 155         .enable_mask    = MAX77686_OPMODE_MASK,                         \
 156 }
 157 #define regulator_desc_buck_dvs(num)            {                       \
 158         .name           = "BUCK"#num,                                   \
 159         .id             = MAX77686_BUCK##num,                           \
 160         .ops            = &max77686_buck_dvs_ops,                       \
 161         .type           = REGULATOR_VOLTAGE,                            \
 162         .owner          = THIS_MODULE,                                  \
 163         .min_uV         = MAX77686_DVS_MINUV,                           \
 164         .uV_step        = MAX77686_DVS_UVSTEP,                          \
 165         .ramp_delay     = MAX77686_DVS_RAMP_DELAY,                      \
 166         .n_voltages     = MAX77686_DVS_VSEL_MASK + 1,                   \
 167         .vsel_reg       = MAX77686_REG_BUCK2DVS1 + (num - 2) * 10,      \
 168         .vsel_mask      = MAX77686_DVS_VSEL_MASK,                       \
 169         .enable_reg     = MAX77686_REG_BUCK2CTRL1 + (num - 2) * 10,     \
 170         .enable_mask    = MAX77686_OPMODE_MASK                          \
 171                         << MAX77686_OPMODE_BUCK234_SHIFT,               \
 172 }
 173
 174 static struct regulator_desc regulators[] = {
 175         regulator_desc_ldo_low(1),
 176         regulator_desc_ldo_low(2),
 177         regulator_desc_ldo(3),
 178         regulator_desc_ldo(4),
 179         regulator_desc_ldo(5),
 180         regulator_desc_ldo_low(6),
 181         regulator_desc_ldo_low(7),
 182         regulator_desc_ldo_low(8),
 183         regulator_desc_ldo(9),
 184         regulator_desc_ldo(10),
 185         regulator_desc_ldo(11),
 186         regulator_desc_ldo(12),
 187         regulator_desc_ldo(13),
 188         regulator_desc_ldo(14),
 189         regulator_desc_ldo_low(15),
 190         regulator_desc_ldo(16),
 191         regulator_desc_ldo(17),
 192         regulator_desc_ldo(18),
 193         regulator_desc_ldo(19),
 194         regulator_desc_ldo(20),
 195         regulator_desc_ldo(21),
 196         regulator_desc_ldo(22),
 197         regulator_desc_ldo(23),
 198         regulator_desc_ldo(24),
 199         regulator_desc_ldo(25),
 200         regulator_desc_ldo(26),
 201         regulator_desc_buck1(1),
 202         regulator_desc_buck_dvs(2),
 203         regulator_desc_buck_dvs(3),
 204         regulator_desc_buck_dvs(4),
 205         regulator_desc_buck(5),
 206         regulator_desc_buck(6),
 207         regulator_desc_buck(7),
 208         regulator_desc_buck(8),
 209         regulator_desc_buck(9),
 210 };
 211
 212 static __devinit int max77686_pmic_probe(struct platform_device *pdev)
 213 {
 214         struct max77686_dev *iodev = dev_get_drvdata(pdev->dev.parent);
 215         struct max77686_platform_data *pdata = dev_get_platdata(iodev->dev);
 216         struct regulator_dev **rdev;
 217         struct max77686_data *max77686;
 218         int i,  size;
 219         int ret = 0;
 220         struct regulator_config config;
 221
 222         dev_dbg(&pdev->dev, "%s\n", __func__);
 223
 224         if (!pdata || pdata->num_regulators != MAX77686_REGULATORS) {
 225                 dev_err(&pdev->dev,
 226                         "Invalid initial data for regulator's initialiation\n");
 227                 return -EINVAL;
 228         }
 229
 230         max77686 = devm_kzalloc(&pdev->dev, sizeof(struct max77686_data),
 231                                 GFP_KERNEL);
 232         if (!max77686)
 233                 return -ENOMEM;
 234
 235         size = sizeof(struct regulator_dev *) * MAX77686_REGULATORS;
 236         max77686->rdev = devm_kzalloc(&pdev->dev, size, GFP_KERNEL);
 237         if (!max77686->rdev)
 238                 return -ENOMEM;
 239
 240         rdev = max77686->rdev;
 241         max77686->dev = &pdev->dev;
 242         max77686->iodev = iodev;
 243         platform_set_drvdata(pdev, max77686);
 244
 245         for (i = 0; i < MAX77686_REGULATORS; i++) {
 246                 config.dev = max77686->dev;
 247                 config.regmap = iodev->regmap;
 248                 config.driver_data = max77686;
 249                 config.init_data = pdata->regulators[i].initdata;
 250
 251                 rdev[i] = regulator_register(&regulators[i], &config);
 252                 if (IS_ERR(rdev[i])) {
 253                         ret = PTR_ERR(rdev[i]);
 254                         dev_err(max77686->dev,
 255                                 "regulator init failed for %d\n", i);
 256                                 rdev[i] = NULL;
 257                                 goto err;
 258                 }
 259         }
 260
 261         return 0;
 262 err:
 263         while (--i >= 0)
 264                 regulator_unregister(rdev[i]);
 265         return ret;
 266 }
 267
 268 static int __devexit max77686_pmic_remove(struct platform_device *pdev)
 269 {
 270         struct max77686_data *max77686 = platform_get_drvdata(pdev);
 271         struct regulator_dev **rdev = max77686->rdev;
 272         int i;
 273
 274         for (i = 0; i < MAX77686_REGULATORS; i++)
 275                 if (rdev[i])
 276                         regulator_unregister(rdev[i]);
 277
 278         return 0;
 279 }
 280
 281 static const struct platform_device_id max77686_pmic_id[] = {
 282         {"max77686-pmic", 0},
 283         { },
 284 };
 285 MODULE_DEVICE_TABLE(platform, max77686_pmic_id);
 286
 287 static struct platform_driver max77686_pmic_driver = {
 288         .driver = {
 289                 .name = "max77686-pmic",
 290                 .owner = THIS_MODULE,
 291         },
 292         .probe = max77686_pmic_probe,
 293         .remove = __devexit_p(max77686_pmic_remove),
 294         .id_table = max77686_pmic_id,
 295 };
 296
 297 static int __init max77686_pmic_init(void)
 298 {
 299         return platform_driver_register(&max77686_pmic_driver);
 300 }
 301 subsys_initcall(max77686_pmic_init);
 302
 303 static void __exit max77686_pmic_cleanup(void)
 304 {
 305         platform_driver_unregister(&max77686_pmic_driver);
 306 }
 307 module_exit(max77686_pmic_cleanup);
 308
 309 MODULE_DESCRIPTION("MAXIM 77686 Regulator Driver");
 310 MODULE_AUTHOR("Chiwoong Byun <woong.byun@samsung.com>");
 311 MODULE_LICENSE("GPL");