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