Commit d8a5d624 authored by Takashi Iwai's avatar Takashi Iwai

ASoC: doc: ReSTize platform.txt

A simple conversion from a plain text file.
Acked-by: default avatarMark Brown <broonie@kernel.org>
Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent 77190f03
...@@ -11,3 +11,4 @@ The documentation is spilt into the following sections:- ...@@ -11,3 +11,4 @@ The documentation is spilt into the following sections:-
codec codec
dai dai
dapm dapm
platform
====================
ASoC Platform Driver ASoC Platform Driver
==================== ====================
...@@ -9,21 +10,23 @@ Audio DMA ...@@ -9,21 +10,23 @@ Audio DMA
========= =========
The platform DMA driver optionally supports the following ALSA operations:- The platform DMA driver optionally supports the following ALSA operations:-
::
/* SoC audio ops */ /* SoC audio ops */
struct snd_soc_ops { struct snd_soc_ops {
int (*startup)(struct snd_pcm_substream *); int (*startup)(struct snd_pcm_substream *);
void (*shutdown)(struct snd_pcm_substream *); void (*shutdown)(struct snd_pcm_substream *);
int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *); int (*hw_params)(struct snd_pcm_substream *, struct snd_pcm_hw_params *);
int (*hw_free)(struct snd_pcm_substream *); int (*hw_free)(struct snd_pcm_substream *);
int (*prepare)(struct snd_pcm_substream *); int (*prepare)(struct snd_pcm_substream *);
int (*trigger)(struct snd_pcm_substream *, int); int (*trigger)(struct snd_pcm_substream *, int);
}; };
The platform driver exports its DMA functionality via struct The platform driver exports its DMA functionality via struct
snd_soc_platform_driver:- snd_soc_platform_driver:-
::
struct snd_soc_platform_driver { struct snd_soc_platform_driver {
char *name; char *name;
int (*probe)(struct platform_device *pdev); int (*probe)(struct platform_device *pdev);
...@@ -44,7 +47,7 @@ struct snd_soc_platform_driver { ...@@ -44,7 +47,7 @@ struct snd_soc_platform_driver {
/* platform stream ops */ /* platform stream ops */
struct snd_pcm_ops *pcm_ops; struct snd_pcm_ops *pcm_ops;
}; };
Please refer to the ALSA driver documentation for details of audio DMA. Please refer to the ALSA driver documentation for details of audio DMA.
http://www.alsa-project.org/~iwai/writing-an-alsa-driver/ http://www.alsa-project.org/~iwai/writing-an-alsa-driver/
...@@ -57,11 +60,11 @@ SoC DAI Drivers ...@@ -57,11 +60,11 @@ SoC DAI Drivers
Each SoC DAI driver must provide the following features:- Each SoC DAI driver must provide the following features:-
1) Digital audio interface (DAI) description 1. Digital audio interface (DAI) description
2) Digital audio interface configuration 2. Digital audio interface configuration
3) PCM's description 3. PCM's description
4) SYSCLK configuration 4. SYSCLK configuration
5) Suspend and resume (optional) 5. Suspend and resume (optional)
Please see codec.txt for a description of items 1 - 4. Please see codec.txt for a description of items 1 - 4.
...@@ -71,9 +74,9 @@ SoC DSP Drivers ...@@ -71,9 +74,9 @@ SoC DSP Drivers
Each SoC DSP driver usually supplies the following features :- Each SoC DSP driver usually supplies the following features :-
1) DAPM graph 1. DAPM graph
2) Mixer controls 2. Mixer controls
3) DMA IO to/from DSP buffers (if applicable) 3. DMA IO to/from DSP buffers (if applicable)
4) Definition of DSP front end (FE) PCM devices. 4. Definition of DSP front end (FE) PCM devices.
Please see DPCM.txt for a description of item 4. Please see DPCM.txt for a description of item 4.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment