blob: 06d835987c6a8f9d4454ca39b57ac13bed978c75 [file] [log] [blame]
Liam Girdwoodeb1a6af2006-10-06 18:34:51 +02001ASoC Platform Driver
2====================
3
4An ASoC platform driver can be divided into audio DMA and SoC DAI configuration
5and control. The platform drivers only target the SoC CPU and must have no board
6specific code.
7
8Audio DMA
9=========
10
Mark Brown7c4dbbd2008-01-23 08:41:46 +010011The platform DMA driver optionally supports the following ALSA operations:-
Liam Girdwoodeb1a6af2006-10-06 18:34:51 +020012
13/* SoC audio ops */
14struct snd_soc_ops {
Takashi Iwai5b78efd2006-11-24 16:12:50 +010015 int (*startup)(struct snd_pcm_substream *);
16 void (*shutdown)(struct snd_pcm_substream *);
17 int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
18 int (*hw_free)(struct snd_pcm_substream *);
19 int (*prepare)(struct snd_pcm_substream *);
20 int (*trigger)(struct snd_pcm_substream *, int);
Liam Girdwoodeb1a6af2006-10-06 18:34:51 +020021};
22
Matt LaPlante01dd2fb2007-10-20 01:34:40 +020023The platform driver exports its DMA functionality via struct snd_soc_platform:-
Liam Girdwoodeb1a6af2006-10-06 18:34:51 +020024
25struct snd_soc_platform {
26 char *name;
27
28 int (*probe)(struct platform_device *pdev);
29 int (*remove)(struct platform_device *pdev);
30 int (*suspend)(struct platform_device *pdev, struct snd_soc_cpu_dai *cpu_dai);
31 int (*resume)(struct platform_device *pdev, struct snd_soc_cpu_dai *cpu_dai);
32
33 /* pcm creation and destruction */
Takashi Iwai5b78efd2006-11-24 16:12:50 +010034 int (*pcm_new)(struct snd_card *, struct snd_soc_codec_dai *, struct snd_pcm *);
35 void (*pcm_free)(struct snd_pcm *);
Liam Girdwoodeb1a6af2006-10-06 18:34:51 +020036
37 /* platform stream ops */
Takashi Iwai5b78efd2006-11-24 16:12:50 +010038 struct snd_pcm_ops *pcm_ops;
Liam Girdwoodeb1a6af2006-10-06 18:34:51 +020039};
40
Mark Brown7c4dbbd2008-01-23 08:41:46 +010041Please refer to the ALSA driver documentation for details of audio DMA.
Justin P. Mattock0ea6e612010-07-23 20:51:24 -070042http://www.alsa-project.org/~iwai/writing-an-alsa-driver/
Liam Girdwoodeb1a6af2006-10-06 18:34:51 +020043
44An example DMA driver is soc/pxa/pxa2xx-pcm.c
45
46
47SoC DAI Drivers
48===============
49
50Each SoC DAI driver must provide the following features:-
51
52 1) Digital audio interface (DAI) description
53 2) Digital audio interface configuration
54 3) PCM's description
Mark Brown7c4dbbd2008-01-23 08:41:46 +010055 4) SYSCLK configuration
Liam Girdwoodeb1a6af2006-10-06 18:34:51 +020056 5) Suspend and resume (optional)
57
58Please see codec.txt for a description of items 1 - 4.