ASoC: doc: ReSTize overview.txt
A simple conversion from a plain text file. Created a new subdirectory, Documentation/sound/soc, for this and other ASoC documents. Since the index page contains the TOC, so "Documentation" section got removed from overview. Acked-by: Mark Brown <broonie@kernel.org> Signed-off-by: Takashi Iwai <tiwai@suse.de>
This commit is contained in:
@@ -7,6 +7,7 @@ Linux Sound Subsystem Documentation
|
|||||||
|
|
||||||
kernel-api/index
|
kernel-api/index
|
||||||
designs/index
|
designs/index
|
||||||
|
soc/index
|
||||||
alsa-configuration
|
alsa-configuration
|
||||||
hd-audio/index
|
hd-audio/index
|
||||||
cards/index
|
cards/index
|
||||||
|
10
Documentation/sound/soc/index.rst
Normal file
10
Documentation/sound/soc/index.rst
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
==============
|
||||||
|
ALSA SoC Layer
|
||||||
|
==============
|
||||||
|
|
||||||
|
The documentation is spilt into the following sections:-
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
overview
|
@@ -1,5 +1,6 @@
|
|||||||
ALSA SoC Layer
|
=======================
|
||||||
==============
|
ALSA SoC Layer Overview
|
||||||
|
=======================
|
||||||
|
|
||||||
The overall project goal of the ALSA System on Chip (ASoC) layer is to
|
The overall project goal of the ALSA System on Chip (ASoC) layer is to
|
||||||
provide better ALSA support for embedded system-on-chip processors (e.g.
|
provide better ALSA support for embedded system-on-chip processors (e.g.
|
||||||
@@ -66,30 +67,3 @@ multiple re-usable component drivers :-
|
|||||||
describes and binds the other component drivers together to form an ALSA
|
describes and binds the other component drivers together to form an ALSA
|
||||||
"sound card device". It handles any machine specific controls and
|
"sound card device". It handles any machine specific controls and
|
||||||
machine level audio events (e.g. turning on an amp at start of playback).
|
machine level audio events (e.g. turning on an amp at start of playback).
|
||||||
|
|
||||||
|
|
||||||
Documentation
|
|
||||||
=============
|
|
||||||
|
|
||||||
The documentation is spilt into the following sections:-
|
|
||||||
|
|
||||||
overview.txt: This file.
|
|
||||||
|
|
||||||
codec.txt: Codec driver internals.
|
|
||||||
|
|
||||||
DAI.txt: Description of Digital Audio Interface standards and how to configure
|
|
||||||
a DAI within your codec and CPU DAI drivers.
|
|
||||||
|
|
||||||
dapm.txt: Dynamic Audio Power Management
|
|
||||||
|
|
||||||
platform.txt: Platform audio DMA and DAI.
|
|
||||||
|
|
||||||
machine.txt: Machine driver internals.
|
|
||||||
|
|
||||||
pop_clicks.txt: How to minimise audio artifacts.
|
|
||||||
|
|
||||||
clocking.txt: ASoC clocking for best power performance.
|
|
||||||
|
|
||||||
jack.txt: ASoC jack detection.
|
|
||||||
|
|
||||||
DPCM.txt: Dynamic PCM - Describes DPCM with DSP examples.
|
|
Reference in New Issue
Block a user