ALSA-Configuration.txt 50.7 KB
Newer Older
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

		Advanced Linux Sound Architecture - Driver
		==========================================
			    Configuration guide


Kernel Configuration
====================

To enable the ALSA support, at least you need to build the kernel with
the primary sound card support (CONFIG_SOUND).  Since ALSA can emulate
the OSS, you don't have to choose any of the OSS/Free modules.  Please
enable "OSS API emulation" (CONFIG_SND_OSSEMUL) and both OSS mixer and
PCM supports if you want to run the OSS application with the ALSA.

When you want to support the WaveTable functionality on some cards
such like SB Live!, you need to enable "Sequencer support"
(CONFIG_SND_SEQUENCER).

For getting more verbose debug messages, turn on "Verbose printk" and
"Debug" options.  For checking the memory leaks, you can turn on
"Debug memory" option, too.  "Debug detection" will put more
additional checks for the detection of cards.

Please note that all the ALSA ISA drivers support Linux isapnp API (if
the card supports).  You don't need to configure the PnP via
isapnptools.


Jaroslav Kysela's avatar
Jaroslav Kysela committed
30 31 32
Creating ALSA devices
=====================

33
Use the /dev/MAKEDEV script to create the nessecary device nodes.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
34 35


Jaroslav Kysela's avatar
Jaroslav Kysela committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
Module parameters
=================

  A user can modify or set parameters at the load time of the module. If
  the module supports more cards and you have got more than one card
  of the same type, you may simply specify more values for the parameter,
  delimited by commas.
  
  Note that module option names were changed in 0.9.0rc4. The 'snd_'
  prefix was removed.

  Module snd
  ----------

    The module snd is the ALSA core module, which is used by all ALSA
    card drivers.  This takes the global options for creating devices,
    etc.

    major	- major # for sound driver
		- default is 116
    cards_limit
57 58 59 60
		- specifies card limit # for auto-loading (1-8)
		- default is 1
		- for auto-loading more than 1 card, specify this option
		  together with snd-card-X aliases.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
61 62
    device_mode
		- specifies permission mask for dynamic sound device filesystem
Jaroslav Kysela's avatar
Jaroslav Kysela committed
63
		  (available only when DEVFS is enabled)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
		- default value = 0666
		- for example 'device_mode=0660'

  
  Module snd-pcm-oss
  ------------------

    The PCM OSS emulation module.
    This module takes the options to change the mapping of devices.

    dsp_map	- PCM device number maps assigned to the 1st OSS device.
		  (default: 0)
    adsp_map	- PCM device number maps assigned to the 2st OSS device.
		  (default: 1)
    nonblock_open - Don't block opening busy PCM devices.

    For example, when dsp_map=2, /dev/dsp will be mapped to PCM #2 of
    the card #0.  Similarly, when adsp_map=0, /dev/adsp will be mapped
    to PCM #0 of the card #0.
    For changing the second or later card, specify the option with
    commas, such like "dsp_map=0,1".

    nonblock_open option is used to change the behavior of the PCM
    regarding opening the device.  When this option is non-zero,
    opening a busy OSS PCM device won't be blocked but return
    immediately with EAGAIN (just like O_NONBLOCK flag).
    
  Module snd-rawmidi
  ------------------

    This module takes the options to change the mapping of OSS
    devices like snd-pcm-oss module.

    midi_map	- MIDI device number maps assigned to the 1st OSS device.
		  (default: 0)
    amidi_map	- MIDI device number maps assigned to the 2st OSS device.
		  (default: 1)

Jaroslav Kysela's avatar
Jaroslav Kysela committed
102
  Common parameters for top soundcard modules
