blob: 4252697a95d6f41c23b1a0a8e7375f98626a3bac [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 Iwaia4efc232005-11-17 17:24:26 +0100516 The power-management is supported.
517
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200518 Module snd-echo3g
519 -----------------
520
521 Module for Echoaudio 3G cards (Gina3G/Layla3G)
522
523 This module supports multiple cards.
524 The driver requires the firmware loader support on kernel.
525
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 Module snd-emu10k1
527 ------------------
528
529 Module for EMU10K1/EMU10k2 based PCI sound cards.
530 * Sound Blaster Live!
531 * Sound Blaster PCI 512
532 * Emu APS (partially supported)
533 * Sound Blaster Audigy
534
535 extin - bitmap of available external inputs for FX8010 (see bellow)
536 extout - bitmap of available external outputs for FX8010 (see bellow)
537 seq_ports - allocated sequencer ports (4 by default)
538 max_synth_voices - limit of voices used for wavetable (64 by default)
539 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
540 given in MB unit. Default value is 128.
541 enable_ir - enable IR
542
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100543 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544
545 Input & Output configurations [extin/extout]
546 * Creative Card wo/Digital out [0x0003/0x1f03]
547 * Creative Card w/Digital out [0x0003/0x1f0f]
548 * Creative Card w/Digital CD in [0x000f/0x1f0f]
549 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
550 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
551 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
552 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
553 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
554 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
555 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
556 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
557 * Creative Card all ins and outs [0x3fff/0x7fff]
558
Takashi Iwaia4efc232005-11-17 17:24:26 +0100559 The power-management is supported.
560
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 Module snd-emu10k1x
562 -------------------
563
564 Module for Creative Emu10k1X (SB Live Dell OEM version)
565
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100566 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
568 Module snd-ens1370
569 ------------------
570
571 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
572 * SoundBlaster PCI 64
573 * SoundBlaster PCI 128
574
575 joystick - Enable joystick (default off)
576
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100577 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100579 The power-management is supported.
580
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 Module snd-ens1371
582 ------------------
583
584 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
585 * SoundBlaster PCI 64
586 * SoundBlaster PCI 128
587 * SoundBlaster Vibra PCI
588
589 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
590 0 = disable (default), 1 = auto-detect
591
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100592 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100594 The power-management is supported.
595
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 Module snd-es968
597 ----------------
598
599 Module for sound cards based on ESS ES968 chip (PnP only).
600
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100601 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
Takashi Iwaia4efc232005-11-17 17:24:26 +0100603 The power-management is supported.
604
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 Module snd-es1688
606 -----------------
607
608 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
609
610 port - port # for ES-1688 chip (0x220,0x240,0x260)
Takashi Iwai504a06d2009-01-30 19:59:10 +0100611 fm_port - port # for OPL3 (option; share the same port as default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
613 irq - IRQ # for ES-1688 chip (5,7,9,10)
614 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
615 dma8 - DMA # for ES-1688 chip (0,1,3)
616
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100617 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
619 Module snd-es18xx
620 -----------------
621
622 Module for ESS AudioDrive ES-18xx sound cards.
623
Rene Herman64e0e2d2007-12-13 16:29:33 +0100624 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
625
626 with isapnp=0, the following options are available:
627
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 port - port # for ES-18xx chip (0x220,0x240,0x260)
629 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
630 fm_port - port # for FM (optional, not used)
631 irq - IRQ # for ES-18xx chip (5,7,9,10)
632 dma1 - first DMA # for ES-18xx chip (0,1,3)
633 dma2 - first DMA # for ES-18xx chip (0,1,3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100635 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
636 port if native ISA PnP routines are not used).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 When dma2 is equal with dma1, the driver works as half-duplex.
638
639 The power-management is supported.
640
641 Module snd-es1938
642 -----------------
643
644 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
645
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100646 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
Takashi Iwaia4efc232005-11-17 17:24:26 +0100648 The power-management is supported.
649
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 Module snd-es1968
651 -----------------
652
653 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
654
655 total_bufsize - total buffer size in kB (1-4096kB)
656 pcm_substreams_p - playback channels (1-8, default=2)
657 pcm_substreams_c - capture channels (1-8, default=0)
658 clock - clock (0 = auto-detection)
659 use_pm - support the power-management (0 = off, 1 = on,
660 2 = auto (default))
661 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
662 joystick - enable joystick (default off)
663
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100664 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
666 The power-management is supported.
667
668 Module snd-fm801
669 ----------------
670
671 Module for ForteMedia FM801 based PCI sound cards.
672
673 tea575x_tuner - Enable TEA575x tuner
674 - 1 = MediaForte 256-PCS
675 - 2 = MediaForte 256-PCPR
676 - 3 = MediaForte 64-PCR
677 - High 16-bits are video (radio) device number + 1
678 - example: 0x10002 (MediaForte 256-PCPR, device 1)
679
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100680 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681
Takashi Iwaia4efc232005-11-17 17:24:26 +0100682 The power-management is supported.
683
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200684 Module snd-gina20
685 -----------------
686
687 Module for Echoaudio Gina20
688
689 This module supports multiple cards.
690 The driver requires the firmware loader support on kernel.
691
692 Module snd-gina24
693 -----------------
694
695 Module for Echoaudio Gina24
696
697 This module supports multiple cards.
698 The driver requires the firmware loader support on kernel.
699
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 Module snd-gusclassic
701 ---------------------
702
703 Module for Gravis UltraSound Classic sound card.
704
705 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
706 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
707 dma1 - DMA # for GF1 chip (1,3,5,6,7)
708 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
709 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
710 voices - GF1 voices limit (14-32)
711 pcm_voices - reserved PCM voices
712
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100713 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
715 Module snd-gusextreme
716 ---------------------
717
718 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
719
720 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
721 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
722 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
723 irq - IRQ # for ES-1688 chip (5,7,9,10)
724 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
725 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
726 dma8 - DMA # for ES-1688 chip (0,1,3)
727 dma1 - DMA # for GF1 chip (1,3,5,6,7)
728 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
729 voices - GF1 voices limit (14-32)
730 pcm_voices - reserved PCM voices
731
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100732 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733
734 Module snd-gusmax
735 -----------------
736
737 Module for Gravis UltraSound MAX sound card.
738
739 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
740 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
741 dma1 - DMA # for GF1 chip (1,3,5,6,7)
742 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
743 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
744 voices - GF1 voices limit (14-32)
745 pcm_voices - reserved PCM voices
746
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100747 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
749 Module snd-hda-intel
750 --------------------
751
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400752 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8, ICH9, ICH10,
753 PCH, SCH),
754 ATI SB450, SB600, R600, RS600, RS690, RS780, RV610, RV620,
755 RV630, RV635, RV670, RV770,
Takashi Iwai9b878192006-05-17 11:26:39 +0200756 VIA VT8251/VT8237A,
757 SIS966, ULI M5461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100759 [Multiple options for each card instance]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760 model - force the model name
Takashi Iwaid2e1c972008-06-10 17:53:34 +0200761 position_fix - Fix DMA pointer (0 = auto, 1 = use LPIB, 2 = POSBUF)
Takashi Iwai95904742007-05-19 17:06:42 +0200762 probe_mask - Bitmask to probe codecs (default = -1, meaning all slots)
Takashi Iwaiae374d62009-02-13 08:33:55 +0100763 When the bit 8 (0x100) is set, the lower 8 bits are used
764 as the "fixed" codec slots; i.e. the driver probes the
765 slots regardless what hardware reports back
Takashi Iwaid4d9cd032008-12-19 15:19:11 +0100766 probe_only - Only probing and no codec initialization (default=off);
767 Useful to check the initial codec status for debugging
Takashi Iwai8c53b962008-06-10 17:53:35 +0200768 bdl_pos_adj - Specifies the DMA IRQ timing delay in samples.
769 Passing -1 will make the driver to choose the appropriate
770 value based on the controller chip.
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100771
772 [Single (global) options]
Takashi Iwai27346162006-01-12 18:28:44 +0100773 single_cmd - Use single immediate commands to communicate with
774 codecs (for debugging only)
Takashi Iwai134a11f2006-11-10 12:08:37 +0100775 enable_msi - Enable Message Signaled Interrupt (MSI) (default = off)
Matt LaPlante19f59462009-04-27 15:06:31 +0200776 power_save - Automatic power-saving timeout (in second, 0 =
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200777 disable)
Takashi Iwaidee1b662007-08-13 16:10:30 +0200778 power_save_controller - Reset HD-audio controller in power-saving mode
779 (default = on)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100781 This module supports multiple cards and autoprobe.
782
Takashi Iwaicae51172008-12-19 08:36:53 +0100783 See Documentation/sound/alsa/HD-Audio.txt for more details about
784 HD-audio driver.
785
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786 Each codec may have a model table for different configurations.
787 If your machine isn't listed there, the default (usually minimal)
788 configuration is set up. You can pass "model=<name>" option to
789 specify a certain model in such a case. There are different
Takashi Iwaicae51172008-12-19 08:36:53 +0100790 models depending on the codec chip. The list of available models
791 is found in HD-Audio-Models.txt
Takashi Iwaidb064e52006-03-16 16:04:58 +0100792
Takashi Iwai6d7b1d72007-02-26 15:56:46 +0100793 The model name "genric" is treated as a special case. When this
794 model is given, the driver uses the generic codec parser without
795 "codec-patch". It's sometimes good for testing and debugging.
796
Takashi Iwai62430082005-09-05 17:12:29 +0200797 If the default configuration doesn't work and one of the above
Takashi Iwai30bc4482008-12-09 08:23:45 +0100798 matches with your device, report it together with alsa-info.sh
799 output (with --no-upload option) to kernel bugzilla or alsa-devel
Takashi Iwai62430082005-09-05 17:12:29 +0200800 ML (see the section "Links and Addresses").
801
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200802 power_save and power_save_controller options are for power-saving
803 mode. See powersave.txt for details.
Takashi Iwaidee1b662007-08-13 16:10:30 +0200804
Takashi Iwaic74db862005-05-12 14:26:27 +0200805 Note 2: If you get click noises on output, try the module option
806 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
807 register value without FIFO size correction as the current
808 DMA pointer. position_fix=2 will make the driver to use
809 the position buffer instead of reading SD_LPIB register.
Michael Kerrisk90f31e32008-09-01 14:03:50 +0200810 (Usually SD_LPIB register is more accurate than the
Takashi Iwaic74db862005-05-12 14:26:27 +0200811 position buffer.)
812
Takashi Iwai27346162006-01-12 18:28:44 +0100813 NB: If you get many "azx_get_response timeout" messages at
814 loading, it's likely a problem of interrupts (e.g. ACPI irq
815 routing). Try to boot with options like "pci=noacpi". Also, you
816 can try "single_cmd=1" module option. This will switch the
817 communication method between HDA controller and codecs to the
818 single immediate commands instead of CORB/RIRB. Basically, the
819 single command mode is provided only for BIOS, and you won't get
820 unsolicited events, too. But, at least, this works independently
821 from the irq. Remember this is a last resort, and should be
822 avoided as much as possible...
823
Takashi Iwai95904742007-05-19 17:06:42 +0200824 MORE NOTES ON "azx_get_response timeout" PROBLEMS:
825 On some hardwares, you may need to add a proper probe_mask option
826 to avoid the "azx_get_response timeout" problem above, instead.
827 This occurs when the access to non-existing or non-working codec slot
828 (likely a modem one) causes a stall of the communication via HD-audio
829 bus. You can see which codec slots are probed by enabling
Takashi Iwai62cf8722008-05-20 12:15:15 +0200830 CONFIG_SND_DEBUG_VERBOSE, or simply from the file name of the codec
Takashi Iwai95904742007-05-19 17:06:42 +0200831 proc files. Then limit the slots to probe by probe_mask option.
832 For example, probe_mask=1 means to probe only the first slot, and
833 probe_mask=4 means only the third slot.
834
Takashi Iwaia4efc232005-11-17 17:24:26 +0100835 The power-management is supported.
836
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 Module snd-hdsp
838 ---------------
839
840 Module for RME Hammerfall DSP audio interface(s)
841
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100842 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843
844 Note: The firmware data can be automatically loaded via hotplug
845 when CONFIG_FW_LOADER is set. Otherwise, you need to load
846 the firmware via hdsploader utility included in alsa-tools
847 package.
848 The firmware data is found in alsa-firmware package.
849
850 Note: snd-page-alloc module does the job which snd-hammerfall-mem
851 module did formerly. It will allocate the buffers in advance
852 when any HDSP cards are found. To make the buffer
853 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +0200854 stage of boot sequence. See "Early Buffer Allocation"
855 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856
Takashi Iwai54704402005-06-03 11:27:00 +0200857 Module snd-hdspm
858 ----------------
859
860 Module for RME HDSP MADI board.
861
862 precise_ptr - Enable precise pointer, or disable.
863 line_outs_monitor - Send playback streams to analog outs by default.
864 enable_monitor - Enable Analog Out on Channel 63/64 by default.
865
866 See hdspm.txt for details.
867
Clemens Ladischc6260262008-01-25 08:41:52 +0100868 Module snd-hifier
869 -----------------
870
871 Module for the MediaTek/TempoTec HiFier Fantasia sound card.
872
873 This module supports autoprobe and multiple cards.
874
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875 Module snd-ice1712
876 ------------------
877
878 Module for Envy24 (ICE1712) based PCI sound cards.
879 * MidiMan M Audio Delta 1010
880 * MidiMan M Audio Delta 1010LT
881 * MidiMan M Audio Delta DiO 2496
882 * MidiMan M Audio Delta 66
883 * MidiMan M Audio Delta 44
884 * MidiMan M Audio Delta 410
885 * MidiMan M Audio Audiophile 2496
886 * TerraTec EWS 88MT
887 * TerraTec EWS 88D
888 * TerraTec EWX 24/96
889 * TerraTec DMX 6Fire
Takashi Iwaic9bce912005-05-24 13:41:03 +0200890 * TerraTec Phase 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 * Hoontech SoundTrack DSP 24
892 * Hoontech SoundTrack DSP 24 Value
893 * Hoontech SoundTrack DSP 24 Media 7.1
Takashi Iwaic9bce912005-05-24 13:41:03 +0200894 * Event Electronics, EZ8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 * Digigram VX442
Takashi Iwaic9bce912005-05-24 13:41:03 +0200896 * Lionstracs, Mediastaton
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400897 * Terrasoniq TS 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898
899 model - Use the given board model, one of the following:
900 delta1010, dio2496, delta66, delta44, audiophile, delta410,
901 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
Takashi Iwaic9bce912005-05-24 13:41:03 +0200902 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
903 phase88, mediastation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 omni - Omni I/O support for MidiMan M-Audio Delta44/66
Matt LaPlantefa00e7e2006-11-30 04:55:36 +0100905 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transceiver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 in msec resolution, default value is 500 (0.5 sec)
907
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100908 This module supports multiple cards and autoprobe. Note: The consumer part
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 is not used with all Envy24 based cards (for example in the MidiMan Delta
910 serie).
911
Takashi Iwaic9bce912005-05-24 13:41:03 +0200912 Note: The supported board is detected by reading EEPROM or PCI
913 SSID (if EEPROM isn't available). You can override the
914 model by passing "model" module option in case that the
915 driver isn't configured properly or you want to try another
916 type for testing.
917
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 Module snd-ice1724
919 ------------------
920
Takashi Iwaic9bce912005-05-24 13:41:03 +0200921 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100922 * MidiMan M Audio Revolution 5.1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 * MidiMan M Audio Revolution 7.1
Takashi Iwai56255062006-11-09 16:47:26 +0100924 * MidiMan M Audio Audiophile 192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 * AMP Ltd AUDIO2000
Takashi Iwaic9bce912005-05-24 13:41:03 +0200926 * TerraTec Aureon 5.1 Sky
927 * TerraTec Aureon 7.1 Space
928 * TerraTec Aureon 7.1 Universe
929 * TerraTec Phase 22
930 * TerraTec Phase 28
931 * AudioTrak Prodigy 7.1
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400932 * AudioTrak Prodigy 7.1 LT
933 * AudioTrak Prodigy 7.1 XT
934 * AudioTrak Prodigy 7.1 HIFI
935 * AudioTrak Prodigy 7.1 HD2
Takashi Iwaic9bce912005-05-24 13:41:03 +0200936 * AudioTrak Prodigy 192
937 * Pontis MS300
938 * Albatron K8X800 Pro II
939 * Chaintech ZNF3-150
940 * Chaintech ZNF3-250
941 * Chaintech 9CJS
Takashi Iwai8cfbbac2005-05-27 12:10:40 +0200942 * Chaintech AV-710
Takashi Iwaic9bce912005-05-24 13:41:03 +0200943 * Shuttle SN25P
Shin-ya Okadaf31639b2007-10-23 15:08:18 +0200944 * Onkyo SE-90PCI
945 * Onkyo SE-200PCI
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400946 * ESI Juli@
Takashi Iwai72cbfd42009-05-06 17:33:19 +0200947 * ESI Maya44
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400948 * Hercules Fortissimo IV
949 * EGO-SYS WaveTerminal 192M
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950
951 model - Use the given board model, one of the following:
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100952 revo51, revo71, amp2000, prodigy71, prodigy71lt,
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400953 prodigy71xt, prodigy71hifi, prodigyhd2, prodigy192,
954 juli, aureon51, aureon71, universe, ap192, k8x800,
955 phase22, phase28, ms300, av710, se200pci, se90pci,
Takashi Iwai72cbfd42009-05-06 17:33:19 +0200956 fortissimo4, sn25p, WT192M, maya44
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100958 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959
Takashi Iwaic9bce912005-05-24 13:41:03 +0200960 Note: The supported board is detected by reading EEPROM or PCI
961 SSID (if EEPROM isn't available). You can override the
962 model by passing "model" module option in case that the
963 driver isn't configured properly or you want to try another
964 type for testing.
965
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200966 Module snd-indigo
967 -----------------
968
969 Module for Echoaudio Indigo
970
971 This module supports multiple cards.
972 The driver requires the firmware loader support on kernel.
973
974 Module snd-indigodj
975 -------------------
976
977 Module for Echoaudio Indigo DJ
978
979 This module supports multiple cards.
980 The driver requires the firmware loader support on kernel.
981
982 Module snd-indigoio
983 -------------------
984
985 Module for Echoaudio Indigo IO
986
987 This module supports multiple cards.
988 The driver requires the firmware loader support on kernel.
989
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 Module snd-intel8x0
991 -------------------
992
993 Module for AC'97 motherboards from Intel and compatibles.
994 * Intel i810/810E, i815, i820, i830, i84x, MX440
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400995 ICH5, ICH6, ICH7, 6300ESB, ESB2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 * SiS 7012 (SiS 735)
Takashi Iwai89ac9c22006-01-24 10:36:57 +0100997 * NVidia NForce, NForce2, NForce3, MCP04, CK804
998 CK8, CK8S, MCP501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999 * AMD AMD768, AMD8111
1000 * ALi m5455
1001
1002 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1003 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001004 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 buggy_irq - Enable workaround for buggy interrupts on some
Takashi Iwaia06147d2005-09-08 19:54:17 +02001006 motherboards (default yes on nForce chips,
1007 otherwise off)
1008 buggy_semaphore - Enable workaround for hardwares with buggy
1009 semaphores (e.g. on some ASUS laptops)
1010 (default off)
Takashi Iwai6c5cfd92006-11-28 17:18:25 +01001011 spdif_aclink - Use S/PDIF over AC-link instead of direct connection
1012 from the controller chip
1013 (0 = off, 1 = on, -1 = default)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001015 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016
1017 Note: the latest driver supports auto-detection of chip clock.
1018 if you still encounter too fast playback, specify the clock
1019 explicitly via the module option "ac97_clock=41194".
1020
1021 Joystick/MIDI ports are not supported by this driver. If your
1022 motherboard has these devices, use the ns558 or snd-mpu401
1023 modules, respectively.
1024
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 The power-management is supported.
1026
1027 Module snd-intel8x0m
1028 --------------------
1029
1030 Module for Intel ICH (i8x0) chipset MC97 modems.
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001031 * Intel i810/810E, i815, i820, i830, i84x, MX440
1032 ICH5, ICH6, ICH7
1033 * SiS 7013 (SiS 735)
1034 * NVidia NForce, NForce2, NForce2s, NForce3
1035 * AMD AMD8111
1036 * ALi m5455
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037
1038 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1039
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001040 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041
1042 Note: The default index value of this module is -2, i.e. the first
1043 slot is excluded.
1044
Takashi Iwaia4efc232005-11-17 17:24:26 +01001045 The power-management is supported.
1046
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047 Module snd-interwave
1048 --------------------
1049
1050 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1051 and other sound cards based on AMD InterWave (tm) chip.
1052
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1054 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1055 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1056 effect - 1 = InterWave effects enable (default 0);
1057 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001058 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1059
1060 with isapnp=0, the following options are available:
1061
1062 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1063 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1064 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1065 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001067 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068
1069 Module snd-interwave-stb
1070 ------------------------
1071
1072 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1073 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1074 circuit for extended control of bass, treble and master volume.
1075
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1077 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1078 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1079 effect - 1 = InterWave effects enable (default 0);
1080 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001081 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1082
1083 with isapnp=0, the following options are available:
1084
1085 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1086 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1087 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1088 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1089 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001091 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092
1093 Module snd-korg1212
1094 -------------------
1095
1096 Module for Korg 1212 IO PCI card
1097
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001098 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001100 Module snd-layla20
1101 ------------------
1102
1103 Module for Echoaudio Layla20
1104
1105 This module supports multiple cards.
1106 The driver requires the firmware loader support on kernel.
1107
1108 Module snd-layla24
1109 ------------------
1110
1111 Module for Echoaudio Layla24
1112
1113 This module supports multiple cards.
1114 The driver requires the firmware loader support on kernel.
1115
Takashi Iwai8338c302009-04-14 12:30:36 +02001116 Module snd-lx6464es
1117 -------------------
1118
1119 Module for Digigram LX6464ES boards
1120
1121 This module supports multiple cards.
1122
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 Module snd-maestro3
1124 -------------------
1125
1126 Module for Allegro/Maestro3 chips
1127
1128 external_amp - enable external amp (enabled by default)
1129 amp_gpio - GPIO pin number for external amp (0-15) or
1130 -1 for default pin (8 for allegro, 1 for
1131 others)
1132
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001133 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134
1135 Note: the binding of amplifier is dependent on hardware.
1136 If there is no sound even though all channels are unmuted, try to
1137 specify other gpio connection via amp_gpio option.
1138 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1139 option.
1140
1141 The power-management is supported.
1142
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001143 Module snd-mia
1144 ---------------
1145
1146 Module for Echoaudio Mia
1147
1148 This module supports multiple cards.
1149 The driver requires the firmware loader support on kernel.
1150
Martin Langer1841f6132006-03-27 12:41:01 +02001151 Module snd-miro
1152 ---------------
1153
1154 Module for Miro soundcards: miroSOUND PCM 1 pro,
1155 miroSOUND PCM 12,
1156 miroSOUND PCM 20 Radio.
1157
1158 port - Port # (0x530,0x604,0xe80,0xf40)
1159 irq - IRQ # (5,7,9,10,11)
1160 dma1 - 1st dma # (0,1,3)
1161 dma2 - 2nd dma # (0,1)
1162 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1163 mpu_irq - MPU-401 irq # (5,7,9,10)
1164 fm_port - FM Port # (0x388)
1165 wss - enable WSS mode
1166 ide - enable onboard ide support
1167
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 Module snd-mixart
1169 -----------------
1170
1171 Module for Digigram miXart8 sound cards.
1172
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001173 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 Note: One miXart8 board will be represented as 4 alsa cards.
1175 See MIXART.txt for details.
1176
1177 When the driver is compiled as a module and the hotplug firmware
1178 is supported, the firmware data is loaded via hotplug automatically.
1179 Install the necessary firmware files in alsa-firmware package.
1180 When no hotplug fw loader is available, you need to load the
1181 firmware via mixartloader utility in alsa-tools package.
1182
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001183 Module snd-mona
1184 ---------------
1185
1186 Module for Echoaudio Mona
1187
1188 This module supports multiple cards.
1189 The driver requires the firmware loader support on kernel.
1190
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 Module snd-mpu401
1192 -----------------
1193
1194 Module for MPU-401 UART devices.
1195
1196 port - port number or -1 (disable)
1197 irq - IRQ number or -1 (disable)
1198 pnp - PnP detection - 0 = disable, 1 = enable (default)
1199
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001200 This module supports multiple devices and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201
Takashi Iwaic96330b2009-01-28 08:23:03 +01001202 Module snd-msnd-classic
1203 -----------------------
1204
1205 Module for Turtle Beach MultiSound Classic, Tahiti or Monterey
1206 soundcards.
1207
1208 io - Port # for msnd-classic card
1209 irq - IRQ # for msnd-classic card
1210 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1211 0xe0000 or 0xe8000)
1212 write_ndelay - enable write ndelay (default = 1)
1213 calibrate_signal - calibrate signal (default = 0)
1214 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1215 digital - Digital daughterboard present (default = 0)
1216 cfg - Config port (0x250, 0x260 or 0x270) default = PnP
1217 reset - Reset all devices
1218 mpu_io - MPU401 I/O port
1219 mpu_irq - MPU401 irq#
1220 ide_io0 - IDE port #0
1221 ide_io1 - IDE port #1
1222 ide_irq - IDE irq#
1223 joystick_io - Joystick I/O port
1224
1225 The driver requires firmware files "turtlebeach/msndinit.bin" and
1226 "turtlebeach/msndperm.bin" in the proper firmware directory.
1227
1228 See Documentation/sound/oss/MultiSound for important information
1229 about this driver. Note that it has been discontinued, but the
1230 Voyetra Turtle Beach knowledge base entry for it is still available
1231 at
1232 http://www.turtlebeach.com/site/kb_ftp/790.asp
1233
1234 Module snd-msnd-pinnacle
1235 ------------------------
1236
1237 Module for Turtle Beach MultiSound Pinnacle/Fiji soundcards.
1238
1239 io - Port # for pinnacle/fiji card
1240 irq - IRQ # for pinnalce/fiji card
1241 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1242 0xe0000 or 0xe8000)
1243 write_ndelay - enable write ndelay (default = 1)
1244 calibrate_signal - calibrate signal (default = 0)
1245 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1246
1247 The driver requires firmware files "turtlebeach/pndspini.bin" and
1248 "turtlebeach/pndsperm.bin" in the proper firmware directory.
1249
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 Module snd-mtpav
1251 ----------------
1252
1253 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1254 port).
1255
1256 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1257 irq - IRQ # for MTPAV (7,5, default=7)
1258 hwports - number of supported hardware ports, default=8.
1259
1260 Module supports only 1 card. This module has no enable option.
1261
Matthias Koenig68ab8012006-07-27 16:59:23 +02001262 Module snd-mts64
1263 ----------------
1264
1265 Module for Ego Systems (ESI) Miditerminal 4140
1266
1267 This module supports multiple devices.
1268 Requires parport (CONFIG_PARPORT).
1269
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 Module snd-nm256
1271 ----------------
1272
1273 Module for NeoMagic NM256AV/ZX chips
1274
1275 playback_bufsize - max playback frame size in kB (4-128kB)
1276 capture_bufsize - max capture frame size in kB (4-128kB)
1277 force_ac97 - 0 or 1 (disabled by default)
1278 buffer_top - specify buffer top address
1279 use_cache - 0 or 1 (disabled by default)
1280 vaio_hack - alias buffer_top=0x25a800
1281 reset_workaround - enable AC97 RESET workaround for some laptops
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001282 reset_workaround2 - enable extended AC97 RESET workaround for some
1283 other laptops
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +02001285 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286
1287 The power-management is supported.
1288
1289 Note: on some notebooks the buffer address cannot be detected
1290 automatically, or causes hang-up during initialization.
Matt LaPlantefff92892006-10-03 22:47:42 +02001291 In such a case, specify the buffer top address explicitly via
1292 the buffer_top option.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 For example,
1294 Sony F250: buffer_top=0x25a800
1295 Sony F270: buffer_top=0x272800
1296 The driver supports only ac97 codec. It's possible to force
1297 to initialize/use ac97 although it's not detected. In such a
1298 case, use force_ac97=1 option - but *NO* guarantee whether it
1299 works!
1300
1301 Note: The NM256 chip can be linked internally with non-AC97
1302 codecs. This driver supports only the AC97 codec, and won't work
1303 with machines with other (most likely CS423x or OPL3SAx) chips,
1304 even though the device is detected in lspci. In such a case, try
1305 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
Takashi Iwai62430082005-09-05 17:12:29 +02001306 but some doesn't have ISA PnP. You'll need to specify isapnp=0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307 and proper hardware parameters in the case without ISA PnP.
1308
1309 Note: some laptops need a workaround for AC97 RESET. For the
1310 known hardware like Dell Latitude LS and Sony PCG-F305, this
1311 workaround is enabled automatically. For other laptops with a
1312 hard freeze, you can try reset_workaround=1 option.
1313
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001314 Note: Dell Latitude CSx laptops have another problem regarding
1315 AC97 RESET. On these laptops, reset_workaround2 option is
1316 turned on as default. This option is worth to try if the
1317 previous reset_workaround option doesn't help.
1318
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319 Note: This driver is really crappy. It's a porting from the
1320 OSS driver, which is a result of black-magic reverse engineering.
1321 The detection of codec will fail if the driver is loaded *after*
1322 X-server as described above. You might be able to force to load
1323 the module, but it may result in hang-up. Hence, make sure that
1324 you load this module *before* X if you encounter this kind of
1325 problem.
1326
1327 Module snd-opl3sa2
1328 ------------------
1329
1330 Module for Yamaha OPL3-SA2/SA3 sound cards.
1331
Rene Herman64e0e2d2007-12-13 16:29:33 +01001332 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1333
1334 with isapnp=0, the following options are available:
1335
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 port - control port # for OPL3-SA chip (0x370)
1337 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1338 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1339 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1340 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1341 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1342 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1343 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001345 This module supports multiple cards and ISA PnP. It does not support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1347
1348 The power-management is supported.
1349
1350 Module snd-opti92x-ad1848
1351 -------------------------
1352
1353 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1354 Module works with OAK Mozart cards as well.
1355
Rene Herman64e0e2d2007-12-13 16:29:33 +01001356 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1357
1358 with isapnp=0, the following options are available:
1359
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1361 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1362 fm_port - port # for OPL3 device (0x388)
1363 irq - IRQ # for WSS chip (5,7,9,10,11)
1364 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1365 dma1 - first DMA # for WSS chip (0,1,3)
1366
1367 This module supports only one card, autoprobe and PnP.
1368
1369 Module snd-opti92x-cs4231
1370 -------------------------
1371
1372 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1373
Rene Herman64e0e2d2007-12-13 16:29:33 +01001374 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1375
1376 with isapnp=0, the following options are available:
1377
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1379 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1380 fm_port - port # for OPL3 device (0x388)
1381 irq - IRQ # for WSS chip (5,7,9,10,11)
1382 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1383 dma1 - first DMA # for WSS chip (0,1,3)
1384 dma2 - second DMA # for WSS chip (0,1,3)
1385
1386 This module supports only one card, autoprobe and PnP.
1387
1388 Module snd-opti93x
1389 ------------------
1390
1391 Module for sound cards based on OPTi 82c93x chips.
1392
Rene Herman64e0e2d2007-12-13 16:29:33 +01001393 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1394
1395 with isapnp=0, the following options are available:
1396
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1398 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1399 fm_port - port # for OPL3 device (0x388)
1400 irq - IRQ # for WSS chip (5,7,9,10,11)
1401 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1402 dma1 - first DMA # for WSS chip (0,1,3)
1403 dma2 - second DMA # for WSS chip (0,1,3)
1404
1405 This module supports only one card, autoprobe and PnP.
1406
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001407 Module snd-oxygen
1408 -----------------
1409
1410 Module for sound cards based on the C-Media CMI8788 chip:
1411 * Asound A-8788
1412 * AuzenTech X-Meridian
1413 * Bgears b-Enspirer
1414 * Club3D Theatron DTS
Clemens Ladischde04b102008-11-26 10:37:23 +01001415 * HT-Omega Claro (plus)
1416 * HT-Omega Claro halo (XT)
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001417 * Razer Barracuda AC-1
1418 * Sondigo Inferno
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001419
1420 This module supports autoprobe and multiple cards.
1421
Stas Sergeevd08cd582008-03-06 11:01:44 +01001422 Module snd-pcsp
1423 -----------------
1424
1425 Module for internal PC-Speaker.
1426
1427 nforce_wa - enable NForce chipset workaround. Expect bad sound.
1428
1429 This module supports system beeps, some kind of PCM playback and
1430 even a few mixer controls.
1431
Markus Bollingere12229b2005-12-06 13:55:26 +01001432 Module snd-pcxhr
1433 ----------------
1434
1435 Module for Digigram PCXHR boards
1436
1437 This module supports multiple cards.
1438
Matthias Koenig757e1192007-01-25 13:15:05 +01001439 Module snd-portman2x4
1440 ---------------------
1441
1442 Module for Midiman Portman 2x4 parallel port MIDI interface
1443
1444 This module supports multiple cards.
1445
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 Module snd-powermac (on ppc only)
1447 ---------------------------------
1448
1449 Module for PowerMac, iMac and iBook on-board soundchips
1450
1451 enable_beep - enable beep using PCM (enabled as default)
1452
1453 Module supports autoprobe a chip.
1454
1455 Note: the driver may have problems regarding endianess.
1456
1457 The power-management is supported.
1458
Takashi Iwai2c484df2005-06-30 18:54:04 +02001459 Module snd-pxa2xx-ac97 (on arm only)
1460 ------------------------------------
1461
1462 Module for AC97 driver for the Intel PXA2xx chip
1463
1464 For ARM architecture only.
1465
Takashi Iwaia4efc232005-11-17 17:24:26 +01001466 The power-management is supported.
1467
Peter Gruber109a9632006-03-27 13:10:28 +02001468 Module snd-riptide
1469 ------------------
1470
1471 Module for Conexant Riptide chip
1472
1473 joystick_port - Joystick port # (default: 0x200)
1474 mpu_port - MPU401 port # (default: 0x330)
1475 opl3_port - OPL3 port # (default: 0x388)
1476
1477 This module supports multiple cards.
1478 The driver requires the firmware loader support on kernel.
1479 You need to install the firmware file "riptide.hex" to the standard
1480 firmware path (e.g. /lib/firmware).
1481
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482 Module snd-rme32
1483 ----------------
1484
1485 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1486 Prodif96 and Prodif Gold) sound cards.
1487
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001488 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489
1490 Module snd-rme96
1491 ----------------
1492
1493 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1494
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001495 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496
1497 Module snd-rme9652
1498 ------------------
1499
1500 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1501
1502 precise_ptr - Enable precise pointer (doesn't work reliably).
1503 (default = 0)
1504
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001505 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506
1507 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1508 module did formerly. It will allocate the buffers in advance
1509 when any RME9652 cards are found. To make the buffer
1510 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +02001511 stage of boot sequence. See "Early Buffer Allocation"
1512 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513
1514 Module snd-sa11xx-uda1341 (on arm only)
1515 ---------------------------------------
1516
1517 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1518
1519 Module supports only one card.
1520 Module has no enable and index options.
1521
Takashi Iwaia4efc232005-11-17 17:24:26 +01001522 The power-management is supported.
1523
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 Module snd-sb8
1525 --------------
1526
1527 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1528 SoundBlaster 2.0,
1529 SoundBlaster Pro
1530
1531 port - port # for SB DSP chip (0x220,0x240,0x260)
1532 irq - IRQ # for SB DSP chip (5,7,9,10)
1533 dma8 - DMA # for SB DSP chip (1,3)
1534
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001535 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536
Takashi Iwaia4efc232005-11-17 17:24:26 +01001537 The power-management is supported.
1538
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539 Module snd-sb16 and snd-sbawe
1540 -----------------------------
1541
1542 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1543 SoundBlaster AWE 32 (PnP),
1544 SoundBlaster AWE 64 PnP
1545
Rene Herman64e0e2d2007-12-13 16:29:33 +01001546 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1547 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1548 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1549
1550 with isapnp=0, the following options are available:
1551
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1553 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1554 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1555 (snd-sbawe module only)
1556 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1557 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1558 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001560 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561
1562 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1563 disable 16bit DMA with dma16 = -1 module parameter.
1564 Also, all Sound Blaster 16 type cards can operate in 16-bit
1565 half duplex mode through 8-bit DMA channel by disabling their
1566 16-bit DMA channel.
1567
Takashi Iwaia4efc232005-11-17 17:24:26 +01001568 The power-management is supported.
1569
Takashi Iwai074a6e92007-09-11 22:10:14 +02001570 Module snd-sc6000
1571 -----------------
1572
Krzysztof Heltb0ec3a32009-05-03 10:39:19 +02001573 Module for Gallant SC-6000 soundcard and later models: SC-6600
1574 and SC-7000.
Takashi Iwai074a6e92007-09-11 22:10:14 +02001575
1576 port - Port # (0x220 or 0x240)
1577 mss_port - MSS Port # (0x530 or 0xe80)
1578 irq - IRQ # (5,7,9,10,11)
Krzysztof Helt7b758d22007-09-17 14:42:49 +02001579 mpu_irq - MPU-401 IRQ # (5,7,9,10) ,0 - no MPU-401 irq
Takashi Iwai074a6e92007-09-11 22:10:14 +02001580 dma - DMA # (1,3,0)
Krzysztof Heltb0ec3a32009-05-03 10:39:19 +02001581 joystick - Enable gameport - 0 = disable (default), 1 = enable
Takashi Iwai074a6e92007-09-11 22:10:14 +02001582
1583 This module supports multiple cards.
1584
1585 This card is also known as Audio Excel DSP 16 or Zoltrix AV302.
1586
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587 Module snd-sgalaxy
1588 ------------------
1589
1590 Module for Aztech Sound Galaxy sound card.
1591
1592 sbport - Port # for SB16 interface (0x220,0x240)
1593 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1594 irq - IRQ # (7,9,10,11)
1595 dma1 - DMA #
1596
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001597 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598
Takashi Iwaia4efc232005-11-17 17:24:26 +01001599 The power-management is supported.
1600
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 Module snd-sscape
1602 -----------------
1603
1604 Module for ENSONIQ SoundScape PnP cards.
1605
1606 port - Port # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001607 wss_port - WSS Port # (PnP setup)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 irq - IRQ # (PnP setup)
1609 mpu_irq - MPU-401 IRQ # (PnP setup)
1610 dma - DMA # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001611 dma2 - 2nd DMA # (PnP setup, -1 to disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001613 This module supports multiple cards. ISA PnP must be enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 You need sscape_ctl tool in alsa-tools package for loading
1615 the microcode.
1616
1617 Module snd-sun-amd7930 (on sparc only)
1618 --------------------------------------
1619
1620 Module for AMD7930 sound chips found on Sparcs.
1621
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001622 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623
1624 Module snd-sun-cs4231 (on sparc only)
1625 -------------------------------------
1626
1627 Module for CS4231 sound chips found on Sparcs.
1628
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001629 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001631 Module snd-sun-dbri (on sparc only)
1632 -----------------------------------
1633
1634 Module for DBRI sound chips found on Sparcs.
1635
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001636 This module supports multiple cards.
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001637
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 Module snd-wavefront
1639 --------------------
1640
1641 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1642
Rene Herman64e0e2d2007-12-13 16:29:33 +01001643 use_cs4232_midi - Use CS4232 MPU-401 interface
1644 (inaccessibly located inside your computer)
1645 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1646
1647 with isapnp=0, the following options are available:
1648
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 cs4232_pcm_port - Port # for CS4232 PCM interface.
1650 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1651 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1652 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 ics2115_port - Port # for ICS2115
1654 ics2115_irq - IRQ # for ICS2115
1655 fm_port - FM OPL-3 Port #
1656 dma1 - DMA1 # for CS4232 PCM interface.
1657 dma2 - DMA2 # for CS4232 PCM interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658
Takashi Iwaic2b12392007-08-21 15:20:26 +02001659 The below are options for wavefront_synth features:
1660 wf_raw - Assume that we need to boot the OS (default:no)
1661 If yes, then during driver loading, the state of the board is
1662 ignored, and we reset the board and load the firmware anyway.
1663 fx_raw - Assume that the FX process needs help (default:yes)
1664 If false, we'll leave the FX processor in whatever state it is
1665 when the driver is loaded. The default is to download the
1666 microprogram and associated coefficients to set it up for
1667 "default" operation, whatever that means.
1668 debug_default - Debug parameters for card initialization
1669 wait_usecs - How long to wait without sleeping, usecs
1670 (default:150)
1671 This magic number seems to give pretty optimal throughput
1672 based on my limited experimentation.
1673 If you want to play around with it and find a better value, be
1674 my guest. Remember, the idea is to get a number that causes us
1675 to just busy wait for as many WaveFront commands as possible,
1676 without coming up with a number so large that we hog the whole
1677 CPU.
1678 Specifically, with this number, out of about 134,000 status
1679 waits, only about 250 result in a sleep.
1680 sleep_interval - How long to sleep when waiting for reply
1681 (default: 100)
1682 sleep_tries - How many times to try sleeping during a wait
1683 (default: 50)
1684 ospath - Pathname to processed ICS2115 OS firmware
1685 (default:wavefront.os)
1686 The path name of the ISC2115 OS firmware. In the recent
1687 version, it's handled via firmware loader framework, so it
1688 must be installed in the proper path, typically,
1689 /lib/firmware.
1690 reset_time - How long to wait for a reset to take effect
1691 (default:2)
1692 ramcheck_time - How many seconds to wait for the RAM test
1693 (default:20)
1694 osrun_time - How many seconds to wait for the ICS2115 OS
1695 (default:10)
1696
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001697 This module supports multiple cards and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001698
Takashi Iwaic2b12392007-08-21 15:20:26 +02001699 Note: the firmware file "wavefront.os" was located in the earlier
1700 version in /etc. Now it's loaded via firmware loader, and
1701 must be in the proper firmware path, such as /lib/firmware.
1702 Copy (or symlink) the file appropriately if you get an error
1703 regarding firmware downloading after upgrading the kernel.
1704
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 Module snd-sonicvibes
1706 ---------------------
1707
1708 Module for S3 SonicVibes PCI sound cards.
1709 * PINE Schubert 32 PCI
1710
1711 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1712 - SoundCard must have onboard SRAM for this.
1713 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1714
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001715 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716
1717 Module snd-serial-u16550
1718 ------------------------
1719
1720 Module for UART16550A serial MIDI ports.
1721
1722 port - port # for UART16550A chip
1723 irq - IRQ # for UART16550A chip, -1 = poll mode
1724 speed - speed in bauds (9600,19200,38400,57600,115200)
1725 38400 = default
1726 base - base for divisor in bauds (57600,115200,230400,460800)
1727 115200 = default
1728 outs - number of MIDI ports in a serial port (1-4)
1729 1 = default
1730 adaptor - Type of adaptor.
1731 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1732 3 = MS-124W M/B, 4 = Generic
1733
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001734 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735 thus the main port must be specified!!! Other options are optional.
1736
1737 Module snd-trident
1738 ------------------
1739
1740 Module for Trident 4DWave DX/NX sound cards.
1741 * Best Union Miss Melody 4DWave PCI
1742 * HIS 4DWave PCI
1743 * Warpspeed ONSpeed 4DWave PCI
1744 * AzTech PCI 64-Q3D
1745 * Addonics SV 750
1746 * CHIC True Sound 4Dwave
1747 * Shark Predator4D-PCI
1748 * Jaton SonicWave 4D
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001749 * SiS SI7018 PCI Audio
1750 * Hoontech SoundTrack Digital 4DWave NX
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751
1752 pcm_channels - max channels (voices) reserved for PCM
1753 wavetable_size - max wavetable size in kB (4-?kb)
1754
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001755 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756
1757 The power-management is supported.
1758
1759 Module snd-usb-audio
1760 --------------------
1761
1762 Module for USB audio and USB MIDI devices.
1763
1764 vid - Vendor ID for the device (optional)
1765 pid - Product ID for the device (optional)
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001766 nrpacks - Max. number of packets per URB (default: 8)
1767 async_unlink - Use async unlink mode (default: yes)
Thibault LE MEURe3113342006-03-14 11:44:53 +01001768 device_setup - Device specific magic number (optional)
1769 - Influence depends on the device
1770 - Default: 0x0000
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001771 ignore_ctl_error - Ignore any USB-controller regarding mixer
1772 interface (default: no)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001774 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001776 NB: nrpacks parameter can be modified dynamically via sysfs.
1777 Don't put the value over 20. Changing via sysfs has no sanity
1778 check.
1779 NB: async_unlink=0 would cause Oops. It remains just for
1780 debugging purpose (if any).
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001781 NB: ignore_ctl_error=1 may help when you get an error at accessing
1782 the mixer element such as URB error -22. This happens on some
1783 buggy USB device or the controller.
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001784
Daniel Mack523f1dc2007-03-26 19:11:24 +02001785 Module snd-usb-caiaq
1786 --------------------
1787
1788 Module for caiaq UB audio interfaces,
1789 * Native Instruments RigKontrol2
1790 * Native Instruments Kore Controller
1791 * Native Instruments Audio Kontrol 1
1792 * Native Instruments Audio 8 DJ
1793
1794 This module supports multiple devices, autoprobe and hotplugging.
1795
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 Module snd-usb-usx2y
1797 --------------------
1798
1799 Module for Tascam USB US-122, US-224 and US-428 devices.
1800
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001801 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802
1803 Note: you need to load the firmware via usx2yloader utility included
1804 in alsa-tools and alsa-firmware packages.
1805
1806 Module snd-via82xx
1807 ------------------
1808
1809 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001810 8233A, 8233C, 8235, 8237 (south) bridge.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811
1812 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1813 [VIA686A/686B only]
1814 joystick - Enable joystick (default off) [VIA686A/686B only]
1815 ac97_clock - AC'97 codec clock base (default 48000Hz)
1816 dxs_support - support DXS channels,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001817 0 = auto (default), 1 = enable, 2 = disable,
1818 3 = 48k only, 4 = no VRA, 5 = enable any sample
1819 rate and different sample rates on different
1820 channels
1821 [VIA8233/C, 8235, 8237 only]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001823 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001825 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826
1827 Note: on some SMP motherboards like MSI 694D the interrupts might
1828 not be generated properly. In such a case, please try to
1829 set the SMP (or MPS) version on BIOS to 1.1 instead of
1830 default value 1.4. Then the interrupt number will be
1831 assigned under 15. You might also upgrade your BIOS.
1832
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001833 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 channels as the first PCM. On these channels, up to 4
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001835 streams can be played at the same time, and the controller
1836 can perform sample rate conversion with separate rates for
1837 each channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838 As default (dxs_support = 0), 48k fixed rate is chosen
1839 except for the known devices since the output is often
1840 noisy except for 48k on some mother boards due to the
1841 bug of BIOS.
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001842 Please try once dxs_support=5 and if it works on other
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1844 know the PCI subsystem vendor/device id's (output of
1845 "lspci -nv").
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001846 If dxs_support=5 does not work, try dxs_support=4; if it
1847 doesn't work too, try dxs_support=1. (dxs_support=1 is
Takashi Iwai62430082005-09-05 17:12:29 +02001848 usually for old motherboards. The correct implemented
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001849 board should work with 4 or 5.) If it still doesn't
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850 work and the default setting is ok, dxs_support=3 is the
1851 right choice. If the default setting doesn't work at all,
1852 try dxs_support=2 to disable the DXS channels.
1853 In any cases, please let us know the result and the
Takashi Iwai62430082005-09-05 17:12:29 +02001854 subsystem vendor/device ids. See "Links and Addresses"
1855 below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856
1857 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Takashi Iwai62430082005-09-05 17:12:29 +02001858 additionally. The mpu_port option is for VIA686 chips only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859
Takashi Iwaia4efc232005-11-17 17:24:26 +01001860 The power-management is supported.
1861
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 Module snd-via82xx-modem
1863 ------------------------
1864
1865 Module for VIA82xx AC97 modem
1866
1867 ac97_clock - AC'97 codec clock base (default 48000Hz)
1868
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001869 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870
1871 Note: The default index value of this module is -2, i.e. the first
1872 slot is excluded.
1873
Takashi Iwaia4efc232005-11-17 17:24:26 +01001874 The power-management is supported.
1875
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876 Module snd-virmidi
1877 ------------------
1878
1879 Module for virtual rawmidi devices.
1880 This module creates virtual rawmidi devices which communicate
1881 to the corresponding ALSA sequencer ports.
1882
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001883 midi_devs - MIDI devices # (1-4, default=4)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001885 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001887 Module snd-virtuoso
1888 -------------------
1889
Clemens Ladisch5430c722008-07-28 10:28:43 +02001890 Module for sound cards based on the Asus AV100/AV200 chips,
Clemens Ladisch04f98902009-05-25 10:11:29 +02001891 i.e., Xonar D1, DX, D2, D2X, HDAV1.3 (Deluxe), Essence ST
1892 (Deluxe) and Essence STX.
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001893
1894 This module supports autoprobe and multiple cards.
1895
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 Module snd-vx222
1897 ----------------
1898
1899 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1900
1901 mic - Enable Microphone on V222 Mic (NYI)
1902 ibl - Capture IBL size. (default = 0, minimum size)
1903
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001904 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905
1906 When the driver is compiled as a module and the hotplug firmware
1907 is supported, the firmware data is loaded via hotplug automatically.
1908 Install the necessary firmware files in alsa-firmware package.
1909 When no hotplug fw loader is available, you need to load the
1910 firmware via vxloader utility in alsa-tools package. To invoke
1911 vxloader automatically, add the following to /etc/modprobe.conf
1912
1913 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1914
1915 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1916 /etc/modules.conf, instead.)
1917 IBL size defines the interrupts period for PCM. The smaller size
1918 gives smaller latency but leads to more CPU consumption, too.
1919 The size is usually aligned to 126. As default (=0), the smallest
1920 size is chosen. The possible IBL values can be found in
1921 /proc/asound/cardX/vx-status proc file.
1922
Takashi Iwaia4efc232005-11-17 17:24:26 +01001923 The power-management is supported.
1924
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925 Module snd-vxpocket
1926 -------------------
1927
Takashi Iwai6d00a312005-06-30 13:40:51 +02001928 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929
1930 ibl - Capture IBL size. (default = 0, minimum size)
1931
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001932 This module supports multiple cards. The module is compiled only when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933 PCMCIA is supported on kernel.
1934
Takashi Iwai62430082005-09-05 17:12:29 +02001935 With the older 2.6.x kernel, to activate the driver via the card
1936 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1937 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1938 longer require a config file.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939
1940 When the driver is compiled as a module and the hotplug firmware
1941 is supported, the firmware data is loaded via hotplug automatically.
1942 Install the necessary firmware files in alsa-firmware package.
1943 When no hotplug fw loader is available, you need to load the
1944 firmware via vxloader utility in alsa-tools package.
1945
1946 About capture IBL, see the description of snd-vx222 module.
1947
Takashi Iwaied7cbe32006-05-11 11:30:10 +02001948 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
Takashi Iwai62430082005-09-05 17:12:29 +02001949 ALSA 1.0.10.
1950
Takashi Iwaia4efc232005-11-17 17:24:26 +01001951 The power-management is supported.
1952
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 Module snd-ymfpci
1954 -----------------
1955
1956 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1957
1958 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1959 1 (auto-detect for YMF744/754 only)
1960 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1961 1 (auto-detect for YMF744/754 only)
1962 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1963 1 (auto-detect)
1964 rear_switch - enable shared rear/line-in switch (bool)
1965
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001966 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967
1968 The power-management is supported.
1969
1970 Module snd-pdaudiocf
1971 --------------------
1972
1973 Module for Sound Core PDAudioCF sound card.
1974
Takashi Iwaia4efc232005-11-17 17:24:26 +01001975 The power-management is supported.
1976
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977
Takashi Iwai62430082005-09-05 17:12:29 +02001978AC97 Quirk Option
1979=================
1980
1981The ac97_quirk option is used to enable/override the workaround for
1982specific devices on drivers for on-board AC'97 controllers like
1983snd-intel8x0. Some hardware have swapped output pins between Master
1984and Headphone, or Surround (thanks to confusion of AC'97
1985specifications from version to version :-)
1986
1987The driver provides the auto-detection of known problematic devices,
1988but some might be unknown or wrongly detected. In such a case, pass
1989the proper value with this option.
1990
1991The following strings are accepted:
1992 - default Don't override the default setting
Takashi Iwai10e4097f2005-11-17 11:04:55 +01001993 - none Disable the quirk
Takashi Iwai62430082005-09-05 17:12:29 +02001994 - hp_only Bind Master and Headphone controls as a single control
1995 - swap_hp Swap headphone and master controls
1996 - swap_surround Swap master and surround controls
1997 - ad_sharing For AD1985, turn on OMS bit and use headphone
1998 - alc_jack For ALC65x, turn on the jack sense mode
1999 - inv_eapd Inverted EAPD implementation
2000 - mute_led Bind EAPD bit for turning on/off mute LED
2001
2002For backward compatibility, the corresponding integer value -1, 0,
2003... are accepted, too.
2004
2005For example, if "Master" volume control has no effect on your device
2006but only "Headphone" does, pass ac97_quirk=hp_only module option.
2007
2008
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009Configuring Non-ISAPNP Cards
2010============================
2011
2012When the kernel is configured with ISA-PnP support, the modules
2013supporting the isapnp cards will have module options "isapnp".
2014If this option is set, *only* the ISA-PnP devices will be probed.
2015For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
2016together with the proper i/o and irq configuration.
2017
2018When the kernel is configured without ISA-PnP support, isapnp option
2019will be not built in.
2020
2021
2022Module Autoloading Support
2023==========================
2024
2025The ALSA drivers can be loaded automatically on demand by defining
2026module aliases. The string 'snd-card-%1' is requested for ALSA native
2027devices where %i is sound card number from zero to seven.
2028
2029To auto-load an ALSA driver for OSS services, define the string
2030'sound-slot-%i' where %i means the slot number for OSS, which
2031corresponds to the card index of ALSA. Usually, define this
Tobias Klauserd533f672005-09-10 00:26:46 -07002032as the same card module.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033
2034An example configuration for a single emu10k1 card is like below:
2035----- /etc/modprobe.conf
2036alias snd-card-0 snd-emu10k1
2037alias sound-slot-0 snd-emu10k1
2038----- /etc/modprobe.conf
2039
2040The available number of auto-loaded sound cards depends on the module
2041option "cards_limit" of snd module. As default it's set to 1.
2042To enable the auto-loading of multiple cards, specify the number of
2043sound cards in that option.
2044
2045When multiple cards are available, it'd better to specify the index
2046number for each card via module option, too, so that the order of
2047cards is kept consistent.
2048
2049An example configuration for two sound cards is like below:
2050
2051----- /etc/modprobe.conf
2052# ALSA portion
2053options snd cards_limit=2
2054alias snd-card-0 snd-interwave
2055alias snd-card-1 snd-ens1371
2056options snd-interwave index=0
2057options snd-ens1371 index=1
2058# OSS/Free portion
2059alias sound-slot-0 snd-interwave
2060alias sound-slot-1 snd-ens1371
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02002061----- /etc/modprobe.conf
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062
2063In this example, the interwave card is always loaded as the first card
2064(index 0) and ens1371 as the second (index 1).
2065
Takashi Iwai304cd072007-10-26 15:10:15 +02002066Alternative (and new) way to fixate the slot assignment is to use
2067"slots" option of snd module. In the case above, specify like the
2068following:
2069
2070options snd slots=snd-interwave,snd-ens1371
2071
2072Then, the first slot (#0) is reserved for snd-interwave driver, and
2073the second (#1) for snd-ens1371. You can omit index option in each
2074driver if slots option is used (although you can still have them at
2075the same time as long as they don't conflict).
2076
2077The slots option is especially useful for avoiding the possible
2078hot-plugging and the resultant slot conflict. For example, in the
2079case above again, the first two slots are already reserved. If any
2080other driver (e.g. snd-usb-audio) is loaded before snd-interwave or
2081snd-ens1371, it will be assigned to the third or later slot.
2082
Takashi Iwaia93bbaa2008-05-27 17:59:24 +02002083When a module name is given with '!', the slot will be given for any
2084modules but that name. For example, "slots=!snd-pcsp" will reserve
2085the first slot for any modules but snd-pcsp.
2086
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087
2088ALSA PCM devices to OSS devices mapping
2089=======================================
2090
2091/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
2092/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
2093/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
2094/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
2095/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
2096/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
2097/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
2098/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
2099/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
2100
2101The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
2102sound card number and second means device number. The ALSA devices
2103have either 'c' or 'p' suffix indicating the direction, capture and
2104playback, respectively.
2105
2106Please note that the device mapping above may be varied via the module
2107options of snd-pcm-oss module.
2108
2109
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110Proc interfaces (/proc/asound)
2111==============================
2112
2113/proc/asound/card#/pcm#[cp]/oss
2114-------------------------------
2115 String "erase" - erase all additional informations about OSS applications
2116 String "<app_name> <fragments> <fragment_size> [<options>]"
2117
2118 <app_name> - name of application with (higher priority) or without path
2119 <fragments> - number of fragments or zero if auto
2120 <fragment_size> - size of fragment in bytes or zero if auto
2121 <options> - optional parameters
2122 - disable the application tries to open a pcm device for
2123 this channel but does not want to use it.
2124 (Cause a bug or mmap needs)
2125 It's good for Quake etc...
2126 - direct don't use plugins
2127 - block force block mode (rvplayer)
2128 - non-block force non-block mode
2129 - whole-frag write only whole fragments (optimization affecting
2130 playback only)
2131 - no-silence do not fill silence ahead to avoid clicks
Takashi Iwai10f69f92005-09-08 13:48:34 +02002132 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
2133 instead of filled blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134
2135 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
2136 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
2137 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
2138
2139
Takashi Iwaib6a96912005-05-30 18:27:03 +02002140Early Buffer Allocation
2141=======================
2142
2143Some drivers (e.g. hdsp) require the large contiguous buffers, and
2144sometimes it's too late to find such spaces when the driver module is
2145actually loaded due to memory fragmentation. You can pre-allocate the
2146PCM buffers by loading snd-page-alloc module and write commands to its
2147proc file in prior, for example, in the early boot stage like
2148/etc/init.d/*.local scripts.
2149
2150Reading the proc file /proc/drivers/snd-page-alloc shows the current
2151usage of page allocation. In writing, you can send the following
2152commands to the snd-page-alloc driver:
2153
2154 - add VENDOR DEVICE MASK SIZE BUFFERS
2155
2156 VENDOR and DEVICE are PCI vendor and device IDs. They take
2157 integer numbers (0x prefix is needed for the hex).
2158 MASK is the PCI DMA mask. Pass 0 if not restricted.
2159 SIZE is the size of each buffer to allocate. You can pass
2160 k and m suffix for KB and MB. The max number is 16MB.
2161 BUFFERS is the number of buffers to allocate. It must be greater
2162 than 0. The max number is 4.
2163
2164 - erase
2165
2166 This will erase the all pre-allocated buffers which are not in
2167 use.
2168
2169
Takashi Iwai62430082005-09-05 17:12:29 +02002170Links and Addresses
2171===================
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172
2173 ALSA project homepage
2174 http://www.alsa-project.org
2175
Takashi Iwai30bc4482008-12-09 08:23:45 +01002176 Kernel Bugzilla
2177 http://bugzilla.kernel.org/
Takashi Iwai62430082005-09-05 17:12:29 +02002178
2179 ALSA Developers ML
Rene Herman45051792007-03-21 12:05:06 +01002180 mailto:alsa-devel@alsa-project.org
Takashi Iwai30bc4482008-12-09 08:23:45 +01002181
2182 alsa-info.sh script
2183 http://www.alsa-project.org/alsa-info.sh