Documentation/sound/hd-audio/notes.rst

   1 =============================
   2 More Notes on HD-Audio Driver
   3 =============================
   4
   5 Takashi Iwai <tiwai@suse.de>
   6
   7
   8 General
   9 =======
  10
  11 HD-audio is the new standard on-board audio component on modern PCs
  12 after AC97.  Although Linux has been supporting HD-audio since long
  13 time ago, there are often problems with new machines.  A part of the
  14 problem is broken BIOS, and the rest is the driver implementation.
  15 This document explains the brief trouble-shooting and debugging
  16 methods for the HD-audio hardware.
  17
  18 The HD-audio component consists of two parts: the controller chip and
  19 the codec chips on the HD-audio bus.  Linux provides a single driver
  20 for all controllers, snd-hda-intel.  Although the driver name contains
  21 a word of a well-known hardware vendor, it's not specific to it but for
  22 all controller chips by other companies.  Since the HD-audio
  23 controllers are supposed to be compatible, the single snd-hda-driver
  24 should work in most cases.  But, not surprisingly, there are known
  25 bugs and issues specific to each controller type.  The snd-hda-intel
  26 driver has a bunch of workarounds for these as described below.
  27
  28 A controller may have multiple codecs.  Usually you have one audio
  29 codec and optionally one modem codec.  In theory, there might be
  30 multiple audio codecs, e.g. for analog and digital outputs, and the
  31 driver might not work properly because of conflict of mixer elements.
  32 This should be fixed in future if such hardware really exists.
  33
  34 The snd-hda-intel driver has several different codec parsers depending
  35 on the codec.  It has a generic parser as a fallback, but this
  36 functionality is fairly limited until now.  Instead of the generic
  37 parser, usually the codec-specific parser (coded in patch_*.c) is used
  38 for the codec-specific implementations.  The details about the
  39 codec-specific problems are explained in the later sections.
  40
  41 If you are interested in the deep debugging of HD-audio, read the
  42 HD-audio specification at first.  The specification is found on
  43 Intel's web page, for example:
  44
  45 * https://www.intel.com/standards/hdaudio/
  46
  47
  48 HD-Audio Controller
  49 ===================
  50
  51 DMA-Position Problem
  52 --------------------
  53 The most common problem of the controller is the inaccurate DMA
  54 pointer reporting.  The DMA pointer for playback and capture can be
  55 read in two ways, either via a LPIB register or via a position-buffer
  56 map.  As default the driver tries to read from the io-mapped
  57 position-buffer, and falls back to LPIB if the position-buffer appears
  58 dead.  However, this detection isn't perfect on some devices.  In such
  59 a case, you can change the default method via ``position_fix`` option.
  60
  61 ``position_fix=1`` means to use LPIB method explicitly.
  62 ``position_fix=2`` means to use the position-buffer.
  63 ``position_fix=3`` means to use a combination of both methods, needed
  64 for some VIA controllers.  The capture stream position is corrected
  65 by comparing both LPIB and position-buffer values.
  66 ``position_fix=4`` is another combination available for all controllers,
  67 and uses LPIB for the playback and the position-buffer for the capture
  68 streams.
  69 ``position_fix=5`` is specific to Intel platforms, so far, for Skylake
  70 and onward.  It applies the delay calculation for the precise position
  71 reporting.
  72 ``position_fix=6`` is to correct the position with the fixed FIFO
  73 size, mainly targeted for the recent AMD controllers.
  74 0 is the default value for all other
  75 controllers, the automatic check and fallback to LPIB as described in
  76 the above.  If you get a problem of repeated sounds, this option might
  77 help.
  78
  79 In addition to that, every controller is known to be broken regarding
  80 the wake-up timing.  It wakes up a few samples before actually
  81 processing the data on the buffer.  This caused a lot of problems, for
  82 example, with ALSA dmix or JACK.  Since 2.6.27 kernel, the driver puts
  83 an artificial delay to the wake up timing.  This delay is controlled
  84 via ``bdl_pos_adj`` option.
  85
  86 When ``bdl_pos_adj`` is a negative value (as default), it's assigned to
  87 an appropriate value depending on the controller chip.  For Intel
  88 chips, it'd be 1 while it'd be 32 for others.  Usually this works.
  89 Only in case it doesn't work and you get warning messages, you should
  90 change this parameter to other values.
  91
  92
  93 Codec-Probing Problem
  94 ---------------------
  95 A less often but a more severe problem is the codec probing.  When
  96 BIOS reports the available codec slots wrongly, the driver gets
  97 confused and tries to access the non-existing codec slot.  This often
  98 results in the total screw-up, and destructs the further communication
  99 with the codec chips.  The symptom appears usually as error messages
 100 like:
 101 ::
 102
 103     hda_intel: azx_get_response timeout, switching to polling mode:
 104           last cmd=0x12345678
 105     hda_intel: azx_get_response timeout, switching to single_cmd mode:
 106           last cmd=0x12345678
 107
 108 The first line is a warning, and this is usually relatively harmless.
 109 It means that the codec response isn't notified via an IRQ.  The
 110 driver uses explicit polling method to read the response.  It gives
 111 very slight CPU overhead, but you'd unlikely notice it.
 112
 113 The second line is, however, a fatal error.  If this happens, usually
 114 it means that something is really wrong.  Most likely you are
 115 accessing a non-existing codec slot.
 116
 117 Thus, if the second error message appears, try to narrow the probed
 118 codec slots via ``probe_mask`` option.  It's a bitmask, and each bit
 119 corresponds to the codec slot.  For example, to probe only the first
 120 slot, pass ``probe_mask=1``.  For the first and the third slots, pass
 121 ``probe_mask=5`` (where 5 = 1 | 4), and so on.
 122
 123 Since 2.6.29 kernel, the driver has a more robust probing method, so
 124 this error might happen rarely, though.
 125
 126 On a machine with a broken BIOS, sometimes you need to force the
 127 driver to probe the codec slots the hardware doesn't report for use.
 128 In such a case, turn the bit 8 (0x100) of ``probe_mask`` option on.
 129 Then the rest 8 bits are passed as the codec slots to probe
 130 unconditionally.  For example, ``probe_mask=0x103`` will force to probe
 131 the codec slots 0 and 1 no matter what the hardware reports.
 132
 133
 134 Interrupt Handling
 135 ------------------
 136 HD-audio driver uses MSI as default (if available) since 2.6.33
 137 kernel as MSI works better on some machines, and in general, it's
 138 better for performance.  However, Nvidia controllers showed bad
 139 regressions with MSI (especially in a combination with AMD chipset),
 140 thus we disabled MSI for them.
 141
 142 There seem also still other devices that don't work with MSI.  If you
 143 see a regression wrt the sound quality (stuttering, etc) or a lock-up
 144 in the recent kernel, try to pass ``enable_msi=0`` option to disable
 145 MSI.  If it works, you can add the known bad device to the blacklist
 146 defined in hda_intel.c.  In such a case, please report and give the
 147 patch back to the upstream developer.
 148
 149
 150 HD-Audio Codec
 151 ==============
 152
 153 Model Option
 154 ------------
 155 The most common problem regarding the HD-audio driver is the
 156 unsupported codec features or the mismatched device configuration.
 157 Most of codec-specific code has several preset models, either to
 158 override the BIOS setup or to provide more comprehensive features.
 159
 160 The driver checks PCI SSID and looks through the static configuration
 161 table until any matching entry is found.  If you have a new machine,
 162 you may see a message like below:
 163 ::
 164
 165     hda_codec: ALC880: BIOS auto-probing.
 166
 167 Meanwhile, in the earlier versions, you would see a message like:
 168 ::
 169
 170     hda_codec: Unknown model for ALC880, trying auto-probe from BIOS...
 171
 172 Even if you see such a message, DON'T PANIC.  Take a deep breath and
 173 keep your towel.  First of all, it's an informational message, no
 174 warning, no error.  This means that the PCI SSID of your device isn't
 175 listed in the known preset model (white-)list.  But, this doesn't mean
 176 that the driver is broken.  Many codec-drivers provide the automatic
 177 configuration mechanism based on the BIOS setup.
 178
 179 The HD-audio codec has usually "pin" widgets, and BIOS sets the default
 180 configuration of each pin, which indicates the location, the
 181 connection type, the jack color, etc.  The HD-audio driver can guess
 182 the right connection judging from these default configuration values.
 183 However -- some codec-support codes, such as patch_analog.c, don't
 184 support the automatic probing (yet as of 2.6.28).  And, BIOS is often,
 185 yes, pretty often broken.  It sets up wrong values and screws up the
 186 driver.
 187
 188 The preset model (or recently called as "fix-up") is provided
 189 basically to overcome such a situation.  When the matching preset
 190 model is found in the white-list, the driver assumes the static
 191 configuration of that preset with the correct pin setup, etc.
 192 Thus, if you have a newer machine with a slightly different PCI SSID
 193 (or codec SSID) from the existing one, you may have a good chance to
 194 re-use the same model.  You can pass the ``model`` option to specify the
 195 preset model instead of PCI (and codec-) SSID look-up.
 196
 197 What ``model`` option values are available depends on the codec chip.
 198 Check your codec chip from the codec proc file (see "Codec Proc-File"
 199 section below).  It will show the vendor/product name of your codec
 200 chip.  Then, see Documentation/sound/hd-audio/models.rst file,
 201 the section of HD-audio driver.  You can find a list of codecs
 202 and ``model`` options belonging to each codec.  For example, for Realtek
 203 ALC262 codec chip, pass ``model=ultra`` for devices that are compatible
 204 with Samsung Q1 Ultra.
 205
 206 Thus, the first thing you can do for any brand-new, unsupported and
 207 non-working HD-audio hardware is to check HD-audio codec and several
 208 different ``model`` option values.  If you have any luck, some of them
 209 might suit with your device well.
 210
 211 There are a few special model option values:
 212
 213 * when 'nofixup' is passed, the device-specific fixups in the codec
 214   parser are skipped.
 215 * when ``generic`` is passed, the codec-specific parser is skipped and
 216   only the generic parser is used.
 217
 218 A new style for the model option that was introduced since 5.15 kernel
 219 is to pass the PCI or codec SSID in the form of ``model=XXXX:YYYY``
 220 where XXXX and YYYY are the sub-vendor and sub-device IDs in hex
 221 numbers, respectively.  This is a kind of aliasing to another device;
 222 when this form is given, the driver will refer to that SSID as a
 223 reference to the quirk table.  It'd be useful especially when the
 224 target quirk isn't listed in the model table.  For example, passing
 225 model=103c:8862 will apply the quirk for HP ProBook 445 G8 (which
 226 isn't found in the model table as of writing) as long as the device is
 227 handled equivalently by the same driver.
 228
 229
 230 Speaker and Headphone Output
 231 ----------------------------
 232 One of the most frequent (and obvious) bugs with HD-audio is the
 233 silent output from either or both of a built-in speaker and a
 234 headphone jack.  In general, you should try a headphone output at
 235 first.  A speaker output often requires more additional controls like
 236 the external amplifier bits.  Thus a headphone output has a slightly
 237 better chance.
 238
 239 Before making a bug report, double-check whether the mixer is set up
 240 correctly.  The recent version of snd-hda-intel driver provides mostly
 241 "Master" volume control as well as "Front" volume (where Front
 242 indicates the front-channels).  In addition, there can be individual
 243 "Headphone" and "Speaker" controls.
 244
 245 Ditto for the speaker output.  There can be "External Amplifier"
 246 switch on some codecs.  Turn on this if present.
 247
 248 Another related problem is the automatic mute of speaker output by
 249 headphone plugging.  This feature is implemented in most cases, but
 250 not on every preset model or codec-support code.
 251
 252 In anyway, try a different model option if you have such a problem.
 253 Some other models may match better and give you more matching
 254 functionality.  If none of the available models works, send a bug
 255 report.  See the bug report section for details.
 256
 257 If you are masochistic enough to debug the driver problem, note the
 258 following:
 259
 260 * The speaker (and the headphone, too) output often requires the
 261   external amplifier.  This can be set usually via EAPD verb or a
 262   certain GPIO.  If the codec pin supports EAPD, you have a better
 263   chance via SET_EAPD_BTL verb (0x70c).  On others, GPIO pin (mostly
 264   it's either GPIO0 or GPIO1) may turn on/off EAPD.
 265 * Some Realtek codecs require special vendor-specific coefficients to
 266   turn on the amplifier.  See patch_realtek.c.
 267 * IDT codecs may have extra power-enable/disable controls on each
 268   analog pin.  See patch_sigmatel.c.
 269 * Very rare but some devices don't accept the pin-detection verb until
 270   triggered.  Issuing GET_PIN_SENSE verb (0xf09) may result in the
 271   codec-communication stall.  Some examples are found in
 272   patch_realtek.c.
 273
 274
 275 Capture Problems
 276 ----------------
 277 The capture problems are often because of missing setups of mixers.
 278 Thus, before submitting a bug report, make sure that you set up the
 279 mixer correctly.  For example, both "Capture Volume" and "Capture
 280 Switch" have to be set properly in addition to the right "Capture
 281 Source" or "Input Source" selection.  Some devices have "Mic Boost"
 282 volume or switch.
 283
 284 When the PCM device is opened via "default" PCM (without pulse-audio
 285 plugin), you'll likely have "Digital Capture Volume" control as well.
 286 This is provided for the extra gain/attenuation of the signal in
 287 software, especially for the inputs without the hardware volume
 288 control such as digital microphones.  Unless really needed, this
 289 should be set to exactly 50%, corresponding to 0dB -- neither extra
 290 gain nor attenuation.  When you use "hw" PCM, i.e., a raw access PCM,
 291 this control will have no influence, though.
 292
 293 It's known that some codecs / devices have fairly bad analog circuits,
 294 and the recorded sound contains a certain DC-offset.  This is no bug
 295 of the driver.
 296
 297 Most of modern laptops have no analog CD-input connection.  Thus, the
 298 recording from CD input won't work in many cases although the driver
 299 provides it as the capture source.  Use CDDA instead.
 300
 301 The automatic switching of the built-in and external mic per plugging
 302 is implemented on some codec models but not on every model.  Partly
 303 because of my laziness but mostly lack of testers.  Feel free to
 304 submit the improvement patch to the author.
 305
 306
 307 Direct Debugging
 308 ----------------
 309 If no model option gives you a better result, and you are a tough guy
 310 to fight against evil, try debugging via hitting the raw HD-audio
 311 codec verbs to the device.  Some tools are available: hda-emu and
 312 hda-analyzer.  The detailed description is found in the sections
 313 below.  You'd need to enable hwdep for using these tools.  See "Kernel
 314 Configuration" section.
 315
 316
 317 Other Issues
 318 ============
 319
 320 Kernel Configuration
 321 --------------------
 322 In general, I recommend you to enable the sound debug option,
 323 ``CONFIG_SND_DEBUG=y``, no matter whether you are debugging or not.
 324 This enables snd_printd() macro and others, and you'll get additional
 325 kernel messages at probing.
 326
 327 In addition, you can enable ``CONFIG_SND_DEBUG_VERBOSE=y``.  But this
 328 will give you far more messages.  Thus turn this on only when you are
 329 sure to want it.
 330
 331 Don't forget to turn on the appropriate ``CONFIG_SND_HDA_CODEC_*``
 332 options.  Note that each of them corresponds to the codec chip, not
 333 the controller chip.  Thus, even if lspci shows the Nvidia controller,
 334 you may need to choose the option for other vendors.  If you are
 335 unsure, just select all yes.
 336
 337 ``CONFIG_SND_HDA_HWDEP`` is a useful option for debugging the driver.
 338 When this is enabled, the driver creates hardware-dependent devices
 339 (one per each codec), and you have a raw access to the device via
 340 these device files.  For example, ``hwC0D2`` will be created for the
 341 codec slot #2 of the first card (#0).  For debug-tools such as
 342 hda-verb and hda-analyzer, the hwdep device has to be enabled.
 343 Thus, it'd be better to turn this on always.
 344
 345 ``CONFIG_SND_HDA_RECONFIG`` is a new option, and this depends on the
 346 hwdep option above.  When enabled, you'll have some sysfs files under
 347 the corresponding hwdep directory.  See "HD-audio reconfiguration"
 348 section below.
 349
 350 ``CONFIG_SND_HDA_POWER_SAVE`` option enables the power-saving feature.
 351 See "Power-saving" section below.
 352
 353
 354 Codec Proc-File
 355 ---------------
 356 The codec proc-file is a treasure-chest for debugging HD-audio.
 357 It shows most of useful information of each codec widget.
 358
 359 The proc file is located in /proc/asound/card*/codec#*, one file per
 360 each codec slot.  You can know the codec vendor, product id and
 361 names, the type of each widget, capabilities and so on.
 362 This file, however, doesn't show the jack sensing state, so far.  This
 363 is because the jack-sensing might be depending on the trigger state.
 364
 365 This file will be picked up by the debug tools, and also it can be fed
 366 to the emulator as the primary codec information.  See the debug tools
 367 section below.
 368
 369 This proc file can be also used to check whether the generic parser is
 370 used.  When the generic parser is used, the vendor/product ID name
 371 will appear as "Realtek ID 0262", instead of "Realtek ALC262".
 372
 373
 374 HD-Audio Reconfiguration
 375 ------------------------
 376 This is an experimental feature to allow you re-configure the HD-audio
 377 codec dynamically without reloading the driver.  The following sysfs
 378 files are available under each codec-hwdep device directory (e.g.
 379 /sys/class/sound/hwC0D0):
 380
 381 vendor_id
 382     Shows the 32bit codec vendor-id hex number.  You can change the
 383     vendor-id value by writing to this file.
 384 subsystem_id
 385     Shows the 32bit codec subsystem-id hex number.  You can change the
 386     subsystem-id value by writing to this file.
 387 revision_id
 388     Shows the 32bit codec revision-id hex number.  You can change the
 389     revision-id value by writing to this file.
 390 afg
 391     Shows the AFG ID.  This is read-only.
 392 mfg
 393     Shows the MFG ID.  This is read-only.
 394 name
 395     Shows the codec name string.  Can be changed by writing to this
 396     file.
 397 modelname
 398     Shows the currently set ``model`` option.  Can be changed by writing
 399     to this file.
 400 init_verbs
 401     The extra verbs to execute at initialization.  You can add a verb by
 402     writing to this file.  Pass three numbers: nid, verb and parameter
 403     (separated with a space).
 404 hints
 405     Shows / stores hint strings for codec parsers for any use.
 406     Its format is ``key = value``.  For example, passing ``jack_detect = no``
 407     will disable the jack detection of the machine completely.
 408 init_pin_configs
 409     Shows the initial pin default config values set by BIOS.
 410 driver_pin_configs
 411     Shows the pin default values set by the codec parser explicitly.
 412     This doesn't show all pin values but only the changed values by
 413     the parser.  That is, if the parser doesn't change the pin default
 414     config values by itself, this will contain nothing.
 415 user_pin_configs
 416     Shows the pin default config values to override the BIOS setup.
 417     Writing this (with two numbers, NID and value) appends the new
 418     value.  The given will be used instead of the initial BIOS value at
 419     the next reconfiguration time.  Note that this config will override
 420     even the driver pin configs, too.
 421 reconfig
 422     Triggers the codec re-configuration.  When any value is written to
 423     this file, the driver re-initialize and parses the codec tree
 424     again.  All the changes done by the sysfs entries above are taken
 425     into account.
 426 clear
 427     Resets the codec, removes the mixer elements and PCM stuff of the
 428     specified codec, and clear all init verbs and hints.
 429
 430 For example, when you want to change the pin default configuration
 431 value of the pin widget 0x14 to 0x9993013f, and let the driver
 432 re-configure based on that state, run like below:
 433 ::
 434
 435     # echo 0x14 0x9993013f > /sys/class/sound/hwC0D0/user_pin_configs
 436     # echo 1 > /sys/class/sound/hwC0D0/reconfig
 437
 438
 439 Hint Strings
 440 ------------
 441 The codec parser have several switches and adjustment knobs for
 442 matching better with the actual codec or device behavior.  Many of
 443 them can be adjusted dynamically via "hints" strings as mentioned in
 444 the section above.  For example, by passing ``jack_detect = no`` string
 445 via sysfs or a patch file, you can disable the jack detection, thus
 446 the codec parser will skip the features like auto-mute or mic
 447 auto-switch.  As a boolean value, either ``yes``, ``no``, ``true``, ``false``,
 448 ``1`` or ``0`` can be passed.
 449
 450 The generic parser supports the following hints:
 451
 452 jack_detect (bool)
 453     specify whether the jack detection is available at all on this
 454     machine; default true
 455 inv_jack_detect (bool)
 456     indicates that the jack detection logic is inverted
 457 trigger_sense (bool)
 458     indicates that the jack detection needs the explicit call of
 459     AC_VERB_SET_PIN_SENSE verb
 460 inv_eapd (bool)
 461     indicates that the EAPD is implemented in the inverted logic
 462 pcm_format_first (bool)
 463     sets the PCM format before the stream tag and channel ID
 464 sticky_stream (bool)
 465     keep the PCM format, stream tag and ID as long as possible;
 466     default true
 467 spdif_status_reset (bool)
 468     reset the SPDIF status bits at each time the SPDIF stream is set
 469     up
 470 pin_amp_workaround (bool)
 471     the output pin may have multiple amp values
 472 single_adc_amp (bool)
 473     ADCs can have only single input amps
 474 auto_mute (bool)
 475     enable/disable the headphone auto-mute feature; default true
 476 auto_mic (bool)
 477     enable/disable the mic auto-switch feature; default true
 478 line_in_auto_switch (bool)
 479     enable/disable the line-in auto-switch feature; default false
 480 need_dac_fix (bool)
 481     limits the DACs depending on the channel count
 482 primary_hp (bool)
 483     probe headphone jacks as the primary outputs; default true
 484 multi_io (bool)
 485     try probing multi-I/O config (e.g. shared line-in/surround,
 486     mic/clfe jacks)
 487 multi_cap_vol (bool)
 488     provide multiple capture volumes
 489 inv_dmic_split (bool)
 490     provide split internal mic volume/switch for phase-inverted
 491     digital mics
 492 indep_hp (bool)
 493     provide the independent headphone PCM stream and the corresponding
 494     mixer control, if available
 495 add_stereo_mix_input (bool)
 496     add the stereo mix (analog-loopback mix) to the input mux if
 497     available
 498 add_jack_modes (bool)
 499     add "xxx Jack Mode" enum controls to each I/O jack for allowing to
 500     change the headphone amp and mic bias VREF capabilities
 501 power_save_node (bool)
 502     advanced power management for each widget, controlling the power
 503     sate (D0/D3) of each widget node depending on the actual pin and
 504     stream states
 505 power_down_unused (bool)
 506     power down the unused widgets, a subset of power_save_node, and
 507     will be dropped in future
 508 add_hp_mic (bool)
 509     add the headphone to capture source if possible
 510 hp_mic_detect (bool)
 511     enable/disable the hp/mic shared input for a single built-in mic
 512     case; default true
 513 vmaster (bool)
 514     enable/disable the virtual Master control; default true
 515 mixer_nid (int)
 516     specifies the widget NID of the analog-loopback mixer
 517
 518
 519 Early Patching
 520 --------------
 521 When ``CONFIG_SND_HDA_PATCH_LOADER=y`` is set, you can pass a "patch"
 522 as a firmware file for modifying the HD-audio setup before
 523 initializing the codec.  This can work basically like the
 524 reconfiguration via sysfs in the above, but it does it before the
 525 first codec configuration.
 526
 527 A patch file is a plain text file which looks like below:
 528
 529 ::
 530
 531     [codec]
 532     0x12345678 0xabcd1234 2
 533
 534     [model]
 535     auto
 536
 537     [pincfg]
 538     0x12 0x411111f0
 539
 540     [verb]
 541     0x20 0x500 0x03
 542     0x20 0x400 0xff
 543
 544     [hint]
 545     jack_detect = no
 546
 547
 548 The file needs to have a line ``[codec]``.  The next line should contain
 549 three numbers indicating the codec vendor-id (0x12345678 in the
 550 example), the codec subsystem-id (0xabcd1234) and the address (2) of
 551 the codec.  The rest patch entries are applied to this specified codec
 552 until another codec entry is given.  Passing 0 or a negative number to
 553 the first or the second value will make the check of the corresponding
 554 field be skipped.  It'll be useful for really broken devices that don't
 555 initialize SSID properly.
 556
 557 The ``[model]`` line allows to change the model name of the each codec.
 558 In the example above, it will be changed to model=auto.
 559 Note that this overrides the module option.
 560
 561 After the ``[pincfg]`` line, the contents are parsed as the initial
 562 default pin-configurations just like ``user_pin_configs`` sysfs above.
 563 The values can be shown in user_pin_configs sysfs file, too.
 564
 565 Similarly, the lines after ``[verb]`` are parsed as ``init_verbs``
 566 sysfs entries, and the lines after ``[hint]`` are parsed as ``hints``
 567 sysfs entries, respectively.
 568
 569 Another example to override the codec vendor id from 0x12345678 to
 570 0xdeadbeef is like below:
 571 ::
 572
 573     [codec]
 574     0x12345678 0xabcd1234 2
 575
 576     [vendor_id]
 577     0xdeadbeef
 578
 579
 580 In the similar way, you can override the codec subsystem_id via
 581 ``[subsystem_id]``, the revision id via ``[revision_id]`` line.
 582 Also, the codec chip name can be rewritten via ``[chip_name]`` line.
 583 ::
 584
 585     [codec]
 586     0x12345678 0xabcd1234 2
 587
 588     [subsystem_id]
 589     0xffff1111
 590
 591     [revision_id]
 592     0x10
 593
 594     [chip_name]
 595     My-own NEWS-0002
 596
 597
 598 The hd-audio driver reads the file via request_firmware().  Thus,
 599 a patch file has to be located on the appropriate firmware path,
 600 typically, /lib/firmware.  For example, when you pass the option
 601 ``patch=hda-init.fw``, the file /lib/firmware/hda-init.fw must be
 602 present.
 603
 604 The patch module option is specific to each card instance, and you
 605 need to give one file name for each instance, separated by commas.
 606 For example, if you have two cards, one for an on-board analog and one
 607 for an HDMI video board, you may pass patch option like below:
 608 ::
 609
 610     options snd-hda-intel patch=on-board-patch,hdmi-patch
 611
 612
 613 Power-Saving
 614 ------------
 615 The power-saving is a kind of auto-suspend of the device.  When the
 616 device is inactive for a certain time, the device is automatically
 617 turned off to save the power.  The time to go down is specified via
 618 ``power_save`` module option, and this option can be changed dynamically
 619 via sysfs.
 620
 621 The power-saving won't work when the analog loopback is enabled on
 622 some codecs.  Make sure that you mute all unneeded signal routes when
 623 you want the power-saving.
 624
 625 The power-saving feature might cause audible click noises at each
 626 power-down/up depending on the device.  Some of them might be
 627 solvable, but some are hard, I'm afraid.  Some distros such as
 628 openSUSE enables the power-saving feature automatically when the power
 629 cable is unplugged.  Thus, if you hear noises, suspect first the
 630 power-saving.  See /sys/module/snd_hda_intel/parameters/power_save to
 631 check the current value.  If it's non-zero, the feature is turned on.
 632
 633 The recent kernel supports the runtime PM for the HD-audio controller
 634 chip, too.  It means that the HD-audio controller is also powered up /
 635 down dynamically.  The feature is enabled only for certain controller
 636 chips like Intel LynxPoint.  You can enable/disable this feature
 637 forcibly by setting ``power_save_controller`` option, which is also
 638 available at /sys/module/snd_hda_intel/parameters directory.
 639
 640
 641 Tracepoints
 642 -----------
 643 The hd-audio driver gives a few basic tracepoints.
 644 ``hda:hda_send_cmd`` traces each CORB write while ``hda:hda_get_response``
 645 traces the response from RIRB (only when read from the codec driver).
 646 ``hda:hda_bus_reset`` traces the bus-reset due to fatal error, etc,
 647 ``hda:hda_unsol_event`` traces the unsolicited events, and
 648 ``hda:hda_power_down`` and ``hda:hda_power_up`` trace the power down/up
 649 via power-saving behavior.
 650
 651 Enabling all tracepoints can be done like
 652 ::
 653
 654     # echo 1 > /sys/kernel/debug/tracing/events/hda/enable
 655
 656 then after some commands, you can traces from
 657 /sys/kernel/debug/tracing/trace file.  For example, when you want to
 658 trace what codec command is sent, enable the tracepoint like:
 659 ::
 660
 661     # cat /sys/kernel/debug/tracing/trace
 662     # tracer: nop
 663     #
 664     #       TASK-PID    CPU#    TIMESTAMP  FUNCTION
 665     #          | |       |          |         |
 666            <...>-7807  [002] 105147.774889: hda_send_cmd: [0:0] val=e3a019
 667            <...>-7807  [002] 105147.774893: hda_send_cmd: [0:0] val=e39019
 668            <...>-7807  [002] 105147.999542: hda_send_cmd: [0:0] val=e3a01a
 669            <...>-7807  [002] 105147.999543: hda_send_cmd: [0:0] val=e3901a
 670            <...>-26764 [001] 349222.837143: hda_send_cmd: [0:0] val=e3a019
 671            <...>-26764 [001] 349222.837148: hda_send_cmd: [0:0] val=e39019
 672            <...>-26764 [001] 349223.058539: hda_send_cmd: [0:0] val=e3a01a
 673            <...>-26764 [001] 349223.058541: hda_send_cmd: [0:0] val=e3901a
 674
 675 Here ``[0:0]`` indicates the card number and the codec address, and
 676 ``val`` shows the value sent to the codec, respectively.  The value is
 677 a packed value, and you can decode it via hda-decode-verb program
 678 included in hda-emu package below.  For example, the value e3a019 is
 679 to set the left output-amp value to 25.
 680 ::
 681
 682     % hda-decode-verb 0xe3a019
 683     raw value = 0x00e3a019
 684     cid = 0, nid = 0x0e, verb = 0x3a0, parm = 0x19
 685     raw value: verb = 0x3a0, parm = 0x19
 686     verbname = set_amp_gain_mute
 687     amp raw val = 0xa019
 688     output, left, idx=0, mute=0, val=25
 689
 690
 691 Development Tree
 692 ----------------
 693 The latest development codes for HD-audio are found on sound git tree:
 694
 695 * git://git.kernel.org/pub/scm/linux/kernel/git/tiwai/sound.git
 696
 697 The master branch or for-next branches can be used as the main
 698 development branches in general while the development for the current
 699 and next kernels are found in for-linus and for-next branches,
 700 respectively.
 701
 702
 703 Sending a Bug Report
 704 --------------------
 705 If any model or module options don't work for your device, it's time
 706 to send a bug report to the developers.  Give the following in your
 707 bug report:
 708
 709 * Hardware vendor, product and model names
 710 * Kernel version (and ALSA-driver version if you built externally)
 711 * ``alsa-info.sh`` output; run with ``--no-upload`` option.  See the
 712   section below about alsa-info
 713
 714 If it's a regression, at best, send alsa-info outputs of both working
 715 and non-working kernels.  This is really helpful because we can
 716 compare the codec registers directly.
 717
 718 Send a bug report either the following:
 719
 720 kernel-bugzilla
 721     https://bugzilla.kernel.org/
 722 alsa-devel ML
 723     alsa-devel@alsa-project.org
 724
 725
 726 Debug Tools
 727 ===========
 728
 729 This section describes some tools available for debugging HD-audio
 730 problems.
 731
 732 alsa-info
 733 ---------
 734 The script ``alsa-info.sh`` is a very useful tool to gather the audio
 735 device information.  It's included in alsa-utils package.  The latest
 736 version can be found on git repository:
 737
 738 * git://git.alsa-project.org/alsa-utils.git
 739
 740 The script can be fetched directly from the following URL, too:
 741
 742 * https://www.alsa-project.org/alsa-info.sh
 743
 744 Run this script as root, and it will gather the important information
 745 such as the module lists, module parameters, proc file contents
 746 including the codec proc files, mixer outputs and the control
 747 elements.  As default, it will store the information onto a web server
 748 on alsa-project.org.  But, if you send a bug report, it'd be better to
 749 run with ``--no-upload`` option, and attach the generated file.
 750
 751 There are some other useful options.  See ``--help`` option output for
 752 details.
 753
 754 When a probe error occurs or when the driver obviously assigns a
 755 mismatched model, it'd be helpful to load the driver with
 756 ``probe_only=1`` option (at best after the cold reboot) and run
 757 alsa-info at this state.  With this option, the driver won't configure
 758 the mixer and PCM but just tries to probe the codec slot.  After
 759 probing, the proc file is available, so you can get the raw codec
 760 information before modified by the driver.  Of course, the driver
 761 isn't usable with ``probe_only=1``.  But you can continue the
 762 configuration via hwdep sysfs file if hda-reconfig option is enabled.
 763 Using ``probe_only`` mask 2 skips the reset of HDA codecs (use
 764 ``probe_only=3`` as module option). The hwdep interface can be used
 765 to determine the BIOS codec initialization.
 766
 767
 768 hda-verb
 769 --------
 770 hda-verb is a tiny program that allows you to access the HD-audio
 771 codec directly.  You can execute a raw HD-audio codec verb with this.
 772 This program accesses the hwdep device, thus you need to enable the
 773 kernel config ``CONFIG_SND_HDA_HWDEP=y`` beforehand.
 774
 775 The hda-verb program takes four arguments: the hwdep device file, the
 776 widget NID, the verb and the parameter.  When you access to the codec
 777 on the slot 2 of the card 0, pass /dev/snd/hwC0D2 to the first
 778 argument, typically.  (However, the real path name depends on the
 779 system.)
 780
 781 The second parameter is the widget number-id to access.  The third
 782 parameter can be either a hex/digit number or a string corresponding
 783 to a verb.  Similarly, the last parameter is the value to write, or
 784 can be a string for the parameter type.
 785
 786 ::
 787
 788     % hda-verb /dev/snd/hwC0D0 0x12 0x701 2
 789     nid = 0x12, verb = 0x701, param = 0x2
 790     value = 0x0
 791
 792     % hda-verb /dev/snd/hwC0D0 0x0 PARAMETERS VENDOR_ID
 793     nid = 0x0, verb = 0xf00, param = 0x0
 794     value = 0x10ec0262
 795
 796     % hda-verb /dev/snd/hwC0D0 2 set_a 0xb080
 797     nid = 0x2, verb = 0x300, param = 0xb080
 798     value = 0x0
 799
 800
 801 Although you can issue any verbs with this program, the driver state
 802 won't be always updated.  For example, the volume values are usually
 803 cached in the driver, and thus changing the widget amp value directly
 804 via hda-verb won't change the mixer value.
 805
 806 The hda-verb program is included now in alsa-tools:
 807
 808 * git://git.alsa-project.org/alsa-tools.git
 809
 810 Also, the old stand-alone package is found in the ftp directory:
 811
 812 * ftp://ftp.suse.com/pub/people/tiwai/misc/
 813
 814 Also a git repository is available:
 815
 816 * git://git.kernel.org/pub/scm/linux/kernel/git/tiwai/hda-verb.git
 817
 818 See README file in the tarball for more details about hda-verb
 819 program.
 820
 821
 822 hda-analyzer
 823 ------------
 824 hda-analyzer provides a graphical interface to access the raw HD-audio
 825 control, based on pyGTK2 binding.  It's a more powerful version of
 826 hda-verb.  The program gives you an easy-to-use GUI stuff for showing
 827 the widget information and adjusting the amp values, as well as the
 828 proc-compatible output.
 829
 830 The hda-analyzer:
 831
 832 * https://git.alsa-project.org/?p=alsa.git;a=tree;f=hda-analyzer
 833
 834 is a part of alsa.git repository in alsa-project.org:
 835
 836 * git://git.alsa-project.org/alsa.git
 837
 838 Codecgraph
 839 ----------
 840 Codecgraph is a utility program to generate a graph and visualizes the
 841 codec-node connection of a codec chip.  It's especially useful when
 842 you analyze or debug a codec without a proper datasheet.  The program
 843 parses the given codec proc file and converts to SVG via graphiz
 844 program.
 845
 846 The tarball and GIT trees are found in the web page at:
 847
 848 * http://helllabs.org/codecgraph/
 849
 850
 851 hda-emu
 852 -------
 853 hda-emu is an HD-audio emulator.  The main purpose of this program is
 854 to debug an HD-audio codec without the real hardware.  Thus, it
 855 doesn't emulate the behavior with the real audio I/O, but it just
 856 dumps the codec register changes and the ALSA-driver internal changes
 857 at probing and operating the HD-audio driver.
 858
 859 The program requires a codec proc-file to simulate.  Get a proc file
 860 for the target codec beforehand, or pick up an example codec from the
 861 codec proc collections in the tarball.  Then, run the program with the
 862 proc file, and the hda-emu program will start parsing the codec file
 863 and simulates the HD-audio driver:
 864
 865 ::
 866
 867     % hda-emu codecs/stac9200-dell-d820-laptop
 868     # Parsing..
 869     hda_codec: Unknown model for STAC9200, using BIOS defaults
 870     hda_codec: pin nid 08 bios pin config 40c003fa
 871     ....
 872
 873
 874 The program gives you only a very dumb command-line interface.  You
 875 can get a proc-file dump at the current state, get a list of control
 876 (mixer) elements, set/get the control element value, simulate the PCM
 877 operation, the jack plugging simulation, etc.
 878
 879 The program is found in the git repository below:
 880
 881 * git://git.kernel.org/pub/scm/linux/kernel/git/tiwai/hda-emu.git
 882
 883 See README file in the repository for more details about hda-emu
 884 program.
 885
 886
 887 hda-jack-retask
 888 ---------------
 889 hda-jack-retask is a user-friendly GUI program to manipulate the
 890 HD-audio pin control for jack retasking.  If you have a problem about
 891 the jack assignment, try this program and check whether you can get
 892 useful results.  Once when you figure out the proper pin assignment,
 893 it can be fixed either in the driver code statically or via passing a
 894 firmware patch file (see "Early Patching" section).
 895
 896 The program is included in alsa-tools now:
 897
 898 * git://git.alsa-project.org/alsa-tools.git