blob: 71f9246127ecafb9747562136c1bce8d9a1bf697 [file] [log] [blame]
Takashi Iwai5f8206c2009-02-09 08:50:43 +01001<?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" []>
Linus Torvalds1da177e2005-04-16 15:20:36 -07004
5<!-- ****************************************************** -->
6<!-- Header -->
7<!-- ****************************************************** -->
Takashi Iwai5f8206c2009-02-09 08:50:43 +01008<book id="ALSA-Driver-API">
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 <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
Takashi Iwai5f8206c2009-02-09 08:50:43 +010038<toc></toc>
39
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 <chapter><title>Management of Cards and Devices</title>
Nicolas Kaiser5bda9fa2007-01-22 14:54:33 +010041 <sect1><title>Card Management</title>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042!Esound/core/init.c
43 </sect1>
44 <sect1><title>Device Components</title>
45!Esound/core/device.c
46 </sect1>
Johannes Berga81792f2008-07-08 19:00:25 +020047 <sect1><title>Module requests and Device File Entries</title>
Linus Torvalds1da177e2005-04-16 15:20:36 -070048!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
Takashi Iwai67faa6e2014-10-30 15:37:37 +010060!Iinclude/sound/pcm.h
Linus Torvalds1da177e2005-04-16 15:20:36 -070061 </sect1>
62 <sect1><title>PCM Format Helpers</title>
63!Esound/core/pcm_misc.c
64 </sect1>
Nicolas Kaiser5bda9fa2007-01-22 14:54:33 +010065 <sect1><title>PCM Memory Management</title>
Linus Torvalds1da177e2005-04-16 15:20:36 -070066!Esound/core/pcm_memory.c
67 </sect1>
Takashi Iwai90446d02014-10-28 15:28:07 +010068 <sect1><title>PCM DMA Engine API</title>
69!Esound/core/pcm_dmaengine.c
70!Iinclude/sound/dmaengine_pcm.h
71 </sect1>
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 </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>
Takashi Iwai79c7cdd2009-02-09 14:47:19 +010081 <sect1><title>Virtual Master Control API</title>
82!Esound/core/vmaster.c
83!Iinclude/sound/control.h
84 </sect1>
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 </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>
Takashi Iwai90446d02014-10-28 15:28:07 +010099 <chapter><title>Compress Offload</title>
100 <sect1><title>Compress Offload API</title>
101!Esound/core/compress_offload.c
Takashi Iwai00dad6c2014-10-29 08:23:31 +0100102!Iinclude/uapi/sound/compress_offload.h
103!Iinclude/uapi/sound/compress_params.h
Takashi Iwai90446d02014-10-28 15:28:07 +0100104!Iinclude/sound/compress_driver.h
105 </sect1>
106 </chapter>
Takashi Iwai438f4e22014-10-30 12:44:00 +0100107 <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
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>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 <chapter><title>Miscellaneous Functions</title>
124 <sect1><title>Hardware-Dependent Devices API</title>
125!Esound/core/hwdep.c
126 </sect1>
Takashi Iwai662c3192009-02-09 08:53:50 +0100127 <sect1><title>Jack Abstraction Layer API</title>
Takashi Iwai90446d02014-10-28 15:28:07 +0100128!Iinclude/sound/jack.h
Takashi Iwai438f4e22014-10-30 12:44:00 +0100129!Esound/core/jack.c
130!Esound/soc/soc-jack.c
Takashi Iwai662c3192009-02-09 08:53:50 +0100131 </sect1>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 <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>