drivers/regulator/pwm-regulator.c

   1 /*
   2  * Regulator driver for PWM Regulators
   3  *
   4  * Copyright (C) 2014 - STMicroelectronics Inc.
   5  *
   6  * Author: Lee Jones <lee.jones@linaro.org>
   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 version 2 as
  10  * published by the Free Software Foundation.
  11  */
  12
  13 #include <linux/delay.h>
  14 #include <linux/module.h>
  15 #include <linux/init.h>
  16 #include <linux/err.h>
  17 #include <linux/regulator/driver.h>
  18 #include <linux/regulator/machine.h>
  19 #include <linux/regulator/of_regulator.h>
  20 #include <linux/of.h>
  21 #include <linux/of_device.h>
  22 #include <linux/pwm.h>
  23 #include <linux/gpio/consumer.h>
  24
  25 struct pwm_regulator_data {
  26         /*  Shared */
  27         struct pwm_device *pwm;
  28
  29         /* Voltage table */
  30         struct pwm_voltages *duty_cycle_table;
  31
  32         /* regulator descriptor */
  33         struct regulator_desc desc;
  34
  35         /* Regulator ops */
  36         struct regulator_ops ops;
  37
  38         int state;
  39
  40         /* Continuous voltage */
  41         int volt_uV;
  42
  43         /* Enable GPIO */
  44         struct gpio_desc *enb_gpio;
  45 };
  46
  47 struct pwm_voltages {
  48         unsigned int uV;
  49         unsigned int dutycycle;
  50 };
  51
  52 /**
  53  * Voltage table call-backs
  54  */
  55 static int pwm_regulator_get_voltage_sel(struct regulator_dev *rdev)
  56 {
  57         struct pwm_regulator_data *drvdata = rdev_get_drvdata(rdev);
  58
  59         return drvdata->state;
  60 }
  61
  62 static int pwm_regulator_set_voltage_sel(struct regulator_dev *rdev,
  63                                          unsigned selector)
  64 {
  65         struct pwm_regulator_data *drvdata = rdev_get_drvdata(rdev);
  66         struct pwm_args pargs;
  67         int dutycycle;
  68         int ret;
  69
  70         pwm_get_args(drvdata->pwm, &pargs);
  71
  72         dutycycle = (pargs.period *
  73                     drvdata->duty_cycle_table[selector].dutycycle) / 100;
  74
  75         ret = pwm_config(drvdata->pwm, dutycycle, pargs.period);
  76         if (ret) {
  77                 dev_err(&rdev->dev, "Failed to configure PWM: %d\n", ret);
  78                 return ret;
  79         }
  80
  81         drvdata->state = selector;
  82
  83         return 0;
  84 }
  85
  86 static int pwm_regulator_list_voltage(struct regulator_dev *rdev,
  87                                       unsigned selector)
  88 {
  89         struct pwm_regulator_data *drvdata = rdev_get_drvdata(rdev);
  90
  91         if (selector >= rdev->desc->n_voltages)
  92                 return -EINVAL;
  93
  94         return drvdata->duty_cycle_table[selector].uV;
  95 }
  96
  97 static int pwm_regulator_enable(struct regulator_dev *dev)
  98 {
  99         struct pwm_regulator_data *drvdata = rdev_get_drvdata(dev);
 100
 101         if (drvdata->enb_gpio)
 102                 gpiod_set_value_cansleep(drvdata->enb_gpio, 1);
 103
 104         return pwm_enable(drvdata->pwm);
 105 }
 106
 107 static int pwm_regulator_disable(struct regulator_dev *dev)
 108 {
 109         struct pwm_regulator_data *drvdata = rdev_get_drvdata(dev);
 110
 111         pwm_disable(drvdata->pwm);
 112
 113         if (drvdata->enb_gpio)
 114                 gpiod_set_value_cansleep(drvdata->enb_gpio, 0);
 115
 116         return 0;
 117 }
 118
 119 static int pwm_regulator_is_enabled(struct regulator_dev *dev)
 120 {
 121         struct pwm_regulator_data *drvdata = rdev_get_drvdata(dev);
 122
 123         if (drvdata->enb_gpio && !gpiod_get_value_cansleep(drvdata->enb_gpio))
 124                 return false;
 125
 126         return pwm_is_enabled(drvdata->pwm);
 127 }
 128
 129 static int pwm_regulator_get_voltage(struct regulator_dev *rdev)
 130 {
 131         struct pwm_regulator_data *drvdata = rdev_get_drvdata(rdev);
 132
 133         return drvdata->volt_uV;
 134 }
 135
 136 static int pwm_regulator_set_voltage(struct regulator_dev *rdev,
 137                                         int min_uV, int max_uV,
 138                                         unsigned *selector)
 139 {
 140         struct pwm_regulator_data *drvdata = rdev_get_drvdata(rdev);
 141         unsigned int ramp_delay = rdev->constraints->ramp_delay;
 142         struct pwm_args pargs;
 143         unsigned int req_diff = min_uV - rdev->constraints->min_uV;
 144         unsigned int diff;
 145         unsigned int duty_pulse;
 146         u64 req_period;
 147         u32 rem;
 148         int ret;
 149
 150         pwm_get_args(drvdata->pwm, &pargs);
 151         diff = rdev->constraints->max_uV - rdev->constraints->min_uV;
 152
 153         /* First try to find out if we get the iduty cycle time which is
 154          * factor of PWM period time. If (request_diff_to_min * pwm_period)
 155          * is perfect divided by voltage_range_diff then it is possible to
 156          * get duty cycle time which is factor of PWM period. This will help
 157          * to get output voltage nearer to requested value as there is no
 158          * calculation loss.
 159          */
 160         req_period = req_diff * pargs.period;
 161         div_u64_rem(req_period, diff, &rem);
 162         if (!rem) {
 163                 do_div(req_period, diff);
 164                 duty_pulse = (unsigned int)req_period;
 165         } else {
 166                 duty_pulse = (pargs.period / 100) * ((req_diff * 100) / diff);
 167         }
 168
 169         ret = pwm_config(drvdata->pwm, duty_pulse, pargs.period);
 170         if (ret) {
 171                 dev_err(&rdev->dev, "Failed to configure PWM: %d\n", ret);
 172                 return ret;
 173         }
 174
 175         drvdata->volt_uV = min_uV;
 176
 177         /* Delay required by PWM regulator to settle to the new voltage */
 178         usleep_range(ramp_delay, ramp_delay + 1000);
 179
 180         return 0;
 181 }
 182
 183 static struct regulator_ops pwm_regulator_voltage_table_ops = {
 184         .set_voltage_sel = pwm_regulator_set_voltage_sel,
 185         .get_voltage_sel = pwm_regulator_get_voltage_sel,
 186         .list_voltage    = pwm_regulator_list_voltage,
 187         .map_voltage     = regulator_map_voltage_iterate,
 188         .enable          = pwm_regulator_enable,
 189         .disable         = pwm_regulator_disable,
 190         .is_enabled      = pwm_regulator_is_enabled,
 191 };
 192
 193 static struct regulator_ops pwm_regulator_voltage_continuous_ops = {
 194         .get_voltage = pwm_regulator_get_voltage,
 195         .set_voltage = pwm_regulator_set_voltage,
 196         .enable          = pwm_regulator_enable,
 197         .disable         = pwm_regulator_disable,
 198         .is_enabled      = pwm_regulator_is_enabled,
 199 };
 200
 201 static struct regulator_desc pwm_regulator_desc = {
 202         .name           = "pwm-regulator",
 203         .type           = REGULATOR_VOLTAGE,
 204         .owner          = THIS_MODULE,
 205         .supply_name    = "pwm",
 206 };
 207
 208 static int pwm_regulator_init_table(struct platform_device *pdev,
 209                                     struct pwm_regulator_data *drvdata)
 210 {
 211         struct device_node *np = pdev->dev.of_node;
 212         struct pwm_voltages *duty_cycle_table;
 213         unsigned int length = 0;
 214         int ret;
 215
 216         of_find_property(np, "voltage-table", &length);
 217
 218         if ((length < sizeof(*duty_cycle_table)) ||
 219             (length % sizeof(*duty_cycle_table))) {
 220                 dev_err(&pdev->dev, "voltage-table length(%d) is invalid\n",
 221                         length);
 222                 return -EINVAL;
 223         }
 224
 225         duty_cycle_table = devm_kzalloc(&pdev->dev, length, GFP_KERNEL);
 226         if (!duty_cycle_table)
 227                 return -ENOMEM;
 228
 229         ret = of_property_read_u32_array(np, "voltage-table",
 230                                          (u32 *)duty_cycle_table,
 231                                          length / sizeof(u32));
 232         if (ret) {
 233                 dev_err(&pdev->dev, "Failed to read voltage-table: %d\n", ret);
 234                 return ret;
 235         }
 236
 237         drvdata->duty_cycle_table       = duty_cycle_table;
 238         memcpy(&drvdata->ops, &pwm_regulator_voltage_table_ops,
 239                sizeof(drvdata->ops));
 240         drvdata->desc.ops = &drvdata->ops;
 241         drvdata->desc.n_voltages        = length / sizeof(*duty_cycle_table);
 242
 243         return 0;
 244 }
 245
 246 static int pwm_regulator_init_continuous(struct platform_device *pdev,
 247                                          struct pwm_regulator_data *drvdata)
 248 {
 249         memcpy(&drvdata->ops, &pwm_regulator_voltage_continuous_ops,
 250                sizeof(drvdata->ops));
 251         drvdata->desc.ops = &drvdata->ops;
 252         drvdata->desc.continuous_voltage_range = true;
 253
 254         return 0;
 255 }
 256
 257 static int pwm_regulator_probe(struct platform_device *pdev)
 258 {
 259         const struct regulator_init_data *init_data;
 260         struct pwm_regulator_data *drvdata;
 261         struct regulator_dev *regulator;
 262         struct regulator_config config = { };
 263         struct device_node *np = pdev->dev.of_node;
 264         enum gpiod_flags gpio_flags;
 265         int ret;
 266
 267         if (!np) {
 268                 dev_err(&pdev->dev, "Device Tree node missing\n");
 269                 return -EINVAL;
 270         }
 271
 272         drvdata = devm_kzalloc(&pdev->dev, sizeof(*drvdata), GFP_KERNEL);
 273         if (!drvdata)
 274                 return -ENOMEM;
 275
 276         memcpy(&drvdata->desc, &pwm_regulator_desc, sizeof(drvdata->desc));
 277
 278         if (of_find_property(np, "voltage-table", NULL))
 279                 ret = pwm_regulator_init_table(pdev, drvdata);
 280         else
 281                 ret = pwm_regulator_init_continuous(pdev, drvdata);
 282         if (ret)
 283                 return ret;
 284
 285         init_data = of_get_regulator_init_data(&pdev->dev, np,
 286                                                &drvdata->desc);
 287         if (!init_data)
 288                 return -ENOMEM;
 289
 290         config.of_node = np;
 291         config.dev = &pdev->dev;
 292         config.driver_data = drvdata;
 293         config.init_data = init_data;
 294
 295         drvdata->pwm = devm_pwm_get(&pdev->dev, NULL);
 296         if (IS_ERR(drvdata->pwm)) {
 297                 ret = PTR_ERR(drvdata->pwm);
 298                 dev_err(&pdev->dev, "Failed to get PWM: %d\n", ret);
 299                 return ret;
 300         }
 301
 302         if (init_data->constraints.boot_on || init_data->constraints.always_on)
 303                 gpio_flags = GPIOD_OUT_HIGH;
 304         else
 305                 gpio_flags = GPIOD_OUT_LOW;
 306         drvdata->enb_gpio = devm_gpiod_get_optional(&pdev->dev, "enable",
 307                                                     gpio_flags);
 308         if (IS_ERR(drvdata->enb_gpio)) {
 309                 ret = PTR_ERR(drvdata->enb_gpio);
 310                 dev_err(&pdev->dev, "Failed to get enable GPIO: %d\n", ret);
 311                 return ret;
 312         }
 313
 314         /*
 315          * FIXME: pwm_apply_args() should be removed when switching to the
 316          * atomic PWM API.
 317          */
 318         pwm_apply_args(drvdata->pwm);
 319
 320         regulator = devm_regulator_register(&pdev->dev,
 321                                             &drvdata->desc, &config);
 322         if (IS_ERR(regulator)) {
 323                 ret = PTR_ERR(regulator);
 324                 dev_err(&pdev->dev, "Failed to register regulator %s: %d\n",
 325                         drvdata->desc.name, ret);
 326                 return ret;
 327         }
 328
 329         return 0;
 330 }
 331
 332 static const struct of_device_id pwm_of_match[] = {
 333         { .compatible = "pwm-regulator" },
 334         { },
 335 };
 336 MODULE_DEVICE_TABLE(of, pwm_of_match);
 337
 338 static struct platform_driver pwm_regulator_driver = {
 339         .driver = {
 340                 .name           = "pwm-regulator",
 341                 .of_match_table = of_match_ptr(pwm_of_match),
 342         },
 343         .probe = pwm_regulator_probe,
 344 };
 345
 346 module_platform_driver(pwm_regulator_driver);
 347
 348 MODULE_LICENSE("GPL");
 349 MODULE_AUTHOR("Lee Jones <lee.jones@linaro.org>");
 350 MODULE_DESCRIPTION("PWM Regulator Driver");
 351 MODULE_ALIAS("platform:pwm-regulator");