Documentation/sound/alsa/Procfile.txt

   1                 Proc Files of ALSA Drivers
   2                 ==========================
   3                 Takashi Iwai <tiwai@suse.de>
   4
   5 General
   6 -------
   7
   8 ALSA has its own proc tree, /proc/asound.  Many useful information are
   9 found in this tree.  When you encounter a problem and need debugging,
  10 check the files listed in the following sections.
  11
  12 Each card has its subtree cardX, where X is from 0 to 7. The
  13 card-specific files are stored in the card* subdirectories.
  14
  15
  16 Global Information
  17 ------------------
  18
  19 cards
  20         Shows the list of currently configured ALSA drivers,
  21         index, the id string, short and long descriptions.
  22
  23 version
  24         Shows the version string and compile date.
  25
  26 modules
  27         Lists the module of each card
  28
  29 devices
  30         Lists the ALSA native device mappings.
  31
  32 meminfo
  33         Shows the status of allocated pages via ALSA drivers.
  34         Appears only when CONFIG_SND_DEBUG=y.
  35
  36 hwdep
  37         Lists the currently available hwdep devices in format of
  38         <card>-<device>: <name>
  39
  40 pcm
  41         Lists the currently available PCM devices in format of
  42         <card>-<device>: <id>: <name> : <sub-streams>
  43
  44 timer
  45         Lists the currently available timer devices
  46
  47
  48 oss/devices
  49         Lists the OSS device mappings.
  50
  51 oss/sndstat
  52         Provides the output compatible with /dev/sndstat.
  53         You can symlink this to /dev/sndstat.
  54
  55
  56 Card Specific Files
  57 -------------------
  58
  59 The card-specific files are found in /proc/asound/card* directories.
  60 Some drivers (e.g. cmipci) have their own proc entries for the
  61 register dump, etc (e.g. /proc/asound/card*/cmipci shows the register
  62 dump).  These files would be really helpful for debugging.
  63
  64 When PCM devices are available on this card, you can see directories
  65 like pcm0p or pcm1c.  They hold the PCM information for each PCM
  66 stream.  The number after 'pcm' is the PCM device number from 0, and
  67 the last 'p' or 'c' means playback or capture direction.  The files in
  68 this subtree is described later.
  69
  70 The status of MIDI I/O is found in midi* files.  It shows the device
  71 name and the received/transmitted bytes through the MIDI device.
  72
  73 When the card is equipped with AC97 codecs, there are codec97#*
  74 subdirectories (described later).
  75
  76 When the OSS mixer emulation is enabled (and the module is loaded),
  77 oss_mixer file appears here, too.  This shows the current mapping of
  78 OSS mixer elements to the ALSA control elements.  You can change the
  79 mapping by writing to this device.  Read OSS-Emulation.txt for
  80 details.
  81
  82
  83 PCM Proc Files
  84 --------------
  85
  86 card*/pcm*/info
  87         The general information of this PCM device: card #, device #,
  88         substreams, etc.
  89
  90 card*/pcm*/xrun_debug
  91         This file appears when CONFIG_SND_DEBUG=y.
  92         This shows the status of xrun (= buffer overrun/xrun) debug of
  93         ALSA PCM middle layer, as an integer from 0 to 2.  The value
  94         can be changed by writing to this file, such as
  95
  96                  # cat 2 > /proc/asound/card0/pcm0p/xrun_debug
  97
  98         When this value is greater than 0, the driver will show the
  99         messages to kernel log when an xrun is detected.  The debug
 100         message is shown also when the invalid H/W pointer is detected
 101         at the update of periods (usually called from the interrupt
 102         handler).
 103
 104         When this value is greater than 1, the driver will show the
 105         stack trace additionally.  This may help the debugging.
 106
 107         Since 2.6.30, this option also enables the hwptr check using
 108         jiffies.  This detects spontaneous invalid pointer callback
 109         values, but can be lead to too much corrections for a (mostly
 110         buggy) hardware that doesn't give smooth pointer updates.
 111
 112 card*/pcm*/sub*/info
 113         The general information of this PCM sub-stream.
 114
 115 card*/pcm*/sub*/status
 116         The current status of this PCM sub-stream, elapsed time,
 117         H/W position, etc.
 118
 119 card*/pcm*/sub*/hw_params
 120         The hardware parameters set for this sub-stream.
 121
 122 card*/pcm*/sub*/sw_params
 123         The soft parameters set for this sub-stream.
 124
 125 card*/pcm*/sub*/prealloc
 126         The buffer pre-allocation information.
 127
 128
 129 AC97 Codec Information
 130 ----------------------
 131
 132 card*/codec97#*/ac97#?-?
 133         Shows the general information of this AC97 codec chip, such as
 134         name, capabilities, set up.
 135
 136 card*/codec97#0/ac97#?-?+regs
 137         Shows the AC97 register dump.  Useful for debugging.
 138
 139         When CONFIG_SND_DEBUG is enabled, you can write to this file for
 140         changing an AC97 register directly.  Pass two hex numbers.
 141         For example,
 142
 143         # echo 02 9f1f > /proc/asound/card0/codec97#0/ac97#0-0+regs
 144
 145
 146 USB Audio Streams
 147 -----------------
 148
 149 card*/stream*
 150         Shows the assignment and the current status of each audio stream
 151         of the given card.  This information is very useful for debugging.
 152
 153
 154 HD-Audio Codecs
 155 ---------------
 156
 157 card*/codec#*
 158         Shows the general codec information and the attribute of each
 159         widget node.
 160
 161 card*/eld#*
 162         Available for HDMI or DisplayPort interfaces.
 163         Shows ELD(EDID Like Data) info retrieved from the attached HDMI sink,
 164         and describes its audio capabilities and configurations.
 165
 166         Some ELD fields may be modified by doing `echo name hex_value > eld#*`.
 167         Only do this if you are sure the HDMI sink provided value is wrong.
 168         And if that makes your HDMI audio work, please report to us so that we
 169         can fix it in future kernel releases.
 170
 171
 172 Sequencer Information
 173 ---------------------
 174
 175 seq/drivers
 176         Lists the currently available ALSA sequencer drivers.
 177
 178 seq/clients
 179         Shows the list of currently available sequencer clients and
 180         ports.  The connection status and the running status are shown
 181         in this file, too.
 182
 183 seq/queues
 184         Lists the currently allocated/running sequencer queues.
 185
 186 seq/timer
 187         Lists the currently allocated/running sequencer timers.
 188
 189 seq/oss
 190         Lists the OSS-compatible sequencer stuffs.
 191
 192
 193 Help For Debugging?
 194 -------------------
 195
 196 When the problem is related with PCM, first try to turn on xrun_debug
 197 mode.  This will give you the kernel messages when and where xrun
 198 happened.
 199
 200 If it's really a bug, report it with the following information:
 201
 202   - the name of the driver/card, show in /proc/asound/cards
 203   - the register dump, if available (e.g. card*/cmipci)
 204
 205 when it's a PCM problem,
 206
 207   - set-up of PCM, shown in hw_parms, sw_params, and status in the PCM
 208     sub-stream directory
 209
 210 when it's a mixer problem,
 211
 212   - AC97 proc files, codec97#*/* files
 213
 214 for USB audio/midi,
 215
 216   - output of lsusb -v
 217   - stream* files in card directory
 218
 219
 220 The ALSA bug-tracking system is found at:
 221
 222     https://bugtrack.alsa-project.org/alsa-bug/