Difference between revisions of "I2S device tree configuration"

[quality revision] [quality revision]
m
m (Setting I2S as a master clock provider)
 
Applicable for STM32MP13x lines, STM32MP15x lines

1 Article purpose[edit]

This article explains how to configure the SPI/I2S 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 I2S peripheral, used by the I2S 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[edit]

STM32 I2S device tree bindings [1] describes all the required and optional configuration properties.

3 DT configuration[edit]

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]

The I2S node is declared in On STM32MP13x lines Warning.png, the I2S nodes are declared in stm32mp131.dtsi[3].

On STM32MP15x lines More info.png, the I2S nodes are declared in stm32mp151.dtsi[24]. It

This device tree describes the hardware parameters such as register addresses, interrupt, clock, and DMA. This set of properties may not vary for a given STM32MPU.

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.

3.2 DT configuration (board level)[edit]

The I2S 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 I2S to implement a soundcard. Refer to soundcard configuration for examples of I2S configuration for various boards.

3.3 DT configuration examples[edit]

3.3.1 Setting I2S as a master clock provider[edit]

The I2S peripheral can provide a clock to a codec through the MCLK output pin. In this case, it acts as master clock provider. The below DT sample gives an example of I2S configuration as a master clock provider.

&i2s2 {
	...
	i2s2: audio-controller@4000b000 {
		#clock-cells = <0>; /* Set I2S2 as master clock provider */
		...
		i2s2_endpoint: endpoint {
			mclk-fs = <256>; /* Set mclk/fs ratio. (256 or 512) */
		};
	};
};

The codec has to be declared as a consumer of the I2S MCLK provider, in the Device Tree.

codec: {
	clocks = <&i2s2>;     /* The codec is a consumer of I2S2 master clock */
	clock-names = "MCLK"; /* Feed MCLK codec clock with I2S2 master clock provider */
	...
};

Then as a consumer of the MCLK clock, the codec driver can enable the clock using the clock framework API.

An alternative is to enable the MCLK clock dynamically at runtime, using the ASoC DAPM mechanism. In this case the codec driver has to implement a DAPM clock supply widget through SND_SOC_DAPM_SUPPLY macro. An example of such DAPM widget can be found in Cirrus CS42L51 codec source code[5]. To allow MCLK activation/deactivation, DAPM routes must also be defined in the DT, between MCLK and audio stream widgets. These routes are defined in the sound card node, as shown below.

soundcard {
	routing =
		"Playback" , "MCLK", /* Set a route between "MCLK" and "playback" DAPM widgets */
		"Capture" , "MCLK";  /* Set a route between "MCLK" and "capture" DAPM widgets */
	...
};

4 How to configure the DT using STM32CubeMX[edit]

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 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 are preserved from one generation to another. Refer to the STM32CubeMX user manual for further information.

Warning white.png Warning
STM32CubeMX does not allow the generation of all the nodes required to configure a soundcard.

The

soundcard node and the codec

following nodes have to be filled manually through user

sections.

sections :

  • soundcard node
  • codec node
  • i2s node is not fully filled and has to be updated manually. The clock muxings, in STM32CubeMX clock tree panel, allows to configure a single parent clock for the I2S internal peripheral. However, for the I2S peripheral, the device tree has to define two parent clocks "x8k" and "x11k", allowing the I2S Linux driver to choose dynamically the most appropriated clock at runtime. Refer to the I2S device tree bindings [1] and to the I2S driver description for further information.

5 References[edit]


== <noinclude>{{ApplicableFor
|MPUs list=STM32MP13x, STM32MP15x
|MPUs checklist=STM32MP13x, STM32MP15x
}}</noinclude>


== Article purpose ==
This article explains how to configure the [[SPI internal peripheral|SPI/I2S internal peripheral]] when it is assigned to the '''Linux® OS'''. In that case, it is controlled by the [[ALSA_overview|ALSA framework]].

