blob: bdafdbd32561afa6e85ada5bef103085af94dbd7 [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.
60`position_fix=2` means to use the position-buffer. 0 is the default
Takashi Iwaid2afbe72008-12-10 09:28:15 +010061value, the automatic check and fallback to LPIB as described in the
62above. If you get a problem of repeated sounds, this option might
63help.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +010064
65In addition to that, every controller is known to be broken regarding
66the wake-up timing. It wakes up a few samples before actually
67processing the data on the buffer. This caused a lot of problems, for
68example, with ALSA dmix or JACK. Since 2.6.27 kernel, the driver puts
69an artificial delay to the wake up timing. This delay is controlled
70via `bdl_pos_adj` option.
71
72When `bdl_pos_adj` is a negative value (as default), it's assigned to
73an appropriate value depending on the controller chip. For Intel
Takashi Iwaid2afbe72008-12-10 09:28:15 +010074chips, it'd be 1 while it'd be 32 for others. Usually this works.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +010075Only in case it doesn't work and you get warning messages, you should
Takashi Iwaid2afbe72008-12-10 09:28:15 +010076change this parameter to other values.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +010077
78
79Codec-Probing Problem
80~~~~~~~~~~~~~~~~~~~~~
81A less often but a more severe problem is the codec probing. When
82BIOS reports the available codec slots wrongly, the driver gets
83confused and tries to access the non-existing codec slot. This often
Takashi Iwaid2afbe72008-12-10 09:28:15 +010084results in the total screw-up, and destructs the further communication
85with the codec chips. The symptom appears usually as error messages
86like:
Takashi Iwaia7fe49b2008-12-03 18:26:35 +010087------------------------------------------------------------------------
Takashi Iwaid2afbe72008-12-10 09:28:15 +010088 hda_intel: azx_get_response timeout, switching to polling mode:
Takashi Iwaia7fe49b2008-12-03 18:26:35 +010089 last cmd=0x12345678
Takashi Iwaid2afbe72008-12-10 09:28:15 +010090 hda_intel: azx_get_response timeout, switching to single_cmd mode:
Takashi Iwaia7fe49b2008-12-03 18:26:35 +010091 last cmd=0x12345678
92------------------------------------------------------------------------
93
94The first line is a warning, and this is usually relatively harmless.
95It means that the codec response isn't notified via an IRQ. The
96driver uses explicit polling method to read the response. It gives
97very slight CPU overhead, but you'd unlikely notice it.
98
99The second line is, however, a fatal error. If this happens, usually
100it means that something is really wrong. Most likely you are
101accessing a non-existing codec slot.
102
103Thus, if the second error message appears, try to narrow the probed
104codec slots via `probe_mask` option. It's a bitmask, and each bit
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100105corresponds to the codec slot. For example, to probe only the first
106slot, pass `probe_mask=1`. For the first and the third slots, pass
107`probe_mask=5` (where 5 = 1 | 4), and so on.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100108
109Since 2.6.29 kernel, the driver has a more robust probing method, so
110this error might happen rarely, though.
111
Takashi Iwaiae374d62009-02-13 08:33:55 +0100112On a machine with a broken BIOS, sometimes you need to force the
113driver to probe the codec slots the hardware doesn't report for use.
114In such a case, turn the bit 8 (0x100) of `probe_mask` option on.
115Then the rest 8 bits are passed as the codec slots to probe
116unconditionally. For example, `probe_mask=0x103` will force to probe
117the codec slots 0 and 1 no matter what the hardware reports.
118
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100119
120Interrupt Handling
121~~~~~~~~~~~~~~~~~~
Takashi Iwai91cb1732010-04-01 18:08:29 +0200122HD-audio driver uses MSI as default (if available) since 2.6.33
123kernel as MSI works better on some machines, and in general, it's
124better for performance. However, Nvidia controllers showed bad
125regressions with MSI (especially in a combination with AMD chipset),
126thus we disabled MSI for them.
127
128There seem also still other devices that don't work with MSI. If you
129see a regression wrt the sound quality (stuttering, etc) or a lock-up
130in the recent kernel, try to pass `enable_msi=0` option to disable
131MSI. If it works, you can add the known bad device to the blacklist
132defined in hda_intel.c. In such a case, please report and give the
133patch back to the upstream developer.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100134
135
136HD-AUDIO CODEC
137--------------
138
139Model Option
140~~~~~~~~~~~~
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100141The most common problem regarding the HD-audio driver is the
142unsupported codec features or the mismatched device configuration.
143Most of codec-specific code has several preset models, either to
144override the BIOS setup or to provide more comprehensive features.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100145
146The driver checks PCI SSID and looks through the static configuration
147table until any matching entry is found. If you have a new machine,
148you may see a message like below:
149------------------------------------------------------------------------
Takashi Iwai9a11f1a2009-07-28 16:01:20 +0200150 hda_codec: ALC880: BIOS auto-probing.
151------------------------------------------------------------------------
152Meanwhile, in the earlier versions, you would see a message like:
153------------------------------------------------------------------------
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100154 hda_codec: Unknown model for ALC880, trying auto-probe from BIOS...
155------------------------------------------------------------------------
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100156Even if you see such a message, DON'T PANIC. Take a deep breath and
157keep your towel. First of all, it's an informational message, no
158warning, no error. This means that the PCI SSID of your device isn't
159listed in the known preset model (white-)list. But, this doesn't mean
160that the driver is broken. Many codec-drivers provide the automatic
161configuration mechanism based on the BIOS setup.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100162
163The HD-audio codec has usually "pin" widgets, and BIOS sets the default
164configuration of each pin, which indicates the location, the
165connection type, the jack color, etc. The HD-audio driver can guess
166the right connection judging from these default configuration values.
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100167However -- some codec-support codes, such as patch_analog.c, don't
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100168support the automatic probing (yet as of 2.6.28). And, BIOS is often,
169yes, pretty often broken. It sets up wrong values and screws up the
170driver.
171
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100172The preset model is provided basically to overcome such a situation.
173When the matching preset model is found in the white-list, the driver
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100174assumes the static configuration of that preset and builds the mixer
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100175elements and PCM streams based on the static information. Thus, if
176you have a newer machine with a slightly different PCI SSID from the
177existing one, you may have a good chance to re-use the same model.
178You can pass the `model` option to specify the preset model instead of
179PCI SSID look-up.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100180
181What `model` option values are available depends on the codec chip.
182Check your codec chip from the codec proc file (see "Codec Proc-File"
183section below). It will show the vendor/product name of your codec
Justin Mattock83b20862009-04-14 14:31:21 -0700184chip. Then, see Documentation/sound/alsa/HD-Audio-Models.txt file,
Takashi Iwai692f9042008-12-19 12:44:46 +0100185the section of HD-audio driver. You can find a list of codecs
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100186and `model` options belonging to each codec. For example, for Realtek
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100187ALC262 codec chip, pass `model=ultra` for devices that are compatible
188with Samsung Q1 Ultra.
189
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100190Thus, the first thing you can do for any brand-new, unsupported and
191non-working HD-audio hardware is to check HD-audio codec and several
Justin Mattock83b20862009-04-14 14:31:21 -0700192different `model` option values. If you have any luck, some of them
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100193might suit with your device well.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100194
195Some codecs such as ALC880 have a special model option `model=test`.
196This configures the driver to provide as many mixer controls as
197possible for every single pin feature except for the unsolicited
198events (and maybe some other specials). Adjust each mixer element and
199try the I/O in the way of trial-and-error until figuring out the whole
200I/O pin mappings.
201
202Note that `model=generic` has a special meaning. It means to use the
203generic parser regardless of the codec. Usually the codec-specific
204parser is much better than the generic parser (as now). Thus this
205option is more about the debugging purpose.
206
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100207Speaker and Headphone Output
208~~~~~~~~~~~~~~~~~~~~~~~~~~~~
209One of the most frequent (and obvious) bugs with HD-audio is the
210silent output from either or both of a built-in speaker and a
211headphone jack. In general, you should try a headphone output at
212first. A speaker output often requires more additional controls like
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100213the external amplifier bits. Thus a headphone output has a slightly
214better chance.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100215
216Before making a bug report, double-check whether the mixer is set up
217correctly. The recent version of snd-hda-intel driver provides mostly
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100218"Master" volume control as well as "Front" volume (where Front
219indicates the front-channels). In addition, there can be individual
220"Headphone" and "Speaker" controls.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100221
222Ditto for the speaker output. There can be "External Amplifier"
223switch on some codecs. Turn on this if present.
224
225Another related problem is the automatic mute of speaker output by
226headphone plugging. This feature is implemented in most cases, but
227not on every preset model or codec-support code.
228
229In anyway, try a different model option if you have such a problem.
230Some other models may match better and give you more matching
231functionality. If none of the available models works, send a bug
232report. See the bug report section for details.
233
234If you are masochistic enough to debug the driver problem, note the
235following:
236
237- The speaker (and the headphone, too) output often requires the
238 external amplifier. This can be set usually via EAPD verb or a
239 certain GPIO. If the codec pin supports EAPD, you have a better
240 chance via SET_EAPD_BTL verb (0x70c). On others, GPIO pin (mostly
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100241 it's either GPIO0 or GPIO1) may turn on/off EAPD.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100242- Some Realtek codecs require special vendor-specific coefficients to
243 turn on the amplifier. See patch_realtek.c.
244- IDT codecs may have extra power-enable/disable controls on each
245 analog pin. See patch_sigmatel.c.
246- Very rare but some devices don't accept the pin-detection verb until
247 triggered. Issuing GET_PIN_SENSE verb (0xf09) may result in the
248 codec-communication stall. Some examples are found in
249 patch_realtek.c.
250
251
252Capture Problems
253~~~~~~~~~~~~~~~~
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100254The capture problems are often because of missing setups of mixers.
255Thus, before submitting a bug report, make sure that you set up the
256mixer correctly. For example, both "Capture Volume" and "Capture
257Switch" have to be set properly in addition to the right "Capture
258Source" or "Input Source" selection. Some devices have "Mic Boost"
259volume or switch.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100260
261When the PCM device is opened via "default" PCM (without pulse-audio
262plugin), you'll likely have "Digital Capture Volume" control as well.
263This is provided for the extra gain/attenuation of the signal in
264software, especially for the inputs without the hardware volume
265control such as digital microphones. Unless really needed, this
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100266should be set to exactly 50%, corresponding to 0dB -- neither extra
267gain nor attenuation. When you use "hw" PCM, i.e., a raw access PCM,
268this control will have no influence, though.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100269
270It's known that some codecs / devices have fairly bad analog circuits,
271and the recorded sound contains a certain DC-offset. This is no bug
272of the driver.
273
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100274Most of modern laptops have no analog CD-input connection. Thus, the
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100275recording from CD input won't work in many cases although the driver
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100276provides it as the capture source. Use CDDA instead.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100277
278The automatic switching of the built-in and external mic per plugging
279is implemented on some codec models but not on every model. Partly
280because of my laziness but mostly lack of testers. Feel free to
281submit the improvement patch to the author.
282
283
284Direct Debugging
285~~~~~~~~~~~~~~~~
Takashi Iwaif8bbd062008-12-11 13:12:59 +0100286If no model option gives you a better result, and you are a tough guy
Takashi Iwai623b9f62008-12-11 07:44:18 +0100287to fight against evil, try debugging via hitting the raw HD-audio
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100288codec verbs to the device. Some tools are available: hda-emu and
289hda-analyzer. The detailed description is found in the sections
290below. You'd need to enable hwdep for using these tools. See "Kernel
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100291Configuration" section.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100292
293
294OTHER ISSUES
295------------
296
297Kernel Configuration
298~~~~~~~~~~~~~~~~~~~~
299In general, I recommend you to enable the sound debug option,
300`CONFIG_SND_DEBUG=y`, no matter whether you are debugging or not.
301This enables snd_printd() macro and others, and you'll get additional
302kernel messages at probing.
303
304In addition, you can enable `CONFIG_SND_DEBUG_VERBOSE=y`. But this
305will give you far more messages. Thus turn this on only when you are
306sure to want it.
307
308Don't forget to turn on the appropriate `CONFIG_SND_HDA_CODEC_*`
309options. Note that each of them corresponds to the codec chip, not
310the controller chip. Thus, even if lspci shows the Nvidia controller,
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100311you may need to choose the option for other vendors. If you are
312unsure, just select all yes.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100313
314`CONFIG_SND_HDA_HWDEP` is a useful option for debugging the driver.
315When this is enabled, the driver creates hardware-dependent devices
316(one per each codec), and you have a raw access to the device via
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100317these device files. For example, `hwC0D2` will be created for the
318codec slot #2 of the first card (#0). For debug-tools such as
319hda-verb and hda-analyzer, the hwdep device has to be enabled.
320Thus, it'd be better to turn this on always.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100321
322`CONFIG_SND_HDA_RECONFIG` is a new option, and this depends on the
323hwdep option above. When enabled, you'll have some sysfs files under
324the corresponding hwdep directory. See "HD-audio reconfiguration"
325section below.
326
327`CONFIG_SND_HDA_POWER_SAVE` option enables the power-saving feature.
328See "Power-saving" section below.
329
330
331Codec Proc-File
332~~~~~~~~~~~~~~~
333The codec proc-file is a treasure-chest for debugging HD-audio.
334It shows most of useful information of each codec widget.
335
336The proc file is located in /proc/asound/card*/codec#*, one file per
337each codec slot. You can know the codec vendor, product id and
338names, the type of each widget, capabilities and so on.
339This file, however, doesn't show the jack sensing state, so far. This
340is because the jack-sensing might be depending on the trigger state.
341
342This file will be picked up by the debug tools, and also it can be fed
343to the emulator as the primary codec information. See the debug tools
344section below.
345
346This proc file can be also used to check whether the generic parser is
347used. When the generic parser is used, the vendor/product ID name
348will appear as "Realtek ID 0262", instead of "Realtek ALC262".
349
350
351HD-Audio Reconfiguration
352~~~~~~~~~~~~~~~~~~~~~~~~
353This is an experimental feature to allow you re-configure the HD-audio
354codec dynamically without reloading the driver. The following sysfs
355files are available under each codec-hwdep device directory (e.g.
356/sys/class/sound/hwC0D0):
357
358vendor_id::
359 Shows the 32bit codec vendor-id hex number. You can change the
360 vendor-id value by writing to this file.
361subsystem_id::
362 Shows the 32bit codec subsystem-id hex number. You can change the
363 subsystem-id value by writing to this file.
364revision_id::
365 Shows the 32bit codec revision-id hex number. You can change the
366 revision-id value by writing to this file.
367afg::
368 Shows the AFG ID. This is read-only.
369mfg::
370 Shows the MFG ID. This is read-only.
371name::
372 Shows the codec name string. Can be changed by writing to this
373 file.
374modelname::
375 Shows the currently set `model` option. Can be changed by writing
376 to this file.
377init_verbs::
378 The extra verbs to execute at initialization. You can add a verb by
Takashi Iwaid02b1f32009-03-02 17:34:51 +0100379 writing to this file. Pass three numbers: nid, verb and parameter
380 (separated with a space).
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100381hints::
Takashi Iwaid02b1f32009-03-02 17:34:51 +0100382 Shows / stores hint strings for codec parsers for any use.
383 Its format is `key = value`. For example, passing `hp_detect = yes`
384 to IDT/STAC codec parser will result in the disablement of the
385 headphone detection.
Takashi Iwaif1085c42009-02-20 14:50:35 +0100386init_pin_configs::
387 Shows the initial pin default config values set by BIOS.
Takashi Iwai346ff702009-02-23 09:42:57 +0100388driver_pin_configs::
Takashi Iwaif1085c42009-02-20 14:50:35 +0100389 Shows the pin default values set by the codec parser explicitly.
390 This doesn't show all pin values but only the changed values by
391 the parser. That is, if the parser doesn't change the pin default
392 config values by itself, this will contain nothing.
Takashi Iwai346ff702009-02-23 09:42:57 +0100393user_pin_configs::
394 Shows the pin default config values to override the BIOS setup.
395 Writing this (with two numbers, NID and value) appends the new
396 value. The given will be used instead of the initial BIOS value at
Takashi Iwai5e7b8e02009-02-23 09:45:59 +0100397 the next reconfiguration time. Note that this config will override
398 even the driver pin configs, too.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100399reconfig::
400 Triggers the codec re-configuration. When any value is written to
401 this file, the driver re-initialize and parses the codec tree
402 again. All the changes done by the sysfs entries above are taken
403 into account.
404clear::
405 Resets the codec, removes the mixer elements and PCM stuff of the
406 specified codec, and clear all init verbs and hints.
407
Takashi Iwai39c28712009-02-23 14:14:51 +0100408For example, when you want to change the pin default configuration
409value of the pin widget 0x14 to 0x9993013f, and let the driver
410re-configure based on that state, run like below:
411------------------------------------------------------------------------
412 # echo 0x14 0x9993013f > /sys/class/sound/hwC0D0/user_pin_configs
413 # echo 1 > /sys/class/sound/hwC0D0/reconfig
414------------------------------------------------------------------------
415
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100416
Takashi Iwai76824822009-06-17 17:17:18 +0200417Early Patching
418~~~~~~~~~~~~~~
419When CONFIG_SND_HDA_PATCH_LOADER=y is set, you can pass a "patch" as a
420firmware file for modifying the HD-audio setup before initializing the
421codec. This can work basically like the reconfiguration via sysfs in
422the above, but it does it before the first codec configuration.
423
Takashi Iwai1e7b8c82009-06-17 17:30:54 +0200424A patch file is a plain text file which looks like below:
Takashi Iwai76824822009-06-17 17:17:18 +0200425
426------------------------------------------------------------------------
427 [codec]
428 0x12345678 0xabcd1234 2
429
430 [model]
431 auto
432
433 [pincfg]
434 0x12 0x411111f0
435
436 [verb]
437 0x20 0x500 0x03
438 0x20 0x400 0xff
439
440 [hint]
441 hp_detect = yes
442------------------------------------------------------------------------
443
444The file needs to have a line `[codec]`. The next line should contain
445three numbers indicating the codec vendor-id (0x12345678 in the
446example), the codec subsystem-id (0xabcd1234) and the address (2) of
447the codec. The rest patch entries are applied to this specified codec
448until another codec entry is given.
449
450The `[model]` line allows to change the model name of the each codec.
451In the example above, it will be changed to model=auto.
452Note that this overrides the module option.
453
454After the `[pincfg]` line, the contents are parsed as the initial
455default pin-configurations just like `user_pin_configs` sysfs above.
456The values can be shown in user_pin_configs sysfs file, too.
457
458Similarly, the lines after `[verb]` are parsed as `init_verbs`
459sysfs entries, and the lines after `[hint]` are parsed as `hints`
460sysfs entries, respectively.
461
Takashi Iwaib09f3e72010-01-28 00:01:53 +0100462Another example to override the codec vendor id from 0x12345678 to
4630xdeadbeef is like below:
464------------------------------------------------------------------------
465 [codec]
466 0x12345678 0xabcd1234 2
467
468 [vendor_id]
469 0xdeadbeef
470------------------------------------------------------------------------
471
472In the similar way, you can override the codec subsystem_id via
473`[subsystem_id]`, the revision id via `[revision_id]` line.
474Also, the codec chip name can be rewritten via `[chip_name]` line.
475------------------------------------------------------------------------
476 [codec]
477 0x12345678 0xabcd1234 2
478
479 [subsystem_id]
480 0xffff1111
481
482 [revision_id]
483 0x10
484
485 [chip_name]
486 My-own NEWS-0002
487------------------------------------------------------------------------
488
Takashi Iwai1e7b8c82009-06-17 17:30:54 +0200489The hd-audio driver reads the file via request_firmware(). Thus,
490a patch file has to be located on the appropriate firmware path,
491typically, /lib/firmware. For example, when you pass the option
492`patch=hda-init.fw`, the file /lib/firmware/hda-init-fw must be
493present.
494
495The patch module option is specific to each card instance, and you
496need to give one file name for each instance, separated by commas.
497For example, if you have two cards, one for an on-board analog and one
498for an HDMI video board, you may pass patch option like below:
499------------------------------------------------------------------------
500 options snd-hda-intel patch=on-board-patch,hdmi-patch
501------------------------------------------------------------------------
502
Takashi Iwai76824822009-06-17 17:17:18 +0200503
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100504Power-Saving
505~~~~~~~~~~~~
506The power-saving is a kind of auto-suspend of the device. When the
507device is inactive for a certain time, the device is automatically
508turned off to save the power. The time to go down is specified via
509`power_save` module option, and this option can be changed dynamically
510via sysfs.
511
512The power-saving won't work when the analog loopback is enabled on
513some codecs. Make sure that you mute all unneeded signal routes when
514you want the power-saving.
515
516The power-saving feature might cause audible click noises at each
517power-down/up depending on the device. Some of them might be
518solvable, but some are hard, I'm afraid. Some distros such as
519openSUSE enables the power-saving feature automatically when the power
520cable is unplugged. Thus, if you hear noises, suspect first the
Takashi Iwai623b9f62008-12-11 07:44:18 +0100521power-saving. See /sys/module/snd_hda_intel/parameters/power_save to
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100522check the current value. If it's non-zero, the feature is turned on.
523
524
Takashi Iwai132bb7c2008-12-11 15:39:52 +0100525Development Tree
526~~~~~~~~~~~~~~~~
527The latest development codes for HD-audio are found on sound git tree:
528
529- git://git.kernel.org/pub/scm/linux/kernel/git/tiwai/sound-2.6.git
530
531The master branch or for-next branches can be used as the main
532development branches in general while the HD-audio specific patches
533are committed in topic/hda branch.
534
535If you are using the latest Linus tree, it'd be better to pull the
536above GIT tree onto it. If you are using the older kernels, an easy
537way to try the latest ALSA code is to build from the snapshot
538tarball. There are daily tarballs and the latest snapshot tarball.
539All can be built just like normal alsa-driver release packages, that
540is, installed via the usual spells: configure, make and make
541install(-modules). See INSTALL in the package. The snapshot tarballs
542are found at:
543
544- ftp://ftp.kernel.org/pub/linux/kernel/people/tiwai/snapshot/
545
546
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100547Sending a Bug Report
548~~~~~~~~~~~~~~~~~~~~
549If any model or module options don't work for your device, it's time
550to send a bug report to the developers. Give the following in your
551bug report:
552
553- Hardware vendor, product and model names
554- Kernel version (and ALSA-driver version if you built externally)
555- `alsa-info.sh` output; run with `--no-upload` option. See the
556 section below about alsa-info
557
558If it's a regression, at best, send alsa-info outputs of both working
559and non-working kernels. This is really helpful because we can
560compare the codec registers directly.
561
562Send a bug report either the followings:
563
564kernel-bugzilla::
565 http://bugme.linux-foundation.org/
566alsa-devel ML::
567 alsa-devel@alsa-project.org
568
569
570DEBUG TOOLS
571-----------
572
573This section describes some tools available for debugging HD-audio
574problems.
575
576alsa-info
577~~~~~~~~~
578The script `alsa-info.sh` is a very useful tool to gather the audio
579device information. You can fetch the latest version from:
580
581- http://www.alsa-project.org/alsa-info.sh
582
583Run this script as root, and it will gather the important information
584such as the module lists, module parameters, proc file contents
585including the codec proc files, mixer outputs and the control
586elements. As default, it will store the information onto a web server
587on alsa-project.org. But, if you send a bug report, it'd be better to
588run with `--no-upload` option, and attach the generated file.
589
590There are some other useful options. See `--help` option output for
591details.
592
Takashi Iwaiae374d62009-02-13 08:33:55 +0100593When a probe error occurs or when the driver obviously assigns a
594mismatched model, it'd be helpful to load the driver with
595`probe_only=1` option (at best after the cold reboot) and run
596alsa-info at this state. With this option, the driver won't configure
597the mixer and PCM but just tries to probe the codec slot. After
598probing, the proc file is available, so you can get the raw codec
599information before modified by the driver. Of course, the driver
600isn't usable with `probe_only=1`. But you can continue the
601configuration via hwdep sysfs file if hda-reconfig option is enabled.
Jaroslav Kysela10e77dd2010-03-26 11:04:38 +0100602Using `probe_only` mask 2 skips the reset of HDA codecs (use
603`probe_only=3` as module option). The hwdep interface can be used
604to determine the BIOS codec initialization.
Takashi Iwaiae374d62009-02-13 08:33:55 +0100605
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100606
607hda-verb
608~~~~~~~~
609hda-verb is a tiny program that allows you to access the HD-audio
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100610codec directly. You can execute a raw HD-audio codec verb with this.
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100611This program accesses the hwdep device, thus you need to enable the
612kernel config `CONFIG_SND_HDA_HWDEP=y` beforehand.
613
614The hda-verb program takes four arguments: the hwdep device file, the
615widget NID, the verb and the parameter. When you access to the codec
616on the slot 2 of the card 0, pass /dev/snd/hwC0D2 to the first
617argument, typically. (However, the real path name depends on the
618system.)
619
620The second parameter is the widget number-id to access. The third
621parameter can be either a hex/digit number or a string corresponding
622to a verb. Similarly, the last parameter is the value to write, or
623can be a string for the parameter type.
624
625------------------------------------------------------------------------
626 % hda-verb /dev/snd/hwC0D0 0x12 0x701 2
627 nid = 0x12, verb = 0x701, param = 0x2
628 value = 0x0
629
630 % hda-verb /dev/snd/hwC0D0 0x0 PARAMETERS VENDOR_ID
631 nid = 0x0, verb = 0xf00, param = 0x0
632 value = 0x10ec0262
633
634 % hda-verb /dev/snd/hwC0D0 2 set_a 0xb080
635 nid = 0x2, verb = 0x300, param = 0xb080
636 value = 0x0
637------------------------------------------------------------------------
638
639Although you can issue any verbs with this program, the driver state
640won't be always updated. For example, the volume values are usually
641cached in the driver, and thus changing the widget amp value directly
642via hda-verb won't change the mixer value.
643
644The hda-verb program is found in the ftp directory:
645
646- ftp://ftp.kernel.org/pub/linux/kernel/people/tiwai/misc/
647
648Also a git repository is available:
649
650- git://git.kernel.org/pub/scm/linux/kernel/git/tiwai/hda-verb.git
651
652See README file in the tarball for more details about hda-verb
653program.
654
655
656hda-analyzer
657~~~~~~~~~~~~
658hda-analyzer provides a graphical interface to access the raw HD-audio
659control, based on pyGTK2 binding. It's a more powerful version of
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100660hda-verb. The program gives you an easy-to-use GUI stuff for showing
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100661the widget information and adjusting the amp values, as well as the
662proc-compatible output.
663
Alexey Fisher11caa3b2009-12-09 09:42:07 +0100664The hda-analyzer:
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100665
666- http://git.alsa-project.org/?p=alsa.git;a=tree;f=hda-analyzer
667
Alexey Fisher11caa3b2009-12-09 09:42:07 +0100668is a part of alsa.git repository in alsa-project.org:
669
670- git://git.alsa-project.org/alsa.git
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100671
Takashi Iwai623b9f62008-12-11 07:44:18 +0100672Codecgraph
673~~~~~~~~~~
674Codecgraph is a utility program to generate a graph and visualizes the
675codec-node connection of a codec chip. It's especially useful when
676you analyze or debug a codec without a proper datasheet. The program
677parses the given codec proc file and converts to SVG via graphiz
678program.
679
680The tarball and GIT trees are found in the web page at:
681
682- http://helllabs.org/codecgraph/
683
684
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100685hda-emu
686~~~~~~~
Takashi Iwaid2afbe72008-12-10 09:28:15 +0100687hda-emu is an HD-audio emulator. The main purpose of this program is
Takashi Iwaia7fe49b2008-12-03 18:26:35 +0100688to debug an HD-audio codec without the real hardware. Thus, it
689doesn't emulate the behavior with the real audio I/O, but it just
690dumps the codec register changes and the ALSA-driver internal changes
691at probing and operating the HD-audio driver.
692
693The program requires a codec proc-file to simulate. Get a proc file
694for the target codec beforehand, or pick up an example codec from the
695codec proc collections in the tarball. Then, run the program with the
696proc file, and the hda-emu program will start parsing the codec file
697and simulates the HD-audio driver:
698
699------------------------------------------------------------------------
700 % hda-emu codecs/stac9200-dell-d820-laptop
701 # Parsing..
702 hda_codec: Unknown model for STAC9200, using BIOS defaults
703 hda_codec: pin nid 08 bios pin config 40c003fa
704 ....
705------------------------------------------------------------------------
706
707The program gives you only a very dumb command-line interface. You
708can get a proc-file dump at the current state, get a list of control
709(mixer) elements, set/get the control element value, simulate the PCM
710operation, the jack plugging simulation, etc.
711
712The package is found in:
713
714- ftp://ftp.kernel.org/pub/linux/kernel/people/tiwai/misc/
715
716A git repository is available:
717
718- git://git.kernel.org/pub/scm/linux/kernel/git/tiwai/hda-emu.git
719
720See README file in the tarball for more details about hda-emu
721program.