blob: c82beb0076341856ca13b1e1dd125cc440ed439c [file] [log] [blame]
Takashi Iwaia7fe49b2008-12-03 18:26:35 +01001MORE NOTES ON HD-AUDIO DRIVER
2=============================
3 Takashi Iwai <tiwai@suse.de>
4
5
6GENERAL
7-------
8
9HD-audio is the new standard on-board audio component on modern PCs
10after AC97. Although Linux has been supporting HD-audio since long
11time ago, there are often problems with new machines. A part of the
Takashi Iwaid2afbe72008-12-10 09:28:15 +010012problem is broken BIOS, and the rest is the driver implementation.
13This document explains the brief trouble-shooting and debugging
14methods for the HD-audio hardware.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +010015
16The HD-audio component consists of two parts: the controller chip and
17the codec chips on the HD-audio bus. Linux provides a single driver
Takashi Iwaid2afbe72008-12-10 09:28:15 +010018for all controllers, snd-hda-intel. Although the driver name contains
Matt LaPlante19f59462009-04-27 15:06:31 +020019a word of a well-known hardware vendor, it's not specific to it but for
Takashi Iwaid2afbe72008-12-10 09:28:15 +010020all controller chips by other companies. Since the HD-audio
21controllers are supposed to be compatible, the single snd-hda-driver
22should work in most cases. But, not surprisingly, there are known
23bugs and issues specific to each controller type. The snd-hda-intel
24driver has a bunch of workarounds for these as described below.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +010025
26A controller may have multiple codecs. Usually you have one audio
Takashi Iwaid2afbe72008-12-10 09:28:15 +010027codec and optionally one modem codec. In theory, there might be
28multiple audio codecs, e.g. for analog and digital outputs, and the
29driver might not work properly because of conflict of mixer elements.
30This should be fixed in future if such hardware really exists.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +010031
32The snd-hda-intel driver has several different codec parsers depending
33on the codec. It has a generic parser as a fallback, but this
34functionality is fairly limited until now. Instead of the generic
35parser, usually the codec-specific parser (coded in patch_*.c) is used
36for the codec-specific implementations. The details about the
37codec-specific problems are explained in the later sections.
38
39If you are interested in the deep debugging of HD-audio, read the
40HD-audio specification at first. The specification is found on
41Intel's web page, for example:
42
43- http://www.intel.com/standards/hdaudio/
44
45
46HD-AUDIO CONTROLLER
47-------------------
48
49DMA-Position Problem
50~~~~~~~~~~~~~~~~~~~~
51The most common problem of the controller is the inaccurate DMA
52pointer reporting. The DMA pointer for playback and capture can be
53read in two ways, either via a LPIB register or via a position-buffer
Takashi Iwaid2afbe72008-12-10 09:28:15 +010054map. As default the driver tries to read from the io-mapped
55position-buffer, and falls back to LPIB if the position-buffer appears
56dead. However, this detection isn't perfect on some devices. In such
57a case, you can change the default method via `position_fix` option.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +010058
59`position_fix=1` means to use LPIB method explicitly.
David Henningsson4cb36312010-09-30 10:12:50 +020060`position_fix=2` means to use the position-buffer.
61`position_fix=3` means to use a combination of both methods, needed
62for some VIA and ATI controllers. 0 is the default value for all other
63controllers, the automatic check and fallback to LPIB as described in
64the above. If you get a problem of repeated sounds, this option might
Takashi Iwaid2afbe72008-12-10 09:28:15 +010065help.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +010066
67In addition to that, every controller is known to be broken regarding
68the wake-up timing. It wakes up a few samples before actually
69processing the data on the buffer. This caused a lot of problems, for
70example, with ALSA dmix or JACK. Since 2.6.27 kernel, the driver puts
71an artificial delay to the wake up timing. This delay is controlled
72via `bdl_pos_adj` option.
73
74When `bdl_pos_adj` is a negative value (as default), it's assigned to
75an appropriate value depending on the controller chip. For Intel
Takashi Iwaid2afbe72008-12-10 09:28:15 +010076chips, it'd be 1 while it'd be 32 for others. Usually this works.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +010077Only in case it doesn't work and you get warning messages, you should
Takashi Iwaid2afbe72008-12-10 09:28:15 +010078change this parameter to other values.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +010079
80
81Codec-Probing Problem
82~~~~~~~~~~~~~~~~~~~~~
83A less often but a more severe problem is the codec probing. When
84BIOS reports the available codec slots wrongly, the driver gets
85confused and tries to access the non-existing codec slot. This often
Takashi Iwaid2afbe72008-12-10 09:28:15 +010086results in the total screw-up, and destructs the further communication
87with the codec chips. The symptom appears usually as error messages
88like:
Takashi Iwaia7fe49b2008-12-03 18:26:35 +010089------------------------------------------------------------------------
Takashi Iwaid2afbe72008-12-10 09:28:15 +010090 hda_intel: azx_get_response timeout, switching to polling mode:
Takashi Iwaia7fe49b2008-12-03 18:26:35 +010091 last cmd=0x12345678
Takashi Iwaid2afbe72008-12-10 09:28:15 +010092 hda_intel: azx_get_response timeout, switching to single_cmd mode:
Takashi Iwaia7fe49b2008-12-03 18:26:35 +010093 last cmd=0x12345678
94------------------------------------------------------------------------
95
96The first line is a warning, and this is usually relatively harmless.
97It means that the codec response isn't notified via an IRQ. The
98driver uses explicit polling method to read the response. It gives
99very slight CPU overhead, but you'd unlikely notice it.
100
101The second line is, however, a fatal error. If this happens, usually
102it means that something is really wrong. Most likely you are
103accessing a non-existing codec slot.
104
105Thus, if the second error message appears, try to narrow the probed
106codec slots via `probe_mask` option. It's a bitmask, and each bit
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100107corresponds to the codec slot. For example, to probe only the first
108slot, pass `probe_mask=1`. For the first and the third slots, pass
109`probe_mask=5` (where 5 = 1 | 4), and so on.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100110
111Since 2.6.29 kernel, the driver has a more robust probing method, so
112this error might happen rarely, though.
113
Takashi Iwaiae374d62009-02-13 08:33:55 +0100114On a machine with a broken BIOS, sometimes you need to force the
115driver to probe the codec slots the hardware doesn't report for use.
116In such a case, turn the bit 8 (0x100) of `probe_mask` option on.
117Then the rest 8 bits are passed as the codec slots to probe
118unconditionally. For example, `probe_mask=0x103` will force to probe
119the codec slots 0 and 1 no matter what the hardware reports.
120
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100121
122Interrupt Handling
123~~~~~~~~~~~~~~~~~~
Takashi Iwai91cb1732010-04-01 18:08:29 +0200124HD-audio driver uses MSI as default (if available) since 2.6.33
125kernel as MSI works better on some machines, and in general, it's
126better for performance. However, Nvidia controllers showed bad
127regressions with MSI (especially in a combination with AMD chipset),
128thus we disabled MSI for them.
129
130There seem also still other devices that don't work with MSI. If you
131see a regression wrt the sound quality (stuttering, etc) or a lock-up
132in the recent kernel, try to pass `enable_msi=0` option to disable
133MSI. If it works, you can add the known bad device to the blacklist
134defined in hda_intel.c. In such a case, please report and give the
135patch back to the upstream developer.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100136
137
138HD-AUDIO CODEC
139--------------
140
141Model Option
142~~~~~~~~~~~~
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100143The most common problem regarding the HD-audio driver is the
144unsupported codec features or the mismatched device configuration.
145Most of codec-specific code has several preset models, either to
146override the BIOS setup or to provide more comprehensive features.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100147
148The driver checks PCI SSID and looks through the static configuration
149table until any matching entry is found. If you have a new machine,
150you may see a message like below:
151------------------------------------------------------------------------
Takashi Iwai9a11f1a2009-07-28 16:01:20 +0200152 hda_codec: ALC880: BIOS auto-probing.
153------------------------------------------------------------------------
154Meanwhile, in the earlier versions, you would see a message like:
155------------------------------------------------------------------------
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100156 hda_codec: Unknown model for ALC880, trying auto-probe from BIOS...
157------------------------------------------------------------------------
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100158Even if you see such a message, DON'T PANIC. Take a deep breath and
159keep your towel. First of all, it's an informational message, no
160warning, no error. This means that the PCI SSID of your device isn't
161listed in the known preset model (white-)list. But, this doesn't mean
162that the driver is broken. Many codec-drivers provide the automatic
163configuration mechanism based on the BIOS setup.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100164
165The HD-audio codec has usually "pin" widgets, and BIOS sets the default
166configuration of each pin, which indicates the location, the
167connection type, the jack color, etc. The HD-audio driver can guess
168the right connection judging from these default configuration values.
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100169However -- some codec-support codes, such as patch_analog.c, don't
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100170support the automatic probing (yet as of 2.6.28). And, BIOS is often,
171yes, pretty often broken. It sets up wrong values and screws up the
172driver.
173
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100174The preset model is provided basically to overcome such a situation.
175When the matching preset model is found in the white-list, the driver
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100176assumes the static configuration of that preset and builds the mixer
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100177elements and PCM streams based on the static information. Thus, if
178you have a newer machine with a slightly different PCI SSID from the
179existing one, you may have a good chance to re-use the same model.
180You can pass the `model` option to specify the preset model instead of
181PCI SSID look-up.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100182
183What `model` option values are available depends on the codec chip.
184Check your codec chip from the codec proc file (see "Codec Proc-File"
185section below). It will show the vendor/product name of your codec
Justin Mattock83b20862009-04-14 14:31:21 -0700186chip. Then, see Documentation/sound/alsa/HD-Audio-Models.txt file,
Takashi Iwai692f9042008-12-19 12:44:46 +0100187the section of HD-audio driver. You can find a list of codecs
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100188and `model` options belonging to each codec. For example, for Realtek
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100189ALC262 codec chip, pass `model=ultra` for devices that are compatible
190with Samsung Q1 Ultra.
191
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100192Thus, the first thing you can do for any brand-new, unsupported and
193non-working HD-audio hardware is to check HD-audio codec and several
Justin Mattock83b20862009-04-14 14:31:21 -0700194different `model` option values. If you have any luck, some of them
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100195might suit with your device well.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100196
197Some codecs such as ALC880 have a special model option `model=test`.
198This configures the driver to provide as many mixer controls as
199possible for every single pin feature except for the unsolicited
200events (and maybe some other specials). Adjust each mixer element and
201try the I/O in the way of trial-and-error until figuring out the whole
202I/O pin mappings.
203
204Note that `model=generic` has a special meaning. It means to use the
205generic parser regardless of the codec. Usually the codec-specific
206parser is much better than the generic parser (as now). Thus this
207option is more about the debugging purpose.
208
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100209Speaker and Headphone Output
210~~~~~~~~~~~~~~~~~~~~~~~~~~~~
211One of the most frequent (and obvious) bugs with HD-audio is the
212silent output from either or both of a built-in speaker and a
213headphone jack. In general, you should try a headphone output at
214first. A speaker output often requires more additional controls like
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100215the external amplifier bits. Thus a headphone output has a slightly
216better chance.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100217
218Before making a bug report, double-check whether the mixer is set up
219correctly. The recent version of snd-hda-intel driver provides mostly
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100220"Master" volume control as well as "Front" volume (where Front
221indicates the front-channels). In addition, there can be individual
222"Headphone" and "Speaker" controls.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100223
224Ditto for the speaker output. There can be "External Amplifier"
225switch on some codecs. Turn on this if present.
226
227Another related problem is the automatic mute of speaker output by
228headphone plugging. This feature is implemented in most cases, but
229not on every preset model or codec-support code.
230
231In anyway, try a different model option if you have such a problem.
232Some other models may match better and give you more matching
233functionality. If none of the available models works, send a bug
234report. See the bug report section for details.
235
236If you are masochistic enough to debug the driver problem, note the
237following:
238
239- The speaker (and the headphone, too) output often requires the
240 external amplifier. This can be set usually via EAPD verb or a
241 certain GPIO. If the codec pin supports EAPD, you have a better
242 chance via SET_EAPD_BTL verb (0x70c). On others, GPIO pin (mostly
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100243 it's either GPIO0 or GPIO1) may turn on/off EAPD.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100244- Some Realtek codecs require special vendor-specific coefficients to
245 turn on the amplifier. See patch_realtek.c.
246- IDT codecs may have extra power-enable/disable controls on each
247 analog pin. See patch_sigmatel.c.
248- Very rare but some devices don't accept the pin-detection verb until
249 triggered. Issuing GET_PIN_SENSE verb (0xf09) may result in the
250 codec-communication stall. Some examples are found in
251 patch_realtek.c.
252
253
254Capture Problems
255~~~~~~~~~~~~~~~~
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100256The capture problems are often because of missing setups of mixers.
257Thus, before submitting a bug report, make sure that you set up the
258mixer correctly. For example, both "Capture Volume" and "Capture
259Switch" have to be set properly in addition to the right "Capture
260Source" or "Input Source" selection. Some devices have "Mic Boost"
261volume or switch.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100262
263When the PCM device is opened via "default" PCM (without pulse-audio
264plugin), you'll likely have "Digital Capture Volume" control as well.
265This is provided for the extra gain/attenuation of the signal in
266software, especially for the inputs without the hardware volume
267control such as digital microphones. Unless really needed, this
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100268should be set to exactly 50%, corresponding to 0dB -- neither extra
269gain nor attenuation. When you use "hw" PCM, i.e., a raw access PCM,
270this control will have no influence, though.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100271
272It's known that some codecs / devices have fairly bad analog circuits,
273and the recorded sound contains a certain DC-offset. This is no bug
274of the driver.
275
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100276Most of modern laptops have no analog CD-input connection. Thus, the
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100277recording from CD input won't work in many cases although the driver
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100278provides it as the capture source. Use CDDA instead.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100279
280The automatic switching of the built-in and external mic per plugging
281is implemented on some codec models but not on every model. Partly
282because of my laziness but mostly lack of testers. Feel free to
283submit the improvement patch to the author.
284
285
286Direct Debugging
287~~~~~~~~~~~~~~~~
Takashi Iwaif8bbd062008-12-11 13:12:59 +0100288If no model option gives you a better result, and you are a tough guy
Takashi Iwai623b9f62008-12-11 07:44:18 +0100289to fight against evil, try debugging via hitting the raw HD-audio
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100290codec verbs to the device. Some tools are available: hda-emu and
291hda-analyzer. The detailed description is found in the sections
292below. You'd need to enable hwdep for using these tools. See "Kernel
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100293Configuration" section.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100294
295
296OTHER ISSUES
297------------
298
299Kernel Configuration
300~~~~~~~~~~~~~~~~~~~~
301In general, I recommend you to enable the sound debug option,
302`CONFIG_SND_DEBUG=y`, no matter whether you are debugging or not.
303This enables snd_printd() macro and others, and you'll get additional
304kernel messages at probing.
305
306In addition, you can enable `CONFIG_SND_DEBUG_VERBOSE=y`. But this
307will give you far more messages. Thus turn this on only when you are
308sure to want it.
309
310Don't forget to turn on the appropriate `CONFIG_SND_HDA_CODEC_*`
311options. Note that each of them corresponds to the codec chip, not
312the controller chip. Thus, even if lspci shows the Nvidia controller,
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100313you may need to choose the option for other vendors. If you are
314unsure, just select all yes.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100315
316`CONFIG_SND_HDA_HWDEP` is a useful option for debugging the driver.
317When this is enabled, the driver creates hardware-dependent devices
318(one per each codec), and you have a raw access to the device via
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100319these device files. For example, `hwC0D2` will be created for the
320codec slot #2 of the first card (#0). For debug-tools such as
321hda-verb and hda-analyzer, the hwdep device has to be enabled.
322Thus, it'd be better to turn this on always.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100323
324`CONFIG_SND_HDA_RECONFIG` is a new option, and this depends on the
325hwdep option above. When enabled, you'll have some sysfs files under
326the corresponding hwdep directory. See "HD-audio reconfiguration"
327section below.
328
329`CONFIG_SND_HDA_POWER_SAVE` option enables the power-saving feature.
330See "Power-saving" section below.
331
332
333Codec Proc-File
334~~~~~~~~~~~~~~~
335The codec proc-file is a treasure-chest for debugging HD-audio.
336It shows most of useful information of each codec widget.
337
338The proc file is located in /proc/asound/card*/codec#*, one file per
339each codec slot. You can know the codec vendor, product id and
340names, the type of each widget, capabilities and so on.
341This file, however, doesn't show the jack sensing state, so far. This
342is because the jack-sensing might be depending on the trigger state.
343
344This file will be picked up by the debug tools, and also it can be fed
345to the emulator as the primary codec information. See the debug tools
346section below.
347
348This proc file can be also used to check whether the generic parser is
349used. When the generic parser is used, the vendor/product ID name
350will appear as "Realtek ID 0262", instead of "Realtek ALC262".
351
352
353HD-Audio Reconfiguration
354~~~~~~~~~~~~~~~~~~~~~~~~
355This is an experimental feature to allow you re-configure the HD-audio
356codec dynamically without reloading the driver. The following sysfs
357files are available under each codec-hwdep device directory (e.g.
358/sys/class/sound/hwC0D0):
359
360vendor_id::
361 Shows the 32bit codec vendor-id hex number. You can change the
362 vendor-id value by writing to this file.
363subsystem_id::
364 Shows the 32bit codec subsystem-id hex number. You can change the
365 subsystem-id value by writing to this file.
366revision_id::
367 Shows the 32bit codec revision-id hex number. You can change the
368 revision-id value by writing to this file.
369afg::
370 Shows the AFG ID. This is read-only.
371mfg::
372 Shows the MFG ID. This is read-only.
373name::
374 Shows the codec name string. Can be changed by writing to this
375 file.
376modelname::
377 Shows the currently set `model` option. Can be changed by writing
378 to this file.
379init_verbs::
380 The extra verbs to execute at initialization. You can add a verb by
Takashi Iwaid02b1f32009-03-02 17:34:51 +0100381 writing to this file. Pass three numbers: nid, verb and parameter
382 (separated with a space).
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100383hints::
Takashi Iwaid02b1f32009-03-02 17:34:51 +0100384 Shows / stores hint strings for codec parsers for any use.
385 Its format is `key = value`. For example, passing `hp_detect = yes`
386 to IDT/STAC codec parser will result in the disablement of the
387 headphone detection.
Takashi Iwaif1085c42009-02-20 14:50:35 +0100388init_pin_configs::
389 Shows the initial pin default config values set by BIOS.
Takashi Iwai346ff702009-02-23 09:42:57 +0100390driver_pin_configs::
Takashi Iwaif1085c42009-02-20 14:50:35 +0100391 Shows the pin default values set by the codec parser explicitly.
392 This doesn't show all pin values but only the changed values by
393 the parser. That is, if the parser doesn't change the pin default
394 config values by itself, this will contain nothing.
Takashi Iwai346ff702009-02-23 09:42:57 +0100395user_pin_configs::
396 Shows the pin default config values to override the BIOS setup.
397 Writing this (with two numbers, NID and value) appends the new
398 value. The given will be used instead of the initial BIOS value at
Takashi Iwai5e7b8e02009-02-23 09:45:59 +0100399 the next reconfiguration time. Note that this config will override
400 even the driver pin configs, too.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100401reconfig::
402 Triggers the codec re-configuration. When any value is written to
403 this file, the driver re-initialize and parses the codec tree
404 again. All the changes done by the sysfs entries above are taken
405 into account.
406clear::
407 Resets the codec, removes the mixer elements and PCM stuff of the
408 specified codec, and clear all init verbs and hints.
409
Takashi Iwai39c28712009-02-23 14:14:51 +0100410For example, when you want to change the pin default configuration
411value of the pin widget 0x14 to 0x9993013f, and let the driver
412re-configure based on that state, run like below:
413------------------------------------------------------------------------
414 # echo 0x14 0x9993013f > /sys/class/sound/hwC0D0/user_pin_configs
415 # echo 1 > /sys/class/sound/hwC0D0/reconfig
416------------------------------------------------------------------------
417
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100418
Takashi Iwai76824822009-06-17 17:17:18 +0200419Early Patching
420~~~~~~~~~~~~~~
421When CONFIG_SND_HDA_PATCH_LOADER=y is set, you can pass a "patch" as a
422firmware file for modifying the HD-audio setup before initializing the
423codec. This can work basically like the reconfiguration via sysfs in
424the above, but it does it before the first codec configuration.
425
Takashi Iwai1e7b8c82009-06-17 17:30:54 +0200426A patch file is a plain text file which looks like below:
Takashi Iwai76824822009-06-17 17:17:18 +0200427
428------------------------------------------------------------------------
429 [codec]
430 0x12345678 0xabcd1234 2
431
432 [model]
433 auto
434
435 [pincfg]
436 0x12 0x411111f0
437
438 [verb]
439 0x20 0x500 0x03
440 0x20 0x400 0xff
441
442 [hint]
443 hp_detect = yes
444------------------------------------------------------------------------
445
446The file needs to have a line `[codec]`. The next line should contain
447three numbers indicating the codec vendor-id (0x12345678 in the
448example), the codec subsystem-id (0xabcd1234) and the address (2) of
449the codec. The rest patch entries are applied to this specified codec
450until another codec entry is given.
451
452The `[model]` line allows to change the model name of the each codec.
453In the example above, it will be changed to model=auto.
454Note that this overrides the module option.
455
456After the `[pincfg]` line, the contents are parsed as the initial
457default pin-configurations just like `user_pin_configs` sysfs above.
458The values can be shown in user_pin_configs sysfs file, too.
459
460Similarly, the lines after `[verb]` are parsed as `init_verbs`
461sysfs entries, and the lines after `[hint]` are parsed as `hints`
462sysfs entries, respectively.
463
Takashi Iwaib09f3e72010-01-28 00:01:53 +0100464Another example to override the codec vendor id from 0x12345678 to
4650xdeadbeef is like below:
466------------------------------------------------------------------------
467 [codec]
468 0x12345678 0xabcd1234 2
469
470 [vendor_id]
471 0xdeadbeef
472------------------------------------------------------------------------
473
474In the similar way, you can override the codec subsystem_id via
475`[subsystem_id]`, the revision id via `[revision_id]` line.
476Also, the codec chip name can be rewritten via `[chip_name]` line.
477------------------------------------------------------------------------
478 [codec]
479 0x12345678 0xabcd1234 2
480
481 [subsystem_id]
482 0xffff1111
483
484 [revision_id]
485 0x10
486
487 [chip_name]
488 My-own NEWS-0002
489------------------------------------------------------------------------
490
Takashi Iwai1e7b8c82009-06-17 17:30:54 +0200491The hd-audio driver reads the file via request_firmware(). Thus,
492a patch file has to be located on the appropriate firmware path,
493typically, /lib/firmware. For example, when you pass the option
494`patch=hda-init.fw`, the file /lib/firmware/hda-init-fw must be
495present.
496
497The patch module option is specific to each card instance, and you
498need to give one file name for each instance, separated by commas.
499For example, if you have two cards, one for an on-board analog and one
500for an HDMI video board, you may pass patch option like below:
501------------------------------------------------------------------------
502 options snd-hda-intel patch=on-board-patch,hdmi-patch
503------------------------------------------------------------------------
504
Takashi Iwai76824822009-06-17 17:17:18 +0200505
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100506Power-Saving
507~~~~~~~~~~~~
508The power-saving is a kind of auto-suspend of the device. When the
509device is inactive for a certain time, the device is automatically
510turned off to save the power. The time to go down is specified via
511`power_save` module option, and this option can be changed dynamically
512via sysfs.
513
514The power-saving won't work when the analog loopback is enabled on
515some codecs. Make sure that you mute all unneeded signal routes when
516you want the power-saving.
517
518The power-saving feature might cause audible click noises at each
519power-down/up depending on the device. Some of them might be
520solvable, but some are hard, I'm afraid. Some distros such as
521openSUSE enables the power-saving feature automatically when the power
522cable is unplugged. Thus, if you hear noises, suspect first the
Takashi Iwai623b9f62008-12-11 07:44:18 +0100523power-saving. See /sys/module/snd_hda_intel/parameters/power_save to
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100524check the current value. If it's non-zero, the feature is turned on.
525
526
Takashi Iwai132bb7c2008-12-11 15:39:52 +0100527Development Tree
528~~~~~~~~~~~~~~~~
529The latest development codes for HD-audio are found on sound git tree:
530
531- git://git.kernel.org/pub/scm/linux/kernel/git/tiwai/sound-2.6.git
532
533The master branch or for-next branches can be used as the main
534development branches in general while the HD-audio specific patches
535are committed in topic/hda branch.
536
537If you are using the latest Linus tree, it'd be better to pull the
538above GIT tree onto it. If you are using the older kernels, an easy
539way to try the latest ALSA code is to build from the snapshot
540tarball. There are daily tarballs and the latest snapshot tarball.
541All can be built just like normal alsa-driver release packages, that
542is, installed via the usual spells: configure, make and make
543install(-modules). See INSTALL in the package. The snapshot tarballs
544are found at:
545
546- ftp://ftp.kernel.org/pub/linux/kernel/people/tiwai/snapshot/
547
548
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100549Sending a Bug Report
550~~~~~~~~~~~~~~~~~~~~
551If any model or module options don't work for your device, it's time
552to send a bug report to the developers. Give the following in your
553bug report:
554
555- Hardware vendor, product and model names
556- Kernel version (and ALSA-driver version if you built externally)
557- `alsa-info.sh` output; run with `--no-upload` option. See the
558 section below about alsa-info
559
560If it's a regression, at best, send alsa-info outputs of both working
561and non-working kernels. This is really helpful because we can
562compare the codec registers directly.
563
564Send a bug report either the followings:
565
566kernel-bugzilla::
Justin P. Mattock0ea6e612010-07-23 20:51:24 -0700567 https://bugzilla.kernel.org/
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100568alsa-devel ML::
569 alsa-devel@alsa-project.org
570
571
572DEBUG TOOLS
573-----------
574
575This section describes some tools available for debugging HD-audio
576problems.
577
578alsa-info
579~~~~~~~~~
580The script `alsa-info.sh` is a very useful tool to gather the audio
581device information. You can fetch the latest version from:
582
583- http://www.alsa-project.org/alsa-info.sh
584
585Run this script as root, and it will gather the important information
586such as the module lists, module parameters, proc file contents
587including the codec proc files, mixer outputs and the control
588elements. As default, it will store the information onto a web server
589on alsa-project.org. But, if you send a bug report, it'd be better to
590run with `--no-upload` option, and attach the generated file.
591
592There are some other useful options. See `--help` option output for
593details.
594
Takashi Iwaiae374d62009-02-13 08:33:55 +0100595When a probe error occurs or when the driver obviously assigns a
596mismatched model, it'd be helpful to load the driver with
597`probe_only=1` option (at best after the cold reboot) and run
598alsa-info at this state. With this option, the driver won't configure
599the mixer and PCM but just tries to probe the codec slot. After
600probing, the proc file is available, so you can get the raw codec
601information before modified by the driver. Of course, the driver
602isn't usable with `probe_only=1`. But you can continue the
603configuration via hwdep sysfs file if hda-reconfig option is enabled.
Jaroslav Kysela10e77dd2010-03-26 11:04:38 +0100604Using `probe_only` mask 2 skips the reset of HDA codecs (use
605`probe_only=3` as module option). The hwdep interface can be used
606to determine the BIOS codec initialization.
Takashi Iwaiae374d62009-02-13 08:33:55 +0100607
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100608
609hda-verb
610~~~~~~~~
611hda-verb is a tiny program that allows you to access the HD-audio
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100612codec directly. You can execute a raw HD-audio codec verb with this.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100613This program accesses the hwdep device, thus you need to enable the
614kernel config `CONFIG_SND_HDA_HWDEP=y` beforehand.
615
616The hda-verb program takes four arguments: the hwdep device file, the
617widget NID, the verb and the parameter. When you access to the codec
618on the slot 2 of the card 0, pass /dev/snd/hwC0D2 to the first
619argument, typically. (However, the real path name depends on the
620system.)
621
622The second parameter is the widget number-id to access. The third
623parameter can be either a hex/digit number or a string corresponding
624to a verb. Similarly, the last parameter is the value to write, or
625can be a string for the parameter type.
626
627------------------------------------------------------------------------
628 % hda-verb /dev/snd/hwC0D0 0x12 0x701 2
629 nid = 0x12, verb = 0x701, param = 0x2
630 value = 0x0
631
632 % hda-verb /dev/snd/hwC0D0 0x0 PARAMETERS VENDOR_ID
633 nid = 0x0, verb = 0xf00, param = 0x0
634 value = 0x10ec0262
635
636 % hda-verb /dev/snd/hwC0D0 2 set_a 0xb080
637 nid = 0x2, verb = 0x300, param = 0xb080
638 value = 0x0
639------------------------------------------------------------------------
640
641Although you can issue any verbs with this program, the driver state
642won't be always updated. For example, the volume values are usually
643cached in the driver, and thus changing the widget amp value directly
644via hda-verb won't change the mixer value.
645
646The hda-verb program is found in the ftp directory:
647
648- ftp://ftp.kernel.org/pub/linux/kernel/people/tiwai/misc/
649
650Also a git repository is available:
651
652- git://git.kernel.org/pub/scm/linux/kernel/git/tiwai/hda-verb.git
653
654See README file in the tarball for more details about hda-verb
655program.
656
657
658hda-analyzer
659~~~~~~~~~~~~
660hda-analyzer provides a graphical interface to access the raw HD-audio
661control, based on pyGTK2 binding. It's a more powerful version of
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100662hda-verb. The program gives you an easy-to-use GUI stuff for showing
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100663the widget information and adjusting the amp values, as well as the
664proc-compatible output.
665
Alexey Fisher11caa3b2009-12-09 09:42:07 +0100666The hda-analyzer:
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100667
668- http://git.alsa-project.org/?p=alsa.git;a=tree;f=hda-analyzer
669
Alexey Fisher11caa3b2009-12-09 09:42:07 +0100670is a part of alsa.git repository in alsa-project.org:
671
672- git://git.alsa-project.org/alsa.git
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100673
Takashi Iwai623b9f62008-12-11 07:44:18 +0100674Codecgraph
675~~~~~~~~~~
676Codecgraph is a utility program to generate a graph and visualizes the
677codec-node connection of a codec chip. It's especially useful when
678you analyze or debug a codec without a proper datasheet. The program
679parses the given codec proc file and converts to SVG via graphiz
680program.
681
682The tarball and GIT trees are found in the web page at:
683
684- http://helllabs.org/codecgraph/
685
686
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100687hda-emu
688~~~~~~~
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100689hda-emu is an HD-audio emulator. The main purpose of this program is
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100690to debug an HD-audio codec without the real hardware. Thus, it
691doesn't emulate the behavior with the real audio I/O, but it just
692dumps the codec register changes and the ALSA-driver internal changes
693at probing and operating the HD-audio driver.
694
695The program requires a codec proc-file to simulate. Get a proc file
696for the target codec beforehand, or pick up an example codec from the
697codec proc collections in the tarball. Then, run the program with the
698proc file, and the hda-emu program will start parsing the codec file
699and simulates the HD-audio driver:
700
701------------------------------------------------------------------------
702 % hda-emu codecs/stac9200-dell-d820-laptop
703 # Parsing..
704 hda_codec: Unknown model for STAC9200, using BIOS defaults
705 hda_codec: pin nid 08 bios pin config 40c003fa
706 ....
707------------------------------------------------------------------------
708
709The program gives you only a very dumb command-line interface. You
710can get a proc-file dump at the current state, get a list of control
711(mixer) elements, set/get the control element value, simulate the PCM
712operation, the jack plugging simulation, etc.
713
714The package is found in:
715
716- ftp://ftp.kernel.org/pub/linux/kernel/people/tiwai/misc/
717
718A git repository is available:
719
720- git://git.kernel.org/pub/scm/linux/kernel/git/tiwai/hda-emu.git
721
722See README file in the tarball for more details about hda-emu
723program.