Documentation/sound/alsa-configuration.rst

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