4 * Copyright (C) 2012 Texas Instruments, Inc. - http://www.ti.com/
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include <linux/module.h>
22 #include <linux/platform_device.h>
23 #include <linux/pwm.h>
25 #include <linux/err.h>
26 #include <linux/clk.h>
27 #include <linux/pm_runtime.h>
28 #include <linux/of_device.h>
30 #include "pwm-tipwmss.h"
32 /* EHRPWM registers and bits definitions */
34 /* Time base module registers */
38 #define TBCTL_RUN_MASK (BIT(15) | BIT(14))
39 #define TBCTL_STOP_NEXT 0
40 #define TBCTL_STOP_ON_CYCLE BIT(14)
41 #define TBCTL_FREE_RUN (BIT(15) | BIT(14))
42 #define TBCTL_PRDLD_MASK BIT(3)
43 #define TBCTL_PRDLD_SHDW 0
44 #define TBCTL_PRDLD_IMDT BIT(3)
45 #define TBCTL_CLKDIV_MASK (BIT(12) | BIT(11) | BIT(10) | BIT(9) | \
47 #define TBCTL_CTRMODE_MASK (BIT(1) | BIT(0))
48 #define TBCTL_CTRMODE_UP 0
49 #define TBCTL_CTRMODE_DOWN BIT(0)
50 #define TBCTL_CTRMODE_UPDOWN BIT(1)
51 #define TBCTL_CTRMODE_FREEZE (BIT(1) | BIT(0))
53 #define TBCTL_HSPCLKDIV_SHIFT 7
54 #define TBCTL_CLKDIV_SHIFT 10
57 #define HSPCLKDIV_MAX 7
58 #define PERIOD_MAX 0xFFFF
60 /* compare module registers */
64 /* Action qualifier module registers */
70 #define AQCTL_CBU_MASK (BIT(9) | BIT(8))
71 #define AQCTL_CBU_FRCLOW BIT(8)
72 #define AQCTL_CBU_FRCHIGH BIT(9)
73 #define AQCTL_CBU_FRCTOGGLE (BIT(9) | BIT(8))
74 #define AQCTL_CAU_MASK (BIT(5) | BIT(4))
75 #define AQCTL_CAU_FRCLOW BIT(4)
76 #define AQCTL_CAU_FRCHIGH BIT(5)
77 #define AQCTL_CAU_FRCTOGGLE (BIT(5) | BIT(4))
78 #define AQCTL_PRD_MASK (BIT(3) | BIT(2))
79 #define AQCTL_PRD_FRCLOW BIT(2)
80 #define AQCTL_PRD_FRCHIGH BIT(3)
81 #define AQCTL_PRD_FRCTOGGLE (BIT(3) | BIT(2))
82 #define AQCTL_ZRO_MASK (BIT(1) | BIT(0))
83 #define AQCTL_ZRO_FRCLOW BIT(0)
84 #define AQCTL_ZRO_FRCHIGH BIT(1)
85 #define AQCTL_ZRO_FRCTOGGLE (BIT(1) | BIT(0))
87 #define AQCTL_CHANA_POLNORMAL (AQCTL_CAU_FRCLOW | AQCTL_PRD_FRCHIGH | \
89 #define AQCTL_CHANA_POLINVERSED (AQCTL_CAU_FRCHIGH | AQCTL_PRD_FRCLOW | \
91 #define AQCTL_CHANB_POLNORMAL (AQCTL_CBU_FRCLOW | AQCTL_PRD_FRCHIGH | \
93 #define AQCTL_CHANB_POLINVERSED (AQCTL_CBU_FRCHIGH | AQCTL_PRD_FRCLOW | \
96 #define AQSFRC_RLDCSF_MASK (BIT(7) | BIT(6))
97 #define AQSFRC_RLDCSF_ZRO 0
98 #define AQSFRC_RLDCSF_PRD BIT(6)
99 #define AQSFRC_RLDCSF_ZROPRD BIT(7)
100 #define AQSFRC_RLDCSF_IMDT (BIT(7) | BIT(6))
102 #define AQCSFRC_CSFB_MASK (BIT(3) | BIT(2))
103 #define AQCSFRC_CSFB_FRCDIS 0
104 #define AQCSFRC_CSFB_FRCLOW BIT(2)
105 #define AQCSFRC_CSFB_FRCHIGH BIT(3)
106 #define AQCSFRC_CSFB_DISSWFRC (BIT(3) | BIT(2))
107 #define AQCSFRC_CSFA_MASK (BIT(1) | BIT(0))
108 #define AQCSFRC_CSFA_FRCDIS 0
109 #define AQCSFRC_CSFA_FRCLOW BIT(0)
110 #define AQCSFRC_CSFA_FRCHIGH BIT(1)
111 #define AQCSFRC_CSFA_DISSWFRC (BIT(1) | BIT(0))
113 #define NUM_PWM_CHANNEL 2 /* EHRPWM channels */
115 struct ehrpwm_context {
126 struct ehrpwm_pwm_chip {
127 struct pwm_chip chip;
128 unsigned int clk_rate;
129 void __iomem *mmio_base;
130 unsigned long period_cycles[NUM_PWM_CHANNEL];
131 enum pwm_polarity polarity[NUM_PWM_CHANNEL];
133 struct ehrpwm_context ctx;
136 static inline struct ehrpwm_pwm_chip *to_ehrpwm_pwm_chip(struct pwm_chip *chip)
138 return container_of(chip, struct ehrpwm_pwm_chip, chip);
141 static u16 ehrpwm_read(void __iomem *base, int offset)
143 return readw(base + offset);
146 static void ehrpwm_write(void __iomem *base, int offset, unsigned int val)
148 writew(val & 0xFFFF, base + offset);
151 static void ehrpwm_modify(void __iomem *base, int offset,
152 unsigned short mask, unsigned short val)
154 unsigned short regval;
156 regval = readw(base + offset);
158 regval |= val & mask;
159 writew(regval, base + offset);
163 * set_prescale_div - Set up the prescaler divider function
164 * @rqst_prescaler: prescaler value min
165 * @prescale_div: prescaler value set
166 * @tb_clk_div: Time Base Control prescaler bits
168 static int set_prescale_div(unsigned long rqst_prescaler,
169 unsigned short *prescale_div, unsigned short *tb_clk_div)
171 unsigned int clkdiv, hspclkdiv;
173 for (clkdiv = 0; clkdiv <= CLKDIV_MAX; clkdiv++) {
174 for (hspclkdiv = 0; hspclkdiv <= HSPCLKDIV_MAX; hspclkdiv++) {
177 * calculations for prescaler value :
178 * prescale_div = HSPCLKDIVIDER * CLKDIVIDER.
179 * HSPCLKDIVIDER = 2 ** hspclkdiv
180 * CLKDIVIDER = (1), if clkdiv == 0 *OR*
181 * (2 * clkdiv), if clkdiv != 0
183 * Configure prescale_div value such that period
184 * register value is less than 65535.
187 *prescale_div = (1 << clkdiv) *
188 (hspclkdiv ? (hspclkdiv * 2) : 1);
189 if (*prescale_div > rqst_prescaler) {
190 *tb_clk_div = (clkdiv << TBCTL_CLKDIV_SHIFT) |
191 (hspclkdiv << TBCTL_HSPCLKDIV_SHIFT);
199 static void configure_polarity(struct ehrpwm_pwm_chip *pc, int chan)
202 unsigned short aqctl_val, aqctl_mask;
205 * Configure PWM output to HIGH/LOW level on counter
206 * reaches compare register value and LOW/HIGH level
207 * on counter value reaches period register value and
208 * zero value on counter
212 aqctl_mask = AQCTL_CBU_MASK;
214 if (pc->polarity[chan] == PWM_POLARITY_INVERSED)
215 aqctl_val = AQCTL_CHANB_POLINVERSED;
217 aqctl_val = AQCTL_CHANB_POLNORMAL;
220 aqctl_mask = AQCTL_CAU_MASK;
222 if (pc->polarity[chan] == PWM_POLARITY_INVERSED)
223 aqctl_val = AQCTL_CHANA_POLINVERSED;
225 aqctl_val = AQCTL_CHANA_POLNORMAL;
228 aqctl_mask |= AQCTL_PRD_MASK | AQCTL_ZRO_MASK;
229 ehrpwm_modify(pc->mmio_base, aqctl_reg, aqctl_mask, aqctl_val);
233 * period_ns = 10^9 * (ps_divval * period_cycles) / PWM_CLK_RATE
234 * duty_ns = 10^9 * (ps_divval * duty_cycles) / PWM_CLK_RATE
236 static int ehrpwm_pwm_config(struct pwm_chip *chip, struct pwm_device *pwm,
237 int duty_ns, int period_ns)
239 struct ehrpwm_pwm_chip *pc = to_ehrpwm_pwm_chip(chip);
240 unsigned long long c;
241 unsigned long period_cycles, duty_cycles;
242 unsigned short ps_divval, tb_divval;
245 if (period_ns > NSEC_PER_SEC)
250 do_div(c, NSEC_PER_SEC);
251 period_cycles = (unsigned long)c;
253 if (period_cycles < 1) {
259 do_div(c, NSEC_PER_SEC);
260 duty_cycles = (unsigned long)c;
264 * Period values should be same for multiple PWM channels as IP uses
265 * same period register for multiple channels.
267 for (i = 0; i < NUM_PWM_CHANNEL; i++) {
268 if (pc->period_cycles[i] &&
269 (pc->period_cycles[i] != period_cycles)) {
271 * Allow channel to reconfigure period if no other
272 * channels being configured.
277 dev_err(chip->dev, "Period value conflicts with channel %d\n",
283 pc->period_cycles[pwm->hwpwm] = period_cycles;
285 /* Configure clock prescaler to support Low frequency PWM wave */
286 if (set_prescale_div(period_cycles/PERIOD_MAX, &ps_divval,
288 dev_err(chip->dev, "Unsupported values\n");
292 pm_runtime_get_sync(chip->dev);
294 /* Update clock prescaler values */
295 ehrpwm_modify(pc->mmio_base, TBCTL, TBCTL_CLKDIV_MASK, tb_divval);
297 /* Update period & duty cycle with presacler division */
298 period_cycles = period_cycles / ps_divval;
299 duty_cycles = duty_cycles / ps_divval;
301 /* Configure shadow loading on Period register */
302 ehrpwm_modify(pc->mmio_base, TBCTL, TBCTL_PRDLD_MASK, TBCTL_PRDLD_SHDW);
304 ehrpwm_write(pc->mmio_base, TBPRD, period_cycles);
306 /* Configure ehrpwm counter for up-count mode */
307 ehrpwm_modify(pc->mmio_base, TBCTL, TBCTL_CTRMODE_MASK,
311 /* Channel 1 configured with compare B register */
314 /* Channel 0 configured with compare A register */
317 ehrpwm_write(pc->mmio_base, cmp_reg, duty_cycles);
319 pm_runtime_put_sync(chip->dev);
323 static int ehrpwm_pwm_set_polarity(struct pwm_chip *chip,
324 struct pwm_device *pwm, enum pwm_polarity polarity)
326 struct ehrpwm_pwm_chip *pc = to_ehrpwm_pwm_chip(chip);
328 /* Configuration of polarity in hardware delayed, do at enable */
329 pc->polarity[pwm->hwpwm] = polarity;
333 static int ehrpwm_pwm_enable(struct pwm_chip *chip, struct pwm_device *pwm)
335 struct ehrpwm_pwm_chip *pc = to_ehrpwm_pwm_chip(chip);
336 unsigned short aqcsfrc_val, aqcsfrc_mask;
339 /* Leave clock enabled on enabling PWM */
340 pm_runtime_get_sync(chip->dev);
342 /* Disabling Action Qualifier on PWM output */
344 aqcsfrc_val = AQCSFRC_CSFB_FRCDIS;
345 aqcsfrc_mask = AQCSFRC_CSFB_MASK;
347 aqcsfrc_val = AQCSFRC_CSFA_FRCDIS;
348 aqcsfrc_mask = AQCSFRC_CSFA_MASK;
351 /* Changes to shadow mode */
352 ehrpwm_modify(pc->mmio_base, AQSFRC, AQSFRC_RLDCSF_MASK,
355 ehrpwm_modify(pc->mmio_base, AQCSFRC, aqcsfrc_mask, aqcsfrc_val);
357 /* Channels polarity can be configured from action qualifier module */
358 configure_polarity(pc, pwm->hwpwm);
360 /* Enable TBCLK before enabling PWM device */
361 ret = clk_enable(pc->tbclk);
363 pr_err("Failed to enable TBCLK for %s\n",
364 dev_name(pc->chip.dev));
368 /* Enable time counter for free_run */
369 ehrpwm_modify(pc->mmio_base, TBCTL, TBCTL_RUN_MASK, TBCTL_FREE_RUN);
373 static void ehrpwm_pwm_disable(struct pwm_chip *chip, struct pwm_device *pwm)
375 struct ehrpwm_pwm_chip *pc = to_ehrpwm_pwm_chip(chip);
376 unsigned short aqcsfrc_val, aqcsfrc_mask;
378 /* Action Qualifier puts PWM output low forcefully */
380 aqcsfrc_val = AQCSFRC_CSFB_FRCLOW;
381 aqcsfrc_mask = AQCSFRC_CSFB_MASK;
383 aqcsfrc_val = AQCSFRC_CSFA_FRCLOW;
384 aqcsfrc_mask = AQCSFRC_CSFA_MASK;
388 * Changes to immediate action on Action Qualifier. This puts
389 * Action Qualifier control on PWM output from next TBCLK
391 ehrpwm_modify(pc->mmio_base, AQSFRC, AQSFRC_RLDCSF_MASK,
394 ehrpwm_modify(pc->mmio_base, AQCSFRC, aqcsfrc_mask, aqcsfrc_val);
396 /* Disabling TBCLK on PWM disable */
397 clk_disable(pc->tbclk);
399 /* Stop Time base counter */
400 ehrpwm_modify(pc->mmio_base, TBCTL, TBCTL_RUN_MASK, TBCTL_STOP_NEXT);
402 /* Disable clock on PWM disable */
403 pm_runtime_put_sync(chip->dev);
406 static void ehrpwm_pwm_free(struct pwm_chip *chip, struct pwm_device *pwm)
408 struct ehrpwm_pwm_chip *pc = to_ehrpwm_pwm_chip(chip);
410 if (test_bit(PWMF_ENABLED, &pwm->flags)) {
411 dev_warn(chip->dev, "Removing PWM device without disabling\n");
412 pm_runtime_put_sync(chip->dev);
415 /* set period value to zero on free */
416 pc->period_cycles[pwm->hwpwm] = 0;
419 static const struct pwm_ops ehrpwm_pwm_ops = {
420 .free = ehrpwm_pwm_free,
421 .config = ehrpwm_pwm_config,
422 .set_polarity = ehrpwm_pwm_set_polarity,
423 .enable = ehrpwm_pwm_enable,
424 .disable = ehrpwm_pwm_disable,
425 .owner = THIS_MODULE,
428 static const struct of_device_id ehrpwm_of_match[] = {
429 { .compatible = "ti,am33xx-ehrpwm" },
432 MODULE_DEVICE_TABLE(of, ehrpwm_of_match);
434 static int ehrpwm_pwm_probe(struct platform_device *pdev)
439 struct ehrpwm_pwm_chip *pc;
442 pc = devm_kzalloc(&pdev->dev, sizeof(*pc), GFP_KERNEL);
444 dev_err(&pdev->dev, "failed to allocate memory\n");
448 clk = devm_clk_get(&pdev->dev, "fck");
450 dev_err(&pdev->dev, "failed to get clock\n");
454 pc->clk_rate = clk_get_rate(clk);
456 dev_err(&pdev->dev, "failed to get clock rate\n");
460 pc->chip.dev = &pdev->dev;
461 pc->chip.ops = &ehrpwm_pwm_ops;
462 pc->chip.of_xlate = of_pwm_xlate_with_flags;
463 pc->chip.of_pwm_n_cells = 3;
465 pc->chip.npwm = NUM_PWM_CHANNEL;
467 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
468 pc->mmio_base = devm_ioremap_resource(&pdev->dev, r);
469 if (IS_ERR(pc->mmio_base))
470 return PTR_ERR(pc->mmio_base);
472 /* Acquire tbclk for Time Base EHRPWM submodule */
473 pc->tbclk = devm_clk_get(&pdev->dev, "tbclk");
474 if (IS_ERR(pc->tbclk)) {
475 dev_err(&pdev->dev, "Failed to get tbclk\n");
476 return PTR_ERR(pc->tbclk);
479 ret = clk_prepare(pc->tbclk);
481 dev_err(&pdev->dev, "clk_prepare() failed: %d\n", ret);
485 ret = pwmchip_add(&pc->chip);
487 dev_err(&pdev->dev, "pwmchip_add() failed: %d\n", ret);
491 pm_runtime_enable(&pdev->dev);
492 pm_runtime_get_sync(&pdev->dev);
494 status = pwmss_submodule_state_change(pdev->dev.parent,
496 if (!(status & PWMSS_EPWMCLK_EN_ACK)) {
497 dev_err(&pdev->dev, "PWMSS config space clock enable failed\n");
499 goto pwmss_clk_failure;
502 pm_runtime_put_sync(&pdev->dev);
504 platform_set_drvdata(pdev, pc);
508 pm_runtime_put_sync(&pdev->dev);
509 pm_runtime_disable(&pdev->dev);
510 pwmchip_remove(&pc->chip);
511 clk_unprepare(pc->tbclk);
515 static int ehrpwm_pwm_remove(struct platform_device *pdev)
517 struct ehrpwm_pwm_chip *pc = platform_get_drvdata(pdev);
519 clk_unprepare(pc->tbclk);
521 pm_runtime_get_sync(&pdev->dev);
523 * Due to hardware misbehaviour, acknowledge of the stop_req
524 * is missing. Hence checking of the status bit skipped.
526 pwmss_submodule_state_change(pdev->dev.parent, PWMSS_EPWMCLK_STOP_REQ);
527 pm_runtime_put_sync(&pdev->dev);
529 pm_runtime_put_sync(&pdev->dev);
530 pm_runtime_disable(&pdev->dev);
531 return pwmchip_remove(&pc->chip);
534 static void ehrpwm_pwm_save_context(struct ehrpwm_pwm_chip *pc)
536 pm_runtime_get_sync(pc->chip.dev);
537 pc->ctx.tbctl = ehrpwm_read(pc->mmio_base, TBCTL);
538 pc->ctx.tbprd = ehrpwm_read(pc->mmio_base, TBPRD);
539 pc->ctx.cmpa = ehrpwm_read(pc->mmio_base, CMPA);
540 pc->ctx.cmpb = ehrpwm_read(pc->mmio_base, CMPB);
541 pc->ctx.aqctla = ehrpwm_read(pc->mmio_base, AQCTLA);
542 pc->ctx.aqctlb = ehrpwm_read(pc->mmio_base, AQCTLB);
543 pc->ctx.aqsfrc = ehrpwm_read(pc->mmio_base, AQSFRC);
544 pc->ctx.aqcsfrc = ehrpwm_read(pc->mmio_base, AQCSFRC);
545 pm_runtime_put_sync(pc->chip.dev);
548 static void ehrpwm_pwm_restore_context(struct ehrpwm_pwm_chip *pc)
550 ehrpwm_write(pc->mmio_base, TBPRD, pc->ctx.tbprd);
551 ehrpwm_write(pc->mmio_base, CMPA, pc->ctx.cmpa);
552 ehrpwm_write(pc->mmio_base, CMPB, pc->ctx.cmpb);
553 ehrpwm_write(pc->mmio_base, AQCTLA, pc->ctx.aqctla);
554 ehrpwm_write(pc->mmio_base, AQCTLB, pc->ctx.aqctlb);
555 ehrpwm_write(pc->mmio_base, AQSFRC, pc->ctx.aqsfrc);
556 ehrpwm_write(pc->mmio_base, AQCSFRC, pc->ctx.aqcsfrc);
557 ehrpwm_write(pc->mmio_base, TBCTL, pc->ctx.tbctl);
560 #ifdef CONFIG_PM_SLEEP
561 static int ehrpwm_pwm_suspend(struct device *dev)
563 struct ehrpwm_pwm_chip *pc = dev_get_drvdata(dev);
566 ehrpwm_pwm_save_context(pc);
567 for (i = 0; i < pc->chip.npwm; i++) {
568 struct pwm_device *pwm = &pc->chip.pwms[i];
570 if (!test_bit(PWMF_ENABLED, &pwm->flags))
573 /* Disable explicitly if PWM is running */
574 pm_runtime_put_sync(dev);
579 static int ehrpwm_pwm_resume(struct device *dev)
581 struct ehrpwm_pwm_chip *pc = dev_get_drvdata(dev);
584 for (i = 0; i < pc->chip.npwm; i++) {
585 struct pwm_device *pwm = &pc->chip.pwms[i];
587 if (!test_bit(PWMF_ENABLED, &pwm->flags))
590 /* Enable explicitly if PWM was running */
591 pm_runtime_get_sync(dev);
593 ehrpwm_pwm_restore_context(pc);
598 static SIMPLE_DEV_PM_OPS(ehrpwm_pwm_pm_ops, ehrpwm_pwm_suspend,
601 static struct platform_driver ehrpwm_pwm_driver = {
604 .owner = THIS_MODULE,
605 .of_match_table = ehrpwm_of_match,
606 .pm = &ehrpwm_pwm_pm_ops,
608 .probe = ehrpwm_pwm_probe,
609 .remove = ehrpwm_pwm_remove,
612 module_platform_driver(ehrpwm_pwm_driver);
614 MODULE_DESCRIPTION("EHRPWM PWM driver");
615 MODULE_AUTHOR("Texas Instruments");
616 MODULE_LICENSE("GPL");