[media] DocBook: Add rules to auto-generate some media docbook
[linux-2.6.git] / 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      </sect1>
61      <sect1><title>PCM Format Helpers</title>
62 !Esound/core/pcm_misc.c
63      </sect1>
64      <sect1><title>PCM Memory Management</title>
65 !Esound/core/pcm_memory.c
66      </sect1>
67   </chapter>
68   <chapter><title>Control/Mixer API</title>
69      <sect1><title>General Control Interface</title>
70 !Esound/core/control.c
71      </sect1>
72      <sect1><title>AC97 Codec API</title>
73 !Esound/pci/ac97/ac97_codec.c
74 !Esound/pci/ac97/ac97_pcm.c
75      </sect1>
76      <sect1><title>Virtual Master Control API</title>
77 !Esound/core/vmaster.c
78 !Iinclude/sound/control.h
79      </sect1>
80   </chapter>
81   <chapter><title>MIDI API</title>
82      <sect1><title>Raw MIDI API</title>
83 !Esound/core/rawmidi.c
84      </sect1>
85      <sect1><title>MPU401-UART API</title>
86 !Esound/drivers/mpu401/mpu401_uart.c
87      </sect1>
88   </chapter>
89   <chapter><title>Proc Info API</title>
90      <sect1><title>Proc Info Interface</title>
91 !Esound/core/info.c
92      </sect1>
93   </chapter>
94   <chapter><title>Miscellaneous Functions</title>
95      <sect1><title>Hardware-Dependent Devices API</title>
96 !Esound/core/hwdep.c
97      </sect1>
98      <sect1><title>Jack Abstraction Layer API</title>
99 !Esound/core/jack.c
100      </sect1>
101      <sect1><title>ISA DMA Helpers</title>
102 !Esound/core/isadma.c
103      </sect1>
104      <sect1><title>Other Helper Macros</title>
105 !Iinclude/sound/core.h
106      </sect1>
107   </chapter>
108
109 </book>