blob: bb488b575def48cc1816c228a59f452b593c8d82 [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 Iwai2f24d1592007-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)
521
522 When multiple PCM devices are created, snd-dummy gives different
523 behavior to each PCM device:
524 0 = interleaved with mmap support
525 1 = non-interleaved with mmap support
526 2 = interleaved without mmap
527 3 = non-interleaved without mmap
528
Takashi Iwaia4efc232005-11-17 17:24:26 +0100529 The power-management is supported.
530
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200531 Module snd-echo3g
532 -----------------
533
534 Module for Echoaudio 3G cards (Gina3G/Layla3G)
535
536 This module supports multiple cards.
537 The driver requires the firmware loader support on kernel.
538
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 Module snd-emu10k1
540 ------------------
541
542 Module for EMU10K1/EMU10k2 based PCI sound cards.
543 * Sound Blaster Live!
544 * Sound Blaster PCI 512
545 * Emu APS (partially supported)
546 * Sound Blaster Audigy
547
548 extin - bitmap of available external inputs for FX8010 (see bellow)
549 extout - bitmap of available external outputs for FX8010 (see bellow)
550 seq_ports - allocated sequencer ports (4 by default)
551 max_synth_voices - limit of voices used for wavetable (64 by default)
552 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
553 given in MB unit. Default value is 128.
554 enable_ir - enable IR
555
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100556 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
558 Input & Output configurations [extin/extout]
559 * Creative Card wo/Digital out [0x0003/0x1f03]
560 * Creative Card w/Digital out [0x0003/0x1f0f]
561 * Creative Card w/Digital CD in [0x000f/0x1f0f]
562 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
563 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
564 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
565 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
566 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
567 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
568 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
569 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
570 * Creative Card all ins and outs [0x3fff/0x7fff]
571
Takashi Iwaia4efc232005-11-17 17:24:26 +0100572 The power-management is supported.
573
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 Module snd-emu10k1x
575 -------------------
576
577 Module for Creative Emu10k1X (SB Live Dell OEM version)
578
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100579 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
581 Module snd-ens1370
582 ------------------
583
584 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
585 * SoundBlaster PCI 64
586 * SoundBlaster PCI 128
587
588 joystick - Enable joystick (default off)
589
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100590 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100592 The power-management is supported.
593
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 Module snd-ens1371
595 ------------------
596
597 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
598 * SoundBlaster PCI 64
599 * SoundBlaster PCI 128
600 * SoundBlaster Vibra PCI
601
602 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
603 0 = disable (default), 1 = auto-detect
604
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100605 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100607 The power-management is supported.
608
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 Module snd-es968
610 ----------------
611
612 Module for sound cards based on ESS ES968 chip (PnP only).
613
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100614 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
Takashi Iwaia4efc232005-11-17 17:24:26 +0100616 The power-management is supported.
617
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 Module snd-es1688
619 -----------------
620
621 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
622
623 port - port # for ES-1688 chip (0x220,0x240,0x260)
Takashi Iwai504a06d2009-01-30 19:59:10 +0100624 fm_port - port # for OPL3 (option; share the same port as default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
626 irq - IRQ # for ES-1688 chip (5,7,9,10)
627 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
628 dma8 - DMA # for ES-1688 chip (0,1,3)
629
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100630 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
632 Module snd-es18xx
633 -----------------
634
635 Module for ESS AudioDrive ES-18xx sound cards.
636
Rene Herman64e0e2d2007-12-13 16:29:33 +0100637 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
638
639 with isapnp=0, the following options are available:
640
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 port - port # for ES-18xx chip (0x220,0x240,0x260)
642 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
643 fm_port - port # for FM (optional, not used)
644 irq - IRQ # for ES-18xx chip (5,7,9,10)
645 dma1 - first DMA # for ES-18xx chip (0,1,3)
646 dma2 - first DMA # for ES-18xx chip (0,1,3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100648 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
649 port if native ISA PnP routines are not used).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 When dma2 is equal with dma1, the driver works as half-duplex.
651
652 The power-management is supported.
653
654 Module snd-es1938
655 -----------------
656
657 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
658
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100659 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
Takashi Iwaia4efc232005-11-17 17:24:26 +0100661 The power-management is supported.
662
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 Module snd-es1968
664 -----------------
665
666 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
667
668 total_bufsize - total buffer size in kB (1-4096kB)
669 pcm_substreams_p - playback channels (1-8, default=2)
670 pcm_substreams_c - capture channels (1-8, default=0)
671 clock - clock (0 = auto-detection)
672 use_pm - support the power-management (0 = off, 1 = on,
673 2 = auto (default))
674 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
675 joystick - enable joystick (default off)
676
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100677 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678
679 The power-management is supported.
680
681 Module snd-fm801
682 ----------------
683
684 Module for ForteMedia FM801 based PCI sound cards.
685
686 tea575x_tuner - Enable TEA575x tuner
687 - 1 = MediaForte 256-PCS
688 - 2 = MediaForte 256-PCPR
689 - 3 = MediaForte 64-PCR
690 - High 16-bits are video (radio) device number + 1
691 - example: 0x10002 (MediaForte 256-PCPR, device 1)
692
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100693 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694
Takashi Iwaia4efc232005-11-17 17:24:26 +0100695 The power-management is supported.
696
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200697 Module snd-gina20
698 -----------------
699
700 Module for Echoaudio Gina20
701
702 This module supports multiple cards.
703 The driver requires the firmware loader support on kernel.
704
705 Module snd-gina24
706 -----------------
707
708 Module for Echoaudio Gina24
709
710 This module supports multiple cards.
711 The driver requires the firmware loader support on kernel.
712
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 Module snd-gusclassic
714 ---------------------
715
716 Module for Gravis UltraSound Classic sound card.
717
718 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
719 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
720 dma1 - DMA # for GF1 chip (1,3,5,6,7)
721 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
722 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
723 voices - GF1 voices limit (14-32)
724 pcm_voices - reserved PCM voices
725
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100726 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727
728 Module snd-gusextreme
729 ---------------------
730
731 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
732
733 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
734 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
735 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
736 irq - IRQ # for ES-1688 chip (5,7,9,10)
737 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
738 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
739 dma8 - DMA # for ES-1688 chip (0,1,3)
740 dma1 - DMA # for GF1 chip (1,3,5,6,7)
741 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
742 voices - GF1 voices limit (14-32)
743 pcm_voices - reserved PCM voices
744
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100745 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746
747 Module snd-gusmax
748 -----------------
749
750 Module for Gravis UltraSound MAX sound card.
751
752 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
753 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
754 dma1 - DMA # for GF1 chip (1,3,5,6,7)
755 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
756 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
757 voices - GF1 voices limit (14-32)
758 pcm_voices - reserved PCM voices
759
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100760 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
762 Module snd-hda-intel
763 --------------------
764
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400765 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8, ICH9, ICH10,
766 PCH, SCH),
767 ATI SB450, SB600, R600, RS600, RS690, RS780, RV610, RV620,
768 RV630, RV635, RV670, RV770,
Takashi Iwai9b878192006-05-17 11:26:39 +0200769 VIA VT8251/VT8237A,
770 SIS966, ULI M5461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100772 [Multiple options for each card instance]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 model - force the model name
Takashi Iwaid2e1c972008-06-10 17:53:34 +0200774 position_fix - Fix DMA pointer (0 = auto, 1 = use LPIB, 2 = POSBUF)
Takashi Iwai95904742007-05-19 17:06:42 +0200775 probe_mask - Bitmask to probe codecs (default = -1, meaning all slots)
Takashi Iwaiae374d62009-02-13 08:33:55 +0100776 When the bit 8 (0x100) is set, the lower 8 bits are used
777 as the "fixed" codec slots; i.e. the driver probes the
778 slots regardless what hardware reports back
Takashi Iwaid4d9cd032008-12-19 15:19:11 +0100779 probe_only - Only probing and no codec initialization (default=off);
780 Useful to check the initial codec status for debugging
Takashi Iwai8c53b962008-06-10 17:53:35 +0200781 bdl_pos_adj - Specifies the DMA IRQ timing delay in samples.
782 Passing -1 will make the driver to choose the appropriate
783 value based on the controller chip.
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100784
785 [Single (global) options]
Takashi Iwai27346162006-01-12 18:28:44 +0100786 single_cmd - Use single immediate commands to communicate with
787 codecs (for debugging only)
Takashi Iwai134a11f2006-11-10 12:08:37 +0100788 enable_msi - Enable Message Signaled Interrupt (MSI) (default = off)
Matt LaPlante19f59462009-04-27 15:06:31 +0200789 power_save - Automatic power-saving timeout (in second, 0 =
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200790 disable)
Takashi Iwaidee1b662007-08-13 16:10:30 +0200791 power_save_controller - Reset HD-audio controller in power-saving mode
792 (default = on)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100794 This module supports multiple cards and autoprobe.
795
Takashi Iwaicae51172008-12-19 08:36:53 +0100796 See Documentation/sound/alsa/HD-Audio.txt for more details about
797 HD-audio driver.
798
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 Each codec may have a model table for different configurations.
800 If your machine isn't listed there, the default (usually minimal)
801 configuration is set up. You can pass "model=<name>" option to
802 specify a certain model in such a case. There are different
Takashi Iwaicae51172008-12-19 08:36:53 +0100803 models depending on the codec chip. The list of available models
804 is found in HD-Audio-Models.txt
Takashi Iwaidb064e52006-03-16 16:04:58 +0100805
Takashi Iwai6d7b1d72007-02-26 15:56:46 +0100806 The model name "genric" is treated as a special case. When this
807 model is given, the driver uses the generic codec parser without
808 "codec-patch". It's sometimes good for testing and debugging.
809
Takashi Iwai62430082005-09-05 17:12:29 +0200810 If the default configuration doesn't work and one of the above
Takashi Iwai30bc4482008-12-09 08:23:45 +0100811 matches with your device, report it together with alsa-info.sh
812 output (with --no-upload option) to kernel bugzilla or alsa-devel
Takashi Iwai62430082005-09-05 17:12:29 +0200813 ML (see the section "Links and Addresses").
814
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200815 power_save and power_save_controller options are for power-saving
816 mode. See powersave.txt for details.
Takashi Iwaidee1b662007-08-13 16:10:30 +0200817
Takashi Iwaic74db862005-05-12 14:26:27 +0200818 Note 2: If you get click noises on output, try the module option
819 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
820 register value without FIFO size correction as the current
821 DMA pointer. position_fix=2 will make the driver to use
822 the position buffer instead of reading SD_LPIB register.
Michael Kerrisk90f31e32008-09-01 14:03:50 +0200823 (Usually SD_LPIB register is more accurate than the
Takashi Iwaic74db862005-05-12 14:26:27 +0200824 position buffer.)
825
Takashi Iwai27346162006-01-12 18:28:44 +0100826 NB: If you get many "azx_get_response timeout" messages at
827 loading, it's likely a problem of interrupts (e.g. ACPI irq
828 routing). Try to boot with options like "pci=noacpi". Also, you
829 can try "single_cmd=1" module option. This will switch the
830 communication method between HDA controller and codecs to the
831 single immediate commands instead of CORB/RIRB. Basically, the
832 single command mode is provided only for BIOS, and you won't get
833 unsolicited events, too. But, at least, this works independently
834 from the irq. Remember this is a last resort, and should be
835 avoided as much as possible...
836
Takashi Iwai95904742007-05-19 17:06:42 +0200837 MORE NOTES ON "azx_get_response timeout" PROBLEMS:
838 On some hardwares, you may need to add a proper probe_mask option
839 to avoid the "azx_get_response timeout" problem above, instead.
840 This occurs when the access to non-existing or non-working codec slot
841 (likely a modem one) causes a stall of the communication via HD-audio
842 bus. You can see which codec slots are probed by enabling
Takashi Iwai62cf8722008-05-20 12:15:15 +0200843 CONFIG_SND_DEBUG_VERBOSE, or simply from the file name of the codec
Takashi Iwai95904742007-05-19 17:06:42 +0200844 proc files. Then limit the slots to probe by probe_mask option.
845 For example, probe_mask=1 means to probe only the first slot, and
846 probe_mask=4 means only the third slot.
847
Takashi Iwaia4efc232005-11-17 17:24:26 +0100848 The power-management is supported.
849
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 Module snd-hdsp
851 ---------------
852
853 Module for RME Hammerfall DSP audio interface(s)
854
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100855 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856
857 Note: The firmware data can be automatically loaded via hotplug
858 when CONFIG_FW_LOADER is set. Otherwise, you need to load
859 the firmware via hdsploader utility included in alsa-tools
860 package.
861 The firmware data is found in alsa-firmware package.
862
863 Note: snd-page-alloc module does the job which snd-hammerfall-mem
864 module did formerly. It will allocate the buffers in advance
865 when any HDSP cards are found. To make the buffer
866 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +0200867 stage of boot sequence. See "Early Buffer Allocation"
868 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869
Takashi Iwai54704402005-06-03 11:27:00 +0200870 Module snd-hdspm
871 ----------------
872
873 Module for RME HDSP MADI board.
874
875 precise_ptr - Enable precise pointer, or disable.
876 line_outs_monitor - Send playback streams to analog outs by default.
877 enable_monitor - Enable Analog Out on Channel 63/64 by default.
878
879 See hdspm.txt for details.
880
Clemens Ladischc6260262008-01-25 08:41:52 +0100881 Module snd-hifier
882 -----------------
883
884 Module for the MediaTek/TempoTec HiFier Fantasia sound card.
885
886 This module supports autoprobe and multiple cards.
887
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 Module snd-ice1712
889 ------------------
890
891 Module for Envy24 (ICE1712) based PCI sound cards.
892 * MidiMan M Audio Delta 1010
893 * MidiMan M Audio Delta 1010LT
894 * MidiMan M Audio Delta DiO 2496
895 * MidiMan M Audio Delta 66
896 * MidiMan M Audio Delta 44
897 * MidiMan M Audio Delta 410
898 * MidiMan M Audio Audiophile 2496
899 * TerraTec EWS 88MT
900 * TerraTec EWS 88D
901 * TerraTec EWX 24/96
902 * TerraTec DMX 6Fire
Takashi Iwaic9bce912005-05-24 13:41:03 +0200903 * TerraTec Phase 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 * Hoontech SoundTrack DSP 24
905 * Hoontech SoundTrack DSP 24 Value
906 * Hoontech SoundTrack DSP 24 Media 7.1
Takashi Iwaic9bce912005-05-24 13:41:03 +0200907 * Event Electronics, EZ8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 * Digigram VX442
Takashi Iwaic9bce912005-05-24 13:41:03 +0200909 * Lionstracs, Mediastaton
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400910 * Terrasoniq TS 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911
912 model - Use the given board model, one of the following:
913 delta1010, dio2496, delta66, delta44, audiophile, delta410,
914 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
Takashi Iwaic9bce912005-05-24 13:41:03 +0200915 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
916 phase88, mediastation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 omni - Omni I/O support for MidiMan M-Audio Delta44/66
Matt LaPlantefa00e7e2006-11-30 04:55:36 +0100918 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transceiver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 in msec resolution, default value is 500 (0.5 sec)
920
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100921 This module supports multiple cards and autoprobe. Note: The consumer part
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 is not used with all Envy24 based cards (for example in the MidiMan Delta
923 serie).
924
Takashi Iwaic9bce912005-05-24 13:41:03 +0200925 Note: The supported board is detected by reading EEPROM or PCI
926 SSID (if EEPROM isn't available). You can override the
927 model by passing "model" module option in case that the
928 driver isn't configured properly or you want to try another
929 type for testing.
930
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 Module snd-ice1724
932 ------------------
933
Takashi Iwaic9bce912005-05-24 13:41:03 +0200934 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100935 * MidiMan M Audio Revolution 5.1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 * MidiMan M Audio Revolution 7.1
Takashi Iwai56255062006-11-09 16:47:26 +0100937 * MidiMan M Audio Audiophile 192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938 * AMP Ltd AUDIO2000
Takashi Iwaic9bce912005-05-24 13:41:03 +0200939 * TerraTec Aureon 5.1 Sky
940 * TerraTec Aureon 7.1 Space
941 * TerraTec Aureon 7.1 Universe
942 * TerraTec Phase 22
943 * TerraTec Phase 28
944 * AudioTrak Prodigy 7.1
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400945 * AudioTrak Prodigy 7.1 LT
946 * AudioTrak Prodigy 7.1 XT
947 * AudioTrak Prodigy 7.1 HIFI
948 * AudioTrak Prodigy 7.1 HD2
Takashi Iwaic9bce912005-05-24 13:41:03 +0200949 * AudioTrak Prodigy 192
950 * Pontis MS300
951 * Albatron K8X800 Pro II
952 * Chaintech ZNF3-150
953 * Chaintech ZNF3-250
954 * Chaintech 9CJS
Takashi Iwai8cfbbac2005-05-27 12:10:40 +0200955 * Chaintech AV-710
Takashi Iwaic9bce912005-05-24 13:41:03 +0200956 * Shuttle SN25P
Shin-ya Okadaf31639b2007-10-23 15:08:18 +0200957 * Onkyo SE-90PCI
958 * Onkyo SE-200PCI
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400959 * ESI Juli@
Takashi Iwai72cbfd42009-05-06 17:33:19 +0200960 * ESI Maya44
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400961 * Hercules Fortissimo IV
962 * EGO-SYS WaveTerminal 192M
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963
964 model - Use the given board model, one of the following:
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100965 revo51, revo71, amp2000, prodigy71, prodigy71lt,
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400966 prodigy71xt, prodigy71hifi, prodigyhd2, prodigy192,
967 juli, aureon51, aureon71, universe, ap192, k8x800,
968 phase22, phase28, ms300, av710, se200pci, se90pci,
Takashi Iwai72cbfd42009-05-06 17:33:19 +0200969 fortissimo4, sn25p, WT192M, maya44
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100971 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972
Takashi Iwaic9bce912005-05-24 13:41:03 +0200973 Note: The supported board is detected by reading EEPROM or PCI
974 SSID (if EEPROM isn't available). You can override the
975 model by passing "model" module option in case that the
976 driver isn't configured properly or you want to try another
977 type for testing.
978
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200979 Module snd-indigo
980 -----------------
981
982 Module for Echoaudio Indigo
983
984 This module supports multiple cards.
985 The driver requires the firmware loader support on kernel.
986
987 Module snd-indigodj
988 -------------------
989
990 Module for Echoaudio Indigo DJ
991
992 This module supports multiple cards.
993 The driver requires the firmware loader support on kernel.
994
995 Module snd-indigoio
996 -------------------
997
998 Module for Echoaudio Indigo IO
999
1000 This module supports multiple cards.
1001 The driver requires the firmware loader support on kernel.
1002
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 Module snd-intel8x0
1004 -------------------
1005
1006 Module for AC'97 motherboards from Intel and compatibles.
1007 * Intel i810/810E, i815, i820, i830, i84x, MX440
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001008 ICH5, ICH6, ICH7, 6300ESB, ESB2
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 * SiS 7012 (SiS 735)
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001010 * NVidia NForce, NForce2, NForce3, MCP04, CK804
1011 CK8, CK8S, MCP501
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 * AMD AMD768, AMD8111
1013 * ALi m5455
1014
1015 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1016 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001017 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 buggy_irq - Enable workaround for buggy interrupts on some
Takashi Iwaia06147d2005-09-08 19:54:17 +02001019 motherboards (default yes on nForce chips,
1020 otherwise off)
1021 buggy_semaphore - Enable workaround for hardwares with buggy
1022 semaphores (e.g. on some ASUS laptops)
1023 (default off)
Takashi Iwai6c5cfd92006-11-28 17:18:25 +01001024 spdif_aclink - Use S/PDIF over AC-link instead of direct connection
1025 from the controller chip
1026 (0 = off, 1 = on, -1 = default)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001028 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029
1030 Note: the latest driver supports auto-detection of chip clock.
1031 if you still encounter too fast playback, specify the clock
1032 explicitly via the module option "ac97_clock=41194".
1033
1034 Joystick/MIDI ports are not supported by this driver. If your
1035 motherboard has these devices, use the ns558 or snd-mpu401
1036 modules, respectively.
1037
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038 The power-management is supported.
1039
1040 Module snd-intel8x0m
1041 --------------------
1042
1043 Module for Intel ICH (i8x0) chipset MC97 modems.
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001044 * Intel i810/810E, i815, i820, i830, i84x, MX440
1045 ICH5, ICH6, ICH7
1046 * SiS 7013 (SiS 735)
1047 * NVidia NForce, NForce2, NForce2s, NForce3
1048 * AMD AMD8111
1049 * ALi m5455
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050
1051 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1052
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001053 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054
1055 Note: The default index value of this module is -2, i.e. the first
1056 slot is excluded.
1057
Takashi Iwaia4efc232005-11-17 17:24:26 +01001058 The power-management is supported.
1059
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 Module snd-interwave
1061 --------------------
1062
1063 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1064 and other sound cards based on AMD InterWave (tm) chip.
1065
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1067 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1068 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1069 effect - 1 = InterWave effects enable (default 0);
1070 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001071 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1072
1073 with isapnp=0, the following options are available:
1074
1075 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1076 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1077 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1078 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001080 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081
1082 Module snd-interwave-stb
1083 ------------------------
1084
1085 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1086 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1087 circuit for extended control of bass, treble and master volume.
1088
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1090 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1091 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1092 effect - 1 = InterWave effects enable (default 0);
1093 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001094 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1095
1096 with isapnp=0, the following options are available:
1097
1098 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1099 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1100 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1101 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1102 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001104 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105
1106 Module snd-korg1212
1107 -------------------
1108
1109 Module for Korg 1212 IO PCI card
1110
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001111 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001113 Module snd-layla20
1114 ------------------
1115
1116 Module for Echoaudio Layla20
1117
1118 This module supports multiple cards.
1119 The driver requires the firmware loader support on kernel.
1120
1121 Module snd-layla24
1122 ------------------
1123
1124 Module for Echoaudio Layla24
1125
1126 This module supports multiple cards.
1127 The driver requires the firmware loader support on kernel.
1128
Takashi Iwai8338c302009-04-14 12:30:36 +02001129 Module snd-lx6464es
1130 -------------------
1131
1132 Module for Digigram LX6464ES boards
1133
1134 This module supports multiple cards.
1135
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136 Module snd-maestro3
1137 -------------------
1138
1139 Module for Allegro/Maestro3 chips
1140
1141 external_amp - enable external amp (enabled by default)
1142 amp_gpio - GPIO pin number for external amp (0-15) or
1143 -1 for default pin (8 for allegro, 1 for
1144 others)
1145
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001146 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001147
1148 Note: the binding of amplifier is dependent on hardware.
1149 If there is no sound even though all channels are unmuted, try to
1150 specify other gpio connection via amp_gpio option.
1151 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1152 option.
1153
1154 The power-management is supported.
1155
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001156 Module snd-mia
1157 ---------------
1158
1159 Module for Echoaudio Mia
1160
1161 This module supports multiple cards.
1162 The driver requires the firmware loader support on kernel.
1163
Martin Langer1841f6132006-03-27 12:41:01 +02001164 Module snd-miro
1165 ---------------
1166
1167 Module for Miro soundcards: miroSOUND PCM 1 pro,
1168 miroSOUND PCM 12,
1169 miroSOUND PCM 20 Radio.
1170
1171 port - Port # (0x530,0x604,0xe80,0xf40)
1172 irq - IRQ # (5,7,9,10,11)
1173 dma1 - 1st dma # (0,1,3)
1174 dma2 - 2nd dma # (0,1)
1175 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1176 mpu_irq - MPU-401 irq # (5,7,9,10)
1177 fm_port - FM Port # (0x388)
1178 wss - enable WSS mode
1179 ide - enable onboard ide support
1180
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 Module snd-mixart
1182 -----------------
1183
1184 Module for Digigram miXart8 sound cards.
1185
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001186 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 Note: One miXart8 board will be represented as 4 alsa cards.
1188 See MIXART.txt for details.
1189
1190 When the driver is compiled as a module and the hotplug firmware
1191 is supported, the firmware data is loaded via hotplug automatically.
1192 Install the necessary firmware files in alsa-firmware package.
1193 When no hotplug fw loader is available, you need to load the
1194 firmware via mixartloader utility in alsa-tools package.
1195
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001196 Module snd-mona
1197 ---------------
1198
1199 Module for Echoaudio Mona
1200
1201 This module supports multiple cards.
1202 The driver requires the firmware loader support on kernel.
1203
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 Module snd-mpu401
1205 -----------------
1206
1207 Module for MPU-401 UART devices.
1208
1209 port - port number or -1 (disable)
1210 irq - IRQ number or -1 (disable)
1211 pnp - PnP detection - 0 = disable, 1 = enable (default)
1212
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001213 This module supports multiple devices and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214
Takashi Iwaic96330b2009-01-28 08:23:03 +01001215 Module snd-msnd-classic
1216 -----------------------
1217
1218 Module for Turtle Beach MultiSound Classic, Tahiti or Monterey
1219 soundcards.
1220
1221 io - Port # for msnd-classic card
1222 irq - IRQ # for msnd-classic card
1223 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1224 0xe0000 or 0xe8000)
1225 write_ndelay - enable write ndelay (default = 1)
1226 calibrate_signal - calibrate signal (default = 0)
1227 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1228 digital - Digital daughterboard present (default = 0)
1229 cfg - Config port (0x250, 0x260 or 0x270) default = PnP
1230 reset - Reset all devices
1231 mpu_io - MPU401 I/O port
1232 mpu_irq - MPU401 irq#
1233 ide_io0 - IDE port #0
1234 ide_io1 - IDE port #1
1235 ide_irq - IDE irq#
1236 joystick_io - Joystick I/O port
1237
1238 The driver requires firmware files "turtlebeach/msndinit.bin" and
1239 "turtlebeach/msndperm.bin" in the proper firmware directory.
1240
1241 See Documentation/sound/oss/MultiSound for important information
1242 about this driver. Note that it has been discontinued, but the
1243 Voyetra Turtle Beach knowledge base entry for it is still available
1244 at
1245 http://www.turtlebeach.com/site/kb_ftp/790.asp
1246
1247 Module snd-msnd-pinnacle
1248 ------------------------
1249
1250 Module for Turtle Beach MultiSound Pinnacle/Fiji soundcards.
1251
1252 io - Port # for pinnacle/fiji card
1253 irq - IRQ # for pinnalce/fiji card
1254 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1255 0xe0000 or 0xe8000)
1256 write_ndelay - enable write ndelay (default = 1)
1257 calibrate_signal - calibrate signal (default = 0)
1258 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1259
1260 The driver requires firmware files "turtlebeach/pndspini.bin" and
1261 "turtlebeach/pndsperm.bin" in the proper firmware directory.
1262
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 Module snd-mtpav
1264 ----------------
1265
1266 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1267 port).
1268
1269 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1270 irq - IRQ # for MTPAV (7,5, default=7)
1271 hwports - number of supported hardware ports, default=8.
1272
1273 Module supports only 1 card. This module has no enable option.
1274
Matthias Koenig68ab8012006-07-27 16:59:23 +02001275 Module snd-mts64
1276 ----------------
1277
1278 Module for Ego Systems (ESI) Miditerminal 4140
1279
1280 This module supports multiple devices.
1281 Requires parport (CONFIG_PARPORT).
1282
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 Module snd-nm256
1284 ----------------
1285
1286 Module for NeoMagic NM256AV/ZX chips
1287
1288 playback_bufsize - max playback frame size in kB (4-128kB)
1289 capture_bufsize - max capture frame size in kB (4-128kB)
1290 force_ac97 - 0 or 1 (disabled by default)
1291 buffer_top - specify buffer top address
1292 use_cache - 0 or 1 (disabled by default)
1293 vaio_hack - alias buffer_top=0x25a800
1294 reset_workaround - enable AC97 RESET workaround for some laptops
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001295 reset_workaround2 - enable extended AC97 RESET workaround for some
1296 other laptops
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +02001298 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299
1300 The power-management is supported.
1301
1302 Note: on some notebooks the buffer address cannot be detected
1303 automatically, or causes hang-up during initialization.
Matt LaPlantefff92892006-10-03 22:47:42 +02001304 In such a case, specify the buffer top address explicitly via
1305 the buffer_top option.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306 For example,
1307 Sony F250: buffer_top=0x25a800
1308 Sony F270: buffer_top=0x272800
1309 The driver supports only ac97 codec. It's possible to force
1310 to initialize/use ac97 although it's not detected. In such a
1311 case, use force_ac97=1 option - but *NO* guarantee whether it
1312 works!
1313
1314 Note: The NM256 chip can be linked internally with non-AC97
1315 codecs. This driver supports only the AC97 codec, and won't work
1316 with machines with other (most likely CS423x or OPL3SAx) chips,
1317 even though the device is detected in lspci. In such a case, try
1318 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
Takashi Iwai62430082005-09-05 17:12:29 +02001319 but some doesn't have ISA PnP. You'll need to specify isapnp=0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 and proper hardware parameters in the case without ISA PnP.
1321
1322 Note: some laptops need a workaround for AC97 RESET. For the
1323 known hardware like Dell Latitude LS and Sony PCG-F305, this
1324 workaround is enabled automatically. For other laptops with a
1325 hard freeze, you can try reset_workaround=1 option.
1326
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001327 Note: Dell Latitude CSx laptops have another problem regarding
1328 AC97 RESET. On these laptops, reset_workaround2 option is
1329 turned on as default. This option is worth to try if the
1330 previous reset_workaround option doesn't help.
1331
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 Note: This driver is really crappy. It's a porting from the
1333 OSS driver, which is a result of black-magic reverse engineering.
1334 The detection of codec will fail if the driver is loaded *after*
1335 X-server as described above. You might be able to force to load
1336 the module, but it may result in hang-up. Hence, make sure that
1337 you load this module *before* X if you encounter this kind of
1338 problem.
1339
1340 Module snd-opl3sa2
1341 ------------------
1342
1343 Module for Yamaha OPL3-SA2/SA3 sound cards.
1344
Rene Herman64e0e2d2007-12-13 16:29:33 +01001345 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1346
1347 with isapnp=0, the following options are available:
1348
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349 port - control port # for OPL3-SA chip (0x370)
1350 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1351 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1352 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1353 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1354 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1355 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1356 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001358 This module supports multiple cards and ISA PnP. It does not support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1360
1361 The power-management is supported.
1362
1363 Module snd-opti92x-ad1848
1364 -------------------------
1365
1366 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1367 Module works with OAK Mozart cards as well.
1368
Rene Herman64e0e2d2007-12-13 16:29:33 +01001369 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1370
1371 with isapnp=0, the following options are available:
1372
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1374 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1375 fm_port - port # for OPL3 device (0x388)
1376 irq - IRQ # for WSS chip (5,7,9,10,11)
1377 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1378 dma1 - first DMA # for WSS chip (0,1,3)
1379
1380 This module supports only one card, autoprobe and PnP.
1381
1382 Module snd-opti92x-cs4231
1383 -------------------------
1384
1385 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1386
Rene Herman64e0e2d2007-12-13 16:29:33 +01001387 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1388
1389 with isapnp=0, the following options are available:
1390
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1392 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1393 fm_port - port # for OPL3 device (0x388)
1394 irq - IRQ # for WSS chip (5,7,9,10,11)
1395 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1396 dma1 - first DMA # for WSS chip (0,1,3)
1397 dma2 - second DMA # for WSS chip (0,1,3)
1398
1399 This module supports only one card, autoprobe and PnP.
1400
1401 Module snd-opti93x
1402 ------------------
1403
1404 Module for sound cards based on OPTi 82c93x chips.
1405
Rene Herman64e0e2d2007-12-13 16:29:33 +01001406 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1407
1408 with isapnp=0, the following options are available:
1409
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1411 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1412 fm_port - port # for OPL3 device (0x388)
1413 irq - IRQ # for WSS chip (5,7,9,10,11)
1414 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1415 dma1 - first DMA # for WSS chip (0,1,3)
1416 dma2 - second DMA # for WSS chip (0,1,3)
1417
1418 This module supports only one card, autoprobe and PnP.
1419
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001420 Module snd-oxygen
1421 -----------------
1422
1423 Module for sound cards based on the C-Media CMI8788 chip:
1424 * Asound A-8788
1425 * AuzenTech X-Meridian
1426 * Bgears b-Enspirer
1427 * Club3D Theatron DTS
Clemens Ladischde04b102008-11-26 10:37:23 +01001428 * HT-Omega Claro (plus)
1429 * HT-Omega Claro halo (XT)
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001430 * Razer Barracuda AC-1
1431 * Sondigo Inferno
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001432
1433 This module supports autoprobe and multiple cards.
1434
Stas Sergeevd08cd582008-03-06 11:01:44 +01001435 Module snd-pcsp
1436 -----------------
1437
1438 Module for internal PC-Speaker.
1439
1440 nforce_wa - enable NForce chipset workaround. Expect bad sound.
1441
1442 This module supports system beeps, some kind of PCM playback and
1443 even a few mixer controls.
1444
Markus Bollingere12229b2005-12-06 13:55:26 +01001445 Module snd-pcxhr
1446 ----------------
1447
1448 Module for Digigram PCXHR boards
1449
1450 This module supports multiple cards.
1451
Matthias Koenig757e1192007-01-25 13:15:05 +01001452 Module snd-portman2x4
1453 ---------------------
1454
1455 Module for Midiman Portman 2x4 parallel port MIDI interface
1456
1457 This module supports multiple cards.
1458
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459 Module snd-powermac (on ppc only)
1460 ---------------------------------
1461
1462 Module for PowerMac, iMac and iBook on-board soundchips
1463
1464 enable_beep - enable beep using PCM (enabled as default)
1465
1466 Module supports autoprobe a chip.
1467
1468 Note: the driver may have problems regarding endianess.
1469
1470 The power-management is supported.
1471
Takashi Iwai2c484df2005-06-30 18:54:04 +02001472 Module snd-pxa2xx-ac97 (on arm only)
1473 ------------------------------------
1474
1475 Module for AC97 driver for the Intel PXA2xx chip
1476
1477 For ARM architecture only.
1478
Takashi Iwaia4efc232005-11-17 17:24:26 +01001479 The power-management is supported.
1480
Peter Gruber109a9632006-03-27 13:10:28 +02001481 Module snd-riptide
1482 ------------------
1483
1484 Module for Conexant Riptide chip
1485
1486 joystick_port - Joystick port # (default: 0x200)
1487 mpu_port - MPU401 port # (default: 0x330)
1488 opl3_port - OPL3 port # (default: 0x388)
1489
1490 This module supports multiple cards.
1491 The driver requires the firmware loader support on kernel.
1492 You need to install the firmware file "riptide.hex" to the standard
1493 firmware path (e.g. /lib/firmware).
1494
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495 Module snd-rme32
1496 ----------------
1497
1498 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1499 Prodif96 and Prodif Gold) sound cards.
1500
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001501 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502
1503 Module snd-rme96
1504 ----------------
1505
1506 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST 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-rme9652
1511 ------------------
1512
1513 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1514
1515 precise_ptr - Enable precise pointer (doesn't work reliably).
1516 (default = 0)
1517
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001518 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519
1520 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1521 module did formerly. It will allocate the buffers in advance
1522 when any RME9652 cards are found. To make the buffer
1523 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +02001524 stage of boot sequence. See "Early Buffer Allocation"
1525 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526
1527 Module snd-sa11xx-uda1341 (on arm only)
1528 ---------------------------------------
1529
1530 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1531
1532 Module supports only one card.
1533 Module has no enable and index options.
1534
Takashi Iwaia4efc232005-11-17 17:24:26 +01001535 The power-management is supported.
1536
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537 Module snd-sb8
1538 --------------
1539
1540 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1541 SoundBlaster 2.0,
1542 SoundBlaster Pro
1543
1544 port - port # for SB DSP chip (0x220,0x240,0x260)
1545 irq - IRQ # for SB DSP chip (5,7,9,10)
1546 dma8 - DMA # for SB DSP chip (1,3)
1547
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001548 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549
Takashi Iwaia4efc232005-11-17 17:24:26 +01001550 The power-management is supported.
1551
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 Module snd-sb16 and snd-sbawe
1553 -----------------------------
1554
1555 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1556 SoundBlaster AWE 32 (PnP),
1557 SoundBlaster AWE 64 PnP
1558
Rene Herman64e0e2d2007-12-13 16:29:33 +01001559 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1560 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1561 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1562
1563 with isapnp=0, the following options are available:
1564
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1566 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1567 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1568 (snd-sbawe module only)
1569 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1570 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1571 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001573 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574
1575 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1576 disable 16bit DMA with dma16 = -1 module parameter.
1577 Also, all Sound Blaster 16 type cards can operate in 16-bit
1578 half duplex mode through 8-bit DMA channel by disabling their
1579 16-bit DMA channel.
1580
Takashi Iwaia4efc232005-11-17 17:24:26 +01001581 The power-management is supported.
1582
Takashi Iwai074a6e92007-09-11 22:10:14 +02001583 Module snd-sc6000
1584 -----------------
1585
Krzysztof Heltb0ec3a32009-05-03 10:39:19 +02001586 Module for Gallant SC-6000 soundcard and later models: SC-6600
1587 and SC-7000.
Takashi Iwai074a6e92007-09-11 22:10:14 +02001588
1589 port - Port # (0x220 or 0x240)
1590 mss_port - MSS Port # (0x530 or 0xe80)
1591 irq - IRQ # (5,7,9,10,11)
Krzysztof Helt7b758d22007-09-17 14:42:49 +02001592 mpu_irq - MPU-401 IRQ # (5,7,9,10) ,0 - no MPU-401 irq
Takashi Iwai074a6e92007-09-11 22:10:14 +02001593 dma - DMA # (1,3,0)
Krzysztof Heltb0ec3a32009-05-03 10:39:19 +02001594 joystick - Enable gameport - 0 = disable (default), 1 = enable
Takashi Iwai074a6e92007-09-11 22:10:14 +02001595
1596 This module supports multiple cards.
1597
1598 This card is also known as Audio Excel DSP 16 or Zoltrix AV302.
1599
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600 Module snd-sgalaxy
1601 ------------------
1602
1603 Module for Aztech Sound Galaxy sound card.
1604
1605 sbport - Port # for SB16 interface (0x220,0x240)
1606 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1607 irq - IRQ # (7,9,10,11)
1608 dma1 - DMA #
1609
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001610 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611
Takashi Iwaia4efc232005-11-17 17:24:26 +01001612 The power-management is supported.
1613
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 Module snd-sscape
1615 -----------------
1616
1617 Module for ENSONIQ SoundScape PnP cards.
1618
1619 port - Port # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001620 wss_port - WSS Port # (PnP setup)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 irq - IRQ # (PnP setup)
1622 mpu_irq - MPU-401 IRQ # (PnP setup)
1623 dma - DMA # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001624 dma2 - 2nd DMA # (PnP setup, -1 to disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001626 This module supports multiple cards. ISA PnP must be enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627 You need sscape_ctl tool in alsa-tools package for loading
1628 the microcode.
1629
1630 Module snd-sun-amd7930 (on sparc only)
1631 --------------------------------------
1632
1633 Module for AMD7930 sound chips found on Sparcs.
1634
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001635 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636
1637 Module snd-sun-cs4231 (on sparc only)
1638 -------------------------------------
1639
1640 Module for CS4231 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
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001644 Module snd-sun-dbri (on sparc only)
1645 -----------------------------------
1646
1647 Module for DBRI sound chips found on Sparcs.
1648
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001649 This module supports multiple cards.
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001650
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 Module snd-wavefront
1652 --------------------
1653
1654 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1655
Rene Herman64e0e2d2007-12-13 16:29:33 +01001656 use_cs4232_midi - Use CS4232 MPU-401 interface
1657 (inaccessibly located inside your computer)
1658 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1659
1660 with isapnp=0, the following options are available:
1661
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 cs4232_pcm_port - Port # for CS4232 PCM interface.
1663 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1664 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1665 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666 ics2115_port - Port # for ICS2115
1667 ics2115_irq - IRQ # for ICS2115
1668 fm_port - FM OPL-3 Port #
1669 dma1 - DMA1 # for CS4232 PCM interface.
1670 dma2 - DMA2 # for CS4232 PCM interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671
Takashi Iwaic2b12392007-08-21 15:20:26 +02001672 The below are options for wavefront_synth features:
1673 wf_raw - Assume that we need to boot the OS (default:no)
1674 If yes, then during driver loading, the state of the board is
1675 ignored, and we reset the board and load the firmware anyway.
1676 fx_raw - Assume that the FX process needs help (default:yes)
1677 If false, we'll leave the FX processor in whatever state it is
1678 when the driver is loaded. The default is to download the
1679 microprogram and associated coefficients to set it up for
1680 "default" operation, whatever that means.
1681 debug_default - Debug parameters for card initialization
1682 wait_usecs - How long to wait without sleeping, usecs
1683 (default:150)
1684 This magic number seems to give pretty optimal throughput
1685 based on my limited experimentation.
1686 If you want to play around with it and find a better value, be
1687 my guest. Remember, the idea is to get a number that causes us
1688 to just busy wait for as many WaveFront commands as possible,
1689 without coming up with a number so large that we hog the whole
1690 CPU.
1691 Specifically, with this number, out of about 134,000 status
1692 waits, only about 250 result in a sleep.
1693 sleep_interval - How long to sleep when waiting for reply
1694 (default: 100)
1695 sleep_tries - How many times to try sleeping during a wait
1696 (default: 50)
1697 ospath - Pathname to processed ICS2115 OS firmware
1698 (default:wavefront.os)
1699 The path name of the ISC2115 OS firmware. In the recent
1700 version, it's handled via firmware loader framework, so it
1701 must be installed in the proper path, typically,
1702 /lib/firmware.
1703 reset_time - How long to wait for a reset to take effect
1704 (default:2)
1705 ramcheck_time - How many seconds to wait for the RAM test
1706 (default:20)
1707 osrun_time - How many seconds to wait for the ICS2115 OS
1708 (default:10)
1709
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001710 This module supports multiple cards and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711
Takashi Iwaic2b12392007-08-21 15:20:26 +02001712 Note: the firmware file "wavefront.os" was located in the earlier
1713 version in /etc. Now it's loaded via firmware loader, and
1714 must be in the proper firmware path, such as /lib/firmware.
1715 Copy (or symlink) the file appropriately if you get an error
1716 regarding firmware downloading after upgrading the kernel.
1717
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718 Module snd-sonicvibes
1719 ---------------------
1720
1721 Module for S3 SonicVibes PCI sound cards.
1722 * PINE Schubert 32 PCI
1723
1724 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1725 - SoundCard must have onboard SRAM for this.
1726 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1727
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001728 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729
1730 Module snd-serial-u16550
1731 ------------------------
1732
1733 Module for UART16550A serial MIDI ports.
1734
1735 port - port # for UART16550A chip
1736 irq - IRQ # for UART16550A chip, -1 = poll mode
1737 speed - speed in bauds (9600,19200,38400,57600,115200)
1738 38400 = default
1739 base - base for divisor in bauds (57600,115200,230400,460800)
1740 115200 = default
1741 outs - number of MIDI ports in a serial port (1-4)
1742 1 = default
1743 adaptor - Type of adaptor.
1744 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1745 3 = MS-124W M/B, 4 = Generic
1746
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001747 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 thus the main port must be specified!!! Other options are optional.
1749
1750 Module snd-trident
1751 ------------------
1752
1753 Module for Trident 4DWave DX/NX sound cards.
1754 * Best Union Miss Melody 4DWave PCI
1755 * HIS 4DWave PCI
1756 * Warpspeed ONSpeed 4DWave PCI
1757 * AzTech PCI 64-Q3D
1758 * Addonics SV 750
1759 * CHIC True Sound 4Dwave
1760 * Shark Predator4D-PCI
1761 * Jaton SonicWave 4D
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001762 * SiS SI7018 PCI Audio
1763 * Hoontech SoundTrack Digital 4DWave NX
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764
1765 pcm_channels - max channels (voices) reserved for PCM
1766 wavetable_size - max wavetable size in kB (4-?kb)
1767
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001768 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769
1770 The power-management is supported.
1771
1772 Module snd-usb-audio
1773 --------------------
1774
1775 Module for USB audio and USB MIDI devices.
1776
1777 vid - Vendor ID for the device (optional)
1778 pid - Product ID for the device (optional)
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001779 nrpacks - Max. number of packets per URB (default: 8)
1780 async_unlink - Use async unlink mode (default: yes)
Thibault LE MEURe3113342006-03-14 11:44:53 +01001781 device_setup - Device specific magic number (optional)
1782 - Influence depends on the device
1783 - Default: 0x0000
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001784 ignore_ctl_error - Ignore any USB-controller regarding mixer
1785 interface (default: no)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001787 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001789 NB: nrpacks parameter can be modified dynamically via sysfs.
1790 Don't put the value over 20. Changing via sysfs has no sanity
1791 check.
1792 NB: async_unlink=0 would cause Oops. It remains just for
1793 debugging purpose (if any).
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001794 NB: ignore_ctl_error=1 may help when you get an error at accessing
1795 the mixer element such as URB error -22. This happens on some
1796 buggy USB device or the controller.
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001797
Daniel Mack523f1dc2007-03-26 19:11:24 +02001798 Module snd-usb-caiaq
1799 --------------------
1800
1801 Module for caiaq UB audio interfaces,
1802 * Native Instruments RigKontrol2
1803 * Native Instruments Kore Controller
1804 * Native Instruments Audio Kontrol 1
1805 * Native Instruments Audio 8 DJ
1806
1807 This module supports multiple devices, autoprobe and hotplugging.
1808
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 Module snd-usb-usx2y
1810 --------------------
1811
1812 Module for Tascam USB US-122, US-224 and US-428 devices.
1813
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001814 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815
1816 Note: you need to load the firmware via usx2yloader utility included
1817 in alsa-tools and alsa-firmware packages.
1818
1819 Module snd-via82xx
1820 ------------------
1821
1822 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001823 8233A, 8233C, 8235, 8237 (south) bridge.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824
1825 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1826 [VIA686A/686B only]
1827 joystick - Enable joystick (default off) [VIA686A/686B only]
1828 ac97_clock - AC'97 codec clock base (default 48000Hz)
1829 dxs_support - support DXS channels,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001830 0 = auto (default), 1 = enable, 2 = disable,
1831 3 = 48k only, 4 = no VRA, 5 = enable any sample
1832 rate and different sample rates on different
1833 channels
1834 [VIA8233/C, 8235, 8237 only]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001836 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001838 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839
1840 Note: on some SMP motherboards like MSI 694D the interrupts might
1841 not be generated properly. In such a case, please try to
1842 set the SMP (or MPS) version on BIOS to 1.1 instead of
1843 default value 1.4. Then the interrupt number will be
1844 assigned under 15. You might also upgrade your BIOS.
1845
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001846 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847 channels as the first PCM. On these channels, up to 4
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001848 streams can be played at the same time, and the controller
1849 can perform sample rate conversion with separate rates for
1850 each channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 As default (dxs_support = 0), 48k fixed rate is chosen
1852 except for the known devices since the output is often
1853 noisy except for 48k on some mother boards due to the
1854 bug of BIOS.
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001855 Please try once dxs_support=5 and if it works on other
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1857 know the PCI subsystem vendor/device id's (output of
1858 "lspci -nv").
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001859 If dxs_support=5 does not work, try dxs_support=4; if it
1860 doesn't work too, try dxs_support=1. (dxs_support=1 is
Takashi Iwai62430082005-09-05 17:12:29 +02001861 usually for old motherboards. The correct implemented
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001862 board should work with 4 or 5.) If it still doesn't
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 work and the default setting is ok, dxs_support=3 is the
1864 right choice. If the default setting doesn't work at all,
1865 try dxs_support=2 to disable the DXS channels.
1866 In any cases, please let us know the result and the
Takashi Iwai62430082005-09-05 17:12:29 +02001867 subsystem vendor/device ids. See "Links and Addresses"
1868 below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869
1870 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Takashi Iwai62430082005-09-05 17:12:29 +02001871 additionally. The mpu_port option is for VIA686 chips only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872
Takashi Iwaia4efc232005-11-17 17:24:26 +01001873 The power-management is supported.
1874
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875 Module snd-via82xx-modem
1876 ------------------------
1877
1878 Module for VIA82xx AC97 modem
1879
1880 ac97_clock - AC'97 codec clock base (default 48000Hz)
1881
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001882 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001883
1884 Note: The default index value of this module is -2, i.e. the first
1885 slot is excluded.
1886
Takashi Iwaia4efc232005-11-17 17:24:26 +01001887 The power-management is supported.
1888
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889 Module snd-virmidi
1890 ------------------
1891
1892 Module for virtual rawmidi devices.
1893 This module creates virtual rawmidi devices which communicate
1894 to the corresponding ALSA sequencer ports.
1895
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001896 midi_devs - MIDI devices # (1-4, default=4)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001898 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001900 Module snd-virtuoso
1901 -------------------
1902
Clemens Ladisch5430c722008-07-28 10:28:43 +02001903 Module for sound cards based on the Asus AV100/AV200 chips,
Clemens Ladisch04f98902009-05-25 10:11:29 +02001904 i.e., Xonar D1, DX, D2, D2X, HDAV1.3 (Deluxe), Essence ST
1905 (Deluxe) and Essence STX.
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001906
1907 This module supports autoprobe and multiple cards.
1908
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 Module snd-vx222
1910 ----------------
1911
1912 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1913
1914 mic - Enable Microphone on V222 Mic (NYI)
1915 ibl - Capture IBL size. (default = 0, minimum size)
1916
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001917 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918
1919 When the driver is compiled as a module and the hotplug firmware
1920 is supported, the firmware data is loaded via hotplug automatically.
1921 Install the necessary firmware files in alsa-firmware package.
1922 When no hotplug fw loader is available, you need to load the
1923 firmware via vxloader utility in alsa-tools package. To invoke
1924 vxloader automatically, add the following to /etc/modprobe.conf
1925
1926 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1927
1928 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1929 /etc/modules.conf, instead.)
1930 IBL size defines the interrupts period for PCM. The smaller size
1931 gives smaller latency but leads to more CPU consumption, too.
1932 The size is usually aligned to 126. As default (=0), the smallest
1933 size is chosen. The possible IBL values can be found in
1934 /proc/asound/cardX/vx-status proc file.
1935
Takashi Iwaia4efc232005-11-17 17:24:26 +01001936 The power-management is supported.
1937
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938 Module snd-vxpocket
1939 -------------------
1940
Takashi Iwai6d00a312005-06-30 13:40:51 +02001941 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942
1943 ibl - Capture IBL size. (default = 0, minimum size)
1944
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001945 This module supports multiple cards. The module is compiled only when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 PCMCIA is supported on kernel.
1947
Takashi Iwai62430082005-09-05 17:12:29 +02001948 With the older 2.6.x kernel, to activate the driver via the card
1949 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1950 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1951 longer require a config file.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952
1953 When the driver is compiled as a module and the hotplug firmware
1954 is supported, the firmware data is loaded via hotplug automatically.
1955 Install the necessary firmware files in alsa-firmware package.
1956 When no hotplug fw loader is available, you need to load the
1957 firmware via vxloader utility in alsa-tools package.
1958
1959 About capture IBL, see the description of snd-vx222 module.
1960
Takashi Iwaied7cbe32006-05-11 11:30:10 +02001961 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
Takashi Iwai62430082005-09-05 17:12:29 +02001962 ALSA 1.0.10.
1963
Takashi Iwaia4efc232005-11-17 17:24:26 +01001964 The power-management is supported.
1965
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966 Module snd-ymfpci
1967 -----------------
1968
1969 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1970
1971 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1972 1 (auto-detect for YMF744/754 only)
1973 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1974 1 (auto-detect for YMF744/754 only)
1975 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1976 1 (auto-detect)
1977 rear_switch - enable shared rear/line-in switch (bool)
1978
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001979 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980
1981 The power-management is supported.
1982
1983 Module snd-pdaudiocf
1984 --------------------
1985
1986 Module for Sound Core PDAudioCF sound card.
1987
Takashi Iwaia4efc232005-11-17 17:24:26 +01001988 The power-management is supported.
1989
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990
Takashi Iwai62430082005-09-05 17:12:29 +02001991AC97 Quirk Option
1992=================
1993
1994The ac97_quirk option is used to enable/override the workaround for
1995specific devices on drivers for on-board AC'97 controllers like
1996snd-intel8x0. Some hardware have swapped output pins between Master
1997and Headphone, or Surround (thanks to confusion of AC'97
1998specifications from version to version :-)
1999
2000The driver provides the auto-detection of known problematic devices,
2001but some might be unknown or wrongly detected. In such a case, pass
2002the proper value with this option.
2003
2004The following strings are accepted:
2005 - default Don't override the default setting
Takashi Iwai10e4097f2005-11-17 11:04:55 +01002006 - none Disable the quirk
Takashi Iwai62430082005-09-05 17:12:29 +02002007 - hp_only Bind Master and Headphone controls as a single control
2008 - swap_hp Swap headphone and master controls
2009 - swap_surround Swap master and surround controls
2010 - ad_sharing For AD1985, turn on OMS bit and use headphone
2011 - alc_jack For ALC65x, turn on the jack sense mode
2012 - inv_eapd Inverted EAPD implementation
2013 - mute_led Bind EAPD bit for turning on/off mute LED
2014
2015For backward compatibility, the corresponding integer value -1, 0,
2016... are accepted, too.
2017
2018For example, if "Master" volume control has no effect on your device
2019but only "Headphone" does, pass ac97_quirk=hp_only module option.
2020
2021
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022Configuring Non-ISAPNP Cards
2023============================
2024
2025When the kernel is configured with ISA-PnP support, the modules
2026supporting the isapnp cards will have module options "isapnp".
2027If this option is set, *only* the ISA-PnP devices will be probed.
2028For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
2029together with the proper i/o and irq configuration.
2030
2031When the kernel is configured without ISA-PnP support, isapnp option
2032will be not built in.
2033
2034
2035Module Autoloading Support
2036==========================
2037
2038The ALSA drivers can be loaded automatically on demand by defining
2039module aliases. The string 'snd-card-%1' is requested for ALSA native
2040devices where %i is sound card number from zero to seven.
2041
2042To auto-load an ALSA driver for OSS services, define the string
2043'sound-slot-%i' where %i means the slot number for OSS, which
2044corresponds to the card index of ALSA. Usually, define this
Tobias Klauserd533f672005-09-10 00:26:46 -07002045as the same card module.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046
2047An example configuration for a single emu10k1 card is like below:
2048----- /etc/modprobe.conf
2049alias snd-card-0 snd-emu10k1
2050alias sound-slot-0 snd-emu10k1
2051----- /etc/modprobe.conf
2052
2053The available number of auto-loaded sound cards depends on the module
2054option "cards_limit" of snd module. As default it's set to 1.
2055To enable the auto-loading of multiple cards, specify the number of
2056sound cards in that option.
2057
2058When multiple cards are available, it'd better to specify the index
2059number for each card via module option, too, so that the order of
2060cards is kept consistent.
2061
2062An example configuration for two sound cards is like below:
2063
2064----- /etc/modprobe.conf
2065# ALSA portion
2066options snd cards_limit=2
2067alias snd-card-0 snd-interwave
2068alias snd-card-1 snd-ens1371
2069options snd-interwave index=0
2070options snd-ens1371 index=1
2071# OSS/Free portion
2072alias sound-slot-0 snd-interwave
2073alias sound-slot-1 snd-ens1371
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02002074----- /etc/modprobe.conf
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075
2076In this example, the interwave card is always loaded as the first card
2077(index 0) and ens1371 as the second (index 1).
2078
Takashi Iwai304cd072007-10-26 15:10:15 +02002079Alternative (and new) way to fixate the slot assignment is to use
2080"slots" option of snd module. In the case above, specify like the
2081following:
2082
2083options snd slots=snd-interwave,snd-ens1371
2084
2085Then, the first slot (#0) is reserved for snd-interwave driver, and
2086the second (#1) for snd-ens1371. You can omit index option in each
2087driver if slots option is used (although you can still have them at
2088the same time as long as they don't conflict).
2089
2090The slots option is especially useful for avoiding the possible
2091hot-plugging and the resultant slot conflict. For example, in the
2092case above again, the first two slots are already reserved. If any
2093other driver (e.g. snd-usb-audio) is loaded before snd-interwave or
2094snd-ens1371, it will be assigned to the third or later slot.
2095
Takashi Iwaia93bbaa2008-05-27 17:59:24 +02002096When a module name is given with '!', the slot will be given for any
2097modules but that name. For example, "slots=!snd-pcsp" will reserve
2098the first slot for any modules but snd-pcsp.
2099
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100
2101ALSA PCM devices to OSS devices mapping
2102=======================================
2103
2104/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
2105/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
2106/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
2107/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
2108/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
2109/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
2110/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
2111/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
2112/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
2113
2114The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
2115sound card number and second means device number. The ALSA devices
2116have either 'c' or 'p' suffix indicating the direction, capture and
2117playback, respectively.
2118
2119Please note that the device mapping above may be varied via the module
2120options of snd-pcm-oss module.
2121
2122
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123Proc interfaces (/proc/asound)
2124==============================
2125
2126/proc/asound/card#/pcm#[cp]/oss
2127-------------------------------
2128 String "erase" - erase all additional informations about OSS applications
2129 String "<app_name> <fragments> <fragment_size> [<options>]"
2130
2131 <app_name> - name of application with (higher priority) or without path
2132 <fragments> - number of fragments or zero if auto
2133 <fragment_size> - size of fragment in bytes or zero if auto
2134 <options> - optional parameters
2135 - disable the application tries to open a pcm device for
2136 this channel but does not want to use it.
2137 (Cause a bug or mmap needs)
2138 It's good for Quake etc...
2139 - direct don't use plugins
2140 - block force block mode (rvplayer)
2141 - non-block force non-block mode
2142 - whole-frag write only whole fragments (optimization affecting
2143 playback only)
2144 - no-silence do not fill silence ahead to avoid clicks
Takashi Iwai10f69f92005-09-08 13:48:34 +02002145 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
2146 instead of filled blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147
2148 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
2149 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
2150 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
2151
2152
Takashi Iwaib6a96912005-05-30 18:27:03 +02002153Early Buffer Allocation
2154=======================
2155
2156Some drivers (e.g. hdsp) require the large contiguous buffers, and
2157sometimes it's too late to find such spaces when the driver module is
2158actually loaded due to memory fragmentation. You can pre-allocate the
2159PCM buffers by loading snd-page-alloc module and write commands to its
2160proc file in prior, for example, in the early boot stage like
2161/etc/init.d/*.local scripts.
2162
2163Reading the proc file /proc/drivers/snd-page-alloc shows the current
2164usage of page allocation. In writing, you can send the following
2165commands to the snd-page-alloc driver:
2166
2167 - add VENDOR DEVICE MASK SIZE BUFFERS
2168
2169 VENDOR and DEVICE are PCI vendor and device IDs. They take
2170 integer numbers (0x prefix is needed for the hex).
2171 MASK is the PCI DMA mask. Pass 0 if not restricted.
2172 SIZE is the size of each buffer to allocate. You can pass
2173 k and m suffix for KB and MB. The max number is 16MB.
2174 BUFFERS is the number of buffers to allocate. It must be greater
2175 than 0. The max number is 4.
2176
2177 - erase
2178
2179 This will erase the all pre-allocated buffers which are not in
2180 use.
2181
2182
Takashi Iwai62430082005-09-05 17:12:29 +02002183Links and Addresses
2184===================
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185
2186 ALSA project homepage
2187 http://www.alsa-project.org
2188
Takashi Iwai30bc4482008-12-09 08:23:45 +01002189 Kernel Bugzilla
2190 http://bugzilla.kernel.org/
Takashi Iwai62430082005-09-05 17:12:29 +02002191
2192 ALSA Developers ML
Rene Herman45051792007-03-21 12:05:06 +01002193 mailto:alsa-devel@alsa-project.org
Takashi Iwai30bc4482008-12-09 08:23:45 +01002194
2195 alsa-info.sh script
2196 http://www.alsa-project.org/alsa-info.sh