SPDIFRX device tree configuration

Applicable for

STM32MP13x lines, STM32MP15x lines, STM32MP25x lines

---

1. Article purpose

This article explains how to configure the SPDIFRX internal peripheral when it is assigned to the Linux® OS. In that case, it is controlled by the ALSA framework.

The configuration is performed using the device tree mechanism that provides a hardware description of the SPDIFRX peripheral, used by the SPDFIRX linux driver.

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

2. DT bindings documentation

STM32 SPDIFRX device tree bindings document describes all the required and optional configuration properties.

3. DT configuration

This hardware description is a combination of STM32 microprocessor and board device tree files. 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 SPDIFRX node is declared in STM32 microprocessor device tree. It describes hardware parameters such as registers address, interrupt and DMA. This set of properties may not vary for a given STM32MPU.

On STM32MP13x lines , the SPDIFRX nodes are declared in stm32mp131.dtsi.

On STM32MP15x lines , the SPDIFRX nodes are declared in stm32mp151.dtsi.

On STM32MP25x lines , the SPDIFRX nodes are declared in stm32mp251.dtsi.

Template:Warning

3.2. DT configuration (board level)

The SPDIFRX is an audio peripheral, which can be used as a component of a soundcard through Linux^® kernel ALSA framework. This part of the device tree allows the configuration of the SPDIFRX to implement a soundcard. Refer to soundcard configuration for examples of SPDIFRX configuration on various boards.

3.3. DT configuration examples

&spdifrx {
	pinctrl-names = "default", "sleep"; 
	pinctrl-0 = <&spdifrx_pins_a>;
	pinctrl-1 = <&spdifrx_sleep_pins_a>
	/* Use spdifrx_pins_a instead of spdifrx_sleep_pins_a configuration,
	to allow IEC958 status bits capture, when an audio stream record is
	not active. Note that sleep state has to be defined, to allow pin state
	recovery from low power modes. */

	spdifrx_port: port {
		spdifrx_endpoint: endpoint {
			remote-endpoint = <&spdif_in_endpoint>;
		};
	};
};

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

Template:ArticleBasedOnModel