tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
fork atom

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>

authored by

Liam Girdwood and committed by
Mark Brown d9e9ff5a 6ce4eac1

+18 -9
+18 -9
Documentation/sound/alsa/soc/overview.txt
··· 49 49 * Machine specific controls: Allow machines to add controls to the sound card 50 50 (e.g. volume control for speaker amplifier). 51 51 52 - To achieve all this, ASoC basically splits an embedded audio system into 3 53 - components :- 52 + To achieve all this, ASoC basically splits an embedded audio system into 53 + multiple re-usable component drivers :- 54 54 55 - * Codec driver: The codec driver is platform independent and contains audio 56 - controls, audio interface capabilities, codec DAPM definition and codec IO 57 - functions. 55 + * Codec class drivers: The codec class driver is platform independent and 56 + contains audio controls, audio interface capabilities, codec DAPM 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 60 - interface drivers (e.g. I2S, AC97, PCM) for that platform. 61 + * Platform class drivers: The platform class driver includes the audio DMA 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 63 - audio events (e.g. turning on an amp at start of playback). 65 + * Machine class driver: The machine driver class acts as the glue that 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 66 71 Documentation ··· 89 84 pop_clicks.txt: How to minimise audio artifacts. 90 85 91 86 clocking.txt: ASoC clocking for best power performance. 87 + 88 + jack.txt: ASoC jack detection. 89 + 90 + DPCM.txt: Dynamic PCM - Describes DPCM with DSP examples.