TIM device tree configuration

Applicable for

STM32MP13x lines, STM32MP15x lines, STM32MP21x lines, STM32MP23x lines, STM32MP25x lines

---

1. Article purpose

The purpose of this article is to explain how to configure the TIM internal peripheral using the device tree mechanism, relying on the bindings documentation, that is the description of the required and optional device-tree properties.

When the peripheral is assigned to Linux^® OS, it explains:

• how to enable PWM, trigger or quadrature encoder.
• how to configure the board, e.g. TIM input/output pins.

It is used by the TIM_OpenSTLinux_drivers that registers relevant information in PWM, IIO and counter frameworks.

The peripheral can be assigned to different contexts/software components, depending on the final product needs. Refer to How to assign an internal peripheral to an execution context for guidelines on this configuration.

2. DT bindings documentation

The device tree binding documents are stored in the Linux kernel repository:

• Linux^® OS : Template:CodeSource

The TIM internal peripheral is a multifunction device (MFD), providing several functions represented by a separate compatible string:

• st,stm32-timers deals with core resources. (e.g. registers, clock, DMAs)
• st,stm32-pwm deals with PWM resources. (e.g. PWM input/output pins)
• st,stm32-timer-trigger deals with trigger resources (e.g. trigger output connected to other STM32 internal peripherals)
• st,stm32-timer-counter deals with quadrature encoder resources and external events counter.

3. DT configuration

This hardware description is a combination of the STM32 microprocessor device tree files (.dtsi extension) and board device tree files (.dts extension). See the Device tree for an explanation of the device-tree file organization.

STM32CubeMX can be used to generate the board device tree. Refer to How to configure the DT using STM32CubeMX for more details.

3.1. DT configuration (STM32 level)

DT root node (e.g. timers1...) and DT child nodes describe the TIM features such as:

• PWM
• trigger
• counter and quadrature encoder

They also describe hardware parameters such as registers address, clock and DMA.

3.1.1. On STM32MP1 series

TIM nodes are declared in stm32mp131.dtsi on STM32MP13x lines .

TIM nodes are declared in stm32mp151.dtsi on STM32MP15x lines .

timers1: timer@address {
	Template:Highlight
	compatible = "st,stm32-timers";
	...
	pwm {
		Template:Highlight
		compatible = "st,stm32-pwm";
	};
	timer@0 {
		compatible = "st,stm32h7-timer-trigger";
		Template:Highlight
		reg = <0>;
	};
	counter {
		compatible = "st,stm32-timer-counter";
	};
};

Template:Warning

3.1.2. On STM32MP2 series

3.1.2.1. On STM32MP21x lines 

TIM nodes are declared in stm32mp211.dtsi on STM32MP21x lines .

timers1: timer@address {
	Template:Highlight
	compatible = "st,stm32mp21-timers";
	...
	pwm {
		Template:Highlight
		compatible = "st,stm32mp21-pwm";
	};
	timer@0 {
		compatible = "st,stm32mp21-timer-trigger";
		Template:Highlight
		reg = <0>;
	};
	counter {
		compatible = "st,stm32mp21-timer-counter";
	};
};

Template:Warning

3.1.2.2. On STM32MP23x lines  and STM32MP25x lines 

TIM nodes are declared in stm32mp231.dtsi on STM32MP23x lines .

TIM nodes are declared in stm32mp251.dtsi on STM32MP25x lines .

timers1: timer@address {
	Template:Highlight
	compatible = "st,stm32mp25-timers";
	...
	pwm {
		Template:Highlight
		compatible = "st,stm32mp25-pwm";
	};
	timer@0 {
		compatible = "st,stm32mp25-timer-trigger";
		Template:Highlight
		reg = <0>;
	};
	counter {
		compatible = "st,stm32mp25-timer-counter";
	};
};

Template:Warning

3.2. DT configuration (board level)

The objective of this chapter is to explain how to enable and configure the TIM DT nodes for a board:

• Enable DT root node for the TIM instances in use (e.g timers1...) by setting Template:Highlight
• Enable DT child node(s) for the feature(s) in use (PWM input/output, trigger and quadrature encoder) by setting Template:Highlight
• Configure pins in use via pinctrl through Template:Highlight, Template:Highlight and Template:Highlight.

To enable PWM capture on the board (optional), DMA must be configured:

• Enable DMA channel(s) corresponding to the PWM input(s) by setting Template:Highlight and matching Template:Highlight.

