blob: ea16e7d184a4de62579e051e1b8e8d67ae605398 [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.
Takashi Iwai304cd072007-10-26 15:10:15 +020060 slots - Reserve the slot index for the given driver.
61 This option takes multiple strings.
62 See "Module Autoloading Support" section for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
64 Module snd-pcm-oss
65 ------------------
66
67 The PCM OSS emulation module.
68 This module takes options which change the mapping of devices.
69
70 dsp_map - PCM device number maps assigned to the 1st OSS device.
71 - Default: 0
72 adsp_map - PCM device number maps assigned to the 2st OSS device.
73 - Default: 1
74 nonblock_open
Takashi Iwai62430082005-09-05 17:12:29 +020075 - Don't block opening busy PCM devices. Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77 For example, when dsp_map=2, /dev/dsp will be mapped to PCM #2 of
78 the card #0. Similarly, when adsp_map=0, /dev/adsp will be mapped
79 to PCM #0 of the card #0.
80 For changing the second or later card, specify the option with
81 commas, such like "dsp_map=0,1".
82
83 nonblock_open option is used to change the behavior of the PCM
84 regarding opening the device. When this option is non-zero,
85 opening a busy OSS PCM device won't be blocked but return
86 immediately with EAGAIN (just like O_NONBLOCK flag).
87
88 Module snd-rawmidi
89 ------------------
90
91 This module takes options which change the mapping of devices.
92 similar to those of the snd-pcm-oss module.
93
94 midi_map - MIDI device number maps assigned to the 1st OSS device.
95 - Default: 0
96 amidi_map - MIDI device number maps assigned to the 2st OSS device.
97 - Default: 1
98
99 Common parameters for top sound card modules
100 --------------------------------------------
101
102 Each of top level sound card module takes the following options.
103
104 index - index (slot #) of sound card
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100105 - Values: 0 through 31 or negative
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 - If nonnegative, assign that index number
107 - if negative, interpret as a bitmask of permissible
108 indices; the first free permitted index is assigned
109 - Default: -1
110 id - card ID (identifier or name)
111 - Can be up to 15 characters long
112 - Default: the card type
113 - A directory by this name is created under /proc/asound/
114 containing information about the card
115 - This ID can be used instead of the index number in
116 identifying the card
117 enable - enable card
118 - Default: enabled, for PCI and ISA PnP cards
119
Rene Hermancf40a312006-03-28 12:38:20 +0200120 Module snd-adlib
121 ----------------
122
123 Module for AdLib FM cards.
124
125 port - port # for OPL chip
126
127 This module supports multiple cards. It does not support autoprobe, so
128 the port must be specified. For actual AdLib FM cards it will be 0x388.
129 Note that this card does not have PCM support and no mixer; only FM
130 synthesis.
131
132 Make sure you have "sbiload" from the alsa-tools package available and,
133 after loading the module, find out the assigned ALSA sequencer port
134 number through "sbiload -l". Example output:
135
136 Port Client name Port name
137 64:0 OPL2 FM synth OPL2 FM Port
138
139 Load the std.sb and drums.sb patches also supplied by sbiload:
140
141 sbiload -p 64:0 std.sb drums.sb
142
143 If you use this driver to drive an OPL3, you can use std.o3 and drums.o3
144 instead. To have the card produce sound, use aplaymidi from alsa-utils:
145
146 aplaymidi -p 64:0 foo.mid
147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 Module snd-ad1816a
149 ------------------
150
151 Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips.
152
Takashi Iwai506d4c62005-08-03 14:02:47 +0200153 clockfreq - Clock frequency for AD1816A chip (default = 0, 33000Hz)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100155 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
157 Module snd-ad1848
158 -----------------
159
160 Module for sound cards based on AD1848/AD1847/CS4248 ISA chips.
161
162 port - port # for AD1848 chip
163 irq - IRQ # for AD1848 chip
164 dma1 - DMA # for AD1848 chip (0,1,3)
165
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100166 This module supports multiple cards. It does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 thus main port must be specified!!! Other ports are optional.
168
Takashi Iwaia4efc232005-11-17 17:24:26 +0100169 The power-management is supported.
170
Clemens Ladisch84010e62005-09-02 07:57:59 +0200171 Module snd-ad1889
172 -----------------
173
174 Module for Analog Devices AD1889 chips.
175
176 ac97_quirk - AC'97 workaround for strange hardware
177 See the description of intel8x0 module for details.
178
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100179 This module supports multiple cards.
Clemens Ladisch84010e62005-09-02 07:57:59 +0200180
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 Module snd-ali5451
182 ------------------
183
184 Module for ALi M5451 PCI chip.
185
186 pcm_channels - Number of hardware channels assigned for PCM
187 spdif - Support SPDIF I/O
188 - Default: disabled
189
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +0200190 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
192 The power-management is supported.
193
194 Module snd-als100
195 -----------------
196
197 Module for sound cards based on Avance Logic ALS100/ALS120 ISA chips.
198
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100199 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Takashi Iwaia4efc232005-11-17 17:24:26 +0100201 The power-management is supported.
202
Ash Willisb3a70d52006-03-27 13:20:40 +0200203 Module snd-als300
204 -----------------
205
206 Module for Avance Logic ALS300 and ALS300+
207
208 This module supports multiple cards.
209
210 The power-management is supported.
211
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 Module snd-als4000
213 ------------------
214
215 Module for sound cards based on Avance Logic ALS4000 PCI chip.
216
217 joystick_port - port # for legacy joystick support.
218 0 = disabled (default), 1 = auto-detect
219
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100220 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Takashi Iwaia4efc232005-11-17 17:24:26 +0100222 The power-management is supported.
223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 Module snd-atiixp
225 -----------------
226
Takashi Iwai62430082005-09-05 17:12:29 +0200227 Module for ATI IXP 150/200/250/400 AC97 controllers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Takashi Iwai62430082005-09-05 17:12:29 +0200229 ac97_clock - AC'97 clock (default = 48000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200231 See "AC97 Quirk Option" section below.
Dan Carpenter14e1d352006-11-20 16:35:18 +0100232 ac97_codec - Workaround to specify which AC'97 codec
233 instead of probing. If this works for you
234 file a bug with your `lspci -vn` output.
235 -2 -- Force probing.
236 -1 -- Default behavior.
237 0-2 -- Use the specified codec.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 spdif_aclink - S/PDIF transfer over AC-link (default = 1)
239
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200240 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
Takashi Iwai62430082005-09-05 17:12:29 +0200242 ATI IXP has two different methods to control SPDIF output. One is
243 over AC-link and another is over the "direct" SPDIF output. The
244 implementation depends on the motherboard, and you'll need to
245 choose the correct one via spdif_aclink module option.
246
Takashi Iwaia4efc232005-11-17 17:24:26 +0100247 The power-management is supported.
248
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 Module snd-atiixp-modem
250 -----------------------
251
252 Module for ATI IXP 150/200/250 AC97 modem controllers.
253
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200254 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
256 Note: The default index value of this module is -2, i.e. the first
257 slot is excluded.
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-au8810, snd-au8820, snd-au8830
262 -----------------------------------------
263
264 Module for Aureal Vortex, Vortex2 and Advantage device.
265
266 pcifix - Control PCI workarounds
267 0 = Disable all workarounds
268 1 = Force the PCI latency of the Aureal card to 0xff
269 2 = Force the Extend PCI#2 Internal Master for Efficient
270 Handling of Dummy Requests on the VIA KT133 AGP Bridge
271 3 = Force both settings
272 255 = Autodetect what is required (default)
273
274 This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
275 EQ, mpu401, gameport. A3D and wavetable support are still in development.
276 Development and reverse engineering work is being coordinated at
277 http://savannah.nongnu.org/projects/openvortex/
278 SPDIF output has a copy of the AC97 codec output, unless you use the
279 "spdif" pcm device, which allows raw data passthru.
280 The hardware EQ hardware and SPDIF is only present in the Vortex2 and
281 Advantage.
282
Takashi Iwai62430082005-09-05 17:12:29 +0200283 Note: Some ALSA mixer applications don't handle the SPDIF sample rate
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 control correctly. If you have problems regarding this, try
285 another ALSA compliant mixer (alsamixer works).
286
Takashi Iwai9e235322008-02-20 12:13:29 +0100287 Module snd-aw2
288 --------------
289
290 Module for Audiowerk2 sound card
291
292 This module supports multiple cards.
293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 Module snd-azt2320
295 ------------------
296
297 Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
298
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100299 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
Takashi Iwaia4efc232005-11-17 17:24:26 +0100301 The power-management is supported.
302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 Module snd-azt3328
304 ------------------
305
306 Module for sound cards based on Aztech AZF3328 PCI chip.
307
308 joystick - Enable joystick (default off)
309
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100310 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
312 Module snd-bt87x
313 ----------------
314
315 Module for video cards based on Bt87x chips.
316
317 digital_rate - Override the default digital rate (Hz)
318 load_all - Load the driver even if the card model isn't known
319
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100320 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
322 Note: The default index value of this module is -2, i.e. the first
323 slot is excluded.
324
325 Module snd-ca0106
326 -----------------
327
328 Module for Creative Audigy LS and SB Live 24bit
329
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100330 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
332
333 Module snd-cmi8330
334 ------------------
335
336 Module for sound cards based on C-Media CMI8330 ISA chips.
337
Rene Herman64e0e2d2007-12-13 16:29:33 +0100338 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
339
340 with isapnp=0, the following options are available:
341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 wssport - port # for CMI8330 chip (WSS)
343 wssirq - IRQ # for CMI8330 chip (WSS)
344 wssdma - first DMA # for CMI8330 chip (WSS)
345 sbport - port # for CMI8330 chip (SB16)
346 sbirq - IRQ # for CMI8330 chip (SB16)
347 sbdma8 - 8bit DMA # for CMI8330 chip (SB16)
348 sbdma16 - 16bit DMA # for CMI8330 chip (SB16)
Takashi Iwai9e128fd2009-01-29 11:49:10 +0100349 fmport - (optional) OPL3 I/O port
350 mpuport - (optional) MPU401 I/O port
351 mpuirq - (optional) MPU401 irq #
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100353 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
Takashi Iwaia4efc232005-11-17 17:24:26 +0100355 The power-management is supported.
356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 Module snd-cmipci
358 -----------------
359
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200360 Module for C-Media CMI8338/8738/8768/8770 PCI sound cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
Clemens Ladischc78c9502007-09-03 09:55:49 +0200362 mpu_port - port address of MIDI interface (8338 only):
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200363 0x300,0x310,0x320,0x330 = legacy port,
Takashi Iwaicab5c4c2006-05-04 14:36:08 +0200364 0 = disable (default)
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200365 fm_port - port address of OPL-3 FM synthesizer (8x38 only):
366 0x388 = legacy port,
367 1 = integrated PCI port (default on 8738),
Takashi Iwai2f24d152007-02-15 18:56:43 +0100368 0 = disable
Takashi Iwai62430082005-09-05 17:12:29 +0200369 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 (default = 1)
371 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
372
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100373 This module supports autoprobe and multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
Takashi Iwaia4efc232005-11-17 17:24:26 +0100375 The power-management is supported.
376
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 Module snd-cs4231
378 -----------------
379
380 Module for sound cards based on CS4231 ISA chips.
381
382 port - port # for CS4231 chip
383 mpu_port - port # for MPU-401 UART (optional), -1 = disable
384 irq - IRQ # for CS4231 chip
385 mpu_irq - IRQ # for MPU-401 UART
386 dma1 - first DMA # for CS4231 chip
387 dma2 - second DMA # for CS4231 chip
388
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100389 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 thus main port must be specified!!! Other ports are optional.
391
392 The power-management is supported.
393
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 Module snd-cs4236
395 -----------------
396
Takashi Iwaic844a5d2009-02-16 23:17:33 +0100397 Module for sound cards based on CS4232/CS4232A,
398 CS4235/CS4236/CS4236B/CS4237B/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 CS4238B/CS4239 ISA chips.
400
Rene Herman64e0e2d2007-12-13 16:29:33 +0100401 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
402
403 with isapnp=0, the following options are available:
404
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 port - port # for CS4236 chip (PnP setup - 0x534)
406 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
407 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
408 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
409 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
410 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
411 dma1 - first DMA # for CS4236 chip (0,1,3)
412 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100414 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 (if ISA PnP is not used) thus main port and control port must be
416 specified!!! Other ports are optional.
417
418 The power-management is supported.
419
Takashi Iwaic844a5d2009-02-16 23:17:33 +0100420 This module is aliased as snd-cs4232 since it provides the old
421 snd-cs4232 functionality, too.
422
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 Module snd-cs4281
424 -----------------
425
426 Module for Cirrus Logic CS4281 soundchip.
427
428 dual_codec - Secondary codec ID (0 = disable, default)
429
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100430 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
432 The power-management is supported.
433
434 Module snd-cs46xx
435 -----------------
436
437 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
438 CS4624/CS4630/CS4280 PCI chips.
439
Takashi Iwai62430082005-09-05 17:12:29 +0200440 external_amp - Force to enable external amplifier.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 thinkpad - Force to enable Thinkpad's CLKRUN control.
442 mmap_valid - Support OSS mmap mode (default = 0).
443
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100444 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 Usually external amp and CLKRUN controls are detected automatically
446 from PCI sub vendor/device ids. If they don't work, give the options
447 above explicitly.
448
449 The power-management is supported.
Takashi Iwai621887a2007-05-24 18:46:54 +0200450
451 Module snd-cs5530
452 _________________
453
454 Module for Cyrix/NatSemi Geode 5530 chip.
455
Takashi Iwai3e873172005-11-17 10:15:37 +0100456 Module snd-cs5535audio
457 ----------------------
458
459 Module for multifunction CS5535 companion PCI device
460
Takashi Iwaic00bd742006-05-19 19:22:34 +0200461 The power-management is supported.
Takashi Iwai3e873172005-11-17 10:15:37 +0100462
Wai Yew CHAY8cc72362009-05-14 08:05:58 +0200463 Module snd-ctxfi
464 ----------------
465
466 Module for Creative Sound Blaster X-Fi boards (20k1 / 20k2 chips)
467 * Creative Sound Blaster X-Fi Titanium Fatal1ty Champion Series
468 * Creative Sound Blaster X-Fi Titanium Fatal1ty Professional Series
469 * Creative Sound Blaster X-Fi Titanium Professional Audio
470 * Creative Sound Blaster X-Fi Titanium
471 * Creative Sound Blaster X-Fi Elite Pro
472 * Creative Sound Blaster X-Fi Platinum
473 * Creative Sound Blaster X-Fi Fatal1ty
474 * Creative Sound Blaster X-Fi XtremeGamer
475 * Creative Sound Blaster X-Fi XtremeMusic
476
477 reference_rate - reference sample rate, 44100 or 48000 (default)
478 multiple - multiple to ref. sample rate, 1 or 2 (default)
479
480 This module supports multiple cards.
481
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200482 Module snd-darla20
483 ------------------
484
485 Module for Echoaudio Darla20
486
487 This module supports multiple cards.
488 The driver requires the firmware loader support on kernel.
489
490 Module snd-darla24
491 ------------------
492
493 Module for Echoaudio Darla24
494
495 This module supports multiple cards.
496 The driver requires the firmware loader support on kernel.
497
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 Module snd-dt019x
499 -----------------
500
501 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
502 only)
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 Iwai30681bcf2009-09-03 16:08:08 +0200516 pcm_devs - Number of PCM devices assigned to each card
517 (default = 1, up to 4)
518 pcm_substreams - Number of PCM substreams assigned to each PCM
519 (default = 8, up to 16)
520 hrtimer - Use hrtimer (=1, default) or system timer (=0)
Takashi Iwaia68c4d12009-09-04 12:19:36 +0200521 fake_buffer - Fake buffer allocations (default = 1)
Takashi Iwai30681bcf2009-09-03 16:08:08 +0200522
523 When multiple PCM devices are created, snd-dummy gives different
524 behavior to each PCM device:
525 0 = interleaved with mmap support
526 1 = non-interleaved with mmap support
527 2 = interleaved without mmap
528 3 = non-interleaved without mmap
529
Takashi Iwaia68c4d12009-09-04 12:19:36 +0200530 As default, snd-dummy drivers doesn't allocate the real buffers
531 but either ignores read/write or mmap a single dummy page to all
532 buffer pages, in order to save the resouces. If your apps need
533 the read/ written buffer data to be consistent, pass fake_buffer=0
534 option.
535
Takashi Iwaia4efc232005-11-17 17:24:26 +0100536 The power-management is supported.
537
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200538 Module snd-echo3g
539 -----------------
540
541 Module for Echoaudio 3G cards (Gina3G/Layla3G)
542
543 This module supports multiple cards.
544 The driver requires the firmware loader support on kernel.
545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 Module snd-emu10k1
547 ------------------
548
549 Module for EMU10K1/EMU10k2 based PCI sound cards.
550 * Sound Blaster Live!
551 * Sound Blaster PCI 512
552 * Emu APS (partially supported)
553 * Sound Blaster Audigy
554
555 extin - bitmap of available external inputs for FX8010 (see bellow)
556 extout - bitmap of available external outputs for FX8010 (see bellow)
557 seq_ports - allocated sequencer ports (4 by default)
558 max_synth_voices - limit of voices used for wavetable (64 by default)
559 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
560 given in MB unit. Default value is 128.
561 enable_ir - enable IR
562
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100563 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564
565 Input & Output configurations [extin/extout]
566 * Creative Card wo/Digital out [0x0003/0x1f03]
567 * Creative Card w/Digital out [0x0003/0x1f0f]
568 * Creative Card w/Digital CD in [0x000f/0x1f0f]
569 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
570 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
571 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
572 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
573 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
574 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
575 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
576 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
577 * Creative Card all ins and outs [0x3fff/0x7fff]
578
Takashi Iwaia4efc232005-11-17 17:24:26 +0100579 The power-management is supported.
580
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 Module snd-emu10k1x
582 -------------------
583
584 Module for Creative Emu10k1X (SB Live Dell OEM version)
585
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100586 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587
588 Module snd-ens1370
589 ------------------
590
591 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
592 * SoundBlaster PCI 64
593 * SoundBlaster PCI 128
594
595 joystick - Enable joystick (default off)
596
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100597 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100599 The power-management is supported.
600
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 Module snd-ens1371
602 ------------------
603
604 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
605 * SoundBlaster PCI 64
606 * SoundBlaster PCI 128
607 * SoundBlaster Vibra PCI
608
609 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
610 0 = disable (default), 1 = auto-detect
611
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100612 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100614 The power-management is supported.
615
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 Module snd-es968
617 ----------------
618
619 Module for sound cards based on ESS ES968 chip (PnP only).
620
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100621 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
Takashi Iwaia4efc232005-11-17 17:24:26 +0100623 The power-management is supported.
624
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 Module snd-es1688
626 -----------------
627
628 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
629
630 port - port # for ES-1688 chip (0x220,0x240,0x260)
Takashi Iwai504a06d2009-01-30 19:59:10 +0100631 fm_port - port # for OPL3 (option; share the same port as default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
633 irq - IRQ # for ES-1688 chip (5,7,9,10)
634 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
635 dma8 - DMA # for ES-1688 chip (0,1,3)
636
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100637 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
639 Module snd-es18xx
640 -----------------
641
642 Module for ESS AudioDrive ES-18xx sound cards.
643
Rene Herman64e0e2d2007-12-13 16:29:33 +0100644 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
645
646 with isapnp=0, the following options are available:
647
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 port - port # for ES-18xx chip (0x220,0x240,0x260)
649 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
650 fm_port - port # for FM (optional, not used)
651 irq - IRQ # for ES-18xx chip (5,7,9,10)
652 dma1 - first DMA # for ES-18xx chip (0,1,3)
653 dma2 - first DMA # for ES-18xx chip (0,1,3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100655 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
656 port if native ISA PnP routines are not used).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 When dma2 is equal with dma1, the driver works as half-duplex.
658
659 The power-management is supported.
660
661 Module snd-es1938
662 -----------------
663
664 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
665
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100666 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
Takashi Iwaia4efc232005-11-17 17:24:26 +0100668 The power-management is supported.
669
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 Module snd-es1968
671 -----------------
672
673 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
674
675 total_bufsize - total buffer size in kB (1-4096kB)
676 pcm_substreams_p - playback channels (1-8, default=2)
677 pcm_substreams_c - capture channels (1-8, default=0)
678 clock - clock (0 = auto-detection)
679 use_pm - support the power-management (0 = off, 1 = on,
680 2 = auto (default))
681 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
682 joystick - enable joystick (default off)
683
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100684 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685
686 The power-management is supported.
687
688 Module snd-fm801
689 ----------------
690
691 Module for ForteMedia FM801 based PCI sound cards.
692
693 tea575x_tuner - Enable TEA575x tuner
694 - 1 = MediaForte 256-PCS
695 - 2 = MediaForte 256-PCPR
696 - 3 = MediaForte 64-PCR
697 - High 16-bits are video (radio) device number + 1
698 - example: 0x10002 (MediaForte 256-PCPR, device 1)
699
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100700 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701
Takashi Iwaia4efc232005-11-17 17:24:26 +0100702 The power-management is supported.
703
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200704 Module snd-gina20
705 -----------------
706
707 Module for Echoaudio Gina20
708
709 This module supports multiple cards.
710 The driver requires the firmware loader support on kernel.
711
712 Module snd-gina24
713 -----------------
714
715 Module for Echoaudio Gina24
716
717 This module supports multiple cards.
718 The driver requires the firmware loader support on kernel.
719
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 Module snd-gusclassic
721 ---------------------
722
723 Module for Gravis UltraSound Classic sound card.
724
725 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
726 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
727 dma1 - DMA # for GF1 chip (1,3,5,6,7)
728 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
729 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
730 voices - GF1 voices limit (14-32)
731 pcm_voices - reserved PCM voices
732
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100733 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734
735 Module snd-gusextreme
736 ---------------------
737
738 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
739
740 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
741 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
742 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
743 irq - IRQ # for ES-1688 chip (5,7,9,10)
744 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
745 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
746 dma8 - DMA # for ES-1688 chip (0,1,3)
747 dma1 - DMA # for GF1 chip (1,3,5,6,7)
748 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
749 voices - GF1 voices limit (14-32)
750 pcm_voices - reserved PCM voices
751
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100752 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753
754 Module snd-gusmax
755 -----------------
756
757 Module for Gravis UltraSound MAX sound card.
758
759 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
760 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
761 dma1 - DMA # for GF1 chip (1,3,5,6,7)
762 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
763 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
764 voices - GF1 voices limit (14-32)
765 pcm_voices - reserved PCM voices
766
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100767 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768
769 Module snd-hda-intel
770 --------------------
771
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400772 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8, ICH9, ICH10,
773 PCH, SCH),
774 ATI SB450, SB600, R600, RS600, RS690, RS780, RV610, RV620,
775 RV630, RV635, RV670, RV770,
Takashi Iwai9b878192006-05-17 11:26:39 +0200776 VIA VT8251/VT8237A,
777 SIS966, ULI M5461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100779 [Multiple options for each card instance]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 model - force the model name
Takashi Iwaid2e1c972008-06-10 17:53:34 +0200781 position_fix - Fix DMA pointer (0 = auto, 1 = use LPIB, 2 = POSBUF)
Takashi Iwai95904742007-05-19 17:06:42 +0200782 probe_mask - Bitmask to probe codecs (default = -1, meaning all slots)
Takashi Iwaiae374d62009-02-13 08:33:55 +0100783 When the bit 8 (0x100) is set, the lower 8 bits are used
784 as the "fixed" codec slots; i.e. the driver probes the
785 slots regardless what hardware reports back
Takashi Iwaid4d9cd032008-12-19 15:19:11 +0100786 probe_only - Only probing and no codec initialization (default=off);
787 Useful to check the initial codec status for debugging
Takashi Iwai8c53b962008-06-10 17:53:35 +0200788 bdl_pos_adj - Specifies the DMA IRQ timing delay in samples.
789 Passing -1 will make the driver to choose the appropriate
790 value based on the controller chip.
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100791
792 [Single (global) options]
Takashi Iwai27346162006-01-12 18:28:44 +0100793 single_cmd - Use single immediate commands to communicate with
794 codecs (for debugging only)
Takashi Iwai134a11f2006-11-10 12:08:37 +0100795 enable_msi - Enable Message Signaled Interrupt (MSI) (default = off)
Matt LaPlante19f59462009-04-27 15:06:31 +0200796 power_save - Automatic power-saving timeout (in second, 0 =
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200797 disable)
Takashi Iwaidee1b662007-08-13 16:10:30 +0200798 power_save_controller - Reset HD-audio controller in power-saving mode
799 (default = on)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100801 This module supports multiple cards and autoprobe.
802
Takashi Iwaicae51172008-12-19 08:36:53 +0100803 See Documentation/sound/alsa/HD-Audio.txt for more details about
804 HD-audio driver.
805
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 Each codec may have a model table for different configurations.
807 If your machine isn't listed there, the default (usually minimal)
808 configuration is set up. You can pass "model=<name>" option to
809 specify a certain model in such a case. There are different
Takashi Iwaicae51172008-12-19 08:36:53 +0100810 models depending on the codec chip. The list of available models
811 is found in HD-Audio-Models.txt
Takashi Iwaidb064e52006-03-16 16:04:58 +0100812
Takashi Iwai6d7b1d72007-02-26 15:56:46 +0100813 The model name "genric" is treated as a special case. When this
814 model is given, the driver uses the generic codec parser without
815 "codec-patch". It's sometimes good for testing and debugging.
816
Takashi Iwai62430082005-09-05 17:12:29 +0200817 If the default configuration doesn't work and one of the above
Takashi Iwai30bc4482008-12-09 08:23:45 +0100818 matches with your device, report it together with alsa-info.sh
819 output (with --no-upload option) to kernel bugzilla or alsa-devel
Takashi Iwai62430082005-09-05 17:12:29 +0200820 ML (see the section "Links and Addresses").
821
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200822 power_save and power_save_controller options are for power-saving
823 mode. See powersave.txt for details.
Takashi Iwaidee1b662007-08-13 16:10:30 +0200824
Takashi Iwaic74db862005-05-12 14:26:27 +0200825 Note 2: If you get click noises on output, try the module option
826 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
827 register value without FIFO size correction as the current
828 DMA pointer. position_fix=2 will make the driver to use
829 the position buffer instead of reading SD_LPIB register.
Michael Kerrisk90f31e32008-09-01 14:03:50 +0200830 (Usually SD_LPIB register is more accurate than the
Takashi Iwaic74db862005-05-12 14:26:27 +0200831 position buffer.)
832
Takashi Iwai27346162006-01-12 18:28:44 +0100833 NB: If you get many "azx_get_response timeout" messages at
834 loading, it's likely a problem of interrupts (e.g. ACPI irq
835 routing). Try to boot with options like "pci=noacpi". Also, you
836 can try "single_cmd=1" module option. This will switch the
837 communication method between HDA controller and codecs to the
838 single immediate commands instead of CORB/RIRB. Basically, the
839 single command mode is provided only for BIOS, and you won't get
840 unsolicited events, too. But, at least, this works independently
841 from the irq. Remember this is a last resort, and should be
842 avoided as much as possible...
843
Takashi Iwai95904742007-05-19 17:06:42 +0200844 MORE NOTES ON "azx_get_response timeout" PROBLEMS:
845 On some hardwares, you may need to add a proper probe_mask option
846 to avoid the "azx_get_response timeout" problem above, instead.
847 This occurs when the access to non-existing or non-working codec slot
848 (likely a modem one) causes a stall of the communication via HD-audio
849 bus. You can see which codec slots are probed by enabling
Takashi Iwai62cf8722008-05-20 12:15:15 +0200850 CONFIG_SND_DEBUG_VERBOSE, or simply from the file name of the codec
Takashi Iwai95904742007-05-19 17:06:42 +0200851 proc files. Then limit the slots to probe by probe_mask option.
852 For example, probe_mask=1 means to probe only the first slot, and
853 probe_mask=4 means only the third slot.
854
Takashi Iwaia4efc232005-11-17 17:24:26 +0100855 The power-management is supported.
856
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 Module snd-hdsp
858 ---------------
859
860 Module for RME Hammerfall DSP audio interface(s)
861
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100862 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863
864 Note: The firmware data can be automatically loaded via hotplug
865 when CONFIG_FW_LOADER is set. Otherwise, you need to load
866 the firmware via hdsploader utility included in alsa-tools
867 package.
868 The firmware data is found in alsa-firmware package.
869
870 Note: snd-page-alloc module does the job which snd-hammerfall-mem
871 module did formerly. It will allocate the buffers in advance
872 when any HDSP cards are found. To make the buffer
873 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +0200874 stage of boot sequence. See "Early Buffer Allocation"
875 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876
Takashi Iwai54704402005-06-03 11:27:00 +0200877 Module snd-hdspm
878 ----------------
879
880 Module for RME HDSP MADI board.
881
882 precise_ptr - Enable precise pointer, or disable.
883 line_outs_monitor - Send playback streams to analog outs by default.
884 enable_monitor - Enable Analog Out on Channel 63/64 by default.
885
886 See hdspm.txt for details.
887
Clemens Ladischc6260262008-01-25 08:41:52 +0100888 Module snd-hifier
889 -----------------
890
891 Module for the MediaTek/TempoTec HiFier Fantasia sound card.
892
893 This module supports autoprobe and multiple cards.
894
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 Module snd-ice1712
896 ------------------
897
898 Module for Envy24 (ICE1712) based PCI sound cards.
899 * MidiMan M Audio Delta 1010
900 * MidiMan M Audio Delta 1010LT
901 * MidiMan M Audio Delta DiO 2496
902 * MidiMan M Audio Delta 66
903 * MidiMan M Audio Delta 44
904 * MidiMan M Audio Delta 410
905 * MidiMan M Audio Audiophile 2496
906 * TerraTec EWS 88MT
907 * TerraTec EWS 88D
908 * TerraTec EWX 24/96
909 * TerraTec DMX 6Fire
Takashi Iwaic9bce912005-05-24 13:41:03 +0200910 * TerraTec Phase 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 * Hoontech SoundTrack DSP 24
912 * Hoontech SoundTrack DSP 24 Value
913 * Hoontech SoundTrack DSP 24 Media 7.1
Takashi Iwaic9bce912005-05-24 13:41:03 +0200914 * Event Electronics, EZ8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 * Digigram VX442
Takashi Iwaic9bce912005-05-24 13:41:03 +0200916 * Lionstracs, Mediastaton
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400917 * Terrasoniq TS 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
919 model - Use the given board model, one of the following:
920 delta1010, dio2496, delta66, delta44, audiophile, delta410,
921 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
Takashi Iwaic9bce912005-05-24 13:41:03 +0200922 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
923 phase88, mediastation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 omni - Omni I/O support for MidiMan M-Audio Delta44/66
Matt LaPlantefa00e7e2006-11-30 04:55:36 +0100925 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transceiver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926 in msec resolution, default value is 500 (0.5 sec)
927
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100928 This module supports multiple cards and autoprobe. Note: The consumer part
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 is not used with all Envy24 based cards (for example in the MidiMan Delta
930 serie).
931
Takashi Iwaic9bce912005-05-24 13:41:03 +0200932 Note: The supported board is detected by reading EEPROM or PCI
933 SSID (if EEPROM isn't available). You can override the
934 model by passing "model" module option in case that the
935 driver isn't configured properly or you want to try another
936 type for testing.
937
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 Module snd-ice1724
939 ------------------
940
Takashi Iwaic9bce912005-05-24 13:41:03 +0200941 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100942 * MidiMan M Audio Revolution 5.1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943 * MidiMan M Audio Revolution 7.1
Takashi Iwai56255062006-11-09 16:47:26 +0100944 * MidiMan M Audio Audiophile 192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 * AMP Ltd AUDIO2000
Takashi Iwaic9bce912005-05-24 13:41:03 +0200946 * TerraTec Aureon 5.1 Sky
947 * TerraTec Aureon 7.1 Space
948 * TerraTec Aureon 7.1 Universe
949 * TerraTec Phase 22
950 * TerraTec Phase 28
951 * AudioTrak Prodigy 7.1
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400952 * AudioTrak Prodigy 7.1 LT
953 * AudioTrak Prodigy 7.1 XT
954 * AudioTrak Prodigy 7.1 HIFI
955 * AudioTrak Prodigy 7.1 HD2
Takashi Iwaic9bce912005-05-24 13:41:03 +0200956 * AudioTrak Prodigy 192
957 * Pontis MS300
958 * Albatron K8X800 Pro II
959 * Chaintech ZNF3-150
960 * Chaintech ZNF3-250
961 * Chaintech 9CJS
Takashi Iwai8cfbbac2005-05-27 12:10:40 +0200962 * Chaintech AV-710
Takashi Iwaic9bce912005-05-24 13:41:03 +0200963 * Shuttle SN25P
Shin-ya Okadaf31639b2007-10-23 15:08:18 +0200964 * Onkyo SE-90PCI
965 * Onkyo SE-200PCI
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400966 * ESI Juli@
Takashi Iwai72cbfd42009-05-06 17:33:19 +0200967 * ESI Maya44
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400968 * Hercules Fortissimo IV
969 * EGO-SYS WaveTerminal 192M
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970
971 model - Use the given board model, one of the following:
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100972 revo51, revo71, amp2000, prodigy71, prodigy71lt,
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400973 prodigy71xt, prodigy71hifi, prodigyhd2, prodigy192,
974 juli, aureon51, aureon71, universe, ap192, k8x800,
975 phase22, phase28, ms300, av710, se200pci, se90pci,
Takashi Iwai72cbfd42009-05-06 17:33:19 +0200976 fortissimo4, sn25p, WT192M, maya44
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100978 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979
Takashi Iwaic9bce912005-05-24 13:41:03 +0200980 Note: The supported board is detected by reading EEPROM or PCI
981 SSID (if EEPROM isn't available). You can override the
982 model by passing "model" module option in case that the
983 driver isn't configured properly or you want to try another
984 type for testing.
985
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200986 Module snd-indigo
987 -----------------
988
989 Module for Echoaudio Indigo
990
991 This module supports multiple cards.
992 The driver requires the firmware loader support on kernel.
993
994 Module snd-indigodj
995 -------------------
996
997 Module for Echoaudio Indigo DJ
998
999 This module supports multiple cards.
1000 The driver requires the firmware loader support on kernel.
1001
1002 Module snd-indigoio
1003 -------------------
1004
1005 Module for Echoaudio Indigo IO
1006
1007 This module supports multiple cards.
1008 The driver requires the firmware loader support on kernel.
1009
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010 Module snd-intel8x0
1011 -------------------
1012
1013 Module for AC'97 motherboards from Intel and compatibles.
1014 * Intel i810/810E, i815, i820, i830, i84x, MX440
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001015 ICH5, ICH6, ICH7, 6300ESB, ESB2
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 * SiS 7012 (SiS 735)
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001017 * NVidia NForce, NForce2, NForce3, MCP04, CK804
1018 CK8, CK8S, MCP501
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019 * AMD AMD768, AMD8111
1020 * ALi m5455
1021
1022 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1023 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001024 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 buggy_irq - Enable workaround for buggy interrupts on some
Takashi Iwaia06147d2005-09-08 19:54:17 +02001026 motherboards (default yes on nForce chips,
1027 otherwise off)
1028 buggy_semaphore - Enable workaround for hardwares with buggy
1029 semaphores (e.g. on some ASUS laptops)
1030 (default off)
Takashi Iwai6c5cfd92006-11-28 17:18:25 +01001031 spdif_aclink - Use S/PDIF over AC-link instead of direct connection
1032 from the controller chip
1033 (0 = off, 1 = on, -1 = default)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001035 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036
1037 Note: the latest driver supports auto-detection of chip clock.
1038 if you still encounter too fast playback, specify the clock
1039 explicitly via the module option "ac97_clock=41194".
1040
1041 Joystick/MIDI ports are not supported by this driver. If your
1042 motherboard has these devices, use the ns558 or snd-mpu401
1043 modules, respectively.
1044
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 The power-management is supported.
1046
1047 Module snd-intel8x0m
1048 --------------------
1049
1050 Module for Intel ICH (i8x0) chipset MC97 modems.
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001051 * Intel i810/810E, i815, i820, i830, i84x, MX440
1052 ICH5, ICH6, ICH7
1053 * SiS 7013 (SiS 735)
1054 * NVidia NForce, NForce2, NForce2s, NForce3
1055 * AMD AMD8111
1056 * ALi m5455
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057
1058 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1059
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001060 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061
1062 Note: The default index value of this module is -2, i.e. the first
1063 slot is excluded.
1064
Takashi Iwaia4efc232005-11-17 17:24:26 +01001065 The power-management is supported.
1066
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 Module snd-interwave
1068 --------------------
1069
1070 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1071 and other sound cards based on AMD InterWave (tm) chip.
1072
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1074 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1075 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1076 effect - 1 = InterWave effects enable (default 0);
1077 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001078 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1079
1080 with isapnp=0, the following options are available:
1081
1082 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1083 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1084 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1085 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001087 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088
1089 Module snd-interwave-stb
1090 ------------------------
1091
1092 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1093 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1094 circuit for extended control of bass, treble and master volume.
1095
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1097 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1098 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1099 effect - 1 = InterWave effects enable (default 0);
1100 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001101 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1102
1103 with isapnp=0, the following options are available:
1104
1105 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1106 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1107 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1108 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1109 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001111 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112
1113 Module snd-korg1212
1114 -------------------
1115
1116 Module for Korg 1212 IO PCI card
1117
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001118 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001120 Module snd-layla20
1121 ------------------
1122
1123 Module for Echoaudio Layla20
1124
1125 This module supports multiple cards.
1126 The driver requires the firmware loader support on kernel.
1127
1128 Module snd-layla24
1129 ------------------
1130
1131 Module for Echoaudio Layla24
1132
1133 This module supports multiple cards.
1134 The driver requires the firmware loader support on kernel.
1135
Takashi Iwai8338c302009-04-14 12:30:36 +02001136 Module snd-lx6464es
1137 -------------------
1138
1139 Module for Digigram LX6464ES boards
1140
1141 This module supports multiple cards.
1142
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143 Module snd-maestro3
1144 -------------------
1145
1146 Module for Allegro/Maestro3 chips
1147
1148 external_amp - enable external amp (enabled by default)
1149 amp_gpio - GPIO pin number for external amp (0-15) or
1150 -1 for default pin (8 for allegro, 1 for
1151 others)
1152
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001153 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154
1155 Note: the binding of amplifier is dependent on hardware.
1156 If there is no sound even though all channels are unmuted, try to
1157 specify other gpio connection via amp_gpio option.
1158 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1159 option.
1160
1161 The power-management is supported.
1162
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001163 Module snd-mia
1164 ---------------
1165
1166 Module for Echoaudio Mia
1167
1168 This module supports multiple cards.
1169 The driver requires the firmware loader support on kernel.
1170
Martin Langer1841f612006-03-27 12:41:01 +02001171 Module snd-miro
1172 ---------------
1173
1174 Module for Miro soundcards: miroSOUND PCM 1 pro,
1175 miroSOUND PCM 12,
1176 miroSOUND PCM 20 Radio.
1177
1178 port - Port # (0x530,0x604,0xe80,0xf40)
1179 irq - IRQ # (5,7,9,10,11)
1180 dma1 - 1st dma # (0,1,3)
1181 dma2 - 2nd dma # (0,1)
1182 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1183 mpu_irq - MPU-401 irq # (5,7,9,10)
1184 fm_port - FM Port # (0x388)
1185 wss - enable WSS mode
1186 ide - enable onboard ide support
1187
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 Module snd-mixart
1189 -----------------
1190
1191 Module for Digigram miXart8 sound cards.
1192
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001193 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 Note: One miXart8 board will be represented as 4 alsa cards.
1195 See MIXART.txt for details.
1196
1197 When the driver is compiled as a module and the hotplug firmware
1198 is supported, the firmware data is loaded via hotplug automatically.
1199 Install the necessary firmware files in alsa-firmware package.
1200 When no hotplug fw loader is available, you need to load the
1201 firmware via mixartloader utility in alsa-tools package.
1202
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001203 Module snd-mona
1204 ---------------
1205
1206 Module for Echoaudio Mona
1207
1208 This module supports multiple cards.
1209 The driver requires the firmware loader support on kernel.
1210
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211 Module snd-mpu401
1212 -----------------
1213
1214 Module for MPU-401 UART devices.
1215
1216 port - port number or -1 (disable)
1217 irq - IRQ number or -1 (disable)
1218 pnp - PnP detection - 0 = disable, 1 = enable (default)
1219
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001220 This module supports multiple devices and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001221
Takashi Iwaic96330b2009-01-28 08:23:03 +01001222 Module snd-msnd-classic
1223 -----------------------
1224
1225 Module for Turtle Beach MultiSound Classic, Tahiti or Monterey
1226 soundcards.
1227
1228 io - Port # for msnd-classic card
1229 irq - IRQ # for msnd-classic card
1230 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1231 0xe0000 or 0xe8000)
1232 write_ndelay - enable write ndelay (default = 1)
1233 calibrate_signal - calibrate signal (default = 0)
1234 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1235 digital - Digital daughterboard present (default = 0)
1236 cfg - Config port (0x250, 0x260 or 0x270) default = PnP
1237 reset - Reset all devices
1238 mpu_io - MPU401 I/O port
1239 mpu_irq - MPU401 irq#
1240 ide_io0 - IDE port #0
1241 ide_io1 - IDE port #1
1242 ide_irq - IDE irq#
1243 joystick_io - Joystick I/O port
1244
1245 The driver requires firmware files "turtlebeach/msndinit.bin" and
1246 "turtlebeach/msndperm.bin" in the proper firmware directory.
1247
1248 See Documentation/sound/oss/MultiSound for important information
1249 about this driver. Note that it has been discontinued, but the
1250 Voyetra Turtle Beach knowledge base entry for it is still available
1251 at
1252 http://www.turtlebeach.com/site/kb_ftp/790.asp
1253
1254 Module snd-msnd-pinnacle
1255 ------------------------
1256
1257 Module for Turtle Beach MultiSound Pinnacle/Fiji soundcards.
1258
1259 io - Port # for pinnacle/fiji card
1260 irq - IRQ # for pinnalce/fiji card
1261 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1262 0xe0000 or 0xe8000)
1263 write_ndelay - enable write ndelay (default = 1)
1264 calibrate_signal - calibrate signal (default = 0)
1265 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1266
1267 The driver requires firmware files "turtlebeach/pndspini.bin" and
1268 "turtlebeach/pndsperm.bin" in the proper firmware directory.
1269
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 Module snd-mtpav
1271 ----------------
1272
1273 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1274 port).
1275
1276 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1277 irq - IRQ # for MTPAV (7,5, default=7)
1278 hwports - number of supported hardware ports, default=8.
1279
1280 Module supports only 1 card. This module has no enable option.
1281
Matthias Koenig68ab8012006-07-27 16:59:23 +02001282 Module snd-mts64
1283 ----------------
1284
1285 Module for Ego Systems (ESI) Miditerminal 4140
1286
1287 This module supports multiple devices.
1288 Requires parport (CONFIG_PARPORT).
1289
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290 Module snd-nm256
1291 ----------------
1292
1293 Module for NeoMagic NM256AV/ZX chips
1294
1295 playback_bufsize - max playback frame size in kB (4-128kB)
1296 capture_bufsize - max capture frame size in kB (4-128kB)
1297 force_ac97 - 0 or 1 (disabled by default)
1298 buffer_top - specify buffer top address
1299 use_cache - 0 or 1 (disabled by default)
1300 vaio_hack - alias buffer_top=0x25a800
1301 reset_workaround - enable AC97 RESET workaround for some laptops
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001302 reset_workaround2 - enable extended AC97 RESET workaround for some
1303 other laptops
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +02001305 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306
1307 The power-management is supported.
1308
1309 Note: on some notebooks the buffer address cannot be detected
1310 automatically, or causes hang-up during initialization.
Matt LaPlantefff92892006-10-03 22:47:42 +02001311 In such a case, specify the buffer top address explicitly via
1312 the buffer_top option.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 For example,
1314 Sony F250: buffer_top=0x25a800
1315 Sony F270: buffer_top=0x272800
1316 The driver supports only ac97 codec. It's possible to force
1317 to initialize/use ac97 although it's not detected. In such a
1318 case, use force_ac97=1 option - but *NO* guarantee whether it
1319 works!
1320
1321 Note: The NM256 chip can be linked internally with non-AC97
1322 codecs. This driver supports only the AC97 codec, and won't work
1323 with machines with other (most likely CS423x or OPL3SAx) chips,
1324 even though the device is detected in lspci. In such a case, try
1325 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
Takashi Iwai62430082005-09-05 17:12:29 +02001326 but some doesn't have ISA PnP. You'll need to specify isapnp=0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 and proper hardware parameters in the case without ISA PnP.
1328
1329 Note: some laptops need a workaround for AC97 RESET. For the
1330 known hardware like Dell Latitude LS and Sony PCG-F305, this
1331 workaround is enabled automatically. For other laptops with a
1332 hard freeze, you can try reset_workaround=1 option.
1333
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001334 Note: Dell Latitude CSx laptops have another problem regarding
1335 AC97 RESET. On these laptops, reset_workaround2 option is
1336 turned on as default. This option is worth to try if the
1337 previous reset_workaround option doesn't help.
1338
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 Note: This driver is really crappy. It's a porting from the
1340 OSS driver, which is a result of black-magic reverse engineering.
1341 The detection of codec will fail if the driver is loaded *after*
1342 X-server as described above. You might be able to force to load
1343 the module, but it may result in hang-up. Hence, make sure that
1344 you load this module *before* X if you encounter this kind of
1345 problem.
1346
1347 Module snd-opl3sa2
1348 ------------------
1349
1350 Module for Yamaha OPL3-SA2/SA3 sound cards.
1351
Rene Herman64e0e2d2007-12-13 16:29:33 +01001352 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1353
1354 with isapnp=0, the following options are available:
1355
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 port - control port # for OPL3-SA chip (0x370)
1357 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1358 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1359 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1360 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1361 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1362 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1363 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001365 This module supports multiple cards and ISA PnP. It does not support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1367
1368 The power-management is supported.
1369
1370 Module snd-opti92x-ad1848
1371 -------------------------
1372
1373 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1374 Module works with OAK Mozart cards as well.
1375
Rene Herman64e0e2d2007-12-13 16:29:33 +01001376 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1377
1378 with isapnp=0, the following options are available:
1379
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1381 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1382 fm_port - port # for OPL3 device (0x388)
1383 irq - IRQ # for WSS chip (5,7,9,10,11)
1384 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1385 dma1 - first DMA # for WSS chip (0,1,3)
1386
1387 This module supports only one card, autoprobe and PnP.
1388
1389 Module snd-opti92x-cs4231
1390 -------------------------
1391
1392 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1393
Rene Herman64e0e2d2007-12-13 16:29:33 +01001394 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1395
1396 with isapnp=0, the following options are available:
1397
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1399 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1400 fm_port - port # for OPL3 device (0x388)
1401 irq - IRQ # for WSS chip (5,7,9,10,11)
1402 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1403 dma1 - first DMA # for WSS chip (0,1,3)
1404 dma2 - second DMA # for WSS chip (0,1,3)
1405
1406 This module supports only one card, autoprobe and PnP.
1407
1408 Module snd-opti93x
1409 ------------------
1410
1411 Module for sound cards based on OPTi 82c93x chips.
1412
Rene Herman64e0e2d2007-12-13 16:29:33 +01001413 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1414
1415 with isapnp=0, the following options are available:
1416
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1418 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1419 fm_port - port # for OPL3 device (0x388)
1420 irq - IRQ # for WSS chip (5,7,9,10,11)
1421 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1422 dma1 - first DMA # for WSS chip (0,1,3)
1423 dma2 - second DMA # for WSS chip (0,1,3)
1424
1425 This module supports only one card, autoprobe and PnP.
1426
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001427 Module snd-oxygen
1428 -----------------
1429
1430 Module for sound cards based on the C-Media CMI8788 chip:
1431 * Asound A-8788
1432 * AuzenTech X-Meridian
1433 * Bgears b-Enspirer
1434 * Club3D Theatron DTS
Clemens Ladischde04b102008-11-26 10:37:23 +01001435 * HT-Omega Claro (plus)
1436 * HT-Omega Claro halo (XT)
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001437 * Razer Barracuda AC-1
1438 * Sondigo Inferno
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001439
1440 This module supports autoprobe and multiple cards.
1441
Stas Sergeevd08cd582008-03-06 11:01:44 +01001442 Module snd-pcsp
1443 -----------------
1444
1445 Module for internal PC-Speaker.
1446
1447 nforce_wa - enable NForce chipset workaround. Expect bad sound.
1448
1449 This module supports system beeps, some kind of PCM playback and
1450 even a few mixer controls.
1451
Markus Bollingere12229b2005-12-06 13:55:26 +01001452 Module snd-pcxhr
1453 ----------------
1454
1455 Module for Digigram PCXHR boards
1456
1457 This module supports multiple cards.
1458
Matthias Koenig757e1192007-01-25 13:15:05 +01001459 Module snd-portman2x4
1460 ---------------------
1461
1462 Module for Midiman Portman 2x4 parallel port MIDI interface
1463
1464 This module supports multiple cards.
1465
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466 Module snd-powermac (on ppc only)
1467 ---------------------------------
1468
1469 Module for PowerMac, iMac and iBook on-board soundchips
1470
1471 enable_beep - enable beep using PCM (enabled as default)
1472
1473 Module supports autoprobe a chip.
1474
1475 Note: the driver may have problems regarding endianess.
1476
1477 The power-management is supported.
1478
Takashi Iwai2c484df2005-06-30 18:54:04 +02001479 Module snd-pxa2xx-ac97 (on arm only)
1480 ------------------------------------
1481
1482 Module for AC97 driver for the Intel PXA2xx chip
1483
1484 For ARM architecture only.
1485
Takashi Iwaia4efc232005-11-17 17:24:26 +01001486 The power-management is supported.
1487
Peter Gruber109a9632006-03-27 13:10:28 +02001488 Module snd-riptide
1489 ------------------
1490
1491 Module for Conexant Riptide chip
1492
1493 joystick_port - Joystick port # (default: 0x200)
1494 mpu_port - MPU401 port # (default: 0x330)
1495 opl3_port - OPL3 port # (default: 0x388)
1496
1497 This module supports multiple cards.
1498 The driver requires the firmware loader support on kernel.
1499 You need to install the firmware file "riptide.hex" to the standard
1500 firmware path (e.g. /lib/firmware).
1501
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 Module snd-rme32
1503 ----------------
1504
1505 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1506 Prodif96 and Prodif Gold) sound cards.
1507
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001508 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509
1510 Module snd-rme96
1511 ----------------
1512
1513 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1514
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001515 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516
1517 Module snd-rme9652
1518 ------------------
1519
1520 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1521
1522 precise_ptr - Enable precise pointer (doesn't work reliably).
1523 (default = 0)
1524
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001525 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526
1527 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1528 module did formerly. It will allocate the buffers in advance
1529 when any RME9652 cards are found. To make the buffer
1530 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +02001531 stage of boot sequence. See "Early Buffer Allocation"
1532 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533
1534 Module snd-sa11xx-uda1341 (on arm only)
1535 ---------------------------------------
1536
1537 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1538
1539 Module supports only one card.
1540 Module has no enable and index options.
1541
Takashi Iwaia4efc232005-11-17 17:24:26 +01001542 The power-management is supported.
1543
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 Module snd-sb8
1545 --------------
1546
1547 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1548 SoundBlaster 2.0,
1549 SoundBlaster Pro
1550
1551 port - port # for SB DSP chip (0x220,0x240,0x260)
1552 irq - IRQ # for SB DSP chip (5,7,9,10)
1553 dma8 - DMA # for SB DSP chip (1,3)
1554
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001555 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556
Takashi Iwaia4efc232005-11-17 17:24:26 +01001557 The power-management is supported.
1558
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 Module snd-sb16 and snd-sbawe
1560 -----------------------------
1561
1562 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1563 SoundBlaster AWE 32 (PnP),
1564 SoundBlaster AWE 64 PnP
1565
Rene Herman64e0e2d2007-12-13 16:29:33 +01001566 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1567 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1568 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1569
1570 with isapnp=0, the following options are available:
1571
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1573 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1574 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1575 (snd-sbawe module only)
1576 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1577 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1578 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001579
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001580 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581
1582 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1583 disable 16bit DMA with dma16 = -1 module parameter.
1584 Also, all Sound Blaster 16 type cards can operate in 16-bit
1585 half duplex mode through 8-bit DMA channel by disabling their
1586 16-bit DMA channel.
1587
Takashi Iwaia4efc232005-11-17 17:24:26 +01001588 The power-management is supported.
1589
Takashi Iwai074a6e92007-09-11 22:10:14 +02001590 Module snd-sc6000
1591 -----------------
1592
Krzysztof Heltb0ec3a32009-05-03 10:39:19 +02001593 Module for Gallant SC-6000 soundcard and later models: SC-6600
1594 and SC-7000.
Takashi Iwai074a6e92007-09-11 22:10:14 +02001595
1596 port - Port # (0x220 or 0x240)
1597 mss_port - MSS Port # (0x530 or 0xe80)
1598 irq - IRQ # (5,7,9,10,11)
Krzysztof Helt7b758d22007-09-17 14:42:49 +02001599 mpu_irq - MPU-401 IRQ # (5,7,9,10) ,0 - no MPU-401 irq
Takashi Iwai074a6e92007-09-11 22:10:14 +02001600 dma - DMA # (1,3,0)
Krzysztof Heltb0ec3a32009-05-03 10:39:19 +02001601 joystick - Enable gameport - 0 = disable (default), 1 = enable
Takashi Iwai074a6e92007-09-11 22:10:14 +02001602
1603 This module supports multiple cards.
1604
1605 This card is also known as Audio Excel DSP 16 or Zoltrix AV302.
1606
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 Module snd-sgalaxy
1608 ------------------
1609
1610 Module for Aztech Sound Galaxy sound card.
1611
1612 sbport - Port # for SB16 interface (0x220,0x240)
1613 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1614 irq - IRQ # (7,9,10,11)
1615 dma1 - DMA #
1616
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001617 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618
Takashi Iwaia4efc232005-11-17 17:24:26 +01001619 The power-management is supported.
1620
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 Module snd-sscape
1622 -----------------
1623
1624 Module for ENSONIQ SoundScape PnP cards.
1625
1626 port - Port # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001627 wss_port - WSS Port # (PnP setup)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 irq - IRQ # (PnP setup)
1629 mpu_irq - MPU-401 IRQ # (PnP setup)
1630 dma - DMA # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001631 dma2 - 2nd DMA # (PnP setup, -1 to disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001633 This module supports multiple cards. ISA PnP must be enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 You need sscape_ctl tool in alsa-tools package for loading
1635 the microcode.
1636
1637 Module snd-sun-amd7930 (on sparc only)
1638 --------------------------------------
1639
1640 Module for AMD7930 sound chips found on Sparcs.
1641
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001642 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
1644 Module snd-sun-cs4231 (on sparc only)
1645 -------------------------------------
1646
1647 Module for CS4231 sound chips found on Sparcs.
1648
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001649 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001651 Module snd-sun-dbri (on sparc only)
1652 -----------------------------------
1653
1654 Module for DBRI sound chips found on Sparcs.
1655
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001656 This module supports multiple cards.
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001657
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 Module snd-wavefront
1659 --------------------
1660
1661 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1662
Rene Herman64e0e2d2007-12-13 16:29:33 +01001663 use_cs4232_midi - Use CS4232 MPU-401 interface
1664 (inaccessibly located inside your computer)
1665 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1666
1667 with isapnp=0, the following options are available:
1668
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 cs4232_pcm_port - Port # for CS4232 PCM interface.
1670 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1671 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1672 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 ics2115_port - Port # for ICS2115
1674 ics2115_irq - IRQ # for ICS2115
1675 fm_port - FM OPL-3 Port #
1676 dma1 - DMA1 # for CS4232 PCM interface.
1677 dma2 - DMA2 # for CS4232 PCM interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678
Takashi Iwaic2b12392007-08-21 15:20:26 +02001679 The below are options for wavefront_synth features:
1680 wf_raw - Assume that we need to boot the OS (default:no)
1681 If yes, then during driver loading, the state of the board is
1682 ignored, and we reset the board and load the firmware anyway.
1683 fx_raw - Assume that the FX process needs help (default:yes)
1684 If false, we'll leave the FX processor in whatever state it is
1685 when the driver is loaded. The default is to download the
1686 microprogram and associated coefficients to set it up for
1687 "default" operation, whatever that means.
1688 debug_default - Debug parameters for card initialization
1689 wait_usecs - How long to wait without sleeping, usecs
1690 (default:150)
1691 This magic number seems to give pretty optimal throughput
1692 based on my limited experimentation.
1693 If you want to play around with it and find a better value, be
1694 my guest. Remember, the idea is to get a number that causes us
1695 to just busy wait for as many WaveFront commands as possible,
1696 without coming up with a number so large that we hog the whole
1697 CPU.
1698 Specifically, with this number, out of about 134,000 status
1699 waits, only about 250 result in a sleep.
1700 sleep_interval - How long to sleep when waiting for reply
1701 (default: 100)
1702 sleep_tries - How many times to try sleeping during a wait
1703 (default: 50)
1704 ospath - Pathname to processed ICS2115 OS firmware
1705 (default:wavefront.os)
1706 The path name of the ISC2115 OS firmware. In the recent
1707 version, it's handled via firmware loader framework, so it
1708 must be installed in the proper path, typically,
1709 /lib/firmware.
1710 reset_time - How long to wait for a reset to take effect
1711 (default:2)
1712 ramcheck_time - How many seconds to wait for the RAM test
1713 (default:20)
1714 osrun_time - How many seconds to wait for the ICS2115 OS
1715 (default:10)
1716
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001717 This module supports multiple cards and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718
Takashi Iwaic2b12392007-08-21 15:20:26 +02001719 Note: the firmware file "wavefront.os" was located in the earlier
1720 version in /etc. Now it's loaded via firmware loader, and
1721 must be in the proper firmware path, such as /lib/firmware.
1722 Copy (or symlink) the file appropriately if you get an error
1723 regarding firmware downloading after upgrading the kernel.
1724
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725 Module snd-sonicvibes
1726 ---------------------
1727
1728 Module for S3 SonicVibes PCI sound cards.
1729 * PINE Schubert 32 PCI
1730
1731 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1732 - SoundCard must have onboard SRAM for this.
1733 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1734
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001735 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736
1737 Module snd-serial-u16550
1738 ------------------------
1739
1740 Module for UART16550A serial MIDI ports.
1741
1742 port - port # for UART16550A chip
1743 irq - IRQ # for UART16550A chip, -1 = poll mode
1744 speed - speed in bauds (9600,19200,38400,57600,115200)
1745 38400 = default
1746 base - base for divisor in bauds (57600,115200,230400,460800)
1747 115200 = default
1748 outs - number of MIDI ports in a serial port (1-4)
1749 1 = default
1750 adaptor - Type of adaptor.
1751 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1752 3 = MS-124W M/B, 4 = Generic
1753
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001754 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 thus the main port must be specified!!! Other options are optional.
1756
1757 Module snd-trident
1758 ------------------
1759
1760 Module for Trident 4DWave DX/NX sound cards.
1761 * Best Union Miss Melody 4DWave PCI
1762 * HIS 4DWave PCI
1763 * Warpspeed ONSpeed 4DWave PCI
1764 * AzTech PCI 64-Q3D
1765 * Addonics SV 750
1766 * CHIC True Sound 4Dwave
1767 * Shark Predator4D-PCI
1768 * Jaton SonicWave 4D
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001769 * SiS SI7018 PCI Audio
1770 * Hoontech SoundTrack Digital 4DWave NX
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771
1772 pcm_channels - max channels (voices) reserved for PCM
1773 wavetable_size - max wavetable size in kB (4-?kb)
1774
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001775 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776
1777 The power-management is supported.
1778
1779 Module snd-usb-audio
1780 --------------------
1781
1782 Module for USB audio and USB MIDI devices.
1783
1784 vid - Vendor ID for the device (optional)
1785 pid - Product ID for the device (optional)
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001786 nrpacks - Max. number of packets per URB (default: 8)
1787 async_unlink - Use async unlink mode (default: yes)
Thibault LE MEURe3113342006-03-14 11:44:53 +01001788 device_setup - Device specific magic number (optional)
1789 - Influence depends on the device
1790 - Default: 0x0000
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001791 ignore_ctl_error - Ignore any USB-controller regarding mixer
1792 interface (default: no)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001794 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001796 NB: nrpacks parameter can be modified dynamically via sysfs.
1797 Don't put the value over 20. Changing via sysfs has no sanity
1798 check.
1799 NB: async_unlink=0 would cause Oops. It remains just for
1800 debugging purpose (if any).
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001801 NB: ignore_ctl_error=1 may help when you get an error at accessing
1802 the mixer element such as URB error -22. This happens on some
1803 buggy USB device or the controller.
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001804
Daniel Mack523f1dc2007-03-26 19:11:24 +02001805 Module snd-usb-caiaq
1806 --------------------
1807
1808 Module for caiaq UB audio interfaces,
1809 * Native Instruments RigKontrol2
1810 * Native Instruments Kore Controller
1811 * Native Instruments Audio Kontrol 1
1812 * Native Instruments Audio 8 DJ
1813
1814 This module supports multiple devices, autoprobe and hotplugging.
1815
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 Module snd-usb-usx2y
1817 --------------------
1818
1819 Module for Tascam USB US-122, US-224 and US-428 devices.
1820
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001821 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822
1823 Note: you need to load the firmware via usx2yloader utility included
1824 in alsa-tools and alsa-firmware packages.
1825
1826 Module snd-via82xx
1827 ------------------
1828
1829 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001830 8233A, 8233C, 8235, 8237 (south) bridge.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831
1832 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1833 [VIA686A/686B only]
1834 joystick - Enable joystick (default off) [VIA686A/686B only]
1835 ac97_clock - AC'97 codec clock base (default 48000Hz)
1836 dxs_support - support DXS channels,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001837 0 = auto (default), 1 = enable, 2 = disable,
1838 3 = 48k only, 4 = no VRA, 5 = enable any sample
1839 rate and different sample rates on different
1840 channels
1841 [VIA8233/C, 8235, 8237 only]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001843 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001845 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001846
1847 Note: on some SMP motherboards like MSI 694D the interrupts might
1848 not be generated properly. In such a case, please try to
1849 set the SMP (or MPS) version on BIOS to 1.1 instead of
1850 default value 1.4. Then the interrupt number will be
1851 assigned under 15. You might also upgrade your BIOS.
1852
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001853 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854 channels as the first PCM. On these channels, up to 4
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001855 streams can be played at the same time, and the controller
1856 can perform sample rate conversion with separate rates for
1857 each channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 As default (dxs_support = 0), 48k fixed rate is chosen
1859 except for the known devices since the output is often
1860 noisy except for 48k on some mother boards due to the
1861 bug of BIOS.
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001862 Please try once dxs_support=5 and if it works on other
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1864 know the PCI subsystem vendor/device id's (output of
1865 "lspci -nv").
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001866 If dxs_support=5 does not work, try dxs_support=4; if it
1867 doesn't work too, try dxs_support=1. (dxs_support=1 is
Takashi Iwai62430082005-09-05 17:12:29 +02001868 usually for old motherboards. The correct implemented
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001869 board should work with 4 or 5.) If it still doesn't
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870 work and the default setting is ok, dxs_support=3 is the
1871 right choice. If the default setting doesn't work at all,
1872 try dxs_support=2 to disable the DXS channels.
1873 In any cases, please let us know the result and the
Takashi Iwai62430082005-09-05 17:12:29 +02001874 subsystem vendor/device ids. See "Links and Addresses"
1875 below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876
1877 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Takashi Iwai62430082005-09-05 17:12:29 +02001878 additionally. The mpu_port option is for VIA686 chips only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879
Takashi Iwaia4efc232005-11-17 17:24:26 +01001880 The power-management is supported.
1881
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882 Module snd-via82xx-modem
1883 ------------------------
1884
1885 Module for VIA82xx AC97 modem
1886
1887 ac97_clock - AC'97 codec clock base (default 48000Hz)
1888
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001889 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890
1891 Note: The default index value of this module is -2, i.e. the first
1892 slot is excluded.
1893
Takashi Iwaia4efc232005-11-17 17:24:26 +01001894 The power-management is supported.
1895
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 Module snd-virmidi
1897 ------------------
1898
1899 Module for virtual rawmidi devices.
1900 This module creates virtual rawmidi devices which communicate
1901 to the corresponding ALSA sequencer ports.
1902
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001903 midi_devs - MIDI devices # (1-4, default=4)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001905 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001907 Module snd-virtuoso
1908 -------------------
1909
Clemens Ladisch5430c722008-07-28 10:28:43 +02001910 Module for sound cards based on the Asus AV100/AV200 chips,
Clemens Ladisch04f98902009-05-25 10:11:29 +02001911 i.e., Xonar D1, DX, D2, D2X, HDAV1.3 (Deluxe), Essence ST
1912 (Deluxe) and Essence STX.
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001913
1914 This module supports autoprobe and multiple cards.
1915
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916 Module snd-vx222
1917 ----------------
1918
1919 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1920
1921 mic - Enable Microphone on V222 Mic (NYI)
1922 ibl - Capture IBL size. (default = 0, minimum size)
1923
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001924 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925
1926 When the driver is compiled as a module and the hotplug firmware
1927 is supported, the firmware data is loaded via hotplug automatically.
1928 Install the necessary firmware files in alsa-firmware package.
1929 When no hotplug fw loader is available, you need to load the
1930 firmware via vxloader utility in alsa-tools package. To invoke
1931 vxloader automatically, add the following to /etc/modprobe.conf
1932
1933 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1934
1935 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1936 /etc/modules.conf, instead.)
1937 IBL size defines the interrupts period for PCM. The smaller size
1938 gives smaller latency but leads to more CPU consumption, too.
1939 The size is usually aligned to 126. As default (=0), the smallest
1940 size is chosen. The possible IBL values can be found in
1941 /proc/asound/cardX/vx-status proc file.
1942
Takashi Iwaia4efc232005-11-17 17:24:26 +01001943 The power-management is supported.
1944
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945 Module snd-vxpocket
1946 -------------------
1947
Takashi Iwai6d00a312005-06-30 13:40:51 +02001948 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949
1950 ibl - Capture IBL size. (default = 0, minimum size)
1951
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001952 This module supports multiple cards. The module is compiled only when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 PCMCIA is supported on kernel.
1954
Takashi Iwai62430082005-09-05 17:12:29 +02001955 With the older 2.6.x kernel, to activate the driver via the card
1956 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1957 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1958 longer require a config file.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959
1960 When the driver is compiled as a module and the hotplug firmware
1961 is supported, the firmware data is loaded via hotplug automatically.
1962 Install the necessary firmware files in alsa-firmware package.
1963 When no hotplug fw loader is available, you need to load the
1964 firmware via vxloader utility in alsa-tools package.
1965
1966 About capture IBL, see the description of snd-vx222 module.
1967
Takashi Iwaied7cbe32006-05-11 11:30:10 +02001968 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
Takashi Iwai62430082005-09-05 17:12:29 +02001969 ALSA 1.0.10.
1970
Takashi Iwaia4efc232005-11-17 17:24:26 +01001971 The power-management is supported.
1972
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 Module snd-ymfpci
1974 -----------------
1975
1976 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1977
1978 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1979 1 (auto-detect for YMF744/754 only)
1980 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1981 1 (auto-detect for YMF744/754 only)
1982 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1983 1 (auto-detect)
1984 rear_switch - enable shared rear/line-in switch (bool)
1985
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001986 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987
1988 The power-management is supported.
1989
1990 Module snd-pdaudiocf
1991 --------------------
1992
1993 Module for Sound Core PDAudioCF sound card.
1994
Takashi Iwaia4efc232005-11-17 17:24:26 +01001995 The power-management is supported.
1996
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997
Takashi Iwai62430082005-09-05 17:12:29 +02001998AC97 Quirk Option
1999=================
2000
2001The ac97_quirk option is used to enable/override the workaround for
2002specific devices on drivers for on-board AC'97 controllers like
2003snd-intel8x0. Some hardware have swapped output pins between Master
2004and Headphone, or Surround (thanks to confusion of AC'97
2005specifications from version to version :-)
2006
2007The driver provides the auto-detection of known problematic devices,
2008but some might be unknown or wrongly detected. In such a case, pass
2009the proper value with this option.
2010
2011The following strings are accepted:
2012 - default Don't override the default setting
Takashi Iwai10e4097f2005-11-17 11:04:55 +01002013 - none Disable the quirk
Takashi Iwai62430082005-09-05 17:12:29 +02002014 - hp_only Bind Master and Headphone controls as a single control
2015 - swap_hp Swap headphone and master controls
2016 - swap_surround Swap master and surround controls
2017 - ad_sharing For AD1985, turn on OMS bit and use headphone
2018 - alc_jack For ALC65x, turn on the jack sense mode
2019 - inv_eapd Inverted EAPD implementation
2020 - mute_led Bind EAPD bit for turning on/off mute LED
2021
2022For backward compatibility, the corresponding integer value -1, 0,
2023... are accepted, too.
2024
2025For example, if "Master" volume control has no effect on your device
2026but only "Headphone" does, pass ac97_quirk=hp_only module option.
2027
2028
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029Configuring Non-ISAPNP Cards
2030============================
2031
2032When the kernel is configured with ISA-PnP support, the modules
2033supporting the isapnp cards will have module options "isapnp".
2034If this option is set, *only* the ISA-PnP devices will be probed.
2035For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
2036together with the proper i/o and irq configuration.
2037
2038When the kernel is configured without ISA-PnP support, isapnp option
2039will be not built in.
2040
2041
2042Module Autoloading Support
2043==========================
2044
2045The ALSA drivers can be loaded automatically on demand by defining
2046module aliases. The string 'snd-card-%1' is requested for ALSA native
2047devices where %i is sound card number from zero to seven.
2048
2049To auto-load an ALSA driver for OSS services, define the string
2050'sound-slot-%i' where %i means the slot number for OSS, which
2051corresponds to the card index of ALSA. Usually, define this
Tobias Klauserd533f672005-09-10 00:26:46 -07002052as the same card module.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053
2054An example configuration for a single emu10k1 card is like below:
2055----- /etc/modprobe.conf
2056alias snd-card-0 snd-emu10k1
2057alias sound-slot-0 snd-emu10k1
2058----- /etc/modprobe.conf
2059
2060The available number of auto-loaded sound cards depends on the module
2061option "cards_limit" of snd module. As default it's set to 1.
2062To enable the auto-loading of multiple cards, specify the number of
2063sound cards in that option.
2064
2065When multiple cards are available, it'd better to specify the index
2066number for each card via module option, too, so that the order of
2067cards is kept consistent.
2068
2069An example configuration for two sound cards is like below:
2070
2071----- /etc/modprobe.conf
2072# ALSA portion
2073options snd cards_limit=2
2074alias snd-card-0 snd-interwave
2075alias snd-card-1 snd-ens1371
2076options snd-interwave index=0
2077options snd-ens1371 index=1
2078# OSS/Free portion
2079alias sound-slot-0 snd-interwave
2080alias sound-slot-1 snd-ens1371
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02002081----- /etc/modprobe.conf
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082
2083In this example, the interwave card is always loaded as the first card
2084(index 0) and ens1371 as the second (index 1).
2085
Takashi Iwai304cd072007-10-26 15:10:15 +02002086Alternative (and new) way to fixate the slot assignment is to use
2087"slots" option of snd module. In the case above, specify like the
2088following:
2089
2090options snd slots=snd-interwave,snd-ens1371
2091
2092Then, the first slot (#0) is reserved for snd-interwave driver, and
2093the second (#1) for snd-ens1371. You can omit index option in each
2094driver if slots option is used (although you can still have them at
2095the same time as long as they don't conflict).
2096
2097The slots option is especially useful for avoiding the possible
2098hot-plugging and the resultant slot conflict. For example, in the
2099case above again, the first two slots are already reserved. If any
2100other driver (e.g. snd-usb-audio) is loaded before snd-interwave or
2101snd-ens1371, it will be assigned to the third or later slot.
2102
Takashi Iwaia93bbaa2008-05-27 17:59:24 +02002103When a module name is given with '!', the slot will be given for any
2104modules but that name. For example, "slots=!snd-pcsp" will reserve
2105the first slot for any modules but snd-pcsp.
2106
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107
2108ALSA PCM devices to OSS devices mapping
2109=======================================
2110
2111/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
2112/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
2113/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
2114/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
2115/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
2116/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
2117/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
2118/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
2119/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
2120
2121The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
2122sound card number and second means device number. The ALSA devices
2123have either 'c' or 'p' suffix indicating the direction, capture and
2124playback, respectively.
2125
2126Please note that the device mapping above may be varied via the module
2127options of snd-pcm-oss module.
2128
2129
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130Proc interfaces (/proc/asound)
2131==============================
2132
2133/proc/asound/card#/pcm#[cp]/oss
2134-------------------------------
2135 String "erase" - erase all additional informations about OSS applications
2136 String "<app_name> <fragments> <fragment_size> [<options>]"
2137
2138 <app_name> - name of application with (higher priority) or without path
2139 <fragments> - number of fragments or zero if auto
2140 <fragment_size> - size of fragment in bytes or zero if auto
2141 <options> - optional parameters
2142 - disable the application tries to open a pcm device for
2143 this channel but does not want to use it.
2144 (Cause a bug or mmap needs)
2145 It's good for Quake etc...
2146 - direct don't use plugins
2147 - block force block mode (rvplayer)
2148 - non-block force non-block mode
2149 - whole-frag write only whole fragments (optimization affecting
2150 playback only)
2151 - no-silence do not fill silence ahead to avoid clicks
Takashi Iwai10f69f92005-09-08 13:48:34 +02002152 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
2153 instead of filled blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154
2155 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
2156 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
2157 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
2158
2159
Takashi Iwaib6a96912005-05-30 18:27:03 +02002160Early Buffer Allocation
2161=======================
2162
2163Some drivers (e.g. hdsp) require the large contiguous buffers, and
2164sometimes it's too late to find such spaces when the driver module is
2165actually loaded due to memory fragmentation. You can pre-allocate the
2166PCM buffers by loading snd-page-alloc module and write commands to its
2167proc file in prior, for example, in the early boot stage like
2168/etc/init.d/*.local scripts.
2169
2170Reading the proc file /proc/drivers/snd-page-alloc shows the current
2171usage of page allocation. In writing, you can send the following
2172commands to the snd-page-alloc driver:
2173
2174 - add VENDOR DEVICE MASK SIZE BUFFERS
2175
2176 VENDOR and DEVICE are PCI vendor and device IDs. They take
2177 integer numbers (0x prefix is needed for the hex).
2178 MASK is the PCI DMA mask. Pass 0 if not restricted.
2179 SIZE is the size of each buffer to allocate. You can pass
2180 k and m suffix for KB and MB. The max number is 16MB.
2181 BUFFERS is the number of buffers to allocate. It must be greater
2182 than 0. The max number is 4.
2183
2184 - erase
2185
2186 This will erase the all pre-allocated buffers which are not in
2187 use.
2188
2189
Takashi Iwai62430082005-09-05 17:12:29 +02002190Links and Addresses
2191===================
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192
2193 ALSA project homepage
2194 http://www.alsa-project.org
2195
Takashi Iwai30bc4482008-12-09 08:23:45 +01002196 Kernel Bugzilla
2197 http://bugzilla.kernel.org/
Takashi Iwai62430082005-09-05 17:12:29 +02002198
2199 ALSA Developers ML
Rene Herman45051792007-03-21 12:05:06 +01002200 mailto:alsa-devel@alsa-project.org
Takashi Iwai30bc4482008-12-09 08:23:45 +01002201
2202 alsa-info.sh script
2203 http://www.alsa-project.org/alsa-info.sh