Jaroslav Kysela's avatar
Jaroslav Kysela committed
103 104 105 106 107 108 109 110 111 112 113
  -------------------------------------------

    Each of top-level soundcard module takes some general options,

    index	- 0-7 - index (slot #) for soundcard
                - if not set or -1, first free index (slot #) is assigned
    id		- user identification for card (up to 15 chars)
		- default expression is 'card<index>' (for example card1)
		- value is used for /proc/asound filesystem
		- this value can be used by applications for identification
		  of card if user does not want identify card with index number
114 115
    enable  	- enable card.  (all cards enabled for PCI and ISA PnP cards
		  as default.)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149

  Module snd-ad1816a
  ------------------

    Module for soundcards based on Analog Devices AD1816A/AD1815 ISA chips.

    port	- port # for AD1816A chip (PnP setup)
    mpu_port	- port # for MPU-401 UART (PnP setup)
    fm_port	- port # for OPL3 (PnP setup)
    irq		- IRQ # for AD1816A chip (PnP setup)
    mpu_irq	- IRQ # for MPU-401 UART (PnP setup)
    dma1	- first DMA # for AD1816A chip (PnP setup)
    dma2	- second DMA # for AD1816A chip (PnP setup)
    
    Module supports up to 8 cards, autoprobe and PnP.
    
  Module snd-ad1848
  -----------------

    Module for soundcards based on AD1848/AD1847/CS4248 ISA chips.

    port	- port # for AD1848 chip
    irq		- IRQ # for AD1848  chip
    dma1	- DMA # for AD1848 chip (0,1,3)
    
    Module supports up to 8 cards. This module does not support autoprobe
    thus main port must be specified!!! Other ports are optional.
    
  Module snd-ali5451
  ------------------

    Module for ALi M5451 PCI chip.

    pcm_channels    - Number of hardware channels assigned for PCM
Jaroslav Kysela's avatar
Jaroslav Kysela committed
150
    spdif           - Support SPDIF I/O (disabled by default)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176

    Module supports autoprobe and multiple chips (max 8).

    The power-management is supported.

  Module snd-als100
  -----------------

    Module for soundcards based on Avance Logic ALS100/ALS120 ISA chips.

    port	- port # for ALS100 (SB16) chip (PnP setup)
    irq		- IRQ # for ALS100 (SB16) chip (PnP setup)
    dma8	- 8-bit DMA # for ALS100 (SB16) chip (PnP setup)
    dma16	- 16-bit DMA # for ALS100 (SB16) chip (PnP setup)
    mpu_port	- port # for MPU-401 UART (PnP setup)
    mpu_irq	- IRQ # for MPU-401 (PnP setup)
    fm_port	- port # for OPL3 FM (PnP setup)
    
    Module supports up to 8 cards, autoprobe and PnP.

  Module snd-als4000
  ------------------

    Module for soundcards based on Avance Logic ALS4000 PCI chip.

    joystick_port - port # for legacy joystick support.
177
                    0 = disabled (default), 1 = auto-detect
Jaroslav Kysela's avatar
Jaroslav Kysela committed
178 179 180
    
    Module supports up to 8 cards, autoprobe and PnP.

181 182 183 184 185 186 187 188 189 190
  Module snd-atiixp
  -----------------

    Module for ATI IXP 150/200/250 AC97 controllers.

    ac97_clock		- AC'97 clock (defalut = 48000)
    spdif_aclink	- S/PDIF transfer over AC-link (default = 1)

    This module supports up to 8 cards and autoprobe.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
191 192 193 194 195 196 197
  Module snd-atiixp-modem
  -----------------------

    Module for ATI IXP 150/200/250 AC97 modem controllers.

    Module supports up to 8 cards.

198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
  Module snd-au8810, snd-au8820, snd-au8830
  -----------------------------------------

    Module for Aureal Vortex, Vortex2 and Advantage device.

    pcifix	- Control PCI workarounds
		  0 = Disable all workarounds
		  1 = Force the PCI latency of the Aureal card to 0xff
		  2 = Force the Extend PCI#2 Internal Master for Efficient
		      Handling of Dummy Requests on the VIA KT133 AGP Bridge
		  3 = Force both settings
		  255 = Autodetect what is required (default)

    This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
    EQ, mpu401, gameport. A3D and wavetable support are still in development.
    Development and reverse engineering work is being coordinated at
    http://savannah.nongnu.org/projects/openvortex/
    SPDIF output has a copy of the AC97 codec output, unless you use the
    "spdif" pcm device, which allows raw data passthru.
    The hardware EQ hardware and SPDIF is only present in the Vortex2 and 
    Advantage.

    Note: Some ALSA mixer applicactions don't handle the SPDIF samplerate 
           control correctly. If you have problems regarding this, try
           another ALSA compliant mixer (alsamixer works).

Jaroslav Kysela's avatar
Jaroslav Kysela committed
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
  Module snd-azt2320
  ------------------

    Module for soundcards based on Aztech System AZT2320 ISA chip (PnP only).

    port	- port # for AZT2320 chip (PnP setup)
    wss_port	- port # for WSS (PnP setup)
    mpu_port	- port # for MPU-401 UART (PnP setup)
    fm_port	- FM port # for AZT2320 chip (PnP setup)
    irq		- IRQ # for AZT2320 (WSS) chip (PnP setup)
    mpu_irq	- IRQ # for MPU-401 UART (PnP setup)
    dma1	- 1st DMA # for AZT2320 (WSS) chip (PnP setup)
    dma2	- 2nd DMA # for AZT2320 (WSS) chip (PnP setup)
    
    Module supports up to 8 cards, PnP and autoprobe.
    
Jaroslav Kysela's avatar
Jaroslav Kysela committed
240 241 242 243 244
  Module snd-azt3328
  ------------------

    Module for soundcards based on Aztech AZF3328 PCI chip.

245 246
    joystick	- Enable joystick (default off)

Jaroslav Kysela's avatar
Jaroslav Kysela committed
247 248
    Module supports up to 8 cards.

249 250 251 252 253 254
  Module snd-bt87x
  ----------------

    Module for video cards based on Bt87x chips.

    digital_rate - Override the default digital rate (Hz)
255
    load_all	- Load the driver even if the card model isn't known
256 257 258

    Module supports up to 8 cards.

259 260 261 262 263 264 265 266
  Module snd-ca0106
  -----------------

    Module for Creative Audigy LS and SB Live 24bit

    Module supports up to 8 cards.


Jaroslav Kysela's avatar
Jaroslav Kysela committed
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
  Module snd-cmi8330
  ------------------

    Module for soundcards based on C-Media CMI8330 ISA chips.

    wssport	- port # for CMI8330 chip (WSS)
    wssirq	- IRQ # for CMI8330 chip (WSS)
    wssdma	- first DMA # for CMI8330 chip (WSS)
    sbport	- port # for CMI8330 chip (SB16)
    sbirq	- IRQ # for CMI8330 chip (SB16)
    sbdma8	- 8bit DMA # for CMI8330 chip (SB16)
    sbdma16	- 16bit DMA # for CMI8330 chip (SB16)

    Module supports up to 8 cards and autoprobe.

  Module snd-cmipci
  -----------------

    Module for C-Media CMI8338 and 8738 PCI soundcards.

287 288
    mpu_port	- 0x300,0x310,0x320,0x330, 0 = disable (default)
    fm_port     - 0x388 (default), 0 = disable (default)
289 290
    soft_ac3    - Sofware-conversion of raw SPDIF packets (model 033 only)
                  (default = 1)
291
    joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434

    Module supports autoprobe and multiple chips (max 8).
    
  Module snd-cs4231
  -----------------

    Module for soundcards based on CS4231 ISA chips.

    port	- port # for CS4231 chip
    mpu_port	- port # for MPU-401 UART (optional), -1 = disable
    irq		- IRQ # for CS4231 chip
    mpu_irq	- IRQ # for MPU-401 UART
    dma1	- first DMA # for CS4231 chip
    dma2	- second DMA # for CS4231 chip
    
    Module supports up to 8 cards. This module does not support autoprobe
    thus main port must be specified!!! Other ports are optional.

    The power-management is supported.
    
  Module snd-cs4232
  -----------------

    Module for soundcards based on CS4232/CS4232A ISA chips.

    port	- port # for CS4232 chip (PnP setup - 0x534)
    cport	- control port # for CS4232 chip (PnP setup - 0x120,0x210,0xf00)
    mpu_port	- port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
    fm_port	- FM port # for CS4232 chip (PnP setup - 0x388), -1 = disable
    irq		- IRQ # for CS4232 chip (5,7,9,11,12,15)
    mpu_irq	- IRQ # for MPU-401 UART (9,11,12,15)
    dma1	- first DMA # for CS4232 chip (0,1,3)
    dma2	- second DMA # for Yamaha CS4232 chip (0,1,3), -1 = disable
    isapnp	- ISA PnP detection - 0 = disable, 1 = enable (default)
    
    Module supports up to 8 cards. This module does not support autoprobe
    thus main port must be specified!!! Other ports are optional.

    The power-management is supported.
    
  Module snd-cs4236
  -----------------

    Module for soundcards based on CS4235/CS4236/CS4236B/CS4237B/
                                   CS4238B/CS4239 ISA chips.

    port	- port # for CS4236 chip (PnP setup - 0x534)
    cport	- control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
    mpu_port	- port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
    fm_port	- FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
    irq		- IRQ # for CS4236 chip (5,7,9,11,12,15)
    mpu_irq	- IRQ # for MPU-401 UART (9,11,12,15)
    dma1	- first DMA # for CS4236 chip (0,1,3)
    dma2	- second DMA # for CS4236 chip (0,1,3), -1 = disable
    isapnp	- ISA PnP detection - 0 = disable, 1 = enable (default)
    
    Module supports up to 8 cards. This module does not support autoprobe
    (if ISA PnP is not used) thus main port and control port must be
    specified!!! Other ports are optional.

    The power-management is supported.

  Module snd-cs4281
  -----------------

    Module for Cirrus Logic CS4281 soundchip.

    dual_codec	- Secondary codec ID (0 = disable, default)

    Module supports up to 8 cards.

    The power-management is supported.

  Module snd-cs46xx
  -----------------

    Module for PCI soundcards based on CS4610/CS4612/CS4614/CS4615/CS4622/
				       CS4624/CS4630/CS4280 PCI chips.

    external_amp     - Force to enable external amplifer.
    thinkpad         - Force to enable Thinkpad's CLKRUN control.
    mmap_valid       - Support OSS mmap mode (default = 0).

    Module supports up to 8 cards and autoprobe.
    Usually external amp and CLKRUN controls are detected automatically
    from PCI sub vendor/device ids.  If they don't work, give the options
    above explicitly.

    The power-management is supported.
    
  Module snd-dt019x
  -----------------

    Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
    only)

    port	- Port # (PnP setup)
    mpu_port	- Port # for MPU-401 (PnP setup)
    fm_port	- Port # for FM OPL-3 (PnP setup)
    irq		- IRQ # (PnP setup)
    mpu_irq	- IRQ # for MPU-401 (PnP setup)
    dma8	- DMA # (PnP setup)

    Module supports up to 8 cards.  This module is enabled only with
    ISA PnP support.

  Module snd-dummy
  ----------------

    Module for the dummy soundcard. This soundcard doesn't do any output
    or input, but you may use this module for any application which
    requires a soundcard (like RealPlayer).

  Module snd-emu10k1
  ------------------

    Module for EMU10K1/EMU10k2 based PCI soundcards.
			* Sound Blaster Live!
			* Sound Blaster PCI 512
			* Emu APS (partially supported)
			* Sound Blaster Audigy

    extin   - bitmap of available external inputs for FX8010 (see bellow)
    extout  - bitmap of available external outputs for FX8010 (see bellow)
    seq_ports - allocated sequencer ports (4 by default)
    max_synth_voices - limit of voices used for wavetable (64 by default)
    max_buffer_size  - specifies the maximum size of wavetable/pcm buffers
                       given in MB unit.  Default value is 128.
    enable_ir - enable IR

    Module supports up to 8 cards and autoprobe.

    Input & Output configurations 			[extin/extout]
	* Creative Card wo/Digital out			[0x0003/0x1f03]
	* Creative Card w/Digital out			[0x0003/0x1f0f]
	* Creative Card w/Digital CD in			[0x000f/0x1f0f]
	* Creative Card wo/Digital out + LiveDrive	[0x3fc3/0x1fc3]
	* Creative Card w/Digital out + LiveDrive	[0x3fc3/0x1fcf]
	* Creative Card w/Digital CD in + LiveDrive	[0x3fcf/0x1fcf]
	* Creative Card wo/Digital out + Digital I/O 2  [0x0fc3/0x1f0f]
	* Creative Card w/Digital out + Digital I/O 2	[0x0fc3/0x1f0f]
	* Creative Card w/Digital CD in + Digital I/O 2	[0x0fcf/0x1f0f]
        * Creative Card 5.1/w Digital out + LiveDrive	[0x3fc3/0x1fff]
435 436
	* Creative Card 5.1 (c) 2003			[0x3fc3/0x7cff]
        * Creative Card all ins and outs		[0x3fff/0x7fff]
Jaroslav Kysela's avatar
Jaroslav Kysela committed
437
    
Jaroslav Kysela's avatar
Jaroslav Kysela committed
438 439 440 441 442 443 444
  Module snd-emu10k1x
  -------------------

    Module for Creative Emu10k1X (SB Live Dell OEM version)

    Module supports up to 8 cards.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
445 446 447 448 449 450 451
  Module snd-ens1370
  ------------------

    Module for Ensoniq AudioPCI ES1370 PCI soundcards.
			* SoundBlaster PCI 64
			* SoundBlaster PCI 128

452 453
    joystick		- Enable joystick (default off)

Jaroslav Kysela's avatar
Jaroslav Kysela committed
454 455 456 457 458 459 460 461 462 463
    Module supports up to 8 cards and autoprobe.
    
  Module snd-ens1371
  ------------------

    Module for Ensoniq AudioPCI ES1371 PCI soundcards.
			* SoundBlaster PCI 64
			* SoundBlaster PCI 128
			* SoundBlaster Vibra PCI

464
    joystick_port	- port # for joystick (0x200,0x208,0x210,0x218),
465
			  0 = disable (default), 1 = auto-detect
466

Jaroslav Kysela's avatar
Jaroslav Kysela committed
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
    Module supports up to 8 cards and autoprobe.
    
  Module snd-es968
  ----------------

    Module for soundcards based on ESS ES968 chip (PnP only).

    port	- port # for ES968 (SB8) chip (PnP setup)
    irq		- IRQ # for ES968 (SB8) chip (PnP setup)
    dma1	- DMA # for ES968 (SB8) chip (PnP setup)
    
    Module supports up to 8 cards, PnP and autoprobe.
    
  Module snd-es1688
  -----------------

    Module for ESS AudioDrive ES-1688 and ES-688 soundcards.

    port	- port # for ES-1688 chip (0x220,0x240,0x260)
    mpu_port	- port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
    irq		- IRQ # for ES-1688 chip (5,7,9,10)
    mpu_irq	- IRQ # for MPU-401 port (5,7,9,10)
    dma8	- DMA # for ES-1688 chip (0,1,3)

    Module supports up to 8 cards and autoprobe (without MPU-401 port).

  Module snd-es18xx
  -----------------

    Module for ESS AudioDrive ES-18xx soundcards.

    port	- port # for ES-18xx chip (0x220,0x240,0x260)
    mpu_port	- port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
    fm_port	- port # for FM (optional, not used)
    irq		- IRQ # for ES-18xx chip (5,7,9,10)
    dma1	- first DMA # for ES-18xx chip (0,1,3)
    dma2	- first DMA # for ES-18xx chip (0,1,3)
    isapnp	- ISA PnP detection - 0 = disable, 1 = enable (default)

    Module supports up to 8 cards ISA PnP and autoprobe (without MPU-401 port
    if native ISA PnP routines are not used).
    When dma2 is equal with dma1, the driver works as half-duplex.

    The power-management is supported.

  Module snd-es1938
  -----------------

    Module for soundcards based on ESS Solo-1 (ES1938,ES1946) chips.

    Module supports up to 8 cards and autoprobe.

  Module snd-es1968
  -----------------

    Module for soundcards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.

    total_bufsize	- total buffer size in kB (1-4096kB)
    pcm_substreams_p	- playback channels (1-8, default=2)
    pcm_substreams_c	- capture channels (1-8, default=0)
    clock		- clock (0 = auto-detection)
    use_pm		- support the power-management (0 = off, 1 = on,
Jaroslav Kysela's avatar
Jaroslav Kysela committed
529 530
			  2 = auto (default))
    enable_mpu		- enable MPU401 (0 = off, 1 = on, 2 = auto (default))
531
    joystick		- enable joystick (default off)       
Jaroslav Kysela's avatar
Jaroslav Kysela committed
532 533 534 535 536 537 538 539 540 541

    Module supports up to 8 cards and autoprobe.

    The power-management is supported.

  Module snd-fm801
  ----------------

    Module for ForteMedia FM801 based PCI soundcards.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
542 543 544 545 546 547 548
    tea575x_tuner       - Enable TEA575x tuner
                          - 1 = MediaForte 256-PCS
                          - 2 = MediaForte 256-PCPR
                          - 3 = MediaForte 64-PCR  
                          - High 16-bits are video (radio) device number + 1
                          - example: 0x10002 (MediaForte 256-PCPR, device 1)

Jaroslav Kysela's avatar
Jaroslav Kysela committed
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
    Module supports up to 8 cards and autoprobe.
    
  Module snd-gusclassic
  ---------------------

    Module for Gravis UltraSound Classic soundcard.

    port	- port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
    irq		- IRQ # for GF1 chip (3,5,9,11,12,15)
    dma1	- DMA # for GF1 chip (1,3,5,6,7)
    dma2	- DMA # for GF1 chip (1,3,5,6,7,-1=disable)
    joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
    voices	- GF1 voices limit (14-32)
    pcm_voices	- reserved PCM voices

    Module supports up to 8 cards and autoprobe.

  Module snd-gusextreme
  ---------------------

    Module for Gravis UltraSound Extreme (Synergy ViperMax) soundcard.

    port	- port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
    gf1_port	- port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
    mpu_port	- port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
    irq		- IRQ # for ES-1688 chip (5,7,9,10)
    gf1_irq	- IRQ # for GF1 chip (3,5,9,11,12,15)
    mpu_irq	- IRQ # for MPU-401 port (5,7,9,10)
    dma8	- DMA # for ES-1688 chip (0,1,3)
    dma1	- DMA # for GF1 chip (1,3,5,6,7)
    joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
    voices	- GF1 voices limit (14-32)
    pcm_voices	- reserved PCM voices

    Module supports up to 8 cards and autoprobe (without MPU-401 port).

  Module snd-gusmax
  -----------------

    Module for Gravis UltraSound MAX soundcard.

    port	- port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
    irq		- IRQ # for GF1 chip (3,5,9,11,12,15)
    dma1	- DMA # for GF1 chip (1,3,5,6,7)
    dma2	- DMA # for GF1 chip (1,3,5,6,7,-1=disable)
    joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
    voices	- GF1 voices limit (14-32)
    pcm_voices	- reserved PCM voices

    Module supports up to 8 cards and autoprobe.
    
  Module snd-hdsp
  ---------------

    Module for RME Hammerfall DSP audio interface(s)

    precise_ptr	      - Enable precise pointer (doesn't work reliably).
			(default = 0)
    line_outs_monitor - Send all input and playback streams to line outs
			by default. (default = 0)
    force_firmware    - Force a reload of the I/O box firmware
			(default = 0)

    Module supports up to 8 cards.

614 615 616 617 618
    Note: The firmware data can be automatically loaded via hotplug
          when CONFIG_FW_LOADER is set.  Otherwise, you need to load
          the firmware via hdsploader utility included in alsa-tools
          package.
          The firmware data is found in alsa-firmware package.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
619 620 621 622 623 624 625

    Note: snd-page-alloc module does the job which snd-hammerfall-mem
          module did formerly.  It will allocate the buffers in advance
          when any HDSP cards are found.  To make the buffer
          allocation sure, load snd-page-alloc module in the early
          stage of boot sequence.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
626 627 628 629 630
  Module snd-ice1712
  ------------------

    Module for Envy24 (ICE1712) based PCI soundcards.
			* MidiMan M Audio Delta 1010
Jaroslav Kysela's avatar
Jaroslav Kysela committed
631
			* MidiMan M Audio Delta 1010LT
Jaroslav Kysela's avatar
Jaroslav Kysela committed
632 633 634
			* MidiMan M Audio Delta DiO 2496
			* MidiMan M Audio Delta 66
			* MidiMan M Audio Delta 44
Jaroslav Kysela's avatar
Jaroslav Kysela committed
635
			* MidiMan M Audio Delta 410
Jaroslav Kysela's avatar
Jaroslav Kysela committed
636 637 638 639
			* MidiMan M Audio Audiophile 2496
                        * TerraTec EWS 88MT
                        * TerraTec EWS 88D
                        * TerraTec EWX 24/96
Jaroslav Kysela's avatar
Jaroslav Kysela committed
640 641 642 643
                        * TerraTec DMX 6Fire
                        * Hoontech SoundTrack DSP 24
                        * Hoontech SoundTrack DSP 24 Value
                        * Hoontech SoundTrack DSP 24 Media 7.1
644
                        * Digigram VX442
Jaroslav Kysela's avatar
Jaroslav Kysela committed
645

646 647 648
    model       - Use the given board model, one of the following:
		  delta1010, dio2496, delta66, delta44, audiophile, delta410,
		  delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
649
		  dmx6fire, dsp24, dsp24_value, dsp24_71, ez8
Jaroslav Kysela's avatar
Jaroslav Kysela committed
650
    omni	- Omni I/O support for MidiMan M-Audio Delta44/66
651
    cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transciever)
652
                     in msec resolution, default value is 500 (0.5 sec)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
653 654 655 656 657

    Module supports up to 8 cards and autoprobe. Note: The consumer part
    is not used with all Envy24 based cards (for example in the MidiMan Delta
    serie).

Jaroslav Kysela's avatar
Jaroslav Kysela committed
658 659 660 661 662 663
  Module snd-ice1724
  ------------------

    Module for Envy24HT (VT/ICE1724) based PCI soundcards.
			* MidiMan M Audio Revolution 7.1
			* AMP Ltd AUDIO2000
Jaroslav Kysela's avatar
Jaroslav Kysela committed
664
			* TerraTec Aureon Sky-5.1, Space-7.1
Jaroslav Kysela's avatar
Jaroslav Kysela committed
665

666
    model       - Use the given board model, one of the following:
667 668
		  revo71, amp2000, prodigy71, aureon51, aureon71,
		  k8x800
669

Jaroslav Kysela's avatar
Jaroslav Kysela committed
670 671
    Module supports up to 8 cards and autoprobe.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
672 673 674 675 676 677 678 679 680 681 682
  Module snd-intel8x0
  -------------------

    Module for AC'97 motherboards from Intel and compatibles.
			* Intel i810/810E, i815, i820, i830, i84x, MX440
			* SiS 7012 (SiS 735)
			* NVidia NForce, NForce2
			* AMD AMD768, AMD8111
			* ALi m5455

    ac97_clock	  - AC'97 codec clock base (0 = auto-detect)
683 684 685 686 687 688
    ac97_quirk    - AC'97 workaround for strange hardware (-1 = default)
                    -1 = default, don't override
                     0 = disable
                     1 = use headphone control as master
                     2 = swap headphone and master controls
                     3 = for AD1985, turn on OMS bit and use headphone
689
                     4 = for ALC65x, turn on the jack sense mode
690
                     5 = inverted EAPD implementation
Jaroslav Kysela's avatar
Jaroslav Kysela committed
691 692
    buggy_irq      - Enable workaround for buggy interrupts on some
                     motherboards (default off)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
693 694

    Module supports autoprobe and multiple bus-master chips (max 8).
695

Jaroslav Kysela's avatar
Jaroslav Kysela committed
696 697 698 699
    Note: the latest driver supports auto-detection of chip clock.
    if you still encounter too fast playback, specify the clock
    explicitly via the module option "ac97_clock=41194".

700 701 702
    Joystick/MIDI ports are not supported by this driver.  If your
    motherboard has these devices, use the ns558 or snd-mpu401
    modules, respectively.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
703

704 705 706 707 708 709 710
    The ac97_quirk option is used to enable/override the workaround
    for specific devices.  Some hardware have swapped output pins
    between Master and Headphone, or Surround.  The driver provides
    the auto-detection of known problematic devices, but some might
    be unknown or wrongly detected.  In such a case, pass the proper
    value with this option.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
711 712
    The power-management is supported.
    
713 714 715 716 717 718 719 720 721
  Module snd-intel8x0m
  --------------------

    Module for Intel ICH (i8x0) chipset MC97 modems.

    ac97_clock	  - AC'97 codec clock base (0 = auto-detect)

    This module supports up to 8 cards and autoprobe.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
  Module snd-interwave
  --------------------

    Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
    and other soundcards based on AMD InterWave (tm) chip.
  
    port	- port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
    irq		- IRQ # for InterWave chip (3,5,9,11,12,15)
    dma1	- DMA # for InterWave chip (0,1,3,5,6,7)
    dma2	- DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
    joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
    midi	- 1 = MIDI UART enable, 0 = MIDI UART disable (default)
    pcm_voices	- reserved PCM voices for the synthesizer (default 2)
    effect	- 1 = InterWave effects enable (default 0);
                  requires 8 voices

    Module supports up to 8 cards, autoprobe and ISA PnP.

  Module snd-interwave-stb
  ------------------------

    Module for UltraSound 32-Pro (soundcard from STB used by Compaq)
    and other soundcards based on AMD InterWave (tm) chip with TEA6330T
    circuit for extended control of bass, treble and master volume.
  
    port	- port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
    port_tc	- tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
    irq		- IRQ # for InterWave chip (3,5,9,11,12,15)
    dma1	- DMA # for InterWave chip (0,1,3,5,6,7)
    dma2	- DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
    joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
    midi	- 1 = MIDI UART enable, 0 = MIDI UART disable (default)
    pcm_voices	- reserved PCM voices for the synthesizer (default 2)
    effect	- 1 = InterWave effects enable (default 0);
                  requires 8 voices

    Module supports up to 8 cards, autoprobe and ISA PnP.

  Module snd-korg1212
  -------------------

    Module for Korg 1212 IO PCI card

    Module supports up to 8 cards.

  Module snd-maestro3
  -------------------

    Module for Allegro/Maestro3 chips

    external_amp     - enable external amp (enabled by default)
    amp_gpio         - GPIO pin number for external amp (0-15) or
                       -1 for default pin (8 for allegro, 1 for
                       others) 

    Module supports autoprobe and multiple chips (max 8).
778

Jaroslav Kysela's avatar
Jaroslav Kysela committed
779 780 781 782 783 784 785 786
    Note: the binding of amplifier is dependent on hardware.
    If there is no sound even though all channels are unmuted, try to
    specify other gpio connection via amp_gpio option. 
    For example, a Panasonic notebook might need "amp_gpio=0x0d"
    option.

    The power-management is supported.

787 788 789 790 791 792 793 794 795
  Module snd-mixart
  -----------------

    Module for Digigram miXart8 soundcards.

    Module supports multiple cards.
    Note: One miXart8 board will be represented as 4 alsa cards.
          See MIXART.txt for details.

796 797 798 799
    When the driver is compiled as a module and the hotplug firmware
    is supported, the firmware data is loaded via hotplug automatically.
    Install the necessary firmware files in alsa-firmware package.
    When no hotplug fw loader is available, you need to load the
800
    firmware via mixartloader utility in alsa-tools package.
801

Jaroslav Kysela's avatar
Jaroslav Kysela committed
802 803 804 805 806 807 808
  Module snd-mpu401
  -----------------

    Module for MPU-401 UART devices.

    port	- port number or -1 (disable)
    irq		- IRQ number or -1 (disable)
809
    acpipnp	- ACPI PnP detection - 0 = disable, 1 = enable (default)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
810

811 812
    Module supports multiple devices (max 8) and ACPI PnP.  If PnP is not
    used (or ACPI not enabled), port and irq must be specified.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
    
  Module snd-mtpav
  ----------------

    Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
    port).

    port	- I/O port # for MTPAV (0x378,0x278, default=0x378)
    irq		- IRQ # for MTPAV (7,5, default=7)
    hwports	- number of supported hardware ports, default=8.
    
    Module supports only 1 card.  This module has no enable option.

  Module snd-nm256
  ----------------

    Module for NeoMagic NM256AV/ZX chips

    playback_bufsize - max playback frame size in kB (4-128kB)
    capture_bufsize  - max capture frame size in kB (4-128kB)
    force_ac97       - 0 or 1 (disabled by default)
    buffer_top       - specify buffer top address
    use_cache        - 0 or 1 (disabled by default)
    vaio_hack        - alias buffer_top=0x25a800
