tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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>
+158
-143
+1
-1
Documentation/DocBook/Makefile
+1
-1
Documentation/DocBook/Makefile
···
13
13
gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
14
14
genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \
15
15
debugobjects.xml sh.xml regulator.xml \
16
-
alsa-driver-api.xml writing-an-alsa-driver.xml \
16
+
writing-an-alsa-driver.xml \
17
17
tracepoint.xml w1.xml \
18
18
writing_musb_glue_layer.xml crypto-API.xml iio.xml
19
19
-142
Documentation/DocBook/alsa-driver-api.tmpl
-142
Documentation/DocBook/alsa-driver-api.tmpl
···
1
-
<?xml version="1.0" encoding="UTF-8"?>
2
-
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
-
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
4
-
5
-
<!-- ****************************************************** -->
6
-
<!-- Header -->
7
-
<!-- ****************************************************** -->
8
-
<book id="ALSA-Driver-API">
9
-
<bookinfo>
10
-
<title>The ALSA Driver API</title>
11
-
12
-
<legalnotice>
13
-
<para>
14
-
This document is free; you can redistribute it and/or modify it
15
-
under the terms of the GNU General Public License as published by
16
-
the Free Software Foundation; either version 2 of the License, or
17
-
(at your option) any later version.
18
-
</para>
19
-
20
-
<para>
21
-
This document is distributed in the hope that it will be useful,
22
-
but <emphasis>WITHOUT ANY WARRANTY</emphasis>; without even the
23
-
implied warranty of <emphasis>MERCHANTABILITY or FITNESS FOR A
24
-
PARTICULAR PURPOSE</emphasis>. See the GNU General Public License
25
-
for more details.
26
-
</para>
27
-
28
-
<para>
29
-
You should have received a copy of the GNU General Public
30
-
License along with this program; if not, write to the Free
31
-
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
32
-
MA 02111-1307 USA
33
-
</para>
34
-
</legalnotice>
35
-
36
-
</bookinfo>
37
-
38
-
<toc></toc>
39
-
40
-
<chapter><title>Management of Cards and Devices</title>
41
-
<sect1><title>Card Management</title>
42
-
!Esound/core/init.c
43
-
</sect1>
44
-
<sect1><title>Device Components</title>
45
-
!Esound/core/device.c
46
-
</sect1>
47
-
<sect1><title>Module requests and Device File Entries</title>
48
-
!Esound/core/sound.c
49
-
</sect1>
50
-
<sect1><title>Memory Management Helpers</title>
51
-
!Esound/core/memory.c
52
-
!Esound/core/memalloc.c
53
-
</sect1>
54
-
</chapter>
55
-
<chapter><title>PCM API</title>
56
-
<sect1><title>PCM Core</title>
57
-
!Esound/core/pcm.c
58
-
!Esound/core/pcm_lib.c
59
-
!Esound/core/pcm_native.c
60
-
!Iinclude/sound/pcm.h
61
-
</sect1>
62
-
<sect1><title>PCM Format Helpers</title>
63
-
!Esound/core/pcm_misc.c
64
-
</sect1>
65
-
<sect1><title>PCM Memory Management</title>
66
-
!Esound/core/pcm_memory.c
67
-
</sect1>
68
-
<sect1><title>PCM DMA Engine API</title>
69
-
!Esound/core/pcm_dmaengine.c
70
-
!Iinclude/sound/dmaengine_pcm.h
71
-
</sect1>
72
-
</chapter>
73
-
<chapter><title>Control/Mixer API</title>
74
-
<sect1><title>General Control Interface</title>
75
-
!Esound/core/control.c
76
-
</sect1>
77
-
<sect1><title>AC97 Codec API</title>
78
-
!Esound/pci/ac97/ac97_codec.c
79
-
!Esound/pci/ac97/ac97_pcm.c
80
-
</sect1>
81
-
<sect1><title>Virtual Master Control API</title>
82
-
!Esound/core/vmaster.c
83
-
!Iinclude/sound/control.h
84
-
</sect1>
85
-
</chapter>
86
-
<chapter><title>MIDI API</title>
87
-
<sect1><title>Raw MIDI API</title>
88
-
!Esound/core/rawmidi.c
89
-
</sect1>
90
-
<sect1><title>MPU401-UART API</title>
91
-
!Esound/drivers/mpu401/mpu401_uart.c
92
-
</sect1>
93
-
</chapter>
94
-
<chapter><title>Proc Info API</title>
95
-
<sect1><title>Proc Info Interface</title>
96
-
!Esound/core/info.c
97
-
</sect1>
98
-
</chapter>
99
-
<chapter><title>Compress Offload</title>
100
-
<sect1><title>Compress Offload API</title>
101
-
!Esound/core/compress_offload.c
102
-
!Iinclude/uapi/sound/compress_offload.h
103
-
!Iinclude/uapi/sound/compress_params.h
104
-
!Iinclude/sound/compress_driver.h
105
-
</sect1>
106
-
</chapter>
107
-
<chapter><title>ASoC</title>
108
-
<sect1><title>ASoC Core API</title>
109
-
!Iinclude/sound/soc.h
110
-
!Esound/soc/soc-core.c
111
-
<!-- !Esound/soc/soc-cache.c no docbook comments here -->
112
-
!Esound/soc/soc-devres.c
113
-
!Esound/soc/soc-io.c
114
-
!Esound/soc/soc-pcm.c
115
-
!Esound/soc/soc-ops.c
116
-
!Esound/soc/soc-compress.c
117
-
</sect1>
118
-
<sect1><title>ASoC DAPM API</title>
119
-
!Esound/soc/soc-dapm.c
120
-
</sect1>
121
-
<sect1><title>ASoC DMA Engine API</title>
122
-
!Esound/soc/soc-generic-dmaengine-pcm.c
123
-
</sect1>
124
-
</chapter>
125
-
<chapter><title>Miscellaneous Functions</title>
126
-
<sect1><title>Hardware-Dependent Devices API</title>
127
-
!Esound/core/hwdep.c
128
-
</sect1>
129
-
<sect1><title>Jack Abstraction Layer API</title>
130
-
!Iinclude/sound/jack.h
131
-
!Esound/core/jack.c
132
-
!Esound/soc/soc-jack.c
133
-
</sect1>
134
-
<sect1><title>ISA DMA Helpers</title>
135
-
!Esound/core/isadma.c
136
-
</sect1>
137
-
<sect1><title>Other Helper Macros</title>
138
-
!Iinclude/sound/core.h
139
-
</sect1>
140
-
</chapter>
141
-
142
-
</book>
+1
Documentation/index.rst
+1
Documentation/index.rst
+15
Documentation/sound/index.rst
+15
Documentation/sound/index.rst
+134
Documentation/sound/kernel-api/alsa-driver-api.rst
+134
Documentation/sound/kernel-api/alsa-driver-api.rst
···
1
+
===================
2
+
The ALSA Driver API
3
+
===================
4
+
5
+
Management of Cards and Devices
6
+
===============================
7
+
8
+
Card Management
9
+
---------------
10
+
.. kernel-doc:: sound/core/init.c
11
+
12
+
Device Components
13
+
-----------------
14
+
.. kernel-doc:: sound/core/device.c
15
+
16
+
Module requests and Device File Entries
17
+
---------------------------------------
18
+
.. kernel-doc:: sound/core/sound.c
19
+
20
+
Memory Management Helpers
21
+
-------------------------
22
+
.. kernel-doc:: sound/core/memory.c
23
+
.. kernel-doc:: sound/core/memalloc.c
24
+
25
+
26
+
PCM API
27
+
=======
28
+
29
+
PCM Core
30
+
--------
31
+
.. kernel-doc:: sound/core/pcm.c
32
+
.. kernel-doc:: sound/core/pcm_lib.c
33
+
.. kernel-doc:: sound/core/pcm_native.c
34
+
.. kernel-doc:: include/sound/pcm.h
35
+
36
+
PCM Format Helpers
37
+
------------------
38
+
.. kernel-doc:: sound/core/pcm_misc.c
39
+
40
+
PCM Memory Management
41
+
---------------------
42
+
.. kernel-doc:: sound/core/pcm_memory.c
43
+
44
+
PCM DMA Engine API
45
+
------------------
46
+
.. kernel-doc:: sound/core/pcm_dmaengine.c
47
+
.. kernel-doc:: include/sound/dmaengine_pcm.h
48
+
49
+
Control/Mixer API
50
+
=================
51
+
52
+
General Control Interface
53
+
-------------------------
54
+
.. kernel-doc:: sound/core/control.c
55
+
56
+
AC97 Codec API
57
+
--------------
58
+
.. kernel-doc:: sound/pci/ac97/ac97_codec.c
59
+
.. kernel-doc:: sound/pci/ac97/ac97_pcm.c
60
+
61
+
Virtual Master Control API
62
+
--------------------------
63
+
.. kernel-doc:: sound/core/vmaster.c
64
+
.. kernel-doc:: include/sound/control.h
65
+
66
+
MIDI API
67
+
========
68
+
69
+
Raw MIDI API
70
+
------------
71
+
.. kernel-doc:: sound/core/rawmidi.c
72
+
73
+
MPU401-UART API
74
+
---------------
75
+
.. kernel-doc:: sound/drivers/mpu401/mpu401_uart.c
76
+
77
+
Proc Info API
78
+
=============
79
+
80
+
Proc Info Interface
81
+
-------------------
82
+
.. kernel-doc:: sound/core/info.c
83
+
84
+
Compress Offload
85
+
================
86
+
87
+
Compress Offload API
88
+
--------------------
89
+
.. kernel-doc:: sound/core/compress_offload.c
90
+
.. kernel-doc:: include/uapi/sound/compress_offload.h
91
+
.. kernel-doc:: include/uapi/sound/compress_params.h
92
+
.. kernel-doc:: include/sound/compress_driver.h
93
+
94
+
ASoC
95
+
====
96
+
97
+
ASoC Core API
98
+
-------------
99
+
.. kernel-doc:: include/sound/soc.h
100
+
.. kernel-doc:: sound/soc/soc-core.c
101
+
.. kernel-doc:: sound/soc/soc-devres.c
102
+
.. kernel-doc:: sound/soc/soc-io.c
103
+
.. kernel-doc:: sound/soc/soc-pcm.c
104
+
.. kernel-doc:: sound/soc/soc-ops.c
105
+
.. kernel-doc:: sound/soc/soc-compress.c
106
+
107
+
ASoC DAPM API
108
+
-------------
109
+
.. kernel-doc:: sound/soc/soc-dapm.c
110
+
111
+
ASoC DMA Engine API
112
+
-------------------
113
+
.. kernel-doc:: sound/soc/soc-generic-dmaengine-pcm.c
114
+
115
+
Miscellaneous Functions
116
+
=======================
117
+
118
+
Hardware-Dependent Devices API
119
+
------------------------------
120
+
.. kernel-doc:: sound/core/hwdep.c
121
+
122
+
Jack Abstraction Layer API
123
+
--------------------------
124
+
.. kernel-doc:: include/sound/jack.h
125
+
.. kernel-doc:: sound/core/jack.c
126
+
.. kernel-doc:: sound/soc/soc-jack.c
127
+
128
+
ISA DMA Helpers
129
+
---------------
130
+
.. kernel-doc:: sound/core/isadma.c
131
+
132
+
Other Helper Macros
133
+
-------------------
134
+
.. kernel-doc:: include/sound/core.h