1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) STMicroelectronics 2016
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,
307 static ssize_t stm32_tt_show_master_mode_avail(struct device *dev,
308 struct device_attribute *attr,
311 struct iio_trigger *trig = to_iio_trigger(dev);
312 unsigned int i, master_mode_max;
315 if (stm32_timer_is_trgo2_name(trig->name))
316 master_mode_max = MASTER_MODE2_MAX;
318 master_mode_max = MASTER_MODE_MAX;
320 for (i = 0; i <= master_mode_max; i++)
321 len += scnprintf(buf + len, PAGE_SIZE - len,
322 "%s ", master_mode_table[i]);
324 /* replace trailing space by newline */
330 static IIO_DEVICE_ATTR(master_mode_available, 0444,
331 stm32_tt_show_master_mode_avail, NULL, 0);
333 static IIO_DEVICE_ATTR(master_mode, 0660,
334 stm32_tt_show_master_mode,
335 stm32_tt_store_master_mode,
338 static struct attribute *stm32_trigger_attrs[] = {
339 &iio_dev_attr_sampling_frequency.dev_attr.attr,
340 &iio_dev_attr_master_mode.dev_attr.attr,
341 &iio_dev_attr_master_mode_available.dev_attr.attr,
345 static const struct attribute_group stm32_trigger_attr_group = {
346 .attrs = stm32_trigger_attrs,
349 static const struct attribute_group *stm32_trigger_attr_groups[] = {
350 &stm32_trigger_attr_group,
354 static const struct iio_trigger_ops timer_trigger_ops = {
357 static int stm32_setup_iio_triggers(struct stm32_timer_trigger *priv)
360 const char * const *cur = priv->triggers;
362 while (cur && *cur) {
363 struct iio_trigger *trig;
364 bool cur_is_trgo = stm32_timer_is_trgo_name(*cur);
365 bool cur_is_trgo2 = stm32_timer_is_trgo2_name(*cur);
367 if (cur_is_trgo2 && !priv->has_trgo2) {
372 trig = devm_iio_trigger_alloc(priv->dev, "%s", *cur);
376 trig->dev.parent = priv->dev->parent;
377 trig->ops = &timer_trigger_ops;
380 * sampling frequency and master mode attributes
381 * should only be available on trgo/trgo2 triggers
383 if (cur_is_trgo || cur_is_trgo2)
384 trig->dev.groups = stm32_trigger_attr_groups;
386 iio_trigger_set_drvdata(trig, priv);
388 ret = devm_iio_trigger_register(priv->dev, trig);
397 static int stm32_counter_read_raw(struct iio_dev *indio_dev,
398 struct iio_chan_spec const *chan,
399 int *val, int *val2, long mask)
401 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
405 case IIO_CHAN_INFO_RAW:
406 regmap_read(priv->regmap, TIM_CNT, &dat);
410 case IIO_CHAN_INFO_ENABLE:
411 regmap_read(priv->regmap, TIM_CR1, &dat);
412 *val = (dat & TIM_CR1_CEN) ? 1 : 0;
415 case IIO_CHAN_INFO_SCALE:
416 regmap_read(priv->regmap, TIM_SMCR, &dat);
422 /* in quadrature case scale = 0.25 */
426 return IIO_VAL_FRACTIONAL_LOG2;
432 static int stm32_counter_write_raw(struct iio_dev *indio_dev,
433 struct iio_chan_spec const *chan,
434 int val, int val2, long mask)
436 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
440 case IIO_CHAN_INFO_RAW:
441 return regmap_write(priv->regmap, TIM_CNT, val);
443 case IIO_CHAN_INFO_SCALE:
447 case IIO_CHAN_INFO_ENABLE:
449 regmap_read(priv->regmap, TIM_CR1, &dat);
450 if (!(dat & TIM_CR1_CEN))
451 clk_enable(priv->clk);
452 regmap_update_bits(priv->regmap, TIM_CR1, TIM_CR1_CEN,
455 regmap_read(priv->regmap, TIM_CR1, &dat);
456 regmap_update_bits(priv->regmap, TIM_CR1, TIM_CR1_CEN,
458 if (dat & TIM_CR1_CEN)
459 clk_disable(priv->clk);
467 static int stm32_counter_validate_trigger(struct iio_dev *indio_dev,
468 struct iio_trigger *trig)
470 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
471 const char * const *cur = priv->valids;
474 if (!is_stm32_timer_trigger(trig))
477 while (cur && *cur) {
478 if (!strncmp(trig->name, *cur, strlen(trig->name))) {
479 regmap_update_bits(priv->regmap,
480 TIM_SMCR, TIM_SMCR_TS,
481 i << TIM_SMCR_TS_SHIFT);
491 static const struct iio_info stm32_trigger_info = {
492 .validate_trigger = stm32_counter_validate_trigger,
493 .read_raw = stm32_counter_read_raw,
494 .write_raw = stm32_counter_write_raw
497 static const char *const stm32_trigger_modes[] = {
501 static int stm32_set_trigger_mode(struct iio_dev *indio_dev,
502 const struct iio_chan_spec *chan,
505 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
507 regmap_update_bits(priv->regmap, TIM_SMCR, TIM_SMCR_SMS, TIM_SMCR_SMS);
512 static int stm32_get_trigger_mode(struct iio_dev *indio_dev,
513 const struct iio_chan_spec *chan)
515 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
518 regmap_read(priv->regmap, TIM_SMCR, &smcr);
520 return (smcr & TIM_SMCR_SMS) == TIM_SMCR_SMS ? 0 : -EINVAL;
523 static const struct iio_enum stm32_trigger_mode_enum = {
524 .items = stm32_trigger_modes,
525 .num_items = ARRAY_SIZE(stm32_trigger_modes),
526 .set = stm32_set_trigger_mode,
527 .get = stm32_get_trigger_mode
530 static const char *const stm32_enable_modes[] = {
536 static int stm32_enable_mode2sms(int mode)
550 static int stm32_set_enable_mode(struct iio_dev *indio_dev,
551 const struct iio_chan_spec *chan,
554 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
555 int sms = stm32_enable_mode2sms(mode);
561 * Triggered mode sets CEN bit automatically by hardware. So, first
562 * enable counter clock, so it can use it. Keeps it in sync with CEN.
565 regmap_read(priv->regmap, TIM_CR1, &val);
566 if (!(val & TIM_CR1_CEN))
567 clk_enable(priv->clk);
570 regmap_update_bits(priv->regmap, TIM_SMCR, TIM_SMCR_SMS, sms);
575 static int stm32_sms2enable_mode(int mode)
589 static int stm32_get_enable_mode(struct iio_dev *indio_dev,
590 const struct iio_chan_spec *chan)
592 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
595 regmap_read(priv->regmap, TIM_SMCR, &smcr);
596 smcr &= TIM_SMCR_SMS;
598 return stm32_sms2enable_mode(smcr);
601 static const struct iio_enum stm32_enable_mode_enum = {
602 .items = stm32_enable_modes,
603 .num_items = ARRAY_SIZE(stm32_enable_modes),
604 .set = stm32_set_enable_mode,
605 .get = stm32_get_enable_mode
608 static ssize_t stm32_count_get_preset(struct iio_dev *indio_dev,
610 const struct iio_chan_spec *chan,
613 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
616 regmap_read(priv->regmap, TIM_ARR, &arr);
618 return snprintf(buf, PAGE_SIZE, "%u\n", arr);
621 static ssize_t stm32_count_set_preset(struct iio_dev *indio_dev,
623 const struct iio_chan_spec *chan,
624 const char *buf, size_t len)
626 struct stm32_timer_trigger *priv = iio_priv(indio_dev);
630 ret = kstrtouint(buf, 0, &preset);
634 /* TIMx_ARR register shouldn't be buffered (ARPE=0) */
635 regmap_update_bits(priv->regmap, TIM_CR1, TIM_CR1_ARPE, 0);
636 regmap_write(priv->regmap, TIM_ARR, preset);
641 static const struct iio_chan_spec_ext_info stm32_trigger_count_info[] = {
644 .shared = IIO_SEPARATE,
645 .read = stm32_count_get_preset,
646 .write = stm32_count_set_preset
648 IIO_ENUM("enable_mode", IIO_SEPARATE, &stm32_enable_mode_enum),
649 IIO_ENUM_AVAILABLE("enable_mode", &stm32_enable_mode_enum),
650 IIO_ENUM("trigger_mode", IIO_SEPARATE, &stm32_trigger_mode_enum),
651 IIO_ENUM_AVAILABLE("trigger_mode", &stm32_trigger_mode_enum),
655 static const struct iio_chan_spec stm32_trigger_channel = {
658 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) |
659 BIT(IIO_CHAN_INFO_ENABLE) |
660 BIT(IIO_CHAN_INFO_SCALE),
661 .ext_info = stm32_trigger_count_info,
665 static struct stm32_timer_trigger *stm32_setup_counter_device(struct device *dev)
667 struct iio_dev *indio_dev;
670 indio_dev = devm_iio_device_alloc(dev,
671 sizeof(struct stm32_timer_trigger));
675 indio_dev->name = dev_name(dev);
676 indio_dev->dev.parent = dev;
677 indio_dev->info = &stm32_trigger_info;
678 indio_dev->modes = INDIO_HARDWARE_TRIGGERED;
679 indio_dev->num_channels = 1;
680 indio_dev->channels = &stm32_trigger_channel;
681 indio_dev->dev.of_node = dev->of_node;
683 ret = devm_iio_device_register(dev, indio_dev);
687 return iio_priv(indio_dev);
691 * is_stm32_timer_trigger
692 * @trig: trigger to be checked
694 * return true if the trigger is a valid stm32 iio timer trigger
695 * either return false
697 bool is_stm32_timer_trigger(struct iio_trigger *trig)
699 return (trig->ops == &timer_trigger_ops);
701 EXPORT_SYMBOL(is_stm32_timer_trigger);
703 static void stm32_timer_detect_trgo2(struct stm32_timer_trigger *priv)
708 * Master mode selection 2 bits can only be written and read back when
711 regmap_update_bits(priv->regmap, TIM_CR2, TIM_CR2_MMS2, TIM_CR2_MMS2);
712 regmap_read(priv->regmap, TIM_CR2, &val);
713 regmap_update_bits(priv->regmap, TIM_CR2, TIM_CR2_MMS2, 0);
714 priv->has_trgo2 = !!val;
717 static int stm32_timer_trigger_probe(struct platform_device *pdev)
719 struct device *dev = &pdev->dev;
720 struct stm32_timer_trigger *priv;
721 struct stm32_timers *ddata = dev_get_drvdata(pdev->dev.parent);
722 const struct stm32_timer_trigger_cfg *cfg;
726 if (of_property_read_u32(dev->of_node, "reg", &index))
729 cfg = (const struct stm32_timer_trigger_cfg *)
730 of_match_device(dev->driver->of_match_table, dev)->data;
732 if (index >= ARRAY_SIZE(triggers_table) ||
733 index >= cfg->num_valids_table)
736 /* Create an IIO device only if we have triggers to be validated */
737 if (*cfg->valids_table[index])
738 priv = stm32_setup_counter_device(dev);
740 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
746 priv->regmap = ddata->regmap;
747 priv->clk = ddata->clk;
748 priv->max_arr = ddata->max_arr;
749 priv->triggers = triggers_table[index];
750 priv->valids = cfg->valids_table[index];
751 stm32_timer_detect_trgo2(priv);
753 ret = stm32_setup_iio_triggers(priv);
757 platform_set_drvdata(pdev, priv);
762 static const struct stm32_timer_trigger_cfg stm32_timer_trg_cfg = {
763 .valids_table = valids_table,
764 .num_valids_table = ARRAY_SIZE(valids_table),
767 static const struct stm32_timer_trigger_cfg stm32h7_timer_trg_cfg = {
768 .valids_table = stm32h7_valids_table,
769 .num_valids_table = ARRAY_SIZE(stm32h7_valids_table),
772 static const struct of_device_id stm32_trig_of_match[] = {
774 .compatible = "st,stm32-timer-trigger",
775 .data = (void *)&stm32_timer_trg_cfg,
777 .compatible = "st,stm32h7-timer-trigger",
778 .data = (void *)&stm32h7_timer_trg_cfg,
782 MODULE_DEVICE_TABLE(of, stm32_trig_of_match);
784 static struct platform_driver stm32_timer_trigger_driver = {
785 .probe = stm32_timer_trigger_probe,
787 .name = "stm32-timer-trigger",
788 .of_match_table = stm32_trig_of_match,
791 module_platform_driver(stm32_timer_trigger_driver);
793 MODULE_ALIAS("platform: stm32-timer-trigger");
794 MODULE_DESCRIPTION("STMicroelectronics STM32 Timer Trigger driver");
795 MODULE_LICENSE("GPL v2");