When PWM capture isn't used, it's recommended to disable DMA channels by default, to spare them for other usage:

• Disable DMA channels by setting Template:Highlight and Template:Highlight

Peripheral configuration should be done in specific board device tree files (board dts file and pinctrl dtsi file).

3.3. DT configuration examples

3.3.1. TIM configured in PWM mode

The example below shows how to configure TIM1 channel 1 to act as:

• PWM output on PE9, e.g. TIM1_CH1 (See pinctrl device tree configuration and GPIO internal peripheral)
• PWM device tree provider (e.g. TIM1_CH1) used by a device tree consumer (e.g. like "pwm-leds").

Template:Highlight
pwm1_pins_a: pwm1-0 {
	pins {
		pinmux = <STM32_PINMUX('E', 9, AF1)>;
		bias-pull-down;
		drive-push-pull;
		slew-rate = <0>;
	};
};

Template:Highlight
pwm1_sleep_pins_a: pwm1-sleep-0 {
	pins {
		pinmux = <STM32_PINMUX('E', 9, ANALOG)>;
	};
};

Information

The PWM output doesn't require any DMA channel. Disable them if they are configured by default in the .dtsi file.

Template:Highlight
&timers1 {
	status = "Template:Highlight";
	/* spare all DMA channels since they are not needed for PWM output */
	/delete-property/dmas;
	/delete-property/dma-names;
	/* define pwm1 label */
	Template:Highlight: pwm {
		Template:Highlight
		pinctrl-0 = <&pwm1_pins_a>;
		pinctrl-1 = <&pwm1_sleep_pins_a>;
		pinctrl-names = "default", "sleep";
		Template:Highlight
		status = "Template:Highlight";
	};
};

• PWM DT user example

Information

The TIM PWM DT user specifier encodes 3 cells: PWM number (0 for CH1, 1 for CH2 and so on) PWM period in nanoseconds PWM polarity (0 for normal polarity or PWM_POLARITY_INVERTED)

/ {
	...
	Template:Highlight
	pwmleds {
		compatible = "pwm-leds";
		example {
			label = "stm32-pwm-leds-example";
			Template:Highlight
			/* period in nanoseconds (500000), normal polarity (0) */
			pwms = <Template:Highlight 500000 0>;
			max-brightness = <127>;
		};
	};
};

3.3.2. TIM configured in PWM mode and trigger source

The example below shows how to configure TIM1 channel 1 to act as:

• PWM output on PE9, e.g. TIM1_CH1 (See pinctrl device tree configuration and GPIO internal peripheral)
• trigger source (synchronous with PWM) for other internal peripheral such as STM32 ADC

Template:Highlight
pwm1_pins_a: pwm1-0 {
	pins {
		pinmux = <STM32_PINMUX('E', 9, AF1)>;
		bias-pull-down;
		drive-push-pull;
		slew-rate = <0>;
	};
};

Template:Highlight
pwm1_sleep_pins_a: pwm1-sleep-0 {
	pins {
		pinmux = <STM32_PINMUX('E', 9, ANALOG)>;
	};
};

Information

The PWM output doesn't require any DMA channel. Disable them if they are configured by default in the .dtsi file.

&timers1 {
	status = "Template:Highlight";
	Template:Highlight
	/delete-property/dmas;
	/delete-property/dma-names;
	pwm {
		Template:Highlight
		pinctrl-0 = <&pwm1_pins_a>;          
		pinctrl-1 = <&pwm1_sleep_pins_a>;
		pinctrl-names = "default", "sleep";
		Template:Highlight
		status = "Template:Highlight";
	};
	timer@0 {
		Template:Highlight
		status = "Template:Highlight";
	};
};

3.3.3. TIM configured in counter capture mode

The example below shows how to configure TIM10 channel 1 in counter capture mode, based on the counter subsystem.

It is available on available on STM32MP257x-EV1 GPIO expansion connector.

• Configure PB9 as alternate function to use TIM10_CH1 (See pinctrl device tree configuration and GPIO internal peripheral):

Template:Highlight
	tim10_counter_pins_a: tim10-counter-0 {
		pins {
			pinmux = <STM32_PINMUX('B', 9, AF9)>; /* TIM10_CH1 */
			bias-disable;
		};
	};

