Merge branch 'topic/vmaster-update' into topic/docbook-fix
[linux-2.6] / Documentation / sound / alsa / DocBook / alsa-driver-api.tmpl
1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
2
3 <book>
4 <?dbhtml filename="index.html">
5
6 <!-- ****************************************************** -->
7 <!-- Header  -->
8 <!-- ****************************************************** -->
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   <chapter><title>Management of Cards and Devices</title>
39      <sect1><title>Card Management</title>
40 !Esound/core/init.c
41      </sect1>
42      <sect1><title>Device Components</title>
43 !Esound/core/device.c
44      </sect1>
45      <sect1><title>Module requests and Device File Entries</title>
46 !Esound/core/sound.c
47      </sect1>
48      <sect1><title>Memory Management Helpers</title>
49 !Esound/core/memory.c
50 !Esound/core/memalloc.c
51      </sect1>
52   </chapter>
53   <chapter><title>PCM API</title>
54      <sect1><title>PCM Core</title>
55 !Esound/core/pcm.c
56 !Esound/core/pcm_lib.c
57 !Esound/core/pcm_native.c
58      </sect1>
59      <sect1><title>PCM Format Helpers</title>
60 !Esound/core/pcm_misc.c
61      </sect1>
62      <sect1><title>PCM Memory Management</title>
63 !Esound/core/pcm_memory.c
64      </sect1>
65   </chapter>
66   <chapter><title>Control/Mixer API</title>
67      <sect1><title>General Control Interface</title>
68 !Esound/core/control.c
69      </sect1>
70      <sect1><title>AC97 Codec API</title>
71 !Esound/pci/ac97/ac97_codec.c
72 !Esound/pci/ac97/ac97_pcm.c
73      </sect1>
74      <sect1><title>Virtual Master Control API</title>
75 !Esound/core/vmaster.c
76 !Iinclude/sound/control.h
77      </sect1>
78   </chapter>
79   <chapter><title>MIDI API</title>
80      <sect1><title>Raw MIDI API</title>
81 !Esound/core/rawmidi.c
82      </sect1>
83      <sect1><title>MPU401-UART API</title>
84 !Esound/drivers/mpu401/mpu401_uart.c
85      </sect1>
86   </chapter>
87   <chapter><title>Proc Info API</title>
88      <sect1><title>Proc Info Interface</title>
89 !Esound/core/info.c
90      </sect1>
91   </chapter>
92   <chapter><title>Miscellaneous Functions</title>
93      <sect1><title>Hardware-Dependent Devices API</title>
94 !Esound/core/hwdep.c
95      </sect1>
96      <sect1><title>Jack Abstraction Layer API</title>
97 !Esound/core/jack.c
98      </sect1>
99      <sect1><title>ISA DMA Helpers</title>
100 !Esound/core/isadma.c
101      </sect1>
102      <sect1><title>Other Helper Macros</title>
103 !Iinclude/sound/core.h
104      </sect1>
105   </chapter>
106
107 </book>