The configuration is performed using the [[Device_tree|device tree]] mechanism that provides a hardware description of the I2S peripheral, used by the [[I2S_Linux_driver|I2S 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.

== DT bindings documentation ==
STM32 I2S device tree bindings <ref name="i2s bindings">{{CodeSource | Linux kernel | Documentation/devicetree/bindings/sound/st,stm32-i2s.txtyaml}}</ref> describes all the required and optional configuration properties.

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

'''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) ===The I2S node is declared in On {{MicroprocessorDevice | device=13}}, the I2S nodes are declared in stm32mp131.dtsi<ref name="stm32mp131.dtsi">{{CodeSource | Linux kernel | arch/arm/boot/dts/stm32mp131.dtsi | STM32MP131 device tree file}}</ref>.<br/>


On {{MicroprocessorDevice | device=15}}, the I2S nodes are declared in stm32mp151.dtsi<ref name="stm32mp151._dtsi">{{CodeSource | Linux kernel | arch/arm/boot/dts/stm32mp151.dtsi}}</ref>. 
It  | STM32MP151 device tree file}}</ref>.

This device tree describes the hardware parameters such as register addresses, interrupt, clock, and DMA. This set of properties may not vary for a given STM32MPU.
{{Warning|This device tree part is related to STM32 microprocessors. It must be kept as is, without being modified by the end-user.}}

=== DT configuration (board level) ===

The I2S is an audio peripheral, which can be used as a component of a soundcard through Linux<sup>&reg;</sup> kernel [[ALSA overview|ALSA framework]]. This part of the device tree allows the configuration of the I2S to implement a soundcard. Refer to [[Soundcard configuration|soundcard configuration]] for examples of I2S configuration for various boards.

=== DT configuration examples ===

====  Setting I2S as a master clock provider ====

The I2S peripheral can provide a clock to a codec through the MCLK output pin. In this case, it acts as master clock provider. The below DT sample gives an example of I2S configuration as a master clock provider.

 &i2s2 {
 	...
 	i2s2: audio-controller@4000b000 {
 		#clock-cells = <0>; {{highlight|/* Set I2S2 as master clock provider */}}
 		...
 		i2s2_endpoint: endpoint {
 			mclk-fs = <256>; {{highlight|/* Set mclk/fs ratio. (256 or 512) */}}
 		};
 	};
 };

The codec has to be declared as a consumer of the I2S MCLK provider, in the Device Tree.

 codec: {
 	clocks = <&i2s2>;     {{highlight|/* The codec is a consumer of I2S2 master clock */}}
 	clock-names = "MCLK"; {{highlight|/* Feed MCLK codec clock with I2S2 master clock provider */}}
 	...
 };

Then as a consumer of the MCLK clock, the codec driver can enable the clock using the clock framework API.

An alternative is to enable the MCLK clock dynamically at runtime, using the ASoC DAPM mechanism.
In this case the codec driver has to implement a '''DAPM clock supply widget''' through SND_SOC_DAPM_SUPPLY macro. An example of such DAPM widget can be found in Cirrus CS42L51 codec source code<ref name="CS42L51 code">{{CodeSource | Linux kernel | sound/soc/codecs/cs42l51.c}}</ref>. 
To allow MCLK activation/deactivation, '''DAPM routes''' must also be defined in the DT, between MCLK and audio stream widgets. These routes are defined in the sound card node, as shown below. 

 soundcard {
 	routing =
 		"Playback" , "MCLK", {{highlight|/* Set a route between "MCLK" and "playback" DAPM widgets */}}
 		"Capture" , "MCLK";  {{highlight|/* Set a route between "MCLK" and "capture" DAPM widgets */}}
 	...
 };

==How to configure the DT using STM32CubeMX==
The [[STM32CubeMX]] tool can be used to configure the STM32MPU device and get the corresponding [[Device_tree#STM32|platform configuration device tree]] files.<br />

STM32CubeMX may not support all the properties described in the above [[#DT bindings documentation|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 are preserved from one generation to another. Refer to the [[STM32CubeMX]] user manual for further information.
{{Warning|STM32CubeMX does not allow the generation of all the nodes required to configure a soundcard.
The soundcard node and the codec following nodes have to be filled manually through user sections.}}
 :
* soundcard node
* codec node
* i2s node is not fully filled and has to be updated manually. The clock muxings, in STM32CubeMX clock tree panel, allows to configure a single parent clock for the I2S internal peripheral. However, for the I2S peripheral, the device tree has to define two parent clocks "x8k" and "x11k", allowing the [[I2S Linux driver]] to choose dynamically the most appropriated clock at runtime. Refer to the I2S device tree bindings <ref name="i2s bindings">{{CodeSource | Linux kernel | Documentation/devicetree/bindings/sound/st,stm32-i2s.yaml}}</ref> and to the [[I2S Linux driver#Short_Description | I2S driver description]] for further information.
}}
==References==
<references />

<noinclude>

[[Category:Device tree configuration]]
[[Category:ALSA]]
{{ArticleBasedOnModel | Peripheral or framework device tree configuration model}}
{{PublicationRequestId | 13535 | 2019-10-04 | }}</noinclude>
(20 intermediate revisions by 4 users not shown)
Line 1: Line 1:
  +
<noinclude>{{ApplicableFor
  +
|MPUs list=STM32MP13x, STM32MP15x
  +
|MPUs checklist=STM32MP13x, STM32MP15x
  +
}}</noinclude>
  +
 
== Article purpose ==
 
== Article purpose ==
 
This article explains how to configure the [[SPI internal peripheral|SPI/I2S 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 [[SPI internal peripheral|SPI/I2S internal peripheral]] when it is assigned to the '''Linux® OS'''. In that case, it is controlled by the [[ALSA_overview|ALSA framework]].
Line 7: Line 12:
   
 
== DT bindings documentation ==
 
== DT bindings documentation ==
STM32 I2S device tree bindings <ref name="i2s bindings">{{CodeSource | Linux kernel | Documentation/devicetree/bindings/sound/st,stm32-i2s.txt}}</ref> describes all the required and optional configuration properties.
+
STM32 I2S device tree bindings <ref name="i2s bindings">{{CodeSource | Linux kernel | Documentation/devicetree/bindings/sound/st,stm32-i2s.yaml}}</ref> describes all the required and optional configuration properties.
   
 
== DT configuration ==
 
== DT configuration ==
Line 15: Line 20:
   
 
=== DT configuration (STM32 level) ===
 
=== DT configuration (STM32 level) ===
The I2S node is declared in stm32mp151.dtsi<ref name="stm32mp151.dtsi">{{CodeSource | Linux kernel | arch/arm/boot/dts/stm32mp151.dtsi}}</ref>.  
+
On {{MicroprocessorDevice | device=13}}, the I2S nodes are declared in stm32mp131.dtsi<ref name="stm32mp131.dtsi">{{CodeSource | Linux kernel | arch/arm/boot/dts/stm32mp131.dtsi | STM32MP131 device tree file}}</ref>.<br/>
It describes the hardware parameters such as register addresses, interrupt, clock, and DMA. This set of properties may not vary for a given STM32MPU.
+
 
  +
On {{MicroprocessorDevice | device=15}}, the I2S nodes are declared in stm32mp151.dtsi<ref name="stm32mp151_dtsi">{{CodeSource | Linux kernel | arch/arm/boot/dts/stm32mp151.dtsi | STM32MP151 device tree file}}</ref>.
  +
 
  +
This device tree describes the hardware parameters such as register addresses, interrupt, clock, and DMA. This set of properties may not vary for a given STM32MPU.
  +
 
 
{{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.}}
   
Line 22: Line 31:
   
 
The I2S is an audio peripheral, which can be used as a component of a soundcard through Linux<sup>&reg;</sup> kernel [[ALSA overview|ALSA framework]]. This part of the device tree allows the configuration of the I2S to implement a soundcard. Refer to [[Soundcard configuration|soundcard configuration]] for examples of I2S configuration for various boards.
 
The I2S is an audio peripheral, which can be used as a component of a soundcard through Linux<sup>&reg;</sup> kernel [[ALSA overview|ALSA framework]]. This part of the device tree allows the configuration of the I2S to implement a soundcard. Refer to [[Soundcard configuration|soundcard configuration]] for examples of I2S configuration for various boards.
  +
  +
=== DT configuration examples ===
  +
  +
====  Setting I2S as a master clock provider ====
  +
  +
The I2S peripheral can provide a clock to a codec through the MCLK output pin. In this case, it acts as master clock provider. The below DT sample gives an example of I2S configuration as a master clock provider.
  +
  +
&i2s2 {
  +
...
  +
i2s2: audio-controller@4000b000 {
  +
#clock-cells = <0>; {{highlight|/* Set I2S2 as master clock provider */}}
  +
...
  +
i2s2_endpoint: endpoint {
  +
mclk-fs = <256>; {{highlight|/* Set mclk/fs ratio. (256 or 512) */}}
  +
};
  +
};
  +
};
  +
  +
The codec has to be declared as a consumer of the I2S MCLK provider, in the Device Tree.
  +
  +
codec: {
  +
clocks = <&i2s2>;    {{highlight|/* The codec is a consumer of I2S2 master clock */}}
  +
clock-names = "MCLK"; {{highlight|/* Feed MCLK codec clock with I2S2 master clock provider */}}
  +
...
  +
};
  +
  +
Then as a consumer of the MCLK clock, the codec driver can enable the clock using the clock framework API.
  +
  +
An alternative is to enable the MCLK clock dynamically at runtime, using the ASoC DAPM mechanism.
  +
In this case the codec driver has to implement a '''DAPM clock supply widget''' through SND_SOC_DAPM_SUPPLY macro. An example of such DAPM widget can be found in Cirrus CS42L51 codec source code<ref name="CS42L51 code">{{CodeSource | Linux kernel | sound/soc/codecs/cs42l51.c}}</ref>.
  +
To allow MCLK activation/deactivation, '''DAPM routes''' must also be defined in the DT, between MCLK and audio stream widgets. These routes are defined in the sound card node, as shown below.
  +
  +
soundcard {
  +
routing =
  +
"Playback" , "MCLK", {{highlight|/* Set a route between "MCLK" and "playback" DAPM widgets */}}
  +
"Capture" , "MCLK";  {{highlight|/* Set a route between "MCLK" and "capture" DAPM widgets */}}
  +
...
  +
};
   
 
==How to configure the DT using STM32CubeMX==
 
==How to configure the DT using STM32CubeMX==
 
The [[STM32CubeMX]] tool can be used to configure the STM32MPU device and get the corresponding [[Device_tree#STM32|platform configuration device tree]] files.<br />
 
The [[STM32CubeMX]] tool can be used to configure the STM32MPU device and get the corresponding [[Device_tree#STM32|platform configuration device tree]] files.<br />
 
STM32CubeMX may not support all the properties described in the above [[#DT bindings documentation|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 are preserved from one generation to another. Refer to the [[STM32CubeMX]] user manual for further information.
 
STM32CubeMX may not support all the properties described in the above [[#DT bindings documentation|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 are preserved from one generation to another. Refer to the [[STM32CubeMX]] user manual for further information.
{{Warning|STM32CubeMX does not allow the generation of all the nodes required to configure a soundcard. The soundcard node and the codec nodes have to be filled manually through user sections.}}
+
 
  +
{{Warning|STM32CubeMX does not allow the generation of all the nodes required to configure a soundcard.
  +
The following nodes have to be filled manually through user sections :
  +
* soundcard node
  +
* codec node
  +
* i2s node is not fully filled and has to be updated manually. The clock muxings, in STM32CubeMX clock tree panel, allows to configure a single parent clock for the I2S internal peripheral. However, for the I2S peripheral, the device tree has to define two parent clocks "x8k" and "x11k", allowing the [[I2S Linux driver]] to choose dynamically the most appropriated clock at runtime. Refer to the I2S device tree bindings <ref name="i2s bindings">{{CodeSource | Linux kernel | Documentation/devicetree/bindings/sound/st,stm32-i2s.yaml}}</ref> and to the [[I2S Linux driver#Short_Description | I2S driver description]] for further information.
  +
}}
   
 
==References==
 
==References==