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