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