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