Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (C) STMicroelectronics 2016
4 *
5 * Author: Gerald Baeza <gerald.baeza@st.com>
6 *
7 * Inspired by timer-stm32.c from Maxime Coquelin
8 * pwm-atmel.c from Bo Shen
9 */
10
11#include <linux/bitfield.h>
12#include <linux/mfd/stm32-timers.h>
13#include <linux/module.h>
14#include <linux/of.h>
15#include <linux/pinctrl/consumer.h>
16#include <linux/platform_device.h>
17#include <linux/pwm.h>
18
19#define CCMR_CHANNEL_SHIFT 8
20#define CCMR_CHANNEL_MASK 0xFF
21#define MAX_BREAKINPUT 2
22
23struct stm32_breakinput {
24 u32 index;
25 u32 level;
26 u32 filter;
27};
28
29struct stm32_pwm {
30 struct pwm_chip chip;
31 struct mutex lock; /* protect pwm config/enable */
32 struct clk *clk;
33 struct regmap *regmap;
34 u32 max_arr;
35 bool have_complementary_output;
36 struct stm32_breakinput breakinputs[MAX_BREAKINPUT];
37 unsigned int num_breakinputs;
38 u32 capture[4] ____cacheline_aligned; /* DMA'able buffer */
39};
40
41static inline struct stm32_pwm *to_stm32_pwm_dev(struct pwm_chip *chip)
42{
43 return container_of(chip, struct stm32_pwm, chip);
44}
45
46static u32 active_channels(struct stm32_pwm *dev)
47{
48 u32 ccer;
49
50 regmap_read(dev->regmap, TIM_CCER, &ccer);
51
52 return ccer & TIM_CCER_CCXE;
53}
54
55static int write_ccrx(struct stm32_pwm *dev, int ch, u32 value)
56{
57 switch (ch) {
58 case 0:
59 return regmap_write(dev->regmap, TIM_CCR1, value);
60 case 1:
61 return regmap_write(dev->regmap, TIM_CCR2, value);
62 case 2:
63 return regmap_write(dev->regmap, TIM_CCR3, value);
64 case 3:
65 return regmap_write(dev->regmap, TIM_CCR4, value);
66 }
67 return -EINVAL;
68}
69
70#define TIM_CCER_CC12P (TIM_CCER_CC1P | TIM_CCER_CC2P)
71#define TIM_CCER_CC12E (TIM_CCER_CC1E | TIM_CCER_CC2E)
72#define TIM_CCER_CC34P (TIM_CCER_CC3P | TIM_CCER_CC4P)
73#define TIM_CCER_CC34E (TIM_CCER_CC3E | TIM_CCER_CC4E)
74
75/*
76 * Capture using PWM input mode:
77 * ___ ___
78 * TI[1, 2, 3 or 4]: ........._| |________|
79 * ^0 ^1 ^2
80 * . . .
81 * . . XXXXX
82 * . . XXXXX |
83 * . XXXXX . |
84 * XXXXX . . |
85 * COUNTER: ______XXXXX . . . |_XXX
86 * start^ . . . ^stop
87 * . . . .
88 * v v . v
89 * v
90 * CCR1/CCR3: tx..........t0...........t2
91 * CCR2/CCR4: tx..............t1.........
92 *
93 * DMA burst transfer: | |
94 * v v
95 * DMA buffer: { t0, tx } { t2, t1 }
96 * DMA done: ^
97 *
98 * 0: IC1/3 snapchot on rising edge: counter value -> CCR1/CCR3
99 * + DMA transfer CCR[1/3] & CCR[2/4] values (t0, tx: doesn't care)
100 * 1: IC2/4 snapchot on falling edge: counter value -> CCR2/CCR4
101 * 2: IC1/3 snapchot on rising edge: counter value -> CCR1/CCR3
102 * + DMA transfer CCR[1/3] & CCR[2/4] values (t2, t1)
103 *
104 * DMA done, compute:
105 * - Period = t2 - t0
106 * - Duty cycle = t1 - t0
107 */
108static int stm32_pwm_raw_capture(struct stm32_pwm *priv, struct pwm_device *pwm,
109 unsigned long tmo_ms, u32 *raw_prd,
110 u32 *raw_dty)
111{
112 struct device *parent = priv->chip.dev->parent;
113 enum stm32_timers_dmas dma_id;
114 u32 ccen, ccr;
115 int ret;
116
117 /* Ensure registers have been updated, enable counter and capture */
118 regmap_set_bits(priv->regmap, TIM_EGR, TIM_EGR_UG);
119 regmap_set_bits(priv->regmap, TIM_CR1, TIM_CR1_CEN);
120
121 /* Use cc1 or cc3 DMA resp for PWM input channels 1 & 2 or 3 & 4 */
122 dma_id = pwm->hwpwm < 2 ? STM32_TIMERS_DMA_CH1 : STM32_TIMERS_DMA_CH3;
123 ccen = pwm->hwpwm < 2 ? TIM_CCER_CC12E : TIM_CCER_CC34E;
124 ccr = pwm->hwpwm < 2 ? TIM_CCR1 : TIM_CCR3;
125 regmap_set_bits(priv->regmap, TIM_CCER, ccen);
126
127 /*
128 * Timer DMA burst mode. Request 2 registers, 2 bursts, to get both
129 * CCR1 & CCR2 (or CCR3 & CCR4) on each capture event.
130 * We'll get two capture snapchots: { CCR1, CCR2 }, { CCR1, CCR2 }
131 * or { CCR3, CCR4 }, { CCR3, CCR4 }
132 */
133 ret = stm32_timers_dma_burst_read(parent, priv->capture, dma_id, ccr, 2,
134 2, tmo_ms);
135 if (ret)
136 goto stop;
137
138 /* Period: t2 - t0 (take care of counter overflow) */
139 if (priv->capture[0] <= priv->capture[2])
140 *raw_prd = priv->capture[2] - priv->capture[0];
141 else
142 *raw_prd = priv->max_arr - priv->capture[0] + priv->capture[2];
143
144 /* Duty cycle capture requires at least two capture units */
145 if (pwm->chip->npwm < 2)
146 *raw_dty = 0;
147 else if (priv->capture[0] <= priv->capture[3])
148 *raw_dty = priv->capture[3] - priv->capture[0];
149 else
150 *raw_dty = priv->max_arr - priv->capture[0] + priv->capture[3];
151
152 if (*raw_dty > *raw_prd) {
153 /*
154 * Race beetween PWM input and DMA: it may happen
155 * falling edge triggers new capture on TI2/4 before DMA
156 * had a chance to read CCR2/4. It means capture[1]
157 * contains period + duty_cycle. So, subtract period.
158 */
159 *raw_dty -= *raw_prd;
160 }
161
162stop:
163 regmap_clear_bits(priv->regmap, TIM_CCER, ccen);
164 regmap_clear_bits(priv->regmap, TIM_CR1, TIM_CR1_CEN);
165
166 return ret;
167}
168
169static int stm32_pwm_capture(struct pwm_chip *chip, struct pwm_device *pwm,
170 struct pwm_capture *result, unsigned long tmo_ms)
171{
172 struct stm32_pwm *priv = to_stm32_pwm_dev(chip);
173 unsigned long long prd, div, dty;
174 unsigned long rate;
175 unsigned int psc = 0, icpsc, scale;
176 u32 raw_prd = 0, raw_dty = 0;
177 int ret = 0;
178
179 mutex_lock(&priv->lock);
180
181 if (active_channels(priv)) {
182 ret = -EBUSY;
183 goto unlock;
184 }
185
186 ret = clk_enable(priv->clk);
187 if (ret) {
188 dev_err(priv->chip.dev, "failed to enable counter clock\n");
189 goto unlock;
190 }
191
192 rate = clk_get_rate(priv->clk);
193 if (!rate) {
194 ret = -EINVAL;
195 goto clk_dis;
196 }
197
198 /* prescaler: fit timeout window provided by upper layer */
199 div = (unsigned long long)rate * (unsigned long long)tmo_ms;
200 do_div(div, MSEC_PER_SEC);
201 prd = div;
202 while ((div > priv->max_arr) && (psc < MAX_TIM_PSC)) {
203 psc++;
204 div = prd;
205 do_div(div, psc + 1);
206 }
207 regmap_write(priv->regmap, TIM_ARR, priv->max_arr);
208 regmap_write(priv->regmap, TIM_PSC, psc);
209
210 /* Map TI1 or TI2 PWM input to IC1 & IC2 (or TI3/4 to IC3 & IC4) */
211 regmap_update_bits(priv->regmap,
212 pwm->hwpwm < 2 ? TIM_CCMR1 : TIM_CCMR2,
213 TIM_CCMR_CC1S | TIM_CCMR_CC2S, pwm->hwpwm & 0x1 ?
214 TIM_CCMR_CC1S_TI2 | TIM_CCMR_CC2S_TI2 :
215 TIM_CCMR_CC1S_TI1 | TIM_CCMR_CC2S_TI1);
216
217 /* Capture period on IC1/3 rising edge, duty cycle on IC2/4 falling. */
218 regmap_update_bits(priv->regmap, TIM_CCER, pwm->hwpwm < 2 ?
219 TIM_CCER_CC12P : TIM_CCER_CC34P, pwm->hwpwm < 2 ?
220 TIM_CCER_CC2P : TIM_CCER_CC4P);
221
222 ret = stm32_pwm_raw_capture(priv, pwm, tmo_ms, &raw_prd, &raw_dty);
223 if (ret)
224 goto stop;
225
226 /*
227 * Got a capture. Try to improve accuracy at high rates:
228 * - decrease counter clock prescaler, scale up to max rate.
229 * - use input prescaler, capture once every /2 /4 or /8 edges.
230 */
231 if (raw_prd) {
232 u32 max_arr = priv->max_arr - 0x1000; /* arbitrary margin */
233
234 scale = max_arr / min(max_arr, raw_prd);
235 } else {
236 scale = priv->max_arr; /* bellow resolution, use max scale */
237 }
238
239 if (psc && scale > 1) {
240 /* 2nd measure with new scale */
241 psc /= scale;
242 regmap_write(priv->regmap, TIM_PSC, psc);
243 ret = stm32_pwm_raw_capture(priv, pwm, tmo_ms, &raw_prd,
244 &raw_dty);
245 if (ret)
246 goto stop;
247 }
248
249 /* Compute intermediate period not to exceed timeout at low rates */
250 prd = (unsigned long long)raw_prd * (psc + 1) * NSEC_PER_SEC;
251 do_div(prd, rate);
252
253 for (icpsc = 0; icpsc < MAX_TIM_ICPSC ; icpsc++) {
254 /* input prescaler: also keep arbitrary margin */
255 if (raw_prd >= (priv->max_arr - 0x1000) >> (icpsc + 1))
256 break;
257 if (prd >= (tmo_ms * NSEC_PER_MSEC) >> (icpsc + 2))
258 break;
259 }
260
261 if (!icpsc)
262 goto done;
263
264 /* Last chance to improve period accuracy, using input prescaler */
265 regmap_update_bits(priv->regmap,
266 pwm->hwpwm < 2 ? TIM_CCMR1 : TIM_CCMR2,
267 TIM_CCMR_IC1PSC | TIM_CCMR_IC2PSC,
268 FIELD_PREP(TIM_CCMR_IC1PSC, icpsc) |
269 FIELD_PREP(TIM_CCMR_IC2PSC, icpsc));
270
271 ret = stm32_pwm_raw_capture(priv, pwm, tmo_ms, &raw_prd, &raw_dty);
272 if (ret)
273 goto stop;
274
275 if (raw_dty >= (raw_prd >> icpsc)) {
276 /*
277 * We may fall here using input prescaler, when input
278 * capture starts on high side (before falling edge).
279 * Example with icpsc to capture on each 4 events:
280 *
281 * start 1st capture 2nd capture
282 * v v v
283 * ___ _____ _____ _____ _____ ____
284 * TI1..4 |__| |__| |__| |__| |__|
285 * v v . . . . . v v
286 * icpsc1/3: . 0 . 1 . 2 . 3 . 0
287 * icpsc2/4: 0 1 2 3 0
288 * v v v v
289 * CCR1/3 ......t0..............................t2
290 * CCR2/4 ..t1..............................t1'...
291 * . . .
292 * Capture0: .<----------------------------->.
293 * Capture1: .<-------------------------->. .
294 * . . .
295 * Period: .<------> . .
296 * Low side: .<>.
297 *
298 * Result:
299 * - Period = Capture0 / icpsc
300 * - Duty = Period - Low side = Period - (Capture0 - Capture1)
301 */
302 raw_dty = (raw_prd >> icpsc) - (raw_prd - raw_dty);
303 }
304
305done:
306 prd = (unsigned long long)raw_prd * (psc + 1) * NSEC_PER_SEC;
307 result->period = DIV_ROUND_UP_ULL(prd, rate << icpsc);
308 dty = (unsigned long long)raw_dty * (psc + 1) * NSEC_PER_SEC;
309 result->duty_cycle = DIV_ROUND_UP_ULL(dty, rate);
310stop:
311 regmap_write(priv->regmap, TIM_CCER, 0);
312 regmap_write(priv->regmap, pwm->hwpwm < 2 ? TIM_CCMR1 : TIM_CCMR2, 0);
313 regmap_write(priv->regmap, TIM_PSC, 0);
314clk_dis:
315 clk_disable(priv->clk);
316unlock:
317 mutex_unlock(&priv->lock);
318
319 return ret;
320}
321
322static int stm32_pwm_config(struct stm32_pwm *priv, int ch,
323 int duty_ns, int period_ns)
324{
325 unsigned long long prd, div, dty;
326 unsigned int prescaler = 0;
327 u32 ccmr, mask, shift;
328
329 /* Period and prescaler values depends on clock rate */
330 div = (unsigned long long)clk_get_rate(priv->clk) * period_ns;
331
332 do_div(div, NSEC_PER_SEC);
333 prd = div;
334
335 while (div > priv->max_arr) {
336 prescaler++;
337 div = prd;
338 do_div(div, prescaler + 1);
339 }
340
341 prd = div;
342
343 if (prescaler > MAX_TIM_PSC)
344 return -EINVAL;
345
346 /*
347 * All channels share the same prescaler and counter so when two
348 * channels are active at the same time we can't change them
349 */
350 if (active_channels(priv) & ~(1 << ch * 4)) {
351 u32 psc, arr;
352
353 regmap_read(priv->regmap, TIM_PSC, &psc);
354 regmap_read(priv->regmap, TIM_ARR, &arr);
355
356 if ((psc != prescaler) || (arr != prd - 1))
357 return -EBUSY;
358 }
359
360 regmap_write(priv->regmap, TIM_PSC, prescaler);
361 regmap_write(priv->regmap, TIM_ARR, prd - 1);
362 regmap_set_bits(priv->regmap, TIM_CR1, TIM_CR1_ARPE);
363
364 /* Calculate the duty cycles */
365 dty = prd * duty_ns;
366 do_div(dty, period_ns);
367
368 write_ccrx(priv, ch, dty);
369
370 /* Configure output mode */
371 shift = (ch & 0x1) * CCMR_CHANNEL_SHIFT;
372 ccmr = (TIM_CCMR_PE | TIM_CCMR_M1) << shift;
373 mask = CCMR_CHANNEL_MASK << shift;
374
375 if (ch < 2)
376 regmap_update_bits(priv->regmap, TIM_CCMR1, mask, ccmr);
377 else
378 regmap_update_bits(priv->regmap, TIM_CCMR2, mask, ccmr);
379
380 regmap_set_bits(priv->regmap, TIM_BDTR, TIM_BDTR_MOE);
381
382 return 0;
383}
384
385static int stm32_pwm_set_polarity(struct stm32_pwm *priv, int ch,
386 enum pwm_polarity polarity)
387{
388 u32 mask;
389
390 mask = TIM_CCER_CC1P << (ch * 4);
391 if (priv->have_complementary_output)
392 mask |= TIM_CCER_CC1NP << (ch * 4);
393
394 regmap_update_bits(priv->regmap, TIM_CCER, mask,
395 polarity == PWM_POLARITY_NORMAL ? 0 : mask);
396
397 return 0;
398}
399
400static int stm32_pwm_enable(struct stm32_pwm *priv, int ch)
401{
402 u32 mask;
403 int ret;
404
405 ret = clk_enable(priv->clk);
406 if (ret)
407 return ret;
408
409 /* Enable channel */
410 mask = TIM_CCER_CC1E << (ch * 4);
411 if (priv->have_complementary_output)
412 mask |= TIM_CCER_CC1NE << (ch * 4);
413
414 regmap_set_bits(priv->regmap, TIM_CCER, mask);
415
416 /* Make sure that registers are updated */
417 regmap_set_bits(priv->regmap, TIM_EGR, TIM_EGR_UG);
418
419 /* Enable controller */
420 regmap_set_bits(priv->regmap, TIM_CR1, TIM_CR1_CEN);
421
422 return 0;
423}
424
425static void stm32_pwm_disable(struct stm32_pwm *priv, int ch)
426{
427 u32 mask;
428
429 /* Disable channel */
430 mask = TIM_CCER_CC1E << (ch * 4);
431 if (priv->have_complementary_output)
432 mask |= TIM_CCER_CC1NE << (ch * 4);
433
434 regmap_clear_bits(priv->regmap, TIM_CCER, mask);
435
436 /* When all channels are disabled, we can disable the controller */
437 if (!active_channels(priv))
438 regmap_clear_bits(priv->regmap, TIM_CR1, TIM_CR1_CEN);
439
440 clk_disable(priv->clk);
441}
442
443static int stm32_pwm_apply(struct pwm_chip *chip, struct pwm_device *pwm,
444 const struct pwm_state *state)
445{
446 bool enabled;
447 struct stm32_pwm *priv = to_stm32_pwm_dev(chip);
448 int ret;
449
450 enabled = pwm->state.enabled;
451
452 if (enabled && !state->enabled) {
453 stm32_pwm_disable(priv, pwm->hwpwm);
454 return 0;
455 }
456
457 if (state->polarity != pwm->state.polarity)
458 stm32_pwm_set_polarity(priv, pwm->hwpwm, state->polarity);
459
460 ret = stm32_pwm_config(priv, pwm->hwpwm,
461 state->duty_cycle, state->period);
462 if (ret)
463 return ret;
464
465 if (!enabled && state->enabled)
466 ret = stm32_pwm_enable(priv, pwm->hwpwm);
467
468 return ret;
469}
470
471static int stm32_pwm_apply_locked(struct pwm_chip *chip, struct pwm_device *pwm,
472 const struct pwm_state *state)
473{
474 struct stm32_pwm *priv = to_stm32_pwm_dev(chip);
475 int ret;
476
477 /* protect common prescaler for all active channels */
478 mutex_lock(&priv->lock);
479 ret = stm32_pwm_apply(chip, pwm, state);
480 mutex_unlock(&priv->lock);
481
482 return ret;
483}
484
485static const struct pwm_ops stm32pwm_ops = {
486 .owner = THIS_MODULE,
487 .apply = stm32_pwm_apply_locked,
488 .capture = IS_ENABLED(CONFIG_DMA_ENGINE) ? stm32_pwm_capture : NULL,
489};
490
491static int stm32_pwm_set_breakinput(struct stm32_pwm *priv,
492 const struct stm32_breakinput *bi)
493{
494 u32 shift = TIM_BDTR_BKF_SHIFT(bi->index);
495 u32 bke = TIM_BDTR_BKE(bi->index);
496 u32 bkp = TIM_BDTR_BKP(bi->index);
497 u32 bkf = TIM_BDTR_BKF(bi->index);
498 u32 mask = bkf | bkp | bke;
499 u32 bdtr;
500
501 bdtr = (bi->filter & TIM_BDTR_BKF_MASK) << shift | bke;
502
503 if (bi->level)
504 bdtr |= bkp;
505
506 regmap_update_bits(priv->regmap, TIM_BDTR, mask, bdtr);
507
508 regmap_read(priv->regmap, TIM_BDTR, &bdtr);
509
510 return (bdtr & bke) ? 0 : -EINVAL;
511}
512
513static int stm32_pwm_apply_breakinputs(struct stm32_pwm *priv)
514{
515 unsigned int i;
516 int ret;
517
518 for (i = 0; i < priv->num_breakinputs; i++) {
519 ret = stm32_pwm_set_breakinput(priv, &priv->breakinputs[i]);
520 if (ret < 0)
521 return ret;
522 }
523
524 return 0;
525}
526
527static int stm32_pwm_probe_breakinputs(struct stm32_pwm *priv,
528 struct device_node *np)
529{
530 int nb, ret, array_size;
531 unsigned int i;
532
533 nb = of_property_count_elems_of_size(np, "st,breakinput",
534 sizeof(struct stm32_breakinput));
535
536 /*
537 * Because "st,breakinput" parameter is optional do not make probe
538 * failed if it doesn't exist.
539 */
540 if (nb <= 0)
541 return 0;
542
543 if (nb > MAX_BREAKINPUT)
544 return -EINVAL;
545
546 priv->num_breakinputs = nb;
547 array_size = nb * sizeof(struct stm32_breakinput) / sizeof(u32);
548 ret = of_property_read_u32_array(np, "st,breakinput",
549 (u32 *)priv->breakinputs, array_size);
550 if (ret)
551 return ret;
552
553 for (i = 0; i < priv->num_breakinputs; i++) {
554 if (priv->breakinputs[i].index > 1 ||
555 priv->breakinputs[i].level > 1 ||
556 priv->breakinputs[i].filter > 15)
557 return -EINVAL;
558 }
559
560 return stm32_pwm_apply_breakinputs(priv);
561}
562
563static void stm32_pwm_detect_complementary(struct stm32_pwm *priv)
564{
565 u32 ccer;
566
567 /*
568 * If complementary bit doesn't exist writing 1 will have no
569 * effect so we can detect it.
570 */
571 regmap_set_bits(priv->regmap, TIM_CCER, TIM_CCER_CC1NE);
572 regmap_read(priv->regmap, TIM_CCER, &ccer);
573 regmap_clear_bits(priv->regmap, TIM_CCER, TIM_CCER_CC1NE);
574
575 priv->have_complementary_output = (ccer != 0);
576}
577
578static int stm32_pwm_detect_channels(struct stm32_pwm *priv)
579{
580 u32 ccer;
581 int npwm = 0;
582
583 /*
584 * If channels enable bits don't exist writing 1 will have no
585 * effect so we can detect and count them.
586 */
587 regmap_set_bits(priv->regmap, TIM_CCER, TIM_CCER_CCXE);
588 regmap_read(priv->regmap, TIM_CCER, &ccer);
589 regmap_clear_bits(priv->regmap, TIM_CCER, TIM_CCER_CCXE);
590
591 if (ccer & TIM_CCER_CC1E)
592 npwm++;
593
594 if (ccer & TIM_CCER_CC2E)
595 npwm++;
596
597 if (ccer & TIM_CCER_CC3E)
598 npwm++;
599
600 if (ccer & TIM_CCER_CC4E)
601 npwm++;
602
603 return npwm;
604}
605
606static int stm32_pwm_probe(struct platform_device *pdev)
607{
608 struct device *dev = &pdev->dev;
609 struct device_node *np = dev->of_node;
610 struct stm32_timers *ddata = dev_get_drvdata(pdev->dev.parent);
611 struct stm32_pwm *priv;
612 int ret;
613
614 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
615 if (!priv)
616 return -ENOMEM;
617
618 mutex_init(&priv->lock);
619 priv->regmap = ddata->regmap;
620 priv->clk = ddata->clk;
621 priv->max_arr = ddata->max_arr;
622
623 if (!priv->regmap || !priv->clk)
624 return -EINVAL;
625
626 ret = stm32_pwm_probe_breakinputs(priv, np);
627 if (ret)
628 return ret;
629
630 stm32_pwm_detect_complementary(priv);
631
632 priv->chip.dev = dev;
633 priv->chip.ops = &stm32pwm_ops;
634 priv->chip.npwm = stm32_pwm_detect_channels(priv);
635
636 ret = pwmchip_add(&priv->chip);
637 if (ret < 0)
638 return ret;
639
640 platform_set_drvdata(pdev, priv);
641
642 return 0;
643}
644
645static int stm32_pwm_remove(struct platform_device *pdev)
646{
647 struct stm32_pwm *priv = platform_get_drvdata(pdev);
648 unsigned int i;
649
650 for (i = 0; i < priv->chip.npwm; i++)
651 pwm_disable(&priv->chip.pwms[i]);
652
653 pwmchip_remove(&priv->chip);
654
655 return 0;
656}
657
658static int __maybe_unused stm32_pwm_suspend(struct device *dev)
659{
660 struct stm32_pwm *priv = dev_get_drvdata(dev);
661 unsigned int i;
662 u32 ccer, mask;
663
664 /* Look for active channels */
665 ccer = active_channels(priv);
666
667 for (i = 0; i < priv->chip.npwm; i++) {
668 mask = TIM_CCER_CC1E << (i * 4);
669 if (ccer & mask) {
670 dev_err(dev, "PWM %u still in use by consumer %s\n",
671 i, priv->chip.pwms[i].label);
672 return -EBUSY;
673 }
674 }
675
676 return pinctrl_pm_select_sleep_state(dev);
677}
678
679static int __maybe_unused stm32_pwm_resume(struct device *dev)
680{
681 struct stm32_pwm *priv = dev_get_drvdata(dev);
682 int ret;
683
684 ret = pinctrl_pm_select_default_state(dev);
685 if (ret)
686 return ret;
687
688 /* restore breakinput registers that may have been lost in low power */
689 return stm32_pwm_apply_breakinputs(priv);
690}
691
692static SIMPLE_DEV_PM_OPS(stm32_pwm_pm_ops, stm32_pwm_suspend, stm32_pwm_resume);
693
694static const struct of_device_id stm32_pwm_of_match[] = {
695 { .compatible = "st,stm32-pwm", },
696 { /* end node */ },
697};
698MODULE_DEVICE_TABLE(of, stm32_pwm_of_match);
699
700static struct platform_driver stm32_pwm_driver = {
701 .probe = stm32_pwm_probe,
702 .remove = stm32_pwm_remove,
703 .driver = {
704 .name = "stm32-pwm",
705 .of_match_table = stm32_pwm_of_match,
706 .pm = &stm32_pwm_pm_ops,
707 },
708};
709module_platform_driver(stm32_pwm_driver);
710
711MODULE_ALIAS("platform:stm32-pwm");
712MODULE_DESCRIPTION("STMicroelectronics STM32 PWM driver");
713MODULE_LICENSE("GPL v2");
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Copyright (C) STMicroelectronics 2016
4 *
5 * Author: Gerald Baeza <gerald.baeza@st.com>
6 *
7 * Inspired by timer-stm32.c from Maxime Coquelin
8 * pwm-atmel.c from Bo Shen
9 */
10
11#include <linux/mfd/stm32-timers.h>
12#include <linux/module.h>
13#include <linux/of.h>
14#include <linux/platform_device.h>
15#include <linux/pwm.h>
16
17#define CCMR_CHANNEL_SHIFT 8
18#define CCMR_CHANNEL_MASK 0xFF
19#define MAX_BREAKINPUT 2
20
21struct stm32_pwm {
22 struct pwm_chip chip;
23 struct mutex lock; /* protect pwm config/enable */
24 struct clk *clk;
25 struct regmap *regmap;
26 u32 max_arr;
27 bool have_complementary_output;
28};
29
30struct stm32_breakinput {
31 u32 index;
32 u32 level;
33 u32 filter;
34};
35
36static inline struct stm32_pwm *to_stm32_pwm_dev(struct pwm_chip *chip)
37{
38 return container_of(chip, struct stm32_pwm, chip);
39}
40
41static u32 active_channels(struct stm32_pwm *dev)
42{
43 u32 ccer;
44
45 regmap_read(dev->regmap, TIM_CCER, &ccer);
46
47 return ccer & TIM_CCER_CCXE;
48}
49
50static int write_ccrx(struct stm32_pwm *dev, int ch, u32 value)
51{
52 switch (ch) {
53 case 0:
54 return regmap_write(dev->regmap, TIM_CCR1, value);
55 case 1:
56 return regmap_write(dev->regmap, TIM_CCR2, value);
57 case 2:
58 return regmap_write(dev->regmap, TIM_CCR3, value);
59 case 3:
60 return regmap_write(dev->regmap, TIM_CCR4, value);
61 }
62 return -EINVAL;
63}
64
65static int stm32_pwm_config(struct stm32_pwm *priv, int ch,
66 int duty_ns, int period_ns)
67{
68 unsigned long long prd, div, dty;
69 unsigned int prescaler = 0;
70 u32 ccmr, mask, shift;
71
72 /* Period and prescaler values depends on clock rate */
73 div = (unsigned long long)clk_get_rate(priv->clk) * period_ns;
74
75 do_div(div, NSEC_PER_SEC);
76 prd = div;
77
78 while (div > priv->max_arr) {
79 prescaler++;
80 div = prd;
81 do_div(div, prescaler + 1);
82 }
83
84 prd = div;
85
86 if (prescaler > MAX_TIM_PSC)
87 return -EINVAL;
88
89 /*
90 * All channels share the same prescaler and counter so when two
91 * channels are active at the same time we can't change them
92 */
93 if (active_channels(priv) & ~(1 << ch * 4)) {
94 u32 psc, arr;
95
96 regmap_read(priv->regmap, TIM_PSC, &psc);
97 regmap_read(priv->regmap, TIM_ARR, &arr);
98
99 if ((psc != prescaler) || (arr != prd - 1))
100 return -EBUSY;
101 }
102
103 regmap_write(priv->regmap, TIM_PSC, prescaler);
104 regmap_write(priv->regmap, TIM_ARR, prd - 1);
105 regmap_update_bits(priv->regmap, TIM_CR1, TIM_CR1_ARPE, TIM_CR1_ARPE);
106
107 /* Calculate the duty cycles */
108 dty = prd * duty_ns;
109 do_div(dty, period_ns);
110
111 write_ccrx(priv, ch, dty);
112
113 /* Configure output mode */
114 shift = (ch & 0x1) * CCMR_CHANNEL_SHIFT;
115 ccmr = (TIM_CCMR_PE | TIM_CCMR_M1) << shift;
116 mask = CCMR_CHANNEL_MASK << shift;
117
118 if (ch < 2)
119 regmap_update_bits(priv->regmap, TIM_CCMR1, mask, ccmr);
120 else
121 regmap_update_bits(priv->regmap, TIM_CCMR2, mask, ccmr);
122
123 regmap_update_bits(priv->regmap, TIM_BDTR,
124 TIM_BDTR_MOE | TIM_BDTR_AOE,
125 TIM_BDTR_MOE | TIM_BDTR_AOE);
126
127 return 0;
128}
129
130static int stm32_pwm_set_polarity(struct stm32_pwm *priv, int ch,
131 enum pwm_polarity polarity)
132{
133 u32 mask;
134
135 mask = TIM_CCER_CC1P << (ch * 4);
136 if (priv->have_complementary_output)
137 mask |= TIM_CCER_CC1NP << (ch * 4);
138
139 regmap_update_bits(priv->regmap, TIM_CCER, mask,
140 polarity == PWM_POLARITY_NORMAL ? 0 : mask);
141
142 return 0;
143}
144
145static int stm32_pwm_enable(struct stm32_pwm *priv, int ch)
146{
147 u32 mask;
148 int ret;
149
150 ret = clk_enable(priv->clk);
151 if (ret)
152 return ret;
153
154 /* Enable channel */
155 mask = TIM_CCER_CC1E << (ch * 4);
156 if (priv->have_complementary_output)
157 mask |= TIM_CCER_CC1NE << (ch * 4);
158
159 regmap_update_bits(priv->regmap, TIM_CCER, mask, mask);
160
161 /* Make sure that registers are updated */
162 regmap_update_bits(priv->regmap, TIM_EGR, TIM_EGR_UG, TIM_EGR_UG);
163
164 /* Enable controller */
165 regmap_update_bits(priv->regmap, TIM_CR1, TIM_CR1_CEN, TIM_CR1_CEN);
166
167 return 0;
168}
169
170static void stm32_pwm_disable(struct stm32_pwm *priv, int ch)
171{
172 u32 mask;
173
174 /* Disable channel */
175 mask = TIM_CCER_CC1E << (ch * 4);
176 if (priv->have_complementary_output)
177 mask |= TIM_CCER_CC1NE << (ch * 4);
178
179 regmap_update_bits(priv->regmap, TIM_CCER, mask, 0);
180
181 /* When all channels are disabled, we can disable the controller */
182 if (!active_channels(priv))
183 regmap_update_bits(priv->regmap, TIM_CR1, TIM_CR1_CEN, 0);
184
185 clk_disable(priv->clk);
186}
187
188static int stm32_pwm_apply(struct pwm_chip *chip, struct pwm_device *pwm,
189 struct pwm_state *state)
190{
191 bool enabled;
192 struct stm32_pwm *priv = to_stm32_pwm_dev(chip);
193 int ret;
194
195 enabled = pwm->state.enabled;
196
197 if (enabled && !state->enabled) {
198 stm32_pwm_disable(priv, pwm->hwpwm);
199 return 0;
200 }
201
202 if (state->polarity != pwm->state.polarity)
203 stm32_pwm_set_polarity(priv, pwm->hwpwm, state->polarity);
204
205 ret = stm32_pwm_config(priv, pwm->hwpwm,
206 state->duty_cycle, state->period);
207 if (ret)
208 return ret;
209
210 if (!enabled && state->enabled)
211 ret = stm32_pwm_enable(priv, pwm->hwpwm);
212
213 return ret;
214}
215
216static int stm32_pwm_apply_locked(struct pwm_chip *chip, struct pwm_device *pwm,
217 struct pwm_state *state)
218{
219 struct stm32_pwm *priv = to_stm32_pwm_dev(chip);
220 int ret;
221
222 /* protect common prescaler for all active channels */
223 mutex_lock(&priv->lock);
224 ret = stm32_pwm_apply(chip, pwm, state);
225 mutex_unlock(&priv->lock);
226
227 return ret;
228}
229
230static const struct pwm_ops stm32pwm_ops = {
231 .owner = THIS_MODULE,
232 .apply = stm32_pwm_apply_locked,
233};
234
235static int stm32_pwm_set_breakinput(struct stm32_pwm *priv,
236 int index, int level, int filter)
237{
238 u32 bke = (index == 0) ? TIM_BDTR_BKE : TIM_BDTR_BK2E;
239 int shift = (index == 0) ? TIM_BDTR_BKF_SHIFT : TIM_BDTR_BK2F_SHIFT;
240 u32 mask = (index == 0) ? TIM_BDTR_BKE | TIM_BDTR_BKP | TIM_BDTR_BKF
241 : TIM_BDTR_BK2E | TIM_BDTR_BK2P | TIM_BDTR_BK2F;
242 u32 bdtr = bke;
243
244 /*
245 * The both bits could be set since only one will be wrote
246 * due to mask value.
247 */
248 if (level)
249 bdtr |= TIM_BDTR_BKP | TIM_BDTR_BK2P;
250
251 bdtr |= (filter & TIM_BDTR_BKF_MASK) << shift;
252
253 regmap_update_bits(priv->regmap, TIM_BDTR, mask, bdtr);
254
255 regmap_read(priv->regmap, TIM_BDTR, &bdtr);
256
257 return (bdtr & bke) ? 0 : -EINVAL;
258}
259
260static int stm32_pwm_apply_breakinputs(struct stm32_pwm *priv,
261 struct device_node *np)
262{
263 struct stm32_breakinput breakinput[MAX_BREAKINPUT];
264 int nb, ret, i, array_size;
265
266 nb = of_property_count_elems_of_size(np, "st,breakinput",
267 sizeof(struct stm32_breakinput));
268
269 /*
270 * Because "st,breakinput" parameter is optional do not make probe
271 * failed if it doesn't exist.
272 */
273 if (nb <= 0)
274 return 0;
275
276 if (nb > MAX_BREAKINPUT)
277 return -EINVAL;
278
279 array_size = nb * sizeof(struct stm32_breakinput) / sizeof(u32);
280 ret = of_property_read_u32_array(np, "st,breakinput",
281 (u32 *)breakinput, array_size);
282 if (ret)
283 return ret;
284
285 for (i = 0; i < nb && !ret; i++) {
286 ret = stm32_pwm_set_breakinput(priv,
287 breakinput[i].index,
288 breakinput[i].level,
289 breakinput[i].filter);
290 }
291
292 return ret;
293}
294
295static void stm32_pwm_detect_complementary(struct stm32_pwm *priv)
296{
297 u32 ccer;
298
299 /*
300 * If complementary bit doesn't exist writing 1 will have no
301 * effect so we can detect it.
302 */
303 regmap_update_bits(priv->regmap,
304 TIM_CCER, TIM_CCER_CC1NE, TIM_CCER_CC1NE);
305 regmap_read(priv->regmap, TIM_CCER, &ccer);
306 regmap_update_bits(priv->regmap, TIM_CCER, TIM_CCER_CC1NE, 0);
307
308 priv->have_complementary_output = (ccer != 0);
309}
310
311static int stm32_pwm_detect_channels(struct stm32_pwm *priv)
312{
313 u32 ccer;
314 int npwm = 0;
315
316 /*
317 * If channels enable bits don't exist writing 1 will have no
318 * effect so we can detect and count them.
319 */
320 regmap_update_bits(priv->regmap,
321 TIM_CCER, TIM_CCER_CCXE, TIM_CCER_CCXE);
322 regmap_read(priv->regmap, TIM_CCER, &ccer);
323 regmap_update_bits(priv->regmap, TIM_CCER, TIM_CCER_CCXE, 0);
324
325 if (ccer & TIM_CCER_CC1E)
326 npwm++;
327
328 if (ccer & TIM_CCER_CC2E)
329 npwm++;
330
331 if (ccer & TIM_CCER_CC3E)
332 npwm++;
333
334 if (ccer & TIM_CCER_CC4E)
335 npwm++;
336
337 return npwm;
338}
339
340static int stm32_pwm_probe(struct platform_device *pdev)
341{
342 struct device *dev = &pdev->dev;
343 struct device_node *np = dev->of_node;
344 struct stm32_timers *ddata = dev_get_drvdata(pdev->dev.parent);
345 struct stm32_pwm *priv;
346 int ret;
347
348 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
349 if (!priv)
350 return -ENOMEM;
351
352 mutex_init(&priv->lock);
353 priv->regmap = ddata->regmap;
354 priv->clk = ddata->clk;
355 priv->max_arr = ddata->max_arr;
356
357 if (!priv->regmap || !priv->clk)
358 return -EINVAL;
359
360 ret = stm32_pwm_apply_breakinputs(priv, np);
361 if (ret)
362 return ret;
363
364 stm32_pwm_detect_complementary(priv);
365
366 priv->chip.base = -1;
367 priv->chip.dev = dev;
368 priv->chip.ops = &stm32pwm_ops;
369 priv->chip.npwm = stm32_pwm_detect_channels(priv);
370
371 ret = pwmchip_add(&priv->chip);
372 if (ret < 0)
373 return ret;
374
375 platform_set_drvdata(pdev, priv);
376
377 return 0;
378}
379
380static int stm32_pwm_remove(struct platform_device *pdev)
381{
382 struct stm32_pwm *priv = platform_get_drvdata(pdev);
383 unsigned int i;
384
385 for (i = 0; i < priv->chip.npwm; i++)
386 pwm_disable(&priv->chip.pwms[i]);
387
388 pwmchip_remove(&priv->chip);
389
390 return 0;
391}
392
393static const struct of_device_id stm32_pwm_of_match[] = {
394 { .compatible = "st,stm32-pwm", },
395 { /* end node */ },
396};
397MODULE_DEVICE_TABLE(of, stm32_pwm_of_match);
398
399static struct platform_driver stm32_pwm_driver = {
400 .probe = stm32_pwm_probe,
401 .remove = stm32_pwm_remove,
402 .driver = {
403 .name = "stm32-pwm",
404 .of_match_table = stm32_pwm_of_match,
405 },
406};
407module_platform_driver(stm32_pwm_driver);
408
409MODULE_ALIAS("platform:stm32-pwm");
410MODULE_DESCRIPTION("STMicroelectronics STM32 PWM driver");
411MODULE_LICENSE("GPL v2");