[ALSA] Remove snd_legacy_auto_probe()
[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.
60 device_mode
61 - permission mask for dynamic sound device filesystem
62 - This is available only when DEVFS is enabled
63 - Default: 0666
64 - E.g.: device_mode=0660
65
66
67 Module snd-pcm-oss
68 ------------------
69
70 The PCM OSS emulation module.
71 This module takes options which change the mapping of devices.
72
73 dsp_map - PCM device number maps assigned to the 1st OSS device.
74 - Default: 0
75 adsp_map - PCM device number maps assigned to the 2st OSS device.
76 - Default: 1
77 nonblock_open
6243008b 78 - Don't block opening busy PCM devices. Default: 1
1da177e4
LT
79
80 For example, when dsp_map=2, /dev/dsp will be mapped to PCM #2 of
81 the card #0. Similarly, when adsp_map=0, /dev/adsp will be mapped
82 to PCM #0 of the card #0.
83 For changing the second or later card, specify the option with
84 commas, such like "dsp_map=0,1".
85
86 nonblock_open option is used to change the behavior of the PCM
87 regarding opening the device. When this option is non-zero,
88 opening a busy OSS PCM device won't be blocked but return
89 immediately with EAGAIN (just like O_NONBLOCK flag).
90
91 Module snd-rawmidi
92 ------------------
93
94 This module takes options which change the mapping of devices.
95 similar to those of the snd-pcm-oss module.
96
97 midi_map - MIDI device number maps assigned to the 1st OSS device.
98 - Default: 0
99 amidi_map - MIDI device number maps assigned to the 2st OSS device.
100 - Default: 1
101
102 Common parameters for top sound card modules
103 --------------------------------------------
104
105 Each of top level sound card module takes the following options.
106
107 index - index (slot #) of sound card
108 - Values: 0 through 7 or negative
109 - If nonnegative, assign that index number
110 - if negative, interpret as a bitmask of permissible
111 indices; the first free permitted index is assigned
112 - Default: -1
113 id - card ID (identifier or name)
114 - Can be up to 15 characters long
115 - Default: the card type
116 - A directory by this name is created under /proc/asound/
117 containing information about the card
118 - This ID can be used instead of the index number in
119 identifying the card
120 enable - enable card
121 - Default: enabled, for PCI and ISA PnP cards
122
123 Module snd-ad1816a
124 ------------------
125
126 Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips.
127
128 port - port # for AD1816A chip (PnP setup)
129 mpu_port - port # for MPU-401 UART (PnP setup)
130 fm_port - port # for OPL3 (PnP setup)
131 irq - IRQ # for AD1816A chip (PnP setup)
132 mpu_irq - IRQ # for MPU-401 UART (PnP setup)
133 dma1 - first DMA # for AD1816A chip (PnP setup)
134 dma2 - second DMA # for AD1816A chip (PnP setup)
506d4c6a 135 clockfreq - Clock frequency for AD1816A chip (default = 0, 33000Hz)
1da177e4
LT
136
137 Module supports up to 8 cards, autoprobe and PnP.
138
139 Module snd-ad1848
140 -----------------
141
142 Module for sound cards based on AD1848/AD1847/CS4248 ISA chips.
143
144 port - port # for AD1848 chip
145 irq - IRQ # for AD1848 chip
146 dma1 - DMA # for AD1848 chip (0,1,3)
147
148 Module supports up to 8 cards. This module does not support autoprobe
149 thus main port must be specified!!! Other ports are optional.
150
84010e6f
CL
151 Module snd-ad1889
152 -----------------
153
154 Module for Analog Devices AD1889 chips.
155
156 ac97_quirk - AC'97 workaround for strange hardware
157 See the description of intel8x0 module for details.
158
159 This module supports up to 8 cards.
160
1da177e4
LT
161 Module snd-ali5451
162 ------------------
163
164 Module for ALi M5451 PCI chip.
165
166 pcm_channels - Number of hardware channels assigned for PCM
167 spdif - Support SPDIF I/O
168 - Default: disabled
169
8a3fb4d0 170 This module supports one chip and autoprobe.
1da177e4
LT
171
172 The power-management is supported.
173
174 Module snd-als100
175 -----------------
176
177 Module for sound cards based on Avance Logic ALS100/ALS120 ISA chips.
178
179 port - port # for ALS100 (SB16) chip (PnP setup)
180 irq - IRQ # for ALS100 (SB16) chip (PnP setup)
181 dma8 - 8-bit DMA # for ALS100 (SB16) chip (PnP setup)
182 dma16 - 16-bit DMA # for ALS100 (SB16) chip (PnP setup)
183 mpu_port - port # for MPU-401 UART (PnP setup)
184 mpu_irq - IRQ # for MPU-401 (PnP setup)
185 fm_port - port # for OPL3 FM (PnP setup)
186
187 Module supports up to 8 cards, autoprobe and PnP.
188
189 Module snd-als4000
190 ------------------
191
192 Module for sound cards based on Avance Logic ALS4000 PCI chip.
193
194 joystick_port - port # for legacy joystick support.
195 0 = disabled (default), 1 = auto-detect
196
197 Module supports up to 8 cards, autoprobe and PnP.
198
199 Module snd-atiixp
200 -----------------
201
6243008b 202 Module for ATI IXP 150/200/250/400 AC97 controllers.
1da177e4 203
6243008b 204 ac97_clock - AC'97 clock (default = 48000)
1da177e4 205 ac97_quirk - AC'97 workaround for strange hardware
6243008b 206 See "AC97 Quirk Option" section below.
1da177e4
LT
207 spdif_aclink - S/PDIF transfer over AC-link (default = 1)
208
b7fe4622 209 This module supports one card and autoprobe.
1da177e4 210
6243008b
TI
211 ATI IXP has two different methods to control SPDIF output. One is
212 over AC-link and another is over the "direct" SPDIF output. The
213 implementation depends on the motherboard, and you'll need to
214 choose the correct one via spdif_aclink module option.
215
1da177e4
LT
216 Module snd-atiixp-modem
217 -----------------------
218
219 Module for ATI IXP 150/200/250 AC97 modem controllers.
220
b7fe4622 221 This module supports one card and autoprobe.
1da177e4
LT
222
223 Note: The default index value of this module is -2, i.e. the first
224 slot is excluded.
225
226 Module snd-au8810, snd-au8820, snd-au8830
227 -----------------------------------------
228
229 Module for Aureal Vortex, Vortex2 and Advantage device.
230
231 pcifix - Control PCI workarounds
232 0 = Disable all workarounds
233 1 = Force the PCI latency of the Aureal card to 0xff
234 2 = Force the Extend PCI#2 Internal Master for Efficient
235 Handling of Dummy Requests on the VIA KT133 AGP Bridge
236 3 = Force both settings
237 255 = Autodetect what is required (default)
238
239 This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
240 EQ, mpu401, gameport. A3D and wavetable support are still in development.
241 Development and reverse engineering work is being coordinated at
242 http://savannah.nongnu.org/projects/openvortex/
243 SPDIF output has a copy of the AC97 codec output, unless you use the
244 "spdif" pcm device, which allows raw data passthru.
245 The hardware EQ hardware and SPDIF is only present in the Vortex2 and
246 Advantage.
247
6243008b 248 Note: Some ALSA mixer applications don't handle the SPDIF sample rate
1da177e4
LT
249 control correctly. If you have problems regarding this, try
250 another ALSA compliant mixer (alsamixer works).
251
252 Module snd-azt2320
253 ------------------
254
255 Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
256
257 port - port # for AZT2320 chip (PnP setup)
258 wss_port - port # for WSS (PnP setup)
259 mpu_port - port # for MPU-401 UART (PnP setup)
260 fm_port - FM port # for AZT2320 chip (PnP setup)
261 irq - IRQ # for AZT2320 (WSS) chip (PnP setup)
262 mpu_irq - IRQ # for MPU-401 UART (PnP setup)
263 dma1 - 1st DMA # for AZT2320 (WSS) chip (PnP setup)
264 dma2 - 2nd DMA # for AZT2320 (WSS) chip (PnP setup)
265
266 Module supports up to 8 cards, PnP and autoprobe.
267
268 Module snd-azt3328
269 ------------------
270
271 Module for sound cards based on Aztech AZF3328 PCI chip.
272
273 joystick - Enable joystick (default off)
274
275 Module supports up to 8 cards.
276
277 Module snd-bt87x
278 ----------------
279
280 Module for video cards based on Bt87x chips.
281
282 digital_rate - Override the default digital rate (Hz)
283 load_all - Load the driver even if the card model isn't known
284
285 Module supports up to 8 cards.
286
287 Note: The default index value of this module is -2, i.e. the first
288 slot is excluded.
289
290 Module snd-ca0106
291 -----------------
292
293 Module for Creative Audigy LS and SB Live 24bit
294
295 Module supports up to 8 cards.
296
297
298 Module snd-cmi8330
299 ------------------
300
301 Module for sound cards based on C-Media CMI8330 ISA chips.
302
303 wssport - port # for CMI8330 chip (WSS)
304 wssirq - IRQ # for CMI8330 chip (WSS)
305 wssdma - first DMA # for CMI8330 chip (WSS)
306 sbport - port # for CMI8330 chip (SB16)
307 sbirq - IRQ # for CMI8330 chip (SB16)
308 sbdma8 - 8bit DMA # for CMI8330 chip (SB16)
309 sbdma16 - 16bit DMA # for CMI8330 chip (SB16)
310
311 Module supports up to 8 cards and autoprobe.
312
313 Module snd-cmipci
314 -----------------
315
316 Module for C-Media CMI8338 and 8738 PCI sound cards.
317
318 mpu_port - 0x300,0x310,0x320,0x330, 0 = disable (default)
319 fm_port - 0x388 (default), 0 = disable (default)
6243008b 320 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
1da177e4
LT
321 (default = 1)
322 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
323
324 Module supports autoprobe and multiple chips (max 8).
325
326 Module snd-cs4231
327 -----------------
328
329 Module for sound cards based on CS4231 ISA chips.
330
331 port - port # for CS4231 chip
332 mpu_port - port # for MPU-401 UART (optional), -1 = disable
333 irq - IRQ # for CS4231 chip
334 mpu_irq - IRQ # for MPU-401 UART
335 dma1 - first DMA # for CS4231 chip
336 dma2 - second DMA # for CS4231 chip
337
338 Module supports up to 8 cards. This module does not support autoprobe
339 thus main port must be specified!!! Other ports are optional.
340
341 The power-management is supported.
342
343 Module snd-cs4232
344 -----------------
345
346 Module for sound cards based on CS4232/CS4232A ISA chips.
347
348 port - port # for CS4232 chip (PnP setup - 0x534)
349 cport - control port # for CS4232 chip (PnP setup - 0x120,0x210,0xf00)
350 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
351 fm_port - FM port # for CS4232 chip (PnP setup - 0x388), -1 = disable
352 irq - IRQ # for CS4232 chip (5,7,9,11,12,15)
353 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
354 dma1 - first DMA # for CS4232 chip (0,1,3)
355 dma2 - second DMA # for Yamaha CS4232 chip (0,1,3), -1 = disable
356 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
357
358 Module supports up to 8 cards. This module does not support autoprobe
359 thus main port must be specified!!! Other ports are optional.
360
361 The power-management is supported.
362
363 Module snd-cs4236
364 -----------------
365
366 Module for sound cards based on CS4235/CS4236/CS4236B/CS4237B/
367 CS4238B/CS4239 ISA chips.
368
369 port - port # for CS4236 chip (PnP setup - 0x534)
370 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
371 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
372 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
373 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
374 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
375 dma1 - first DMA # for CS4236 chip (0,1,3)
376 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
377 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
378
379 Module supports up to 8 cards. This module does not support autoprobe
380 (if ISA PnP is not used) thus main port and control port must be
381 specified!!! Other ports are optional.
382
383 The power-management is supported.
384
385 Module snd-cs4281
386 -----------------
387
388 Module for Cirrus Logic CS4281 soundchip.
389
390 dual_codec - Secondary codec ID (0 = disable, default)
391
392 Module supports up to 8 cards.
393
394 The power-management is supported.
395
396 Module snd-cs46xx
397 -----------------
398
399 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
400 CS4624/CS4630/CS4280 PCI chips.
401
6243008b 402 external_amp - Force to enable external amplifier.
1da177e4
LT
403 thinkpad - Force to enable Thinkpad's CLKRUN control.
404 mmap_valid - Support OSS mmap mode (default = 0).
405
406 Module supports up to 8 cards and autoprobe.
407 Usually external amp and CLKRUN controls are detected automatically
408 from PCI sub vendor/device ids. If they don't work, give the options
409 above explicitly.
410
411 The power-management is supported.
412
3e873174
TI
413 Module snd-cs5535audio
414 ----------------------
415
416 Module for multifunction CS5535 companion PCI device
417
418 Module supports up to 8 cards.
419
1da177e4
LT
420 Module snd-dt019x
421 -----------------
422
423 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
424 only)
425
426 port - Port # (PnP setup)
427 mpu_port - Port # for MPU-401 (PnP setup)
428 fm_port - Port # for FM OPL-3 (PnP setup)
429 irq - IRQ # (PnP setup)
430 mpu_irq - IRQ # for MPU-401 (PnP setup)
431 dma8 - DMA # (PnP setup)
432
433 Module supports up to 8 cards. This module is enabled only with
434 ISA PnP support.
435
436 Module snd-dummy
437 ----------------
438
439 Module for the dummy sound card. This "card" doesn't do any output
440 or input, but you may use this module for any application which
441 requires a sound card (like RealPlayer).
442
443 Module snd-emu10k1
444 ------------------
445
446 Module for EMU10K1/EMU10k2 based PCI sound cards.
447 * Sound Blaster Live!
448 * Sound Blaster PCI 512
449 * Emu APS (partially supported)
450 * Sound Blaster Audigy
451
452 extin - bitmap of available external inputs for FX8010 (see bellow)
453 extout - bitmap of available external outputs for FX8010 (see bellow)
454 seq_ports - allocated sequencer ports (4 by default)
455 max_synth_voices - limit of voices used for wavetable (64 by default)
456 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
457 given in MB unit. Default value is 128.
458 enable_ir - enable IR
459
460 Module supports up to 8 cards and autoprobe.
461
462 Input & Output configurations [extin/extout]
463 * Creative Card wo/Digital out [0x0003/0x1f03]
464 * Creative Card w/Digital out [0x0003/0x1f0f]
465 * Creative Card w/Digital CD in [0x000f/0x1f0f]
466 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
467 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
468 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
469 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
470 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
471 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
472 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
473 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
474 * Creative Card all ins and outs [0x3fff/0x7fff]
475
476 Module snd-emu10k1x
477 -------------------
478
479 Module for Creative Emu10k1X (SB Live Dell OEM version)
480
481 Module supports up to 8 cards.
482
483 Module snd-ens1370
484 ------------------
485
486 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
487 * SoundBlaster PCI 64
488 * SoundBlaster PCI 128
489
490 joystick - Enable joystick (default off)
491
492 Module supports up to 8 cards and autoprobe.
493
494 Module snd-ens1371
495 ------------------
496
497 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
498 * SoundBlaster PCI 64
499 * SoundBlaster PCI 128
500 * SoundBlaster Vibra PCI
501
502 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
503 0 = disable (default), 1 = auto-detect
504
505 Module supports up to 8 cards and autoprobe.
506
507 Module snd-es968
508 ----------------
509
510 Module for sound cards based on ESS ES968 chip (PnP only).
511
512 port - port # for ES968 (SB8) chip (PnP setup)
513 irq - IRQ # for ES968 (SB8) chip (PnP setup)
514 dma1 - DMA # for ES968 (SB8) chip (PnP setup)
515
516 Module supports up to 8 cards, PnP and autoprobe.
517
518 Module snd-es1688
519 -----------------
520
521 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
522
523 port - port # for ES-1688 chip (0x220,0x240,0x260)
524 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
525 irq - IRQ # for ES-1688 chip (5,7,9,10)
526 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
527 dma8 - DMA # for ES-1688 chip (0,1,3)
528
529 Module supports up to 8 cards and autoprobe (without MPU-401 port).
530
531 Module snd-es18xx
532 -----------------
533
534 Module for ESS AudioDrive ES-18xx sound cards.
535
536 port - port # for ES-18xx chip (0x220,0x240,0x260)
537 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
538 fm_port - port # for FM (optional, not used)
539 irq - IRQ # for ES-18xx chip (5,7,9,10)
540 dma1 - first DMA # for ES-18xx chip (0,1,3)
541 dma2 - first DMA # for ES-18xx chip (0,1,3)
542 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
543
544 Module supports up to 8 cards ISA PnP and autoprobe (without MPU-401 port
545 if native ISA PnP routines are not used).
546 When dma2 is equal with dma1, the driver works as half-duplex.
547
548 The power-management is supported.
549
550 Module snd-es1938
551 -----------------
552
553 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
554
555 Module supports up to 8 cards and autoprobe.
556
557 Module snd-es1968
558 -----------------
559
560 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
561
562 total_bufsize - total buffer size in kB (1-4096kB)
563 pcm_substreams_p - playback channels (1-8, default=2)
564 pcm_substreams_c - capture channels (1-8, default=0)
565 clock - clock (0 = auto-detection)
566 use_pm - support the power-management (0 = off, 1 = on,
567 2 = auto (default))
568 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
569 joystick - enable joystick (default off)
570
571 Module supports up to 8 cards and autoprobe.
572
573 The power-management is supported.
574
575 Module snd-fm801
576 ----------------
577
578 Module for ForteMedia FM801 based PCI sound cards.
579
580 tea575x_tuner - Enable TEA575x tuner
581 - 1 = MediaForte 256-PCS
582 - 2 = MediaForte 256-PCPR
583 - 3 = MediaForte 64-PCR
584 - High 16-bits are video (radio) device number + 1
585 - example: 0x10002 (MediaForte 256-PCPR, device 1)
586
587 Module supports up to 8 cards and autoprobe.
588
589 Module snd-gusclassic
590 ---------------------
591
592 Module for Gravis UltraSound Classic sound card.
593
594 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
595 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
596 dma1 - DMA # for GF1 chip (1,3,5,6,7)
597 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
598 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
599 voices - GF1 voices limit (14-32)
600 pcm_voices - reserved PCM voices
601
602 Module supports up to 8 cards and autoprobe.
603
604 Module snd-gusextreme
605 ---------------------
606
607 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
608
609 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
610 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
611 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
612 irq - IRQ # for ES-1688 chip (5,7,9,10)
613 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
614 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
615 dma8 - DMA # for ES-1688 chip (0,1,3)
616 dma1 - DMA # for GF1 chip (1,3,5,6,7)
617 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
618 voices - GF1 voices limit (14-32)
619 pcm_voices - reserved PCM voices
620
621 Module supports up to 8 cards and autoprobe (without MPU-401 port).
622
623 Module snd-gusmax
624 -----------------
625
626 Module for Gravis UltraSound MAX sound card.
627
628 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
629 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
630 dma1 - DMA # for GF1 chip (1,3,5,6,7)
631 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
632 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
633 voices - GF1 voices limit (14-32)
634 pcm_voices - reserved PCM voices
635
636 Module supports up to 8 cards and autoprobe.
637
638 Module snd-hda-intel
639 --------------------
640
fc20a562
TI
641 Module for Intel HD Audio (ICH6, ICH6M, ICH7), ATI SB450,
642 VIA VT8251/VT8237A
1da177e4
LT
643
644 model - force the model name
6243008b 645 position_fix - Fix DMA pointer (0 = auto, 1 = none, 2 = POSBUF, 3 = FIFO size)
1da177e4 646
b7fe4622 647 This module supports one card and autoprobe.
1da177e4
LT
648
649 Each codec may have a model table for different configurations.
650 If your machine isn't listed there, the default (usually minimal)
651 configuration is set up. You can pass "model=<name>" option to
652 specify a certain model in such a case. There are different
653 models depending on the codec chip.
654
655 Model name Description
656 ---------- -----------
657 ALC880
658 3stack 3-jack in back and a headphone out
659 3stack-digout 3-jack in back, a HP out and a SPDIF out
660 5stack 5-jack in back, 2-jack in front
661 5stack-digout 5-jack in back, 2-jack in front, a SPDIF out
b6482d48
TI
662 6stack 6-jack in back, 2-jack in front
663 6stack-digout 6-jack with a SPDIF out
1da177e4 664 w810 3-jack
dfc0ff62 665 z71v 3-jack (HP shared SPDIF)
e9edcee0
TI
666 asus 3-jack
667 uniwill 3-jack
668 F1734 2-jack
b6482d48
TI
669 test for testing/debugging purpose, almost all controls can be
670 adjusted. Appearing only when compiled with
671 $CONFIG_SND_DEBUG=y
1da177e4 672
21be3d16
TI
673 ALC260
674 hp HP machines
675 fujitsu Fujitsu S7020
676
1da177e4
LT
677 CMI9880
678 minimal 3-jack in back
679 min_fp 3-jack in back, 2-jack in front
680 full 6-jack in back, 2-jack in front
681 full_dig 6-jack in back, 2-jack in front, SPDIF I/O
682 allout 5-jack in back, 2-jack in front, SPDIF out
e9edcee0 683 auto auto-config reading BIOS (default)
1da177e4 684
6243008b
TI
685 If the default configuration doesn't work and one of the above
686 matches with your device, report it together with the PCI
687 subsystem ID (output of "lspci -nv") to ALSA BTS or alsa-devel
688 ML (see the section "Links and Addresses").
689
c74db86b
TI
690 Note 2: If you get click noises on output, try the module option
691 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
692 register value without FIFO size correction as the current
693 DMA pointer. position_fix=2 will make the driver to use
694 the position buffer instead of reading SD_LPIB register.
695 (Usually SD_LPLIB register is more accurate than the
696 position buffer.)
697
1da177e4
LT
698 Module snd-hdsp
699 ---------------
700
701 Module for RME Hammerfall DSP audio interface(s)
702
703 Module supports up to 8 cards.
704
705 Note: The firmware data can be automatically loaded via hotplug
706 when CONFIG_FW_LOADER is set. Otherwise, you need to load
707 the firmware via hdsploader utility included in alsa-tools
708 package.
709 The firmware data is found in alsa-firmware package.
710
711 Note: snd-page-alloc module does the job which snd-hammerfall-mem
712 module did formerly. It will allocate the buffers in advance
713 when any HDSP cards are found. To make the buffer
714 allocation sure, load snd-page-alloc module in the early
b6a96915
TI
715 stage of boot sequence. See "Early Buffer Allocation"
716 section.
1da177e4 717
5470440a
TI
718 Module snd-hdspm
719 ----------------
720
721 Module for RME HDSP MADI board.
722
723 precise_ptr - Enable precise pointer, or disable.
724 line_outs_monitor - Send playback streams to analog outs by default.
725 enable_monitor - Enable Analog Out on Channel 63/64 by default.
726
727 See hdspm.txt for details.
728
1da177e4
LT
729 Module snd-ice1712
730 ------------------
731
732 Module for Envy24 (ICE1712) based PCI sound cards.
733 * MidiMan M Audio Delta 1010
734 * MidiMan M Audio Delta 1010LT
735 * MidiMan M Audio Delta DiO 2496
736 * MidiMan M Audio Delta 66
737 * MidiMan M Audio Delta 44
738 * MidiMan M Audio Delta 410
739 * MidiMan M Audio Audiophile 2496
740 * TerraTec EWS 88MT
741 * TerraTec EWS 88D
742 * TerraTec EWX 24/96
743 * TerraTec DMX 6Fire
c9bce91f 744 * TerraTec Phase 88
1da177e4
LT
745 * Hoontech SoundTrack DSP 24
746 * Hoontech SoundTrack DSP 24 Value
747 * Hoontech SoundTrack DSP 24 Media 7.1
c9bce91f 748 * Event Electronics, EZ8
1da177e4 749 * Digigram VX442
c9bce91f 750 * Lionstracs, Mediastaton
1da177e4
LT
751
752 model - Use the given board model, one of the following:
753 delta1010, dio2496, delta66, delta44, audiophile, delta410,
754 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
c9bce91f
TI
755 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
756 phase88, mediastation
1da177e4
LT
757 omni - Omni I/O support for MidiMan M-Audio Delta44/66
758 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transciever)
759 in msec resolution, default value is 500 (0.5 sec)
760
761 Module supports up to 8 cards and autoprobe. Note: The consumer part
762 is not used with all Envy24 based cards (for example in the MidiMan Delta
763 serie).
764
c9bce91f
TI
765 Note: The supported board is detected by reading EEPROM or PCI
766 SSID (if EEPROM isn't available). You can override the
767 model by passing "model" module option in case that the
768 driver isn't configured properly or you want to try another
769 type for testing.
770
1da177e4
LT
771 Module snd-ice1724
772 ------------------
773
c9bce91f 774 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
1da177e4
LT
775 * MidiMan M Audio Revolution 7.1
776 * AMP Ltd AUDIO2000
c9bce91f
TI
777 * TerraTec Aureon 5.1 Sky
778 * TerraTec Aureon 7.1 Space
779 * TerraTec Aureon 7.1 Universe
780 * TerraTec Phase 22
781 * TerraTec Phase 28
782 * AudioTrak Prodigy 7.1
783 * AudioTrak Prodigy 192
784 * Pontis MS300
785 * Albatron K8X800 Pro II
786 * Chaintech ZNF3-150
787 * Chaintech ZNF3-250
788 * Chaintech 9CJS
8cfbbac6 789 * Chaintech AV-710
c9bce91f 790 * Shuttle SN25P
1da177e4
LT
791
792 model - Use the given board model, one of the following:
c9bce91f 793 revo71, amp2000, prodigy71, prodigy192, aureon51,
8cfbbac6
TI
794 aureon71, universe, k8x800, phase22, phase28, ms300,
795 av710
1da177e4
LT
796
797 Module supports up to 8 cards and autoprobe.
798
c9bce91f
TI
799 Note: The supported board is detected by reading EEPROM or PCI
800 SSID (if EEPROM isn't available). You can override the
801 model by passing "model" module option in case that the
802 driver isn't configured properly or you want to try another
803 type for testing.
804
1da177e4
LT
805 Module snd-intel8x0
806 -------------------
807
808 Module for AC'97 motherboards from Intel and compatibles.
809 * Intel i810/810E, i815, i820, i830, i84x, MX440
810 * SiS 7012 (SiS 735)
811 * NVidia NForce, NForce2
812 * AMD AMD768, AMD8111
813 * ALi m5455
814
815 ac97_clock - AC'97 codec clock base (0 = auto-detect)
816 ac97_quirk - AC'97 workaround for strange hardware
6243008b 817 See "AC97 Quirk Option" section below.
1da177e4 818 buggy_irq - Enable workaround for buggy interrupts on some
a06147d2
TI
819 motherboards (default yes on nForce chips,
820 otherwise off)
821 buggy_semaphore - Enable workaround for hardwares with buggy
822 semaphores (e.g. on some ASUS laptops)
823 (default off)
1da177e4 824
b7fe4622 825 This module supports one chip and autoprobe.
1da177e4
LT
826
827 Note: the latest driver supports auto-detection of chip clock.
828 if you still encounter too fast playback, specify the clock
829 explicitly via the module option "ac97_clock=41194".
830
831 Joystick/MIDI ports are not supported by this driver. If your
832 motherboard has these devices, use the ns558 or snd-mpu401
833 modules, respectively.
834
1da177e4
LT
835 The power-management is supported.
836
837 Module snd-intel8x0m
838 --------------------
839
840 Module for Intel ICH (i8x0) chipset MC97 modems.
841
842 ac97_clock - AC'97 codec clock base (0 = auto-detect)
843
b7fe4622 844 This module supports one card and autoprobe.
1da177e4
LT
845
846 Note: The default index value of this module is -2, i.e. the first
847 slot is excluded.
848
849 Module snd-interwave
850 --------------------
851
852 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
853 and other sound cards based on AMD InterWave (tm) chip.
854
855 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
856 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
857 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
858 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
859 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
860 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
861 pcm_voices - reserved PCM voices for the synthesizer (default 2)
862 effect - 1 = InterWave effects enable (default 0);
863 requires 8 voices
864
865 Module supports up to 8 cards, autoprobe and ISA PnP.
866
867 Module snd-interwave-stb
868 ------------------------
869
870 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
871 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
872 circuit for extended control of bass, treble and master volume.
873
874 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
875 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
876 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
877 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
878 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
879 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
880 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
881 pcm_voices - reserved PCM voices for the synthesizer (default 2)
882 effect - 1 = InterWave effects enable (default 0);
883 requires 8 voices
884
885 Module supports up to 8 cards, autoprobe and ISA PnP.
886
887 Module snd-korg1212
888 -------------------
889
890 Module for Korg 1212 IO PCI card
891
892 Module supports up to 8 cards.
893
894 Module snd-maestro3
895 -------------------
896
897 Module for Allegro/Maestro3 chips
898
899 external_amp - enable external amp (enabled by default)
900 amp_gpio - GPIO pin number for external amp (0-15) or
901 -1 for default pin (8 for allegro, 1 for
902 others)
903
904 Module supports autoprobe and multiple chips (max 8).
905
906 Note: the binding of amplifier is dependent on hardware.
907 If there is no sound even though all channels are unmuted, try to
908 specify other gpio connection via amp_gpio option.
909 For example, a Panasonic notebook might need "amp_gpio=0x0d"
910 option.
911
912 The power-management is supported.
913
914 Module snd-mixart
915 -----------------
916
917 Module for Digigram miXart8 sound cards.
918
919 Module supports multiple cards.
920 Note: One miXart8 board will be represented as 4 alsa cards.
921 See MIXART.txt for details.
922
923 When the driver is compiled as a module and the hotplug firmware
924 is supported, the firmware data is loaded via hotplug automatically.
925 Install the necessary firmware files in alsa-firmware package.
926 When no hotplug fw loader is available, you need to load the
927 firmware via mixartloader utility in alsa-tools package.
928
929 Module snd-mpu401
930 -----------------
931
932 Module for MPU-401 UART devices.
933
934 port - port number or -1 (disable)
935 irq - IRQ number or -1 (disable)
936 pnp - PnP detection - 0 = disable, 1 = enable (default)
937
938 Module supports multiple devices (max 8) and PnP.
939
940 Module snd-mtpav
941 ----------------
942
943 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
944 port).
945
946 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
947 irq - IRQ # for MTPAV (7,5, default=7)
948 hwports - number of supported hardware ports, default=8.
949
950 Module supports only 1 card. This module has no enable option.
951
952 Module snd-nm256
953 ----------------
954
955 Module for NeoMagic NM256AV/ZX chips
956
957 playback_bufsize - max playback frame size in kB (4-128kB)
958 capture_bufsize - max capture frame size in kB (4-128kB)
959 force_ac97 - 0 or 1 (disabled by default)
960 buffer_top - specify buffer top address
961 use_cache - 0 or 1 (disabled by default)
962 vaio_hack - alias buffer_top=0x25a800
963 reset_workaround - enable AC97 RESET workaround for some laptops
d1f38cf9
TI
964 reset_workaround2 - enable extended AC97 RESET workaround for some
965 other laptops
1da177e4 966
8a3fb4d0 967 This module supports one chip and autoprobe.
1da177e4
LT
968
969 The power-management is supported.
970
971 Note: on some notebooks the buffer address cannot be detected
972 automatically, or causes hang-up during initialization.
973 In such a case, specify the buffer top address explicity via
974 buffer_top option.
975 For example,
976 Sony F250: buffer_top=0x25a800
977 Sony F270: buffer_top=0x272800
978 The driver supports only ac97 codec. It's possible to force
979 to initialize/use ac97 although it's not detected. In such a
980 case, use force_ac97=1 option - but *NO* guarantee whether it
981 works!
982
983 Note: The NM256 chip can be linked internally with non-AC97
984 codecs. This driver supports only the AC97 codec, and won't work
985 with machines with other (most likely CS423x or OPL3SAx) chips,
986 even though the device is detected in lspci. In such a case, try
987 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
6243008b 988 but some doesn't have ISA PnP. You'll need to specify isapnp=0
1da177e4
LT
989 and proper hardware parameters in the case without ISA PnP.
990
991 Note: some laptops need a workaround for AC97 RESET. For the
992 known hardware like Dell Latitude LS and Sony PCG-F305, this
993 workaround is enabled automatically. For other laptops with a
994 hard freeze, you can try reset_workaround=1 option.
995
d1f38cf9
TI
996 Note: Dell Latitude CSx laptops have another problem regarding
997 AC97 RESET. On these laptops, reset_workaround2 option is
998 turned on as default. This option is worth to try if the
999 previous reset_workaround option doesn't help.
1000
1da177e4
LT
1001 Note: This driver is really crappy. It's a porting from the
1002 OSS driver, which is a result of black-magic reverse engineering.
1003 The detection of codec will fail if the driver is loaded *after*
1004 X-server as described above. You might be able to force to load
1005 the module, but it may result in hang-up. Hence, make sure that
1006 you load this module *before* X if you encounter this kind of
1007 problem.
1008
1009 Module snd-opl3sa2
1010 ------------------
1011
1012 Module for Yamaha OPL3-SA2/SA3 sound cards.
1013
1014 port - control port # for OPL3-SA chip (0x370)
1015 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1016 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1017 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1018 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1019 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1020 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1021 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
1022 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1023
1024 Module supports up to 8 cards and ISA PnP. This module does not support
1025 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1026
1027 The power-management is supported.
1028
1029 Module snd-opti92x-ad1848
1030 -------------------------
1031
1032 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1033 Module works with OAK Mozart cards as well.
1034
1035 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1036 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1037 fm_port - port # for OPL3 device (0x388)
1038 irq - IRQ # for WSS chip (5,7,9,10,11)
1039 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1040 dma1 - first DMA # for WSS chip (0,1,3)
1041
1042 This module supports only one card, autoprobe and PnP.
1043
1044 Module snd-opti92x-cs4231
1045 -------------------------
1046
1047 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1048
1049 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1050 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1051 fm_port - port # for OPL3 device (0x388)
1052 irq - IRQ # for WSS chip (5,7,9,10,11)
1053 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1054 dma1 - first DMA # for WSS chip (0,1,3)
1055 dma2 - second DMA # for WSS chip (0,1,3)
1056
1057 This module supports only one card, autoprobe and PnP.
1058
1059 Module snd-opti93x
1060 ------------------
1061
1062 Module for sound cards based on OPTi 82c93x chips.
1063
1064 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1065 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1066 fm_port - port # for OPL3 device (0x388)
1067 irq - IRQ # for WSS chip (5,7,9,10,11)
1068 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1069 dma1 - first DMA # for WSS chip (0,1,3)
1070 dma2 - second DMA # for WSS chip (0,1,3)
1071
1072 This module supports only one card, autoprobe and PnP.
1073
1074 Module snd-powermac (on ppc only)
1075 ---------------------------------
1076
1077 Module for PowerMac, iMac and iBook on-board soundchips
1078
1079 enable_beep - enable beep using PCM (enabled as default)
1080
1081 Module supports autoprobe a chip.
1082
1083 Note: the driver may have problems regarding endianess.
1084
1085 The power-management is supported.
1086
2c484df0
TI
1087 Module snd-pxa2xx-ac97 (on arm only)
1088 ------------------------------------
1089
1090 Module for AC97 driver for the Intel PXA2xx chip
1091
1092 For ARM architecture only.
1093
1da177e4
LT
1094 Module snd-rme32
1095 ----------------
1096
1097 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1098 Prodif96 and Prodif Gold) sound cards.
1099
1100 Module supports up to 8 cards.
1101
1102 Module snd-rme96
1103 ----------------
1104
1105 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1106
1107 Module supports up to 8 cards.
1108
1109 Module snd-rme9652
1110 ------------------
1111
1112 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1113
1114 precise_ptr - Enable precise pointer (doesn't work reliably).
1115 (default = 0)
1116
1117 Module supports up to 8 cards.
1118
1119 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1120 module did formerly. It will allocate the buffers in advance
1121 when any RME9652 cards are found. To make the buffer
1122 allocation sure, load snd-page-alloc module in the early
b6a96915
TI
1123 stage of boot sequence. See "Early Buffer Allocation"
1124 section.
1da177e4
LT
1125
1126 Module snd-sa11xx-uda1341 (on arm only)
1127 ---------------------------------------
1128
1129 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1130
1131 Module supports only one card.
1132 Module has no enable and index options.
1133
1134 Module snd-sb8
1135 --------------
1136
1137 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1138 SoundBlaster 2.0,
1139 SoundBlaster Pro
1140
1141 port - port # for SB DSP chip (0x220,0x240,0x260)
1142 irq - IRQ # for SB DSP chip (5,7,9,10)
1143 dma8 - DMA # for SB DSP chip (1,3)
1144
1145 Module supports up to 8 cards and autoprobe.
1146
1147 Module snd-sb16 and snd-sbawe
1148 -----------------------------
1149
1150 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1151 SoundBlaster AWE 32 (PnP),
1152 SoundBlaster AWE 64 PnP
1153
1154 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1155 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1156 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1157 (snd-sbawe module only)
1158 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1159 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1160 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
1161 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1162 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1163 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1164
1165 Module supports up to 8 cards, autoprobe and ISA PnP.
1166
1167 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1168 disable 16bit DMA with dma16 = -1 module parameter.
1169 Also, all Sound Blaster 16 type cards can operate in 16-bit
1170 half duplex mode through 8-bit DMA channel by disabling their
1171 16-bit DMA channel.
1172
1173 Module snd-sgalaxy
1174 ------------------
1175
1176 Module for Aztech Sound Galaxy sound card.
1177
1178 sbport - Port # for SB16 interface (0x220,0x240)
1179 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1180 irq - IRQ # (7,9,10,11)
1181 dma1 - DMA #
1182
1183 Module supports up to 8 cards.
1184
1185 Module snd-sscape
1186 -----------------
1187
1188 Module for ENSONIQ SoundScape PnP cards.
1189
1190 port - Port # (PnP setup)
1191 irq - IRQ # (PnP setup)
1192 mpu_irq - MPU-401 IRQ # (PnP setup)
1193 dma - DMA # (PnP setup)
1194
1195 Module supports up to 8 cards. ISA PnP must be enabled.
1196 You need sscape_ctl tool in alsa-tools package for loading
1197 the microcode.
1198
1199 Module snd-sun-amd7930 (on sparc only)
1200 --------------------------------------
1201
1202 Module for AMD7930 sound chips found on Sparcs.
1203
1204 Module supports up to 8 cards.
1205
1206 Module snd-sun-cs4231 (on sparc only)
1207 -------------------------------------
1208
1209 Module for CS4231 sound chips found on Sparcs.
1210
1211 Module supports up to 8 cards.
1212
1bd9debf
TI
1213 Module snd-sun-dbri (on sparc only)
1214 -----------------------------------
1215
1216 Module for DBRI sound chips found on Sparcs.
1217
1218 Module supports up to 8 cards.
1219
1da177e4
LT
1220 Module snd-wavefront
1221 --------------------
1222
1223 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1224
1225 cs4232_pcm_port - Port # for CS4232 PCM interface.
1226 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1227 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1228 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
1229 use_cs4232_midi - Use CS4232 MPU-401 interface
1230 (inaccessibly located inside your computer)
1231 ics2115_port - Port # for ICS2115
1232 ics2115_irq - IRQ # for ICS2115
1233 fm_port - FM OPL-3 Port #
1234 dma1 - DMA1 # for CS4232 PCM interface.
1235 dma2 - DMA2 # for CS4232 PCM interface.
1236 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1237
1238 Module supports up to 8 cards and ISA PnP.
1239
1240 Module snd-sonicvibes
1241 ---------------------
1242
1243 Module for S3 SonicVibes PCI sound cards.
1244 * PINE Schubert 32 PCI
1245
1246 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1247 - SoundCard must have onboard SRAM for this.
1248 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1249
1250 Module supports up to 8 cards and autoprobe.
1251
1252 Module snd-serial-u16550
1253 ------------------------
1254
1255 Module for UART16550A serial MIDI ports.
1256
1257 port - port # for UART16550A chip
1258 irq - IRQ # for UART16550A chip, -1 = poll mode
1259 speed - speed in bauds (9600,19200,38400,57600,115200)
1260 38400 = default
1261 base - base for divisor in bauds (57600,115200,230400,460800)
1262 115200 = default
1263 outs - number of MIDI ports in a serial port (1-4)
1264 1 = default
1265 adaptor - Type of adaptor.
1266 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1267 3 = MS-124W M/B, 4 = Generic
1268
1269 Module supports up to 8 cards. This module does not support autoprobe
1270 thus the main port must be specified!!! Other options are optional.
1271
1272 Module snd-trident
1273 ------------------
1274
1275 Module for Trident 4DWave DX/NX sound cards.
1276 * Best Union Miss Melody 4DWave PCI
1277 * HIS 4DWave PCI
1278 * Warpspeed ONSpeed 4DWave PCI
1279 * AzTech PCI 64-Q3D
1280 * Addonics SV 750
1281 * CHIC True Sound 4Dwave
1282 * Shark Predator4D-PCI
1283 * Jaton SonicWave 4D
1284
1285 pcm_channels - max channels (voices) reserved for PCM
1286 wavetable_size - max wavetable size in kB (4-?kb)
1287
1288 Module supports up to 8 cards and autoprobe.
1289
1290 The power-management is supported.
1291
1292 Module snd-usb-audio
1293 --------------------
1294
1295 Module for USB audio and USB MIDI devices.
1296
1297 vid - Vendor ID for the device (optional)
1298 pid - Product ID for the device (optional)
1299
1300 This module supports up to 8 cards, autoprobe and hotplugging.
1301
1302 Module snd-usb-usx2y
1303 --------------------
1304
1305 Module for Tascam USB US-122, US-224 and US-428 devices.
1306
1307 This module supports up to 8 cards, autoprobe and hotplugging.
1308
1309 Note: you need to load the firmware via usx2yloader utility included
1310 in alsa-tools and alsa-firmware packages.
1311
1312 Module snd-via82xx
1313 ------------------
1314
1315 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
2d7eb7cb 1316 8233A, 8233C, 8235, 8237 (south) bridge.
1da177e4
LT
1317
1318 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1319 [VIA686A/686B only]
1320 joystick - Enable joystick (default off) [VIA686A/686B only]
1321 ac97_clock - AC'97 codec clock base (default 48000Hz)
1322 dxs_support - support DXS channels,
2d7eb7cb
SV
1323 0 = auto (default), 1 = enable, 2 = disable,
1324 3 = 48k only, 4 = no VRA, 5 = enable any sample
1325 rate and different sample rates on different
1326 channels
1327 [VIA8233/C, 8235, 8237 only]
1da177e4 1328 ac97_quirk - AC'97 workaround for strange hardware
6243008b 1329 See "AC97 Quirk Option" section below.
1da177e4 1330
b7fe4622 1331 This module supports one chip and autoprobe.
1da177e4
LT
1332
1333 Note: on some SMP motherboards like MSI 694D the interrupts might
1334 not be generated properly. In such a case, please try to
1335 set the SMP (or MPS) version on BIOS to 1.1 instead of
1336 default value 1.4. Then the interrupt number will be
1337 assigned under 15. You might also upgrade your BIOS.
1338
2d7eb7cb 1339 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
1da177e4 1340 channels as the first PCM. On these channels, up to 4
2d7eb7cb
SV
1341 streams can be played at the same time, and the controller
1342 can perform sample rate conversion with separate rates for
1343 each channel.
1da177e4
LT
1344 As default (dxs_support = 0), 48k fixed rate is chosen
1345 except for the known devices since the output is often
1346 noisy except for 48k on some mother boards due to the
1347 bug of BIOS.
2d7eb7cb 1348 Please try once dxs_support=5 and if it works on other
1da177e4
LT
1349 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1350 know the PCI subsystem vendor/device id's (output of
1351 "lspci -nv").
cdc27f3a
TI
1352 If dxs_support=5 does not work, try dxs_support=4; if it
1353 doesn't work too, try dxs_support=1. (dxs_support=1 is
6243008b 1354 usually for old motherboards. The correct implemented
cdc27f3a 1355 board should work with 4 or 5.) If it still doesn't
1da177e4
LT
1356 work and the default setting is ok, dxs_support=3 is the
1357 right choice. If the default setting doesn't work at all,
1358 try dxs_support=2 to disable the DXS channels.
1359 In any cases, please let us know the result and the
6243008b
TI
1360 subsystem vendor/device ids. See "Links and Addresses"
1361 below.
1da177e4
LT
1362
1363 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
6243008b 1364 additionally. The mpu_port option is for VIA686 chips only.
1da177e4
LT
1365
1366 Module snd-via82xx-modem
1367 ------------------------
1368
1369 Module for VIA82xx AC97 modem
1370
1371 ac97_clock - AC'97 codec clock base (default 48000Hz)
1372
b7fe4622 1373 This module supports one card and autoprobe.
1da177e4
LT
1374
1375 Note: The default index value of this module is -2, i.e. the first
1376 slot is excluded.
1377
1378 Module snd-virmidi
1379 ------------------
1380
1381 Module for virtual rawmidi devices.
1382 This module creates virtual rawmidi devices which communicate
1383 to the corresponding ALSA sequencer ports.
1384
1385 midi_devs - MIDI devices # (1-8, default=4)
1386
1387 Module supports up to 8 cards.
1388
1389 Module snd-vx222
1390 ----------------
1391
1392 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1393
1394 mic - Enable Microphone on V222 Mic (NYI)
1395 ibl - Capture IBL size. (default = 0, minimum size)
1396
1397 Module supports up to 8 cards.
1398
1399 When the driver is compiled as a module and the hotplug firmware
1400 is supported, the firmware data is loaded via hotplug automatically.
1401 Install the necessary firmware files in alsa-firmware package.
1402 When no hotplug fw loader is available, you need to load the
1403 firmware via vxloader utility in alsa-tools package. To invoke
1404 vxloader automatically, add the following to /etc/modprobe.conf
1405
1406 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1407
1408 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1409 /etc/modules.conf, instead.)
1410 IBL size defines the interrupts period for PCM. The smaller size
1411 gives smaller latency but leads to more CPU consumption, too.
1412 The size is usually aligned to 126. As default (=0), the smallest
1413 size is chosen. The possible IBL values can be found in
1414 /proc/asound/cardX/vx-status proc file.
1415
1416 Module snd-vxpocket
1417 -------------------
1418
6d00a312 1419 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
1da177e4
LT
1420
1421 ibl - Capture IBL size. (default = 0, minimum size)
1422
1423 Module supports up to 8 cards. The module is compiled only when
1424 PCMCIA is supported on kernel.
1425
6243008b
TI
1426 With the older 2.6.x kernel, to activate the driver via the card
1427 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1428 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1429 longer require a config file.
1da177e4
LT
1430
1431 When the driver is compiled as a module and the hotplug firmware
1432 is supported, the firmware data is loaded via hotplug automatically.
1433 Install the necessary firmware files in alsa-firmware package.
1434 When no hotplug fw loader is available, you need to load the
1435 firmware via vxloader utility in alsa-tools package.
1436
1437 About capture IBL, see the description of snd-vx222 module.
1438
1439 Note: the driver is build only when CONFIG_ISA is set.
1440
6243008b
TI
1441 Note2: snd-vxp440 driver is merged to snd-vxpocket driver since
1442 ALSA 1.0.10.
1443
1da177e4
LT
1444 Module snd-ymfpci
1445 -----------------
1446
1447 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1448
1449 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1450 1 (auto-detect for YMF744/754 only)
1451 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1452 1 (auto-detect for YMF744/754 only)
1453 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1454 1 (auto-detect)
1455 rear_switch - enable shared rear/line-in switch (bool)
1456
1457 Module supports autoprobe and multiple chips (max 8).
1458
1459 The power-management is supported.
1460
1461 Module snd-pdaudiocf
1462 --------------------
1463
1464 Module for Sound Core PDAudioCF sound card.
1465
1466 Note: the driver is build only when CONFIG_ISA is set.
1467
1468
6243008b
TI
1469AC97 Quirk Option
1470=================
1471
1472The ac97_quirk option is used to enable/override the workaround for
1473specific devices on drivers for on-board AC'97 controllers like
1474snd-intel8x0. Some hardware have swapped output pins between Master
1475and Headphone, or Surround (thanks to confusion of AC'97
1476specifications from version to version :-)
1477
1478The driver provides the auto-detection of known problematic devices,
1479but some might be unknown or wrongly detected. In such a case, pass
1480the proper value with this option.
1481
1482The following strings are accepted:
1483 - default Don't override the default setting
10e4097f 1484 - none Disable the quirk
6243008b
TI
1485 - hp_only Bind Master and Headphone controls as a single control
1486 - swap_hp Swap headphone and master controls
1487 - swap_surround Swap master and surround controls
1488 - ad_sharing For AD1985, turn on OMS bit and use headphone
1489 - alc_jack For ALC65x, turn on the jack sense mode
1490 - inv_eapd Inverted EAPD implementation
1491 - mute_led Bind EAPD bit for turning on/off mute LED
1492
1493For backward compatibility, the corresponding integer value -1, 0,
1494... are accepted, too.
1495
1496For example, if "Master" volume control has no effect on your device
1497but only "Headphone" does, pass ac97_quirk=hp_only module option.
1498
1499
1da177e4
LT
1500Configuring Non-ISAPNP Cards
1501============================
1502
1503When the kernel is configured with ISA-PnP support, the modules
1504supporting the isapnp cards will have module options "isapnp".
1505If this option is set, *only* the ISA-PnP devices will be probed.
1506For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
1507together with the proper i/o and irq configuration.
1508
1509When the kernel is configured without ISA-PnP support, isapnp option
1510will be not built in.
1511
1512
1513Module Autoloading Support
1514==========================
1515
1516The ALSA drivers can be loaded automatically on demand by defining
1517module aliases. The string 'snd-card-%1' is requested for ALSA native
1518devices where %i is sound card number from zero to seven.
1519
1520To auto-load an ALSA driver for OSS services, define the string
1521'sound-slot-%i' where %i means the slot number for OSS, which
1522corresponds to the card index of ALSA. Usually, define this
d533f671 1523as the same card module.
1da177e4
LT
1524
1525An example configuration for a single emu10k1 card is like below:
1526----- /etc/modprobe.conf
1527alias snd-card-0 snd-emu10k1
1528alias sound-slot-0 snd-emu10k1
1529----- /etc/modprobe.conf
1530
1531The available number of auto-loaded sound cards depends on the module
1532option "cards_limit" of snd module. As default it's set to 1.
1533To enable the auto-loading of multiple cards, specify the number of
1534sound cards in that option.
1535
1536When multiple cards are available, it'd better to specify the index
1537number for each card via module option, too, so that the order of
1538cards is kept consistent.
1539
1540An example configuration for two sound cards is like below:
1541
1542----- /etc/modprobe.conf
1543# ALSA portion
1544options snd cards_limit=2
1545alias snd-card-0 snd-interwave
1546alias snd-card-1 snd-ens1371
1547options snd-interwave index=0
1548options snd-ens1371 index=1
1549# OSS/Free portion
1550alias sound-slot-0 snd-interwave
1551alias sound-slot-1 snd-ens1371
1552----- /etc/moprobe.conf
1553
1554In this example, the interwave card is always loaded as the first card
1555(index 0) and ens1371 as the second (index 1).
1556
1557
1558ALSA PCM devices to OSS devices mapping
1559=======================================
1560
1561/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
1562/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
1563/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
1564/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
1565/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
1566/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
1567/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
1568/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
1569/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
1570
1571The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
1572sound card number and second means device number. The ALSA devices
1573have either 'c' or 'p' suffix indicating the direction, capture and
1574playback, respectively.
1575
1576Please note that the device mapping above may be varied via the module
1577options of snd-pcm-oss module.
1578
1579
1580DEVFS support
1581=============
1582
1583The ALSA driver fully supports the devfs extension.
1584You should add lines below to your devfsd.conf file:
1585
1586LOOKUP snd MODLOAD ACTION snd
1587REGISTER ^sound/.* PERMISSIONS root.audio 660
1588REGISTER ^snd/.* PERMISSIONS root.audio 660
1589
1590Warning: These lines assume that you have the audio group in your system.
1591 Otherwise replace audio word with another group name (root for
1592 example).
1593
1594
1595Proc interfaces (/proc/asound)
1596==============================
1597
1598/proc/asound/card#/pcm#[cp]/oss
1599-------------------------------
1600 String "erase" - erase all additional informations about OSS applications
1601 String "<app_name> <fragments> <fragment_size> [<options>]"
1602
1603 <app_name> - name of application with (higher priority) or without path
1604 <fragments> - number of fragments or zero if auto
1605 <fragment_size> - size of fragment in bytes or zero if auto
1606 <options> - optional parameters
1607 - disable the application tries to open a pcm device for
1608 this channel but does not want to use it.
1609 (Cause a bug or mmap needs)
1610 It's good for Quake etc...
1611 - direct don't use plugins
1612 - block force block mode (rvplayer)
1613 - non-block force non-block mode
1614 - whole-frag write only whole fragments (optimization affecting
1615 playback only)
1616 - no-silence do not fill silence ahead to avoid clicks
10f69f9e
TI
1617 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
1618 instead of filled blocks
1da177e4
LT
1619
1620 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
1621 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
1622 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
1623
1624
b6a96915
TI
1625Early Buffer Allocation
1626=======================
1627
1628Some drivers (e.g. hdsp) require the large contiguous buffers, and
1629sometimes it's too late to find such spaces when the driver module is
1630actually loaded due to memory fragmentation. You can pre-allocate the
1631PCM buffers by loading snd-page-alloc module and write commands to its
1632proc file in prior, for example, in the early boot stage like
1633/etc/init.d/*.local scripts.
1634
1635Reading the proc file /proc/drivers/snd-page-alloc shows the current
1636usage of page allocation. In writing, you can send the following
1637commands to the snd-page-alloc driver:
1638
1639 - add VENDOR DEVICE MASK SIZE BUFFERS
1640
1641 VENDOR and DEVICE are PCI vendor and device IDs. They take
1642 integer numbers (0x prefix is needed for the hex).
1643 MASK is the PCI DMA mask. Pass 0 if not restricted.
1644 SIZE is the size of each buffer to allocate. You can pass
1645 k and m suffix for KB and MB. The max number is 16MB.
1646 BUFFERS is the number of buffers to allocate. It must be greater
1647 than 0. The max number is 4.
1648
1649 - erase
1650
1651 This will erase the all pre-allocated buffers which are not in
1652 use.
1653
1654
6243008b
TI
1655Links and Addresses
1656===================
1da177e4
LT
1657
1658 ALSA project homepage
1659 http://www.alsa-project.org
1660
6243008b
TI
1661 ALSA Bug Tracking System
1662 https://bugtrack.alsa-project.org/bugs/
1663
1664 ALSA Developers ML
1665 mailto:alsa-devel@lists.sourceforge.net