837
    reset_workaround - enable AC97 RESET workaround for some laptops
Jaroslav Kysela's avatar
Jaroslav Kysela committed
838 839

    Module supports autoprobe and multiple chips (max 8).
840

841 842
    The power-management is supported.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
843 844
    Note: on some notebooks the buffer address cannot be detected
    automatically, or causes hang-up during initialization.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
845
    In such a case, specify the buffer top address explicity via
Jaroslav Kysela's avatar
Jaroslav Kysela committed
846 847 848 849 850 851
    buffer_top option.
    For example,
      Sony F250: buffer_top=0x25a800
      Sony F270: buffer_top=0x272800
    The driver supports only ac97 codec.  It's possible to force
    to initialize/use ac97 although it's not detected.  In such a
852 853 854 855 856 857 858 859 860 861 862
    case, use force_ac97=1 option - but *NO* guarantee whether it
    works!

    Note: The NM256 chip can be linked internally with non-AC97
    codecs.  This driver supports only the AC97 codec, and won't work
    with machines with other (most likely CS423x or OPL3SAx) chips,
    even though the device is detected in lspci.  In such a case, try
    other drivers, e.g. snd-cs4232 or snd-opl3sa2.  Some has ISA-PnP
    but some doesn't have ISA PnP.  You'll need to speicfy isapnp=0
    and proper hardware parameters in the case without ISA PnP.

