Linux 4.19.133
[linux/fpc-iii.git] / drivers / pwm / pwm-tiehrpwm.c
blobad4a40c0f27cf45271e57aee9e8ee4e168118695
1 /*
2 * EHRPWM PWM driver
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>
24 #include <linux/io.h>
25 #include <linux/err.h>
26 #include <linux/clk.h>
27 #include <linux/pm_runtime.h>
28 #include <linux/of_device.h>
30 /* EHRPWM registers and bits definitions */
32 /* Time base module registers */
33 #define TBCTL 0x00
34 #define TBPRD 0x0A
36 #define TBCTL_PRDLD_MASK BIT(3)
37 #define TBCTL_PRDLD_SHDW 0
38 #define TBCTL_PRDLD_IMDT BIT(3)
39 #define TBCTL_CLKDIV_MASK (BIT(12) | BIT(11) | BIT(10) | BIT(9) | \
40 BIT(8) | BIT(7))
41 #define TBCTL_CTRMODE_MASK (BIT(1) | BIT(0))
42 #define TBCTL_CTRMODE_UP 0
43 #define TBCTL_CTRMODE_DOWN BIT(0)
44 #define TBCTL_CTRMODE_UPDOWN BIT(1)
45 #define TBCTL_CTRMODE_FREEZE (BIT(1) | BIT(0))
47 #define TBCTL_HSPCLKDIV_SHIFT 7
48 #define TBCTL_CLKDIV_SHIFT 10
50 #define CLKDIV_MAX 7
51 #define HSPCLKDIV_MAX 7
52 #define PERIOD_MAX 0xFFFF
54 /* compare module registers */
55 #define CMPA 0x12
56 #define CMPB 0x14
58 /* Action qualifier module registers */
59 #define AQCTLA 0x16
60 #define AQCTLB 0x18
61 #define AQSFRC 0x1A
62 #define AQCSFRC 0x1C
64 #define AQCTL_CBU_MASK (BIT(9) | BIT(8))
65 #define AQCTL_CBU_FRCLOW BIT(8)
66 #define AQCTL_CBU_FRCHIGH BIT(9)
67 #define AQCTL_CBU_FRCTOGGLE (BIT(9) | BIT(8))
68 #define AQCTL_CAU_MASK (BIT(5) | BIT(4))
69 #define AQCTL_CAU_FRCLOW BIT(4)
70 #define AQCTL_CAU_FRCHIGH BIT(5)
71 #define AQCTL_CAU_FRCTOGGLE (BIT(5) | BIT(4))
72 #define AQCTL_PRD_MASK (BIT(3) | BIT(2))
73 #define AQCTL_PRD_FRCLOW BIT(2)
74 #define AQCTL_PRD_FRCHIGH BIT(3)
75 #define AQCTL_PRD_FRCTOGGLE (BIT(3) | BIT(2))
76 #define AQCTL_ZRO_MASK (BIT(1) | BIT(0))
77 #define AQCTL_ZRO_FRCLOW BIT(0)
78 #define AQCTL_ZRO_FRCHIGH BIT(1)
79 #define AQCTL_ZRO_FRCTOGGLE (BIT(1) | BIT(0))
81 #define AQCTL_CHANA_POLNORMAL (AQCTL_CAU_FRCLOW | AQCTL_PRD_FRCHIGH | \
82 AQCTL_ZRO_FRCHIGH)
83 #define AQCTL_CHANA_POLINVERSED (AQCTL_CAU_FRCHIGH | AQCTL_PRD_FRCLOW | \
84 AQCTL_ZRO_FRCLOW)
85 #define AQCTL_CHANB_POLNORMAL (AQCTL_CBU_FRCLOW | AQCTL_PRD_FRCHIGH | \
86 AQCTL_ZRO_FRCHIGH)
87 #define AQCTL_CHANB_POLINVERSED (AQCTL_CBU_FRCHIGH | AQCTL_PRD_FRCLOW | \
88 AQCTL_ZRO_FRCLOW)
90 #define AQSFRC_RLDCSF_MASK (BIT(7) | BIT(6))
91 #define AQSFRC_RLDCSF_ZRO 0
92 #define AQSFRC_RLDCSF_PRD BIT(6)
93 #define AQSFRC_RLDCSF_ZROPRD BIT(7)
94 #define AQSFRC_RLDCSF_IMDT (BIT(7) | BIT(6))
96 #define AQCSFRC_CSFB_MASK (BIT(3) | BIT(2))
97 #define AQCSFRC_CSFB_FRCDIS 0
98 #define AQCSFRC_CSFB_FRCLOW BIT(2)
99 #define AQCSFRC_CSFB_FRCHIGH BIT(3)
100 #define AQCSFRC_CSFB_DISSWFRC (BIT(3) | BIT(2))
101 #define AQCSFRC_CSFA_MASK (BIT(1) | BIT(0))
102 #define AQCSFRC_CSFA_FRCDIS 0
103 #define AQCSFRC_CSFA_FRCLOW BIT(0)
104 #define AQCSFRC_CSFA_FRCHIGH BIT(1)
105 #define AQCSFRC_CSFA_DISSWFRC (BIT(1) | BIT(0))
107 #define NUM_PWM_CHANNEL 2 /* EHRPWM channels */
109 struct ehrpwm_context {
110 u16 tbctl;
111 u16 tbprd;
112 u16 cmpa;
113 u16 cmpb;
114 u16 aqctla;
115 u16 aqctlb;
116 u16 aqsfrc;
117 u16 aqcsfrc;
120 struct ehrpwm_pwm_chip {
121 struct pwm_chip chip;
122 unsigned long clk_rate;
123 void __iomem *mmio_base;
124 unsigned long period_cycles[NUM_PWM_CHANNEL];
125 enum pwm_polarity polarity[NUM_PWM_CHANNEL];
126 struct clk *tbclk;
127 struct ehrpwm_context ctx;
130 static inline struct ehrpwm_pwm_chip *to_ehrpwm_pwm_chip(struct pwm_chip *chip)
132 return container_of(chip, struct ehrpwm_pwm_chip, chip);
135 static inline u16 ehrpwm_read(void __iomem *base, unsigned int offset)
137 return readw(base + offset);
140 static inline void ehrpwm_write(void __iomem *base, unsigned int offset,
141 u16 value)
143 writew(value, base + offset);
146 static void ehrpwm_modify(void __iomem *base, unsigned int offset, u16 mask,
147 u16 value)
149 unsigned short val;
151 val = readw(base + offset);
152 val &= ~mask;
153 val |= value & mask;
154 writew(val, base + offset);
158 * set_prescale_div - Set up the prescaler divider function
159 * @rqst_prescaler: prescaler value min
160 * @prescale_div: prescaler value set
161 * @tb_clk_div: Time Base Control prescaler bits
163 static int set_prescale_div(unsigned long rqst_prescaler, u16 *prescale_div,
164 u16 *tb_clk_div)
166 unsigned int clkdiv, hspclkdiv;
168 for (clkdiv = 0; clkdiv <= CLKDIV_MAX; clkdiv++) {
169 for (hspclkdiv = 0; hspclkdiv <= HSPCLKDIV_MAX; hspclkdiv++) {
171 * calculations for prescaler value :
172 * prescale_div = HSPCLKDIVIDER * CLKDIVIDER.
173 * HSPCLKDIVIDER = 2 ** hspclkdiv
174 * CLKDIVIDER = (1), if clkdiv == 0 *OR*
175 * (2 * clkdiv), if clkdiv != 0
177 * Configure prescale_div value such that period
178 * register value is less than 65535.
181 *prescale_div = (1 << clkdiv) *
182 (hspclkdiv ? (hspclkdiv * 2) : 1);
183 if (*prescale_div > rqst_prescaler) {
184 *tb_clk_div = (clkdiv << TBCTL_CLKDIV_SHIFT) |
185 (hspclkdiv << TBCTL_HSPCLKDIV_SHIFT);
186 return 0;
191 return 1;
194 static void configure_polarity(struct ehrpwm_pwm_chip *pc, int chan)
196 u16 aqctl_val, aqctl_mask;
197 unsigned int aqctl_reg;
200 * Configure PWM output to HIGH/LOW level on counter
201 * reaches compare register value and LOW/HIGH level
202 * on counter value reaches period register value and
203 * zero value on counter
205 if (chan == 1) {
206 aqctl_reg = AQCTLB;
207 aqctl_mask = AQCTL_CBU_MASK;
209 if (pc->polarity[chan] == PWM_POLARITY_INVERSED)
210 aqctl_val = AQCTL_CHANB_POLINVERSED;
211 else
212 aqctl_val = AQCTL_CHANB_POLNORMAL;
213 } else {
214 aqctl_reg = AQCTLA;
215 aqctl_mask = AQCTL_CAU_MASK;
217 if (pc->polarity[chan] == PWM_POLARITY_INVERSED)
218 aqctl_val = AQCTL_CHANA_POLINVERSED;
219 else
220 aqctl_val = AQCTL_CHANA_POLNORMAL;
223 aqctl_mask |= AQCTL_PRD_MASK | AQCTL_ZRO_MASK;
224 ehrpwm_modify(pc->mmio_base, aqctl_reg, aqctl_mask, aqctl_val);
228 * period_ns = 10^9 * (ps_divval * period_cycles) / PWM_CLK_RATE
229 * duty_ns = 10^9 * (ps_divval * duty_cycles) / PWM_CLK_RATE
231 static int ehrpwm_pwm_config(struct pwm_chip *chip, struct pwm_device *pwm,
232 int duty_ns, int period_ns)
234 struct ehrpwm_pwm_chip *pc = to_ehrpwm_pwm_chip(chip);
235 u32 period_cycles, duty_cycles;
236 u16 ps_divval, tb_divval;
237 unsigned int i, cmp_reg;
238 unsigned long long c;
240 if (period_ns > NSEC_PER_SEC)
241 return -ERANGE;
243 c = pc->clk_rate;
244 c = c * period_ns;
245 do_div(c, NSEC_PER_SEC);
246 period_cycles = (unsigned long)c;
248 if (period_cycles < 1) {
249 period_cycles = 1;
250 duty_cycles = 1;
251 } else {
252 c = pc->clk_rate;
253 c = c * duty_ns;
254 do_div(c, NSEC_PER_SEC);
255 duty_cycles = (unsigned long)c;
259 * Period values should be same for multiple PWM channels as IP uses
260 * same period register for multiple channels.
262 for (i = 0; i < NUM_PWM_CHANNEL; i++) {
263 if (pc->period_cycles[i] &&
264 (pc->period_cycles[i] != period_cycles)) {
266 * Allow channel to reconfigure period if no other
267 * channels being configured.
269 if (i == pwm->hwpwm)
270 continue;
272 dev_err(chip->dev,
273 "period value conflicts with channel %u\n",
275 return -EINVAL;
279 pc->period_cycles[pwm->hwpwm] = period_cycles;
281 /* Configure clock prescaler to support Low frequency PWM wave */
282 if (set_prescale_div(period_cycles/PERIOD_MAX, &ps_divval,
283 &tb_divval)) {
284 dev_err(chip->dev, "Unsupported values\n");
285 return -EINVAL;
288 pm_runtime_get_sync(chip->dev);
290 /* Update clock prescaler values */
291 ehrpwm_modify(pc->mmio_base, TBCTL, TBCTL_CLKDIV_MASK, tb_divval);
293 /* Update period & duty cycle with presacler division */
294 period_cycles = period_cycles / ps_divval;
295 duty_cycles = duty_cycles / ps_divval;
297 /* Configure shadow loading on Period register */
298 ehrpwm_modify(pc->mmio_base, TBCTL, TBCTL_PRDLD_MASK, TBCTL_PRDLD_SHDW);
300 ehrpwm_write(pc->mmio_base, TBPRD, period_cycles);
302 /* Configure ehrpwm counter for up-count mode */
303 ehrpwm_modify(pc->mmio_base, TBCTL, TBCTL_CTRMODE_MASK,
304 TBCTL_CTRMODE_UP);
306 if (pwm->hwpwm == 1)
307 /* Channel 1 configured with compare B register */
308 cmp_reg = CMPB;
309 else
310 /* Channel 0 configured with compare A register */
311 cmp_reg = CMPA;
313 ehrpwm_write(pc->mmio_base, cmp_reg, duty_cycles);
315 pm_runtime_put_sync(chip->dev);
317 return 0;
320 static int ehrpwm_pwm_set_polarity(struct pwm_chip *chip,
321 struct pwm_device *pwm,
322 enum pwm_polarity polarity)
324 struct ehrpwm_pwm_chip *pc = to_ehrpwm_pwm_chip(chip);
326 /* Configuration of polarity in hardware delayed, do at enable */
327 pc->polarity[pwm->hwpwm] = polarity;
329 return 0;
332 static int ehrpwm_pwm_enable(struct pwm_chip *chip, struct pwm_device *pwm)
334 struct ehrpwm_pwm_chip *pc = to_ehrpwm_pwm_chip(chip);
335 u16 aqcsfrc_val, aqcsfrc_mask;
336 int ret;
338 /* Leave clock enabled on enabling PWM */
339 pm_runtime_get_sync(chip->dev);
341 /* Disabling Action Qualifier on PWM output */
342 if (pwm->hwpwm) {
343 aqcsfrc_val = AQCSFRC_CSFB_FRCDIS;
344 aqcsfrc_mask = AQCSFRC_CSFB_MASK;
345 } else {
346 aqcsfrc_val = AQCSFRC_CSFA_FRCDIS;
347 aqcsfrc_mask = AQCSFRC_CSFA_MASK;
350 /* Changes to shadow mode */
351 ehrpwm_modify(pc->mmio_base, AQSFRC, AQSFRC_RLDCSF_MASK,
352 AQSFRC_RLDCSF_ZRO);
354 ehrpwm_modify(pc->mmio_base, AQCSFRC, aqcsfrc_mask, aqcsfrc_val);
356 /* Channels polarity can be configured from action qualifier module */
357 configure_polarity(pc, pwm->hwpwm);
359 /* Enable TBCLK */
360 ret = clk_enable(pc->tbclk);
361 if (ret) {
362 dev_err(chip->dev, "Failed to enable TBCLK for %s: %d\n",
363 dev_name(pc->chip.dev), ret);
364 return ret;
367 return 0;
370 static void ehrpwm_pwm_disable(struct pwm_chip *chip, struct pwm_device *pwm)
372 struct ehrpwm_pwm_chip *pc = to_ehrpwm_pwm_chip(chip);
373 u16 aqcsfrc_val, aqcsfrc_mask;
375 /* Action Qualifier puts PWM output low forcefully */
376 if (pwm->hwpwm) {
377 aqcsfrc_val = AQCSFRC_CSFB_FRCLOW;
378 aqcsfrc_mask = AQCSFRC_CSFB_MASK;
379 } else {
380 aqcsfrc_val = AQCSFRC_CSFA_FRCLOW;
381 aqcsfrc_mask = AQCSFRC_CSFA_MASK;
384 /* Update shadow register first before modifying active register */
385 ehrpwm_modify(pc->mmio_base, AQSFRC, AQSFRC_RLDCSF_MASK,
386 AQSFRC_RLDCSF_ZRO);
387 ehrpwm_modify(pc->mmio_base, AQCSFRC, aqcsfrc_mask, aqcsfrc_val);
389 * Changes to immediate action on Action Qualifier. This puts
390 * Action Qualifier control on PWM output from next TBCLK
392 ehrpwm_modify(pc->mmio_base, AQSFRC, AQSFRC_RLDCSF_MASK,
393 AQSFRC_RLDCSF_IMDT);
395 ehrpwm_modify(pc->mmio_base, AQCSFRC, aqcsfrc_mask, aqcsfrc_val);
397 /* Disabling TBCLK on PWM disable */
398 clk_disable(pc->tbclk);
400 /* Disable clock on PWM disable */
401 pm_runtime_put_sync(chip->dev);
404 static void ehrpwm_pwm_free(struct pwm_chip *chip, struct pwm_device *pwm)
406 struct ehrpwm_pwm_chip *pc = to_ehrpwm_pwm_chip(chip);
408 if (pwm_is_enabled(pwm)) {
409 dev_warn(chip->dev, "Removing PWM device without disabling\n");
410 pm_runtime_put_sync(chip->dev);
413 /* set period value to zero on free */
414 pc->period_cycles[pwm->hwpwm] = 0;
417 static const struct pwm_ops ehrpwm_pwm_ops = {
418 .free = ehrpwm_pwm_free,
419 .config = ehrpwm_pwm_config,
420 .set_polarity = ehrpwm_pwm_set_polarity,
421 .enable = ehrpwm_pwm_enable,
422 .disable = ehrpwm_pwm_disable,
423 .owner = THIS_MODULE,
426 static const struct of_device_id ehrpwm_of_match[] = {
427 { .compatible = "ti,am3352-ehrpwm" },
428 { .compatible = "ti,am33xx-ehrpwm" },
431 MODULE_DEVICE_TABLE(of, ehrpwm_of_match);
433 static int ehrpwm_pwm_probe(struct platform_device *pdev)
435 struct device_node *np = pdev->dev.of_node;
436 struct ehrpwm_pwm_chip *pc;
437 struct resource *r;
438 struct clk *clk;
439 int ret;
441 pc = devm_kzalloc(&pdev->dev, sizeof(*pc), GFP_KERNEL);
442 if (!pc)
443 return -ENOMEM;
445 clk = devm_clk_get(&pdev->dev, "fck");
446 if (IS_ERR(clk)) {
447 if (of_device_is_compatible(np, "ti,am33xx-ecap")) {
448 dev_warn(&pdev->dev, "Binding is obsolete.\n");
449 clk = devm_clk_get(pdev->dev.parent, "fck");
453 if (IS_ERR(clk)) {
454 dev_err(&pdev->dev, "failed to get clock\n");
455 return PTR_ERR(clk);
458 pc->clk_rate = clk_get_rate(clk);
459 if (!pc->clk_rate) {
460 dev_err(&pdev->dev, "failed to get clock rate\n");
461 return -EINVAL;
464 pc->chip.dev = &pdev->dev;
465 pc->chip.ops = &ehrpwm_pwm_ops;
466 pc->chip.of_xlate = of_pwm_xlate_with_flags;
467 pc->chip.of_pwm_n_cells = 3;
468 pc->chip.base = -1;
469 pc->chip.npwm = NUM_PWM_CHANNEL;
471 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
472 pc->mmio_base = devm_ioremap_resource(&pdev->dev, r);
473 if (IS_ERR(pc->mmio_base))
474 return PTR_ERR(pc->mmio_base);
476 /* Acquire tbclk for Time Base EHRPWM submodule */
477 pc->tbclk = devm_clk_get(&pdev->dev, "tbclk");
478 if (IS_ERR(pc->tbclk)) {
479 dev_err(&pdev->dev, "Failed to get tbclk\n");
480 return PTR_ERR(pc->tbclk);
483 ret = clk_prepare(pc->tbclk);
484 if (ret < 0) {
485 dev_err(&pdev->dev, "clk_prepare() failed: %d\n", ret);
486 return ret;
489 ret = pwmchip_add(&pc->chip);
490 if (ret < 0) {
491 dev_err(&pdev->dev, "pwmchip_add() failed: %d\n", ret);
492 goto err_clk_unprepare;
495 platform_set_drvdata(pdev, pc);
496 pm_runtime_enable(&pdev->dev);
498 return 0;
500 err_clk_unprepare:
501 clk_unprepare(pc->tbclk);
503 return ret;
506 static int ehrpwm_pwm_remove(struct platform_device *pdev)
508 struct ehrpwm_pwm_chip *pc = platform_get_drvdata(pdev);
510 clk_unprepare(pc->tbclk);
512 pm_runtime_disable(&pdev->dev);
514 return pwmchip_remove(&pc->chip);
517 #ifdef CONFIG_PM_SLEEP
518 static void ehrpwm_pwm_save_context(struct ehrpwm_pwm_chip *pc)
520 pm_runtime_get_sync(pc->chip.dev);
522 pc->ctx.tbctl = ehrpwm_read(pc->mmio_base, TBCTL);
523 pc->ctx.tbprd = ehrpwm_read(pc->mmio_base, TBPRD);
524 pc->ctx.cmpa = ehrpwm_read(pc->mmio_base, CMPA);
525 pc->ctx.cmpb = ehrpwm_read(pc->mmio_base, CMPB);
526 pc->ctx.aqctla = ehrpwm_read(pc->mmio_base, AQCTLA);
527 pc->ctx.aqctlb = ehrpwm_read(pc->mmio_base, AQCTLB);
528 pc->ctx.aqsfrc = ehrpwm_read(pc->mmio_base, AQSFRC);
529 pc->ctx.aqcsfrc = ehrpwm_read(pc->mmio_base, AQCSFRC);
531 pm_runtime_put_sync(pc->chip.dev);
534 static void ehrpwm_pwm_restore_context(struct ehrpwm_pwm_chip *pc)
536 ehrpwm_write(pc->mmio_base, TBPRD, pc->ctx.tbprd);
537 ehrpwm_write(pc->mmio_base, CMPA, pc->ctx.cmpa);
538 ehrpwm_write(pc->mmio_base, CMPB, pc->ctx.cmpb);
539 ehrpwm_write(pc->mmio_base, AQCTLA, pc->ctx.aqctla);
540 ehrpwm_write(pc->mmio_base, AQCTLB, pc->ctx.aqctlb);
541 ehrpwm_write(pc->mmio_base, AQSFRC, pc->ctx.aqsfrc);
542 ehrpwm_write(pc->mmio_base, AQCSFRC, pc->ctx.aqcsfrc);
543 ehrpwm_write(pc->mmio_base, TBCTL, pc->ctx.tbctl);
546 static int ehrpwm_pwm_suspend(struct device *dev)
548 struct ehrpwm_pwm_chip *pc = dev_get_drvdata(dev);
549 unsigned int i;
551 ehrpwm_pwm_save_context(pc);
553 for (i = 0; i < pc->chip.npwm; i++) {
554 struct pwm_device *pwm = &pc->chip.pwms[i];
556 if (!pwm_is_enabled(pwm))
557 continue;
559 /* Disable explicitly if PWM is running */
560 pm_runtime_put_sync(dev);
563 return 0;
566 static int ehrpwm_pwm_resume(struct device *dev)
568 struct ehrpwm_pwm_chip *pc = dev_get_drvdata(dev);
569 unsigned int i;
571 for (i = 0; i < pc->chip.npwm; i++) {
572 struct pwm_device *pwm = &pc->chip.pwms[i];
574 if (!pwm_is_enabled(pwm))
575 continue;
577 /* Enable explicitly if PWM was running */
578 pm_runtime_get_sync(dev);
581 ehrpwm_pwm_restore_context(pc);
583 return 0;
585 #endif
587 static SIMPLE_DEV_PM_OPS(ehrpwm_pwm_pm_ops, ehrpwm_pwm_suspend,
588 ehrpwm_pwm_resume);
590 static struct platform_driver ehrpwm_pwm_driver = {
591 .driver = {
592 .name = "ehrpwm",
593 .of_match_table = ehrpwm_of_match,
594 .pm = &ehrpwm_pwm_pm_ops,
596 .probe = ehrpwm_pwm_probe,
597 .remove = ehrpwm_pwm_remove,
599 module_platform_driver(ehrpwm_pwm_driver);
601 MODULE_DESCRIPTION("EHRPWM PWM driver");
602 MODULE_AUTHOR("Texas Instruments");
603 MODULE_LICENSE("GPL");