1============================================================== 2Advanced Linux Sound Architecture - Driver Configuration guide 3============================================================== 4 5 6Kernel Configuration 7==================== 8 9To enable ALSA support you need at least to build the kernel with 10primary sound card support (``CONFIG_SOUND``). Since ALSA can emulate 11OSS, you don't have to choose any of the OSS modules. 12 13Enable "OSS API emulation" (``CONFIG_SND_OSSEMUL``) and both OSS mixer 14and PCM supports if you want to run OSS applications with ALSA. 15 16If you want to support the WaveTable functionality on cards such as 17SB Live! then you need to enable "Sequencer support" 18(``CONFIG_SND_SEQUENCER``). 19 20To make ALSA debug messages more verbose, enable the "Verbose printk" 21and "Debug" options. To check for memory leaks, turn on "Debug memory" 22too. "Debug detection" will add checks for the detection of cards. 23 24Please note that all the ALSA ISA drivers support the Linux isapnp API 25(if the card supports ISA PnP). You don't need to configure the cards 26using isapnptools. 27 28 29Module parameters 30================= 31 32The user can load modules with options. If the module supports more than 33one card and you have more than one card of the same type then you can 34specify multiple values for the option separated by commas. 35 36 37Module snd 38---------- 39 40The core ALSA module. It is used by all ALSA card drivers. 41It takes the following options which have global effects. 42 43major 44 major number for sound driver; 45 Default: 116 46cards_limit 47 limiting card index for auto-loading (1-8); 48 Default: 1; 49 For auto-loading more than one card, specify this option 50 together with snd-card-X aliases. 51slots 52 Reserve the slot index for the given driver; 53 This option takes multiple strings. 54 See `Module Autoloading Support`_ section for details. 55debug 56 Specifies the debug message level; 57 (0 = disable debug prints, 1 = normal debug messages, 58 2 = verbose debug messages); 59 This option appears only when ``CONFIG_SND_DEBUG=y``. 60 This option can be dynamically changed via sysfs 61 /sys/modules/snd/parameters/debug file. 62 63Module snd-pcm-oss 64------------------ 65 66The PCM OSS emulation module. 67This module takes options which change the mapping of devices. 68 69dsp_map 70 PCM device number maps assigned to the 1st OSS device; 71 Default: 0 72adsp_map 73 PCM device number maps assigned to the 2st OSS device; 74 Default: 1 75nonblock_open 76 Don't block opening busy PCM devices; 77 Default: 1 78 79For example, when ``dsp_map=2``, /dev/dsp will be mapped to PCM #2 of 80the card #0. Similarly, when ``adsp_map=0``, /dev/adsp will be mapped 81to PCM #0 of the card #0. 82For changing the second or later card, specify the option with 83commas, such like ``dsp_map=0,1``. 84 85``nonblock_open`` option is used to change the behavior of the PCM 86regarding opening the device. When this option is non-zero, 87opening a busy OSS PCM device won't be blocked but return 88immediately with EAGAIN (just like O_NONBLOCK flag). 89 90Module snd-rawmidi 91------------------ 92 93This module takes options which change the mapping of devices. 94similar to those of the snd-pcm-oss module. 95 96midi_map 97 MIDI device number maps assigned to the 1st OSS device; 98 Default: 0 99amidi_map 100 MIDI device number maps assigned to the 2st OSS device; 101 Default: 1 102 103Common parameters for top sound card modules 104-------------------------------------------- 105 106Each of top level sound card module takes the following options. 107 108index 109 index (slot #) of sound card; 110 Values: 0 through 31 or negative; 111 If nonnegative, assign that index number; 112 if negative, interpret as a bitmask of permissible indices; 113 the first free permitted index is assigned; 114 Default: -1 115id 116 card ID (identifier or name); 117 Can be up to 15 characters long; 118 Default: the card type; 119 A directory by this name is created under /proc/asound/ 120 containing information about the card; 121 This ID can be used instead of the index number in 122 identifying the card 123enable 124 enable card; 125 Default: enabled, for PCI and ISA PnP cards 126 127Module snd-adlib 128---------------- 129 130Module for AdLib FM cards. 131 132port 133 port # for OPL chip 134 135This module supports multiple cards. It does not support autoprobe, so 136the port must be specified. For actual AdLib FM cards it will be 0x388. 137Note that this card does not have PCM support and no mixer; only FM 138synthesis. 139 140Make sure you have ``sbiload`` from the alsa-tools package available and, 141after loading the module, find out the assigned ALSA sequencer port 142number through ``sbiload -l``. 143 144Example output: 145:: 146 147 Port Client name Port name 148 64:0 OPL2 FM synth OPL2 FM Port 149 150Load the ``std.sb`` and ``drums.sb`` patches also supplied by ``sbiload``: 151:: 152 153 sbiload -p 64:0 std.sb drums.sb 154 155If you use this driver to drive an OPL3, you can use ``std.o3`` and ``drums.o3`` 156instead. To have the card produce sound, use ``aplaymidi`` from alsa-utils: 157:: 158 159 aplaymidi -p 64:0 foo.mid 160 161Module snd-ad1816a 162------------------ 163 164Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips. 165 166clockfreq 167 Clock frequency for AD1816A chip (default = 0, 33000Hz) 168 169This module supports multiple cards, autoprobe and PnP. 170 171Module snd-ad1848 172----------------- 173 174Module for sound cards based on AD1848/AD1847/CS4248 ISA chips. 175 176port 177 port # for AD1848 chip 178irq 179 IRQ # for AD1848 chip 180dma1 181 DMA # for AD1848 chip (0,1,3) 182 183This module supports multiple cards. It does not support autoprobe 184thus main port must be specified!!! Other ports are optional. 185 186The power-management is supported. 187 188Module snd-ad1889 189----------------- 190 191Module for Analog Devices AD1889 chips. 192 193ac97_quirk 194 AC'97 workaround for strange hardware; 195 See the description of intel8x0 module for details. 196 197This module supports multiple cards. 198 199Module snd-ali5451 200------------------ 201 202Module for ALi M5451 PCI chip. 203 204pcm_channels 205 Number of hardware channels assigned for PCM 206spdif 207 Support SPDIF I/O; 208 Default: disabled 209 210This module supports one chip and autoprobe. 211 212The power-management is supported. 213 214Module snd-als100 215----------------- 216 217Module for sound cards based on Avance Logic ALS100/ALS120 ISA chips. 218 219This module supports multiple cards, autoprobe and PnP. 220 221The power-management is supported. 222 223Module snd-als300 224----------------- 225 226Module for Avance Logic ALS300 and ALS300+ 227 228This module supports multiple cards. 229 230The power-management is supported. 231 232Module snd-als4000 233------------------ 234 235Module for sound cards based on Avance Logic ALS4000 PCI chip. 236 237joystick_port 238 port # for legacy joystick support; 239 0 = disabled (default), 1 = auto-detect 240 241This module supports multiple cards, autoprobe and PnP. 242 243The power-management is supported. 244 245Module snd-asihpi 246----------------- 247 248Module for AudioScience ASI soundcards 249 250enable_hpi_hwdep 251 enable HPI hwdep for AudioScience soundcard 252 253This module supports multiple cards. 254The driver requires the firmware loader support on kernel. 255 256Module snd-atiixp 257----------------- 258 259Module for ATI IXP 150/200/250/400 AC97 controllers. 260 261ac97_clock 262 AC'97 clock (default = 48000) 263ac97_quirk 264 AC'97 workaround for strange hardware; 265 See `AC97 Quirk Option`_ section below. 266ac97_codec 267 Workaround to specify which AC'97 codec instead of probing. 268 If this works for you file a bug with your `lspci -vn` output. 269 (-2 = Force probing, -1 = Default behavior, 0-2 = Use the 270 specified codec.) 271spdif_aclink 272 S/PDIF transfer over AC-link (default = 1) 273 274This module supports one card and autoprobe. 275 276ATI IXP has two different methods to control SPDIF output. One is 277over AC-link and another is over the "direct" SPDIF output. The 278implementation depends on the motherboard, and you'll need to 279choose the correct one via spdif_aclink module option. 280 281The power-management is supported. 282 283Module snd-atiixp-modem 284----------------------- 285 286Module for ATI IXP 150/200/250 AC97 modem controllers. 287 288This module supports one card and autoprobe. 289 290Note: The default index value of this module is -2, i.e. the first 291slot is excluded. 292 293The power-management is supported. 294 295Module snd-au8810, snd-au8820, snd-au8830 296----------------------------------------- 297 298Module for Aureal Vortex, Vortex2 and Advantage device. 299 300pcifix 301 Control PCI workarounds; 302 0 = Disable all workarounds, 303 1 = Force the PCI latency of the Aureal card to 0xff, 304 2 = Force the Extend PCI#2 Internal Master for Efficient 305 Handling of Dummy Requests on the VIA KT133 AGP Bridge, 306 3 = Force both settings, 307 255 = Autodetect what is required (default) 308 309This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware 310EQ, mpu401, gameport. A3D and wavetable support are still in development. 311Development and reverse engineering work is being coordinated at 312https://savannah.nongnu.org/projects/openvortex/ 313SPDIF output has a copy of the AC97 codec output, unless you use the 314``spdif`` pcm device, which allows raw data passthru. 315The hardware EQ hardware and SPDIF is only present in the Vortex2 and 316Advantage. 317 318Note: Some ALSA mixer applications don't handle the SPDIF sample rate 319control correctly. If you have problems regarding this, try 320another ALSA compliant mixer (alsamixer works). 321 322Module snd-azt1605 323------------------ 324 325Module for Aztech Sound Galaxy soundcards based on the Aztech AZT1605 326chipset. 327 328port 329 port # for BASE (0x220,0x240,0x260,0x280) 330wss_port 331 port # for WSS (0x530,0x604,0xe80,0xf40) 332irq 333 IRQ # for WSS (7,9,10,11) 334dma1 335 DMA # for WSS playback (0,1,3) 336dma2 337 DMA # for WSS capture (0,1), -1 = disabled (default) 338mpu_port 339 port # for MPU-401 UART (0x300,0x330), -1 = disabled (default) 340mpu_irq 341 IRQ # for MPU-401 UART (3,5,7,9), -1 = disabled (default) 342fm_port 343 port # for OPL3 (0x388), -1 = disabled (default) 344 345This module supports multiple cards. It does not support autoprobe: 346``port``, ``wss_port``, ``irq`` and ``dma1`` have to be specified. 347The other values are optional. 348 349``port`` needs to match the BASE ADDRESS jumper on the card (0x220 or 0x240) 350or the value stored in the card's EEPROM for cards that have an EEPROM and 351their "CONFIG MODE" jumper set to "EEPROM SETTING". The other values can 352be chosen freely from the options enumerated above. 353 354If ``dma2`` is specified and different from ``dma1``, the card will operate in 355full-duplex mode. When ``dma1=3``, only ``dma2=0`` is valid and the only way to 356enable capture since only channels 0 and 1 are available for capture. 357 358Generic settings are ``port=0x220 wss_port=0x530 irq=10 dma1=1 dma2=0 359mpu_port=0x330 mpu_irq=9 fm_port=0x388``. 360 361Whatever IRQ and DMA channels you pick, be sure to reserve them for 362legacy ISA in your BIOS. 363 364Module snd-azt2316 365------------------ 366 367Module for Aztech Sound Galaxy soundcards based on the Aztech AZT2316 368chipset. 369 370port 371 port # for BASE (0x220,0x240,0x260,0x280) 372wss_port 373 port # for WSS (0x530,0x604,0xe80,0xf40) 374irq 375 IRQ # for WSS (7,9,10,11) 376dma1 377 DMA # for WSS playback (0,1,3) 378dma2 379 DMA # for WSS capture (0,1), -1 = disabled (default) 380mpu_port 381 port # for MPU-401 UART (0x300,0x330), -1 = disabled (default) 382mpu_irq 383 IRQ # for MPU-401 UART (5,7,9,10), -1 = disabled (default) 384fm_port 385 port # for OPL3 (0x388), -1 = disabled (default) 386 387This module supports multiple cards. It does not support autoprobe: 388``port``, ``wss_port``, ``irq`` and ``dma1`` have to be specified. 389The other values are optional. 390 391``port`` needs to match the BASE ADDRESS jumper on the card (0x220 or 0x240) 392or the value stored in the card's EEPROM for cards that have an EEPROM and 393their "CONFIG MODE" jumper set to "EEPROM SETTING". The other values can 394be chosen freely from the options enumerated above. 395 396If ``dma2`` is specified and different from ``dma1``, the card will operate in 397full-duplex mode. When ``dma1=3``, only ``dma2=0`` is valid and the only way to 398enable capture since only channels 0 and 1 are available for capture. 399 400Generic settings are ``port=0x220 wss_port=0x530 irq=10 dma1=1 dma2=0 401mpu_port=0x330 mpu_irq=9 fm_port=0x388``. 402 403Whatever IRQ and DMA channels you pick, be sure to reserve them for 404legacy ISA in your BIOS. 405 406Module snd-aw2 407-------------- 408 409Module for Audiowerk2 sound card 410 411This module supports multiple cards. 412 413Module snd-azt2320 414------------------ 415 416Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only). 417 418This module supports multiple cards, PnP and autoprobe. 419 420The power-management is supported. 421 422Module snd-azt3328 423------------------ 424 425Module for sound cards based on Aztech AZF3328 PCI chip. 426 427joystick 428 Enable joystick (default off) 429 430This module supports multiple cards. 431 432Module snd-bt87x 433---------------- 434 435Module for video cards based on Bt87x chips. 436 437digital_rate 438 Override the default digital rate (Hz) 439load_all 440 Load the driver even if the card model isn't known 441 442This module supports multiple cards. 443 444Note: The default index value of this module is -2, i.e. the first 445slot is excluded. 446 447Module snd-ca0106 448----------------- 449 450Module for Creative Audigy LS and SB Live 24bit 451 452This module supports multiple cards. 453 454 455Module snd-cmi8330 456------------------ 457 458Module for sound cards based on C-Media CMI8330 ISA chips. 459 460isapnp 461 ISA PnP detection - 0 = disable, 1 = enable (default) 462 463with ``isapnp=0``, the following options are available: 464 465wssport 466 port # for CMI8330 chip (WSS) 467wssirq 468 IRQ # for CMI8330 chip (WSS) 469wssdma 470 first DMA # for CMI8330 chip (WSS) 471sbport 472 port # for CMI8330 chip (SB16) 473sbirq 474 IRQ # for CMI8330 chip (SB16) 475sbdma8 476 8bit DMA # for CMI8330 chip (SB16) 477sbdma16 478 16bit DMA # for CMI8330 chip (SB16) 479fmport 480 (optional) OPL3 I/O port 481mpuport 482 (optional) MPU401 I/O port 483mpuirq 484 (optional) MPU401 irq # 485 486This module supports multiple cards and autoprobe. 487 488The power-management is supported. 489 490Module snd-cmipci 491----------------- 492 493Module for C-Media CMI8338/8738/8768/8770 PCI sound cards. 494 495mpu_port 496 port address of MIDI interface (8338 only): 497 0x300,0x310,0x320,0x330 = legacy port, 498 1 = integrated PCI port (default on 8738), 499 0 = disable 500fm_port 501 port address of OPL-3 FM synthesizer (8x38 only): 502 0x388 = legacy port, 503 1 = integrated PCI port (default on 8738), 504 0 = disable 505soft_ac3 506 Software-conversion of raw SPDIF packets (model 033 only) (default = 1) 507joystick_port 508 Joystick port address (0 = disable, 1 = auto-detect) 509 510This module supports autoprobe and multiple cards. 511 512The power-management is supported. 513 514Module snd-cs4231 515----------------- 516 517Module for sound cards based on CS4231 ISA chips. 518 519port 520 port # for CS4231 chip 521mpu_port 522 port # for MPU-401 UART (optional), -1 = disable 523irq 524 IRQ # for CS4231 chip 525mpu_irq 526 IRQ # for MPU-401 UART 527dma1 528 first DMA # for CS4231 chip 529dma2 530 second DMA # for CS4231 chip 531 532This module supports multiple cards. This module does not support autoprobe 533thus main port must be specified!!! Other ports are optional. 534 535The power-management is supported. 536 537Module snd-cs4236 538----------------- 539 540Module for sound cards based on CS4232/CS4232A, 541CS4235/CS4236/CS4236B/CS4237B/CS4238B/CS4239 ISA chips. 542 543isapnp 544 ISA PnP detection - 0 = disable, 1 = enable (default) 545 546with ``isapnp=0``, the following options are available: 547 548port 549 port # for CS4236 chip (PnP setup - 0x534) 550cport 551 control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00) 552mpu_port 553 port # for MPU-401 UART (PnP setup - 0x300), -1 = disable 554fm_port 555 FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable 556irq 557 IRQ # for CS4236 chip (5,7,9,11,12,15) 558mpu_irq 559 IRQ # for MPU-401 UART (9,11,12,15) 560dma1 561 first DMA # for CS4236 chip (0,1,3) 562dma2 563 second DMA # for CS4236 chip (0,1,3), -1 = disable 564 565This module supports multiple cards. This module does not support autoprobe 566(if ISA PnP is not used) thus main port and control port must be 567specified!!! Other ports are optional. 568 569The power-management is supported. 570 571This module is aliased as snd-cs4232 since it provides the old 572snd-cs4232 functionality, too. 573 574Module snd-cs4281 575----------------- 576 577Module for Cirrus Logic CS4281 soundchip. 578 579dual_codec 580 Secondary codec ID (0 = disable, default) 581 582This module supports multiple cards. 583 584The power-management is supported. 585 586Module snd-cs46xx 587----------------- 588 589Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/ 590CS4624/CS4630/CS4280 PCI chips. 591 592external_amp 593 Force to enable external amplifier. 594thinkpad 595 Force to enable Thinkpad's CLKRUN control. 596mmap_valid 597 Support OSS mmap mode (default = 0). 598 599This module supports multiple cards and autoprobe. 600Usually external amp and CLKRUN controls are detected automatically 601from PCI sub vendor/device ids. If they don't work, give the options 602above explicitly. 603 604The power-management is supported. 605 606Module snd-cs5530 607----------------- 608 609Module for Cyrix/NatSemi Geode 5530 chip. 610 611Module snd-cs5535audio 612---------------------- 613 614Module for multifunction CS5535 companion PCI device 615 616The power-management is supported. 617 618Module snd-ctxfi 619---------------- 620 621Module for Creative Sound Blaster X-Fi boards (20k1 / 20k2 chips) 622 623* Creative Sound Blaster X-Fi Titanium Fatal1ty Champion Series 624* Creative Sound Blaster X-Fi Titanium Fatal1ty Professional Series 625* Creative Sound Blaster X-Fi Titanium Professional Audio 626* Creative Sound Blaster X-Fi Titanium 627* Creative Sound Blaster X-Fi Elite Pro 628* Creative Sound Blaster X-Fi Platinum 629* Creative Sound Blaster X-Fi Fatal1ty 630* Creative Sound Blaster X-Fi XtremeGamer 631* Creative Sound Blaster X-Fi XtremeMusic 632 633reference_rate 634 reference sample rate, 44100 or 48000 (default) 635multiple 636 multiple to ref. sample rate, 1 or 2 (default) 637subsystem 638 override the PCI SSID for probing; 639 the value consists of SSVID << 16 | SSDID. 640 The default is zero, which means no override. 641 642This module supports multiple cards. 643 644Module snd-darla20 645------------------ 646 647Module for Echoaudio Darla20 648 649This module supports multiple cards. 650The driver requires the firmware loader support on kernel. 651 652Module snd-darla24 653------------------ 654 655Module for Echoaudio Darla24 656 657This module supports multiple cards. 658The driver requires the firmware loader support on kernel. 659 660Module snd-dt019x 661----------------- 662 663Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP 664only) 665 666This module supports multiple cards. This module is enabled only with 667ISA PnP support. 668 669The power-management is supported. 670 671Module snd-dummy 672---------------- 673 674Module for the dummy sound card. This "card" doesn't do any output 675or input, but you may use this module for any application which 676requires a sound card (like RealPlayer). 677 678pcm_devs 679 Number of PCM devices assigned to each card (default = 1, up to 4) 680pcm_substreams 681 Number of PCM substreams assigned to each PCM (default = 8, up to 128) 682hrtimer 683 Use hrtimer (=1, default) or system timer (=0) 684fake_buffer 685 Fake buffer allocations (default = 1) 686 687When multiple PCM devices are created, snd-dummy gives different 688behavior to each PCM device: 689* 0 = interleaved with mmap support 690* 1 = non-interleaved with mmap support 691* 2 = interleaved without mmap 692* 3 = non-interleaved without mmap 693 694As default, snd-dummy drivers doesn't allocate the real buffers 695but either ignores read/write or mmap a single dummy page to all 696buffer pages, in order to save the resources. If your apps need 697the read/ written buffer data to be consistent, pass fake_buffer=0 698option. 699 700The power-management is supported. 701 702Module snd-echo3g 703----------------- 704 705Module for Echoaudio 3G cards (Gina3G/Layla3G) 706 707This module supports multiple cards. 708The driver requires the firmware loader support on kernel. 709 710Module snd-emu10k1 711------------------ 712 713Module for EMU10K1/EMU10k2 based PCI sound cards. 714 715* Sound Blaster Live! 716* Sound Blaster PCI 512 717* Emu APS (partially supported) 718* Sound Blaster Audigy 719 720extin 721 bitmap of available external inputs for FX8010 (see bellow) 722extout 723 bitmap of available external outputs for FX8010 (see bellow) 724seq_ports 725 allocated sequencer ports (4 by default) 726max_synth_voices 727 limit of voices used for wavetable (64 by default) 728max_buffer_size 729 specifies the maximum size of wavetable/pcm buffers given in MB 730 unit. Default value is 128. 731enable_ir 732 enable IR 733 734This module supports multiple cards and autoprobe. 735 736Input & Output configurations [extin/extout] 737* Creative Card wo/Digital out [0x0003/0x1f03] 738* Creative Card w/Digital out [0x0003/0x1f0f] 739* Creative Card w/Digital CD in [0x000f/0x1f0f] 740* Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3] 741* Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf] 742* Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf] 743* Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f] 744* Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f] 745* Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f] 746* Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff] 747* Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff] 748* Creative Card all ins and outs [0x3fff/0x7fff] 749 750The power-management is supported. 751 752Module snd-emu10k1x 753------------------- 754 755Module for Creative Emu10k1X (SB Live Dell OEM version) 756 757This module supports multiple cards. 758 759Module snd-ens1370 760------------------ 761 762Module for Ensoniq AudioPCI ES1370 PCI sound cards. 763 764* SoundBlaster PCI 64 765* SoundBlaster PCI 128 766 767joystick 768 Enable joystick (default off) 769 770This module supports multiple cards and autoprobe. 771 772The power-management is supported. 773 774Module snd-ens1371 775------------------ 776 777Module for Ensoniq AudioPCI ES1371 PCI sound cards. 778 779* SoundBlaster PCI 64 780* SoundBlaster PCI 128 781* SoundBlaster Vibra PCI 782 783joystick_port 784 port # for joystick (0x200,0x208,0x210,0x218), 0 = disable 785 (default), 1 = auto-detect 786 787This module supports multiple cards and autoprobe. 788 789The power-management is supported. 790 791Module snd-es1688 792----------------- 793 794Module for ESS AudioDrive ES-1688 and ES-688 sound cards. 795 796isapnp 797 ISA PnP detection - 0 = disable, 1 = enable (default) 798mpu_port 799 port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default) 800mpu_irq 801 IRQ # for MPU-401 port (5,7,9,10) 802fm_port 803 port # for OPL3 (option; share the same port as default) 804 805with ``isapnp=0``, the following additional options are available: 806 807port 808 port # for ES-1688 chip (0x220,0x240,0x260) 809irq 810 IRQ # for ES-1688 chip (5,7,9,10) 811dma8 812 DMA # for ES-1688 chip (0,1,3) 813 814This module supports multiple cards and autoprobe (without MPU-401 port) 815and PnP with the ES968 chip. 816 817Module snd-es18xx 818----------------- 819 820Module for ESS AudioDrive ES-18xx sound cards. 821 822isapnp 823 ISA PnP detection - 0 = disable, 1 = enable (default) 824 825with ``isapnp=0``, the following options are available: 826 827port 828 port # for ES-18xx chip (0x220,0x240,0x260) 829mpu_port 830 port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default) 831fm_port 832 port # for FM (optional, not used) 833irq 834 IRQ # for ES-18xx chip (5,7,9,10) 835dma1 836 first DMA # for ES-18xx chip (0,1,3) 837dma2 838 first DMA # for ES-18xx chip (0,1,3) 839 840This module supports multiple cards, ISA PnP and autoprobe (without MPU-401 841port if native ISA PnP routines are not used). 842When ``dma2`` is equal with ``dma1``, the driver works as half-duplex. 843 844The power-management is supported. 845 846Module snd-es1938 847----------------- 848 849Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips. 850 851This module supports multiple cards and autoprobe. 852 853The power-management is supported. 854 855Module snd-es1968 856----------------- 857 858Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips. 859 860total_bufsize 861 total buffer size in kB (1-4096kB) 862pcm_substreams_p 863 playback channels (1-8, default=2) 864pcm_substreams_c 865 capture channels (1-8, default=0) 866clock 867 clock (0 = auto-detection) 868use_pm 869 support the power-management (0 = off, 1 = on, 2 = auto (default)) 870enable_mpu 871 enable MPU401 (0 = off, 1 = on, 2 = auto (default)) 872joystick 873 enable joystick (default off) 874 875This module supports multiple cards and autoprobe. 876 877The power-management is supported. 878 879Module snd-fm801 880---------------- 881 882Module for ForteMedia FM801 based PCI sound cards. 883 884tea575x_tuner 885 Enable TEA575x tuner; 886 1 = MediaForte 256-PCS, 887 2 = MediaForte 256-PCPR, 888 3 = MediaForte 64-PCR 889 High 16-bits are video (radio) device number + 1; 890 example: 0x10002 (MediaForte 256-PCPR, device 1) 891 892This module supports multiple cards and autoprobe. 893 894The power-management is supported. 895 896Module snd-gina20 897----------------- 898 899Module for Echoaudio Gina20 900 901This module supports multiple cards. 902The driver requires the firmware loader support on kernel. 903 904Module snd-gina24 905----------------- 906 907Module for Echoaudio Gina24 908 909This module supports multiple cards. 910The driver requires the firmware loader support on kernel. 911 912Module snd-gusclassic 913--------------------- 914 915Module for Gravis UltraSound Classic sound card. 916 917port 918 port # for GF1 chip (0x220,0x230,0x240,0x250,0x260) 919irq 920 IRQ # for GF1 chip (3,5,9,11,12,15) 921dma1 922 DMA # for GF1 chip (1,3,5,6,7) 923dma2 924 DMA # for GF1 chip (1,3,5,6,7,-1=disable) 925joystick_dac 926 0 to 31, (0.59V-4.52V or 0.389V-2.98V) 927voices 928 GF1 voices limit (14-32) 929pcm_voices 930 reserved PCM voices 931 932This module supports multiple cards and autoprobe. 933 934Module snd-gusextreme 935--------------------- 936 937Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card. 938 939port 940 port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260) 941gf1_port 942 port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270) 943mpu_port 944 port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable 945irq 946 IRQ # for ES-1688 chip (5,7,9,10) 947gf1_irq 948 IRQ # for GF1 chip (3,5,9,11,12,15) 949mpu_irq 950 IRQ # for MPU-401 port (5,7,9,10) 951dma8 952 DMA # for ES-1688 chip (0,1,3) 953dma1 954 DMA # for GF1 chip (1,3,5,6,7) 955joystick_dac 956 0 to 31, (0.59V-4.52V or 0.389V-2.98V) 957voices 958 GF1 voices limit (14-32) 959pcm_voices 960 reserved PCM voices 961 962This module supports multiple cards and autoprobe (without MPU-401 port). 963 964Module snd-gusmax 965----------------- 966 967Module for Gravis UltraSound MAX sound card. 968 969port 970 port # for GF1 chip (0x220,0x230,0x240,0x250,0x260) 971irq 972 IRQ # for GF1 chip (3,5,9,11,12,15) 973dma1 974 DMA # for GF1 chip (1,3,5,6,7) 975dma2 976 DMA # for GF1 chip (1,3,5,6,7,-1=disable) 977joystick_dac 978 0 to 31, (0.59V-4.52V or 0.389V-2.98V) 979voices 980 GF1 voices limit (14-32) 981pcm_voices 982 reserved PCM voices 983 984This module supports multiple cards and autoprobe. 985 986Module snd-hda-intel 987-------------------- 988 989Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8, ICH9, ICH10, 990PCH, SCH), ATI SB450, SB600, R600, RS600, RS690, RS780, RV610, RV620, 991RV630, RV635, RV670, RV770, VIA VT8251/VT8237A, SIS966, ULI M5461 992 993[Multiple options for each card instance] 994 995model 996 force the model name 997position_fix 998 Fix DMA pointer; 999 -1 = system default: choose appropriate one per controller hardware, 1000 0 = auto: falls back to LPIB when POSBUF doesn't work, 1001 1 = use LPIB, 1002 2 = POSBUF: use position buffer, 1003 3 = VIACOMBO: VIA-specific workaround for capture, 1004 4 = COMBO: use LPIB for playback, auto for capture stream 1005 5 = SKL+: apply the delay calculation available on recent Intel chips 1006 6 = FIFO: correct the position with the fixed FIFO size, for recent AMD chips 1007probe_mask 1008 Bitmask to probe codecs (default = -1, meaning all slots); 1009 When the bit 8 (0x100) is set, the lower 8 bits are used 1010 as the "fixed" codec slots; i.e. the driver probes the 1011 slots regardless what hardware reports back 1012probe_only 1013 Only probing and no codec initialization (default=off); 1014 Useful to check the initial codec status for debugging 1015bdl_pos_adj 1016 Specifies the DMA IRQ timing delay in samples. 1017 Passing -1 will make the driver to choose the appropriate 1018 value based on the controller chip. 1019patch 1020 Specifies the early "patch" files to modify the HD-audio setup 1021 before initializing the codecs. 1022 This option is available only when ``CONFIG_SND_HDA_PATCH_LOADER=y`` 1023 is set. See hd-audio/notes.rst for details. 1024beep_mode 1025 Selects the beep registration mode (0=off, 1=on); 1026 default value is set via ``CONFIG_SND_HDA_INPUT_BEEP_MODE`` kconfig. 1027 1028[Single (global) options] 1029 1030single_cmd 1031 Use single immediate commands to communicate with codecs 1032 (for debugging only) 1033enable_msi 1034 Enable Message Signaled Interrupt (MSI) (default = off) 1035power_save 1036 Automatic power-saving timeout (in second, 0 = disable) 1037power_save_controller 1038 Reset HD-audio controller in power-saving mode (default = on) 1039align_buffer_size 1040 Force rounding of buffer/period sizes to multiples of 128 bytes. 1041 This is more efficient in terms of memory access but isn't 1042 required by the HDA spec and prevents users from specifying 1043 exact period/buffer sizes. (default = on) 1044snoop 1045 Enable/disable snooping (default = on) 1046 1047This module supports multiple cards and autoprobe. 1048 1049See hd-audio/notes.rst for more details about HD-audio driver. 1050 1051Each codec may have a model table for different configurations. 1052If your machine isn't listed there, the default (usually minimal) 1053configuration is set up. You can pass ``model=<name>`` option to 1054specify a certain model in such a case. There are different 1055models depending on the codec chip. The list of available models 1056is found in hd-audio/models.rst. 1057 1058The model name ``generic`` is treated as a special case. When this 1059model is given, the driver uses the generic codec parser without 1060"codec-patch". It's sometimes good for testing and debugging. 1061 1062The model option can be used also for aliasing to another PCI or codec 1063SSID. When it's passed in the form of ``model=XXXX:YYYY`` where XXXX 1064and YYYY are the sub-vendor and sub-device IDs in hex numbers, 1065respectively, the driver will refer to that SSID as a reference to the 1066quirk table. 1067 1068If the default configuration doesn't work and one of the above 1069matches with your device, report it together with alsa-info.sh 1070output (with ``--no-upload`` option) to kernel bugzilla or alsa-devel 1071ML (see the section `Links and Addresses`_). 1072 1073``power_save`` and ``power_save_controller`` options are for power-saving 1074mode. See powersave.rst for details. 1075 1076Note 2: If you get click noises on output, try the module option 1077``position_fix=1`` or ``2``. ``position_fix=1`` will use the SD_LPIB 1078register value without FIFO size correction as the current 1079DMA pointer. ``position_fix=2`` will make the driver to use 1080the position buffer instead of reading SD_LPIB register. 1081(Usually SD_LPIB register is more accurate than the 1082position buffer.) 1083 1084``position_fix=3`` is specific to VIA devices. The position 1085of the capture stream is checked from both LPIB and POSBUF 1086values. ``position_fix=4`` is a combination mode, using LPIB 1087for playback and POSBUF for capture. 1088 1089NB: If you get many ``azx_get_response timeout`` messages at 1090loading, it's likely a problem of interrupts (e.g. ACPI irq 1091routing). Try to boot with options like ``pci=noacpi``. Also, you 1092can try ``single_cmd=1`` module option. This will switch the 1093communication method between HDA controller and codecs to the 1094single immediate commands instead of CORB/RIRB. Basically, the 1095single command mode is provided only for BIOS, and you won't get 1096unsolicited events, too. But, at least, this works independently 1097from the irq. Remember this is a last resort, and should be 1098avoided as much as possible... 1099 1100MORE NOTES ON ``azx_get_response timeout`` PROBLEMS: 1101On some hardware, you may need to add a proper probe_mask option 1102to avoid the ``azx_get_response timeout`` problem above, instead. 1103This occurs when the access to non-existing or non-working codec slot 1104(likely a modem one) causes a stall of the communication via HD-audio 1105bus. You can see which codec slots are probed by enabling 1106``CONFIG_SND_DEBUG_VERBOSE``, or simply from the file name of the codec 1107proc files. Then limit the slots to probe by probe_mask option. 1108For example, ``probe_mask=1`` means to probe only the first slot, and 1109``probe_mask=4`` means only the third slot. 1110 1111The power-management is supported. 1112 1113Module snd-hdsp 1114--------------- 1115 1116Module for RME Hammerfall DSP audio interface(s) 1117 1118This module supports multiple cards. 1119 1120Note: The firmware data can be automatically loaded via hotplug 1121when ``CONFIG_FW_LOADER`` is set. Otherwise, you need to load 1122the firmware via hdsploader utility included in alsa-tools 1123package. 1124The firmware data is found in alsa-firmware package. 1125 1126Note: snd-page-alloc module does the job which snd-hammerfall-mem 1127module did formerly. It will allocate the buffers in advance 1128when any HDSP cards are found. To make the buffer 1129allocation sure, load snd-page-alloc module in the early 1130stage of boot sequence. See `Early Buffer Allocation`_ 1131section. 1132 1133Module snd-hdspm 1134---------------- 1135 1136Module for RME HDSP MADI board. 1137 1138precise_ptr 1139 Enable precise pointer, or disable. 1140line_outs_monitor 1141 Send playback streams to analog outs by default. 1142enable_monitor 1143 Enable Analog Out on Channel 63/64 by default. 1144 1145See hdspm.rst for details. 1146 1147Module snd-ice1712 1148------------------ 1149 1150Module for Envy24 (ICE1712) based PCI sound cards. 1151 1152* MidiMan M Audio Delta 1010 1153* MidiMan M Audio Delta 1010LT 1154* MidiMan M Audio Delta DiO 2496 1155* MidiMan M Audio Delta 66 1156* MidiMan M Audio Delta 44 1157* MidiMan M Audio Delta 410 1158* MidiMan M Audio Audiophile 2496 1159* TerraTec EWS 88MT 1160* TerraTec EWS 88D 1161* TerraTec EWX 24/96 1162* TerraTec DMX 6Fire 1163* TerraTec Phase 88 1164* Hoontech SoundTrack DSP 24 1165* Hoontech SoundTrack DSP 24 Value 1166* Hoontech SoundTrack DSP 24 Media 7.1 1167* Event Electronics, EZ8 1168* Digigram VX442 1169* Lionstracs, Mediastaton 1170* Terrasoniq TS 88 1171 1172model 1173 Use the given board model, one of the following: 1174 delta1010, dio2496, delta66, delta44, audiophile, delta410, 1175 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d, 1176 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8, 1177 phase88, mediastation 1178omni 1179 Omni I/O support for MidiMan M-Audio Delta44/66 1180cs8427_timeout 1181 reset timeout for the CS8427 chip (S/PDIF transceiver) in msec 1182 resolution, default value is 500 (0.5 sec) 1183 1184This module supports multiple cards and autoprobe. 1185Note: The consumer part is not used with all Envy24 based cards (for 1186example in the MidiMan Delta siree). 1187 1188Note: The supported board is detected by reading EEPROM or PCI 1189SSID (if EEPROM isn't available). You can override the 1190model by passing ``model`` module option in case that the 1191driver isn't configured properly or you want to try another 1192type for testing. 1193 1194Module snd-ice1724 1195------------------ 1196 1197Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards. 1198 1199* MidiMan M Audio Revolution 5.1 1200* MidiMan M Audio Revolution 7.1 1201* MidiMan M Audio Audiophile 192 1202* AMP Ltd AUDIO2000 1203* TerraTec Aureon 5.1 Sky 1204* TerraTec Aureon 7.1 Space 1205* TerraTec Aureon 7.1 Universe 1206* TerraTec Phase 22 1207* TerraTec Phase 28 1208* AudioTrak Prodigy 7.1 1209* AudioTrak Prodigy 7.1 LT 1210* AudioTrak Prodigy 7.1 XT 1211* AudioTrak Prodigy 7.1 HIFI 1212* AudioTrak Prodigy 7.1 HD2 1213* AudioTrak Prodigy 192 1214* Pontis MS300 1215* Albatron K8X800 Pro II 1216* Chaintech ZNF3-150 1217* Chaintech ZNF3-250 1218* Chaintech 9CJS 1219* Chaintech AV-710 1220* Shuttle SN25P 1221* Onkyo SE-90PCI 1222* Onkyo SE-200PCI 1223* ESI Juli@ 1224* ESI Maya44 1225* Hercules Fortissimo IV 1226* EGO-SYS WaveTerminal 192M 1227 1228model 1229 Use the given board model, one of the following: 1230 revo51, revo71, amp2000, prodigy71, prodigy71lt, 1231 prodigy71xt, prodigy71hifi, prodigyhd2, prodigy192, 1232 juli, aureon51, aureon71, universe, ap192, k8x800, 1233 phase22, phase28, ms300, av710, se200pci, se90pci, 1234 fortissimo4, sn25p, WT192M, maya44 1235 1236This module supports multiple cards and autoprobe. 1237 1238Note: The supported board is detected by reading EEPROM or PCI 1239SSID (if EEPROM isn't available). You can override the 1240model by passing ``model`` module option in case that the 1241driver isn't configured properly or you want to try another 1242type for testing. 1243 1244Module snd-indigo 1245----------------- 1246 1247Module for Echoaudio Indigo 1248 1249This module supports multiple cards. 1250The driver requires the firmware loader support on kernel. 1251 1252Module snd-indigodj 1253------------------- 1254 1255Module for Echoaudio Indigo DJ 1256 1257This module supports multiple cards. 1258The driver requires the firmware loader support on kernel. 1259 1260Module snd-indigoio 1261------------------- 1262 1263Module for Echoaudio Indigo IO 1264 1265This module supports multiple cards. 1266The driver requires the firmware loader support on kernel. 1267 1268Module snd-intel8x0 1269------------------- 1270 1271Module for AC'97 motherboards from Intel and compatibles. 1272 1273* Intel i810/810E, i815, i820, i830, i84x, MX440 ICH5, ICH6, ICH7, 1274 6300ESB, ESB2 1275* SiS 7012 (SiS 735) 1276* NVidia NForce, NForce2, NForce3, MCP04, CK804 CK8, CK8S, MCP501 1277* AMD AMD768, AMD8111 1278* ALi m5455 1279 1280ac97_clock 1281 AC'97 codec clock base (0 = auto-detect) 1282ac97_quirk 1283 AC'97 workaround for strange hardware; 1284 See `AC97 Quirk Option`_ section below. 1285buggy_irq 1286 Enable workaround for buggy interrupts on some motherboards 1287 (default yes on nForce chips, otherwise off) 1288buggy_semaphore 1289 Enable workaround for hardware with buggy semaphores (e.g. on some 1290 ASUS laptops) (default off) 1291spdif_aclink 1292 Use S/PDIF over AC-link instead of direct connection from the 1293 controller chip (0 = off, 1 = on, -1 = default) 1294 1295This module supports one chip and autoprobe. 1296 1297Note: the latest driver supports auto-detection of chip clock. 1298if you still encounter too fast playback, specify the clock 1299explicitly via the module option ``ac97_clock=41194``. 1300 1301Joystick/MIDI ports are not supported by this driver. If your 1302motherboard has these devices, use the ns558 or snd-mpu401 1303modules, respectively. 1304 1305The power-management is supported. 1306 1307Module snd-intel8x0m 1308-------------------- 1309 1310Module for Intel ICH (i8x0) chipset MC97 modems. 1311 1312* Intel i810/810E, i815, i820, i830, i84x, MX440 ICH5, ICH6, ICH7 1313* SiS 7013 (SiS 735) 1314* NVidia NForce, NForce2, NForce2s, NForce3 1315* AMD AMD8111 1316* ALi m5455 1317 1318ac97_clock 1319 AC'97 codec clock base (0 = auto-detect) 1320 1321This module supports one card and autoprobe. 1322 1323Note: The default index value of this module is -2, i.e. the first 1324slot is excluded. 1325 1326The power-management is supported. 1327 1328Module snd-interwave 1329-------------------- 1330 1331Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32 1332and other sound cards based on AMD InterWave (tm) chip. 1333 1334joystick_dac 1335 0 to 31, (0.59V-4.52V or 0.389V-2.98V) 1336midi 1337 1 = MIDI UART enable, 0 = MIDI UART disable (default) 1338pcm_voices 1339 reserved PCM voices for the synthesizer (default 2) 1340effect 1341 1 = InterWave effects enable (default 0); requires 8 voices 1342isapnp 1343 ISA PnP detection - 0 = disable, 1 = enable (default) 1344 1345with ``isapnp=0``, the following options are available: 1346 1347port 1348 port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260) 1349irq 1350 IRQ # for InterWave chip (3,5,9,11,12,15) 1351dma1 1352 DMA # for InterWave chip (0,1,3,5,6,7) 1353dma2 1354 DMA # for InterWave chip (0,1,3,5,6,7,-1=disable) 1355 1356This module supports multiple cards, autoprobe and ISA PnP. 1357 1358Module snd-interwave-stb 1359------------------------ 1360 1361Module for UltraSound 32-Pro (sound card from STB used by Compaq) 1362and other sound cards based on AMD InterWave (tm) chip with TEA6330T 1363circuit for extended control of bass, treble and master volume. 1364 1365joystick_dac 1366 0 to 31, (0.59V-4.52V or 0.389V-2.98V) 1367midi 1368 1 = MIDI UART enable, 0 = MIDI UART disable (default) 1369pcm_voices 1370 reserved PCM voices for the synthesizer (default 2) 1371effect 1372 1 = InterWave effects enable (default 0); requires 8 voices 1373isapnp 1374 ISA PnP detection - 0 = disable, 1 = enable (default) 1375 1376with ``isapnp=0``, the following options are available: 1377 1378port 1379 port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260) 1380port_tc 1381 tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380) 1382irq 1383 IRQ # for InterWave chip (3,5,9,11,12,15) 1384dma1 1385 DMA # for InterWave chip (0,1,3,5,6,7) 1386dma2 1387 DMA # for InterWave chip (0,1,3,5,6,7,-1=disable) 1388 1389This module supports multiple cards, autoprobe and ISA PnP. 1390 1391Module snd-jazz16 1392------------------- 1393 1394Module for Media Vision Jazz16 chipset. The chipset consists of 3 chips: 1395MVD1216 + MVA416 + MVA514. 1396 1397port 1398 port # for SB DSP chip (0x210,0x220,0x230,0x240,0x250,0x260) 1399irq 1400 IRQ # for SB DSP chip (3,5,7,9,10,15) 1401dma8 1402 DMA # for SB DSP chip (1,3) 1403dma16 1404 DMA # for SB DSP chip (5,7) 1405mpu_port 1406 MPU-401 port # (0x300,0x310,0x320,0x330) 1407mpu_irq 1408 MPU-401 irq # (2,3,5,7) 1409 1410This module supports multiple cards. 1411 1412Module snd-korg1212 1413------------------- 1414 1415Module for Korg 1212 IO PCI card 1416 1417This module supports multiple cards. 1418 1419Module snd-layla20 1420------------------ 1421 1422Module for Echoaudio Layla20 1423 1424This module supports multiple cards. 1425The driver requires the firmware loader support on kernel. 1426 1427Module snd-layla24 1428------------------ 1429 1430Module for Echoaudio Layla24 1431 1432This module supports multiple cards. 1433The driver requires the firmware loader support on kernel. 1434 1435Module snd-lola 1436--------------- 1437 1438Module for Digigram Lola PCI-e boards 1439 1440This module supports multiple cards. 1441 1442Module snd-lx6464es 1443------------------- 1444 1445Module for Digigram LX6464ES boards 1446 1447This module supports multiple cards. 1448 1449Module snd-maestro3 1450------------------- 1451 1452Module for Allegro/Maestro3 chips 1453 1454external_amp 1455 enable external amp (enabled by default) 1456amp_gpio 1457 GPIO pin number for external amp (0-15) or -1 for default pin (8 1458 for allegro, 1 for others) 1459 1460This module supports autoprobe and multiple chips. 1461 1462Note: the binding of amplifier is dependent on hardware. 1463If there is no sound even though all channels are unmuted, try to 1464specify other gpio connection via amp_gpio option. 1465For example, a Panasonic notebook might need ``amp_gpio=0x0d`` 1466option. 1467 1468The power-management is supported. 1469 1470Module snd-mia 1471--------------- 1472 1473Module for Echoaudio Mia 1474 1475This module supports multiple cards. 1476The driver requires the firmware loader support on kernel. 1477 1478Module snd-miro 1479--------------- 1480 1481Module for Miro soundcards: miroSOUND PCM 1 pro, miroSOUND PCM 12, 1482miroSOUND PCM 20 Radio. 1483 1484port 1485 Port # (0x530,0x604,0xe80,0xf40) 1486irq 1487 IRQ # (5,7,9,10,11) 1488dma1 1489 1st dma # (0,1,3) 1490dma2 1491 2nd dma # (0,1) 1492mpu_port 1493 MPU-401 port # (0x300,0x310,0x320,0x330) 1494mpu_irq 1495 MPU-401 irq # (5,7,9,10) 1496fm_port 1497 FM Port # (0x388) 1498wss 1499 enable WSS mode 1500ide 1501 enable onboard ide support 1502 1503Module snd-mixart 1504----------------- 1505 1506Module for Digigram miXart8 sound cards. 1507 1508This module supports multiple cards. 1509Note: One miXart8 board will be represented as 4 alsa cards. 1510See Documentation/sound/cards/mixart.rst for details. 1511 1512When the driver is compiled as a module and the hotplug firmware 1513is supported, the firmware data is loaded via hotplug automatically. 1514Install the necessary firmware files in alsa-firmware package. 1515When no hotplug fw loader is available, you need to load the 1516firmware via mixartloader utility in alsa-tools package. 1517 1518Module snd-mona 1519--------------- 1520 1521Module for Echoaudio Mona 1522 1523This module supports multiple cards. 1524The driver requires the firmware loader support on kernel. 1525 1526Module snd-mpu401 1527----------------- 1528 1529Module for MPU-401 UART devices. 1530 1531port 1532 port number or -1 (disable) 1533irq 1534 IRQ number or -1 (disable) 1535pnp 1536 PnP detection - 0 = disable, 1 = enable (default) 1537 1538This module supports multiple devices and PnP. 1539 1540Module snd-msnd-classic 1541----------------------- 1542 1543Module for Turtle Beach MultiSound Classic, Tahiti or Monterey 1544soundcards. 1545 1546io 1547 Port # for msnd-classic card 1548irq 1549 IRQ # for msnd-classic card 1550mem 1551 Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000, 0xe0000 or 0xe8000) 1552write_ndelay 1553 enable write ndelay (default = 1) 1554calibrate_signal 1555 calibrate signal (default = 0) 1556isapnp 1557 ISA PnP detection - 0 = disable, 1 = enable (default) 1558digital 1559 Digital daughterboard present (default = 0) 1560cfg 1561 Config port (0x250, 0x260 or 0x270) default = PnP 1562reset 1563 Reset all devices 1564mpu_io 1565 MPU401 I/O port 1566mpu_irq 1567 MPU401 irq# 1568ide_io0 1569 IDE port #0 1570ide_io1 1571 IDE port #1 1572ide_irq 1573 IDE irq# 1574joystick_io 1575 Joystick I/O port 1576 1577The driver requires firmware files ``turtlebeach/msndinit.bin`` and 1578``turtlebeach/msndperm.bin`` in the proper firmware directory. 1579 1580See Documentation/sound/cards/multisound.sh for important information 1581about this driver. Note that it has been discontinued, but the 1582Voyetra Turtle Beach knowledge base entry for it is still available 1583at 1584https://www.turtlebeach.com 1585 1586Module snd-msnd-pinnacle 1587------------------------ 1588 1589Module for Turtle Beach MultiSound Pinnacle/Fiji soundcards. 1590 1591io 1592 Port # for pinnacle/fiji card 1593irq 1594 IRQ # for pinnalce/fiji card 1595mem 1596 Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000, 0xe0000 or 0xe8000) 1597write_ndelay 1598 enable write ndelay (default = 1) 1599calibrate_signal 1600 calibrate signal (default = 0) 1601isapnp 1602 ISA PnP detection - 0 = disable, 1 = enable (default) 1603 1604The driver requires firmware files ``turtlebeach/pndspini.bin`` and 1605``turtlebeach/pndsperm.bin`` in the proper firmware directory. 1606 1607Module snd-mtpav 1608---------------- 1609 1610Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel 1611port). 1612 1613port 1614 I/O port # for MTPAV (0x378,0x278, default=0x378) 1615irq 1616 IRQ # for MTPAV (7,5, default=7) 1617hwports 1618 number of supported hardware ports, default=8. 1619 1620Module supports only 1 card. This module has no enable option. 1621 1622Module snd-mts64 1623---------------- 1624 1625Module for Ego Systems (ESI) Miditerminal 4140 1626 1627This module supports multiple devices. 1628Requires parport (``CONFIG_PARPORT``). 1629 1630Module snd-nm256 1631---------------- 1632 1633Module for NeoMagic NM256AV/ZX chips 1634 1635playback_bufsize 1636 max playback frame size in kB (4-128kB) 1637capture_bufsize 1638 max capture frame size in kB (4-128kB) 1639force_ac97 1640 0 or 1 (disabled by default) 1641buffer_top 1642 specify buffer top address 1643use_cache 1644 0 or 1 (disabled by default) 1645vaio_hack 1646 alias buffer_top=0x25a800 1647reset_workaround 1648 enable AC97 RESET workaround for some laptops 1649reset_workaround2 1650 enable extended AC97 RESET workaround for some other laptops 1651 1652This module supports one chip and autoprobe. 1653 1654The power-management is supported. 1655 1656Note: on some notebooks the buffer address cannot be detected 1657automatically, or causes hang-up during initialization. 1658In such a case, specify the buffer top address explicitly via 1659the buffer_top option. 1660For example, 1661Sony F250: buffer_top=0x25a800 1662Sony F270: buffer_top=0x272800 1663The driver supports only ac97 codec. It's possible to force 1664to initialize/use ac97 although it's not detected. In such a 1665case, use ``force_ac97=1`` option - but *NO* guarantee whether it 1666works! 1667 1668Note: The NM256 chip can be linked internally with non-AC97 1669codecs. This driver supports only the AC97 codec, and won't work 1670with machines with other (most likely CS423x or OPL3SAx) chips, 1671even though the device is detected in lspci. In such a case, try 1672other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP 1673but some doesn't have ISA PnP. You'll need to specify ``isapnp=0`` 1674and proper hardware parameters in the case without ISA PnP. 1675 1676Note: some laptops need a workaround for AC97 RESET. For the 1677known hardware like Dell Latitude LS and Sony PCG-F305, this 1678workaround is enabled automatically. For other laptops with a 1679hard freeze, you can try ``reset_workaround=1`` option. 1680 1681Note: Dell Latitude CSx laptops have another problem regarding 1682AC97 RESET. On these laptops, reset_workaround2 option is 1683turned on as default. This option is worth to try if the 1684previous reset_workaround option doesn't help. 1685 1686Note: This driver is really crappy. It's a porting from the 1687OSS driver, which is a result of black-magic reverse engineering. 1688The detection of codec will fail if the driver is loaded *after* 1689X-server as described above. You might be able to force to load 1690the module, but it may result in hang-up. Hence, make sure that 1691you load this module *before* X if you encounter this kind of 1692problem. 1693 1694Module snd-opl3sa2 1695------------------ 1696 1697Module for Yamaha OPL3-SA2/SA3 sound cards. 1698 1699isapnp 1700 ISA PnP detection - 0 = disable, 1 = enable (default) 1701 1702with ``isapnp=0``, the following options are available: 1703 1704port 1705 control port # for OPL3-SA chip (0x370) 1706sb_port 1707 SB port # for OPL3-SA chip (0x220,0x240) 1708wss_port 1709 WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604) 1710midi_port 1711 port # for MPU-401 UART (0x300,0x330), -1 = disable 1712fm_port 1713 FM port # for OPL3-SA chip (0x388), -1 = disable 1714irq 1715 IRQ # for OPL3-SA chip (5,7,9,10) 1716dma1 1717 first DMA # for Yamaha OPL3-SA chip (0,1,3) 1718dma2 1719 second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable 1720 1721This module supports multiple cards and ISA PnP. It does not support 1722autoprobe (if ISA PnP is not used) thus all ports must be specified!!! 1723 1724The power-management is supported. 1725 1726Module snd-opti92x-ad1848 1727------------------------- 1728 1729Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips. 1730Module works with OAK Mozart cards as well. 1731 1732isapnp 1733 ISA PnP detection - 0 = disable, 1 = enable (default) 1734 1735with ``isapnp=0``, the following options are available: 1736 1737port 1738 port # for WSS chip (0x530,0xe80,0xf40,0x604) 1739mpu_port 1740 port # for MPU-401 UART (0x300,0x310,0x320,0x330) 1741fm_port 1742 port # for OPL3 device (0x388) 1743irq 1744 IRQ # for WSS chip (5,7,9,10,11) 1745mpu_irq 1746 IRQ # for MPU-401 UART (5,7,9,10) 1747dma1 1748 first DMA # for WSS chip (0,1,3) 1749 1750This module supports only one card, autoprobe and PnP. 1751 1752Module snd-opti92x-cs4231 1753------------------------- 1754 1755Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips. 1756 1757isapnp 1758 ISA PnP detection - 0 = disable, 1 = enable (default) 1759 1760with ``isapnp=0``, the following options are available: 1761 1762port 1763 port # for WSS chip (0x530,0xe80,0xf40,0x604) 1764mpu_port 1765 port # for MPU-401 UART (0x300,0x310,0x320,0x330) 1766fm_port 1767 port # for OPL3 device (0x388) 1768irq 1769 IRQ # for WSS chip (5,7,9,10,11) 1770mpu_irq 1771 IRQ # for MPU-401 UART (5,7,9,10) 1772dma1 1773 first DMA # for WSS chip (0,1,3) 1774dma2 1775 second DMA # for WSS chip (0,1,3) 1776 1777This module supports only one card, autoprobe and PnP. 1778 1779Module snd-opti93x 1780------------------ 1781 1782Module for sound cards based on OPTi 82c93x chips. 1783 1784isapnp 1785 ISA PnP detection - 0 = disable, 1 = enable (default) 1786 1787with ``isapnp=0``, the following options are available: 1788 1789port 1790 port # for WSS chip (0x530,0xe80,0xf40,0x604) 1791mpu_port 1792 port # for MPU-401 UART (0x300,0x310,0x320,0x330) 1793fm_port 1794 port # for OPL3 device (0x388) 1795irq 1796 IRQ # for WSS chip (5,7,9,10,11) 1797mpu_irq 1798 IRQ # for MPU-401 UART (5,7,9,10) 1799dma1 1800 first DMA # for WSS chip (0,1,3) 1801dma2 1802 second DMA # for WSS chip (0,1,3) 1803 1804This module supports only one card, autoprobe and PnP. 1805 1806Module snd-oxygen 1807----------------- 1808 1809Module for sound cards based on the C-Media CMI8786/8787/8788 chip: 1810 1811* Asound A-8788 1812* Asus Xonar DG/DGX 1813* AuzenTech X-Meridian 1814* AuzenTech X-Meridian 2G 1815* Bgears b-Enspirer 1816* Club3D Theatron DTS 1817* HT-Omega Claro (plus) 1818* HT-Omega Claro halo (XT) 1819* Kuroutoshikou CMI8787-HG2PCI 1820* Razer Barracuda AC-1 1821* Sondigo Inferno 1822* TempoTec HiFier Fantasia 1823* TempoTec HiFier Serenade 1824 1825This module supports autoprobe and multiple cards. 1826 1827Module snd-pcsp 1828--------------- 1829 1830Module for internal PC-Speaker. 1831 1832nopcm 1833 Disable PC-Speaker PCM sound. Only beeps remain. 1834nforce_wa 1835 enable NForce chipset workaround. Expect bad sound. 1836 1837This module supports system beeps, some kind of PCM playback and 1838even a few mixer controls. 1839 1840Module snd-pcxhr 1841---------------- 1842 1843Module for Digigram PCXHR boards 1844 1845This module supports multiple cards. 1846 1847Module snd-portman2x4 1848--------------------- 1849 1850Module for Midiman Portman 2x4 parallel port MIDI interface 1851 1852This module supports multiple cards. 1853 1854Module snd-powermac (on ppc only) 1855--------------------------------- 1856 1857Module for PowerMac, iMac and iBook on-board soundchips 1858 1859enable_beep 1860 enable beep using PCM (enabled as default) 1861 1862Module supports autoprobe a chip. 1863 1864Note: the driver may have problems regarding endianness. 1865 1866The power-management is supported. 1867 1868Module snd-pxa2xx-ac97 (on arm only) 1869------------------------------------ 1870 1871Module for AC97 driver for the Intel PXA2xx chip 1872 1873For ARM architecture only. 1874 1875The power-management is supported. 1876 1877Module snd-riptide 1878------------------ 1879 1880Module for Conexant Riptide chip 1881 1882joystick_port 1883 Joystick port # (default: 0x200) 1884mpu_port 1885 MPU401 port # (default: 0x330) 1886opl3_port 1887 OPL3 port # (default: 0x388) 1888 1889This module supports multiple cards. 1890The driver requires the firmware loader support on kernel. 1891You need to install the firmware file ``riptide.hex`` to the standard 1892firmware path (e.g. /lib/firmware). 1893 1894Module snd-rme32 1895---------------- 1896 1897Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32, 1898Prodif96 and Prodif Gold) sound cards. 1899 1900This module supports multiple cards. 1901 1902Module snd-rme96 1903---------------- 1904 1905Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards. 1906 1907This module supports multiple cards. 1908 1909Module snd-rme9652 1910------------------ 1911 1912Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards. 1913 1914precise_ptr 1915 Enable precise pointer (doesn't work reliably). (default = 0) 1916 1917This module supports multiple cards. 1918 1919Note: snd-page-alloc module does the job which snd-hammerfall-mem 1920module did formerly. It will allocate the buffers in advance 1921when any RME9652 cards are found. To make the buffer 1922allocation sure, load snd-page-alloc module in the early 1923stage of boot sequence. See `Early Buffer Allocation`_ 1924section. 1925 1926Module snd-sa11xx-uda1341 (on arm only) 1927--------------------------------------- 1928 1929Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card. 1930 1931Module supports only one card. 1932Module has no enable and index options. 1933 1934The power-management is supported. 1935 1936Module snd-sb8 1937-------------- 1938 1939Module for 8-bit SoundBlaster cards: SoundBlaster 1.0, SoundBlaster 2.0, 1940SoundBlaster Pro 1941 1942port 1943 port # for SB DSP chip (0x220,0x240,0x260) 1944irq 1945 IRQ # for SB DSP chip (5,7,9,10) 1946dma8 1947 DMA # for SB DSP chip (1,3) 1948 1949This module supports multiple cards and autoprobe. 1950 1951The power-management is supported. 1952 1953Module snd-sb16 and snd-sbawe 1954----------------------------- 1955 1956Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP), 1957SoundBlaster AWE 32 (PnP), SoundBlaster AWE 64 PnP 1958 1959mic_agc 1960 Mic Auto-Gain-Control - 0 = disable, 1 = enable (default) 1961csp 1962 ASP/CSP chip support - 0 = disable (default), 1 = enable 1963isapnp 1964 ISA PnP detection - 0 = disable, 1 = enable (default) 1965 1966with isapnp=0, the following options are available: 1967 1968port 1969 port # for SB DSP 4.x chip (0x220,0x240,0x260) 1970mpu_port 1971 port # for MPU-401 UART (0x300,0x330), -1 = disable 1972awe_port 1973 base port # for EMU8000 synthesizer (0x620,0x640,0x660) (snd-sbawe 1974 module only) 1975irq 1976 IRQ # for SB DSP 4.x chip (5,7,9,10) 1977dma8 1978 8-bit DMA # for SB DSP 4.x chip (0,1,3) 1979dma16 1980 16-bit DMA # for SB DSP 4.x chip (5,6,7) 1981 1982This module supports multiple cards, autoprobe and ISA PnP. 1983 1984Note: To use Vibra16X cards in 16-bit half duplex mode, you must 1985disable 16bit DMA with dma16 = -1 module parameter. 1986Also, all Sound Blaster 16 type cards can operate in 16-bit 1987half duplex mode through 8-bit DMA channel by disabling their 198816-bit DMA channel. 1989 1990The power-management is supported. 1991 1992Module snd-sc6000 1993----------------- 1994 1995Module for Gallant SC-6000 soundcard and later models: SC-6600 and 1996SC-7000. 1997 1998port 1999 Port # (0x220 or 0x240) 2000mss_port 2001 MSS Port # (0x530 or 0xe80) 2002irq 2003 IRQ # (5,7,9,10,11) 2004mpu_irq 2005 MPU-401 IRQ # (5,7,9,10) ,0 - no MPU-401 irq 2006dma 2007 DMA # (1,3,0) 2008joystick 2009 Enable gameport - 0 = disable (default), 1 = enable 2010 2011This module supports multiple cards. 2012 2013This card is also known as Audio Excel DSP 16 or Zoltrix AV302. 2014 2015Module snd-sscape 2016----------------- 2017 2018Module for ENSONIQ SoundScape cards. 2019 2020port 2021 Port # (PnP setup) 2022wss_port 2023 WSS Port # (PnP setup) 2024irq 2025 IRQ # (PnP setup) 2026mpu_irq 2027 MPU-401 IRQ # (PnP setup) 2028dma 2029 DMA # (PnP setup) 2030dma2 2031 2nd DMA # (PnP setup, -1 to disable) 2032joystick 2033 Enable gameport - 0 = disable (default), 1 = enable 2034 2035This module supports multiple cards. 2036 2037The driver requires the firmware loader support on kernel. 2038 2039Module snd-sun-amd7930 (on sparc only) 2040-------------------------------------- 2041 2042Module for AMD7930 sound chips found on Sparcs. 2043 2044This module supports multiple cards. 2045 2046Module snd-sun-cs4231 (on sparc only) 2047------------------------------------- 2048 2049Module for CS4231 sound chips found on Sparcs. 2050 2051This module supports multiple cards. 2052 2053Module snd-sun-dbri (on sparc only) 2054----------------------------------- 2055 2056Module for DBRI sound chips found on Sparcs. 2057 2058This module supports multiple cards. 2059 2060Module snd-wavefront 2061-------------------- 2062 2063Module for Turtle Beach Maui, Tropez and Tropez+ sound cards. 2064 2065use_cs4232_midi 2066 Use CS4232 MPU-401 interface 2067 (inaccessibly located inside your computer) 2068isapnp 2069 ISA PnP detection - 0 = disable, 1 = enable (default) 2070 2071with isapnp=0, the following options are available: 2072 2073cs4232_pcm_port 2074 Port # for CS4232 PCM interface. 2075cs4232_pcm_irq 2076 IRQ # for CS4232 PCM interface (5,7,9,11,12,15). 2077cs4232_mpu_port 2078 Port # for CS4232 MPU-401 interface. 2079cs4232_mpu_irq 2080 IRQ # for CS4232 MPU-401 interface (9,11,12,15). 2081ics2115_port 2082 Port # for ICS2115 2083ics2115_irq 2084 IRQ # for ICS2115 2085fm_port 2086 FM OPL-3 Port # 2087dma1 2088 DMA1 # for CS4232 PCM interface. 2089dma2 2090 DMA2 # for CS4232 PCM interface. 2091 2092The below are options for wavefront_synth features: 2093 2094wf_raw 2095 Assume that we need to boot the OS (default:no); 2096 If yes, then during driver loading, the state of the board is 2097 ignored, and we reset the board and load the firmware anyway. 2098fx_raw 2099 Assume that the FX process needs help (default:yes); 2100 If false, we'll leave the FX processor in whatever state it is 2101 when the driver is loaded. The default is to download the 2102 microprogram and associated coefficients to set it up for 2103 "default" operation, whatever that means. 2104debug_default 2105 Debug parameters for card initialization 2106wait_usecs 2107 How long to wait without sleeping, usecs (default:150); 2108 This magic number seems to give pretty optimal throughput 2109 based on my limited experimentation. 2110 If you want to play around with it and find a better value, be 2111 my guest. Remember, the idea is to get a number that causes us 2112 to just busy wait for as many WaveFront commands as possible, 2113 without coming up with a number so large that we hog the whole 2114 CPU. 2115 Specifically, with this number, out of about 134,000 status 2116 waits, only about 250 result in a sleep. 2117sleep_interval 2118 How long to sleep when waiting for reply (default: 100) 2119sleep_tries 2120 How many times to try sleeping during a wait (default: 50) 2121ospath 2122 Pathname to processed ICS2115 OS firmware (default:wavefront.os); 2123 The path name of the ISC2115 OS firmware. In the recent 2124 version, it's handled via firmware loader framework, so it 2125 must be installed in the proper path, typically, 2126 /lib/firmware. 2127reset_time 2128 How long to wait for a reset to take effect (default:2) 2129ramcheck_time 2130 How many seconds to wait for the RAM test (default:20) 2131osrun_time 2132 How many seconds to wait for the ICS2115 OS (default:10) 2133 2134This module supports multiple cards and ISA PnP. 2135 2136Note: the firmware file ``wavefront.os`` was located in the earlier 2137version in /etc. Now it's loaded via firmware loader, and 2138must be in the proper firmware path, such as /lib/firmware. 2139Copy (or symlink) the file appropriately if you get an error 2140regarding firmware downloading after upgrading the kernel. 2141 2142Module snd-sonicvibes 2143--------------------- 2144 2145Module for S3 SonicVibes PCI sound cards. 2146* PINE Schubert 32 PCI 2147 2148reverb 2149 Reverb Enable - 1 = enable, 0 = disable (default); 2150 SoundCard must have onboard SRAM for this. 2151mge 2152 Mic Gain Enable - 1 = enable, 0 = disable (default) 2153 2154This module supports multiple cards and autoprobe. 2155 2156Module snd-serial-u16550 2157------------------------ 2158 2159Module for UART16550A serial MIDI ports. 2160 2161port 2162 port # for UART16550A chip 2163irq 2164 IRQ # for UART16550A chip, -1 = poll mode 2165speed 2166 speed in bauds (9600,19200,38400,57600,115200) 2167 38400 = default 2168base 2169 base for divisor in bauds (57600,115200,230400,460800) 2170 115200 = default 2171outs 2172 number of MIDI ports in a serial port (1-4) 2173 1 = default 2174adaptor 2175 Type of adaptor. 2176 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A, 2177 3 = MS-124W M/B, 4 = Generic 2178 2179This module supports multiple cards. This module does not support autoprobe 2180thus the main port must be specified!!! Other options are optional. 2181 2182Module snd-trident 2183------------------ 2184 2185Module for Trident 4DWave DX/NX sound cards. 2186* Best Union Miss Melody 4DWave PCI 2187* HIS 4DWave PCI 2188* Warpspeed ONSpeed 4DWave PCI 2189* AzTech PCI 64-Q3D 2190* Addonics SV 750 2191* CHIC True Sound 4Dwave 2192* Shark Predator4D-PCI 2193* Jaton SonicWave 4D 2194* SiS SI7018 PCI Audio 2195* Hoontech SoundTrack Digital 4DWave NX 2196 2197pcm_channels 2198 max channels (voices) reserved for PCM 2199wavetable_size 2200 max wavetable size in kB (4-?kb) 2201 2202This module supports multiple cards and autoprobe. 2203 2204The power-management is supported. 2205 2206Module snd-ua101 2207---------------- 2208 2209Module for the Edirol UA-101/UA-1000 audio/MIDI interfaces. 2210 2211This module supports multiple devices, autoprobe and hotplugging. 2212 2213Module snd-usb-audio 2214-------------------- 2215 2216Module for USB audio and USB MIDI devices. 2217 2218vid 2219 Vendor ID for the device (optional) 2220pid 2221 Product ID for the device (optional) 2222nrpacks 2223 Max. number of packets per URB (default: 8) 2224device_setup 2225 Device specific magic number (optional); 2226 Influence depends on the device 2227 Default: 0x0000 2228ignore_ctl_error 2229 Ignore any USB-controller regarding mixer interface (default: no) 2230autoclock 2231 Enable auto-clock selection for UAC2 devices (default: yes) 2232quirk_alias 2233 Quirk alias list, pass strings like ``0123abcd:5678beef``, which 2234 applies the existing quirk for the device 5678:beef to a new 2235 device 0123:abcd. 2236implicit_fb 2237 Apply the generic implicit feedback sync mode. When this is set 2238 and the playback stream sync mode is ASYNC, the driver tries to 2239 tie an adjacent ASYNC capture stream as the implicit feedback 2240 source. 2241use_vmalloc 2242 Use vmalloc() for allocations of the PCM buffers (default: yes). 2243 For architectures with non-coherent memory like ARM or MIPS, the 2244 mmap access may give inconsistent results with vmalloc'ed 2245 buffers. If mmap is used on such architectures, turn off this 2246 option, so that the DMA-coherent buffers are allocated and used 2247 instead. 2248delayed_register 2249 The option is needed for devices that have multiple streams 2250 defined in multiple USB interfaces. The driver may invoke 2251 registrations multiple times (once per interface) and this may 2252 lead to the insufficient device enumeration. 2253 This option receives an array of strings, and you can pass 2254 ID:INTERFACE like ``0123abcd:4`` for performing the delayed 2255 registration to the given device. In this example, when a USB 2256 device 0123:abcd is probed, the driver waits the registration 2257 until the USB interface 4 gets probed. 2258 The driver prints a message like "Found post-registration device 2259 assignment: 1234abcd:04" for such a device, so that user can 2260 notice the need. 2261quirk_flags 2262 Contains the bit flags for various device specific workarounds. 2263 Applied to the corresponding card index. 2264 2265 * bit 0: Skip reading sample rate for devices 2266 * bit 1: Create Media Controller API entries 2267 * bit 2: Allow alignment on audio sub-slot at transfer 2268 * bit 3: Add length specifier to transfers 2269 * bit 4: Start playback stream at first in implement feedback mode 2270 * bit 5: Skip clock selector setup 2271 * bit 6: Ignore errors from clock source search 2272 * bit 7: Indicates ITF-USB DSD based DACs 2273 * bit 8: Add a delay of 20ms at each control message handling 2274 * bit 9: Add a delay of 1-2ms at each control message handling 2275 * bit 10: Add a delay of 5-6ms at each control message handling 2276 * bit 11: Add a delay of 50ms at each interface setup 2277 * bit 12: Perform sample rate validations at probe 2278 * bit 13: Disable runtime PM autosuspend 2279 * bit 14: Ignore errors for mixer access 2280 * bit 15: Support generic DSD raw U32_BE format 2281 2282This module supports multiple devices, autoprobe and hotplugging. 2283 2284NB: ``nrpacks`` parameter can be modified dynamically via sysfs. 2285Don't put the value over 20. Changing via sysfs has no sanity 2286check. 2287 2288NB: ``ignore_ctl_error=1`` may help when you get an error at accessing 2289the mixer element such as URB error -22. This happens on some 2290buggy USB device or the controller. This workaround corresponds to 2291the ``quirk_flags`` bit 14, too. 2292 2293NB: ``quirk_alias`` option is provided only for testing / development. 2294If you want to have a proper support, contact to upstream for 2295adding the matching quirk in the driver code statically. 2296Ditto for ``quirk_flags``. If a device is known to require specific 2297workarounds, please report to the upstream. 2298 2299Module snd-usb-caiaq 2300-------------------- 2301 2302Module for caiaq UB audio interfaces, 2303 2304* Native Instruments RigKontrol2 2305* Native Instruments Kore Controller 2306* Native Instruments Audio Kontrol 1 2307* Native Instruments Audio 8 DJ 2308 2309This module supports multiple devices, autoprobe and hotplugging. 2310 2311Module snd-usb-usx2y 2312-------------------- 2313 2314Module for Tascam USB US-122, US-224 and US-428 devices. 2315 2316This module supports multiple devices, autoprobe and hotplugging. 2317 2318Note: you need to load the firmware via ``usx2yloader`` utility included 2319in alsa-tools and alsa-firmware packages. 2320 2321Module snd-via82xx 2322------------------ 2323 2324Module for AC'97 motherboards based on VIA 82C686A/686B, 8233, 8233A, 23258233C, 8235, 8237 (south) bridge. 2326 2327mpu_port 2328 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup 2329 [VIA686A/686B only] 2330joystick 2331 Enable joystick (default off) [VIA686A/686B only] 2332ac97_clock 2333 AC'97 codec clock base (default 48000Hz) 2334dxs_support 2335 support DXS channels, 0 = auto (default), 1 = enable, 2 = disable, 2336 3 = 48k only, 4 = no VRA, 5 = enable any sample rate and different 2337 sample rates on different channels [VIA8233/C, 8235, 8237 only] 2338ac97_quirk 2339 AC'97 workaround for strange hardware; 2340 See `AC97 Quirk Option`_ section below. 2341 2342This module supports one chip and autoprobe. 2343 2344Note: on some SMP motherboards like MSI 694D the interrupts might 2345not be generated properly. In such a case, please try to 2346set the SMP (or MPS) version on BIOS to 1.1 instead of 2347default value 1.4. Then the interrupt number will be 2348assigned under 15. You might also upgrade your BIOS. 2349 2350Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound) 2351channels as the first PCM. On these channels, up to 4 2352streams can be played at the same time, and the controller 2353can perform sample rate conversion with separate rates for 2354each channel. 2355As default (``dxs_support = 0``), 48k fixed rate is chosen 2356except for the known devices since the output is often 2357noisy except for 48k on some mother boards due to the 2358bug of BIOS. 2359Please try once ``dxs_support=5`` and if it works on other 2360sample rates (e.g. 44.1kHz of mp3 playback), please let us 2361know the PCI subsystem vendor/device id's (output of 2362``lspci -nv``). 2363If ``dxs_support=5`` does not work, try ``dxs_support=4``; if it 2364doesn't work too, try dxs_support=1. (dxs_support=1 is 2365usually for old motherboards. The correct implemented 2366board should work with 4 or 5.) If it still doesn't 2367work and the default setting is ok, ``dxs_support=3`` is the 2368right choice. If the default setting doesn't work at all, 2369try ``dxs_support=2`` to disable the DXS channels. 2370In any cases, please let us know the result and the 2371subsystem vendor/device ids. See `Links and Addresses`_ 2372below. 2373 2374Note: for the MPU401 on VIA823x, use snd-mpu401 driver 2375additionally. The mpu_port option is for VIA686 chips only. 2376 2377The power-management is supported. 2378 2379Module snd-via82xx-modem 2380------------------------ 2381 2382Module for VIA82xx AC97 modem 2383 2384ac97_clock 2385 AC'97 codec clock base (default 48000Hz) 2386 2387This module supports one card and autoprobe. 2388 2389Note: The default index value of this module is -2, i.e. the first 2390slot is excluded. 2391 2392The power-management is supported. 2393 2394Module snd-virmidi 2395------------------ 2396 2397Module for virtual rawmidi devices. 2398This module creates virtual rawmidi devices which communicate 2399to the corresponding ALSA sequencer ports. 2400 2401midi_devs 2402 MIDI devices # (1-4, default=4) 2403 2404This module supports multiple cards. 2405 2406Module snd-virtuoso 2407------------------- 2408 2409Module for sound cards based on the Asus AV66/AV100/AV200 chips, 2410i.e., Xonar D1, DX, D2, D2X, DS, DSX, Essence ST (Deluxe), 2411Essence STX (II), HDAV1.3 (Deluxe), and HDAV1.3 Slim. 2412 2413This module supports autoprobe and multiple cards. 2414 2415Module snd-vx222 2416---------------- 2417 2418Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards. 2419 2420mic 2421 Enable Microphone on V222 Mic (NYI) 2422ibl 2423 Capture IBL size. (default = 0, minimum size) 2424 2425This module supports multiple cards. 2426 2427When the driver is compiled as a module and the hotplug firmware 2428is supported, the firmware data is loaded via hotplug automatically. 2429Install the necessary firmware files in alsa-firmware package. 2430When no hotplug fw loader is available, you need to load the 2431firmware via vxloader utility in alsa-tools package. To invoke 2432vxloader automatically, add the following to /etc/modprobe.d/alsa.conf 2433 2434:: 2435 2436 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222\ 2437 && /usr/bin/vxloader 2438 2439(for 2.2/2.4 kernels, add ``post-install /usr/bin/vxloader`` to 2440/etc/modules.conf, instead.) 2441IBL size defines the interrupts period for PCM. The smaller size 2442gives smaller latency but leads to more CPU consumption, too. 2443The size is usually aligned to 126. As default (=0), the smallest 2444size is chosen. The possible IBL values can be found in 2445/proc/asound/cardX/vx-status proc file. 2446 2447The power-management is supported. 2448 2449Module snd-vxpocket 2450------------------- 2451 2452Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards. 2453 2454ibl 2455 Capture IBL size. (default = 0, minimum size) 2456 2457This module supports multiple cards. The module is compiled only when 2458PCMCIA is supported on kernel. 2459 2460With the older 2.6.x kernel, to activate the driver via the card 2461manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the 2462sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no 2463longer require a config file. 2464 2465When the driver is compiled as a module and the hotplug firmware 2466is supported, the firmware data is loaded via hotplug automatically. 2467Install the necessary firmware files in alsa-firmware package. 2468When no hotplug fw loader is available, you need to load the 2469firmware via vxloader utility in alsa-tools package. 2470 2471About capture IBL, see the description of snd-vx222 module. 2472 2473Note: snd-vxp440 driver is merged to snd-vxpocket driver since 2474ALSA 1.0.10. 2475 2476The power-management is supported. 2477 2478Module snd-ymfpci 2479----------------- 2480 2481Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x). 2482 2483mpu_port 2484 0x300,0x330,0x332,0x334, 0 (disable) by default, 2485 1 (auto-detect for YMF744/754 only) 2486fm_port 2487 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default 2488 1 (auto-detect for YMF744/754 only) 2489joystick_port 2490 0x201,0x202,0x204,0x205, 0 (disable) by default, 2491 1 (auto-detect) 2492rear_switch 2493 enable shared rear/line-in switch (bool) 2494 2495This module supports autoprobe and multiple chips. 2496 2497The power-management is supported. 2498 2499Module snd-pdaudiocf 2500-------------------- 2501 2502Module for Sound Core PDAudioCF sound card. 2503 2504The power-management is supported. 2505 2506 2507AC97 Quirk Option 2508================= 2509 2510The ac97_quirk option is used to enable/override the workaround for 2511specific devices on drivers for on-board AC'97 controllers like 2512snd-intel8x0. Some hardware have swapped output pins between Master 2513and Headphone, or Surround (thanks to confusion of AC'97 2514specifications from version to version :-) 2515 2516The driver provides the auto-detection of known problematic devices, 2517but some might be unknown or wrongly detected. In such a case, pass 2518the proper value with this option. 2519 2520The following strings are accepted: 2521 2522default 2523 Don't override the default setting 2524none 2525 Disable the quirk 2526hp_only 2527 Bind Master and Headphone controls as a single control 2528swap_hp 2529 Swap headphone and master controls 2530swap_surround 2531 Swap master and surround controls 2532ad_sharing 2533 For AD1985, turn on OMS bit and use headphone 2534alc_jack 2535 For ALC65x, turn on the jack sense mode 2536inv_eapd 2537 Inverted EAPD implementation 2538mute_led 2539 Bind EAPD bit for turning on/off mute LED 2540 2541For backward compatibility, the corresponding integer value -1, 0, ... 2542are accepted, too. 2543 2544For example, if ``Master`` volume control has no effect on your device 2545but only ``Headphone`` does, pass ac97_quirk=hp_only module option. 2546 2547 2548Configuring Non-ISAPNP Cards 2549============================ 2550 2551When the kernel is configured with ISA-PnP support, the modules 2552supporting the isapnp cards will have module options ``isapnp``. 2553If this option is set, *only* the ISA-PnP devices will be probed. 2554For probing the non ISA-PnP cards, you have to pass ``isapnp=0`` option 2555together with the proper i/o and irq configuration. 2556 2557When the kernel is configured without ISA-PnP support, isapnp option 2558will be not built in. 2559 2560 2561Module Autoloading Support 2562========================== 2563 2564The ALSA drivers can be loaded automatically on demand by defining 2565module aliases. The string ``snd-card-%1`` is requested for ALSA native 2566devices where ``%i`` is sound card number from zero to seven. 2567 2568To auto-load an ALSA driver for OSS services, define the string 2569``sound-slot-%i`` where ``%i`` means the slot number for OSS, which 2570corresponds to the card index of ALSA. Usually, define this 2571as the same card module. 2572 2573An example configuration for a single emu10k1 card is like below: 2574:: 2575 2576 ----- /etc/modprobe.d/alsa.conf 2577 alias snd-card-0 snd-emu10k1 2578 alias sound-slot-0 snd-emu10k1 2579 ----- /etc/modprobe.d/alsa.conf 2580 2581The available number of auto-loaded sound cards depends on the module 2582option ``cards_limit`` of snd module. As default it's set to 1. 2583To enable the auto-loading of multiple cards, specify the number of 2584sound cards in that option. 2585 2586When multiple cards are available, it'd better to specify the index 2587number for each card via module option, too, so that the order of 2588cards is kept consistent. 2589 2590An example configuration for two sound cards is like below: 2591:: 2592 2593 ----- /etc/modprobe.d/alsa.conf 2594 # ALSA portion 2595 options snd cards_limit=2 2596 alias snd-card-0 snd-interwave 2597 alias snd-card-1 snd-ens1371 2598 options snd-interwave index=0 2599 options snd-ens1371 index=1 2600 # OSS/Free portion 2601 alias sound-slot-0 snd-interwave 2602 alias sound-slot-1 snd-ens1371 2603 ----- /etc/modprobe.d/alsa.conf 2604 2605In this example, the interwave card is always loaded as the first card 2606(index 0) and ens1371 as the second (index 1). 2607 2608Alternative (and new) way to fixate the slot assignment is to use 2609``slots`` option of snd module. In the case above, specify like the 2610following: 2611:: 2612 2613 options snd slots=snd-interwave,snd-ens1371 2614 2615Then, the first slot (#0) is reserved for snd-interwave driver, and 2616the second (#1) for snd-ens1371. You can omit index option in each 2617driver if slots option is used (although you can still have them at 2618the same time as long as they don't conflict). 2619 2620The slots option is especially useful for avoiding the possible 2621hot-plugging and the resultant slot conflict. For example, in the 2622case above again, the first two slots are already reserved. If any 2623other driver (e.g. snd-usb-audio) is loaded before snd-interwave or 2624snd-ens1371, it will be assigned to the third or later slot. 2625 2626When a module name is given with '!', the slot will be given for any 2627modules but that name. For example, ``slots=!snd-pcsp`` will reserve 2628the first slot for any modules but snd-pcsp. 2629 2630 2631ALSA PCM devices to OSS devices mapping 2632======================================= 2633:: 2634 2635 /dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4 2636 /dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3 2637 /dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12 2638 /dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20 2639 /dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19 2640 /dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28 2641 /dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36 2642 /dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39 2643 /dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44 2644 2645The first number from ``/dev/snd/pcmC{X}D{Y}[c|p]`` expression means 2646sound card number and second means device number. The ALSA devices 2647have either ``c`` or ``p`` suffix indicating the direction, capture and 2648playback, respectively. 2649 2650Please note that the device mapping above may be varied via the module 2651options of snd-pcm-oss module. 2652 2653 2654Proc interfaces (/proc/asound) 2655============================== 2656 2657/proc/asound/card#/pcm#[cp]/oss 2658------------------------------- 2659erase 2660 erase all additional information about OSS applications 2661 2662<app_name> <fragments> <fragment_size> [<options>] 2663 <app_name> 2664 name of application with (higher priority) or without path 2665 <fragments> 2666 number of fragments or zero if auto 2667 <fragment_size> 2668 size of fragment in bytes or zero if auto 2669 <options> 2670 optional parameters 2671 2672 disable 2673 the application tries to open a pcm device for 2674 this channel but does not want to use it. 2675 (Cause a bug or mmap needs) 2676 It's good for Quake etc... 2677 direct 2678 don't use plugins 2679 block 2680 force block mode (rvplayer) 2681 non-block 2682 force non-block mode 2683 whole-frag 2684 write only whole fragments (optimization affecting 2685 playback only) 2686 no-silence 2687 do not fill silence ahead to avoid clicks 2688 buggy-ptr 2689 Returns the whitespace blocks in GETOPTR ioctl 2690 instead of filled blocks 2691 2692Example: 2693:: 2694 2695 echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss 2696 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss 2697 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss 2698 2699 2700Early Buffer Allocation 2701======================= 2702 2703Some drivers (e.g. hdsp) require the large contiguous buffers, and 2704sometimes it's too late to find such spaces when the driver module is 2705actually loaded due to memory fragmentation. You can pre-allocate the 2706PCM buffers by loading snd-page-alloc module and write commands to its 2707proc file in prior, for example, in the early boot stage like 2708``/etc/init.d/*.local`` scripts. 2709 2710Reading the proc file /proc/drivers/snd-page-alloc shows the current 2711usage of page allocation. In writing, you can send the following 2712commands to the snd-page-alloc driver: 2713 2714* add VENDOR DEVICE MASK SIZE BUFFERS 2715 2716VENDOR and DEVICE are PCI vendor and device IDs. They take 2717integer numbers (0x prefix is needed for the hex). 2718MASK is the PCI DMA mask. Pass 0 if not restricted. 2719SIZE is the size of each buffer to allocate. You can pass 2720k and m suffix for KB and MB. The max number is 16MB. 2721BUFFERS is the number of buffers to allocate. It must be greater 2722than 0. The max number is 4. 2723 2724* erase 2725 2726This will erase the all pre-allocated buffers which are not in 2727use. 2728 2729 2730Links and Addresses 2731=================== 2732 2733ALSA project homepage 2734 http://www.alsa-project.org 2735Kernel Bugzilla 2736 http://bugzilla.kernel.org/ 2737ALSA Developers ML 2738 mailto:alsa-devel@alsa-project.org 2739alsa-info.sh script 2740 https://www.alsa-project.org/alsa-info.sh 2741