parisc: Map kernel text and data on huge pages
[linux-2.6-block.git] / Documentation / DocBook / alsa-driver-api.tmpl
CommitLineData
5f8206c0
TI
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" []>
1da177e4
LT
4
5<!-- ****************************************************** -->
6<!-- Header -->
7<!-- ****************************************************** -->
5f8206c0 8<book id="ALSA-Driver-API">
1da177e4
LT
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
5f8206c0
TI
38<toc></toc>
39
1da177e4 40 <chapter><title>Management of Cards and Devices</title>
5bda9fa1 41 <sect1><title>Card Management</title>
1da177e4
LT
42!Esound/core/init.c
43 </sect1>
44 <sect1><title>Device Components</title>
45!Esound/core/device.c
46 </sect1>
a81792f6 47 <sect1><title>Module requests and Device File Entries</title>
1da177e4
LT
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
67faa6eb 60!Iinclude/sound/pcm.h
1da177e4
LT
61 </sect1>
62 <sect1><title>PCM Format Helpers</title>
63!Esound/core/pcm_misc.c
64 </sect1>
5bda9fa1 65 <sect1><title>PCM Memory Management</title>
1da177e4
LT
66!Esound/core/pcm_memory.c
67 </sect1>
90446d07
TI
68 <sect1><title>PCM DMA Engine API</title>
69!Esound/core/pcm_dmaengine.c
70!Iinclude/sound/dmaengine_pcm.h
71 </sect1>
1da177e4
LT
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>
79c7cdd5
TI
81 <sect1><title>Virtual Master Control API</title>
82!Esound/core/vmaster.c
83!Iinclude/sound/control.h
84 </sect1>
1da177e4
LT
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>
90446d07
TI
99 <chapter><title>Compress Offload</title>
100 <sect1><title>Compress Offload API</title>
101!Esound/core/compress_offload.c
00dad6cf
TI
102!Iinclude/uapi/sound/compress_offload.h
103!Iinclude/uapi/sound/compress_params.h
90446d07
TI
104!Iinclude/sound/compress_driver.h
105 </sect1>
106 </chapter>
438f4e28
TI
107 <chapter><title>ASoC</title>
108 <sect1><title>ASoC Core API</title>
109!Iinclude/sound/soc.h
110!Esound/soc/soc-core.c
628536ea 111<!-- !Esound/soc/soc-cache.c no docbook comments here -->
438f4e28
TI
112!Esound/soc/soc-devres.c
113!Esound/soc/soc-io.c
114!Esound/soc/soc-pcm.c
115 </sect1>
116 <sect1><title>ASoC DAPM API</title>
117!Esound/soc/soc-dapm.c
118 </sect1>
119 <sect1><title>ASoC DMA Engine API</title>
120!Esound/soc/soc-generic-dmaengine-pcm.c
121 </sect1>
122 </chapter>
1da177e4
LT
123 <chapter><title>Miscellaneous Functions</title>
124 <sect1><title>Hardware-Dependent Devices API</title>
125!Esound/core/hwdep.c
662c319a
TI
126 </sect1>
127 <sect1><title>Jack Abstraction Layer API</title>
90446d07 128!Iinclude/sound/jack.h
438f4e28
TI
129!Esound/core/jack.c
130!Esound/soc/soc-jack.c
1da177e4
LT
131 </sect1>
132 <sect1><title>ISA DMA Helpers</title>
133!Esound/core/isadma.c
134 </sect1>
135 <sect1><title>Other Helper Macros</title>
136!Iinclude/sound/core.h
137 </sect1>
138 </chapter>
139
140</book>