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