863 864 865 866 867
    Note: some laptops need a workaround for AC97 RESET.  For the
    known hardware like Dell Latitude LS and Sony PCG-F305, this
    workaround is enabled automatically.  For other laptops with a
    hard freeze, you can try reset_workaround=1 option.

868 869 870 871 872 873 874
    Note: This driver is really crappy.  It's a porting from the
    OSS driver, which is a result of black-magic reverse engineering.
    The detection of codec will fail if the driver is loaded *after*
    X-server as described above.  You might be able to force to load
    the module, but it may result in hang-up.   Hence, make sure that
    you load this module *before* X if you encounter this kind of
    problem.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948

  Module snd-opl3sa2
  ------------------

    Module for Yamaha OPL3-SA2/SA3 soundcards.

    port	- control port # for OPL3-SA chip (0x370)
    sb_port	- SB port # for OPL3-SA chip (0x220,0x240)
    wss_port	- WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
    midi_port	- port # for MPU-401 UART (0x300,0x330), -1 = disable
    fm_port	- FM port # for OPL3-SA chip (0x388), -1 = disable
    irq		- IRQ # for OPL3-SA chip (5,7,9,10)
    dma1	- first DMA # for Yamaha OPL3-SA chip (0,1,3)
    dma2	- second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
    isapnp	- ISA PnP detection - 0 = disable, 1 = enable (default)
    
    Module supports up to 8 cards and ISA PnP. This module does not support
    autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
    
    The power-management is supported.

  Module snd-opti92x-ad1848
  -------------------------

    Module for soundcards based on OPTi 82c92x and Analog Devices AD1848 chips.
    Module works with OAK Mozart cards as well.
    
    port      - port # for WSS chip (0x530,0xe80,0xf40,0x604)
    mpu_port  - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
    fm_port   - port # for OPL3 device (0x388)
    irq       - IRQ # for WSS chip (5,7,9,10,11)
    mpu_irq   - IRQ # for MPU-401 UART (5,7,9,10)
    dma1      - first DMA # for WSS chip (0,1,3)

    This module supports only one card, autoprobe and PnP.

  Module snd-opti92x-cs4231
  -------------------------

    Module for soundcards based on OPTi 82c92x and Crystal CS4231 chips.
    
    port      - port # for WSS chip (0x530,0xe80,0xf40,0x604)
    mpu_port  - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
    fm_port   - port # for OPL3 device (0x388)
    irq       - IRQ # for WSS chip (5,7,9,10,11)
    mpu_irq   - IRQ # for MPU-401 UART (5,7,9,10)
    dma1      - first DMA # for WSS chip (0,1,3)
    dma2      - second DMA # for WSS chip (0,1,3)

    This module supports only one card, autoprobe and PnP.

  Module snd-opti93x
  ------------------

    Module for soundcards based on OPTi 82c93x chips.
    
    port      - port # for WSS chip (0x530,0xe80,0xf40,0x604)
    mpu_port  - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
    fm_port   - port # for OPL3 device (0x388)
    irq       - IRQ # for WSS chip (5,7,9,10,11)
    mpu_irq   - IRQ # for MPU-401 UART (5,7,9,10)
    dma1      - first DMA # for WSS chip (0,1,3)
    dma2      - second DMA # for WSS chip (0,1,3)

    This module supports only one card, autoprobe and PnP.

  Module snd-powermac (on ppc only)
  ---------------------------------

    Module for PowerMac, iMac and iBook on-board soundchips

    enable_beep     - enable beep using PCM (enabled as default)

    Module supports autoprobe a chip.
