drivers/pwm/pwm-imx.c

   1 /*
   2  * simple driver for PWM (Pulse Width Modulator) controller
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  *
   8  * Derived from pxa PWM driver by eric miao <eric.miao@marvell.com>
   9  */
  10
  11 #include <linux/module.h>
  12 #include <linux/kernel.h>
  13 #include <linux/platform_device.h>
  14 #include <linux/slab.h>
  15 #include <linux/err.h>
  16 #include <linux/clk.h>
  17 #include <linux/io.h>
  18 #include <linux/pwm.h>
  19 #include <linux/of.h>
  20 #include <linux/of_device.h>
  21
  22 /* i.MX1 and i.MX21 share the same PWM function block: */
  23
  24 #define MX1_PWMC    0x00   /* PWM Control Register */
  25 #define MX1_PWMS    0x04   /* PWM Sample Register */
  26 #define MX1_PWMP    0x08   /* PWM Period Register */
  27
  28 #define MX1_PWMC_EN                     (1 << 4)
  29
  30 /* i.MX27, i.MX31, i.MX35 share the same PWM function block: */
  31
  32 #define MX3_PWMCR                       0x00      /* PWM Control Register */
  33 #define MX3_PWMSAR                      0x0C      /* PWM Sample Register */
  34 #define MX3_PWMPR                       0x10      /* PWM Period Register */
  35 #define MX3_PWMCR_PRESCALER(x)          ((((x) - 1) & 0xFFF) << 4)
  36 #define MX3_PWMCR_DOZEEN                (1 << 24)
  37 #define MX3_PWMCR_WAITEN                (1 << 23)
  38 #define MX3_PWMCR_DBGEN                 (1 << 22)
  39 #define MX3_PWMCR_POUTC                 (1 << 18)
  40 #define MX3_PWMCR_CLKSRC_IPG_HIGH       (2 << 16)
  41 #define MX3_PWMCR_CLKSRC_IPG            (1 << 16)
  42 #define MX3_PWMCR_EN                    (1 << 0)
  43
  44 struct imx_chip {
  45         struct clk      *clk_per;
  46         struct clk      *clk_ipg;
  47
  48         void __iomem    *mmio_base;
  49
  50         struct pwm_chip chip;
  51
  52         int (*config)(struct pwm_chip *chip,
  53                 struct pwm_device *pwm, int duty_ns, int period_ns);
  54         void (*set_enable)(struct pwm_chip *chip, bool enable);
  55 };
  56
  57 #define to_imx_chip(chip)       container_of(chip, struct imx_chip, chip)
  58
  59 static int imx_pwm_config_v1(struct pwm_chip *chip,
  60                 struct pwm_device *pwm, int duty_ns, int period_ns)
  61 {
  62         struct imx_chip *imx = to_imx_chip(chip);
  63
  64         /*
  65          * The PWM subsystem allows for exact frequencies. However,
  66          * I cannot connect a scope on my device to the PWM line and
  67          * thus cannot provide the program the PWM controller
  68          * exactly. Instead, I'm relying on the fact that the
  69          * Bootloader (u-boot or WinCE+haret) has programmed the PWM
  70          * function group already. So I'll just modify the PWM sample
  71          * register to follow the ratio of duty_ns vs. period_ns
  72          * accordingly.
  73          *
  74          * This is good enough for programming the brightness of
  75          * the LCD backlight.
  76          *
  77          * The real implementation would divide PERCLK[0] first by
  78          * both the prescaler (/1 .. /128) and then by CLKSEL
  79          * (/2 .. /16).
  80          */
  81         u32 max = readl(imx->mmio_base + MX1_PWMP);
  82         u32 p = max * duty_ns / period_ns;
  83         writel(max - p, imx->mmio_base + MX1_PWMS);
  84
  85         return 0;
  86 }
  87
  88 static void imx_pwm_set_enable_v1(struct pwm_chip *chip, bool enable)
  89 {
  90         struct imx_chip *imx = to_imx_chip(chip);
  91         u32 val;
  92
  93         val = readl(imx->mmio_base + MX1_PWMC);
  94
  95         if (enable)
  96                 val |= MX1_PWMC_EN;
  97         else
  98                 val &= ~MX1_PWMC_EN;
  99
 100         writel(val, imx->mmio_base + MX1_PWMC);
 101 }
 102
 103 static int imx_pwm_config_v2(struct pwm_chip *chip,
 104                 struct pwm_device *pwm, int duty_ns, int period_ns)
 105 {
 106         struct imx_chip *imx = to_imx_chip(chip);
 107         unsigned long long c;
 108         unsigned long period_cycles, duty_cycles, prescale;
 109         u32 cr;
 110
 111         c = clk_get_rate(imx->clk_per);
 112         c = c * period_ns;
 113         do_div(c, 1000000000);
 114         period_cycles = c;
 115
 116         prescale = period_cycles / 0x10000 + 1;
 117
 118         period_cycles /= prescale;
 119         c = (unsigned long long)period_cycles * duty_ns;
 120         do_div(c, period_ns);
 121         duty_cycles = c;
 122
 123         /*
 124          * according to imx pwm RM, the real period value should be
 125          * PERIOD value in PWMPR plus 2.
 126          */
 127         if (period_cycles > 2)
 128                 period_cycles -= 2;
 129         else
 130                 period_cycles = 0;
 131
 132         writel(duty_cycles, imx->mmio_base + MX3_PWMSAR);
 133         writel(period_cycles, imx->mmio_base + MX3_PWMPR);
 134
 135         cr = MX3_PWMCR_PRESCALER(prescale) |
 136                 MX3_PWMCR_DOZEEN | MX3_PWMCR_WAITEN |
 137                 MX3_PWMCR_DBGEN | MX3_PWMCR_CLKSRC_IPG_HIGH;
 138
 139         if (test_bit(PWMF_ENABLED, &pwm->flags))
 140                 cr |= MX3_PWMCR_EN;
 141
 142         writel(cr, imx->mmio_base + MX3_PWMCR);
 143
 144         return 0;
 145 }
 146
 147 static void imx_pwm_set_enable_v2(struct pwm_chip *chip, bool enable)
 148 {
 149         struct imx_chip *imx = to_imx_chip(chip);
 150         u32 val;
 151
 152         val = readl(imx->mmio_base + MX3_PWMCR);
 153
 154         if (enable)
 155                 val |= MX3_PWMCR_EN;
 156         else
 157                 val &= ~MX3_PWMCR_EN;
 158
 159         writel(val, imx->mmio_base + MX3_PWMCR);
 160 }
 161
 162 static int imx_pwm_config(struct pwm_chip *chip,
 163                 struct pwm_device *pwm, int duty_ns, int period_ns)
 164 {
 165         struct imx_chip *imx = to_imx_chip(chip);
 166         int ret;
 167
 168         ret = clk_prepare_enable(imx->clk_ipg);
 169         if (ret)
 170                 return ret;
 171
 172         ret = imx->config(chip, pwm, duty_ns, period_ns);
 173
 174         clk_disable_unprepare(imx->clk_ipg);
 175
 176         return ret;
 177 }
 178
 179 static int imx_pwm_enable(struct pwm_chip *chip, struct pwm_device *pwm)
 180 {
 181         struct imx_chip *imx = to_imx_chip(chip);
 182         int ret;
 183
 184         ret = clk_prepare_enable(imx->clk_per);
 185         if (ret)
 186                 return ret;
 187
 188         imx->set_enable(chip, true);
 189
 190         return 0;
 191 }
 192
 193 static void imx_pwm_disable(struct pwm_chip *chip, struct pwm_device *pwm)
 194 {
 195         struct imx_chip *imx = to_imx_chip(chip);
 196
 197         imx->set_enable(chip, false);
 198
 199         clk_disable_unprepare(imx->clk_per);
 200 }
 201
 202 static struct pwm_ops imx_pwm_ops = {
 203         .enable = imx_pwm_enable,
 204         .disable = imx_pwm_disable,
 205         .config = imx_pwm_config,
 206         .owner = THIS_MODULE,
 207 };
 208
 209 struct imx_pwm_data {
 210         int (*config)(struct pwm_chip *chip,
 211                 struct pwm_device *pwm, int duty_ns, int period_ns);
 212         void (*set_enable)(struct pwm_chip *chip, bool enable);
 213 };
 214
 215 static struct imx_pwm_data imx_pwm_data_v1 = {
 216         .config = imx_pwm_config_v1,
 217         .set_enable = imx_pwm_set_enable_v1,
 218 };
 219
 220 static struct imx_pwm_data imx_pwm_data_v2 = {
 221         .config = imx_pwm_config_v2,
 222         .set_enable = imx_pwm_set_enable_v2,
 223 };
 224
 225 static const struct of_device_id imx_pwm_dt_ids[] = {
 226         { .compatible = "fsl,imx1-pwm", .data = &imx_pwm_data_v1, },
 227         { .compatible = "fsl,imx27-pwm", .data = &imx_pwm_data_v2, },
 228         { /* sentinel */ }
 229 };
 230 MODULE_DEVICE_TABLE(of, imx_pwm_dt_ids);
 231
 232 static int imx_pwm_probe(struct platform_device *pdev)
 233 {
 234         const struct of_device_id *of_id =
 235                         of_match_device(imx_pwm_dt_ids, &pdev->dev);
 236         const struct imx_pwm_data *data;
 237         struct imx_chip *imx;
 238         struct resource *r;
 239         int ret = 0;
 240
 241         if (!of_id)
 242                 return -ENODEV;
 243
 244         imx = devm_kzalloc(&pdev->dev, sizeof(*imx), GFP_KERNEL);
 245         if (imx == NULL) {
 246                 dev_err(&pdev->dev, "failed to allocate memory\n");
 247                 return -ENOMEM;
 248         }
 249
 250         imx->clk_per = devm_clk_get(&pdev->dev, "per");
 251         if (IS_ERR(imx->clk_per)) {
 252                 dev_err(&pdev->dev, "getting per clock failed with %ld\n",
 253                                 PTR_ERR(imx->clk_per));
 254                 return PTR_ERR(imx->clk_per);
 255         }
 256
 257         imx->clk_ipg = devm_clk_get(&pdev->dev, "ipg");
 258         if (IS_ERR(imx->clk_ipg)) {
 259                 dev_err(&pdev->dev, "getting ipg clock failed with %ld\n",
 260                                 PTR_ERR(imx->clk_ipg));
 261                 return PTR_ERR(imx->clk_ipg);
 262         }
 263
 264         imx->chip.ops = &imx_pwm_ops;
 265         imx->chip.dev = &pdev->dev;
 266         imx->chip.base = -1;
 267         imx->chip.npwm = 1;
 268
 269         r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 270         imx->mmio_base = devm_ioremap_resource(&pdev->dev, r);
 271         if (IS_ERR(imx->mmio_base))
 272                 return PTR_ERR(imx->mmio_base);
 273
 274         data = of_id->data;
 275         imx->config = data->config;
 276         imx->set_enable = data->set_enable;
 277
 278         ret = pwmchip_add(&imx->chip);
 279         if (ret < 0)
 280                 return ret;
 281
 282         platform_set_drvdata(pdev, imx);
 283         return 0;
 284 }
 285
 286 static int imx_pwm_remove(struct platform_device *pdev)
 287 {
 288         struct imx_chip *imx;
 289
 290         imx = platform_get_drvdata(pdev);
 291         if (imx == NULL)
 292                 return -ENODEV;
 293
 294         return pwmchip_remove(&imx->chip);
 295 }
 296
 297 static struct platform_driver imx_pwm_driver = {
 298         .driver         = {
 299                 .name   = "imx-pwm",
 300                 .owner = THIS_MODULE,
 301                 .of_match_table = imx_pwm_dt_ids,
 302         },
 303         .probe          = imx_pwm_probe,
 304         .remove         = imx_pwm_remove,
 305 };
 306
 307 module_platform_driver(imx_pwm_driver);
 308
 309 MODULE_LICENSE("GPL v2");
 310 MODULE_AUTHOR("Sascha Hauer <s.hauer@pengutronix.de>");