summaryrefslogtreecommitdiffstats
path: root/Documentation/sound/kernel-api/alsa-driver-api.rst
blob: 14cd138989e359aed15ea3f6bdfdd1902c854435 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
===================
The ALSA Driver API
===================

Management of Cards and Devices
===============================

Card Management
---------------
.. kernel-doc:: sound/core/init.c

Device Components
-----------------
.. kernel-doc:: sound/core/device.c

Module requests and Device File Entries
---------------------------------------
.. kernel-doc:: sound/core/sound.c

Memory Management Helpers
-------------------------
.. kernel-doc:: sound/core/memory.c
.. kernel-doc:: sound/core/memalloc.c


PCM API
=======

PCM Core
--------
.. kernel-doc:: sound/core/pcm.c
.. kernel-doc:: sound/core/pcm_lib.c
.. kernel-doc:: sound/core/pcm_native.c
.. kernel-doc:: include/sound/pcm.h

PCM Format Helpers
------------------
.. kernel-doc:: sound/core/pcm_misc.c

PCM Memory Management
---------------------
.. kernel-doc:: sound/core/pcm_memory.c

PCM DMA Engine API
------------------
.. kernel-doc:: sound/core/pcm_dmaengine.c
.. kernel-doc:: include/sound/dmaengine_pcm.h

Control/Mixer API
=================

General Control Interface
-------------------------
.. kernel-doc:: sound/core/control.c

AC97 Codec API
--------------
.. kernel-doc:: sound/pci/ac97/ac97_codec.c
.. kernel-doc:: sound/pci/ac97/ac97_pcm.c

Virtual Master Control API
--------------------------
.. kernel-doc:: sound/core/vmaster.c
.. kernel-doc:: include/sound/control.h

MIDI API
========

Raw MIDI API
------------
.. kernel-doc:: sound/core/rawmidi.c

MPU401-UART API
---------------
.. kernel-doc:: sound/drivers/mpu401/mpu401_uart.c

Proc Info API
=============

Proc Info Interface
-------------------
.. kernel-doc:: sound/core/info.c

Compress Offload
================

Compress Offload API
--------------------
.. kernel-doc:: sound/core/compress_offload.c
.. kernel-doc:: include/uapi/sound/compress_offload.h
.. kernel-doc:: include/uapi/sound/compress_params.h
.. kernel-doc:: include/sound/compress_driver.h

ASoC
====

ASoC Core API
-------------
.. kernel-doc:: include/sound/soc.h
.. kernel-doc:: sound/soc/soc-core.c
.. kernel-doc:: sound/soc/soc-devres.c
.. kernel-doc:: sound/soc/soc-io.c
.. kernel-doc:: sound/soc/soc-pcm.c
.. kernel-doc:: sound/soc/soc-ops.c
.. kernel-doc:: sound/soc/soc-compress.c

ASoC DAPM API
-------------
.. kernel-doc:: sound/soc/soc-dapm.c

ASoC DMA Engine API
-------------------
.. kernel-doc:: sound/soc/soc-generic-dmaengine-pcm.c

Miscellaneous Functions
=======================

Hardware-Dependent Devices API
------------------------------
.. kernel-doc:: sound/core/hwdep.c

Jack Abstraction Layer API
--------------------------
.. kernel-doc:: include/sound/jack.h
.. kernel-doc:: sound/core/jack.c
.. kernel-doc:: sound/soc/soc-jack.c

ISA DMA Helpers
---------------
.. kernel-doc:: sound/core/isadma.c

Other Helper Macros
-------------------
.. kernel-doc:: include/sound/core.h