949

Jaroslav Kysela's avatar
Jaroslav Kysela committed
950 951 952 953 954 955 956
    Note: the driver may have problems regarding endianess.

    The power-management is supported.

  Module snd-rme32
  ----------------

Jaroslav Kysela's avatar
Jaroslav Kysela committed
957 958
    Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32, 
    Prodif96 and Prodif Gold) soundcards.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978

    Module supports up to 8 cards.

  Module snd-rme96
  ----------------

    Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST soundcards.

    Module supports up to 8 cards.

  Module snd-rme9652
  ------------------

    Module for RME Digi9652 (Hammerfall, Hammerfall-Light) soundcards.

    precise_ptr	- Enable precise pointer (doesn't work reliably).
		  (default = 0)

    Module supports up to 8 cards.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
979 980 981 982 983 984
    Note: snd-page-alloc module does the job which snd-hammerfall-mem
          module did formerly.  It will allocate the buffers in advance
          when any RME9652 cards are found.  To make the buffer
          allocation sure, load snd-page-alloc module in the early
          stage of boot sequence.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
  Module snd-sa11xx-uda1341 (on arm only)
  ---------------------------------------

    Module for Philips UDA1341TS on Compaq iPAQ H3600 soundcard.

    Module supports only one card.
    Module has no enable and index options.

  Module snd-sb8
  --------------

    Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
					 SoundBlaster 2.0,
					 SoundBlaster Pro

    port	- port # for SB DSP chip (0x220,0x240,0x260)
    irq		- IRQ # for SB DSP chip (5,7,9,10)
    dma8	- DMA # for SB DSP chip (1,3)

    Module supports up to 8 cards and autoprobe.
    
  Module snd-sb16 and snd-sbawe
  -----------------------------

    Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
					  SoundBlaster AWE 32 (PnP),
					  SoundBlaster AWE 64 PnP

    port	- port # for SB DSP 4.x chip (0x220,0x240,0x260)
    mpu_port	- port # for MPU-401 UART (0x300,0x330), -1 = disable
    awe_port	- base port # for EMU8000 synthesizer (0x620,0x640,0x660)
                   (snd-sbawe module only)
    irq		- IRQ # for SB DSP 4.x chip (5,7,9,10)
    dma8	- 8-bit DMA # for SB DSP 4.x chip (0,1,3)
    dma16	- 16-bit DMA # for SB DSP 4.x chip (5,6,7)
    mic_agc	- Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
    csp		- ASP/CSP chip support - 0 = disable (default), 1 = enable
    isapnp	- ISA PnP detection - 0 = disable, 1 = enable (default)
    
    Module supports up to 8 cards, autoprobe and ISA PnP.

    Note: To use Vibra16X cards in 16-bit half duplex mode, you must
          disable 16bit DMA with dma16 = -1 module parameter.
          Also, all Sound Blaster 16 type cards can operate in 16-bit
          half duplex mode through 8-bit DMA channel by disabling their
          16-bit DMA channel.
    
  Module snd-sgalaxy
  ------------------

    Module for Aztech Sound Galaxy soundcard.

    sbport	- Port # for SB16 interface (0x220,0x240)
    wssport	- Port # for WSS interface (0x530,0xe80,0xf40,0x604)
    irq		- IRQ # (7,9,10,11)
    dma1	- DMA #

    Module supports up to 8 cards.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
  Module snd-sscape
  -----------------

    Module for ENSONIQ SoundScape PnP cards.

    port	- Port # (PnP setup)
    irq		- IRQ # (PnP setup)
    mpu_irq	- MPU-401 IRQ # (PnP setup)
    dma		- DMA # (PnP setup)

    Module supports up to 8 cards.  ISA PnP must be enabled.
    You need sscape_ctl tool in alsa-tools package for loading
    the microcode.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
  Module snd-sun-amd7930 (on sparc only)
  --------------------------------------

    Module for AMD7930 sound chips found on Sparcs.

    Module supports up to 8 cards.

  Module snd-sun-cs4231 (on sparc only)
  -------------------------------------

    Module for CS4231 sound chips found on Sparcs.

    Module supports up to 8 cards.

  Module snd-wavefront
  --------------------

    Module for Turtle Beach Maui, Tropez and Tropez+ soundcards.

    cs4232_pcm_port - Port # for CS4232 PCM interface.
    cs4232_pcm_irq  - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
    cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
    cs4232_mpu_irq  - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
    use_cs4232_midi - Use CS4232 MPU-401 interface
                      (inaccessibly located inside your computer)
    ics2115_port    - Port # for ICS2115
    ics2115_irq     - IRQ # for ICS2115
    fm_port         - FM OPL-3 Port #
    dma1            - DMA1 # for CS4232 PCM interface.
    dma2            - DMA2 # for CS4232 PCM interface.
    isapnp          - ISA PnP detection - 0 = disable, 1 = enable (default)

    Module supports up to 8 cards and ISA PnP.

  Module snd-sonicvibes
  ---------------------

    Module for S3 SonicVibes PCI soundcards.
			* PINE Schubert 32 PCI

    reverb    - Reverb Enable - 1 = enable, 0 = disable (default)
                  - SoundCard must have onboard SRAM for this.
    mge       - Mic Gain Enable - 1 = enable, 0 = disable (default)
    
    Module supports up to 8 cards and autoprobe.

  Module snd-serial-u16550
  ------------------------

    Module for UART16550A serial MIDI ports.

    port	- port # for UART16550A chip
    irq		- IRQ # for UART16550A chip, -1 = poll mode
    speed	- speed in bauds (9600,19200,38400,57600,115200)
		  38400 = default
    base	- base for divisor in bauds (57600,115200,230400,460800)
		  115200 = default
    outs	- number of MIDI ports in a serial port (1-4)
		  1 = default
    adaptor	- Type of adaptor.
                  0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
		  3 = MS-124W M/B, 4 = Generic
    
    Module supports up to 8 cards. This module does not support autoprobe
    thus the main port must be specified!!! Other options are optional.

  Module snd-trident
  ------------------

    Module for Trident 4DWave DX/NX soundcards.
			* Best Union  Miss Melody 4DWave PCI
			* HIS  4DWave PCI
			* Warpspeed  ONSpeed 4DWave PCI
			* AzTech  PCI 64-Q3D
			* Addonics  SV 750
			* CHIC  True Sound 4Dwave
			* Shark  Predator4D-PCI
			* Jaton  SonicWave 4D

    pcm_channels   - max channels (voices) reserved for PCM
    wavetable_size - max wavetable size in kB (4-?kb)

    Module supports up to 8 cards and autoprobe.

    The power-management is supported.

  Module snd-usb-audio
  --------------------

    Module for USB audio and USB MIDI devices.

    vid             - Vendor ID for the device (optional)
    pid             - Product ID for the device (optional)

    This module supports up to 8 cards, autoprobe and hotplugging.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
  Module snd-usb-usx2y
  --------------------

    Module for Tascam USB US-122, US-224 and US-428 devices.

    This module supports up to 8 cards, autoprobe and hotplugging.

    Note: you need to load the firmware via usx2yloader utility included
          in alsa-tools and alsa-firmware packages.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1164 1165 1166
  Module snd-via82xx
  ------------------

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1167 1168
    Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
    8233A, 8233C, 8235 (south) bridge.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1169 1170

    mpu_port	- 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1171
		  [VIA686A/686B only]
1172
    joystick	- Enable joystick (default off) [VIA686A/686B only]
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1173
    ac97_clock	- AC'97 codec clock base (default 48000Hz)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1174
    dxs_support	- support DXS channels,
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1175
		  0 = auto (defalut), 1 = enable, 2 = disable,
1176
		  3 = 48k only, 4 = no VRA
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1177
		  [VIA8233/C,8235 only]
1178 1179
    ac97_quirk  - AC'97 workaround for strange hardware
                  See the description of intel8x0 module for details.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1180 1181

    Module supports autoprobe and multiple bus-master chips (max 8).
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1182

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1183 1184 1185 1186 1187 1188
    Note: on some SMP motherboards like MSI 694D the interrupts might
          not be generated properly.  In such a case, please try to
          set the SMP (or MPS) version on BIOS to 1.1 instead of
          default value 1.4.  Then the interrupt number will be
          assigned under 15. You might also upgrade your BIOS.
    
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1189
    Note: VIA8233/5 (not VIA8233A) can support DXS (direct sound)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1190 1191
	  channels as the first PCM.  On these channels, up to 4
	  streams can be played at the same time.
1192 1193 1194 1195
	  As default (dxs_support = 0), 48k fixed rate is chosen
	  except for the known devices since the output is often
	  noisy except for 48k on some mother boards due to the
	  bug of BIOS.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1196
	  Please try once dxs_support=1 and if it works on other
1197 1198 1199 1200 1201 1202 1203 1204 1205
	  sample rates (e.g. 44.1kHz of mp3 playback), please let us
	  know the PCI subsystem vendor/device id's (output of
	  "lspci -nv").
	  If it doesn't work, try dxs_support=4.  If it still doesn't
	  work and the default setting is ok, dxs_support=3 is the
	  right choice.  If the default setting doesn't work at all,
	  try dxs_support=2 to disable the DXS channels.
	  In any cases, please let us know the result and the
	  subsystem vendor/device ids.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1206 1207

    Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1208
	  additonally.  The mpu_port option is for VIA686 chips only.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1209

