drivers/pwm/pwm-mxs.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright 2012 Freescale Semiconductor, Inc.
   4  */
   5
   6 #include <linux/clk.h>
   7 #include <linux/err.h>
   8 #include <linux/io.h>
   9 #include <linux/kernel.h>
  10 #include <linux/module.h>
  11 #include <linux/of.h>
  12 #include <linux/of_address.h>
  13 #include <linux/platform_device.h>
  14 #include <linux/pwm.h>
  15 #include <linux/slab.h>
  16 #include <linux/stmp_device.h>
  17
  18 #define SET     0x4
  19 #define CLR     0x8
  20 #define TOG     0xc
  21
  22 #define PWM_CTRL                0x0
  23 #define PWM_ACTIVE0             0x10
  24 #define PWM_PERIOD0             0x20
  25 #define  PERIOD_PERIOD(p)       ((p) & 0xffff)
  26 #define  PERIOD_PERIOD_MAX      0x10000
  27 #define  PERIOD_ACTIVE_HIGH     (3 << 16)
  28 #define  PERIOD_INACTIVE_LOW    (2 << 18)
  29 #define  PERIOD_POLARITY_NORMAL (PERIOD_ACTIVE_HIGH | PERIOD_INACTIVE_LOW)
  30 #define  PERIOD_CDIV(div)       (((div) & 0x7) << 20)
  31 #define  PERIOD_CDIV_MAX        8
  32
  33 static const unsigned int cdiv[PERIOD_CDIV_MAX] = {
  34         1, 2, 4, 8, 16, 64, 256, 1024
  35 };
  36
  37 struct mxs_pwm_chip {
  38         struct pwm_chip chip;
  39         struct clk *clk;
  40         void __iomem *base;
  41 };
  42
  43 #define to_mxs_pwm_chip(_chip) container_of(_chip, struct mxs_pwm_chip, chip)
  44
  45 static int mxs_pwm_apply(struct pwm_chip *chip, struct pwm_device *pwm,
  46                          const struct pwm_state *state)
  47 {
  48         struct mxs_pwm_chip *mxs = to_mxs_pwm_chip(chip);
  49         int ret, div = 0;
  50         unsigned int period_cycles, duty_cycles;
  51         unsigned long rate;
  52         unsigned long long c;
  53
  54         if (state->polarity != PWM_POLARITY_NORMAL)
  55                 return -ENOTSUPP;
  56
  57         /*
  58          * If the PWM channel is disabled, make sure to turn on the
  59          * clock before calling clk_get_rate() and writing to the
  60          * registers. Otherwise, just keep it enabled.
  61          */
  62         if (!pwm_is_enabled(pwm)) {
  63                 ret = clk_prepare_enable(mxs->clk);
  64                 if (ret)
  65                         return ret;
  66         }
  67
  68         if (!state->enabled && pwm_is_enabled(pwm))
  69                 writel(1 << pwm->hwpwm, mxs->base + PWM_CTRL + CLR);
  70
  71         rate = clk_get_rate(mxs->clk);
  72         while (1) {
  73                 c = rate / cdiv[div];
  74                 c = c * state->period;
  75                 do_div(c, 1000000000);
  76                 if (c < PERIOD_PERIOD_MAX)
  77                         break;
  78                 div++;
  79                 if (div >= PERIOD_CDIV_MAX)
  80                         return -EINVAL;
  81         }
  82
  83         period_cycles = c;
  84         c *= state->duty_cycle;
  85         do_div(c, state->period);
  86         duty_cycles = c;
  87
  88         /*
  89          * The data sheet the says registers must be written to in
  90          * this order (ACTIVEn, then PERIODn). Also, the new settings
  91          * only take effect at the beginning of a new period, avoiding
  92          * glitches.
  93          */
  94         writel(duty_cycles << 16,
  95                mxs->base + PWM_ACTIVE0 + pwm->hwpwm * 0x20);
  96         writel(PERIOD_PERIOD(period_cycles) | PERIOD_POLARITY_NORMAL | PERIOD_CDIV(div),
  97                mxs->base + PWM_PERIOD0 + pwm->hwpwm * 0x20);
  98
  99         if (state->enabled) {
 100                 if (!pwm_is_enabled(pwm)) {
 101                         /*
 102                          * The clock was enabled above. Just enable
 103                          * the channel in the control register.
 104                          */
 105                         writel(1 << pwm->hwpwm, mxs->base + PWM_CTRL + SET);
 106                 }
 107         } else {
 108                 clk_disable_unprepare(mxs->clk);
 109         }
 110         return 0;
 111 }
 112
 113 static int mxs_pwm_config(struct pwm_chip *chip, struct pwm_device *pwm,
 114                           int duty_ns, int period_ns)
 115 {
 116         struct mxs_pwm_chip *mxs = to_mxs_pwm_chip(chip);
 117         int ret, div = 0;
 118         unsigned int period_cycles, duty_cycles;
 119         unsigned long rate;
 120         unsigned long long c;
 121
 122         rate = clk_get_rate(mxs->clk);
 123         while (1) {
 124                 c = rate / cdiv[div];
 125                 c = c * period_ns;
 126                 do_div(c, 1000000000);
 127                 if (c < PERIOD_PERIOD_MAX)
 128                         break;
 129                 div++;
 130                 if (div >= PERIOD_CDIV_MAX)
 131                         return -EINVAL;
 132         }
 133
 134         period_cycles = c;
 135         c *= duty_ns;
 136         do_div(c, period_ns);
 137         duty_cycles = c;
 138
 139         /*
 140          * If the PWM channel is disabled, make sure to turn on the clock
 141          * before writing the register. Otherwise, keep it enabled.
 142          */
 143         if (!pwm_is_enabled(pwm)) {
 144                 ret = clk_prepare_enable(mxs->clk);
 145                 if (ret)
 146                         return ret;
 147         }
 148
 149         writel(duty_cycles << 16,
 150                         mxs->base + PWM_ACTIVE0 + pwm->hwpwm * 0x20);
 151         writel(PERIOD_PERIOD(period_cycles) | PERIOD_ACTIVE_HIGH |
 152                PERIOD_INACTIVE_LOW | PERIOD_CDIV(div),
 153                         mxs->base + PWM_PERIOD0 + pwm->hwpwm * 0x20);
 154
 155         /*
 156          * If the PWM is not enabled, turn the clock off again to save power.
 157          */
 158         if (!pwm_is_enabled(pwm))
 159                 clk_disable_unprepare(mxs->clk);
 160
 161         return 0;
 162 }
 163
 164 static int mxs_pwm_enable(struct pwm_chip *chip, struct pwm_device *pwm)
 165 {
 166         struct mxs_pwm_chip *mxs = to_mxs_pwm_chip(chip);
 167         int ret;
 168
 169         ret = clk_prepare_enable(mxs->clk);
 170         if (ret)
 171                 return ret;
 172
 173         writel(1 << pwm->hwpwm, mxs->base + PWM_CTRL + SET);
 174
 175         return 0;
 176 }
 177
 178 static void mxs_pwm_disable(struct pwm_chip *chip, struct pwm_device *pwm)
 179 {
 180         struct mxs_pwm_chip *mxs = to_mxs_pwm_chip(chip);
 181
 182         writel(1 << pwm->hwpwm, mxs->base + PWM_CTRL + CLR);
 183
 184         clk_disable_unprepare(mxs->clk);
 185 }
 186
 187 static const struct pwm_ops mxs_pwm_ops = {
 188         .apply = mxs_pwm_apply,
 189         .config = mxs_pwm_config,
 190         .enable = mxs_pwm_enable,
 191         .disable = mxs_pwm_disable,
 192         .owner = THIS_MODULE,
 193 };
 194
 195 static int mxs_pwm_probe(struct platform_device *pdev)
 196 {
 197         struct device_node *np = pdev->dev.of_node;
 198         struct mxs_pwm_chip *mxs;
 199         int ret;
 200
 201         mxs = devm_kzalloc(&pdev->dev, sizeof(*mxs), GFP_KERNEL);
 202         if (!mxs)
 203                 return -ENOMEM;
 204
 205         mxs->base = devm_platform_ioremap_resource(pdev, 0);
 206         if (IS_ERR(mxs->base))
 207                 return PTR_ERR(mxs->base);
 208
 209         mxs->clk = devm_clk_get(&pdev->dev, NULL);
 210         if (IS_ERR(mxs->clk))
 211                 return PTR_ERR(mxs->clk);
 212
 213         mxs->chip.dev = &pdev->dev;
 214         mxs->chip.ops = &mxs_pwm_ops;
 215         mxs->chip.base = -1;
 216
 217         ret = of_property_read_u32(np, "fsl,pwm-number", &mxs->chip.npwm);
 218         if (ret < 0) {
 219                 dev_err(&pdev->dev, "failed to get pwm number: %d\n", ret);
 220                 return ret;
 221         }
 222
 223         ret = pwmchip_add(&mxs->chip);
 224         if (ret < 0) {
 225                 dev_err(&pdev->dev, "failed to add pwm chip %d\n", ret);
 226                 return ret;
 227         }
 228
 229         platform_set_drvdata(pdev, mxs);
 230
 231         ret = stmp_reset_block(mxs->base);
 232         if (ret)
 233                 goto pwm_remove;
 234
 235         return 0;
 236
 237 pwm_remove:
 238         pwmchip_remove(&mxs->chip);
 239         return ret;
 240 }
 241
 242 static int mxs_pwm_remove(struct platform_device *pdev)
 243 {
 244         struct mxs_pwm_chip *mxs = platform_get_drvdata(pdev);
 245
 246         return pwmchip_remove(&mxs->chip);
 247 }
 248
 249 static const struct of_device_id mxs_pwm_dt_ids[] = {
 250         { .compatible = "fsl,imx23-pwm", },
 251         { /* sentinel */ }
 252 };
 253 MODULE_DEVICE_TABLE(of, mxs_pwm_dt_ids);
 254
 255 static struct platform_driver mxs_pwm_driver = {
 256         .driver = {
 257                 .name = "mxs-pwm",
 258                 .of_match_table = mxs_pwm_dt_ids,
 259         },
 260         .probe = mxs_pwm_probe,
 261         .remove = mxs_pwm_remove,
 262 };
 263 module_platform_driver(mxs_pwm_driver);
 264
 265 MODULE_ALIAS("platform:mxs-pwm");
 266 MODULE_AUTHOR("Shawn Guo <shawn.guo@linaro.org>");
 267 MODULE_DESCRIPTION("Freescale MXS PWM Driver");
 268 MODULE_LICENSE("GPL v2");