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