Registered User mNo edit summary |
Registered User No edit summary |
||
| (9 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{ApplicableFor | |||
|MPUs list=STM32MP13x, STM32MP15x | |MPUs list=STM32MP13x, STM32MP15x, STM32MP21x, STM32MP23x, STM32MP25x | ||
|MPUs checklist=STM32MP13x,STM32MP15x | |MPUs checklist=STM32MP13x, STM32MP15x, STM32MP21x, STM32MP23x, STM32MP25x | ||
}}</noinclude> | }} | ||
<noinclude></noinclude> | |||
== Article purpose == | == 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_overview|ALSA framework]]. | 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_overview|ALSA framework]]. | ||
| Line 8: | Line 9: | ||
The configuration is performed using the [[Device_tree|device tree]] mechanism that provides a hardware description of the SPDIFRX peripheral, used by the [[SPDIFRX_Linux_driver|SPDFIRX linux driver]]. | The configuration is performed using the [[Device_tree|device tree]] mechanism that provides a hardware description of the SPDIFRX peripheral, used by the [[SPDIFRX_Linux_driver|SPDFIRX linux driver]]. | ||
If the peripheral is assigned to another execution context, refer to [[How to assign an internal peripheral to | 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. | ||
== DT bindings documentation == | == DT bindings documentation == | ||
| Line 14: | Line 15: | ||
== DT configuration == | == DT configuration == | ||
This hardware description is a combination of STM32 microprocessor <ref name="stm32mp151.dtsi">{{CodeSource | Linux kernel | arch/arm/boot/dts/stm32mp151.dtsi}}</ref> and board device tree files. See the [[Device tree]] for an explanation of the device tree file split. | This hardware description is a combination of STM32 microprocessor <ref name="stm32mp151.dtsi">{{CodeSource | Linux kernel | arch/arm/boot/dts/st/stm32mp151.dtsi}}</ref> 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|How to configure the DT using STM32CubeMX]] for more details. | '''STM32CubeMX''' can be used to generate the board device tree. Refer to [[#How_to_configure_the_DT_using_STM32CubeMX|How to configure the DT using STM32CubeMX]] for more details. | ||
=== DT configuration (STM32 level) === | === DT configuration (STM32 level) === | ||
The SPDIFRX node is declared in | 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 {{MicroprocessorDevice | device=13}}, the SPDIFRX nodes are declared in stm32mp131.dtsi<ref name="stm32mp131.dtsi">{{CodeSource | Linux kernel | arch/arm/boot/dts/st/stm32mp131.dtsi | STM32MP131 device tree file}}</ref>.<br/> | |||
On {{MicroprocessorDevice | device=15}}, the SPDIFRX nodes are declared in stm32mp151.dtsi<ref name="stm32mp151_dtsi">{{CodeSource | Linux kernel | arch/arm/boot/dts/st/stm32mp151.dtsi | STM32MP151 device tree file}}</ref>. | |||
On {{MicroprocessorDevice | device=21}}, the SPDIFRX nodes are declared in stm32mp211.dtsi<ref name="stm32mp211_dtsi">{{CodeSource | Linux kernel | arch/arm/boot/dts/st/stm32mp211.dtsi | STM32MP211 device tree file}}</ref>. | |||
On {{MicroprocessorDevice | device=23}}, the SPDIFRX nodes are declared in stm32mp231.dtsi<ref name="stm32mp231_dtsi">{{CodeSource | Linux kernel | arch/arm/boot/dts/st/stm32mp231.dtsi | STM32MP231 device tree file}}</ref>. | |||
On {{MicroprocessorDevice | device=25}}, the SPDIFRX nodes are declared in stm32mp251.dtsi<ref name="stm32mp251_dtsi">{{CodeSource | Linux kernel | arch/arm/boot/dts/st/stm32mp251.dtsi | STM32MP251 device tree file}}</ref>. | |||
{{Warning|This device tree part is related to STM32 microprocessors. It must be kept as is, without being modified by the end-user.}} | {{Warning|This device tree part is related to STM32 microprocessors. It must be kept as is, without being modified by the end-user.}} | ||
Latest revision as of 14:52, 23 October 2024
1. Article purpose[edit | edit source]
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[edit | edit source]
STM32 SPDIFRX device tree bindings [1] document describes all the required and optional configuration properties.
3. DT configuration[edit | edit source]
This hardware description is a combination of STM32 microprocessor [2] 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)[edit | edit source]
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[3].
On STM32MP15x lines , the SPDIFRX nodes are declared in stm32mp151.dtsi[4].
On STM32MP21x lines , the SPDIFRX nodes are declared in stm32mp211.dtsi[5].
On STM32MP23x lines , the SPDIFRX nodes are declared in stm32mp231.dtsi[6].
On STM32MP25x lines , the SPDIFRX nodes are declared in stm32mp251.dtsi[7].
3.2. DT configuration (board level)[edit | edit source]
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[edit | edit source]
&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[edit | edit source]
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[edit | edit source]