CEC device tree configuration

Stable: 17.07.2023 - 09:00 / Revision: 17.07.2023 - 08:58

I am here to prevent the first-page-empty bug!

1 Article purpose

This article explains how to configure the CEC [1] when the peripheral is assigned to the Linux®OS.

The configuration is performed using the device tree mechanism [2].

The Device tree provides a hardware description of the CEC [1] used by the STM32 CEC Linux driver.

If the peripheral is assigned to another execution context, refer to How to assign an internal peripheral to a runtime context article for guidelines on peripheral assignment and configuration.

2 DT bindings documentation

The CEC is represented by the STM32 CEC device tree bindings [3].

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 split.

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)

The CEC device tree node is declared in stm32mp157c.dtsi [4]. It describes the hardware register address, clocks, interrupts and power domains.

		cec: cec@40016000 {
			compatible = "st,stm32-cec";
			reg = <0x40016000 0x400>;
			interrut-names = "event", "wakeup";
			interrupts-extended = <&intc GIC_SPI 94 IRQ_TYPE_LEVEL_HIGH>,
					      <&exti 69 1>;
			clocks = <&rcc CEC>, <&rcc CK_LSE>;
			clock-names = "cec", "hdmi-cec";
			power-domains = <&pd_core>;
			status = "disabled";
		};
Warning white.png Warning
This device tree part is related to STM32 microprocessors. It must be kept as is, without being modified by the end-user. It is strongly advised not to change this configuration except for the "hdmi-cec" clock source.

3.2 DT configuration (board level)

The CEC device tree node contains the pinctrl description and the "okay" status:

&cec {
	pinctrl-names = "default", "sleep";
	pinctrl-0 = <&cec_pins_a>;
	pinctrl-1 = <&cec_pins_sleep_a>;
	status = "okay";
};

You can find a full example of the STM32MP15 Evaluation board device tree in stm32mp157c-ev1.dts [5].

You can find a full example of the CEC pins [6] in the stm32mp157-pinctrl.dtsi [7]

			cec_pins_a: cec-0 {
				pins {
					pinmux = <STM32_PINMUX('A', 15, AF4)>; /* HDMI_CEC */
					bias-disable;
					drive-open-drain;
					slew-rate = <0>;
				};
			};

			cec_pins_sleep_a: cec-sleep-0 {
				pins {
					pinmux = <STM32_PINMUX('A', 15, ANALOG)>; /* HDMI_CEC */
				};
			};

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.
The STM32CubeMX may not support all the properties described 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

Please refer to the following links for additional information:



IMPORTANT NOTICE – READ CAREFULLY
STMicroelectronics NV and its subsidiaries ("ST") reserve the right to make changes, corrections, enhancements, modifications, and improvements to ST products and/or to this document at any time without notice. Purchasers should obtain the latest relevant information on ST products before placing orders. ST products are sold pursuant to ST’s terms and conditions of sale in place at the time of order acknowledgment.

Purchasers are solely responsible for the choice, selection, and use of ST products and ST assumes no liability for application assistance or the design of purchasers’ products.

No license, express or implied, to any intellectual property right is granted by ST herein.

Resale of ST products with provisions different from the information set forth herein shall void any warranty granted by ST for such product.

ST and the ST logo are trademarks of ST. For additional information about ST trademarks, refer to www.st.com/trademarks. All other product or service names are the property of their respective owners.

Information in this document supersedes and replaces information previously supplied in any prior versions of this document.