drivers/pwm/pwm-samsung.c

   1 /*
   2  * Copyright (c) 2007 Ben Dooks
   3  * Copyright (c) 2008 Simtec Electronics
   4  *     Ben Dooks <ben@simtec.co.uk>, <ben-linux@fluff.org>
   5  * Copyright (c) 2013 Tomasz Figa <tomasz.figa@gmail.com>
   6  *
   7  * PWM driver for Samsung SoCs
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License.
  12  */
  13
  14 #include <linux/bitops.h>
  15 #include <linux/clk.h>
  16 #include <linux/export.h>
  17 #include <linux/err.h>
  18 #include <linux/io.h>
  19 #include <linux/kernel.h>
  20 #include <linux/module.h>
  21 #include <linux/of.h>
  22 #include <linux/platform_device.h>
  23 #include <linux/pwm.h>
  24 #include <linux/slab.h>
  25 #include <linux/spinlock.h>
  26 #include <linux/time.h>
  27
  28 /* For struct samsung_timer_variant and samsung_pwm_lock. */
  29 #include <clocksource/samsung_pwm.h>
  30
  31 #define REG_TCFG0                       0x00
  32 #define REG_TCFG1                       0x04
  33 #define REG_TCON                        0x08
  34
  35 #define REG_TCNTB(chan)                 (0x0c + ((chan) * 0xc))
  36 #define REG_TCMPB(chan)                 (0x10 + ((chan) * 0xc))
  37
  38 #define TCFG0_PRESCALER_MASK            0xff
  39 #define TCFG0_PRESCALER1_SHIFT          8
  40
  41 #define TCFG1_MUX_MASK                  0xf
  42 #define TCFG1_SHIFT(chan)               (4 * (chan))
  43
  44 /*
  45  * Each channel occupies 4 bits in TCON register, but there is a gap of 4
  46  * bits (one channel) after channel 0, so channels have different numbering
  47  * when accessing TCON register. See to_tcon_channel() function.
  48  *
  49  * In addition, the location of autoreload bit for channel 4 (TCON channel 5)
  50  * in its set of bits is 2 as opposed to 3 for other channels.
  51  */
  52 #define TCON_START(chan)                BIT(4 * (chan) + 0)
  53 #define TCON_MANUALUPDATE(chan)         BIT(4 * (chan) + 1)
  54 #define TCON_INVERT(chan)               BIT(4 * (chan) + 2)
  55 #define _TCON_AUTORELOAD(chan)          BIT(4 * (chan) + 3)
  56 #define _TCON_AUTORELOAD4(chan)         BIT(4 * (chan) + 2)
  57 #define TCON_AUTORELOAD(chan)           \
  58         ((chan < 5) ? _TCON_AUTORELOAD(chan) : _TCON_AUTORELOAD4(chan))
  59
  60 /**
  61  * struct samsung_pwm_channel - private data of PWM channel
  62  * @period_ns:  current period in nanoseconds programmed to the hardware
  63  * @duty_ns:    current duty time in nanoseconds programmed to the hardware
  64  * @tin_ns:     time of one timer tick in nanoseconds with current timer rate
  65  */
  66 struct samsung_pwm_channel {
  67         u32 period_ns;
  68         u32 duty_ns;
  69         u32 tin_ns;
  70 };
  71
  72 /**
  73  * struct samsung_pwm_chip - private data of PWM chip
  74  * @chip:               generic PWM chip
  75  * @variant:            local copy of hardware variant data
  76  * @inverter_mask:      inverter status for all channels - one bit per channel
  77  * @base:               base address of mapped PWM registers
  78  * @base_clk:           base clock used to drive the timers
  79  * @tclk0:              external clock 0 (can be ERR_PTR if not present)
  80  * @tclk1:              external clock 1 (can be ERR_PTR if not present)
  81  */
  82 struct samsung_pwm_chip {
  83         struct pwm_chip chip;
  84         struct samsung_pwm_variant variant;
  85         u8 inverter_mask;
  86
  87         void __iomem *base;
  88         struct clk *base_clk;
  89         struct clk *tclk0;
  90         struct clk *tclk1;
  91 };
  92
  93 #ifndef CONFIG_CLKSRC_SAMSUNG_PWM
  94 /*
  95  * PWM block is shared between pwm-samsung and samsung_pwm_timer drivers
  96  * and some registers need access synchronization. If both drivers are
  97  * compiled in, the spinlock is defined in the clocksource driver,
  98  * otherwise following definition is used.
  99  *
 100  * Currently we do not need any more complex synchronization method
 101  * because all the supported SoCs contain only one instance of the PWM
 102  * IP. Should this change, both drivers will need to be modified to
 103  * properly synchronize accesses to particular instances.
 104  */
 105 static DEFINE_SPINLOCK(samsung_pwm_lock);
 106 #endif
 107
 108 static inline
 109 struct samsung_pwm_chip *to_samsung_pwm_chip(struct pwm_chip *chip)
 110 {
 111         return container_of(chip, struct samsung_pwm_chip, chip);
 112 }
 113
 114 static inline unsigned int to_tcon_channel(unsigned int channel)
 115 {
 116         /* TCON register has a gap of 4 bits (1 channel) after channel 0 */
 117         return (channel == 0) ? 0 : (channel + 1);
 118 }
 119
 120 static void pwm_samsung_set_divisor(struct samsung_pwm_chip *pwm,
 121                                     unsigned int channel, u8 divisor)
 122 {
 123         u8 shift = TCFG1_SHIFT(channel);
 124         unsigned long flags;
 125         u32 reg;
 126         u8 bits;
 127
 128         bits = (fls(divisor) - 1) - pwm->variant.div_base;
 129
 130         spin_lock_irqsave(&samsung_pwm_lock, flags);
 131
 132         reg = readl(pwm->base + REG_TCFG1);
 133         reg &= ~(TCFG1_MUX_MASK << shift);
 134         reg |= bits << shift;
 135         writel(reg, pwm->base + REG_TCFG1);
 136
 137         spin_unlock_irqrestore(&samsung_pwm_lock, flags);
 138 }
 139
 140 static int pwm_samsung_is_tdiv(struct samsung_pwm_chip *chip, unsigned int chan)
 141 {
 142         struct samsung_pwm_variant *variant = &chip->variant;
 143         u32 reg;
 144
 145         reg = readl(chip->base + REG_TCFG1);
 146         reg >>= TCFG1_SHIFT(chan);
 147         reg &= TCFG1_MUX_MASK;
 148
 149         return (BIT(reg) & variant->tclk_mask) == 0;
 150 }
 151
 152 static unsigned long pwm_samsung_get_tin_rate(struct samsung_pwm_chip *chip,
 153                                               unsigned int chan)
 154 {
 155         unsigned long rate;
 156         u32 reg;
 157
 158         rate = clk_get_rate(chip->base_clk);
 159
 160         reg = readl(chip->base + REG_TCFG0);
 161         if (chan >= 2)
 162                 reg >>= TCFG0_PRESCALER1_SHIFT;
 163         reg &= TCFG0_PRESCALER_MASK;
 164
 165         return rate / (reg + 1);
 166 }
 167
 168 static unsigned long pwm_samsung_calc_tin(struct samsung_pwm_chip *chip,
 169                                           unsigned int chan, unsigned long freq)
 170 {
 171         struct samsung_pwm_variant *variant = &chip->variant;
 172         unsigned long rate;
 173         struct clk *clk;
 174         u8 div;
 175
 176         if (!pwm_samsung_is_tdiv(chip, chan)) {
 177                 clk = (chan < 2) ? chip->tclk0 : chip->tclk1;
 178                 if (!IS_ERR(clk)) {
 179                         rate = clk_get_rate(clk);
 180                         if (rate)
 181                                 return rate;
 182                 }
 183
 184                 dev_warn(chip->chip.dev,
 185                         "tclk of PWM %d is inoperational, using tdiv\n", chan);
 186         }
 187
 188         rate = pwm_samsung_get_tin_rate(chip, chan);
 189         dev_dbg(chip->chip.dev, "tin parent at %lu\n", rate);
 190
 191         /*
 192          * Compare minimum PWM frequency that can be achieved with possible
 193          * divider settings and choose the lowest divisor that can generate
 194          * frequencies lower than requested.
 195          */
 196         for (div = variant->div_base; div < 4; ++div)
 197                 if ((rate >> (variant->bits + div)) < freq)
 198                         break;
 199
 200         pwm_samsung_set_divisor(chip, chan, BIT(div));
 201
 202         return rate >> div;
 203 }
 204
 205 static int pwm_samsung_request(struct pwm_chip *chip, struct pwm_device *pwm)
 206 {
 207         struct samsung_pwm_chip *our_chip = to_samsung_pwm_chip(chip);
 208         struct samsung_pwm_channel *our_chan;
 209
 210         if (!(our_chip->variant.output_mask & BIT(pwm->hwpwm))) {
 211                 dev_warn(chip->dev,
 212                         "tried to request PWM channel %d without output\n",
 213                         pwm->hwpwm);
 214                 return -EINVAL;
 215         }
 216
 217         our_chan = devm_kzalloc(chip->dev, sizeof(*our_chan), GFP_KERNEL);
 218         if (!our_chan)
 219                 return -ENOMEM;
 220
 221         pwm_set_chip_data(pwm, our_chan);
 222
 223         return 0;
 224 }
 225
 226 static void pwm_samsung_free(struct pwm_chip *chip, struct pwm_device *pwm)
 227 {
 228         devm_kfree(chip->dev, pwm_get_chip_data(pwm));
 229         pwm_set_chip_data(pwm, NULL);
 230 }
 231
 232 static int pwm_samsung_enable(struct pwm_chip *chip, struct pwm_device *pwm)
 233 {
 234         struct samsung_pwm_chip *our_chip = to_samsung_pwm_chip(chip);
 235         unsigned int tcon_chan = to_tcon_channel(pwm->hwpwm);
 236         unsigned long flags;
 237         u32 tcon;
 238
 239         spin_lock_irqsave(&samsung_pwm_lock, flags);
 240
 241         tcon = readl(our_chip->base + REG_TCON);
 242
 243         tcon &= ~TCON_START(tcon_chan);
 244         tcon |= TCON_MANUALUPDATE(tcon_chan);
 245         writel(tcon, our_chip->base + REG_TCON);
 246
 247         tcon &= ~TCON_MANUALUPDATE(tcon_chan);
 248         tcon |= TCON_START(tcon_chan) | TCON_AUTORELOAD(tcon_chan);
 249         writel(tcon, our_chip->base + REG_TCON);
 250
 251         spin_unlock_irqrestore(&samsung_pwm_lock, flags);
 252
 253         return 0;
 254 }
 255
 256 static void pwm_samsung_disable(struct pwm_chip *chip, struct pwm_device *pwm)
 257 {
 258         struct samsung_pwm_chip *our_chip = to_samsung_pwm_chip(chip);
 259         unsigned int tcon_chan = to_tcon_channel(pwm->hwpwm);
 260         unsigned long flags;
 261         u32 tcon;
 262
 263         spin_lock_irqsave(&samsung_pwm_lock, flags);
 264
 265         tcon = readl(our_chip->base + REG_TCON);
 266         tcon &= ~TCON_AUTORELOAD(tcon_chan);
 267         writel(tcon, our_chip->base + REG_TCON);
 268
 269         spin_unlock_irqrestore(&samsung_pwm_lock, flags);
 270 }
 271
 272 static int pwm_samsung_config(struct pwm_chip *chip, struct pwm_device *pwm,
 273                               int duty_ns, int period_ns)
 274 {
 275         struct samsung_pwm_chip *our_chip = to_samsung_pwm_chip(chip);
 276         struct samsung_pwm_channel *chan = pwm_get_chip_data(pwm);
 277         u32 tin_ns = chan->tin_ns, tcnt, tcmp;
 278
 279         /*
 280          * We currently avoid using 64bit arithmetic by using the
 281          * fact that anything faster than 1Hz is easily representable
 282          * by 32bits.
 283          */
 284         if (period_ns > NSEC_PER_SEC)
 285                 return -ERANGE;
 286
 287         if (period_ns == chan->period_ns && duty_ns == chan->duty_ns)
 288                 return 0;
 289
 290         tcnt = readl(our_chip->base + REG_TCNTB(pwm->hwpwm));
 291
 292         /* We need tick count for calculation, not last tick. */
 293         ++tcnt;
 294
 295         /* Check to see if we are changing the clock rate of the PWM. */
 296         if (chan->period_ns != period_ns) {
 297                 unsigned long tin_rate;
 298                 u32 period;
 299
 300                 period = NSEC_PER_SEC / period_ns;
 301
 302                 dev_dbg(our_chip->chip.dev, "duty_ns=%d, period_ns=%d (%u)\n",
 303                                                 duty_ns, period_ns, period);
 304
 305                 tin_rate = pwm_samsung_calc_tin(our_chip, pwm->hwpwm, period);
 306
 307                 dev_dbg(our_chip->chip.dev, "tin_rate=%lu\n", tin_rate);
 308
 309                 tin_ns = NSEC_PER_SEC / tin_rate;
 310                 tcnt = period_ns / tin_ns;
 311         }
 312
 313         /* Period is too short. */
 314         if (tcnt <= 1)
 315                 return -ERANGE;
 316
 317         /* Note that counters count down. */
 318         tcmp = duty_ns / tin_ns;
 319
 320         /* 0% duty is not available */
 321         if (!tcmp)
 322                 ++tcmp;
 323
 324         tcmp = tcnt - tcmp;
 325
 326         /* Decrement to get tick numbers, instead of tick counts. */
 327         --tcnt;
 328         /* -1UL will give 100% duty. */
 329         --tcmp;
 330
 331         dev_dbg(our_chip->chip.dev,
 332                                 "tin_ns=%u, tcmp=%u/%u\n", tin_ns, tcmp, tcnt);
 333
 334         /* Update PWM registers. */
 335         writel(tcnt, our_chip->base + REG_TCNTB(pwm->hwpwm));
 336         writel(tcmp, our_chip->base + REG_TCMPB(pwm->hwpwm));
 337
 338         chan->period_ns = period_ns;
 339         chan->tin_ns = tin_ns;
 340         chan->duty_ns = duty_ns;
 341
 342         return 0;
 343 }
 344
 345 static void pwm_samsung_set_invert(struct samsung_pwm_chip *chip,
 346                                    unsigned int channel, bool invert)
 347 {
 348         unsigned int tcon_chan = to_tcon_channel(channel);
 349         unsigned long flags;
 350         u32 tcon;
 351
 352         spin_lock_irqsave(&samsung_pwm_lock, flags);
 353
 354         tcon = readl(chip->base + REG_TCON);
 355
 356         if (invert) {
 357                 chip->inverter_mask |= BIT(channel);
 358                 tcon |= TCON_INVERT(tcon_chan);
 359         } else {
 360                 chip->inverter_mask &= ~BIT(channel);
 361                 tcon &= ~TCON_INVERT(tcon_chan);
 362         }
 363
 364         writel(tcon, chip->base + REG_TCON);
 365
 366         spin_unlock_irqrestore(&samsung_pwm_lock, flags);
 367 }
 368
 369 static int pwm_samsung_set_polarity(struct pwm_chip *chip,
 370                                     struct pwm_device *pwm,
 371                                     enum pwm_polarity polarity)
 372 {
 373         struct samsung_pwm_chip *our_chip = to_samsung_pwm_chip(chip);
 374         bool invert = (polarity == PWM_POLARITY_NORMAL);
 375
 376         /* Inverted means normal in the hardware. */
 377         pwm_samsung_set_invert(our_chip, pwm->hwpwm, invert);
 378
 379         return 0;
 380 }
 381
 382 static const struct pwm_ops pwm_samsung_ops = {
 383         .request        = pwm_samsung_request,
 384         .free           = pwm_samsung_free,
 385         .enable         = pwm_samsung_enable,
 386         .disable        = pwm_samsung_disable,
 387         .config         = pwm_samsung_config,
 388         .set_polarity   = pwm_samsung_set_polarity,
 389         .owner          = THIS_MODULE,
 390 };
 391
 392 #ifdef CONFIG_OF
 393 static const struct samsung_pwm_variant s3c24xx_variant = {
 394         .bits           = 16,
 395         .div_base       = 1,
 396         .has_tint_cstat = false,
 397         .tclk_mask      = BIT(4),
 398 };
 399
 400 static const struct samsung_pwm_variant s3c64xx_variant = {
 401         .bits           = 32,
 402         .div_base       = 0,
 403         .has_tint_cstat = true,
 404         .tclk_mask      = BIT(7) | BIT(6) | BIT(5),
 405 };
 406
 407 static const struct samsung_pwm_variant s5p64x0_variant = {
 408         .bits           = 32,
 409         .div_base       = 0,
 410         .has_tint_cstat = true,
 411         .tclk_mask      = 0,
 412 };
 413
 414 static const struct samsung_pwm_variant s5pc100_variant = {
 415         .bits           = 32,
 416         .div_base       = 0,
 417         .has_tint_cstat = true,
 418         .tclk_mask      = BIT(5),
 419 };
 420
 421 static const struct of_device_id samsung_pwm_matches[] = {
 422         { .compatible = "samsung,s3c2410-pwm", .data = &s3c24xx_variant },
 423         { .compatible = "samsung,s3c6400-pwm", .data = &s3c64xx_variant },
 424         { .compatible = "samsung,s5p6440-pwm", .data = &s5p64x0_variant },
 425         { .compatible = "samsung,s5pc100-pwm", .data = &s5pc100_variant },
 426         { .compatible = "samsung,exynos4210-pwm", .data = &s5p64x0_variant },
 427         {},
 428 };
 429
 430 static int pwm_samsung_parse_dt(struct samsung_pwm_chip *chip)
 431 {
 432         struct device_node *np = chip->chip.dev->of_node;
 433         const struct of_device_id *match;
 434         struct property *prop;
 435         const __be32 *cur;
 436         u32 val;
 437
 438         match = of_match_node(samsung_pwm_matches, np);
 439         if (!match)
 440                 return -ENODEV;
 441
 442         memcpy(&chip->variant, match->data, sizeof(chip->variant));
 443
 444         of_property_for_each_u32(np, "samsung,pwm-outputs", prop, cur, val) {
 445                 if (val >= SAMSUNG_PWM_NUM) {
 446                         dev_err(chip->chip.dev,
 447                                 "%s: invalid channel index in samsung,pwm-outputs property\n",
 448                                                                 __func__);
 449                         continue;
 450                 }
 451                 chip->variant.output_mask |= BIT(val);
 452         }
 453
 454         return 0;
 455 }
 456 #else
 457 static int pwm_samsung_parse_dt(struct samsung_pwm_chip *chip)
 458 {
 459         return -ENODEV;
 460 }
 461 #endif
 462
 463 static int pwm_samsung_probe(struct platform_device *pdev)
 464 {
 465         struct device *dev = &pdev->dev;
 466         struct samsung_pwm_chip *chip;
 467         struct resource *res;
 468         unsigned int chan;
 469         int ret;
 470
 471         chip = devm_kzalloc(&pdev->dev, sizeof(*chip), GFP_KERNEL);
 472         if (chip == NULL)
 473                 return -ENOMEM;
 474
 475         chip->chip.dev = &pdev->dev;
 476         chip->chip.ops = &pwm_samsung_ops;
 477         chip->chip.base = -1;
 478         chip->chip.npwm = SAMSUNG_PWM_NUM;
 479         chip->inverter_mask = BIT(SAMSUNG_PWM_NUM) - 1;
 480
 481         if (IS_ENABLED(CONFIG_OF) && pdev->dev.of_node) {
 482                 ret = pwm_samsung_parse_dt(chip);
 483                 if (ret)
 484                         return ret;
 485
 486                 chip->chip.of_xlate = of_pwm_xlate_with_flags;
 487                 chip->chip.of_pwm_n_cells = 3;
 488         } else {
 489                 if (!pdev->dev.platform_data) {
 490                         dev_err(&pdev->dev, "no platform data specified\n");
 491                         return -EINVAL;
 492                 }
 493
 494                 memcpy(&chip->variant, pdev->dev.platform_data,
 495                                                         sizeof(chip->variant));
 496         }
 497
 498         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 499         chip->base = devm_ioremap_resource(&pdev->dev, res);
 500         if (IS_ERR(chip->base))
 501                 return PTR_ERR(chip->base);
 502
 503         chip->base_clk = devm_clk_get(&pdev->dev, "timers");
 504         if (IS_ERR(chip->base_clk)) {
 505                 dev_err(dev, "failed to get timer base clk\n");
 506                 return PTR_ERR(chip->base_clk);
 507         }
 508
 509         ret = clk_prepare_enable(chip->base_clk);
 510         if (ret < 0) {
 511                 dev_err(dev, "failed to enable base clock\n");
 512                 return ret;
 513         }
 514
 515         for (chan = 0; chan < SAMSUNG_PWM_NUM; ++chan)
 516                 if (chip->variant.output_mask & BIT(chan))
 517                         pwm_samsung_set_invert(chip, chan, true);
 518
 519         /* Following clocks are optional. */
 520         chip->tclk0 = devm_clk_get(&pdev->dev, "pwm-tclk0");
 521         chip->tclk1 = devm_clk_get(&pdev->dev, "pwm-tclk1");
 522
 523         platform_set_drvdata(pdev, chip);
 524
 525         ret = pwmchip_add(&chip->chip);
 526         if (ret < 0) {
 527                 dev_err(dev, "failed to register PWM chip\n");
 528                 clk_disable_unprepare(chip->base_clk);
 529                 return ret;
 530         }
 531
 532         dev_dbg(dev, "base_clk at %lu, tclk0 at %lu, tclk1 at %lu\n",
 533                 clk_get_rate(chip->base_clk),
 534                 !IS_ERR(chip->tclk0) ? clk_get_rate(chip->tclk0) : 0,
 535                 !IS_ERR(chip->tclk1) ? clk_get_rate(chip->tclk1) : 0);
 536
 537         return 0;
 538 }
 539
 540 static int pwm_samsung_remove(struct platform_device *pdev)
 541 {
 542         struct samsung_pwm_chip *chip = platform_get_drvdata(pdev);
 543         int ret;
 544
 545         ret = pwmchip_remove(&chip->chip);
 546         if (ret < 0)
 547                 return ret;
 548
 549         clk_disable_unprepare(chip->base_clk);
 550
 551         return 0;
 552 }
 553
 554 #ifdef CONFIG_PM_SLEEP
 555 static int pwm_samsung_suspend(struct device *dev)
 556 {
 557         struct samsung_pwm_chip *chip = dev_get_drvdata(dev);
 558         unsigned int i;
 559
 560         /*
 561          * No one preserves these values during suspend so reset them.
 562          * Otherwise driver leaves PWM unconfigured if same values are
 563          * passed to pwm_config() next time.
 564          */
 565         for (i = 0; i < SAMSUNG_PWM_NUM; ++i) {
 566                 struct pwm_device *pwm = &chip->chip.pwms[i];
 567                 struct samsung_pwm_channel *chan = pwm_get_chip_data(pwm);
 568
 569                 if (!chan)
 570                         continue;
 571
 572                 chan->period_ns = 0;
 573                 chan->duty_ns = 0;
 574         }
 575
 576         return 0;
 577 }
 578
 579 static int pwm_samsung_resume(struct device *dev)
 580 {
 581         struct samsung_pwm_chip *chip = dev_get_drvdata(dev);
 582         unsigned int chan;
 583
 584         /*
 585          * Inverter setting must be preserved across suspend/resume
 586          * as nobody really seems to configure it more than once.
 587          */
 588         for (chan = 0; chan < SAMSUNG_PWM_NUM; ++chan) {
 589                 if (chip->variant.output_mask & BIT(chan))
 590                         pwm_samsung_set_invert(chip, chan,
 591                                         chip->inverter_mask & BIT(chan));
 592         }
 593
 594         return 0;
 595 }
 596 #endif
 597
 598 static SIMPLE_DEV_PM_OPS(pwm_samsung_pm_ops, pwm_samsung_suspend,
 599                          pwm_samsung_resume);
 600
 601 static struct platform_driver pwm_samsung_driver = {
 602         .driver         = {
 603                 .name   = "samsung-pwm",
 604                 .pm     = &pwm_samsung_pm_ops,
 605                 .of_match_table = of_match_ptr(samsung_pwm_matches),
 606         },
 607         .probe          = pwm_samsung_probe,
 608         .remove         = pwm_samsung_remove,
 609 };
 610 module_platform_driver(pwm_samsung_driver);
 611
 612 MODULE_LICENSE("GPL");
 613 MODULE_AUTHOR("Tomasz Figa <tomasz.figa@gmail.com>");
 614 MODULE_ALIAS("platform:samsung-pwm");