blob: 0846b455bcf2beb210c4b0d606c410c24503a083 [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
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100108 - Values: 0 through 31 or negative
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 - 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
Rene Hermancf40a312006-03-28 12:38:20 +0200123 Module snd-adlib
124 ----------------
125
126 Module for AdLib FM cards.
127
128 port - port # for OPL chip
129
130 This module supports multiple cards. It does not support autoprobe, so
131 the port must be specified. For actual AdLib FM cards it will be 0x388.
132 Note that this card does not have PCM support and no mixer; only FM
133 synthesis.
134
135 Make sure you have "sbiload" from the alsa-tools package available and,
136 after loading the module, find out the assigned ALSA sequencer port
137 number through "sbiload -l". Example output:
138
139 Port Client name Port name
140 64:0 OPL2 FM synth OPL2 FM Port
141
142 Load the std.sb and drums.sb patches also supplied by sbiload:
143
144 sbiload -p 64:0 std.sb drums.sb
145
146 If you use this driver to drive an OPL3, you can use std.o3 and drums.o3
147 instead. To have the card produce sound, use aplaymidi from alsa-utils:
148
149 aplaymidi -p 64:0 foo.mid
150
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 Module snd-ad1816a
152 ------------------
153
154 Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips.
155
156 port - port # for AD1816A chip (PnP setup)
157 mpu_port - port # for MPU-401 UART (PnP setup)
158 fm_port - port # for OPL3 (PnP setup)
159 irq - IRQ # for AD1816A chip (PnP setup)
160 mpu_irq - IRQ # for MPU-401 UART (PnP setup)
161 dma1 - first DMA # for AD1816A chip (PnP setup)
162 dma2 - second DMA # for AD1816A chip (PnP setup)
Takashi Iwai506d4c62005-08-03 14:02:47 +0200163 clockfreq - Clock frequency for AD1816A chip (default = 0, 33000Hz)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100165 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
167 Module snd-ad1848
168 -----------------
169
170 Module for sound cards based on AD1848/AD1847/CS4248 ISA chips.
171
172 port - port # for AD1848 chip
173 irq - IRQ # for AD1848 chip
174 dma1 - DMA # for AD1848 chip (0,1,3)
175
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100176 This module supports multiple cards. It does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 thus main port must be specified!!! Other ports are optional.
178
Takashi Iwaia4efc232005-11-17 17:24:26 +0100179 The power-management is supported.
180
Clemens Ladisch84010e62005-09-02 07:57:59 +0200181 Module snd-ad1889
182 -----------------
183
184 Module for Analog Devices AD1889 chips.
185
186 ac97_quirk - AC'97 workaround for strange hardware
187 See the description of intel8x0 module for details.
188
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100189 This module supports multiple cards.
Clemens Ladisch84010e62005-09-02 07:57:59 +0200190
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 Module snd-ali5451
192 ------------------
193
194 Module for ALi M5451 PCI chip.
195
196 pcm_channels - Number of hardware channels assigned for PCM
197 spdif - Support SPDIF I/O
198 - Default: disabled
199
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +0200200 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
202 The power-management is supported.
203
204 Module snd-als100
205 -----------------
206
207 Module for sound cards based on Avance Logic ALS100/ALS120 ISA chips.
208
209 port - port # for ALS100 (SB16) chip (PnP setup)
210 irq - IRQ # for ALS100 (SB16) chip (PnP setup)
211 dma8 - 8-bit DMA # for ALS100 (SB16) chip (PnP setup)
212 dma16 - 16-bit DMA # for ALS100 (SB16) chip (PnP setup)
213 mpu_port - port # for MPU-401 UART (PnP setup)
214 mpu_irq - IRQ # for MPU-401 (PnP setup)
215 fm_port - port # for OPL3 FM (PnP setup)
216
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100217 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Takashi Iwaia4efc232005-11-17 17:24:26 +0100219 The power-management is supported.
220
Ash Willisb3a70d52006-03-27 13:20:40 +0200221 Module snd-als300
222 -----------------
223
224 Module for Avance Logic ALS300 and ALS300+
225
226 This module supports multiple cards.
227
228 The power-management is supported.
229
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 Module snd-als4000
231 ------------------
232
233 Module for sound cards based on Avance Logic ALS4000 PCI chip.
234
235 joystick_port - port # for legacy joystick support.
236 0 = disabled (default), 1 = auto-detect
237
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100238 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
Takashi Iwaia4efc232005-11-17 17:24:26 +0100240 The power-management is supported.
241
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 Module snd-atiixp
243 -----------------
244
Takashi Iwai62430082005-09-05 17:12:29 +0200245 Module for ATI IXP 150/200/250/400 AC97 controllers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
Takashi Iwai62430082005-09-05 17:12:29 +0200247 ac97_clock - AC'97 clock (default = 48000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200249 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 spdif_aclink - S/PDIF transfer over AC-link (default = 1)
251
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200252 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253
Takashi Iwai62430082005-09-05 17:12:29 +0200254 ATI IXP has two different methods to control SPDIF output. One is
255 over AC-link and another is over the "direct" SPDIF output. The
256 implementation depends on the motherboard, and you'll need to
257 choose the correct one via spdif_aclink module option.
258
Takashi Iwaia4efc232005-11-17 17:24:26 +0100259 The power-management is supported.
260
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 Module snd-atiixp-modem
262 -----------------------
263
264 Module for ATI IXP 150/200/250 AC97 modem controllers.
265
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200266 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
268 Note: The default index value of this module is -2, i.e. the first
269 slot is excluded.
270
Takashi Iwaia4efc232005-11-17 17:24:26 +0100271 The power-management is supported.
272
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 Module snd-au8810, snd-au8820, snd-au8830
274 -----------------------------------------
275
276 Module for Aureal Vortex, Vortex2 and Advantage device.
277
278 pcifix - Control PCI workarounds
279 0 = Disable all workarounds
280 1 = Force the PCI latency of the Aureal card to 0xff
281 2 = Force the Extend PCI#2 Internal Master for Efficient
282 Handling of Dummy Requests on the VIA KT133 AGP Bridge
283 3 = Force both settings
284 255 = Autodetect what is required (default)
285
286 This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
287 EQ, mpu401, gameport. A3D and wavetable support are still in development.
288 Development and reverse engineering work is being coordinated at
289 http://savannah.nongnu.org/projects/openvortex/
290 SPDIF output has a copy of the AC97 codec output, unless you use the
291 "spdif" pcm device, which allows raw data passthru.
292 The hardware EQ hardware and SPDIF is only present in the Vortex2 and
293 Advantage.
294
Takashi Iwai62430082005-09-05 17:12:29 +0200295 Note: Some ALSA mixer applications don't handle the SPDIF sample rate
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 control correctly. If you have problems regarding this, try
297 another ALSA compliant mixer (alsamixer works).
298
299 Module snd-azt2320
300 ------------------
301
302 Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
303
304 port - port # for AZT2320 chip (PnP setup)
305 wss_port - port # for WSS (PnP setup)
306 mpu_port - port # for MPU-401 UART (PnP setup)
307 fm_port - FM port # for AZT2320 chip (PnP setup)
308 irq - IRQ # for AZT2320 (WSS) chip (PnP setup)
309 mpu_irq - IRQ # for MPU-401 UART (PnP setup)
310 dma1 - 1st DMA # for AZT2320 (WSS) chip (PnP setup)
311 dma2 - 2nd DMA # for AZT2320 (WSS) chip (PnP setup)
312
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100313 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
Takashi Iwaia4efc232005-11-17 17:24:26 +0100315 The power-management is supported.
316
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 Module snd-azt3328
318 ------------------
319
320 Module for sound cards based on Aztech AZF3328 PCI chip.
321
322 joystick - Enable joystick (default off)
323
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100324 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
326 Module snd-bt87x
327 ----------------
328
329 Module for video cards based on Bt87x chips.
330
331 digital_rate - Override the default digital rate (Hz)
332 load_all - Load the driver even if the card model isn't known
333
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100334 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335
336 Note: The default index value of this module is -2, i.e. the first
337 slot is excluded.
338
339 Module snd-ca0106
340 -----------------
341
342 Module for Creative Audigy LS and SB Live 24bit
343
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100344 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
346
347 Module snd-cmi8330
348 ------------------
349
350 Module for sound cards based on C-Media CMI8330 ISA chips.
351
352 wssport - port # for CMI8330 chip (WSS)
353 wssirq - IRQ # for CMI8330 chip (WSS)
354 wssdma - first DMA # for CMI8330 chip (WSS)
355 sbport - port # for CMI8330 chip (SB16)
356 sbirq - IRQ # for CMI8330 chip (SB16)
357 sbdma8 - 8bit DMA # for CMI8330 chip (SB16)
358 sbdma16 - 16bit DMA # for CMI8330 chip (SB16)
359
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100360 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
Takashi Iwaia4efc232005-11-17 17:24:26 +0100362 The power-management is supported.
363
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 Module snd-cmipci
365 -----------------
366
367 Module for C-Media CMI8338 and 8738 PCI sound cards.
368
Takashi Iwaicab5c4c2006-05-04 14:36:08 +0200369 mpu_port - 0x300,0x310,0x320,0x330 = legacy port,
370 1 = integrated PCI port,
371 0 = disable (default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 fm_port - 0x388 (default), 0 = disable (default)
Takashi Iwai62430082005-09-05 17:12:29 +0200373 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 (default = 1)
375 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
376
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100377 This module supports autoprobe and multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378
Takashi Iwaia4efc232005-11-17 17:24:26 +0100379 The power-management is supported.
380
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 Module snd-cs4231
382 -----------------
383
384 Module for sound cards based on CS4231 ISA chips.
385
386 port - port # for CS4231 chip
387 mpu_port - port # for MPU-401 UART (optional), -1 = disable
388 irq - IRQ # for CS4231 chip
389 mpu_irq - IRQ # for MPU-401 UART
390 dma1 - first DMA # for CS4231 chip
391 dma2 - second DMA # for CS4231 chip
392
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100393 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 thus main port must be specified!!! Other ports are optional.
395
396 The power-management is supported.
397
398 Module snd-cs4232
399 -----------------
400
401 Module for sound cards based on CS4232/CS4232A ISA chips.
402
403 port - port # for CS4232 chip (PnP setup - 0x534)
404 cport - control port # for CS4232 chip (PnP setup - 0x120,0x210,0xf00)
405 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
406 fm_port - FM port # for CS4232 chip (PnP setup - 0x388), -1 = disable
407 irq - IRQ # for CS4232 chip (5,7,9,11,12,15)
408 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
409 dma1 - first DMA # for CS4232 chip (0,1,3)
410 dma2 - second DMA # for Yamaha CS4232 chip (0,1,3), -1 = disable
411 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
412
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100413 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 thus main port must be specified!!! Other ports are optional.
415
416 The power-management is supported.
417
418 Module snd-cs4236
419 -----------------
420
421 Module for sound cards based on CS4235/CS4236/CS4236B/CS4237B/
422 CS4238B/CS4239 ISA chips.
423
424 port - port # for CS4236 chip (PnP setup - 0x534)
425 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
426 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
427 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
428 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
429 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
430 dma1 - first DMA # for CS4236 chip (0,1,3)
431 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
432 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
433
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100434 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 (if ISA PnP is not used) thus main port and control port must be
436 specified!!! Other ports are optional.
437
438 The power-management is supported.
439
440 Module snd-cs4281
441 -----------------
442
443 Module for Cirrus Logic CS4281 soundchip.
444
445 dual_codec - Secondary codec ID (0 = disable, default)
446
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100447 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
449 The power-management is supported.
450
451 Module snd-cs46xx
452 -----------------
453
454 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
455 CS4624/CS4630/CS4280 PCI chips.
456
Takashi Iwai62430082005-09-05 17:12:29 +0200457 external_amp - Force to enable external amplifier.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 thinkpad - Force to enable Thinkpad's CLKRUN control.
459 mmap_valid - Support OSS mmap mode (default = 0).
460
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100461 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 Usually external amp and CLKRUN controls are detected automatically
463 from PCI sub vendor/device ids. If they don't work, give the options
464 above explicitly.
465
466 The power-management is supported.
467
Takashi Iwai3e873172005-11-17 10:15:37 +0100468 Module snd-cs5535audio
469 ----------------------
470
471 Module for multifunction CS5535 companion PCI device
472
Takashi Iwaic00bd742006-05-19 19:22:34 +0200473 The power-management is supported.
Takashi Iwai3e873172005-11-17 10:15:37 +0100474
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200475 Module snd-darla20
476 ------------------
477
478 Module for Echoaudio Darla20
479
480 This module supports multiple cards.
481 The driver requires the firmware loader support on kernel.
482
483 Module snd-darla24
484 ------------------
485
486 Module for Echoaudio Darla24
487
488 This module supports multiple cards.
489 The driver requires the firmware loader support on kernel.
490
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 Module snd-dt019x
492 -----------------
493
494 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
495 only)
496
497 port - Port # (PnP setup)
498 mpu_port - Port # for MPU-401 (PnP setup)
499 fm_port - Port # for FM OPL-3 (PnP setup)
500 irq - IRQ # (PnP setup)
501 mpu_irq - IRQ # for MPU-401 (PnP setup)
502 dma8 - DMA # (PnP setup)
503
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100504 This module supports multiple cards. This module is enabled only with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 ISA PnP support.
506
Takashi Iwaia4efc232005-11-17 17:24:26 +0100507 The power-management is supported.
508
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 Module snd-dummy
510 ----------------
511
512 Module for the dummy sound card. This "card" doesn't do any output
513 or input, but you may use this module for any application which
514 requires a sound card (like RealPlayer).
515
Takashi Iwaia4efc232005-11-17 17:24:26 +0100516 The power-management is supported.
517
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200518 Module snd-echo3g
519 -----------------
520
521 Module for Echoaudio 3G cards (Gina3G/Layla3G)
522
523 This module supports multiple cards.
524 The driver requires the firmware loader support on kernel.
525
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 Module snd-emu10k1
527 ------------------
528
529 Module for EMU10K1/EMU10k2 based PCI sound cards.
530 * Sound Blaster Live!
531 * Sound Blaster PCI 512
532 * Emu APS (partially supported)
533 * Sound Blaster Audigy
534
535 extin - bitmap of available external inputs for FX8010 (see bellow)
536 extout - bitmap of available external outputs for FX8010 (see bellow)
537 seq_ports - allocated sequencer ports (4 by default)
538 max_synth_voices - limit of voices used for wavetable (64 by default)
539 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
540 given in MB unit. Default value is 128.
541 enable_ir - enable IR
542
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100543 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544
545 Input & Output configurations [extin/extout]
546 * Creative Card wo/Digital out [0x0003/0x1f03]
547 * Creative Card w/Digital out [0x0003/0x1f0f]
548 * Creative Card w/Digital CD in [0x000f/0x1f0f]
549 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
550 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
551 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
552 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
553 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
554 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
555 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
556 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
557 * Creative Card all ins and outs [0x3fff/0x7fff]
558
Takashi Iwaia4efc232005-11-17 17:24:26 +0100559 The power-management is supported.
560
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 Module snd-emu10k1x
562 -------------------
563
564 Module for Creative Emu10k1X (SB Live Dell OEM version)
565
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100566 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
568 Module snd-ens1370
569 ------------------
570
571 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
572 * SoundBlaster PCI 64
573 * SoundBlaster PCI 128
574
575 joystick - Enable joystick (default off)
576
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100577 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100579 The power-management is supported.
580
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 Module snd-ens1371
582 ------------------
583
584 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
585 * SoundBlaster PCI 64
586 * SoundBlaster PCI 128
587 * SoundBlaster Vibra PCI
588
589 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
590 0 = disable (default), 1 = auto-detect
591
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100592 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100594 The power-management is supported.
595
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 Module snd-es968
597 ----------------
598
599 Module for sound cards based on ESS ES968 chip (PnP only).
600
601 port - port # for ES968 (SB8) chip (PnP setup)
602 irq - IRQ # for ES968 (SB8) chip (PnP setup)
603 dma1 - DMA # for ES968 (SB8) chip (PnP setup)
604
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100605 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606
Takashi Iwaia4efc232005-11-17 17:24:26 +0100607 The power-management is supported.
608
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 Module snd-es1688
610 -----------------
611
612 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
613
614 port - port # for ES-1688 chip (0x220,0x240,0x260)
615 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
616 irq - IRQ # for ES-1688 chip (5,7,9,10)
617 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
618 dma8 - DMA # for ES-1688 chip (0,1,3)
619
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100620 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
622 Module snd-es18xx
623 -----------------
624
625 Module for ESS AudioDrive ES-18xx sound cards.
626
627 port - port # for ES-18xx chip (0x220,0x240,0x260)
628 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
629 fm_port - port # for FM (optional, not used)
630 irq - IRQ # for ES-18xx chip (5,7,9,10)
631 dma1 - first DMA # for ES-18xx chip (0,1,3)
632 dma2 - first DMA # for ES-18xx chip (0,1,3)
633 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
634
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100635 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
636 port if native ISA PnP routines are not used).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 When dma2 is equal with dma1, the driver works as half-duplex.
638
639 The power-management is supported.
640
641 Module snd-es1938
642 -----------------
643
644 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
645
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100646 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
Takashi Iwaia4efc232005-11-17 17:24:26 +0100648 The power-management is supported.
649
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 Module snd-es1968
651 -----------------
652
653 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
654
655 total_bufsize - total buffer size in kB (1-4096kB)
656 pcm_substreams_p - playback channels (1-8, default=2)
657 pcm_substreams_c - capture channels (1-8, default=0)
658 clock - clock (0 = auto-detection)
659 use_pm - support the power-management (0 = off, 1 = on,
660 2 = auto (default))
661 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
662 joystick - enable joystick (default off)
663
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100664 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
666 The power-management is supported.
667
668 Module snd-fm801
669 ----------------
670
671 Module for ForteMedia FM801 based PCI sound cards.
672
673 tea575x_tuner - Enable TEA575x tuner
674 - 1 = MediaForte 256-PCS
675 - 2 = MediaForte 256-PCPR
676 - 3 = MediaForte 64-PCR
677 - High 16-bits are video (radio) device number + 1
678 - example: 0x10002 (MediaForte 256-PCPR, device 1)
679
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100680 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
Takashi Iwaia4efc232005-11-17 17:24:26 +0100682 The power-management is supported.
683
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200684 Module snd-gina20
685 -----------------
686
687 Module for Echoaudio Gina20
688
689 This module supports multiple cards.
690 The driver requires the firmware loader support on kernel.
691
692 Module snd-gina24
693 -----------------
694
695 Module for Echoaudio Gina24
696
697 This module supports multiple cards.
698 The driver requires the firmware loader support on kernel.
699
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 Module snd-gusclassic
701 ---------------------
702
703 Module for Gravis UltraSound Classic sound card.
704
705 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
706 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
707 dma1 - DMA # for GF1 chip (1,3,5,6,7)
708 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
709 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
710 voices - GF1 voices limit (14-32)
711 pcm_voices - reserved PCM voices
712
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100713 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
715 Module snd-gusextreme
716 ---------------------
717
718 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
719
720 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
721 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
722 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
723 irq - IRQ # for ES-1688 chip (5,7,9,10)
724 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
725 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
726 dma8 - DMA # for ES-1688 chip (0,1,3)
727 dma1 - DMA # for GF1 chip (1,3,5,6,7)
728 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
729 voices - GF1 voices limit (14-32)
730 pcm_voices - reserved PCM voices
731
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100732 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733
734 Module snd-gusmax
735 -----------------
736
737 Module for Gravis UltraSound MAX sound card.
738
739 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
740 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
741 dma1 - DMA # for GF1 chip (1,3,5,6,7)
742 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
743 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
744 voices - GF1 voices limit (14-32)
745 pcm_voices - reserved PCM voices
746
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100747 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
749 Module snd-hda-intel
750 --------------------
751
Takashi Iwai9b878192006-05-17 11:26:39 +0200752 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8),
753 ATI SB450, SB600, RS600,
754 VIA VT8251/VT8237A,
755 SIS966, ULI M5461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756
757 model - force the model name
Takashi Iwai62430082005-09-05 17:12:29 +0200758 position_fix - Fix DMA pointer (0 = auto, 1 = none, 2 = POSBUF, 3 = FIFO size)
Takashi Iwai27346162006-01-12 18:28:44 +0100759 single_cmd - Use single immediate commands to communicate with
760 codecs (for debugging only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200762 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763
764 Each codec may have a model table for different configurations.
765 If your machine isn't listed there, the default (usually minimal)
766 configuration is set up. You can pass "model=<name>" option to
767 specify a certain model in such a case. There are different
768 models depending on the codec chip.
769
770 Model name Description
771 ---------- -----------
772 ALC880
773 3stack 3-jack in back and a headphone out
774 3stack-digout 3-jack in back, a HP out and a SPDIF out
775 5stack 5-jack in back, 2-jack in front
776 5stack-digout 5-jack in back, 2-jack in front, a SPDIF out
Takashi Iwaib6482d42005-06-27 15:32:43 +0200777 6stack 6-jack in back, 2-jack in front
778 6stack-digout 6-jack with a SPDIF out
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 w810 3-jack
Takashi Iwaidfc0ff62005-05-12 14:31:49 +0200780 z71v 3-jack (HP shared SPDIF)
Takashi Iwaie9edcee2005-06-13 14:16:38 +0200781 asus 3-jack
782 uniwill 3-jack
783 F1734 2-jack
Takashi Iwaiae6b8132006-03-03 16:47:17 +0100784 lg LG laptop (m1 express dual)
Takashi Iwaid6815182006-03-23 16:06:23 +0100785 lg-lw LG LW20 laptop
Takashi Iwaib6482d42005-06-27 15:32:43 +0200786 test for testing/debugging purpose, almost all controls can be
787 adjusted. Appearing only when compiled with
788 $CONFIG_SND_DEBUG=y
Takashi Iwaied345f82006-03-01 14:16:53 +0100789 auto auto-config reading BIOS (default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790
Takashi Iwai21be3d12005-09-16 19:18:56 +0200791 ALC260
792 hp HP machines
793 fujitsu Fujitsu S7020
Takashi Iwaied345f82006-03-01 14:16:53 +0100794 acer Acer TravelMate
795 basic fixed pin assignment (old default model)
796 auto auto-config reading BIOS (default)
797
798 ALC262
799 fujitsu Fujitsu Laptop
800 basic fixed pin assignment w/o SPDIF
801 auto auto-config reading BIOS (default)
802
803 ALC882/883/885
804 3stack-dig 3-jack with SPDIF I/O
805 6stck-dig 6-jack digital with SPDIF I/O
806 auto auto-config reading BIOS (default)
807
808 ALC861
809 3stack 3-jack
810 3stack-dig 3-jack with SPDIF I/O
811 6stack-dig 6-jack with SPDIF I/O
812 auto auto-config reading BIOS (default)
Takashi Iwai21be3d12005-09-16 19:18:56 +0200813
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 CMI9880
815 minimal 3-jack in back
816 min_fp 3-jack in back, 2-jack in front
817 full 6-jack in back, 2-jack in front
818 full_dig 6-jack in back, 2-jack in front, SPDIF I/O
819 allout 5-jack in back, 2-jack in front, SPDIF out
Takashi Iwaie9edcee2005-06-13 14:16:38 +0200820 auto auto-config reading BIOS (default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821
Takashi Iwai9230d212006-03-13 13:49:49 +0100822 AD1981
823 basic 3-jack (default)
824 hp HP nx6320
Takashi Iwai01686c5f2006-04-18 12:54:11 +0200825 thinkpad Lenovo Thinkpad T60/X60/Z60
Takashi Iwai9230d212006-03-13 13:49:49 +0100826
827 AD1986A
828 6stack 6-jack, separate surrounds (default)
829 3stack 3-stack, shared surrounds
830 laptop 2-channel only (FSC V2060, Samsung M50)
Takashi Iwai825aa9722006-03-17 10:50:49 +0100831 laptop-eapd 2-channel with EAPD (Samsung R65, ASUS A6J)
Takashi Iwai9230d212006-03-13 13:49:49 +0100832
833 AD1988
834 6stack 6-jack
835 6stack-dig ditto with SPDIF
836 3stack 3-jack
837 3stack-dig ditto with SPDIF
838 laptop 3-jack with hp-jack automute
839 laptop-dig ditto with SPDIF
840 auto auto-confgi reading BIOS (default)
841
Takashi Iwaidb064e52006-03-16 16:04:58 +0100842 STAC7661(?)
843 vaio Setup for VAIO FE550G/SZ110
844
Takashi Iwai62430082005-09-05 17:12:29 +0200845 If the default configuration doesn't work and one of the above
846 matches with your device, report it together with the PCI
847 subsystem ID (output of "lspci -nv") to ALSA BTS or alsa-devel
848 ML (see the section "Links and Addresses").
849
Takashi Iwaic74db862005-05-12 14:26:27 +0200850 Note 2: If you get click noises on output, try the module option
851 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
852 register value without FIFO size correction as the current
853 DMA pointer. position_fix=2 will make the driver to use
854 the position buffer instead of reading SD_LPIB register.
855 (Usually SD_LPLIB register is more accurate than the
856 position buffer.)
857
Takashi Iwai27346162006-01-12 18:28:44 +0100858 NB: If you get many "azx_get_response timeout" messages at
859 loading, it's likely a problem of interrupts (e.g. ACPI irq
860 routing). Try to boot with options like "pci=noacpi". Also, you
861 can try "single_cmd=1" module option. This will switch the
862 communication method between HDA controller and codecs to the
863 single immediate commands instead of CORB/RIRB. Basically, the
864 single command mode is provided only for BIOS, and you won't get
865 unsolicited events, too. But, at least, this works independently
866 from the irq. Remember this is a last resort, and should be
867 avoided as much as possible...
868
Takashi Iwaia4efc232005-11-17 17:24:26 +0100869 The power-management is supported.
870
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 Module snd-hdsp
872 ---------------
873
874 Module for RME Hammerfall DSP audio interface(s)
875
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100876 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877
878 Note: The firmware data can be automatically loaded via hotplug
879 when CONFIG_FW_LOADER is set. Otherwise, you need to load
880 the firmware via hdsploader utility included in alsa-tools
881 package.
882 The firmware data is found in alsa-firmware package.
883
884 Note: snd-page-alloc module does the job which snd-hammerfall-mem
885 module did formerly. It will allocate the buffers in advance
886 when any HDSP cards are found. To make the buffer
887 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +0200888 stage of boot sequence. See "Early Buffer Allocation"
889 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890
Takashi Iwai54704402005-06-03 11:27:00 +0200891 Module snd-hdspm
892 ----------------
893
894 Module for RME HDSP MADI board.
895
896 precise_ptr - Enable precise pointer, or disable.
897 line_outs_monitor - Send playback streams to analog outs by default.
898 enable_monitor - Enable Analog Out on Channel 63/64 by default.
899
900 See hdspm.txt for details.
901
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 Module snd-ice1712
903 ------------------
904
905 Module for Envy24 (ICE1712) based PCI sound cards.
906 * MidiMan M Audio Delta 1010
907 * MidiMan M Audio Delta 1010LT
908 * MidiMan M Audio Delta DiO 2496
909 * MidiMan M Audio Delta 66
910 * MidiMan M Audio Delta 44
911 * MidiMan M Audio Delta 410
912 * MidiMan M Audio Audiophile 2496
913 * TerraTec EWS 88MT
914 * TerraTec EWS 88D
915 * TerraTec EWX 24/96
916 * TerraTec DMX 6Fire
Takashi Iwaic9bce912005-05-24 13:41:03 +0200917 * TerraTec Phase 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 * Hoontech SoundTrack DSP 24
919 * Hoontech SoundTrack DSP 24 Value
920 * Hoontech SoundTrack DSP 24 Media 7.1
Takashi Iwaic9bce912005-05-24 13:41:03 +0200921 * Event Electronics, EZ8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 * Digigram VX442
Takashi Iwaic9bce912005-05-24 13:41:03 +0200923 * Lionstracs, Mediastaton
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924
925 model - Use the given board model, one of the following:
926 delta1010, dio2496, delta66, delta44, audiophile, delta410,
927 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
Takashi Iwaic9bce912005-05-24 13:41:03 +0200928 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
929 phase88, mediastation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 omni - Omni I/O support for MidiMan M-Audio Delta44/66
931 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transciever)
932 in msec resolution, default value is 500 (0.5 sec)
933
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100934 This module supports multiple cards and autoprobe. Note: The consumer part
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 is not used with all Envy24 based cards (for example in the MidiMan Delta
936 serie).
937
Takashi Iwaic9bce912005-05-24 13:41:03 +0200938 Note: The supported board is detected by reading EEPROM or PCI
939 SSID (if EEPROM isn't available). You can override the
940 model by passing "model" module option in case that the
941 driver isn't configured properly or you want to try another
942 type for testing.
943
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944 Module snd-ice1724
945 ------------------
946
Takashi Iwaic9bce912005-05-24 13:41:03 +0200947 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100948 * MidiMan M Audio Revolution 5.1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 * MidiMan M Audio Revolution 7.1
950 * AMP Ltd AUDIO2000
Takashi Iwaic9bce912005-05-24 13:41:03 +0200951 * TerraTec Aureon 5.1 Sky
952 * TerraTec Aureon 7.1 Space
953 * TerraTec Aureon 7.1 Universe
954 * TerraTec Phase 22
955 * TerraTec Phase 28
956 * AudioTrak Prodigy 7.1
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100957 * AudioTrak Prodigy 7.1LT
Takashi Iwaic9bce912005-05-24 13:41:03 +0200958 * AudioTrak Prodigy 192
959 * Pontis MS300
960 * Albatron K8X800 Pro II
961 * Chaintech ZNF3-150
962 * Chaintech ZNF3-250
963 * Chaintech 9CJS
Takashi Iwai8cfbbac2005-05-27 12:10:40 +0200964 * Chaintech AV-710
Takashi Iwaic9bce912005-05-24 13:41:03 +0200965 * Shuttle SN25P
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966
967 model - Use the given board model, one of the following:
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100968 revo51, revo71, amp2000, prodigy71, prodigy71lt,
969 prodigy192, aureon51, aureon71, universe,
970 k8x800, phase22, phase28, ms300, av710
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100972 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973
Takashi Iwaic9bce912005-05-24 13:41:03 +0200974 Note: The supported board is detected by reading EEPROM or PCI
975 SSID (if EEPROM isn't available). You can override the
976 model by passing "model" module option in case that the
977 driver isn't configured properly or you want to try another
978 type for testing.
979
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200980 Module snd-indigo
981 -----------------
982
983 Module for Echoaudio Indigo
984
985 This module supports multiple cards.
986 The driver requires the firmware loader support on kernel.
987
988 Module snd-indigodj
989 -------------------
990
991 Module for Echoaudio Indigo DJ
992
993 This module supports multiple cards.
994 The driver requires the firmware loader support on kernel.
995
996 Module snd-indigoio
997 -------------------
998
999 Module for Echoaudio Indigo IO
1000
1001 This module supports multiple cards.
1002 The driver requires the firmware loader support on kernel.
1003
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 Module snd-intel8x0
1005 -------------------
1006
1007 Module for AC'97 motherboards from Intel and compatibles.
1008 * Intel i810/810E, i815, i820, i830, i84x, MX440
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001009 ICH5, ICH6, ICH7, ESB2
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 * SiS 7012 (SiS 735)
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001011 * NVidia NForce, NForce2, NForce3, MCP04, CK804
1012 CK8, CK8S, MCP501
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 * AMD AMD768, AMD8111
1014 * ALi m5455
1015
1016 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1017 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001018 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 buggy_irq - Enable workaround for buggy interrupts on some
Takashi Iwaia06147d2005-09-08 19:54:17 +02001020 motherboards (default yes on nForce chips,
1021 otherwise off)
1022 buggy_semaphore - Enable workaround for hardwares with buggy
1023 semaphores (e.g. on some ASUS laptops)
1024 (default off)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001026 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027
1028 Note: the latest driver supports auto-detection of chip clock.
1029 if you still encounter too fast playback, specify the clock
1030 explicitly via the module option "ac97_clock=41194".
1031
1032 Joystick/MIDI ports are not supported by this driver. If your
1033 motherboard has these devices, use the ns558 or snd-mpu401
1034 modules, respectively.
1035
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 The power-management is supported.
1037
1038 Module snd-intel8x0m
1039 --------------------
1040
1041 Module for Intel ICH (i8x0) chipset MC97 modems.
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001042 * Intel i810/810E, i815, i820, i830, i84x, MX440
1043 ICH5, ICH6, ICH7
1044 * SiS 7013 (SiS 735)
1045 * NVidia NForce, NForce2, NForce2s, NForce3
1046 * AMD AMD8111
1047 * ALi m5455
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048
1049 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1050
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001051 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052
1053 Note: The default index value of this module is -2, i.e. the first
1054 slot is excluded.
1055
Takashi Iwaia4efc232005-11-17 17:24:26 +01001056 The power-management is supported.
1057
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 Module snd-interwave
1059 --------------------
1060
1061 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1062 and other sound cards based on AMD InterWave (tm) chip.
1063
1064 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1065 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1066 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1067 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
1068 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1069 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1070 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1071 effect - 1 = InterWave effects enable (default 0);
1072 requires 8 voices
1073
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001074 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075
1076 Module snd-interwave-stb
1077 ------------------------
1078
1079 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1080 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1081 circuit for extended control of bass, treble and master volume.
1082
1083 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1084 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1085 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1086 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1087 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
1088 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1089 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1090 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1091 effect - 1 = InterWave effects enable (default 0);
1092 requires 8 voices
1093
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001094 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095
1096 Module snd-korg1212
1097 -------------------
1098
1099 Module for Korg 1212 IO PCI card
1100
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001101 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001103 Module snd-layla20
1104 ------------------
1105
1106 Module for Echoaudio Layla20
1107
1108 This module supports multiple cards.
1109 The driver requires the firmware loader support on kernel.
1110
1111 Module snd-layla24
1112 ------------------
1113
1114 Module for Echoaudio Layla24
1115
1116 This module supports multiple cards.
1117 The driver requires the firmware loader support on kernel.
1118
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119 Module snd-maestro3
1120 -------------------
1121
1122 Module for Allegro/Maestro3 chips
1123
1124 external_amp - enable external amp (enabled by default)
1125 amp_gpio - GPIO pin number for external amp (0-15) or
1126 -1 for default pin (8 for allegro, 1 for
1127 others)
1128
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001129 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130
1131 Note: the binding of amplifier is dependent on hardware.
1132 If there is no sound even though all channels are unmuted, try to
1133 specify other gpio connection via amp_gpio option.
1134 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1135 option.
1136
1137 The power-management is supported.
1138
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001139 Module snd-mia
1140 ---------------
1141
1142 Module for Echoaudio Mia
1143
1144 This module supports multiple cards.
1145 The driver requires the firmware loader support on kernel.
1146
Martin Langer1841f6132006-03-27 12:41:01 +02001147 Module snd-miro
1148 ---------------
1149
1150 Module for Miro soundcards: miroSOUND PCM 1 pro,
1151 miroSOUND PCM 12,
1152 miroSOUND PCM 20 Radio.
1153
1154 port - Port # (0x530,0x604,0xe80,0xf40)
1155 irq - IRQ # (5,7,9,10,11)
1156 dma1 - 1st dma # (0,1,3)
1157 dma2 - 2nd dma # (0,1)
1158 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1159 mpu_irq - MPU-401 irq # (5,7,9,10)
1160 fm_port - FM Port # (0x388)
1161 wss - enable WSS mode
1162 ide - enable onboard ide support
1163
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 Module snd-mixart
1165 -----------------
1166
1167 Module for Digigram miXart8 sound cards.
1168
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001169 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170 Note: One miXart8 board will be represented as 4 alsa cards.
1171 See MIXART.txt for details.
1172
1173 When the driver is compiled as a module and the hotplug firmware
1174 is supported, the firmware data is loaded via hotplug automatically.
1175 Install the necessary firmware files in alsa-firmware package.
1176 When no hotplug fw loader is available, you need to load the
1177 firmware via mixartloader utility in alsa-tools package.
1178
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001179 Module snd-mona
1180 ---------------
1181
1182 Module for Echoaudio Mona
1183
1184 This module supports multiple cards.
1185 The driver requires the firmware loader support on kernel.
1186
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 Module snd-mpu401
1188 -----------------
1189
1190 Module for MPU-401 UART devices.
1191
1192 port - port number or -1 (disable)
1193 irq - IRQ number or -1 (disable)
1194 pnp - PnP detection - 0 = disable, 1 = enable (default)
1195
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001196 This module supports multiple devices and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197
1198 Module snd-mtpav
1199 ----------------
1200
1201 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1202 port).
1203
1204 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1205 irq - IRQ # for MTPAV (7,5, default=7)
1206 hwports - number of supported hardware ports, default=8.
1207
1208 Module supports only 1 card. This module has no enable option.
1209
1210 Module snd-nm256
1211 ----------------
1212
1213 Module for NeoMagic NM256AV/ZX chips
1214
1215 playback_bufsize - max playback frame size in kB (4-128kB)
1216 capture_bufsize - max capture frame size in kB (4-128kB)
1217 force_ac97 - 0 or 1 (disabled by default)
1218 buffer_top - specify buffer top address
1219 use_cache - 0 or 1 (disabled by default)
1220 vaio_hack - alias buffer_top=0x25a800
1221 reset_workaround - enable AC97 RESET workaround for some laptops
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001222 reset_workaround2 - enable extended AC97 RESET workaround for some
1223 other laptops
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +02001225 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226
1227 The power-management is supported.
1228
1229 Note: on some notebooks the buffer address cannot be detected
1230 automatically, or causes hang-up during initialization.
1231 In such a case, specify the buffer top address explicity via
1232 buffer_top option.
1233 For example,
1234 Sony F250: buffer_top=0x25a800
1235 Sony F270: buffer_top=0x272800
1236 The driver supports only ac97 codec. It's possible to force
1237 to initialize/use ac97 although it's not detected. In such a
1238 case, use force_ac97=1 option - but *NO* guarantee whether it
1239 works!
1240
1241 Note: The NM256 chip can be linked internally with non-AC97
1242 codecs. This driver supports only the AC97 codec, and won't work
1243 with machines with other (most likely CS423x or OPL3SAx) chips,
1244 even though the device is detected in lspci. In such a case, try
1245 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
Takashi Iwai62430082005-09-05 17:12:29 +02001246 but some doesn't have ISA PnP. You'll need to specify isapnp=0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 and proper hardware parameters in the case without ISA PnP.
1248
1249 Note: some laptops need a workaround for AC97 RESET. For the
1250 known hardware like Dell Latitude LS and Sony PCG-F305, this
1251 workaround is enabled automatically. For other laptops with a
1252 hard freeze, you can try reset_workaround=1 option.
1253
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001254 Note: Dell Latitude CSx laptops have another problem regarding
1255 AC97 RESET. On these laptops, reset_workaround2 option is
1256 turned on as default. This option is worth to try if the
1257 previous reset_workaround option doesn't help.
1258
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259 Note: This driver is really crappy. It's a porting from the
1260 OSS driver, which is a result of black-magic reverse engineering.
1261 The detection of codec will fail if the driver is loaded *after*
1262 X-server as described above. You might be able to force to load
1263 the module, but it may result in hang-up. Hence, make sure that
1264 you load this module *before* X if you encounter this kind of
1265 problem.
1266
1267 Module snd-opl3sa2
1268 ------------------
1269
1270 Module for Yamaha OPL3-SA2/SA3 sound cards.
1271
1272 port - control port # for OPL3-SA chip (0x370)
1273 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1274 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1275 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1276 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1277 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1278 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1279 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
1280 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1281
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001282 This module supports multiple cards and ISA PnP. It does not support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1284
1285 The power-management is supported.
1286
1287 Module snd-opti92x-ad1848
1288 -------------------------
1289
1290 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1291 Module works with OAK Mozart cards as well.
1292
1293 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1294 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1295 fm_port - port # for OPL3 device (0x388)
1296 irq - IRQ # for WSS chip (5,7,9,10,11)
1297 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1298 dma1 - first DMA # for WSS chip (0,1,3)
1299
1300 This module supports only one card, autoprobe and PnP.
1301
1302 Module snd-opti92x-cs4231
1303 -------------------------
1304
1305 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1306
1307 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1308 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1309 fm_port - port # for OPL3 device (0x388)
1310 irq - IRQ # for WSS chip (5,7,9,10,11)
1311 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1312 dma1 - first DMA # for WSS chip (0,1,3)
1313 dma2 - second DMA # for WSS chip (0,1,3)
1314
1315 This module supports only one card, autoprobe and PnP.
1316
1317 Module snd-opti93x
1318 ------------------
1319
1320 Module for sound cards based on OPTi 82c93x chips.
1321
1322 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1323 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1324 fm_port - port # for OPL3 device (0x388)
1325 irq - IRQ # for WSS chip (5,7,9,10,11)
1326 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1327 dma1 - first DMA # for WSS chip (0,1,3)
1328 dma2 - second DMA # for WSS chip (0,1,3)
1329
1330 This module supports only one card, autoprobe and PnP.
1331
Markus Bollingere12229b2005-12-06 13:55:26 +01001332 Module snd-pcxhr
1333 ----------------
1334
1335 Module for Digigram PCXHR boards
1336
1337 This module supports multiple cards.
1338
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 Module snd-powermac (on ppc only)
1340 ---------------------------------
1341
1342 Module for PowerMac, iMac and iBook on-board soundchips
1343
1344 enable_beep - enable beep using PCM (enabled as default)
1345
1346 Module supports autoprobe a chip.
1347
1348 Note: the driver may have problems regarding endianess.
1349
1350 The power-management is supported.
1351
Takashi Iwai2c484df2005-06-30 18:54:04 +02001352 Module snd-pxa2xx-ac97 (on arm only)
1353 ------------------------------------
1354
1355 Module for AC97 driver for the Intel PXA2xx chip
1356
1357 For ARM architecture only.
1358
Takashi Iwaia4efc232005-11-17 17:24:26 +01001359 The power-management is supported.
1360
Peter Gruber109a9632006-03-27 13:10:28 +02001361 Module snd-riptide
1362 ------------------
1363
1364 Module for Conexant Riptide chip
1365
1366 joystick_port - Joystick port # (default: 0x200)
1367 mpu_port - MPU401 port # (default: 0x330)
1368 opl3_port - OPL3 port # (default: 0x388)
1369
1370 This module supports multiple cards.
1371 The driver requires the firmware loader support on kernel.
1372 You need to install the firmware file "riptide.hex" to the standard
1373 firmware path (e.g. /lib/firmware).
1374
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375 Module snd-rme32
1376 ----------------
1377
1378 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1379 Prodif96 and Prodif Gold) sound cards.
1380
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001381 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001382
1383 Module snd-rme96
1384 ----------------
1385
1386 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1387
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001388 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389
1390 Module snd-rme9652
1391 ------------------
1392
1393 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1394
1395 precise_ptr - Enable precise pointer (doesn't work reliably).
1396 (default = 0)
1397
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001398 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399
1400 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1401 module did formerly. It will allocate the buffers in advance
1402 when any RME9652 cards are found. To make the buffer
1403 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +02001404 stage of boot sequence. See "Early Buffer Allocation"
1405 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406
1407 Module snd-sa11xx-uda1341 (on arm only)
1408 ---------------------------------------
1409
1410 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1411
1412 Module supports only one card.
1413 Module has no enable and index options.
1414
Takashi Iwaia4efc232005-11-17 17:24:26 +01001415 The power-management is supported.
1416
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 Module snd-sb8
1418 --------------
1419
1420 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1421 SoundBlaster 2.0,
1422 SoundBlaster Pro
1423
1424 port - port # for SB DSP chip (0x220,0x240,0x260)
1425 irq - IRQ # for SB DSP chip (5,7,9,10)
1426 dma8 - DMA # for SB DSP chip (1,3)
1427
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001428 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429
Takashi Iwaia4efc232005-11-17 17:24:26 +01001430 The power-management is supported.
1431
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432 Module snd-sb16 and snd-sbawe
1433 -----------------------------
1434
1435 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1436 SoundBlaster AWE 32 (PnP),
1437 SoundBlaster AWE 64 PnP
1438
1439 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1440 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1441 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1442 (snd-sbawe module only)
1443 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1444 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1445 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
1446 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1447 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1448 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1449
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001450 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451
1452 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1453 disable 16bit DMA with dma16 = -1 module parameter.
1454 Also, all Sound Blaster 16 type cards can operate in 16-bit
1455 half duplex mode through 8-bit DMA channel by disabling their
1456 16-bit DMA channel.
1457
Takashi Iwaia4efc232005-11-17 17:24:26 +01001458 The power-management is supported.
1459
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460 Module snd-sgalaxy
1461 ------------------
1462
1463 Module for Aztech Sound Galaxy sound card.
1464
1465 sbport - Port # for SB16 interface (0x220,0x240)
1466 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1467 irq - IRQ # (7,9,10,11)
1468 dma1 - DMA #
1469
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001470 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471
Takashi Iwaia4efc232005-11-17 17:24:26 +01001472 The power-management is supported.
1473
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474 Module snd-sscape
1475 -----------------
1476
1477 Module for ENSONIQ SoundScape PnP cards.
1478
1479 port - Port # (PnP setup)
1480 irq - IRQ # (PnP setup)
1481 mpu_irq - MPU-401 IRQ # (PnP setup)
1482 dma - DMA # (PnP setup)
1483
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001484 This module supports multiple cards. ISA PnP must be enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001485 You need sscape_ctl tool in alsa-tools package for loading
1486 the microcode.
1487
1488 Module snd-sun-amd7930 (on sparc only)
1489 --------------------------------------
1490
1491 Module for AMD7930 sound chips found on Sparcs.
1492
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001493 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494
1495 Module snd-sun-cs4231 (on sparc only)
1496 -------------------------------------
1497
1498 Module for CS4231 sound chips found on Sparcs.
1499
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001500 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001502 Module snd-sun-dbri (on sparc only)
1503 -----------------------------------
1504
1505 Module for DBRI sound chips found on Sparcs.
1506
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001507 This module supports multiple cards.
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001508
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 Module snd-wavefront
1510 --------------------
1511
1512 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1513
1514 cs4232_pcm_port - Port # for CS4232 PCM interface.
1515 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1516 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1517 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
1518 use_cs4232_midi - Use CS4232 MPU-401 interface
1519 (inaccessibly located inside your computer)
1520 ics2115_port - Port # for ICS2115
1521 ics2115_irq - IRQ # for ICS2115
1522 fm_port - FM OPL-3 Port #
1523 dma1 - DMA1 # for CS4232 PCM interface.
1524 dma2 - DMA2 # for CS4232 PCM interface.
1525 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1526
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001527 This module supports multiple cards and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528
1529 Module snd-sonicvibes
1530 ---------------------
1531
1532 Module for S3 SonicVibes PCI sound cards.
1533 * PINE Schubert 32 PCI
1534
1535 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1536 - SoundCard must have onboard SRAM for this.
1537 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1538
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001539 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540
1541 Module snd-serial-u16550
1542 ------------------------
1543
1544 Module for UART16550A serial MIDI ports.
1545
1546 port - port # for UART16550A chip
1547 irq - IRQ # for UART16550A chip, -1 = poll mode
1548 speed - speed in bauds (9600,19200,38400,57600,115200)
1549 38400 = default
1550 base - base for divisor in bauds (57600,115200,230400,460800)
1551 115200 = default
1552 outs - number of MIDI ports in a serial port (1-4)
1553 1 = default
1554 adaptor - Type of adaptor.
1555 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1556 3 = MS-124W M/B, 4 = Generic
1557
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001558 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 thus the main port must be specified!!! Other options are optional.
1560
1561 Module snd-trident
1562 ------------------
1563
1564 Module for Trident 4DWave DX/NX sound cards.
1565 * Best Union Miss Melody 4DWave PCI
1566 * HIS 4DWave PCI
1567 * Warpspeed ONSpeed 4DWave PCI
1568 * AzTech PCI 64-Q3D
1569 * Addonics SV 750
1570 * CHIC True Sound 4Dwave
1571 * Shark Predator4D-PCI
1572 * Jaton SonicWave 4D
1573
1574 pcm_channels - max channels (voices) reserved for PCM
1575 wavetable_size - max wavetable size in kB (4-?kb)
1576
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001577 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578
1579 The power-management is supported.
1580
1581 Module snd-usb-audio
1582 --------------------
1583
1584 Module for USB audio and USB MIDI devices.
1585
1586 vid - Vendor ID for the device (optional)
1587 pid - Product ID for the device (optional)
Thibault LE MEURe3113342006-03-14 11:44:53 +01001588 device_setup - Device specific magic number (optional)
1589 - Influence depends on the device
1590 - Default: 0x0000
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001592 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593
1594 Module snd-usb-usx2y
1595 --------------------
1596
1597 Module for Tascam USB US-122, US-224 and US-428 devices.
1598
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001599 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600
1601 Note: you need to load the firmware via usx2yloader utility included
1602 in alsa-tools and alsa-firmware packages.
1603
1604 Module snd-via82xx
1605 ------------------
1606
1607 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001608 8233A, 8233C, 8235, 8237 (south) bridge.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609
1610 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1611 [VIA686A/686B only]
1612 joystick - Enable joystick (default off) [VIA686A/686B only]
1613 ac97_clock - AC'97 codec clock base (default 48000Hz)
1614 dxs_support - support DXS channels,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001615 0 = auto (default), 1 = enable, 2 = disable,
1616 3 = 48k only, 4 = no VRA, 5 = enable any sample
1617 rate and different sample rates on different
1618 channels
1619 [VIA8233/C, 8235, 8237 only]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001621 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001623 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624
1625 Note: on some SMP motherboards like MSI 694D the interrupts might
1626 not be generated properly. In such a case, please try to
1627 set the SMP (or MPS) version on BIOS to 1.1 instead of
1628 default value 1.4. Then the interrupt number will be
1629 assigned under 15. You might also upgrade your BIOS.
1630
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001631 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632 channels as the first PCM. On these channels, up to 4
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001633 streams can be played at the same time, and the controller
1634 can perform sample rate conversion with separate rates for
1635 each channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 As default (dxs_support = 0), 48k fixed rate is chosen
1637 except for the known devices since the output is often
1638 noisy except for 48k on some mother boards due to the
1639 bug of BIOS.
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001640 Please try once dxs_support=5 and if it works on other
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1642 know the PCI subsystem vendor/device id's (output of
1643 "lspci -nv").
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001644 If dxs_support=5 does not work, try dxs_support=4; if it
1645 doesn't work too, try dxs_support=1. (dxs_support=1 is
Takashi Iwai62430082005-09-05 17:12:29 +02001646 usually for old motherboards. The correct implemented
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001647 board should work with 4 or 5.) If it still doesn't
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648 work and the default setting is ok, dxs_support=3 is the
1649 right choice. If the default setting doesn't work at all,
1650 try dxs_support=2 to disable the DXS channels.
1651 In any cases, please let us know the result and the
Takashi Iwai62430082005-09-05 17:12:29 +02001652 subsystem vendor/device ids. See "Links and Addresses"
1653 below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654
1655 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Takashi Iwai62430082005-09-05 17:12:29 +02001656 additionally. The mpu_port option is for VIA686 chips only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
Takashi Iwaia4efc232005-11-17 17:24:26 +01001658 The power-management is supported.
1659
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 Module snd-via82xx-modem
1661 ------------------------
1662
1663 Module for VIA82xx AC97 modem
1664
1665 ac97_clock - AC'97 codec clock base (default 48000Hz)
1666
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001667 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668
1669 Note: The default index value of this module is -2, i.e. the first
1670 slot is excluded.
1671
Takashi Iwaia4efc232005-11-17 17:24:26 +01001672 The power-management is supported.
1673
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 Module snd-virmidi
1675 ------------------
1676
1677 Module for virtual rawmidi devices.
1678 This module creates virtual rawmidi devices which communicate
1679 to the corresponding ALSA sequencer ports.
1680
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001681 midi_devs - MIDI devices # (1-4, default=4)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001682
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001683 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684
1685 Module snd-vx222
1686 ----------------
1687
1688 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1689
1690 mic - Enable Microphone on V222 Mic (NYI)
1691 ibl - Capture IBL size. (default = 0, minimum size)
1692
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001693 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694
1695 When the driver is compiled as a module and the hotplug firmware
1696 is supported, the firmware data is loaded via hotplug automatically.
1697 Install the necessary firmware files in alsa-firmware package.
1698 When no hotplug fw loader is available, you need to load the
1699 firmware via vxloader utility in alsa-tools package. To invoke
1700 vxloader automatically, add the following to /etc/modprobe.conf
1701
1702 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1703
1704 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1705 /etc/modules.conf, instead.)
1706 IBL size defines the interrupts period for PCM. The smaller size
1707 gives smaller latency but leads to more CPU consumption, too.
1708 The size is usually aligned to 126. As default (=0), the smallest
1709 size is chosen. The possible IBL values can be found in
1710 /proc/asound/cardX/vx-status proc file.
1711
Takashi Iwaia4efc232005-11-17 17:24:26 +01001712 The power-management is supported.
1713
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714 Module snd-vxpocket
1715 -------------------
1716
Takashi Iwai6d00a312005-06-30 13:40:51 +02001717 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718
1719 ibl - Capture IBL size. (default = 0, minimum size)
1720
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001721 This module supports multiple cards. The module is compiled only when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722 PCMCIA is supported on kernel.
1723
Takashi Iwai62430082005-09-05 17:12:29 +02001724 With the older 2.6.x kernel, to activate the driver via the card
1725 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1726 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1727 longer require a config file.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728
1729 When the driver is compiled as a module and the hotplug firmware
1730 is supported, the firmware data is loaded via hotplug automatically.
1731 Install the necessary firmware files in alsa-firmware package.
1732 When no hotplug fw loader is available, you need to load the
1733 firmware via vxloader utility in alsa-tools package.
1734
1735 About capture IBL, see the description of snd-vx222 module.
1736
Takashi Iwaied7cbe32006-05-11 11:30:10 +02001737 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
Takashi Iwai62430082005-09-05 17:12:29 +02001738 ALSA 1.0.10.
1739
Takashi Iwaia4efc232005-11-17 17:24:26 +01001740 The power-management is supported.
1741
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742 Module snd-ymfpci
1743 -----------------
1744
1745 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1746
1747 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1748 1 (auto-detect for YMF744/754 only)
1749 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1750 1 (auto-detect for YMF744/754 only)
1751 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1752 1 (auto-detect)
1753 rear_switch - enable shared rear/line-in switch (bool)
1754
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001755 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756
1757 The power-management is supported.
1758
1759 Module snd-pdaudiocf
1760 --------------------
1761
1762 Module for Sound Core PDAudioCF sound card.
1763
Takashi Iwaia4efc232005-11-17 17:24:26 +01001764 The power-management is supported.
1765
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766
Takashi Iwai62430082005-09-05 17:12:29 +02001767AC97 Quirk Option
1768=================
1769
1770The ac97_quirk option is used to enable/override the workaround for
1771specific devices on drivers for on-board AC'97 controllers like
1772snd-intel8x0. Some hardware have swapped output pins between Master
1773and Headphone, or Surround (thanks to confusion of AC'97
1774specifications from version to version :-)
1775
1776The driver provides the auto-detection of known problematic devices,
1777but some might be unknown or wrongly detected. In such a case, pass
1778the proper value with this option.
1779
1780The following strings are accepted:
1781 - default Don't override the default setting
Takashi Iwai10e4097f2005-11-17 11:04:55 +01001782 - none Disable the quirk
Takashi Iwai62430082005-09-05 17:12:29 +02001783 - hp_only Bind Master and Headphone controls as a single control
1784 - swap_hp Swap headphone and master controls
1785 - swap_surround Swap master and surround controls
1786 - ad_sharing For AD1985, turn on OMS bit and use headphone
1787 - alc_jack For ALC65x, turn on the jack sense mode
1788 - inv_eapd Inverted EAPD implementation
1789 - mute_led Bind EAPD bit for turning on/off mute LED
1790
1791For backward compatibility, the corresponding integer value -1, 0,
1792... are accepted, too.
1793
1794For example, if "Master" volume control has no effect on your device
1795but only "Headphone" does, pass ac97_quirk=hp_only module option.
1796
1797
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798Configuring Non-ISAPNP Cards
1799============================
1800
1801When the kernel is configured with ISA-PnP support, the modules
1802supporting the isapnp cards will have module options "isapnp".
1803If this option is set, *only* the ISA-PnP devices will be probed.
1804For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
1805together with the proper i/o and irq configuration.
1806
1807When the kernel is configured without ISA-PnP support, isapnp option
1808will be not built in.
1809
1810
1811Module Autoloading Support
1812==========================
1813
1814The ALSA drivers can be loaded automatically on demand by defining
1815module aliases. The string 'snd-card-%1' is requested for ALSA native
1816devices where %i is sound card number from zero to seven.
1817
1818To auto-load an ALSA driver for OSS services, define the string
1819'sound-slot-%i' where %i means the slot number for OSS, which
1820corresponds to the card index of ALSA. Usually, define this
Tobias Klauserd533f672005-09-10 00:26:46 -07001821as the same card module.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822
1823An example configuration for a single emu10k1 card is like below:
1824----- /etc/modprobe.conf
1825alias snd-card-0 snd-emu10k1
1826alias sound-slot-0 snd-emu10k1
1827----- /etc/modprobe.conf
1828
1829The available number of auto-loaded sound cards depends on the module
1830option "cards_limit" of snd module. As default it's set to 1.
1831To enable the auto-loading of multiple cards, specify the number of
1832sound cards in that option.
1833
1834When multiple cards are available, it'd better to specify the index
1835number for each card via module option, too, so that the order of
1836cards is kept consistent.
1837
1838An example configuration for two sound cards is like below:
1839
1840----- /etc/modprobe.conf
1841# ALSA portion
1842options snd cards_limit=2
1843alias snd-card-0 snd-interwave
1844alias snd-card-1 snd-ens1371
1845options snd-interwave index=0
1846options snd-ens1371 index=1
1847# OSS/Free portion
1848alias sound-slot-0 snd-interwave
1849alias sound-slot-1 snd-ens1371
1850----- /etc/moprobe.conf
1851
1852In this example, the interwave card is always loaded as the first card
1853(index 0) and ens1371 as the second (index 1).
1854
1855
1856ALSA PCM devices to OSS devices mapping
1857=======================================
1858
1859/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
1860/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
1861/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
1862/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
1863/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
1864/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
1865/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
1866/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
1867/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
1868
1869The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
1870sound card number and second means device number. The ALSA devices
1871have either 'c' or 'p' suffix indicating the direction, capture and
1872playback, respectively.
1873
1874Please note that the device mapping above may be varied via the module
1875options of snd-pcm-oss module.
1876
1877
1878DEVFS support
1879=============
1880
1881The ALSA driver fully supports the devfs extension.
1882You should add lines below to your devfsd.conf file:
1883
1884LOOKUP snd MODLOAD ACTION snd
1885REGISTER ^sound/.* PERMISSIONS root.audio 660
1886REGISTER ^snd/.* PERMISSIONS root.audio 660
1887
1888Warning: These lines assume that you have the audio group in your system.
1889 Otherwise replace audio word with another group name (root for
1890 example).
1891
1892
1893Proc interfaces (/proc/asound)
1894==============================
1895
1896/proc/asound/card#/pcm#[cp]/oss
1897-------------------------------
1898 String "erase" - erase all additional informations about OSS applications
1899 String "<app_name> <fragments> <fragment_size> [<options>]"
1900
1901 <app_name> - name of application with (higher priority) or without path
1902 <fragments> - number of fragments or zero if auto
1903 <fragment_size> - size of fragment in bytes or zero if auto
1904 <options> - optional parameters
1905 - disable the application tries to open a pcm device for
1906 this channel but does not want to use it.
1907 (Cause a bug or mmap needs)
1908 It's good for Quake etc...
1909 - direct don't use plugins
1910 - block force block mode (rvplayer)
1911 - non-block force non-block mode
1912 - whole-frag write only whole fragments (optimization affecting
1913 playback only)
1914 - no-silence do not fill silence ahead to avoid clicks
Takashi Iwai10f69f92005-09-08 13:48:34 +02001915 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
1916 instead of filled blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917
1918 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
1919 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
1920 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
1921
1922
Takashi Iwaib6a96912005-05-30 18:27:03 +02001923Early Buffer Allocation
1924=======================
1925
1926Some drivers (e.g. hdsp) require the large contiguous buffers, and
1927sometimes it's too late to find such spaces when the driver module is
1928actually loaded due to memory fragmentation. You can pre-allocate the
1929PCM buffers by loading snd-page-alloc module and write commands to its
1930proc file in prior, for example, in the early boot stage like
1931/etc/init.d/*.local scripts.
1932
1933Reading the proc file /proc/drivers/snd-page-alloc shows the current
1934usage of page allocation. In writing, you can send the following
1935commands to the snd-page-alloc driver:
1936
1937 - add VENDOR DEVICE MASK SIZE BUFFERS
1938
1939 VENDOR and DEVICE are PCI vendor and device IDs. They take
1940 integer numbers (0x prefix is needed for the hex).
1941 MASK is the PCI DMA mask. Pass 0 if not restricted.
1942 SIZE is the size of each buffer to allocate. You can pass
1943 k and m suffix for KB and MB. The max number is 16MB.
1944 BUFFERS is the number of buffers to allocate. It must be greater
1945 than 0. The max number is 4.
1946
1947 - erase
1948
1949 This will erase the all pre-allocated buffers which are not in
1950 use.
1951
1952
Takashi Iwai62430082005-09-05 17:12:29 +02001953Links and Addresses
1954===================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955
1956 ALSA project homepage
1957 http://www.alsa-project.org
1958
Takashi Iwai62430082005-09-05 17:12:29 +02001959 ALSA Bug Tracking System
1960 https://bugtrack.alsa-project.org/bugs/
1961
1962 ALSA Developers ML
1963 mailto:alsa-devel@lists.sourceforge.net