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_device.h>
  20 #include <mach/hardware.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_CLKSRC_IPG_HIGH (2 << 16)
  40 #define MX3_PWMCR_CLKSRC_IPG      (1 << 16)
  41 #define MX3_PWMCR_EN              (1 << 0)
  42
  43 struct imx_chip {
  44         struct clk      *clk;
  45
  46         int             enabled;
  47         void __iomem    *mmio_base;
  48
  49         struct pwm_chip chip;
  50
  51         int (*config)(struct pwm_chip *chip,
  52                 struct pwm_device *pwm, int duty_ns, int period_ns);
  53         void (*set_enable)(struct pwm_chip *chip, bool enable);
  54 };
  55
  56 #define to_imx_chip(chip)       container_of(chip, struct imx_chip, chip)
  57
  58 static int imx_pwm_config_v1(struct pwm_chip *chip,
  59                 struct pwm_device *pwm, int duty_ns, int period_ns)
  60 {
  61         struct imx_chip *imx = to_imx_chip(chip);
  62
  63         /*
  64          * The PWM subsystem allows for exact frequencies. However,
  65          * I cannot connect a scope on my device to the PWM line and
  66          * thus cannot provide the program the PWM controller
  67          * exactly. Instead, I'm relying on the fact that the
  68          * Bootloader (u-boot or WinCE+haret) has programmed the PWM
  69          * function group already. So I'll just modify the PWM sample
  70          * register to follow the ratio of duty_ns vs. period_ns
  71          * accordingly.
  72          *
  73          * This is good enough for programming the brightness of
  74          * the LCD backlight.
  75          *
  76          * The real implementation would divide PERCLK[0] first by
  77          * both the prescaler (/1 .. /128) and then by CLKSEL
  78          * (/2 .. /16).
  79          */
  80         u32 max = readl(imx->mmio_base + MX1_PWMP);
  81         u32 p = max * duty_ns / period_ns;
  82         writel(max - p, imx->mmio_base + MX1_PWMS);
  83
  84         return 0;
  85 }
  86
  87 static void imx_pwm_set_enable_v1(struct pwm_chip *chip, bool enable)
  88 {
  89         struct imx_chip *imx = to_imx_chip(chip);
  90         u32 val;
  91
  92         val = readl(imx->mmio_base + MX1_PWMC);
  93
  94         if (enable)
  95                 val |= MX1_PWMC_EN;
  96         else
  97                 val &= ~MX1_PWMC_EN;
  98
  99         writel(val, imx->mmio_base + MX1_PWMC);
 100 }
 101
 102 static int imx_pwm_config_v2(struct pwm_chip *chip,
 103                 struct pwm_device *pwm, int duty_ns, int period_ns)
 104 {
 105         struct imx_chip *imx = to_imx_chip(chip);
 106         unsigned long long c;
 107         unsigned long period_cycles, duty_cycles, prescale;
 108         u32 cr;
 109
 110         c = clk_get_rate(imx->clk);
 111         c = c * period_ns;
 112         do_div(c, 1000000000);
 113         period_cycles = c;
 114
 115         prescale = period_cycles / 0x10000 + 1;
 116
 117         period_cycles /= prescale;
 118         c = (unsigned long long)period_cycles * duty_ns;
 119         do_div(c, period_ns);
 120         duty_cycles = c;
 121
 122         /*
 123          * according to imx pwm RM, the real period value should be
 124          * PERIOD value in PWMPR plus 2.
 125          */
 126         if (period_cycles > 2)
 127                 period_cycles -= 2;
 128         else
 129                 period_cycles = 0;
 130
 131         writel(duty_cycles, imx->mmio_base + MX3_PWMSAR);
 132         writel(period_cycles, imx->mmio_base + MX3_PWMPR);
 133
 134         cr = MX3_PWMCR_PRESCALER(prescale) |
 135                 MX3_PWMCR_DOZEEN | MX3_PWMCR_WAITEN |
 136                 MX3_PWMCR_DBGEN;
 137
 138         if (imx->enabled)
 139                 cr |= MX3_PWMCR_EN;
 140
 141         if (cpu_is_mx25())
 142                 cr |= MX3_PWMCR_CLKSRC_IPG;
 143         else
 144                 cr |= MX3_PWMCR_CLKSRC_IPG_HIGH;
 145
 146         writel(cr, imx->mmio_base + MX3_PWMCR);
 147
 148         return 0;
 149 }
 150
 151 static void imx_pwm_set_enable_v2(struct pwm_chip *chip, bool enable)
 152 {
 153         struct imx_chip *imx = to_imx_chip(chip);
 154         u32 val;
 155
 156         val = readl(imx->mmio_base + MX3_PWMCR);
 157
 158         if (enable)
 159                 val |= MX3_PWMCR_EN;
 160         else
 161                 val &= ~MX3_PWMCR_EN;
 162
 163         writel(val, imx->mmio_base + MX3_PWMCR);
 164 }
 165
 166 static int imx_pwm_config(struct pwm_chip *chip,
 167                 struct pwm_device *pwm, int duty_ns, int period_ns)
 168 {
 169         struct imx_chip *imx = to_imx_chip(chip);
 170
 171         return imx->config(chip, pwm, duty_ns, period_ns);
 172 }
 173
 174 static int imx_pwm_enable(struct pwm_chip *chip, struct pwm_device *pwm)
 175 {
 176         struct imx_chip *imx = to_imx_chip(chip);
 177         int ret;
 178
 179         ret = clk_prepare_enable(imx->clk);
 180         if (ret)
 181                 return ret;
 182
 183         imx->set_enable(chip, true);
 184
 185         imx->enabled = 1;
 186
 187         return 0;
 188 }
 189
 190 static void imx_pwm_disable(struct pwm_chip *chip, struct pwm_device *pwm)
 191 {
 192         struct imx_chip *imx = to_imx_chip(chip);
 193
 194         imx->set_enable(chip, false);
 195
 196         clk_disable_unprepare(imx->clk);
 197         imx->enabled = 0;
 198 }
 199
 200 static struct pwm_ops imx_pwm_ops = {
 201         .enable = imx_pwm_enable,
 202         .disable = imx_pwm_disable,
 203         .config = imx_pwm_config,
 204         .owner = THIS_MODULE,
 205 };
 206
 207 struct imx_pwm_data {
 208         int (*config)(struct pwm_chip *chip,
 209                 struct pwm_device *pwm, int duty_ns, int period_ns);
 210         void (*set_enable)(struct pwm_chip *chip, bool enable);
 211 };
 212
 213 static struct imx_pwm_data imx_pwm_data_v1 = {
 214         .config = imx_pwm_config_v1,
 215         .set_enable = imx_pwm_set_enable_v1,
 216 };
 217
 218 static struct imx_pwm_data imx_pwm_data_v2 = {
 219         .config = imx_pwm_config_v2,
 220         .set_enable = imx_pwm_set_enable_v2,
 221 };
 222
 223 static const struct of_device_id imx_pwm_dt_ids[] = {
 224         { .compatible = "fsl,imx1-pwm", .data = &imx_pwm_data_v1, },
 225         { .compatible = "fsl,imx27-pwm", .data = &imx_pwm_data_v2, },
 226         { /* sentinel */ }
 227 };
 228 MODULE_DEVICE_TABLE(of, imx_pwm_dt_ids);
 229
 230 static int __devinit imx_pwm_probe(struct platform_device *pdev)
 231 {
 232         const struct of_device_id *of_id =
 233                         of_match_device(imx_pwm_dt_ids, &pdev->dev);
 234         struct imx_pwm_data *data;
 235         struct imx_chip *imx;
 236         struct resource *r;
 237         int ret = 0;
 238
 239         if (!of_id)
 240                 return -ENODEV;
 241
 242         imx = devm_kzalloc(&pdev->dev, sizeof(*imx), GFP_KERNEL);
 243         if (imx == NULL) {
 244                 dev_err(&pdev->dev, "failed to allocate memory\n");
 245                 return -ENOMEM;
 246         }
 247
 248         imx->clk = devm_clk_get(&pdev->dev, "pwm");
 249
 250         if (IS_ERR(imx->clk))
 251                 return PTR_ERR(imx->clk);
 252
 253         imx->chip.ops = &imx_pwm_ops;
 254         imx->chip.dev = &pdev->dev;
 255         imx->chip.base = -1;
 256         imx->chip.npwm = 1;
 257
 258         r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 259         if (r == NULL) {
 260                 dev_err(&pdev->dev, "no memory resource defined\n");
 261                 return -ENODEV;
 262         }
 263
 264         imx->mmio_base = devm_request_and_ioremap(&pdev->dev, r);
 265         if (imx->mmio_base == NULL)
 266                 return -EADDRNOTAVAIL;
 267
 268         data = of_id->data;
 269         imx->config = data->config;
 270         imx->set_enable = data->set_enable;
 271
 272         ret = pwmchip_add(&imx->chip);
 273         if (ret < 0)
 274                 return ret;
 275
 276         platform_set_drvdata(pdev, imx);
 277         return 0;
 278 }
 279
 280 static int __devexit imx_pwm_remove(struct platform_device *pdev)
 281 {
 282         struct imx_chip *imx;
 283
 284         imx = platform_get_drvdata(pdev);
 285         if (imx == NULL)
 286                 return -ENODEV;
 287
 288         return pwmchip_remove(&imx->chip);
 289 }
 290
 291 static struct platform_driver imx_pwm_driver = {
 292         .driver         = {
 293                 .name   = "imx-pwm",
 294                 .of_match_table = of_match_ptr(imx_pwm_dt_ids),
 295         },
 296         .probe          = imx_pwm_probe,
 297         .remove         = __devexit_p(imx_pwm_remove),
 298 };
 299
 300 module_platform_driver(imx_pwm_driver);
 301
 302 MODULE_LICENSE("GPL v2");
 303 MODULE_AUTHOR("Sascha Hauer <s.hauer@pengutronix.de>");