1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) STMicroelectronics 2016
5 * Author: Benjamin Gaignard <benjamin.gaignard@st.com>
9 #include <linux/iio/iio.h>
10 #include <linux/iio/sysfs.h>
11 #include <linux/iio/timer/stm32-timer-trigger.h>
12 #include <linux/iio/trigger.h>
13 #include <linux/mfd/stm32-timers.h>
14 #include <linux/module.h>
15 #include <linux/platform_device.h>
16 #include <linux/of_device.h>
18 #define MAX_TRIGGERS 7
21 /* List the triggers created by each timer */
22 static const void *triggers_table[][MAX_TRIGGERS] = {
23 { TIM1_TRGO, TIM1_TRGO2, TIM1_CH1, TIM1_CH2, TIM1_CH3, TIM1_CH4,},
24 { TIM2_TRGO, TIM2_CH1, TIM2_CH2, TIM2_CH3, TIM2_CH4,},
25 { TIM3_TRGO, TIM3_CH1, TIM3_CH2, TIM3_CH3, TIM3_CH4,},
26 { TIM4_TRGO, TIM4_CH1, TIM4_CH2, TIM4_CH3, TIM4_CH4,},
27 { TIM5_TRGO, TIM5_CH1, TIM5_CH2, TIM5_CH3, TIM5_CH4,},
30 { TIM8_TRGO, TIM8_TRGO2, TIM8_CH1, TIM8_CH2, TIM8_CH3, TIM8_CH4,},
31 { TIM9_TRGO, TIM9_CH1, TIM9_CH2,},
34 { TIM12_TRGO, TIM12_CH1, TIM12_CH2,},
42 /* List the triggers accepted by each timer */
43 static const void *valids_table[][MAX_VALIDS] = {
44 { TIM5_TRGO, TIM2_TRGO, TIM3_TRGO, TIM4_TRGO,},
45 { TIM1_TRGO, TIM8_TRGO, TIM3_TRGO, TIM4_TRGO,},
46 { TIM1_TRGO, TIM2_TRGO, TIM5_TRGO, TIM4_TRGO,},
47 { TIM1_TRGO, TIM2_TRGO, TIM3_TRGO, TIM8_TRGO,},
48 { TIM2_TRGO, TIM3_TRGO, TIM4_TRGO, TIM8_TRGO,},
51 { TIM1_TRGO, TIM2_TRGO, TIM4_TRGO, TIM5_TRGO,},
52 { TIM2_TRGO, TIM3_TRGO, TIM10_OC1, TIM11_OC1,},
55 { TIM4_TRGO, TIM5_TRGO, TIM13_OC1, TIM14_OC1,},
58 static const void *stm32h7_valids_table[][MAX_VALIDS] = {
59 { TIM15_TRGO, TIM2_TRGO, TIM3_TRGO, TIM4_TRGO,},
60 { TIM1_TRGO, TIM8_TRGO, TIM3_TRGO, TIM4_TRGO,},
61 { TIM1_TRGO, TIM2_TRGO, TIM15_TRGO, TIM4_TRGO,},
62 { TIM1_TRGO, TIM2_TRGO, TIM3_TRGO, TIM8_TRGO,},
63 { TIM1_TRGO, TIM8_TRGO, TIM3_TRGO, TIM4_TRGO,},
66 { TIM1_TRGO, TIM2_TRGO, TIM4_TRGO, TIM5_TRGO,},
70 { TIM4_TRGO, TIM5_TRGO, TIM13_OC1, TIM14_OC1,},
73 { TIM1_TRGO, TIM3_TRGO, TIM16_OC1, TIM17_OC1,},
78 struct stm32_timer_trigger {
80 struct regmap *regmap;
88 struct stm32_timer_trigger_cfg {
89 const void *(*valids_table)[MAX_VALIDS];
90 const unsigned int num_valids_table;
93 static bool stm32_timer_is_trgo2_name(const char *name)
95 return !!strstr(name, "trgo2");
98 static bool stm32_timer_is_trgo_name(const char *name)
100 return (!!strstr(name, "trgo") && !strstr(name, "trgo2"));
103 static int stm32_timer_start(struct stm32_timer_trigger *priv,
104 struct iio_trigger *trig,
105 unsigned int frequency)
107 unsigned long long prd, div;
111 /* Period and prescaler values depends of clock rate */
112 div = (unsigned long long)clk_get_rate(priv->clk);
114 do_div(div, frequency);
119 * Increase prescaler value until we get a result that fit
120 * with auto reload register maximum value.
122 while (div > priv->max_arr) {
125 do_div(div, (prescaler + 1));
129 if (prescaler > MAX_TIM_PSC) {
130 dev_err(priv->dev, "prescaler exceeds the maximum value\n");
134 /* Check if nobody else use the timer */
135 regmap_read(priv->regmap, TIM_CCER, &ccer);
136 if (ccer & TIM_CCER_CCXE)
139 regmap_read(priv->regmap, TIM_CR1, &cr1);
140 if (!(cr1 & TIM_CR1_CEN))
141 clk_enable(priv->clk);
143 regmap_write(priv->regmap, TIM_PSC, prescaler);
144 regmap_write(priv->regmap, TIM_ARR, prd - 1);
145 regmap_update_bits(priv->regmap, TIM_CR1, TIM_CR1_ARPE, TIM_CR1_ARPE);
147 /* Force master mode to update mode */
148 if (stm32_timer_is_trgo2_name(trig->name))
149 regmap_update_bits(priv->regmap, TIM_CR2, TIM_CR2_MMS2,
150 0x2 << TIM_CR2_MMS2_SHIFT);
152 regmap_update_bits(priv->regmap, TIM_CR2, TIM_CR2_MMS,
153 0x2 << TIM_CR2_MMS_SHIFT);
155 /* Make sure that registers are updated */
156 regmap_update_bits(priv->regmap, TIM_EGR, TIM_EGR_UG, TIM_EGR_UG);
158 /* Enable controller */
159 regmap_update_bits(priv->regmap, TIM_CR1, TIM_CR1_CEN, TIM_CR1_CEN);
164 static void stm32_timer_stop(struct stm32_timer_trigger *priv)
168 regmap_read(priv->regmap, TIM_CCER, &ccer);
169 if (ccer & TIM_CCER_CCXE)
172 regmap_read(priv->regmap, TIM_CR1, &cr1);
173 if (cr1 & TIM_CR1_CEN)
174 clk_disable(priv->clk);
177 regmap_update_bits(priv->regmap, TIM_CR1, TIM_CR1_ARPE, 0);
178 regmap_update_bits(priv->regmap, TIM_CR1, TIM_CR1_CEN, 0);
179 regmap_write(priv->regmap, TIM_PSC, 0);
180 regmap_write(priv->regmap, TIM_ARR, 0);
182 /* Make sure that registers are updated */
183 regmap_update_bits(priv->regmap, TIM_EGR, TIM_EGR_UG, TIM_EGR_UG);
186 static ssize_t stm32_tt_store_frequency(struct device *dev,
187 struct device_attribute *attr,
188 const char *buf, size_t len)
190 struct iio_trigger *trig = to_iio_trigger(dev);
191 struct stm32_timer_trigger *priv = iio_trigger_get_drvdata(trig);
195 ret = kstrtouint(buf, 10, &freq);
200 stm32_timer_stop(priv);
202 ret = stm32_timer_start(priv, trig, freq);
210 static ssize_t stm32_tt_read_frequency(struct device *dev,
211 struct device_attribute *attr, char *buf)
213 struct iio_trigger *trig = to_iio_trigger(dev);
214 struct stm32_timer_trigger *priv = iio_trigger_get_drvdata(trig);
216 unsigned long long freq = 0;
218 regmap_read(priv->regmap, TIM_CR1, &cr1);
219 regmap_read(priv->regmap, TIM_PSC, &psc);
220 regmap_read(priv->regmap, TIM_ARR, &arr);
222 if (cr1 & TIM_CR1_CEN) {
223 freq = (unsigned long long)clk_get_rate(priv->clk);
224 do_div(freq, psc + 1);
225 do_div(freq, arr + 1);
228 return sprintf(buf, "%d\n", (unsigned int)freq);
231 static IIO_DEV_ATTR_SAMP_FREQ(0660,
232 stm32_tt_read_frequency,
233 stm32_tt_store_frequency);
235 #define MASTER_MODE_MAX 7
236 #define MASTER_MODE2_MAX 15
238 static char *master_mode_table[] = {
247 /* Master mode selection 2 only */
250 "compare_pulse_OC4REF",
251 "compare_pulse_OC6REF",
252 "compare_pulse_OC4REF_r_or_OC6REF_r",
253 "compare_pulse_OC4REF_r_or_OC6REF_f",
254 "compare_pulse_OC5REF_r_or_OC6REF_r",
255 "compare_pulse_OC5REF_r_or_OC6REF_f",
258 static ssize_t stm32_tt_show_master_mode(struct device *dev,
259 struct device_attribute *attr,
262 struct stm32_timer_trigger *priv = dev_get_drvdata(dev);
263 struct iio_trigger *trig = to_iio_trigger(dev);
266 regmap_read(priv->regmap, TIM_CR2, &cr2);
268 if (stm32_timer_is_trgo2_name(trig->name))
269 cr2 = (cr2 & TIM_CR2_MMS2) >> TIM_CR2_MMS2_SHIFT;
271 cr2 = (cr2 & TIM_CR2_MMS) >> TIM_CR2_MMS_SHIFT;
273 return snprintf(buf, PAGE_SIZE, "%s\n", master_mode_table[cr2]);
276 static ssize_t stm32_tt_store_master_mode(struct device *dev,
277 struct device_attribute *attr,
278 const char *buf, size_t len)
280 struct stm32_timer_trigger *priv = dev_get_drvdata(dev);
281 struct iio_trigger *trig = to_iio_trigger(dev);
282 u32 mask, shift, master_mode_max;
285 if (stm32_timer_is_trgo2_name(trig->name)) {
287 shift = TIM_CR2_MMS2_SHIFT;
288 master_mode_max = MASTER_MODE2_MAX;
291 shift = TIM_CR2_MMS_SHIFT;
292 master_mode_max = MASTER_MODE_MAX;
295 for (i = 0; i <= master_mode_max; i++) {
296 if (!strncmp(master_mode_table[i], buf,
297 strlen(master_mode_table[i]))) {
298 regmap_update_bits(priv->regmap, TIM_CR2, mask,
300 /* Make sure that registers are updated */
301 regmap_update_bits(priv->regmap, TIM_EGR,
302 TIM_EGR_UG, TIM_EGR_UG);
310 static ssize_t stm32_tt_show_master_mode_avail(struct device *dev,
311 struct device_attribute *attr,
314 struct iio_trigger *trig = to_iio_trigger(dev);
315 unsigned int i, master_mode_max;
318 if (stm32_timer_is_trgo2_name(trig->name))
319 master_mode_max = MASTER_MODE2_MAX;
321 master_mode_max = MASTER_MODE_MAX;
323 for (i = 0; i <= master_mode_max; i++)
324 len += scnprintf(buf + len, PAGE_SIZE - len,
325 "%s ", master_mode_table[i]);
327 /* replace trailing space by newline */
333 static IIO_DEVICE_ATTR(master_mode_available, 0444,
334 stm32_tt_show_master_mode_avail, NULL, 0);
336 static IIO_DEVICE_ATTR(master_mode, 0660,
337 stm32_tt_show_master_mode,
338 stm32_tt_store_master_mode,
341 static struct attribute *stm32_trigger_attrs[] = {
342 &iio_dev_attr_sampling_frequency.dev_attr.attr,
343 &iio_dev_attr_master_mode.dev_attr.attr,
344 &iio_dev_attr_master_mode_available.dev_attr.attr,
348 static const struct attribute_group stm32_trigger_attr_group = {
349 .attrs = stm32_trigger_attrs,
352 static const struct attribute_group *stm32_trigger_attr_groups[] = {
353 &stm32_trigger_attr_group,
357 static const struct iio_trigger_ops timer_trigger_ops = {
360 static int stm32_setup_iio_triggers(struct stm32_timer_trigger *priv)
363 const char * const *cur = priv->triggers;
365 while (cur && *cur) {
366 struct iio_trigger *trig;
367 bool cur_is_trgo = stm32_timer_is_trgo_name(*cur);
368 bool cur_is_trgo2 = stm32_timer_is_trgo2_name(*cur);
370 if (cur_is_trgo2 && !priv->has_trgo2) {
375 trig = devm_iio_trigger_alloc(priv->dev, "%s", *cur);
379 trig->dev.parent = priv->dev->parent;
380 trig->ops = &timer_trigger_ops;
383 * sampling frequency and master mode attributes
384 * should only be available on trgo/trgo2 triggers
386 if (cur_is_trgo || cur_is_trgo2)
387 trig->dev.groups = stm32_trigger_attr_groups;
389 iio_trigger_set_drvdata(trig, priv);
391 ret = devm_iio_trigger_register(priv->dev, trig);
400 static int stm32_counter_read_raw(struct iio_dev *indio_dev,
401 struct iio_chan_spec const *chan,
402 int *val, int *val2, long mask)
404 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
408 case IIO_CHAN_INFO_RAW:
409 regmap_read(priv->regmap, TIM_CNT, &dat);
413 case IIO_CHAN_INFO_ENABLE:
414 regmap_read(priv->regmap, TIM_CR1, &dat);
415 *val = (dat & TIM_CR1_CEN) ? 1 : 0;
418 case IIO_CHAN_INFO_SCALE:
419 regmap_read(priv->regmap, TIM_SMCR, &dat);
425 /* in quadrature case scale = 0.25 */
429 return IIO_VAL_FRACTIONAL_LOG2;
435 static int stm32_counter_write_raw(struct iio_dev *indio_dev,
436 struct iio_chan_spec const *chan,
437 int val, int val2, long mask)
439 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
443 case IIO_CHAN_INFO_RAW:
444 return regmap_write(priv->regmap, TIM_CNT, val);
446 case IIO_CHAN_INFO_SCALE:
450 case IIO_CHAN_INFO_ENABLE:
452 regmap_read(priv->regmap, TIM_CR1, &dat);
453 if (!(dat & TIM_CR1_CEN))
454 clk_enable(priv->clk);
455 regmap_update_bits(priv->regmap, TIM_CR1, TIM_CR1_CEN,
458 regmap_read(priv->regmap, TIM_CR1, &dat);
459 regmap_update_bits(priv->regmap, TIM_CR1, TIM_CR1_CEN,
461 if (dat & TIM_CR1_CEN)
462 clk_disable(priv->clk);
470 static int stm32_counter_validate_trigger(struct iio_dev *indio_dev,
471 struct iio_trigger *trig)
473 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
474 const char * const *cur = priv->valids;
477 if (!is_stm32_timer_trigger(trig))
480 while (cur && *cur) {
481 if (!strncmp(trig->name, *cur, strlen(trig->name))) {
482 regmap_update_bits(priv->regmap,
483 TIM_SMCR, TIM_SMCR_TS,
484 i << TIM_SMCR_TS_SHIFT);
494 static const struct iio_info stm32_trigger_info = {
495 .validate_trigger = stm32_counter_validate_trigger,
496 .read_raw = stm32_counter_read_raw,
497 .write_raw = stm32_counter_write_raw
500 static const char *const stm32_trigger_modes[] = {
504 static int stm32_set_trigger_mode(struct iio_dev *indio_dev,
505 const struct iio_chan_spec *chan,
508 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
510 regmap_update_bits(priv->regmap, TIM_SMCR, TIM_SMCR_SMS, TIM_SMCR_SMS);
515 static int stm32_get_trigger_mode(struct iio_dev *indio_dev,
516 const struct iio_chan_spec *chan)
518 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
521 regmap_read(priv->regmap, TIM_SMCR, &smcr);
523 return (smcr & TIM_SMCR_SMS) == TIM_SMCR_SMS ? 0 : -EINVAL;
526 static const struct iio_enum stm32_trigger_mode_enum = {
527 .items = stm32_trigger_modes,
528 .num_items = ARRAY_SIZE(stm32_trigger_modes),
529 .set = stm32_set_trigger_mode,
530 .get = stm32_get_trigger_mode
533 static const char *const stm32_enable_modes[] = {
539 static int stm32_enable_mode2sms(int mode)
553 static int stm32_set_enable_mode(struct iio_dev *indio_dev,
554 const struct iio_chan_spec *chan,
557 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
558 int sms = stm32_enable_mode2sms(mode);
564 * Triggered mode sets CEN bit automatically by hardware. So, first
565 * enable counter clock, so it can use it. Keeps it in sync with CEN.
568 regmap_read(priv->regmap, TIM_CR1, &val);
569 if (!(val & TIM_CR1_CEN))
570 clk_enable(priv->clk);
573 regmap_update_bits(priv->regmap, TIM_SMCR, TIM_SMCR_SMS, sms);
578 static int stm32_sms2enable_mode(int mode)
592 static int stm32_get_enable_mode(struct iio_dev *indio_dev,
593 const struct iio_chan_spec *chan)
595 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
598 regmap_read(priv->regmap, TIM_SMCR, &smcr);
599 smcr &= TIM_SMCR_SMS;
601 return stm32_sms2enable_mode(smcr);
604 static const struct iio_enum stm32_enable_mode_enum = {
605 .items = stm32_enable_modes,
606 .num_items = ARRAY_SIZE(stm32_enable_modes),
607 .set = stm32_set_enable_mode,
608 .get = stm32_get_enable_mode
611 static ssize_t stm32_count_get_preset(struct iio_dev *indio_dev,
613 const struct iio_chan_spec *chan,
616 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
619 regmap_read(priv->regmap, TIM_ARR, &arr);
621 return snprintf(buf, PAGE_SIZE, "%u\n", arr);
624 static ssize_t stm32_count_set_preset(struct iio_dev *indio_dev,
626 const struct iio_chan_spec *chan,
627 const char *buf, size_t len)
629 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
633 ret = kstrtouint(buf, 0, &preset);
637 /* TIMx_ARR register shouldn't be buffered (ARPE=0) */
638 regmap_update_bits(priv->regmap, TIM_CR1, TIM_CR1_ARPE, 0);
639 regmap_write(priv->regmap, TIM_ARR, preset);
644 static const struct iio_chan_spec_ext_info stm32_trigger_count_info[] = {
647 .shared = IIO_SEPARATE,
648 .read = stm32_count_get_preset,
649 .write = stm32_count_set_preset
651 IIO_ENUM("enable_mode", IIO_SEPARATE, &stm32_enable_mode_enum),
652 IIO_ENUM_AVAILABLE("enable_mode", &stm32_enable_mode_enum),
653 IIO_ENUM("trigger_mode", IIO_SEPARATE, &stm32_trigger_mode_enum),
654 IIO_ENUM_AVAILABLE("trigger_mode", &stm32_trigger_mode_enum),
658 static const struct iio_chan_spec stm32_trigger_channel = {
661 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
662 BIT(IIO_CHAN_INFO_ENABLE) |
663 BIT(IIO_CHAN_INFO_SCALE),
664 .ext_info = stm32_trigger_count_info,
668 static struct stm32_timer_trigger *stm32_setup_counter_device(struct device *dev)
670 struct iio_dev *indio_dev;
673 indio_dev = devm_iio_device_alloc(dev,
674 sizeof(struct stm32_timer_trigger));
678 indio_dev->name = dev_name(dev);
679 indio_dev->dev.parent = dev;
680 indio_dev->info = &stm32_trigger_info;
681 indio_dev->modes = INDIO_HARDWARE_TRIGGERED;
682 indio_dev->num_channels = 1;
683 indio_dev->channels = &stm32_trigger_channel;
684 indio_dev->dev.of_node = dev->of_node;
686 ret = devm_iio_device_register(dev, indio_dev);
690 return iio_priv(indio_dev);
694 * is_stm32_timer_trigger
695 * @trig: trigger to be checked
697 * return true if the trigger is a valid stm32 iio timer trigger
698 * either return false
700 bool is_stm32_timer_trigger(struct iio_trigger *trig)
702 return (trig->ops == &timer_trigger_ops);
704 EXPORT_SYMBOL(is_stm32_timer_trigger);
706 static void stm32_timer_detect_trgo2(struct stm32_timer_trigger *priv)
711 * Master mode selection 2 bits can only be written and read back when
714 regmap_update_bits(priv->regmap, TIM_CR2, TIM_CR2_MMS2, TIM_CR2_MMS2);
715 regmap_read(priv->regmap, TIM_CR2, &val);
716 regmap_update_bits(priv->regmap, TIM_CR2, TIM_CR2_MMS2, 0);
717 priv->has_trgo2 = !!val;
720 static int stm32_timer_trigger_probe(struct platform_device *pdev)
722 struct device *dev = &pdev->dev;
723 struct stm32_timer_trigger *priv;
724 struct stm32_timers *ddata = dev_get_drvdata(pdev->dev.parent);
725 const struct stm32_timer_trigger_cfg *cfg;
729 if (of_property_read_u32(dev->of_node, "reg", &index))
732 cfg = (const struct stm32_timer_trigger_cfg *)
733 of_match_device(dev->driver->of_match_table, dev)->data;
735 if (index >= ARRAY_SIZE(triggers_table) ||
736 index >= cfg->num_valids_table)
739 /* Create an IIO device only if we have triggers to be validated */
740 if (*cfg->valids_table[index])
741 priv = stm32_setup_counter_device(dev);
743 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
749 priv->regmap = ddata->regmap;
750 priv->clk = ddata->clk;
751 priv->max_arr = ddata->max_arr;
752 priv->triggers = triggers_table[index];
753 priv->valids = cfg->valids_table[index];
754 stm32_timer_detect_trgo2(priv);
756 ret = stm32_setup_iio_triggers(priv);
760 platform_set_drvdata(pdev, priv);
765 static const struct stm32_timer_trigger_cfg stm32_timer_trg_cfg = {
766 .valids_table = valids_table,
767 .num_valids_table = ARRAY_SIZE(valids_table),
770 static const struct stm32_timer_trigger_cfg stm32h7_timer_trg_cfg = {
771 .valids_table = stm32h7_valids_table,
772 .num_valids_table = ARRAY_SIZE(stm32h7_valids_table),
775 static const struct of_device_id stm32_trig_of_match[] = {
777 .compatible = "st,stm32-timer-trigger",
778 .data = (void *)&stm32_timer_trg_cfg,
780 .compatible = "st,stm32h7-timer-trigger",
781 .data = (void *)&stm32h7_timer_trg_cfg,
785 MODULE_DEVICE_TABLE(of, stm32_trig_of_match);
787 static struct platform_driver stm32_timer_trigger_driver = {
788 .probe = stm32_timer_trigger_probe,
790 .name = "stm32-timer-trigger",
791 .of_match_table = stm32_trig_of_match,
794 module_platform_driver(stm32_timer_trigger_driver);
796 MODULE_ALIAS("platform: stm32-timer-trigger");
797 MODULE_DESCRIPTION("STMicroelectronics STM32 Timer Trigger driver");
798 MODULE_LICENSE("GPL v2");