1210 1211 1212 1213 1214 1215 1216 1217 1218
  Module snd-via82xx-modem
  ------------------------

    Module for VIA82xx AC97 modem

    ac97_clock	- AC'97 codec clock base (default 48000Hz)

    Module supports up to 8 cards.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
  Module snd-virmidi
  ------------------

    Module for virtual rawmidi devices.
    This module creates virtual rawmidi devices which communicate
    to the corresponding ALSA sequencer ports.

    midi_devs	- MIDI devices # (1-8, default=4)
    
    Module supports up to 8 cards.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1230 1231 1232 1233 1234 1235
  Module snd-vx222
  ----------------

    Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.

    mic		- Enable Microphone on V222 Mic (NYI)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1236
    ibl		- Capture IBL size. (default = 0, minimum size)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1237 1238 1239

    Module supports up to 8 cards.

1240 1241 1242 1243 1244 1245
    When the driver is compiled as a module and the hotplug firmware
    is supported, the firmware data is loaded via hotplug automatically.
    Install the necessary firmware files in alsa-firmware package.
    When no hotplug fw loader is available, you need to load the
    firmware via vxloader utility in alsa-tools package.  To invoke
    vxloader automatically, add the following to /etc/modprobe.conf
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1246

1247
	install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1248

1249
    (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1250
     /etc/modules.conf, instead.)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1251 1252 1253 1254 1255 1256
    IBL size defines the interrupts period for PCM.  The smaller size
    gives smaller latency but leads to more CPU consumption, too.
    The size is usually aligned to 126.  As default (=0), the smallest
    size is chosen.  The possible IBL values can be found in
    /proc/asound/cardX/vx-status proc file.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1257 1258 1259 1260 1261 1262
  Module snd-vxpocket
  -------------------

    Module for Digigram VX-Pocket VX2 PCMCIA card.

    irq_mask - IRQ bitmask, specifies the available IRQs as bits
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1263 1264
               (default = 0xffff, all available)
    irq_list - List of available interrupts (default = -1, not specified)
