diff options
| author | Takashi Iwai <tiwai@suse.de> | 2016-11-10 22:23:02 +0100 |
|---|---|---|
| committer | Takashi Iwai <tiwai@suse.de> | 2016-11-11 17:33:46 +0100 |
| commit | d9641c9d63909ab452405f0a6a3fd6177a4a6b6d (patch) | |
| tree | 5c242da30fcb0eceb32a59c7aaaaaca6d9a3408a /Documentation/sound | |
| parent | d8a5d624cc39c416f008e52b940f47cf619dbd9e (diff) | |
| download | linux-d9641c9d63909ab452405f0a6a3fd6177a4a6b6d.tar.gz linux-d9641c9d63909ab452405f0a6a3fd6177a4a6b6d.tar.bz2 linux-d9641c9d63909ab452405f0a6a3fd6177a4a6b6d.zip | |
ASoC: doc: ReSTize machine.txt
A simple conversion from a plain text file.
Acked-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
Diffstat (limited to 'Documentation/sound')
| -rw-r--r-- | Documentation/sound/soc/index.rst | 1 | ||||
| -rw-r--r-- | Documentation/sound/soc/machine.rst (renamed from Documentation/sound/alsa/soc/machine.txt) | 22 |
2 files changed, 14 insertions, 9 deletions
diff --git a/Documentation/sound/soc/index.rst b/Documentation/sound/soc/index.rst index c5a55195bf4d..4ac3585e7dd1 100644 --- a/Documentation/sound/soc/index.rst +++ b/Documentation/sound/soc/index.rst @@ -12,3 +12,4 @@ The documentation is spilt into the following sections:- dai dapm platform + machine diff --git a/Documentation/sound/alsa/soc/machine.txt b/Documentation/sound/soc/machine.rst index 6bf2d2063b52..515c9444deaf 100644 --- a/Documentation/sound/alsa/soc/machine.txt +++ b/Documentation/sound/soc/machine.rst @@ -1,3 +1,4 @@ +=================== ASoC Machine Driver =================== @@ -9,9 +10,10 @@ interrupts, clocking, jacks and voltage regulators. The machine driver can contain codec and platform specific code. It registers the audio subsystem with the kernel as a platform device and is represented by the following struct:- +:: -/* SoC machine */ -struct snd_soc_card { + /* SoC machine */ + struct snd_soc_card { char *name; ... @@ -33,7 +35,7 @@ struct snd_soc_card { int num_links; ... -}; + }; probe()/remove() ---------------- @@ -55,9 +57,10 @@ initialisation e.g. the machine audio map can be connected to the codec audio map, unconnected codec pins can be set as such. struct snd_soc_dai_link is used to set up each DAI in your machine. e.g. +:: -/* corgi digital audio interface glue - connects codec <--> CPU */ -static struct snd_soc_dai_link corgi_dai = { + /* corgi digital audio interface glue - connects codec <--> CPU */ + static struct snd_soc_dai_link corgi_dai = { .name = "WM8731", .stream_name = "WM8731", .cpu_dai_name = "pxa-is2-dai", @@ -66,16 +69,17 @@ static struct snd_soc_dai_link corgi_dai = { .codec_name = "wm8713-codec.0-001a", .init = corgi_wm8731_init, .ops = &corgi_ops, -}; + }; struct snd_soc_card then sets up the machine with its DAIs. e.g. +:: -/* corgi audio machine driver */ -static struct snd_soc_card snd_soc_corgi = { + /* corgi audio machine driver */ + static struct snd_soc_card snd_soc_corgi = { .name = "Corgi", .dai_link = &corgi_dai, .num_links = 1, -}; + }; Machine Power Map |