Documentation/sound/kernel-api/alsa-driver-api.rst

   1 ===================
   2 The ALSA Driver API
   3 ===================
   4
   5 Management of Cards and Devices
   6 ===============================
   7
   8 Card Management
   9 ---------------
  10 .. kernel-doc:: sound/core/init.c
  11
  12 Device Components
  13 -----------------
  14 .. kernel-doc:: sound/core/device.c
  15
  16 Module requests and Device File Entries
  17 ---------------------------------------
  18 .. kernel-doc:: sound/core/sound.c
  19
  20 Memory Management Helpers
  21 -------------------------
  22 .. kernel-doc:: sound/core/memory.c
  23 .. kernel-doc:: sound/core/memalloc.c
  24
  25
  26 PCM API
  27 =======
  28
  29 PCM Core
  30 --------
  31 .. kernel-doc:: sound/core/pcm.c
  32 .. kernel-doc:: sound/core/pcm_lib.c
  33 .. kernel-doc:: sound/core/pcm_native.c
  34 .. kernel-doc:: include/sound/pcm.h
  35
  36 PCM Format Helpers
  37 ------------------
  38 .. kernel-doc:: sound/core/pcm_misc.c
  39
  40 PCM Memory Management
  41 ---------------------
  42 .. kernel-doc:: sound/core/pcm_memory.c
  43
  44 PCM DMA Engine API
  45 ------------------
  46 .. kernel-doc:: sound/core/pcm_dmaengine.c
  47 .. kernel-doc:: include/sound/dmaengine_pcm.h
  48
  49 Control/Mixer API
  50 =================
  51
  52 General Control Interface
  53 -------------------------
  54 .. kernel-doc:: sound/core/control.c
  55
  56 AC97 Codec API
  57 --------------
  58 .. kernel-doc:: sound/pci/ac97/ac97_codec.c
  59 .. kernel-doc:: sound/pci/ac97/ac97_pcm.c
  60
  61 Virtual Master Control API
  62 --------------------------
  63 .. kernel-doc:: sound/core/vmaster.c
  64 .. kernel-doc:: include/sound/control.h
  65
  66 MIDI API
  67 ========
  68
  69 Raw MIDI API
  70 ------------
  71 .. kernel-doc:: sound/core/rawmidi.c
  72
  73 MPU401-UART API
  74 ---------------
  75 .. kernel-doc:: sound/drivers/mpu401/mpu401_uart.c
  76
  77 Proc Info API
  78 =============
  79
  80 Proc Info Interface
  81 -------------------
  82 .. kernel-doc:: sound/core/info.c
  83
  84 Compress Offload
  85 ================
  86
  87 Compress Offload API
  88 --------------------
  89 .. kernel-doc:: sound/core/compress_offload.c
  90 .. kernel-doc:: include/uapi/sound/compress_offload.h
  91 .. kernel-doc:: include/uapi/sound/compress_params.h
  92 .. kernel-doc:: include/sound/compress_driver.h
  93
  94 ASoC
  95 ====
  96
  97 ASoC Core API
  98 -------------
  99 .. kernel-doc:: include/sound/soc.h
 100 .. kernel-doc:: sound/soc/soc-core.c
 101 .. kernel-doc:: sound/soc/soc-devres.c
 102 .. kernel-doc:: sound/soc/soc-io.c
 103 .. kernel-doc:: sound/soc/soc-pcm.c
 104 .. kernel-doc:: sound/soc/soc-ops.c
 105 .. kernel-doc:: sound/soc/soc-compress.c
 106
 107 ASoC DAPM API
 108 -------------
 109 .. kernel-doc:: sound/soc/soc-dapm.c
 110
 111 ASoC DMA Engine API
 112 -------------------
 113 .. kernel-doc:: sound/soc/soc-generic-dmaengine-pcm.c
 114
 115 Miscellaneous Functions
 116 =======================
 117
 118 Hardware-Dependent Devices API
 119 ------------------------------
 120 .. kernel-doc:: sound/core/hwdep.c
 121
 122 Jack Abstraction Layer API
 123 --------------------------
 124 .. kernel-doc:: include/sound/jack.h
 125 .. kernel-doc:: sound/core/jack.c
 126 .. kernel-doc:: sound/soc/soc-jack.c
 127
 128 ISA DMA Helpers
 129 ---------------
 130 .. kernel-doc:: sound/core/isadma.c
 131
 132 Other Helper Macros
 133 -------------------
 134 .. kernel-doc:: include/sound/core.h