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>
29 #include <linux/pinctrl/consumer.h>
31 #include "pwm-tipwmss.h"
33 /* EHRPWM registers and bits definitions */
35 /* Time base module registers */
39 #define TBCTL_RUN_MASK (BIT(15) | BIT(14))
40 #define TBCTL_STOP_NEXT 0
41 #define TBCTL_STOP_ON_CYCLE BIT(14)
42 #define TBCTL_FREE_RUN (BIT(15) | BIT(14))
43 #define TBCTL_PRDLD_MASK BIT(3)
44 #define TBCTL_PRDLD_SHDW 0
45 #define TBCTL_PRDLD_IMDT BIT(3)
46 #define TBCTL_CLKDIV_MASK (BIT(12) | BIT(11) | BIT(10) | BIT(9) | \
48 #define TBCTL_CTRMODE_MASK (BIT(1) | BIT(0))
49 #define TBCTL_CTRMODE_UP 0
50 #define TBCTL_CTRMODE_DOWN BIT(0)
51 #define TBCTL_CTRMODE_UPDOWN BIT(1)
52 #define TBCTL_CTRMODE_FREEZE (BIT(1) | BIT(0))
54 #define TBCTL_HSPCLKDIV_SHIFT 7
55 #define TBCTL_CLKDIV_SHIFT 10
58 #define HSPCLKDIV_MAX 7
59 #define PERIOD_MAX 0xFFFF
61 /* compare module registers */
65 /* Action qualifier module registers */
71 #define AQCTL_CBU_MASK (BIT(9) | BIT(8))
72 #define AQCTL_CBU_FRCLOW BIT(8)
73 #define AQCTL_CBU_FRCHIGH BIT(9)
74 #define AQCTL_CBU_FRCTOGGLE (BIT(9) | BIT(8))
75 #define AQCTL_CAU_MASK (BIT(5) | BIT(4))
76 #define AQCTL_CAU_FRCLOW BIT(4)
77 #define AQCTL_CAU_FRCHIGH BIT(5)
78 #define AQCTL_CAU_FRCTOGGLE (BIT(5) | BIT(4))
79 #define AQCTL_PRD_MASK (BIT(3) | BIT(2))
80 #define AQCTL_PRD_FRCLOW BIT(2)
81 #define AQCTL_PRD_FRCHIGH BIT(3)
82 #define AQCTL_PRD_FRCTOGGLE (BIT(3) | BIT(2))
83 #define AQCTL_ZRO_MASK (BIT(1) | BIT(0))
84 #define AQCTL_ZRO_FRCLOW BIT(0)
85 #define AQCTL_ZRO_FRCHIGH BIT(1)
86 #define AQCTL_ZRO_FRCTOGGLE (BIT(1) | BIT(0))
88 #define AQCTL_CHANA_POLNORMAL (AQCTL_CAU_FRCLOW | AQCTL_PRD_FRCHIGH | \
90 #define AQCTL_CHANA_POLINVERSED (AQCTL_CAU_FRCHIGH | AQCTL_PRD_FRCLOW | \
92 #define AQCTL_CHANB_POLNORMAL (AQCTL_CBU_FRCLOW | AQCTL_PRD_FRCHIGH | \
94 #define AQCTL_CHANB_POLINVERSED (AQCTL_CBU_FRCHIGH | AQCTL_PRD_FRCLOW | \
97 #define AQSFRC_RLDCSF_MASK (BIT(7) | BIT(6))
98 #define AQSFRC_RLDCSF_ZRO 0
99 #define AQSFRC_RLDCSF_PRD BIT(6)
100 #define AQSFRC_RLDCSF_ZROPRD BIT(7)
101 #define AQSFRC_RLDCSF_IMDT (BIT(7) | BIT(6))
103 #define AQCSFRC_CSFB_MASK (BIT(3) | BIT(2))
104 #define AQCSFRC_CSFB_FRCDIS 0
105 #define AQCSFRC_CSFB_FRCLOW BIT(2)
106 #define AQCSFRC_CSFB_FRCHIGH BIT(3)
107 #define AQCSFRC_CSFB_DISSWFRC (BIT(3) | BIT(2))
108 #define AQCSFRC_CSFA_MASK (BIT(1) | BIT(0))
109 #define AQCSFRC_CSFA_FRCDIS 0
110 #define AQCSFRC_CSFA_FRCLOW BIT(0)
111 #define AQCSFRC_CSFA_FRCHIGH BIT(1)
112 #define AQCSFRC_CSFA_DISSWFRC (BIT(1) | BIT(0))
114 #define NUM_PWM_CHANNEL 2 /* EHRPWM channels */
116 struct ehrpwm_pwm_chip
{
117 struct pwm_chip chip
;
118 unsigned int clk_rate
;
119 void __iomem
*mmio_base
;
120 unsigned long period_cycles
[NUM_PWM_CHANNEL
];
121 enum pwm_polarity polarity
[NUM_PWM_CHANNEL
];
125 static inline struct ehrpwm_pwm_chip
*to_ehrpwm_pwm_chip(struct pwm_chip
*chip
)
127 return container_of(chip
, struct ehrpwm_pwm_chip
, chip
);
130 static void ehrpwm_write(void *base
, int offset
, unsigned int val
)
132 writew(val
& 0xFFFF, base
+ offset
);
135 static void ehrpwm_modify(void *base
, int offset
,
136 unsigned short mask
, unsigned short val
)
138 unsigned short regval
;
140 regval
= readw(base
+ offset
);
142 regval
|= val
& mask
;
143 writew(regval
, base
+ offset
);
147 * set_prescale_div - Set up the prescaler divider function
148 * @rqst_prescaler: prescaler value min
149 * @prescale_div: prescaler value set
150 * @tb_clk_div: Time Base Control prescaler bits
152 static int set_prescale_div(unsigned long rqst_prescaler
,
153 unsigned short *prescale_div
, unsigned short *tb_clk_div
)
155 unsigned int clkdiv
, hspclkdiv
;
157 for (clkdiv
= 0; clkdiv
<= CLKDIV_MAX
; clkdiv
++) {
158 for (hspclkdiv
= 0; hspclkdiv
<= HSPCLKDIV_MAX
; hspclkdiv
++) {
161 * calculations for prescaler value :
162 * prescale_div = HSPCLKDIVIDER * CLKDIVIDER.
163 * HSPCLKDIVIDER = 2 ** hspclkdiv
164 * CLKDIVIDER = (1), if clkdiv == 0 *OR*
165 * (2 * clkdiv), if clkdiv != 0
167 * Configure prescale_div value such that period
168 * register value is less than 65535.
171 *prescale_div
= (1 << clkdiv
) *
172 (hspclkdiv
? (hspclkdiv
* 2) : 1);
173 if (*prescale_div
> rqst_prescaler
) {
174 *tb_clk_div
= (clkdiv
<< TBCTL_CLKDIV_SHIFT
) |
175 (hspclkdiv
<< TBCTL_HSPCLKDIV_SHIFT
);
183 static void configure_polarity(struct ehrpwm_pwm_chip
*pc
, int chan
)
186 unsigned short aqctl_val
, aqctl_mask
;
189 * Configure PWM output to HIGH/LOW level on counter
190 * reaches compare register value and LOW/HIGH level
191 * on counter value reaches period register value and
192 * zero value on counter
196 aqctl_mask
= AQCTL_CBU_MASK
;
198 if (pc
->polarity
[chan
] == PWM_POLARITY_INVERSED
)
199 aqctl_val
= AQCTL_CHANB_POLINVERSED
;
201 aqctl_val
= AQCTL_CHANB_POLNORMAL
;
204 aqctl_mask
= AQCTL_CAU_MASK
;
206 if (pc
->polarity
[chan
] == PWM_POLARITY_INVERSED
)
207 aqctl_val
= AQCTL_CHANA_POLINVERSED
;
209 aqctl_val
= AQCTL_CHANA_POLNORMAL
;
212 aqctl_mask
|= AQCTL_PRD_MASK
| AQCTL_ZRO_MASK
;
213 ehrpwm_modify(pc
->mmio_base
, aqctl_reg
, aqctl_mask
, aqctl_val
);
217 * period_ns = 10^9 * (ps_divval * period_cycles) / PWM_CLK_RATE
218 * duty_ns = 10^9 * (ps_divval * duty_cycles) / PWM_CLK_RATE
220 static int ehrpwm_pwm_config(struct pwm_chip
*chip
, struct pwm_device
*pwm
,
221 int duty_ns
, int period_ns
)
223 struct ehrpwm_pwm_chip
*pc
= to_ehrpwm_pwm_chip(chip
);
224 unsigned long long c
;
225 unsigned long period_cycles
, duty_cycles
;
226 unsigned short ps_divval
, tb_divval
;
229 if (period_ns
> NSEC_PER_SEC
)
234 do_div(c
, NSEC_PER_SEC
);
235 period_cycles
= (unsigned long)c
;
237 if (period_cycles
< 1) {
243 do_div(c
, NSEC_PER_SEC
);
244 duty_cycles
= (unsigned long)c
;
248 * Period values should be same for multiple PWM channels as IP uses
249 * same period register for multiple channels.
251 for (i
= 0; i
< NUM_PWM_CHANNEL
; i
++) {
252 if (pc
->period_cycles
[i
] &&
253 (pc
->period_cycles
[i
] != period_cycles
)) {
255 * Allow channel to reconfigure period if no other
256 * channels being configured.
261 dev_err(chip
->dev
, "Period value conflicts with channel %d\n",
267 pc
->period_cycles
[pwm
->hwpwm
] = period_cycles
;
269 /* Configure clock prescaler to support Low frequency PWM wave */
270 if (set_prescale_div(period_cycles
/PERIOD_MAX
, &ps_divval
,
272 dev_err(chip
->dev
, "Unsupported values\n");
276 pm_runtime_get_sync(chip
->dev
);
278 /* Update clock prescaler values */
279 ehrpwm_modify(pc
->mmio_base
, TBCTL
, TBCTL_CLKDIV_MASK
, tb_divval
);
281 /* Update period & duty cycle with presacler division */
282 period_cycles
= period_cycles
/ ps_divval
;
283 duty_cycles
= duty_cycles
/ ps_divval
;
285 /* Configure shadow loading on Period register */
286 ehrpwm_modify(pc
->mmio_base
, TBCTL
, TBCTL_PRDLD_MASK
, TBCTL_PRDLD_SHDW
);
288 ehrpwm_write(pc
->mmio_base
, TBPRD
, period_cycles
);
290 /* Configure ehrpwm counter for up-count mode */
291 ehrpwm_modify(pc
->mmio_base
, TBCTL
, TBCTL_CTRMODE_MASK
,
295 /* Channel 1 configured with compare B register */
298 /* Channel 0 configured with compare A register */
301 ehrpwm_write(pc
->mmio_base
, cmp_reg
, duty_cycles
);
303 pm_runtime_put_sync(chip
->dev
);
307 static int ehrpwm_pwm_set_polarity(struct pwm_chip
*chip
,
308 struct pwm_device
*pwm
, enum pwm_polarity polarity
)
310 struct ehrpwm_pwm_chip
*pc
= to_ehrpwm_pwm_chip(chip
);
312 /* Configuration of polarity in hardware delayed, do at enable */
313 pc
->polarity
[pwm
->hwpwm
] = polarity
;
317 static int ehrpwm_pwm_enable(struct pwm_chip
*chip
, struct pwm_device
*pwm
)
319 struct ehrpwm_pwm_chip
*pc
= to_ehrpwm_pwm_chip(chip
);
320 unsigned short aqcsfrc_val
, aqcsfrc_mask
;
322 /* Leave clock enabled on enabling PWM */
323 pm_runtime_get_sync(chip
->dev
);
325 /* Disabling Action Qualifier on PWM output */
327 aqcsfrc_val
= AQCSFRC_CSFB_FRCDIS
;
328 aqcsfrc_mask
= AQCSFRC_CSFB_MASK
;
330 aqcsfrc_val
= AQCSFRC_CSFA_FRCDIS
;
331 aqcsfrc_mask
= AQCSFRC_CSFA_MASK
;
334 /* Changes to shadow mode */
335 ehrpwm_modify(pc
->mmio_base
, AQSFRC
, AQSFRC_RLDCSF_MASK
,
338 ehrpwm_modify(pc
->mmio_base
, AQCSFRC
, aqcsfrc_mask
, aqcsfrc_val
);
340 /* Channels polarity can be configured from action qualifier module */
341 configure_polarity(pc
, pwm
->hwpwm
);
343 /* Enable TBCLK before enabling PWM device */
344 clk_enable(pc
->tbclk
);
346 /* Enable time counter for free_run */
347 ehrpwm_modify(pc
->mmio_base
, TBCTL
, TBCTL_RUN_MASK
, TBCTL_FREE_RUN
);
351 static void ehrpwm_pwm_disable(struct pwm_chip
*chip
, struct pwm_device
*pwm
)
353 struct ehrpwm_pwm_chip
*pc
= to_ehrpwm_pwm_chip(chip
);
354 unsigned short aqcsfrc_val
, aqcsfrc_mask
;
356 /* Action Qualifier puts PWM output low forcefully */
358 aqcsfrc_val
= AQCSFRC_CSFB_FRCLOW
;
359 aqcsfrc_mask
= AQCSFRC_CSFB_MASK
;
361 aqcsfrc_val
= AQCSFRC_CSFA_FRCLOW
;
362 aqcsfrc_mask
= AQCSFRC_CSFA_MASK
;
366 * Changes to immediate action on Action Qualifier. This puts
367 * Action Qualifier control on PWM output from next TBCLK
369 ehrpwm_modify(pc
->mmio_base
, AQSFRC
, AQSFRC_RLDCSF_MASK
,
372 ehrpwm_modify(pc
->mmio_base
, AQCSFRC
, aqcsfrc_mask
, aqcsfrc_val
);
374 /* Disabling TBCLK on PWM disable */
375 clk_disable(pc
->tbclk
);
377 /* Stop Time base counter */
378 ehrpwm_modify(pc
->mmio_base
, TBCTL
, TBCTL_RUN_MASK
, TBCTL_STOP_NEXT
);
380 /* Disable clock on PWM disable */
381 pm_runtime_put_sync(chip
->dev
);
384 static void ehrpwm_pwm_free(struct pwm_chip
*chip
, struct pwm_device
*pwm
)
386 struct ehrpwm_pwm_chip
*pc
= to_ehrpwm_pwm_chip(chip
);
388 if (test_bit(PWMF_ENABLED
, &pwm
->flags
)) {
389 dev_warn(chip
->dev
, "Removing PWM device without disabling\n");
390 pm_runtime_put_sync(chip
->dev
);
393 /* set period value to zero on free */
394 pc
->period_cycles
[pwm
->hwpwm
] = 0;
397 static const struct pwm_ops ehrpwm_pwm_ops
= {
398 .free
= ehrpwm_pwm_free
,
399 .config
= ehrpwm_pwm_config
,
400 .set_polarity
= ehrpwm_pwm_set_polarity
,
401 .enable
= ehrpwm_pwm_enable
,
402 .disable
= ehrpwm_pwm_disable
,
403 .owner
= THIS_MODULE
,
406 static const struct of_device_id ehrpwm_of_match
[] = {
407 { .compatible
= "ti,am33xx-ehrpwm" },
410 MODULE_DEVICE_TABLE(of
, ehrpwm_of_match
);
412 static int __devinit
ehrpwm_pwm_probe(struct platform_device
*pdev
)
417 struct ehrpwm_pwm_chip
*pc
;
419 struct pinctrl
*pinctrl
;
421 pinctrl
= devm_pinctrl_get_select_default(&pdev
->dev
);
423 dev_warn(&pdev
->dev
, "unable to select pin group\n");
425 pc
= devm_kzalloc(&pdev
->dev
, sizeof(*pc
), GFP_KERNEL
);
427 dev_err(&pdev
->dev
, "failed to allocate memory\n");
431 clk
= devm_clk_get(&pdev
->dev
, "fck");
433 dev_err(&pdev
->dev
, "failed to get clock\n");
437 pc
->clk_rate
= clk_get_rate(clk
);
439 dev_err(&pdev
->dev
, "failed to get clock rate\n");
443 pc
->chip
.dev
= &pdev
->dev
;
444 pc
->chip
.ops
= &ehrpwm_pwm_ops
;
445 pc
->chip
.of_xlate
= of_pwm_xlate_with_flags
;
446 pc
->chip
.of_pwm_n_cells
= 3;
448 pc
->chip
.npwm
= NUM_PWM_CHANNEL
;
450 r
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
452 dev_err(&pdev
->dev
, "no memory resource defined\n");
456 pc
->mmio_base
= devm_request_and_ioremap(&pdev
->dev
, r
);
458 return -EADDRNOTAVAIL
;
460 /* Acquire tbclk for Time Base EHRPWM submodule */
461 pc
->tbclk
= devm_clk_get(&pdev
->dev
, "tbclk");
462 if (IS_ERR(pc
->tbclk
)) {
463 dev_err(&pdev
->dev
, "Failed to get tbclk\n");
464 return PTR_ERR(pc
->tbclk
);
467 ret
= pwmchip_add(&pc
->chip
);
469 dev_err(&pdev
->dev
, "pwmchip_add() failed: %d\n", ret
);
473 pm_runtime_enable(&pdev
->dev
);
474 pm_runtime_get_sync(&pdev
->dev
);
476 status
= pwmss_submodule_state_change(pdev
->dev
.parent
,
478 if (!(status
& PWMSS_EPWMCLK_EN_ACK
)) {
479 dev_err(&pdev
->dev
, "PWMSS config space clock enable failed\n");
481 goto pwmss_clk_failure
;
484 pm_runtime_put_sync(&pdev
->dev
);
486 platform_set_drvdata(pdev
, pc
);
490 pm_runtime_put_sync(&pdev
->dev
);
491 pm_runtime_disable(&pdev
->dev
);
492 pwmchip_remove(&pc
->chip
);
496 static int __devexit
ehrpwm_pwm_remove(struct platform_device
*pdev
)
498 struct ehrpwm_pwm_chip
*pc
= platform_get_drvdata(pdev
);
500 pm_runtime_get_sync(&pdev
->dev
);
502 * Due to hardware misbehaviour, acknowledge of the stop_req
503 * is missing. Hence checking of the status bit skipped.
505 pwmss_submodule_state_change(pdev
->dev
.parent
, PWMSS_EPWMCLK_STOP_REQ
);
506 pm_runtime_put_sync(&pdev
->dev
);
508 pm_runtime_put_sync(&pdev
->dev
);
509 pm_runtime_disable(&pdev
->dev
);
510 return pwmchip_remove(&pc
->chip
);
513 static struct platform_driver ehrpwm_pwm_driver
= {
516 .owner
= THIS_MODULE
,
517 .of_match_table
= ehrpwm_of_match
,
519 .probe
= ehrpwm_pwm_probe
,
520 .remove
= __devexit_p(ehrpwm_pwm_remove
),
523 module_platform_driver(ehrpwm_pwm_driver
);
525 MODULE_DESCRIPTION("EHRPWM PWM driver");
526 MODULE_AUTHOR("Texas Instruments");
527 MODULE_LICENSE("GPL");