1265
               4 numbers must be given (if specified).
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1266
    ibl      - Capture IBL size. (default = 0, minimum size)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1267 1268 1269 1270 1271 1272 1273

    Module supports up to 8 cards.  The module is compiled only when
    PCMCIA is supported on kernel.

    To activate the driver via the card manager, you'll need to set
    up /etc/pcmcia/vxpocket.conf.  See the sound/pcmcia/vx/vxpocket.c.

1274 1275 1276 1277 1278
    When the driver is compiled as a module and the hotplug firmware
    is supported, the firmware data is loaded via hotplug automatically.
    Install the necessary firmware files in alsa-firmware package.
    When no hotplug fw loader is available, you need to load the
    firmware via vxloader utility in alsa-tools package.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1279

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1280 1281 1282 1283 1284
    The irq_mask and irq_list are provided to avoid allocation of
    specific IRQs.  Usually you don't need to specify them.

    About capture IBL, see the description of snd-vx222 module.

1285 1286
    Note: the driver is build only when CONFIG_ISA is set.
    
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1287 1288 1289 1290 1291 1292
  Module snd-vxp440
  -----------------

    Module for Digigram VX-Pocket 440 PCMCIA card.

    irq_mask - IRQ bitmask, specifies the available IRQs as bits
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1293
    irq_list - List of available interrupts (default = -1, not specified)
