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