aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/sound
diff options
context:
space:
mode:
authorLiam Girdwood <liam.r.girdwood@linux.intel.com>2014-01-07 12:51:41 -0500
committerMark Brown <broonie@linaro.org>2014-01-07 12:56:32 -0500
commitd9e9ff5a8ed3752b659c996eb8a7c7eb4ec9a080 (patch)
tree72594765619c4a820c99f4f02fdcb83439f9f994 /Documentation/sound
parent6ce4eac1f600b34f2f7f58f9cd8f0503d79e42ae (diff)
ASoC: docs: Update the Overview document
Update the ASoC overview to bring it up to date with the current code base and include multi-component. Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com> Signed-off-by: Mark Brown <broonie@linaro.org>
Diffstat (limited to 'Documentation/sound')
-rw-r--r--Documentation/sound/alsa/soc/overview.txt27
1 files changed, 18 insertions, 9 deletions
diff --git a/Documentation/sound/alsa/soc/overview.txt b/Documentation/sound/alsa/soc/overview.txt
index 138ac88c1461..ff88f52eec98 100644
--- a/Documentation/sound/alsa/soc/overview.txt
+++ b/Documentation/sound/alsa/soc/overview.txt
@@ -49,18 +49,23 @@ features :-
49 * Machine specific controls: Allow machines to add controls to the sound card 49 * Machine specific controls: Allow machines to add controls to the sound card
50 (e.g. volume control for speaker amplifier). 50 (e.g. volume control for speaker amplifier).
51 51
52To achieve all this, ASoC basically splits an embedded audio system into 3 52To achieve all this, ASoC basically splits an embedded audio system into
53components :- 53multiple re-usable component drivers :-
54 54
55 * Codec driver: The codec driver is platform independent and contains audio 55 * Codec class drivers: The codec class driver is platform independent and
56 controls, audio interface capabilities, codec DAPM definition and codec IO 56 contains audio controls, audio interface capabilities, codec DAPM
57 functions. 57 definition and codec IO functions. This class extends to BT, FM and MODEM
58 ICs if required. Codec class drivers should be generic code that can run
59 on any architecture and machine.
58 60
59 * Platform driver: The platform driver contains the audio DMA engine and audio 61 * Platform class drivers: The platform class driver includes the audio DMA
60 interface drivers (e.g. I2S, AC97, PCM) for that platform. 62 engine driver, digital audio interface (DAI) drivers (e.g. I2S, AC97, PCM)
63 and any audio DSP drivers for that platform.
61 64
62 * Machine driver: The machine driver handles any machine specific controls and 65 * Machine class driver: The machine driver class acts as the glue that
63 audio events (e.g. turning on an amp at start of playback). 66 decribes and binds the other component drivers together to form an ALSA
67 "sound card device". It handles any machine specific controls and
68 machine level audio events (e.g. turning on an amp at start of playback).
64 69
65 70
66Documentation 71Documentation
@@ -84,3 +89,7 @@ machine.txt: Machine driver internals.
84pop_clicks.txt: How to minimise audio artifacts. 89pop_clicks.txt: How to minimise audio artifacts.
85 90
86clocking.txt: ASoC clocking for best power performance. 91clocking.txt: ASoC clocking for best power performance.
92
93jack.txt: ASoC jack detection.
94
95DPCM.txt: Dynamic PCM - Describes DPCM with DSP examples.