Lines Matching refs:the
9 HD-audio is the new standard on-board audio component on modern PCs
11 time ago, there are often problems with new machines. A part of the
12 problem is broken BIOS, and the rest is the driver implementation.
13 This document explains the brief trouble-shooting and debugging
14 methods for the HD-audio hardware.
16 The HD-audio component consists of two parts: the controller chip and
17 the codec chips on the HD-audio bus. Linux provides a single driver
18 for all controllers, snd-hda-intel. Although the driver name contains
20 all controller chips by other companies. Since the HD-audio
21 controllers are supposed to be compatible, the single snd-hda-driver
28 multiple audio codecs, e.g. for analog and digital outputs, and the
33 on the codec. It has a generic parser as a fallback, but this
34 functionality is fairly limited until now. Instead of the generic
35 parser, usually the codec-specific parser (coded in patch_*.c) is used
36 for the codec-specific implementations. The details about the
37 codec-specific problems are explained in the later sections.
39 If you are interested in the deep debugging of HD-audio, read the
51 The most common problem of the controller is the inaccurate DMA
54 map. As default the driver tries to read from the io-mapped
55 position-buffer, and falls back to LPIB if the position-buffer appears
57 a case, you can change the default method via `position_fix` option.
60 `position_fix=2` means to use the position-buffer.
65 and uses LPIB for the playback and the position-buffer for the capture
67 0 is the default value for all other
68 controllers, the automatic check and fallback to LPIB as described in
69 the above. If you get a problem of repeated sounds, this option might
73 the wake-up timing. It wakes up a few samples before actually
74 processing the data on the buffer. This caused a lot of problems, for
75 example, with ALSA dmix or JACK. Since 2.6.27 kernel, the driver puts
76 an artificial delay to the wake up timing. This delay is controlled
80 an appropriate value depending on the controller chip. For Intel
88 A less often but a more severe problem is the codec probing. When
89 BIOS reports the available codec slots wrongly, the driver gets
90 confused and tries to access the non-existing codec slot. This often
91 results in the total screw-up, and destructs the further communication
92 with the codec chips. The symptom appears usually as error messages
102 It means that the codec response isn't notified via an IRQ. The
103 driver uses explicit polling method to read the response. It gives
110 Thus, if the second error message appears, try to narrow the probed
112 corresponds to the codec slot. For example, to probe only the first
113 slot, pass `probe_mask=1`. For the first and the third slots, pass
116 Since 2.6.29 kernel, the driver has a more robust probing method, so
119 On a machine with a broken BIOS, sometimes you need to force the
120 driver to probe the codec slots the hardware doesn't report for use.
121 In such a case, turn the bit 8 (0x100) of `probe_mask` option on.
122 Then the rest 8 bits are passed as the codec slots to probe
124 the codec slots 0 and 1 no matter what the hardware reports.
136 see a regression wrt the sound quality (stuttering, etc) or a lock-up
137 in the recent kernel, try to pass `enable_msi=0` option to disable
138 MSI. If it works, you can add the known bad device to the blacklist
139 defined in hda_intel.c. In such a case, please report and give the
140 patch back to the upstream developer.
148 The most common problem regarding the HD-audio driver is the
149 unsupported codec features or the mismatched device configuration.
151 override the BIOS setup or to provide more comprehensive features.
153 The driver checks PCI SSID and looks through the static configuration
159 Meanwhile, in the earlier versions, you would see a message like:
165 warning, no error. This means that the PCI SSID of your device isn't
166 listed in the known preset model (white-)list. But, this doesn't mean
167 that the driver is broken. Many codec-drivers provide the automatic
168 configuration mechanism based on the BIOS setup.
170 The HD-audio codec has usually "pin" widgets, and BIOS sets the default
171 configuration of each pin, which indicates the location, the
172 connection type, the jack color, etc. The HD-audio driver can guess
173 the right connection judging from these default configuration values.
175 support the automatic probing (yet as of 2.6.28). And, BIOS is often,
176 yes, pretty often broken. It sets up wrong values and screws up the
180 basically to overcome such a situation. When the matching preset
181 model is found in the white-list, the driver assumes the static
182 configuration of that preset with the correct pin setup, etc.
184 (or codec SSID) from the existing one, you may have a good chance to
185 re-use the same model. You can pass the `model` option to specify the
188 What `model` option values are available depends on the codec chip.
189 Check your codec chip from the codec proc file (see "Codec Proc-File"
190 section below). It will show the vendor/product name of your codec
192 the section of HD-audio driver. You can find a list of codecs
197 Thus, the first thing you can do for any brand-new, unsupported and
203 - when 'nofixup' is passed, the device-specific fixups in the codec
205 - when `generic` is passed, the codec-specific parser is skipped and
206 only the generic parser is used.
211 One of the most frequent (and obvious) bugs with HD-audio is the
215 the external amplifier bits. Thus a headphone output has a slightly
218 Before making a bug report, double-check whether the mixer is set up
221 indicates the front-channels). In addition, there can be individual
224 Ditto for the speaker output. There can be "External Amplifier"
227 Another related problem is the automatic mute of speaker output by
233 functionality. If none of the available models works, send a bug
234 report. See the bug report section for details.
236 If you are masochistic enough to debug the driver problem, note the
239 - The speaker (and the headphone, too) output often requires the
241 certain GPIO. If the codec pin supports EAPD, you have a better
245 turn on the amplifier. See patch_realtek.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
257 Thus, before submitting a bug report, make sure that you set up the
259 Switch" have to be set properly in addition to the right "Capture
263 When the PCM device is opened via "default" PCM (without pulse-audio
265 This is provided for the extra gain/attenuation of the signal in
266 software, especially for the inputs without the hardware volume
273 and the recorded sound contains a certain DC-offset. This is no bug
274 of the driver.
276 Most of modern laptops have no analog CD-input connection. Thus, the
277 recording from CD input won't work in many cases although the driver
278 provides it as the capture source. Use CDDA instead.
280 The automatic switching of the built-in and external mic per plugging
283 submit the improvement patch to the author.
289 to fight against evil, try debugging via hitting the raw HD-audio
290 codec verbs to the device. Some tools are available: hda-emu and
291 hda-analyzer. The detailed description is found in the sections
301 In general, I recommend you to enable the sound debug option,
310 Don't forget to turn on the appropriate `CONFIG_SND_HDA_CODEC_*`
311 options. Note that each of them corresponds to the codec chip, not
312 the controller chip. Thus, even if lspci shows the Nvidia controller,
313 you may need to choose the option for other vendors. If you are
316 `CONFIG_SND_HDA_HWDEP` is a useful option for debugging the driver.
317 When this is enabled, the driver creates hardware-dependent devices
318 (one per each codec), and you have a raw access to the device via
319 these device files. For example, `hwC0D2` will be created for the
320 codec slot #2 of the first card (#0). For debug-tools such as
321 hda-verb and hda-analyzer, the hwdep device has to be enabled.
324 `CONFIG_SND_HDA_RECONFIG` is a new option, and this depends on the
326 the corresponding hwdep directory. See "HD-audio reconfiguration"
329 `CONFIG_SND_HDA_POWER_SAVE` option enables the power-saving feature.
339 each codec slot. You can know the codec vendor, product id and
340 names, the type of each widget, capabilities and so on.
341 This file, however, doesn't show the jack sensing state, so far. This
342 is because the jack-sensing might be depending on the trigger state.
344 This file will be picked up by the debug tools, and also it can be fed
345 to the emulator as the primary codec information. See the debug tools
348 This proc file can be also used to check whether the generic parser is
349 used. When the generic parser is used, the vendor/product ID name
355 This is an experimental feature to allow you re-configure the HD-audio
356 codec dynamically without reloading the driver. The following sysfs
361 Shows the 32bit codec vendor-id hex number. You can change the
364 Shows the 32bit codec subsystem-id hex number. You can change the
367 Shows the 32bit codec revision-id hex number. You can change the
370 Shows the AFG ID. This is read-only.
372 Shows the MFG ID. This is read-only.
374 Shows the codec name string. Can be changed by writing to this
377 Shows the currently set `model` option. Can be changed by writing
386 will disable the jack detection of the machine completely.
388 Shows the initial pin default config values set by BIOS.
390 Shows the pin default values set by the codec parser explicitly.
391 This doesn't show all pin values but only the changed values by
392 the parser. That is, if the parser doesn't change the pin default
395 Shows the pin default config values to override the BIOS setup.
396 Writing this (with two numbers, NID and value) appends the new
397 value. The given will be used instead of the initial BIOS value at
398 the next reconfiguration time. Note that this config will override
399 even the driver pin configs, too.
401 Triggers the codec re-configuration. When any value is written to
402 this file, the driver re-initialize and parses the codec tree
403 again. All the changes done by the sysfs entries above are taken
406 Resets the codec, removes the mixer elements and PCM stuff of the
409 For example, when you want to change the pin default configuration
410 value of the pin widget 0x14 to 0x9993013f, and let the driver
421 matching better with the actual codec or device behavior. Many of
423 the section above. For example, by passing `jack_detect = no` string
424 via sysfs or a patch file, you can disable the jack detection, thus
425 the codec parser will skip the features like auto-mute or mic
429 The generic parser supports the following hints:
431 - jack_detect (bool): specify whether the jack detection is available
433 - inv_jack_detect (bool): indicates that the jack detection logic is
435 - trigger_sense (bool): indicates that the jack detection needs the
437 - inv_eapd (bool): indicates that the EAPD is implemented in the
439 - pcm_format_first (bool): sets the PCM format before the stream tag
441 - sticky_stream (bool): keep the PCM format, stream tag and ID as long
443 - spdif_status_reset (bool): reset the SPDIF status bits at each time
444 the SPDIF stream is set up
445 - pin_amp_workaround (bool): the output pin may have multiple amp
448 - auto_mute (bool): enable/disable the headphone auto-mute feature;
450 - auto_mic (bool): enable/disable the mic auto-switch feature; default
452 - line_in_auto_switch (bool): enable/disable the line-in auto-switch
454 - need_dac_fix (bool): limits the DACs depending on the channel count
455 - primary_hp (bool): probe headphone jacks as the primary outputs;
462 - indep_hp (bool): provide the independent headphone PCM stream and
463 the corresponding mixer control, if available
464 - add_stereo_mix_input (bool): add the stereo mix (analog-loopback
465 mix) to the input mux if available
467 I/O jack for allowing to change the headphone amp and mic bias VREF
470 controlling the power sate (D0/D3) of each widget node depending on
471 the actual pin and stream states
472 - power_down_unused (bool): power down the unused widgets, a subset of
474 - add_hp_mic (bool): add the headphone to capture source if possible
475 - hp_mic_detect (bool): enable/disable the hp/mic shared input for a
477 - mixer_nid (int): specifies the widget NID of the analog-loopback
484 firmware file for modifying the HD-audio setup before initializing the
485 codec. This can work basically like the reconfiguration via sysfs in
486 the above, but it does it before the first codec configuration.
509 three numbers indicating the codec vendor-id (0x12345678 in the
510 example), the codec subsystem-id (0xabcd1234) and the address (2) of
511 the codec. The rest patch entries are applied to this specified codec
513 the first or the second value will make the check of the corresponding
517 The `[model]` line allows to change the model name of the each codec.
518 In the example above, it will be changed to model=auto.
519 Note that this overrides the module option.
521 After the `[pincfg]` line, the contents are parsed as the initial
525 Similarly, the lines after `[verb]` are parsed as `init_verbs`
526 sysfs entries, and the lines after `[hint]` are parsed as `hints`
529 Another example to override the codec vendor id from 0x12345678 to
539 In the similar way, you can override the codec subsystem_id via
540 `[subsystem_id]`, the revision id via `[revision_id]` line.
541 Also, the codec chip name can be rewritten via `[chip_name]` line.
556 The hd-audio driver reads the file via request_firmware(). Thus,
557 a patch file has to be located on the appropriate firmware path,
558 typically, /lib/firmware. For example, when you pass the option
559 `patch=hda-init.fw`, the file /lib/firmware/hda-init.fw must be
573 The power-saving is a kind of auto-suspend of the device. When the
574 device is inactive for a certain time, the device is automatically
575 turned off to save the power. The time to go down is specified via
579 The power-saving won't work when the analog loopback is enabled on
581 you want the power-saving.
584 power-down/up depending on the device. Some of them might be
586 openSUSE enables the power-saving feature automatically when the power
587 cable is unplugged. Thus, if you hear noises, suspect first the
589 check the current value. If it's non-zero, the feature is turned on.
591 The recent kernel supports the runtime PM for the HD-audio controller
592 chip, too. It means that the HD-audio controller is also powered up /
603 traces the response from RIRB (only when read from the codec driver).
604 `hda:hda_bus_reset` traces the bus-reset due to fatal error, etc,
605 `hda:hda_unsol_event` traces the unsolicited events, and
606 `hda:hda_power_down` and `hda:hda_power_up` trace the power down/up
615 trace what codec command is sent, enable the tracepoint like:
631 Here `[0:0]` indicates the card number and the codec address, and
632 `val` shows the value sent to the codec, respectively. The value is
634 included in hda-emu package below. For example, the value e3a019 is
635 to set the left output-amp value to 25.
653 The master branch or for-next branches can be used as the main
654 development branches in general while the development for the current
658 If you are using the latest Linus tree, it'd be better to pull the
659 above GIT tree onto it. If you are using the older kernels, an easy
660 way to try the latest ALSA code is to build from the snapshot
661 tarball. There are daily tarballs and the latest snapshot tarball.
663 is, installed via the usual spells: configure, make and make
664 install(-modules). See INSTALL in the package. The snapshot tarballs
673 to send a bug report to the developers. Give the following in your
678 - `alsa-info.sh` output; run with `--no-upload` option. See the
683 compare the codec registers directly.
685 Send a bug report either the followings:
701 The script `alsa-info.sh` is a very useful tool to gather the audio
702 device information. You can fetch the latest version from:
706 Run this script as root, and it will gather the important information
707 such as the module lists, module parameters, proc file contents
708 including the codec proc files, mixer outputs and the control
709 elements. As default, it will store the information onto a web server
711 run with `--no-upload` option, and attach the generated file.
716 When a probe error occurs or when the driver obviously assigns a
717 mismatched model, it'd be helpful to load the driver with
718 `probe_only=1` option (at best after the cold reboot) and run
719 alsa-info at this state. With this option, the driver won't configure
720 the mixer and PCM but just tries to probe the codec slot. After
721 probing, the proc file is available, so you can get the raw codec
722 information before modified by the driver. Of course, the driver
723 isn't usable with `probe_only=1`. But you can continue the
725 Using `probe_only` mask 2 skips the reset of HDA codecs (use
727 to determine the BIOS codec initialization.
732 hda-verb is a tiny program that allows you to access the HD-audio
734 This program accesses the hwdep device, thus you need to enable the
737 The hda-verb program takes four arguments: the hwdep device file, the
738 widget NID, the verb and the parameter. When you access to the codec
739 on the slot 2 of the card 0, pass /dev/snd/hwC0D2 to the first
740 argument, typically. (However, the real path name depends on the
743 The second parameter is the widget number-id to access. The third
745 to a verb. Similarly, the last parameter is the value to write, or
746 can be a string for the parameter type.
762 Although you can issue any verbs with this program, the driver state
763 won't be always updated. For example, the volume values are usually
764 cached in the driver, and thus changing the widget amp value directly
765 via hda-verb won't change the mixer value.
771 Also, the old stand-alone package is found in the ftp directory:
779 See README file in the tarball for more details about hda-verb
785 hda-analyzer provides a graphical interface to access the raw HD-audio
788 the widget information and adjusting the amp values, as well as the
801 Codecgraph is a utility program to generate a graph and visualizes the
804 parses the given codec proc file and converts to SVG via graphiz
807 The tarball and GIT trees are found in the web page at:
815 to debug an HD-audio codec without the real hardware. Thus, it
816 doesn't emulate the behavior with the real audio I/O, but it just
817 dumps the codec register changes and the ALSA-driver internal changes
818 at probing and operating the HD-audio driver.
821 for the target codec beforehand, or pick up an example codec from the
822 codec proc collections in the tarball. Then, run the program with the
823 proc file, and the hda-emu program will start parsing the codec file
824 and simulates the HD-audio driver:
835 can get a proc-file dump at the current state, get a list of control
836 (mixer) elements, set/get the control element value, simulate the PCM
837 operation, the jack plugging simulation, etc.
847 See README file in the tarball for more details about hda-emu
853 hda-jack-retask is a user-friendly GUI program to manipulate the
855 the jack assignment, try this program and check whether you can get
856 useful results. Once when you figure out the proper pin assignment,
857 it can be fixed either in the driver code statically or via passing a