Registered User mNo edit summary |
Registered User No edit summary |
||
(27 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
{{ApplicableFor | |||
|MPUs list=STM32MP13x, STM32MP15x | |MPUs list=STM32MP13x, STM32MP15x, STM32MP25x | ||
|MPUs checklist=STM32MP13x,STM32MP15x | |MPUs checklist=STM32MP13x, STM32MP15x, STM32MP25x | ||
}}</noinclude> | }} | ||
<noinclude></noinclude> | |||
== Article purpose == | == Article purpose == | ||
This article introduces the I2S Linux<sup>®</sup> driver for the [[SPI internal peripheral|SPI/I2S internal peripheral]]. | This article introduces the I2S Linux<sup>®</sup> driver for the [[SPI internal peripheral|SPI/I2S internal peripheral]]. | ||
Line 9: | Line 10: | ||
The I2S Linux driver is an ASoC CPU DAI driver implemented in the Linux [[ALSA_overview|ALSA framework]]. | The I2S Linux driver is an ASoC CPU DAI driver implemented in the Linux [[ALSA_overview|ALSA framework]]. | ||
The | {{Info| | ||
The SPI/I2S2 and SPI/I2S3 internal peripherals share the same parent clock, which can result in a conflict on clock configuration if I2S2 and I2S3 are used to run audio streams with incompatible rates (i.e. rates not multiples of each other). | |||
* On STM32MP15x lines, the I2S driver does not protect against such conflicts by itself. | |||
* On STM32MP25x lines, the I2S driver manages such conflicts by rejecting the incompatible stream. | |||
}} | |||
== Configuration == | == Configuration == | ||
Line 49: | Line 45: | ||
* debugfs entries: | * debugfs entries: | ||
:* '''asoc''': refer to [[ALSA_overview#How_to_monitor]] | :* '''asoc''': refer to [[ALSA_overview#How_to_monitor]] | ||
:* '''clk''': refer to [[Clock_overview# | :* '''clk''': refer to [[Clock_overview#How_to_monitor_with_debugfs_of_clock_framework]] to get information on clocks. | ||
:* '''pinctrl''': refer to [[Pinctrl_overview#How_to_monitor]] to get information on pins. | :* '''pinctrl''': refer to [[Pinctrl_overview#How_to_monitor]] to get information on pins. | ||
:* '''regmap''': allow to monitor SPI/I2S peripheral registers. | :* '''regmap''': allow to monitor SPI/I2S peripheral registers. | ||
Line 69: | Line 65: | ||
<noinclude> | <noinclude> | ||
{{ArticleBasedOnModel | | {{ArticleBasedOnModel | OpenSTLinux drivers article model}} | ||
{{PublicationRequestId | 10338 | 2019-01-29}} | {{PublicationRequestId | 10338 | 2019-01-29}} | ||
[[Category:ALSA]] | [[Category:ALSA]] | ||
</noinclude> | </noinclude> |
Revision as of 16:34, 10 November 2023
1. Article purpose[edit | edit source]
This article introduces the I2S Linux® driver for the SPI/I2S internal peripheral.
2. Short Description[edit | edit source]
The I2S Linux driver is an ASoC CPU DAI driver implemented in the Linux ALSA framework.
3. Configuration[edit | edit source]
3.1. Kernel Configuration[edit | edit source]
Activate the I2S Linux driver in the kernel configuration using the Linux Menuconfig tool: Menuconfig or how to configure kernel.
Linux Sound Architecture [*] ALSA for SoC audio support STMicroelectronics STM32 SOC audio support [*] STM32 I2S interface (SPI/I2S block) support[*] Device Drivers [*] Sound card support [*] Advanced
3.2. Device tree[edit | edit source]
Refer to the I2S_device_tree_configuration article when configuring the I2S Linux kernel driver.
4. How to use[edit | edit source]
The I2S Linux driver can be accessed from userland through an ALSA device. Refer to ALSA overview for information on how to list and use ALSA devices.
5. How to trace and debug[edit | edit source]
The debugfs and procfs file system can be checked to get information on the I2S driver and the resources it uses. A non-exhaustive list of these file system entries is provided below. Refer to ALSA overview for more details on debugging tools.
- debugfs entries:
- asoc: refer to ALSA_overview#How_to_monitor
- clk: refer to Clock_overview#How_to_monitor_with_debugfs_of_clock_framework to get information on clocks.
- pinctrl: refer to Pinctrl_overview#How_to_monitor to get information on pins.
- regmap: allow to monitor SPI/I2S peripheral registers.
$ cat /sys/kernel/debug/regmap/xxx.audio-controller/registers
- procfs entries:
- asound: refer to ALSA_overview#How_to_debug
- interrupts: allow to check interrupts.
$ cat /proc/interrupts
6. Source code location[edit | edit source]
sound/soc/stm/stm32_i2s.c : implements the I2S Linux driver.
7. References[edit | edit source]