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>