-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ALSA: doc: ReSTize alsa-driver-api document
A simple conversion of alsa-driver-api document from DocBook to ReST. It's moved to the new Documentation/sound/kernel-api subdirectory that will contain other ALSA kernel API documents. The GPL legal note was removed, as it's superfluous (and doesn't fit with ReST kernel docs pretty well). Signed-off-by: Takashi Iwai <tiwai@suse.de>
- Loading branch information
Takashi Iwai
committed
Nov 10, 2016
1 parent
3a5182c
commit 8551914
Showing
6 changed files
with
158 additions
and
143 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,6 +18,7 @@ Contents: | |
media/index | ||
gpu/index | ||
80211/index | ||
sound/index | ||
|
||
Indices and tables | ||
================== | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
=================================== | ||
Linux Sound Subsystem Documentation | ||
=================================== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
kernel-api/index | ||
|
||
.. only:: subproject | ||
|
||
Indices | ||
======= | ||
|
||
* :ref:`genindex` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,134 @@ | ||
=================== | ||
The ALSA Driver API | ||
=================== | ||
|
||
Management of Cards and Devices | ||
=============================== | ||
|
||
Card Management | ||
--------------- | ||
.. kernel-doc:: sound/core/init.c | ||
|
||
Device Components | ||
----------------- | ||
.. kernel-doc:: sound/core/device.c | ||
|
||
Module requests and Device File Entries | ||
--------------------------------------- | ||
.. kernel-doc:: sound/core/sound.c | ||
|
||
Memory Management Helpers | ||
------------------------- | ||
.. kernel-doc:: sound/core/memory.c | ||
.. kernel-doc:: sound/core/memalloc.c | ||
|
||
|
||
PCM API | ||
======= | ||
|
||
PCM Core | ||
-------- | ||
.. kernel-doc:: sound/core/pcm.c | ||
.. kernel-doc:: sound/core/pcm_lib.c | ||
.. kernel-doc:: sound/core/pcm_native.c | ||
.. kernel-doc:: include/sound/pcm.h | ||
|
||
PCM Format Helpers | ||
------------------ | ||
.. kernel-doc:: sound/core/pcm_misc.c | ||
|
||
PCM Memory Management | ||
--------------------- | ||
.. kernel-doc:: sound/core/pcm_memory.c | ||
|
||
PCM DMA Engine API | ||
------------------ | ||
.. kernel-doc:: sound/core/pcm_dmaengine.c | ||
.. kernel-doc:: include/sound/dmaengine_pcm.h | ||
|
||
Control/Mixer API | ||
================= | ||
|
||
General Control Interface | ||
------------------------- | ||
.. kernel-doc:: sound/core/control.c | ||
|
||
AC97 Codec API | ||
-------------- | ||
.. kernel-doc:: sound/pci/ac97/ac97_codec.c | ||
.. kernel-doc:: sound/pci/ac97/ac97_pcm.c | ||
|
||
Virtual Master Control API | ||
-------------------------- | ||
.. kernel-doc:: sound/core/vmaster.c | ||
.. kernel-doc:: include/sound/control.h | ||
|
||
MIDI API | ||
======== | ||
|
||
Raw MIDI API | ||
------------ | ||
.. kernel-doc:: sound/core/rawmidi.c | ||
|
||
MPU401-UART API | ||
--------------- | ||
.. kernel-doc:: sound/drivers/mpu401/mpu401_uart.c | ||
|
||
Proc Info API | ||
============= | ||
|
||
Proc Info Interface | ||
------------------- | ||
.. kernel-doc:: sound/core/info.c | ||
|
||
Compress Offload | ||
================ | ||
|
||
Compress Offload API | ||
-------------------- | ||
.. kernel-doc:: sound/core/compress_offload.c | ||
.. kernel-doc:: include/uapi/sound/compress_offload.h | ||
.. kernel-doc:: include/uapi/sound/compress_params.h | ||
.. kernel-doc:: include/sound/compress_driver.h | ||
|
||
ASoC | ||
==== | ||
|
||
ASoC Core API | ||
------------- | ||
.. kernel-doc:: include/sound/soc.h | ||
.. kernel-doc:: sound/soc/soc-core.c | ||
.. kernel-doc:: sound/soc/soc-devres.c | ||
.. kernel-doc:: sound/soc/soc-io.c | ||
.. kernel-doc:: sound/soc/soc-pcm.c | ||
.. kernel-doc:: sound/soc/soc-ops.c | ||
.. kernel-doc:: sound/soc/soc-compress.c | ||
|
||
ASoC DAPM API | ||
------------- | ||
.. kernel-doc:: sound/soc/soc-dapm.c | ||
|
||
ASoC DMA Engine API | ||
------------------- | ||
.. kernel-doc:: sound/soc/soc-generic-dmaengine-pcm.c | ||
|
||
Miscellaneous Functions | ||
======================= | ||
|
||
Hardware-Dependent Devices API | ||
------------------------------ | ||
.. kernel-doc:: sound/core/hwdep.c | ||
|
||
Jack Abstraction Layer API | ||
-------------------------- | ||
.. kernel-doc:: include/sound/jack.h | ||
.. kernel-doc:: sound/core/jack.c | ||
.. kernel-doc:: sound/soc/soc-jack.c | ||
|
||
ISA DMA Helpers | ||
--------------- | ||
.. kernel-doc:: sound/core/isadma.c | ||
|
||
Other Helper Macros | ||
------------------- | ||
.. kernel-doc:: include/sound/core.h |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
ALSA Kernel API Documentation | ||
============================= | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
alsa-driver-api |