Template:Highlight
	tim10_counter_sleep_pins_a: tim10-counter-sleep-0 {
		pins {
			pinmux = <STM32_PINMUX('B', 9, ANALOG)>; /* TIM10_CH1 */
		};
	};

Information

Note: one or more channels may be configured for capture.

• Configure and enable the timer 10 to act as counter device:

Template:Highlight
&timers10 {
	status = "okay";
	Template:Highlight
	counter {
		pinctrl-0 = <&tim10_counter_pins_a>;
		pinctrl-1 = <&tim10_counter_sleep_pins_a>;
		pinctrl-names = "default", "sleep";
		status = "okay";
	};
};

Expand

3.3.4. TIM configured in PWM input capture mode

Template:Warning

This example shows how to configure TIM1 channel 1 in PWM input capture mode (e.g. period and duty cycle).

• Configure PWM input on PE9, e.g. TIM1_CH1 (See pinctrl device tree configuration and GPIO internal peripheral)

Template:Highlight
pwm1_in_pins_a: pwm1-in-0 {
	pins {
		pinmux = <STM32_PINMUX('E', 9, AF1)>;
		bias-disable;
	};
};

Template:Highlight
pwm1_in_sleep_pins_a: pwm1-in-sleep-0 {
	pins {
		pinmux = <STM32_PINMUX('E', 9, ANALOG)>;
	};
};

A DMA channel is required and must be configured depending on the PWM input channel:

• Select DMA channel 1, "ch1", to capture PWM input channel 1 and/or 2
• Select DMA channel 3, "ch3", to capture PWM input channel 3 and/or 4
• Select both "ch1" and "ch3" dmas to enable capture on all PWM input channels

&timers1 {
	status = "Template:Highlight";
	Template:Highlight
	dmas = <&dmamux1 11 0x400 0x1>;
	dma-names = "ch1";
	pwm {
		Template:Highlight
		pinctrl-0 = <&pwm1_in_pins_a>;
		pinctrl-1 = <&pwm1_in_sleep_pins_a>;
		pinctrl-names = "default", "sleep";
		Template:Highlight
		status = "Template:Highlight";
	};
};

Template:ReviewsComments

Information

DMA channels 1 and/or 3 for each TIM can be picked from the "dmas" list in stm32mp131.dtsi or stm32mp151.dtsi files

3.3.5. TIM configured as quadrature encoder interface

The example below shows how to configure TIM1 to interface with a quadrature encoder, based on the counter subsystem:

• Configure PE9 and PE11 as encoder input pins, e.g. TIM1_CH1, TIM1_CH2 (see pinctrl device tree configuration and GPIO internal peripheral)

Information

On the STM32MP157X-DKX discovery board, TIM1_CH1 and TIM1_CH2 signals are accessible via the D6 and D10 pins of the Arduino Uno connector.

tim1_in_pins_a: tim1-in-pins-0 {
	pins {
		pinmux = <STM32_PINMUX('E', 9, AF1)>, /* TIM1_CH1 */
			 <STM32_PINMUX('E', 11, AF1)>; /* TIM1_CH2 */
		bias-disable;
	};
};

tim1_in_pins_sleep_a: tim1-in-pins-sleep-0 {
	pins {
		pinmux = <STM32_PINMUX('E', 9, ANALOG)>, /* TIM1_CH1 */
			 <STM32_PINMUX('E', 11, ANALOG)>; /* TIM1_CH2 */
	};
};

&timers1 {
	status = "Template:Highlight";
	/delete-property/dmas;                       Template:Highlight
	/delete-property/dma-names;
	counter {
		pinctrl-0 = <&tim1_in_pins_a>;       Template:Highlight
		pinctrl-1 = <&tim1_in_pins_sleep_a>;
		pinctrl-names = "default", "sleep";
		status = "Template:Highlight";                     Template:Highlight
	};
};

4. How to configure the DT using STM32CubeMX

The STM32CubeMX tool can be used to configure the STM32MPU device and get the corresponding platform configuration device tree files.
STM32CubeMX may not support all the properties described in DT binding files listed in the above DT bindings documentation paragraph. If so, the tool inserts user sections in the generated device tree. These sections can then be edited to add some properties, and they are preserved from one generation to another. Refer to STM32CubeMX user manual for further information.

5. References

Refer to the following links for additional information:

Template:ArticleBasedOnModel

Linux^® is a registered trademark of Linus Torvalds.

Operating system

Pulse width modulation

Device tree

Multifunction device

Direct memory access