1294
               4 numbers must be given (if specified).
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1295
    ibl      - Capture IBL size. (default = 0, minimum size)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1296 1297 1298 1299 1300 1301 1302

    Module supports up to 8 cards.  The module is compiled only when
    PCMCIA is supported on kernel.

    To activate the driver via the card manager, you'll need to set
    up /etc/pcmcia/vxp440.conf.  See the sound/pcmcia/vx/vxp440.c.

1303 1304 1305 1306 1307
    When the driver is compiled as a module and the hotplug firmware
    is supported, the firmware data is loaded via hotplug automatically.
    Install the necessary firmware files in alsa-firmware package.
    When no hotplug fw loader is available, you need to load the
    firmware via vxloader utility in alsa-tools package.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1308

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1309 1310 1311 1312 1313
    The irq_mask and irq_list are provided to avoid allocation of
    specific IRQs.  Usually you don't need to specify them.

    About capture IBL, see the description of snd-vx222 module.

1314 1315
    Note: the driver is build only when CONFIG_ISA is set.
    
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1316 1317 1318 1319 1320
  Module snd-ymfpci
  -----------------

    Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).

1321 1322
    mpu_port      - 0x300,0x330,0x332,0x334, 0 (disable) by default,
                    1 (auto-detect for YMF744/754 only)
1323
    fm_port       - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1324
                    1 (auto-detect for YMF744/754 only)
1325 1326
    joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
                    1 (auto-detect)
1327
    rear_switch   - enable shared rear/line-in switch (bool)
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1328 1329

    Module supports autoprobe and multiple chips (max 8).
1330

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1331 1332
    The power-management is supported.

1333 1334 1335 1336 1337 1338 1339 1340 1341 1342
  Module snd-pdaudiocf
  --------------------

    Module for Sound Core PDAudioCF soundcard.

    irq_mask	  - IRQ mask (PCMCIA type)
    irq_list	  - List of available interrupts for this soundcard

    Note: the driver is build only when CONFIG_ISA is set.

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1343

Jaroslav Kysela's avatar
Jaroslav Kysela committed
1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
Configuring Non-ISAPNP Cards
============================

When the kernel is configured with ISA-PnP support, the modules
supporting the isapnp cards will have module options "isapnp".
If this option is set, *only* the ISA-PnP devices will be probed.
For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
together with the proper i/o and irq configuration.

When the kernel is configured without ISA-PnP support, isapnp option
will be not built in.


1357 1358
Module Autoloading Support
==========================
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1359

1360 1361 1362
The ALSA drivers can be loaded automatically on demand by defining
module aliases.  The string 'snd-card-%1' is requested for ALSA native
devices where %i is soundcard number from zero to seven.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1363

1364 1365 1366 1367
To auto-load an ALSA driver for OSS services, define the string
'sound-slot-%i' where %i means the slot number for OSS, which
corresponds to the card index of ALSA.  Usually, define this
as the the same card module.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1368

1369 1370 1371 1372 1373
An example configuration for a single emu10k1 card is like below:
----- /etc/modprobe.conf
alias snd-card-0 snd-emu10k1
alias sound-slot-0 snd-emu10k1
----- /etc/modprobe.conf
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1374

1375 1376 1377 1378
The available number of auto-loaded soundcards depends on the module
option "cards_limit" of snd module.  As default it's set to 1.
To enable the auto-loading of multiple cards, specify the number of
soundcards in that option.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1379

1380 1381 1382
When multiple cards are available, it'd better to specify the index
number for each card via module option, too, so that the order of
cards is kept consistent.
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1383

1384
An example configuration for two soundcards is like below:
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1385

1386
----- /etc/modprobe.conf
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1387
# ALSA portion
1388
options snd cards_limit=2
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1389 1390
alias snd-card-0 snd-interwave
alias snd-card-1 snd-ens1371
1391 1392
options snd-interwave index=0
options snd-ens1371 index=1
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1393
# OSS/Free portion
1394 1395 1396
alias sound-slot-0 snd-interwave
alias sound-slot-1 snd-ens1371
----- /etc/moprobe.conf
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1397

1398 1399
In this example, the interwave card is always loaded as the first card
(index 0) and ens1371 as the second (index 1).
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454


ALSA PCM devices to OSS devices mapping
=======================================

/dev/snd/pcmC0D0  -> /dev/audio0 (/dev/audio) -> minor 4
/dev/snd/pcmC0D0  -> /dev/dsp0 (/dev/dsp)     -> minor 3
/dev/snd/pcmC0D1  -> /dev/adsp0 (/dev/adsp)   -> minor 12
/dev/snd/pcmC1D0  -> /dev/audio1              -> minor 4+16 = 20
/dev/snd/pcmC1D0  -> /dev/dsp1                -> minor 3+16 = 19
/dev/snd/pcmC1D1  -> /dev/adsp1               -> minor 12+16 = 28
/dev/snd/pcmC2D0  -> /dev/audio2              -> minor 4+32 = 36
/dev/snd/pcmC2D0  -> /dev/dsp2                -> minor 3+32 = 39
/dev/snd/pcmC2D1  -> /dev/adsp2               -> minor 12+32 = 44

The first number from /dev/snd/pcmC{X}D{Y} expression means soundcard number
and second means device number.
Please note that the device mapping above may be varied via the module
options of snd-pcm-oss module.


DEVFS support
=============

The ALSA driver fully supports the devfs extension.
You should add lines below to your devfsd.conf file:

LOOKUP snd MODLOAD ACTION snd
REGISTER ^sound/.* PERMISSIONS root.audio 660
REGISTER ^snd/.* PERMISSIONS root.audio 660

Warning: These lines assume that you have the audio group in your system.
         Otherwise replace audio word with another group name (root for
         example).


Proc interfaces (/proc/asound)
==============================

/proc/asound/card#/pcm#[cp]/oss
-------------------------------
  String "erase" - erase all additional informations about OSS applications
  String "<app_name> <fragments> <fragment_size> [<options>]"

   <app_name> - name of application with (higher priority) or without path
   <fragments> - number of fragments or zero if auto
   <fragment_size> - size of fragment in bytes or zero if auto
   <options> - optional parameters
	  - disable   the application tries to open a pcm device for
		      this channel but does not want to use it.
		      (Cause a bug or mmap needs)
		      It's good for Quake etc...
	  - direct    don't use plugins
	  - block     force block mode (rvplayer)
	  - non-block force non-block mode
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1455 1456 1457
	  - whole-frag  write only whole fragments (optimization affecting
			playback only)
	  - no-silence  do not fill silence ahead to avoid clicks
Jaroslav Kysela's avatar
Jaroslav Kysela committed
1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469

  Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
           echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
	   echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss


Links
=====

  ALSA project homepage
       http://www.alsa-project.org