mirror of
https://github.com/edk2-porting/linux-next.git
synced 2024-12-23 20:53:53 +08:00
628536ea06
A number of functions and structures in the sound subsystem had incomplete and/or obsolete DocBook comments, leading to warnings when the docs were built. Correct those comments so that we can enjoy our audio in the absence of warning noise. Signed-off-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Mark Brown <broonie@kernel.org>
141 lines
4.0 KiB
XML
141 lines
4.0 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" []>
|
|
|
|
<!-- ****************************************************** -->
|
|
<!-- Header -->
|
|
<!-- ****************************************************** -->
|
|
<book id="ALSA-Driver-API">
|
|
<bookinfo>
|
|
<title>The ALSA Driver API</title>
|
|
|
|
<legalnotice>
|
|
<para>
|
|
This document is free; you can redistribute it and/or modify it
|
|
under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
</para>
|
|
|
|
<para>
|
|
This document is distributed in the hope that it will be useful,
|
|
but <emphasis>WITHOUT ANY WARRANTY</emphasis>; without even the
|
|
implied warranty of <emphasis>MERCHANTABILITY or FITNESS FOR A
|
|
PARTICULAR PURPOSE</emphasis>. See the GNU General Public License
|
|
for more details.
|
|
</para>
|
|
|
|
<para>
|
|
You should have received a copy of the GNU General Public
|
|
License along with this program; if not, write to the Free
|
|
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
|
|
MA 02111-1307 USA
|
|
</para>
|
|
</legalnotice>
|
|
|
|
</bookinfo>
|
|
|
|
<toc></toc>
|
|
|
|
<chapter><title>Management of Cards and Devices</title>
|
|
<sect1><title>Card Management</title>
|
|
!Esound/core/init.c
|
|
</sect1>
|
|
<sect1><title>Device Components</title>
|
|
!Esound/core/device.c
|
|
</sect1>
|
|
<sect1><title>Module requests and Device File Entries</title>
|
|
!Esound/core/sound.c
|
|
</sect1>
|
|
<sect1><title>Memory Management Helpers</title>
|
|
!Esound/core/memory.c
|
|
!Esound/core/memalloc.c
|
|
</sect1>
|
|
</chapter>
|
|
<chapter><title>PCM API</title>
|
|
<sect1><title>PCM Core</title>
|
|
!Esound/core/pcm.c
|
|
!Esound/core/pcm_lib.c
|
|
!Esound/core/pcm_native.c
|
|
!Iinclude/sound/pcm.h
|
|
</sect1>
|
|
<sect1><title>PCM Format Helpers</title>
|
|
!Esound/core/pcm_misc.c
|
|
</sect1>
|
|
<sect1><title>PCM Memory Management</title>
|
|
!Esound/core/pcm_memory.c
|
|
</sect1>
|
|
<sect1><title>PCM DMA Engine API</title>
|
|
!Esound/core/pcm_dmaengine.c
|
|
!Iinclude/sound/dmaengine_pcm.h
|
|
</sect1>
|
|
</chapter>
|
|
<chapter><title>Control/Mixer API</title>
|
|
<sect1><title>General Control Interface</title>
|
|
!Esound/core/control.c
|
|
</sect1>
|
|
<sect1><title>AC97 Codec API</title>
|
|
!Esound/pci/ac97/ac97_codec.c
|
|
!Esound/pci/ac97/ac97_pcm.c
|
|
</sect1>
|
|
<sect1><title>Virtual Master Control API</title>
|
|
!Esound/core/vmaster.c
|
|
!Iinclude/sound/control.h
|
|
</sect1>
|
|
</chapter>
|
|
<chapter><title>MIDI API</title>
|
|
<sect1><title>Raw MIDI API</title>
|
|
!Esound/core/rawmidi.c
|
|
</sect1>
|
|
<sect1><title>MPU401-UART API</title>
|
|
!Esound/drivers/mpu401/mpu401_uart.c
|
|
</sect1>
|
|
</chapter>
|
|
<chapter><title>Proc Info API</title>
|
|
<sect1><title>Proc Info Interface</title>
|
|
!Esound/core/info.c
|
|
</sect1>
|
|
</chapter>
|
|
<chapter><title>Compress Offload</title>
|
|
<sect1><title>Compress Offload API</title>
|
|
!Esound/core/compress_offload.c
|
|
!Iinclude/uapi/sound/compress_offload.h
|
|
!Iinclude/uapi/sound/compress_params.h
|
|
!Iinclude/sound/compress_driver.h
|
|
</sect1>
|
|
</chapter>
|
|
<chapter><title>ASoC</title>
|
|
<sect1><title>ASoC Core API</title>
|
|
!Iinclude/sound/soc.h
|
|
!Esound/soc/soc-core.c
|
|
<!-- !Esound/soc/soc-cache.c no docbook comments here -->
|
|
!Esound/soc/soc-devres.c
|
|
!Esound/soc/soc-io.c
|
|
!Esound/soc/soc-pcm.c
|
|
</sect1>
|
|
<sect1><title>ASoC DAPM API</title>
|
|
!Esound/soc/soc-dapm.c
|
|
</sect1>
|
|
<sect1><title>ASoC DMA Engine API</title>
|
|
!Esound/soc/soc-generic-dmaengine-pcm.c
|
|
</sect1>
|
|
</chapter>
|
|
<chapter><title>Miscellaneous Functions</title>
|
|
<sect1><title>Hardware-Dependent Devices API</title>
|
|
!Esound/core/hwdep.c
|
|
</sect1>
|
|
<sect1><title>Jack Abstraction Layer API</title>
|
|
!Iinclude/sound/jack.h
|
|
!Esound/core/jack.c
|
|
!Esound/soc/soc-jack.c
|
|
</sect1>
|
|
<sect1><title>ISA DMA Helpers</title>
|
|
!Esound/core/isadma.c
|
|
</sect1>
|
|
<sect1><title>Other Helper Macros</title>
|
|
!Iinclude/sound/core.h
|
|
</sect1>
|
|
</chapter>
|
|
|
|
</book>
|