HD-Audio.txt 30 KB

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