blob: a763b76afe5148c35a5a787af503ec3bf55a440c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001
2 Advanced Linux Sound Architecture - Driver
3 ==========================================
4 Configuration guide
5
6
7Kernel Configuration
8====================
9
10To enable ALSA support you need at least to build the kernel with
11primary sound card support (CONFIG_SOUND). Since ALSA can emulate OSS,
12you don't have to choose any of the OSS modules.
13
14Enable "OSS API emulation" (CONFIG_SND_OSSEMUL) and both OSS mixer and
15PCM supports if you want to run OSS applications with ALSA.
16
17If you want to support the WaveTable functionality on cards such as
18SB Live! then you need to enable "Sequencer support"
19(CONFIG_SND_SEQUENCER).
20
21To make ALSA debug messages more verbose, enable the "Verbose printk"
22and "Debug" options. To check for memory leaks, turn on "Debug memory"
23too. "Debug detection" will add checks for the detection of cards.
24
25Please note that all the ALSA ISA drivers support the Linux isapnp API
26(if the card supports ISA PnP). You don't need to configure the cards
27using isapnptools.
28
29
30Creating ALSA devices
31=====================
32
33This depends on your distribution, but normally you use the /dev/MAKEDEV
34script to create the necessary device nodes. On some systems you use a
35script named 'snddevices'.
36
37
38Module parameters
39=================
40
41The user can load modules with options. If the module supports more than
42one card and you have more than one card of the same type then you can
43specify multiple values for the option separated by commas.
44
45Prior to version 0.9.0rc4 options had a 'snd_' prefix. This was removed.
46
47 Module snd
48 ----------
49
50 The core ALSA module. It is used by all ALSA card drivers.
51 It takes the following options which have global effects.
52
53 major - major number for sound driver
54 - Default: 116
55 cards_limit
56 - limiting card index for auto-loading (1-8)
57 - Default: 1
58 - For auto-loading more than one card, specify this
59 option together with snd-card-X aliases.
Takashi Iwai304cd072007-10-26 15:10:15 +020060 slots - Reserve the slot index for the given driver.
61 This option takes multiple strings.
62 See "Module Autoloading Support" section for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
64 Module snd-pcm-oss
65 ------------------
66
67 The PCM OSS emulation module.
68 This module takes options which change the mapping of devices.
69
70 dsp_map - PCM device number maps assigned to the 1st OSS device.
71 - Default: 0
72 adsp_map - PCM device number maps assigned to the 2st OSS device.
73 - Default: 1
74 nonblock_open
Takashi Iwai62430082005-09-05 17:12:29 +020075 - Don't block opening busy PCM devices. Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77 For example, when dsp_map=2, /dev/dsp will be mapped to PCM #2 of
78 the card #0. Similarly, when adsp_map=0, /dev/adsp will be mapped
79 to PCM #0 of the card #0.
80 For changing the second or later card, specify the option with
81 commas, such like "dsp_map=0,1".
82
83 nonblock_open option is used to change the behavior of the PCM
84 regarding opening the device. When this option is non-zero,
85 opening a busy OSS PCM device won't be blocked but return
86 immediately with EAGAIN (just like O_NONBLOCK flag).
87
88 Module snd-rawmidi
89 ------------------
90
91 This module takes options which change the mapping of devices.
92 similar to those of the snd-pcm-oss module.
93
94 midi_map - MIDI device number maps assigned to the 1st OSS device.
95 - Default: 0
96 amidi_map - MIDI device number maps assigned to the 2st OSS device.
97 - Default: 1
98
99 Common parameters for top sound card modules
100 --------------------------------------------
101
102 Each of top level sound card module takes the following options.
103
104 index - index (slot #) of sound card
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100105 - Values: 0 through 31 or negative
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 - If nonnegative, assign that index number
107 - if negative, interpret as a bitmask of permissible
108 indices; the first free permitted index is assigned
109 - Default: -1
110 id - card ID (identifier or name)
111 - Can be up to 15 characters long
112 - Default: the card type
113 - A directory by this name is created under /proc/asound/
114 containing information about the card
115 - This ID can be used instead of the index number in
116 identifying the card
117 enable - enable card
118 - Default: enabled, for PCI and ISA PnP cards
119
Rene Hermancf40a312006-03-28 12:38:20 +0200120 Module snd-adlib
121 ----------------
122
123 Module for AdLib FM cards.
124
125 port - port # for OPL chip
126
127 This module supports multiple cards. It does not support autoprobe, so
128 the port must be specified. For actual AdLib FM cards it will be 0x388.
129 Note that this card does not have PCM support and no mixer; only FM
130 synthesis.
131
132 Make sure you have "sbiload" from the alsa-tools package available and,
133 after loading the module, find out the assigned ALSA sequencer port
134 number through "sbiload -l". Example output:
135
136 Port Client name Port name
137 64:0 OPL2 FM synth OPL2 FM Port
138
139 Load the std.sb and drums.sb patches also supplied by sbiload:
140
141 sbiload -p 64:0 std.sb drums.sb
142
143 If you use this driver to drive an OPL3, you can use std.o3 and drums.o3
144 instead. To have the card produce sound, use aplaymidi from alsa-utils:
145
146 aplaymidi -p 64:0 foo.mid
147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 Module snd-ad1816a
149 ------------------
150
151 Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips.
152
Takashi Iwai506d4c62005-08-03 14:02:47 +0200153 clockfreq - Clock frequency for AD1816A chip (default = 0, 33000Hz)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100155 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
157 Module snd-ad1848
158 -----------------
159
160 Module for sound cards based on AD1848/AD1847/CS4248 ISA chips.
161
162 port - port # for AD1848 chip
163 irq - IRQ # for AD1848 chip
164 dma1 - DMA # for AD1848 chip (0,1,3)
165
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100166 This module supports multiple cards. It does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 thus main port must be specified!!! Other ports are optional.
168
Takashi Iwaia4efc232005-11-17 17:24:26 +0100169 The power-management is supported.
170
Clemens Ladisch84010e62005-09-02 07:57:59 +0200171 Module snd-ad1889
172 -----------------
173
174 Module for Analog Devices AD1889 chips.
175
176 ac97_quirk - AC'97 workaround for strange hardware
177 See the description of intel8x0 module for details.
178
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100179 This module supports multiple cards.
Clemens Ladisch84010e62005-09-02 07:57:59 +0200180
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 Module snd-ali5451
182 ------------------
183
184 Module for ALi M5451 PCI chip.
185
186 pcm_channels - Number of hardware channels assigned for PCM
187 spdif - Support SPDIF I/O
188 - Default: disabled
189
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +0200190 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
192 The power-management is supported.
193
194 Module snd-als100
195 -----------------
196
197 Module for sound cards based on Avance Logic ALS100/ALS120 ISA chips.
198
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100199 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Takashi Iwaia4efc232005-11-17 17:24:26 +0100201 The power-management is supported.
202
Ash Willisb3a70d52006-03-27 13:20:40 +0200203 Module snd-als300
204 -----------------
205
206 Module for Avance Logic ALS300 and ALS300+
207
208 This module supports multiple cards.
209
210 The power-management is supported.
211
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 Module snd-als4000
213 ------------------
214
215 Module for sound cards based on Avance Logic ALS4000 PCI chip.
216
217 joystick_port - port # for legacy joystick support.
218 0 = disabled (default), 1 = auto-detect
219
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100220 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Takashi Iwaia4efc232005-11-17 17:24:26 +0100222 The power-management is supported.
223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 Module snd-atiixp
225 -----------------
226
Takashi Iwai62430082005-09-05 17:12:29 +0200227 Module for ATI IXP 150/200/250/400 AC97 controllers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Takashi Iwai62430082005-09-05 17:12:29 +0200229 ac97_clock - AC'97 clock (default = 48000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200231 See "AC97 Quirk Option" section below.
Dan Carpenter14e1d352006-11-20 16:35:18 +0100232 ac97_codec - Workaround to specify which AC'97 codec
233 instead of probing. If this works for you
234 file a bug with your `lspci -vn` output.
235 -2 -- Force probing.
236 -1 -- Default behavior.
237 0-2 -- Use the specified codec.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 spdif_aclink - S/PDIF transfer over AC-link (default = 1)
239
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200240 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
Takashi Iwai62430082005-09-05 17:12:29 +0200242 ATI IXP has two different methods to control SPDIF output. One is
243 over AC-link and another is over the "direct" SPDIF output. The
244 implementation depends on the motherboard, and you'll need to
245 choose the correct one via spdif_aclink module option.
246
Takashi Iwaia4efc232005-11-17 17:24:26 +0100247 The power-management is supported.
248
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 Module snd-atiixp-modem
250 -----------------------
251
252 Module for ATI IXP 150/200/250 AC97 modem controllers.
253
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200254 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
256 Note: The default index value of this module is -2, i.e. the first
257 slot is excluded.
258
Takashi Iwaia4efc232005-11-17 17:24:26 +0100259 The power-management is supported.
260
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 Module snd-au8810, snd-au8820, snd-au8830
262 -----------------------------------------
263
264 Module for Aureal Vortex, Vortex2 and Advantage device.
265
266 pcifix - Control PCI workarounds
267 0 = Disable all workarounds
268 1 = Force the PCI latency of the Aureal card to 0xff
269 2 = Force the Extend PCI#2 Internal Master for Efficient
270 Handling of Dummy Requests on the VIA KT133 AGP Bridge
271 3 = Force both settings
272 255 = Autodetect what is required (default)
273
274 This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
275 EQ, mpu401, gameport. A3D and wavetable support are still in development.
276 Development and reverse engineering work is being coordinated at
277 http://savannah.nongnu.org/projects/openvortex/
278 SPDIF output has a copy of the AC97 codec output, unless you use the
279 "spdif" pcm device, which allows raw data passthru.
280 The hardware EQ hardware and SPDIF is only present in the Vortex2 and
281 Advantage.
282
Takashi Iwai62430082005-09-05 17:12:29 +0200283 Note: Some ALSA mixer applications don't handle the SPDIF sample rate
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 control correctly. If you have problems regarding this, try
285 another ALSA compliant mixer (alsamixer works).
286
Takashi Iwai9e235322008-02-20 12:13:29 +0100287 Module snd-aw2
288 --------------
289
290 Module for Audiowerk2 sound card
291
292 This module supports multiple cards.
293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 Module snd-azt2320
295 ------------------
296
297 Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
298
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100299 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
Takashi Iwaia4efc232005-11-17 17:24:26 +0100301 The power-management is supported.
302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 Module snd-azt3328
304 ------------------
305
306 Module for sound cards based on Aztech AZF3328 PCI chip.
307
308 joystick - Enable joystick (default off)
309
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100310 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
312 Module snd-bt87x
313 ----------------
314
315 Module for video cards based on Bt87x chips.
316
317 digital_rate - Override the default digital rate (Hz)
318 load_all - Load the driver even if the card model isn't known
319
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100320 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
322 Note: The default index value of this module is -2, i.e. the first
323 slot is excluded.
324
325 Module snd-ca0106
326 -----------------
327
328 Module for Creative Audigy LS and SB Live 24bit
329
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100330 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
332
333 Module snd-cmi8330
334 ------------------
335
336 Module for sound cards based on C-Media CMI8330 ISA chips.
337
Rene Herman64e0e2d2007-12-13 16:29:33 +0100338 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
339
340 with isapnp=0, the following options are available:
341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 wssport - port # for CMI8330 chip (WSS)
343 wssirq - IRQ # for CMI8330 chip (WSS)
344 wssdma - first DMA # for CMI8330 chip (WSS)
345 sbport - port # for CMI8330 chip (SB16)
346 sbirq - IRQ # for CMI8330 chip (SB16)
347 sbdma8 - 8bit DMA # for CMI8330 chip (SB16)
348 sbdma16 - 16bit DMA # for CMI8330 chip (SB16)
Takashi Iwai9e128fd2009-01-29 11:49:10 +0100349 fmport - (optional) OPL3 I/O port
350 mpuport - (optional) MPU401 I/O port
351 mpuirq - (optional) MPU401 irq #
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100353 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
Takashi Iwaia4efc232005-11-17 17:24:26 +0100355 The power-management is supported.
356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 Module snd-cmipci
358 -----------------
359
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200360 Module for C-Media CMI8338/8738/8768/8770 PCI sound cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
Clemens Ladischc78c9502007-09-03 09:55:49 +0200362 mpu_port - port address of MIDI interface (8338 only):
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200363 0x300,0x310,0x320,0x330 = legacy port,
Takashi Iwaicab5c4c2006-05-04 14:36:08 +0200364 0 = disable (default)
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200365 fm_port - port address of OPL-3 FM synthesizer (8x38 only):
366 0x388 = legacy port,
367 1 = integrated PCI port (default on 8738),
Takashi Iwai2f24d152007-02-15 18:56:43 +0100368 0 = disable
Takashi Iwai62430082005-09-05 17:12:29 +0200369 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 (default = 1)
371 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
372
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100373 This module supports autoprobe and multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
Takashi Iwaia4efc232005-11-17 17:24:26 +0100375 The power-management is supported.
376
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 Module snd-cs4231
378 -----------------
379
380 Module for sound cards based on CS4231 ISA chips.
381
382 port - port # for CS4231 chip
383 mpu_port - port # for MPU-401 UART (optional), -1 = disable
384 irq - IRQ # for CS4231 chip
385 mpu_irq - IRQ # for MPU-401 UART
386 dma1 - first DMA # for CS4231 chip
387 dma2 - second DMA # for CS4231 chip
388
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100389 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 thus main port must be specified!!! Other ports are optional.
391
392 The power-management is supported.
393
394 Module snd-cs4232
395 -----------------
396
397 Module for sound cards based on CS4232/CS4232A ISA chips.
398
Rene Herman64e0e2d2007-12-13 16:29:33 +0100399 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
400
401 with isapnp=0, the following options are available:
402
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 port - port # for CS4232 chip (PnP setup - 0x534)
404 cport - control port # for CS4232 chip (PnP setup - 0x120,0x210,0xf00)
405 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
406 fm_port - FM port # for CS4232 chip (PnP setup - 0x388), -1 = disable
407 irq - IRQ # for CS4232 chip (5,7,9,11,12,15)
408 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
409 dma1 - first DMA # for CS4232 chip (0,1,3)
410 dma2 - second DMA # for Yamaha CS4232 chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100412 This module supports multiple cards. This module does not support autoprobe
Rene Herman64e0e2d2007-12-13 16:29:33 +0100413 (if ISA PnP is not used) thus main port must be specified!!! Other ports are
414 optional.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
416 The power-management is supported.
417
418 Module snd-cs4236
419 -----------------
420
421 Module for sound cards based on CS4235/CS4236/CS4236B/CS4237B/
422 CS4238B/CS4239 ISA chips.
423
Rene Herman64e0e2d2007-12-13 16:29:33 +0100424 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
425
426 with isapnp=0, the following options are available:
427
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 port - port # for CS4236 chip (PnP setup - 0x534)
429 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
430 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
431 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
432 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
433 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
434 dma1 - first DMA # for CS4236 chip (0,1,3)
435 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100437 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 (if ISA PnP is not used) thus main port and control port must be
439 specified!!! Other ports are optional.
440
441 The power-management is supported.
442
443 Module snd-cs4281
444 -----------------
445
446 Module for Cirrus Logic CS4281 soundchip.
447
448 dual_codec - Secondary codec ID (0 = disable, default)
449
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100450 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
452 The power-management is supported.
453
454 Module snd-cs46xx
455 -----------------
456
457 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
458 CS4624/CS4630/CS4280 PCI chips.
459
Takashi Iwai62430082005-09-05 17:12:29 +0200460 external_amp - Force to enable external amplifier.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 thinkpad - Force to enable Thinkpad's CLKRUN control.
462 mmap_valid - Support OSS mmap mode (default = 0).
463
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100464 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 Usually external amp and CLKRUN controls are detected automatically
466 from PCI sub vendor/device ids. If they don't work, give the options
467 above explicitly.
468
469 The power-management is supported.
Takashi Iwai621887a2007-05-24 18:46:54 +0200470
471 Module snd-cs5530
472 _________________
473
474 Module for Cyrix/NatSemi Geode 5530 chip.
475
Takashi Iwai3e873172005-11-17 10:15:37 +0100476 Module snd-cs5535audio
477 ----------------------
478
479 Module for multifunction CS5535 companion PCI device
480
Takashi Iwaic00bd742006-05-19 19:22:34 +0200481 The power-management is supported.
Takashi Iwai3e873172005-11-17 10:15:37 +0100482
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200483 Module snd-darla20
484 ------------------
485
486 Module for Echoaudio Darla20
487
488 This module supports multiple cards.
489 The driver requires the firmware loader support on kernel.
490
491 Module snd-darla24
492 ------------------
493
494 Module for Echoaudio Darla24
495
496 This module supports multiple cards.
497 The driver requires the firmware loader support on kernel.
498
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 Module snd-dt019x
500 -----------------
501
502 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
503 only)
504
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100505 This module supports multiple cards. This module is enabled only with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 ISA PnP support.
507
Takashi Iwaia4efc232005-11-17 17:24:26 +0100508 The power-management is supported.
509
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 Module snd-dummy
511 ----------------
512
513 Module for the dummy sound card. This "card" doesn't do any output
514 or input, but you may use this module for any application which
515 requires a sound card (like RealPlayer).
516
Takashi Iwaia4efc232005-11-17 17:24:26 +0100517 The power-management is supported.
518
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200519 Module snd-echo3g
520 -----------------
521
522 Module for Echoaudio 3G cards (Gina3G/Layla3G)
523
524 This module supports multiple cards.
525 The driver requires the firmware loader support on kernel.
526
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 Module snd-emu10k1
528 ------------------
529
530 Module for EMU10K1/EMU10k2 based PCI sound cards.
531 * Sound Blaster Live!
532 * Sound Blaster PCI 512
533 * Emu APS (partially supported)
534 * Sound Blaster Audigy
535
536 extin - bitmap of available external inputs for FX8010 (see bellow)
537 extout - bitmap of available external outputs for FX8010 (see bellow)
538 seq_ports - allocated sequencer ports (4 by default)
539 max_synth_voices - limit of voices used for wavetable (64 by default)
540 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
541 given in MB unit. Default value is 128.
542 enable_ir - enable IR
543
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100544 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
546 Input & Output configurations [extin/extout]
547 * Creative Card wo/Digital out [0x0003/0x1f03]
548 * Creative Card w/Digital out [0x0003/0x1f0f]
549 * Creative Card w/Digital CD in [0x000f/0x1f0f]
550 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
551 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
552 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
553 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
554 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
555 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
556 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
557 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
558 * Creative Card all ins and outs [0x3fff/0x7fff]
559
Takashi Iwaia4efc232005-11-17 17:24:26 +0100560 The power-management is supported.
561
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 Module snd-emu10k1x
563 -------------------
564
565 Module for Creative Emu10k1X (SB Live Dell OEM version)
566
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100567 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568
569 Module snd-ens1370
570 ------------------
571
572 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
573 * SoundBlaster PCI 64
574 * SoundBlaster PCI 128
575
576 joystick - Enable joystick (default off)
577
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100578 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100580 The power-management is supported.
581
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 Module snd-ens1371
583 ------------------
584
585 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
586 * SoundBlaster PCI 64
587 * SoundBlaster PCI 128
588 * SoundBlaster Vibra PCI
589
590 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
591 0 = disable (default), 1 = auto-detect
592
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100593 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100595 The power-management is supported.
596
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 Module snd-es968
598 ----------------
599
600 Module for sound cards based on ESS ES968 chip (PnP only).
601
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100602 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
Takashi Iwaia4efc232005-11-17 17:24:26 +0100604 The power-management is supported.
605
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 Module snd-es1688
607 -----------------
608
609 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
610
611 port - port # for ES-1688 chip (0x220,0x240,0x260)
Takashi Iwai504a06d2009-01-30 19:59:10 +0100612 fm_port - port # for OPL3 (option; share the same port as default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
614 irq - IRQ # for ES-1688 chip (5,7,9,10)
615 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
616 dma8 - DMA # for ES-1688 chip (0,1,3)
617
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100618 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
620 Module snd-es18xx
621 -----------------
622
623 Module for ESS AudioDrive ES-18xx sound cards.
624
Rene Herman64e0e2d2007-12-13 16:29:33 +0100625 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
626
627 with isapnp=0, the following options are available:
628
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 port - port # for ES-18xx chip (0x220,0x240,0x260)
630 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
631 fm_port - port # for FM (optional, not used)
632 irq - IRQ # for ES-18xx chip (5,7,9,10)
633 dma1 - first DMA # for ES-18xx chip (0,1,3)
634 dma2 - first DMA # for ES-18xx chip (0,1,3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100636 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
637 port if native ISA PnP routines are not used).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 When dma2 is equal with dma1, the driver works as half-duplex.
639
640 The power-management is supported.
641
642 Module snd-es1938
643 -----------------
644
645 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
646
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100647 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648
Takashi Iwaia4efc232005-11-17 17:24:26 +0100649 The power-management is supported.
650
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 Module snd-es1968
652 -----------------
653
654 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
655
656 total_bufsize - total buffer size in kB (1-4096kB)
657 pcm_substreams_p - playback channels (1-8, default=2)
658 pcm_substreams_c - capture channels (1-8, default=0)
659 clock - clock (0 = auto-detection)
660 use_pm - support the power-management (0 = off, 1 = on,
661 2 = auto (default))
662 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
663 joystick - enable joystick (default off)
664
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100665 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666
667 The power-management is supported.
668
669 Module snd-fm801
670 ----------------
671
672 Module for ForteMedia FM801 based PCI sound cards.
673
674 tea575x_tuner - Enable TEA575x tuner
675 - 1 = MediaForte 256-PCS
676 - 2 = MediaForte 256-PCPR
677 - 3 = MediaForte 64-PCR
678 - High 16-bits are video (radio) device number + 1
679 - example: 0x10002 (MediaForte 256-PCPR, device 1)
680
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100681 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
Takashi Iwaia4efc232005-11-17 17:24:26 +0100683 The power-management is supported.
684
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200685 Module snd-gina20
686 -----------------
687
688 Module for Echoaudio Gina20
689
690 This module supports multiple cards.
691 The driver requires the firmware loader support on kernel.
692
693 Module snd-gina24
694 -----------------
695
696 Module for Echoaudio Gina24
697
698 This module supports multiple cards.
699 The driver requires the firmware loader support on kernel.
700
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 Module snd-gusclassic
702 ---------------------
703
704 Module for Gravis UltraSound Classic sound card.
705
706 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
707 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
708 dma1 - DMA # for GF1 chip (1,3,5,6,7)
709 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
710 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
711 voices - GF1 voices limit (14-32)
712 pcm_voices - reserved PCM voices
713
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100714 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
716 Module snd-gusextreme
717 ---------------------
718
719 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
720
721 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
722 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
723 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
724 irq - IRQ # for ES-1688 chip (5,7,9,10)
725 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
726 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
727 dma8 - DMA # for ES-1688 chip (0,1,3)
728 dma1 - DMA # for GF1 chip (1,3,5,6,7)
729 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
730 voices - GF1 voices limit (14-32)
731 pcm_voices - reserved PCM voices
732
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100733 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734
735 Module snd-gusmax
736 -----------------
737
738 Module for Gravis UltraSound MAX sound card.
739
740 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
741 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
742 dma1 - DMA # for GF1 chip (1,3,5,6,7)
743 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
744 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
745 voices - GF1 voices limit (14-32)
746 pcm_voices - reserved PCM voices
747
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100748 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
750 Module snd-hda-intel
751 --------------------
752
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400753 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8, ICH9, ICH10,
754 PCH, SCH),
755 ATI SB450, SB600, R600, RS600, RS690, RS780, RV610, RV620,
756 RV630, RV635, RV670, RV770,
Takashi Iwai9b878192006-05-17 11:26:39 +0200757 VIA VT8251/VT8237A,
758 SIS966, ULI M5461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100760 [Multiple options for each card instance]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 model - force the model name
Takashi Iwaid2e1c972008-06-10 17:53:34 +0200762 position_fix - Fix DMA pointer (0 = auto, 1 = use LPIB, 2 = POSBUF)
Takashi Iwai95904742007-05-19 17:06:42 +0200763 probe_mask - Bitmask to probe codecs (default = -1, meaning all slots)
Takashi Iwaid4d9cd032008-12-19 15:19:11 +0100764 probe_only - Only probing and no codec initialization (default=off);
765 Useful to check the initial codec status for debugging
Takashi Iwai8c53b962008-06-10 17:53:35 +0200766 bdl_pos_adj - Specifies the DMA IRQ timing delay in samples.
767 Passing -1 will make the driver to choose the appropriate
768 value based on the controller chip.
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100769
770 [Single (global) options]
Takashi Iwai27346162006-01-12 18:28:44 +0100771 single_cmd - Use single immediate commands to communicate with
772 codecs (for debugging only)
Takashi Iwai134a11f2006-11-10 12:08:37 +0100773 enable_msi - Enable Message Signaled Interrupt (MSI) (default = off)
Takashi Iwaidee1b662007-08-13 16:10:30 +0200774 power_save - Automatic power-saving timtout (in second, 0 =
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200775 disable)
Takashi Iwaidee1b662007-08-13 16:10:30 +0200776 power_save_controller - Reset HD-audio controller in power-saving mode
777 (default = on)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100779 This module supports multiple cards and autoprobe.
780
Takashi Iwaicae51172008-12-19 08:36:53 +0100781 See Documentation/sound/alsa/HD-Audio.txt for more details about
782 HD-audio driver.
783
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 Each codec may have a model table for different configurations.
785 If your machine isn't listed there, the default (usually minimal)
786 configuration is set up. You can pass "model=<name>" option to
787 specify a certain model in such a case. There are different
Takashi Iwaicae51172008-12-19 08:36:53 +0100788 models depending on the codec chip. The list of available models
789 is found in HD-Audio-Models.txt
Takashi Iwaidb064e52006-03-16 16:04:58 +0100790
Takashi Iwai6d7b1d72007-02-26 15:56:46 +0100791 The model name "genric" is treated as a special case. When this
792 model is given, the driver uses the generic codec parser without
793 "codec-patch". It's sometimes good for testing and debugging.
794
Takashi Iwai62430082005-09-05 17:12:29 +0200795 If the default configuration doesn't work and one of the above
Takashi Iwai30bc4482008-12-09 08:23:45 +0100796 matches with your device, report it together with alsa-info.sh
797 output (with --no-upload option) to kernel bugzilla or alsa-devel
Takashi Iwai62430082005-09-05 17:12:29 +0200798 ML (see the section "Links and Addresses").
799
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200800 power_save and power_save_controller options are for power-saving
801 mode. See powersave.txt for details.
Takashi Iwaidee1b662007-08-13 16:10:30 +0200802
Takashi Iwaic74db862005-05-12 14:26:27 +0200803 Note 2: If you get click noises on output, try the module option
804 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
805 register value without FIFO size correction as the current
806 DMA pointer. position_fix=2 will make the driver to use
807 the position buffer instead of reading SD_LPIB register.
Michael Kerrisk90f31e32008-09-01 14:03:50 +0200808 (Usually SD_LPIB register is more accurate than the
Takashi Iwaic74db862005-05-12 14:26:27 +0200809 position buffer.)
810
Takashi Iwai27346162006-01-12 18:28:44 +0100811 NB: If you get many "azx_get_response timeout" messages at
812 loading, it's likely a problem of interrupts (e.g. ACPI irq
813 routing). Try to boot with options like "pci=noacpi". Also, you
814 can try "single_cmd=1" module option. This will switch the
815 communication method between HDA controller and codecs to the
816 single immediate commands instead of CORB/RIRB. Basically, the
817 single command mode is provided only for BIOS, and you won't get
818 unsolicited events, too. But, at least, this works independently
819 from the irq. Remember this is a last resort, and should be
820 avoided as much as possible...
821
Takashi Iwai95904742007-05-19 17:06:42 +0200822 MORE NOTES ON "azx_get_response timeout" PROBLEMS:
823 On some hardwares, you may need to add a proper probe_mask option
824 to avoid the "azx_get_response timeout" problem above, instead.
825 This occurs when the access to non-existing or non-working codec slot
826 (likely a modem one) causes a stall of the communication via HD-audio
827 bus. You can see which codec slots are probed by enabling
Takashi Iwai62cf8722008-05-20 12:15:15 +0200828 CONFIG_SND_DEBUG_VERBOSE, or simply from the file name of the codec
Takashi Iwai95904742007-05-19 17:06:42 +0200829 proc files. Then limit the slots to probe by probe_mask option.
830 For example, probe_mask=1 means to probe only the first slot, and
831 probe_mask=4 means only the third slot.
832
Takashi Iwaia4efc232005-11-17 17:24:26 +0100833 The power-management is supported.
834
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 Module snd-hdsp
836 ---------------
837
838 Module for RME Hammerfall DSP audio interface(s)
839
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100840 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841
842 Note: The firmware data can be automatically loaded via hotplug
843 when CONFIG_FW_LOADER is set. Otherwise, you need to load
844 the firmware via hdsploader utility included in alsa-tools
845 package.
846 The firmware data is found in alsa-firmware package.
847
848 Note: snd-page-alloc module does the job which snd-hammerfall-mem
849 module did formerly. It will allocate the buffers in advance
850 when any HDSP cards are found. To make the buffer
851 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +0200852 stage of boot sequence. See "Early Buffer Allocation"
853 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854
Takashi Iwai54704402005-06-03 11:27:00 +0200855 Module snd-hdspm
856 ----------------
857
858 Module for RME HDSP MADI board.
859
860 precise_ptr - Enable precise pointer, or disable.
861 line_outs_monitor - Send playback streams to analog outs by default.
862 enable_monitor - Enable Analog Out on Channel 63/64 by default.
863
864 See hdspm.txt for details.
865
Clemens Ladischc6260262008-01-25 08:41:52 +0100866 Module snd-hifier
867 -----------------
868
869 Module for the MediaTek/TempoTec HiFier Fantasia sound card.
870
871 This module supports autoprobe and multiple cards.
872
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 Module snd-ice1712
874 ------------------
875
876 Module for Envy24 (ICE1712) based PCI sound cards.
877 * MidiMan M Audio Delta 1010
878 * MidiMan M Audio Delta 1010LT
879 * MidiMan M Audio Delta DiO 2496
880 * MidiMan M Audio Delta 66
881 * MidiMan M Audio Delta 44
882 * MidiMan M Audio Delta 410
883 * MidiMan M Audio Audiophile 2496
884 * TerraTec EWS 88MT
885 * TerraTec EWS 88D
886 * TerraTec EWX 24/96
887 * TerraTec DMX 6Fire
Takashi Iwaic9bce912005-05-24 13:41:03 +0200888 * TerraTec Phase 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 * Hoontech SoundTrack DSP 24
890 * Hoontech SoundTrack DSP 24 Value
891 * Hoontech SoundTrack DSP 24 Media 7.1
Takashi Iwaic9bce912005-05-24 13:41:03 +0200892 * Event Electronics, EZ8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 * Digigram VX442
Takashi Iwaic9bce912005-05-24 13:41:03 +0200894 * Lionstracs, Mediastaton
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400895 * Terrasoniq TS 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896
897 model - Use the given board model, one of the following:
898 delta1010, dio2496, delta66, delta44, audiophile, delta410,
899 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
Takashi Iwaic9bce912005-05-24 13:41:03 +0200900 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
901 phase88, mediastation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 omni - Omni I/O support for MidiMan M-Audio Delta44/66
Matt LaPlantefa00e7e2006-11-30 04:55:36 +0100903 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transceiver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 in msec resolution, default value is 500 (0.5 sec)
905
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100906 This module supports multiple cards and autoprobe. Note: The consumer part
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 is not used with all Envy24 based cards (for example in the MidiMan Delta
908 serie).
909
Takashi Iwaic9bce912005-05-24 13:41:03 +0200910 Note: The supported board is detected by reading EEPROM or PCI
911 SSID (if EEPROM isn't available). You can override the
912 model by passing "model" module option in case that the
913 driver isn't configured properly or you want to try another
914 type for testing.
915
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916 Module snd-ice1724
917 ------------------
918
Takashi Iwaic9bce912005-05-24 13:41:03 +0200919 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100920 * MidiMan M Audio Revolution 5.1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 * MidiMan M Audio Revolution 7.1
Takashi Iwai56255062006-11-09 16:47:26 +0100922 * MidiMan M Audio Audiophile 192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923 * AMP Ltd AUDIO2000
Takashi Iwaic9bce912005-05-24 13:41:03 +0200924 * TerraTec Aureon 5.1 Sky
925 * TerraTec Aureon 7.1 Space
926 * TerraTec Aureon 7.1 Universe
927 * TerraTec Phase 22
928 * TerraTec Phase 28
929 * AudioTrak Prodigy 7.1
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400930 * AudioTrak Prodigy 7.1 LT
931 * AudioTrak Prodigy 7.1 XT
932 * AudioTrak Prodigy 7.1 HIFI
933 * AudioTrak Prodigy 7.1 HD2
Takashi Iwaic9bce912005-05-24 13:41:03 +0200934 * AudioTrak Prodigy 192
935 * Pontis MS300
936 * Albatron K8X800 Pro II
937 * Chaintech ZNF3-150
938 * Chaintech ZNF3-250
939 * Chaintech 9CJS
Takashi Iwai8cfbbac2005-05-27 12:10:40 +0200940 * Chaintech AV-710
Takashi Iwaic9bce912005-05-24 13:41:03 +0200941 * Shuttle SN25P
Shin-ya Okadaf31639b2007-10-23 15:08:18 +0200942 * Onkyo SE-90PCI
943 * Onkyo SE-200PCI
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400944 * ESI Juli@
945 * Hercules Fortissimo IV
946 * EGO-SYS WaveTerminal 192M
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947
948 model - Use the given board model, one of the following:
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100949 revo51, revo71, amp2000, prodigy71, prodigy71lt,
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400950 prodigy71xt, prodigy71hifi, prodigyhd2, prodigy192,
951 juli, aureon51, aureon71, universe, ap192, k8x800,
952 phase22, phase28, ms300, av710, se200pci, se90pci,
953 fortissimo4, sn25p, WT192M
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100955 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956
Takashi Iwaic9bce912005-05-24 13:41:03 +0200957 Note: The supported board is detected by reading EEPROM or PCI
958 SSID (if EEPROM isn't available). You can override the
959 model by passing "model" module option in case that the
960 driver isn't configured properly or you want to try another
961 type for testing.
962
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200963 Module snd-indigo
964 -----------------
965
966 Module for Echoaudio Indigo
967
968 This module supports multiple cards.
969 The driver requires the firmware loader support on kernel.
970
971 Module snd-indigodj
972 -------------------
973
974 Module for Echoaudio Indigo DJ
975
976 This module supports multiple cards.
977 The driver requires the firmware loader support on kernel.
978
979 Module snd-indigoio
980 -------------------
981
982 Module for Echoaudio Indigo IO
983
984 This module supports multiple cards.
985 The driver requires the firmware loader support on kernel.
986
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 Module snd-intel8x0
988 -------------------
989
990 Module for AC'97 motherboards from Intel and compatibles.
991 * Intel i810/810E, i815, i820, i830, i84x, MX440
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400992 ICH5, ICH6, ICH7, 6300ESB, ESB2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 * SiS 7012 (SiS 735)
Takashi Iwai89ac9c22006-01-24 10:36:57 +0100994 * NVidia NForce, NForce2, NForce3, MCP04, CK804
995 CK8, CK8S, MCP501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 * AMD AMD768, AMD8111
997 * ALi m5455
998
999 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1000 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001001 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 buggy_irq - Enable workaround for buggy interrupts on some
Takashi Iwaia06147d2005-09-08 19:54:17 +02001003 motherboards (default yes on nForce chips,
1004 otherwise off)
1005 buggy_semaphore - Enable workaround for hardwares with buggy
1006 semaphores (e.g. on some ASUS laptops)
1007 (default off)
Takashi Iwai6c5cfd92006-11-28 17:18:25 +01001008 spdif_aclink - Use S/PDIF over AC-link instead of direct connection
1009 from the controller chip
1010 (0 = off, 1 = on, -1 = default)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001012 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013
1014 Note: the latest driver supports auto-detection of chip clock.
1015 if you still encounter too fast playback, specify the clock
1016 explicitly via the module option "ac97_clock=41194".
1017
1018 Joystick/MIDI ports are not supported by this driver. If your
1019 motherboard has these devices, use the ns558 or snd-mpu401
1020 modules, respectively.
1021
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 The power-management is supported.
1023
1024 Module snd-intel8x0m
1025 --------------------
1026
1027 Module for Intel ICH (i8x0) chipset MC97 modems.
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001028 * Intel i810/810E, i815, i820, i830, i84x, MX440
1029 ICH5, ICH6, ICH7
1030 * SiS 7013 (SiS 735)
1031 * NVidia NForce, NForce2, NForce2s, NForce3
1032 * AMD AMD8111
1033 * ALi m5455
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034
1035 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1036
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001037 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038
1039 Note: The default index value of this module is -2, i.e. the first
1040 slot is excluded.
1041
Takashi Iwaia4efc232005-11-17 17:24:26 +01001042 The power-management is supported.
1043
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 Module snd-interwave
1045 --------------------
1046
1047 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1048 and other sound cards based on AMD InterWave (tm) chip.
1049
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1051 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1052 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1053 effect - 1 = InterWave effects enable (default 0);
1054 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001055 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1056
1057 with isapnp=0, the following options are available:
1058
1059 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1060 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1061 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1062 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001064 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065
1066 Module snd-interwave-stb
1067 ------------------------
1068
1069 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1070 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1071 circuit for extended control of bass, treble and master volume.
1072
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1074 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1075 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1076 effect - 1 = InterWave effects enable (default 0);
1077 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001078 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1079
1080 with isapnp=0, the following options are available:
1081
1082 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1083 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1084 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1085 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1086 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001088 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089
1090 Module snd-korg1212
1091 -------------------
1092
1093 Module for Korg 1212 IO PCI card
1094
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001095 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001097 Module snd-layla20
1098 ------------------
1099
1100 Module for Echoaudio Layla20
1101
1102 This module supports multiple cards.
1103 The driver requires the firmware loader support on kernel.
1104
1105 Module snd-layla24
1106 ------------------
1107
1108 Module for Echoaudio Layla24
1109
1110 This module supports multiple cards.
1111 The driver requires the firmware loader support on kernel.
1112
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 Module snd-maestro3
1114 -------------------
1115
1116 Module for Allegro/Maestro3 chips
1117
1118 external_amp - enable external amp (enabled by default)
1119 amp_gpio - GPIO pin number for external amp (0-15) or
1120 -1 for default pin (8 for allegro, 1 for
1121 others)
1122
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001123 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124
1125 Note: the binding of amplifier is dependent on hardware.
1126 If there is no sound even though all channels are unmuted, try to
1127 specify other gpio connection via amp_gpio option.
1128 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1129 option.
1130
1131 The power-management is supported.
1132
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001133 Module snd-mia
1134 ---------------
1135
1136 Module for Echoaudio Mia
1137
1138 This module supports multiple cards.
1139 The driver requires the firmware loader support on kernel.
1140
Martin Langer1841f612006-03-27 12:41:01 +02001141 Module snd-miro
1142 ---------------
1143
1144 Module for Miro soundcards: miroSOUND PCM 1 pro,
1145 miroSOUND PCM 12,
1146 miroSOUND PCM 20 Radio.
1147
1148 port - Port # (0x530,0x604,0xe80,0xf40)
1149 irq - IRQ # (5,7,9,10,11)
1150 dma1 - 1st dma # (0,1,3)
1151 dma2 - 2nd dma # (0,1)
1152 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1153 mpu_irq - MPU-401 irq # (5,7,9,10)
1154 fm_port - FM Port # (0x388)
1155 wss - enable WSS mode
1156 ide - enable onboard ide support
1157
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 Module snd-mixart
1159 -----------------
1160
1161 Module for Digigram miXart8 sound cards.
1162
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001163 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 Note: One miXart8 board will be represented as 4 alsa cards.
1165 See MIXART.txt for details.
1166
1167 When the driver is compiled as a module and the hotplug firmware
1168 is supported, the firmware data is loaded via hotplug automatically.
1169 Install the necessary firmware files in alsa-firmware package.
1170 When no hotplug fw loader is available, you need to load the
1171 firmware via mixartloader utility in alsa-tools package.
1172
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001173 Module snd-mona
1174 ---------------
1175
1176 Module for Echoaudio Mona
1177
1178 This module supports multiple cards.
1179 The driver requires the firmware loader support on kernel.
1180
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 Module snd-mpu401
1182 -----------------
1183
1184 Module for MPU-401 UART devices.
1185
1186 port - port number or -1 (disable)
1187 irq - IRQ number or -1 (disable)
1188 pnp - PnP detection - 0 = disable, 1 = enable (default)
1189
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001190 This module supports multiple devices and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191
1192 Module snd-mtpav
1193 ----------------
1194
1195 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1196 port).
1197
1198 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1199 irq - IRQ # for MTPAV (7,5, default=7)
1200 hwports - number of supported hardware ports, default=8.
1201
1202 Module supports only 1 card. This module has no enable option.
1203
Matthias Koenig68ab8012006-07-27 16:59:23 +02001204 Module snd-mts64
1205 ----------------
1206
1207 Module for Ego Systems (ESI) Miditerminal 4140
1208
1209 This module supports multiple devices.
1210 Requires parport (CONFIG_PARPORT).
1211
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212 Module snd-nm256
1213 ----------------
1214
1215 Module for NeoMagic NM256AV/ZX chips
1216
1217 playback_bufsize - max playback frame size in kB (4-128kB)
1218 capture_bufsize - max capture frame size in kB (4-128kB)
1219 force_ac97 - 0 or 1 (disabled by default)
1220 buffer_top - specify buffer top address
1221 use_cache - 0 or 1 (disabled by default)
1222 vaio_hack - alias buffer_top=0x25a800
1223 reset_workaround - enable AC97 RESET workaround for some laptops
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001224 reset_workaround2 - enable extended AC97 RESET workaround for some
1225 other laptops
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +02001227 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228
1229 The power-management is supported.
1230
1231 Note: on some notebooks the buffer address cannot be detected
1232 automatically, or causes hang-up during initialization.
Matt LaPlantefff92892006-10-03 22:47:42 +02001233 In such a case, specify the buffer top address explicitly via
1234 the buffer_top option.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 For example,
1236 Sony F250: buffer_top=0x25a800
1237 Sony F270: buffer_top=0x272800
1238 The driver supports only ac97 codec. It's possible to force
1239 to initialize/use ac97 although it's not detected. In such a
1240 case, use force_ac97=1 option - but *NO* guarantee whether it
1241 works!
1242
1243 Note: The NM256 chip can be linked internally with non-AC97
1244 codecs. This driver supports only the AC97 codec, and won't work
1245 with machines with other (most likely CS423x or OPL3SAx) chips,
1246 even though the device is detected in lspci. In such a case, try
1247 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
Takashi Iwai62430082005-09-05 17:12:29 +02001248 but some doesn't have ISA PnP. You'll need to specify isapnp=0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 and proper hardware parameters in the case without ISA PnP.
1250
1251 Note: some laptops need a workaround for AC97 RESET. For the
1252 known hardware like Dell Latitude LS and Sony PCG-F305, this
1253 workaround is enabled automatically. For other laptops with a
1254 hard freeze, you can try reset_workaround=1 option.
1255
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001256 Note: Dell Latitude CSx laptops have another problem regarding
1257 AC97 RESET. On these laptops, reset_workaround2 option is
1258 turned on as default. This option is worth to try if the
1259 previous reset_workaround option doesn't help.
1260
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 Note: This driver is really crappy. It's a porting from the
1262 OSS driver, which is a result of black-magic reverse engineering.
1263 The detection of codec will fail if the driver is loaded *after*
1264 X-server as described above. You might be able to force to load
1265 the module, but it may result in hang-up. Hence, make sure that
1266 you load this module *before* X if you encounter this kind of
1267 problem.
1268
1269 Module snd-opl3sa2
1270 ------------------
1271
1272 Module for Yamaha OPL3-SA2/SA3 sound cards.
1273
Rene Herman64e0e2d2007-12-13 16:29:33 +01001274 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1275
1276 with isapnp=0, the following options are available:
1277
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 port - control port # for OPL3-SA chip (0x370)
1279 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1280 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1281 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1282 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1283 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1284 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1285 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001287 This module supports multiple cards and ISA PnP. It does not support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1289
1290 The power-management is supported.
1291
1292 Module snd-opti92x-ad1848
1293 -------------------------
1294
1295 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1296 Module works with OAK Mozart cards as well.
1297
Rene Herman64e0e2d2007-12-13 16:29:33 +01001298 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1299
1300 with isapnp=0, the following options are available:
1301
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1303 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1304 fm_port - port # for OPL3 device (0x388)
1305 irq - IRQ # for WSS chip (5,7,9,10,11)
1306 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1307 dma1 - first DMA # for WSS chip (0,1,3)
1308
1309 This module supports only one card, autoprobe and PnP.
1310
1311 Module snd-opti92x-cs4231
1312 -------------------------
1313
1314 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1315
Rene Herman64e0e2d2007-12-13 16:29:33 +01001316 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1317
1318 with isapnp=0, the following options are available:
1319
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1321 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1322 fm_port - port # for OPL3 device (0x388)
1323 irq - IRQ # for WSS chip (5,7,9,10,11)
1324 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1325 dma1 - first DMA # for WSS chip (0,1,3)
1326 dma2 - second DMA # for WSS chip (0,1,3)
1327
1328 This module supports only one card, autoprobe and PnP.
1329
1330 Module snd-opti93x
1331 ------------------
1332
1333 Module for sound cards based on OPTi 82c93x chips.
1334
Rene Herman64e0e2d2007-12-13 16:29:33 +01001335 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1336
1337 with isapnp=0, the following options are available:
1338
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1340 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1341 fm_port - port # for OPL3 device (0x388)
1342 irq - IRQ # for WSS chip (5,7,9,10,11)
1343 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1344 dma1 - first DMA # for WSS chip (0,1,3)
1345 dma2 - second DMA # for WSS chip (0,1,3)
1346
1347 This module supports only one card, autoprobe and PnP.
1348
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001349 Module snd-oxygen
1350 -----------------
1351
1352 Module for sound cards based on the C-Media CMI8788 chip:
1353 * Asound A-8788
1354 * AuzenTech X-Meridian
1355 * Bgears b-Enspirer
1356 * Club3D Theatron DTS
Clemens Ladischde04b102008-11-26 10:37:23 +01001357 * HT-Omega Claro (plus)
1358 * HT-Omega Claro halo (XT)
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001359 * Razer Barracuda AC-1
1360 * Sondigo Inferno
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001361
1362 This module supports autoprobe and multiple cards.
1363
Stas Sergeevd08cd582008-03-06 11:01:44 +01001364 Module snd-pcsp
1365 -----------------
1366
1367 Module for internal PC-Speaker.
1368
1369 nforce_wa - enable NForce chipset workaround. Expect bad sound.
1370
1371 This module supports system beeps, some kind of PCM playback and
1372 even a few mixer controls.
1373
Markus Bollingere12229b2005-12-06 13:55:26 +01001374 Module snd-pcxhr
1375 ----------------
1376
1377 Module for Digigram PCXHR boards
1378
1379 This module supports multiple cards.
1380
Matthias Koenig757e1192007-01-25 13:15:05 +01001381 Module snd-portman2x4
1382 ---------------------
1383
1384 Module for Midiman Portman 2x4 parallel port MIDI interface
1385
1386 This module supports multiple cards.
1387
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 Module snd-powermac (on ppc only)
1389 ---------------------------------
1390
1391 Module for PowerMac, iMac and iBook on-board soundchips
1392
1393 enable_beep - enable beep using PCM (enabled as default)
1394
1395 Module supports autoprobe a chip.
1396
1397 Note: the driver may have problems regarding endianess.
1398
1399 The power-management is supported.
1400
Takashi Iwai2c484df2005-06-30 18:54:04 +02001401 Module snd-pxa2xx-ac97 (on arm only)
1402 ------------------------------------
1403
1404 Module for AC97 driver for the Intel PXA2xx chip
1405
1406 For ARM architecture only.
1407
Takashi Iwaia4efc232005-11-17 17:24:26 +01001408 The power-management is supported.
1409
Peter Gruber109a9632006-03-27 13:10:28 +02001410 Module snd-riptide
1411 ------------------
1412
1413 Module for Conexant Riptide chip
1414
1415 joystick_port - Joystick port # (default: 0x200)
1416 mpu_port - MPU401 port # (default: 0x330)
1417 opl3_port - OPL3 port # (default: 0x388)
1418
1419 This module supports multiple cards.
1420 The driver requires the firmware loader support on kernel.
1421 You need to install the firmware file "riptide.hex" to the standard
1422 firmware path (e.g. /lib/firmware).
1423
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 Module snd-rme32
1425 ----------------
1426
1427 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1428 Prodif96 and Prodif Gold) sound cards.
1429
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001430 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431
1432 Module snd-rme96
1433 ----------------
1434
1435 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1436
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001437 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438
1439 Module snd-rme9652
1440 ------------------
1441
1442 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1443
1444 precise_ptr - Enable precise pointer (doesn't work reliably).
1445 (default = 0)
1446
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001447 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448
1449 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1450 module did formerly. It will allocate the buffers in advance
1451 when any RME9652 cards are found. To make the buffer
1452 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +02001453 stage of boot sequence. See "Early Buffer Allocation"
1454 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455
1456 Module snd-sa11xx-uda1341 (on arm only)
1457 ---------------------------------------
1458
1459 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1460
1461 Module supports only one card.
1462 Module has no enable and index options.
1463
Takashi Iwaia4efc232005-11-17 17:24:26 +01001464 The power-management is supported.
1465
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466 Module snd-sb8
1467 --------------
1468
1469 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1470 SoundBlaster 2.0,
1471 SoundBlaster Pro
1472
1473 port - port # for SB DSP chip (0x220,0x240,0x260)
1474 irq - IRQ # for SB DSP chip (5,7,9,10)
1475 dma8 - DMA # for SB DSP chip (1,3)
1476
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001477 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478
Takashi Iwaia4efc232005-11-17 17:24:26 +01001479 The power-management is supported.
1480
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481 Module snd-sb16 and snd-sbawe
1482 -----------------------------
1483
1484 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1485 SoundBlaster AWE 32 (PnP),
1486 SoundBlaster AWE 64 PnP
1487
Rene Herman64e0e2d2007-12-13 16:29:33 +01001488 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1489 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1490 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1491
1492 with isapnp=0, the following options are available:
1493
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1495 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1496 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1497 (snd-sbawe module only)
1498 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1499 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1500 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001502 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503
1504 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1505 disable 16bit DMA with dma16 = -1 module parameter.
1506 Also, all Sound Blaster 16 type cards can operate in 16-bit
1507 half duplex mode through 8-bit DMA channel by disabling their
1508 16-bit DMA channel.
1509
Takashi Iwaia4efc232005-11-17 17:24:26 +01001510 The power-management is supported.
1511
Takashi Iwai074a6e92007-09-11 22:10:14 +02001512 Module snd-sc6000
1513 -----------------
1514
1515 Module for Gallant SC-6000 soundcard.
1516
1517 port - Port # (0x220 or 0x240)
1518 mss_port - MSS Port # (0x530 or 0xe80)
1519 irq - IRQ # (5,7,9,10,11)
Krzysztof Helt7b758d22007-09-17 14:42:49 +02001520 mpu_irq - MPU-401 IRQ # (5,7,9,10) ,0 - no MPU-401 irq
Takashi Iwai074a6e92007-09-11 22:10:14 +02001521 dma - DMA # (1,3,0)
1522
1523 This module supports multiple cards.
1524
1525 This card is also known as Audio Excel DSP 16 or Zoltrix AV302.
1526
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 Module snd-sgalaxy
1528 ------------------
1529
1530 Module for Aztech Sound Galaxy sound card.
1531
1532 sbport - Port # for SB16 interface (0x220,0x240)
1533 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1534 irq - IRQ # (7,9,10,11)
1535 dma1 - DMA #
1536
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001537 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538
Takashi Iwaia4efc232005-11-17 17:24:26 +01001539 The power-management is supported.
1540
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541 Module snd-sscape
1542 -----------------
1543
1544 Module for ENSONIQ SoundScape PnP cards.
1545
1546 port - Port # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001547 wss_port - WSS Port # (PnP setup)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 irq - IRQ # (PnP setup)
1549 mpu_irq - MPU-401 IRQ # (PnP setup)
1550 dma - DMA # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001551 dma2 - 2nd DMA # (PnP setup, -1 to disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001553 This module supports multiple cards. ISA PnP must be enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554 You need sscape_ctl tool in alsa-tools package for loading
1555 the microcode.
1556
1557 Module snd-sun-amd7930 (on sparc only)
1558 --------------------------------------
1559
1560 Module for AMD7930 sound chips found on Sparcs.
1561
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001562 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001563
1564 Module snd-sun-cs4231 (on sparc only)
1565 -------------------------------------
1566
1567 Module for CS4231 sound chips found on Sparcs.
1568
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001569 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001571 Module snd-sun-dbri (on sparc only)
1572 -----------------------------------
1573
1574 Module for DBRI sound chips found on Sparcs.
1575
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001576 This module supports multiple cards.
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001577
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578 Module snd-wavefront
1579 --------------------
1580
1581 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1582
Rene Herman64e0e2d2007-12-13 16:29:33 +01001583 use_cs4232_midi - Use CS4232 MPU-401 interface
1584 (inaccessibly located inside your computer)
1585 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1586
1587 with isapnp=0, the following options are available:
1588
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 cs4232_pcm_port - Port # for CS4232 PCM interface.
1590 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1591 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1592 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 ics2115_port - Port # for ICS2115
1594 ics2115_irq - IRQ # for ICS2115
1595 fm_port - FM OPL-3 Port #
1596 dma1 - DMA1 # for CS4232 PCM interface.
1597 dma2 - DMA2 # for CS4232 PCM interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598
Takashi Iwaic2b12392007-08-21 15:20:26 +02001599 The below are options for wavefront_synth features:
1600 wf_raw - Assume that we need to boot the OS (default:no)
1601 If yes, then during driver loading, the state of the board is
1602 ignored, and we reset the board and load the firmware anyway.
1603 fx_raw - Assume that the FX process needs help (default:yes)
1604 If false, we'll leave the FX processor in whatever state it is
1605 when the driver is loaded. The default is to download the
1606 microprogram and associated coefficients to set it up for
1607 "default" operation, whatever that means.
1608 debug_default - Debug parameters for card initialization
1609 wait_usecs - How long to wait without sleeping, usecs
1610 (default:150)
1611 This magic number seems to give pretty optimal throughput
1612 based on my limited experimentation.
1613 If you want to play around with it and find a better value, be
1614 my guest. Remember, the idea is to get a number that causes us
1615 to just busy wait for as many WaveFront commands as possible,
1616 without coming up with a number so large that we hog the whole
1617 CPU.
1618 Specifically, with this number, out of about 134,000 status
1619 waits, only about 250 result in a sleep.
1620 sleep_interval - How long to sleep when waiting for reply
1621 (default: 100)
1622 sleep_tries - How many times to try sleeping during a wait
1623 (default: 50)
1624 ospath - Pathname to processed ICS2115 OS firmware
1625 (default:wavefront.os)
1626 The path name of the ISC2115 OS firmware. In the recent
1627 version, it's handled via firmware loader framework, so it
1628 must be installed in the proper path, typically,
1629 /lib/firmware.
1630 reset_time - How long to wait for a reset to take effect
1631 (default:2)
1632 ramcheck_time - How many seconds to wait for the RAM test
1633 (default:20)
1634 osrun_time - How many seconds to wait for the ICS2115 OS
1635 (default:10)
1636
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001637 This module supports multiple cards and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638
Takashi Iwaic2b12392007-08-21 15:20:26 +02001639 Note: the firmware file "wavefront.os" was located in the earlier
1640 version in /etc. Now it's loaded via firmware loader, and
1641 must be in the proper firmware path, such as /lib/firmware.
1642 Copy (or symlink) the file appropriately if you get an error
1643 regarding firmware downloading after upgrading the kernel.
1644
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 Module snd-sonicvibes
1646 ---------------------
1647
1648 Module for S3 SonicVibes PCI sound cards.
1649 * PINE Schubert 32 PCI
1650
1651 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1652 - SoundCard must have onboard SRAM for this.
1653 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1654
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001655 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001656
1657 Module snd-serial-u16550
1658 ------------------------
1659
1660 Module for UART16550A serial MIDI ports.
1661
1662 port - port # for UART16550A chip
1663 irq - IRQ # for UART16550A chip, -1 = poll mode
1664 speed - speed in bauds (9600,19200,38400,57600,115200)
1665 38400 = default
1666 base - base for divisor in bauds (57600,115200,230400,460800)
1667 115200 = default
1668 outs - number of MIDI ports in a serial port (1-4)
1669 1 = default
1670 adaptor - Type of adaptor.
1671 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1672 3 = MS-124W M/B, 4 = Generic
1673
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001674 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675 thus the main port must be specified!!! Other options are optional.
1676
1677 Module snd-trident
1678 ------------------
1679
1680 Module for Trident 4DWave DX/NX sound cards.
1681 * Best Union Miss Melody 4DWave PCI
1682 * HIS 4DWave PCI
1683 * Warpspeed ONSpeed 4DWave PCI
1684 * AzTech PCI 64-Q3D
1685 * Addonics SV 750
1686 * CHIC True Sound 4Dwave
1687 * Shark Predator4D-PCI
1688 * Jaton SonicWave 4D
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001689 * SiS SI7018 PCI Audio
1690 * Hoontech SoundTrack Digital 4DWave NX
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691
1692 pcm_channels - max channels (voices) reserved for PCM
1693 wavetable_size - max wavetable size in kB (4-?kb)
1694
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001695 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696
1697 The power-management is supported.
1698
1699 Module snd-usb-audio
1700 --------------------
1701
1702 Module for USB audio and USB MIDI devices.
1703
1704 vid - Vendor ID for the device (optional)
1705 pid - Product ID for the device (optional)
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001706 nrpacks - Max. number of packets per URB (default: 8)
1707 async_unlink - Use async unlink mode (default: yes)
Thibault LE MEURe3113342006-03-14 11:44:53 +01001708 device_setup - Device specific magic number (optional)
1709 - Influence depends on the device
1710 - Default: 0x0000
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001711 ignore_ctl_error - Ignore any USB-controller regarding mixer
1712 interface (default: no)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001714 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001716 NB: nrpacks parameter can be modified dynamically via sysfs.
1717 Don't put the value over 20. Changing via sysfs has no sanity
1718 check.
1719 NB: async_unlink=0 would cause Oops. It remains just for
1720 debugging purpose (if any).
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001721 NB: ignore_ctl_error=1 may help when you get an error at accessing
1722 the mixer element such as URB error -22. This happens on some
1723 buggy USB device or the controller.
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001724
Daniel Mack523f1dc2007-03-26 19:11:24 +02001725 Module snd-usb-caiaq
1726 --------------------
1727
1728 Module for caiaq UB audio interfaces,
1729 * Native Instruments RigKontrol2
1730 * Native Instruments Kore Controller
1731 * Native Instruments Audio Kontrol 1
1732 * Native Instruments Audio 8 DJ
1733
1734 This module supports multiple devices, autoprobe and hotplugging.
1735
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736 Module snd-usb-usx2y
1737 --------------------
1738
1739 Module for Tascam USB US-122, US-224 and US-428 devices.
1740
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001741 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742
1743 Note: you need to load the firmware via usx2yloader utility included
1744 in alsa-tools and alsa-firmware packages.
1745
1746 Module snd-via82xx
1747 ------------------
1748
1749 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001750 8233A, 8233C, 8235, 8237 (south) bridge.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751
1752 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1753 [VIA686A/686B only]
1754 joystick - Enable joystick (default off) [VIA686A/686B only]
1755 ac97_clock - AC'97 codec clock base (default 48000Hz)
1756 dxs_support - support DXS channels,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001757 0 = auto (default), 1 = enable, 2 = disable,
1758 3 = 48k only, 4 = no VRA, 5 = enable any sample
1759 rate and different sample rates on different
1760 channels
1761 [VIA8233/C, 8235, 8237 only]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001763 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001765 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766
1767 Note: on some SMP motherboards like MSI 694D the interrupts might
1768 not be generated properly. In such a case, please try to
1769 set the SMP (or MPS) version on BIOS to 1.1 instead of
1770 default value 1.4. Then the interrupt number will be
1771 assigned under 15. You might also upgrade your BIOS.
1772
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001773 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 channels as the first PCM. On these channels, up to 4
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001775 streams can be played at the same time, and the controller
1776 can perform sample rate conversion with separate rates for
1777 each channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778 As default (dxs_support = 0), 48k fixed rate is chosen
1779 except for the known devices since the output is often
1780 noisy except for 48k on some mother boards due to the
1781 bug of BIOS.
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001782 Please try once dxs_support=5 and if it works on other
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1784 know the PCI subsystem vendor/device id's (output of
1785 "lspci -nv").
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001786 If dxs_support=5 does not work, try dxs_support=4; if it
1787 doesn't work too, try dxs_support=1. (dxs_support=1 is
Takashi Iwai62430082005-09-05 17:12:29 +02001788 usually for old motherboards. The correct implemented
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001789 board should work with 4 or 5.) If it still doesn't
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790 work and the default setting is ok, dxs_support=3 is the
1791 right choice. If the default setting doesn't work at all,
1792 try dxs_support=2 to disable the DXS channels.
1793 In any cases, please let us know the result and the
Takashi Iwai62430082005-09-05 17:12:29 +02001794 subsystem vendor/device ids. See "Links and Addresses"
1795 below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796
1797 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Takashi Iwai62430082005-09-05 17:12:29 +02001798 additionally. The mpu_port option is for VIA686 chips only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799
Takashi Iwaia4efc232005-11-17 17:24:26 +01001800 The power-management is supported.
1801
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 Module snd-via82xx-modem
1803 ------------------------
1804
1805 Module for VIA82xx AC97 modem
1806
1807 ac97_clock - AC'97 codec clock base (default 48000Hz)
1808
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001809 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810
1811 Note: The default index value of this module is -2, i.e. the first
1812 slot is excluded.
1813
Takashi Iwaia4efc232005-11-17 17:24:26 +01001814 The power-management is supported.
1815
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 Module snd-virmidi
1817 ------------------
1818
1819 Module for virtual rawmidi devices.
1820 This module creates virtual rawmidi devices which communicate
1821 to the corresponding ALSA sequencer ports.
1822
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001823 midi_devs - MIDI devices # (1-4, default=4)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001825 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001827 Module snd-virtuoso
1828 -------------------
1829
Clemens Ladisch5430c722008-07-28 10:28:43 +02001830 Module for sound cards based on the Asus AV100/AV200 chips,
Clemens Ladisch7407a2e2008-09-22 09:12:11 +02001831 i.e., Xonar D1, DX, D2, D2X and HDAV1.3 (Deluxe).
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001832
1833 This module supports autoprobe and multiple cards.
1834
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835 Module snd-vx222
1836 ----------------
1837
1838 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1839
1840 mic - Enable Microphone on V222 Mic (NYI)
1841 ibl - Capture IBL size. (default = 0, minimum size)
1842
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001843 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844
1845 When the driver is compiled as a module and the hotplug firmware
1846 is supported, the firmware data is loaded via hotplug automatically.
1847 Install the necessary firmware files in alsa-firmware package.
1848 When no hotplug fw loader is available, you need to load the
1849 firmware via vxloader utility in alsa-tools package. To invoke
1850 vxloader automatically, add the following to /etc/modprobe.conf
1851
1852 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1853
1854 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1855 /etc/modules.conf, instead.)
1856 IBL size defines the interrupts period for PCM. The smaller size
1857 gives smaller latency but leads to more CPU consumption, too.
1858 The size is usually aligned to 126. As default (=0), the smallest
1859 size is chosen. The possible IBL values can be found in
1860 /proc/asound/cardX/vx-status proc file.
1861
Takashi Iwaia4efc232005-11-17 17:24:26 +01001862 The power-management is supported.
1863
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864 Module snd-vxpocket
1865 -------------------
1866
Takashi Iwai6d00a312005-06-30 13:40:51 +02001867 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868
1869 ibl - Capture IBL size. (default = 0, minimum size)
1870
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001871 This module supports multiple cards. The module is compiled only when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872 PCMCIA is supported on kernel.
1873
Takashi Iwai62430082005-09-05 17:12:29 +02001874 With the older 2.6.x kernel, to activate the driver via the card
1875 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1876 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1877 longer require a config file.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878
1879 When the driver is compiled as a module and the hotplug firmware
1880 is supported, the firmware data is loaded via hotplug automatically.
1881 Install the necessary firmware files in alsa-firmware package.
1882 When no hotplug fw loader is available, you need to load the
1883 firmware via vxloader utility in alsa-tools package.
1884
1885 About capture IBL, see the description of snd-vx222 module.
1886
Takashi Iwaied7cbe32006-05-11 11:30:10 +02001887 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
Takashi Iwai62430082005-09-05 17:12:29 +02001888 ALSA 1.0.10.
1889
Takashi Iwaia4efc232005-11-17 17:24:26 +01001890 The power-management is supported.
1891
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892 Module snd-ymfpci
1893 -----------------
1894
1895 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1896
1897 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1898 1 (auto-detect for YMF744/754 only)
1899 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1900 1 (auto-detect for YMF744/754 only)
1901 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1902 1 (auto-detect)
1903 rear_switch - enable shared rear/line-in switch (bool)
1904
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001905 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906
1907 The power-management is supported.
1908
1909 Module snd-pdaudiocf
1910 --------------------
1911
1912 Module for Sound Core PDAudioCF sound card.
1913
Takashi Iwaia4efc232005-11-17 17:24:26 +01001914 The power-management is supported.
1915
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916
Takashi Iwai62430082005-09-05 17:12:29 +02001917AC97 Quirk Option
1918=================
1919
1920The ac97_quirk option is used to enable/override the workaround for
1921specific devices on drivers for on-board AC'97 controllers like
1922snd-intel8x0. Some hardware have swapped output pins between Master
1923and Headphone, or Surround (thanks to confusion of AC'97
1924specifications from version to version :-)
1925
1926The driver provides the auto-detection of known problematic devices,
1927but some might be unknown or wrongly detected. In such a case, pass
1928the proper value with this option.
1929
1930The following strings are accepted:
1931 - default Don't override the default setting
Takashi Iwai10e4097f2005-11-17 11:04:55 +01001932 - none Disable the quirk
Takashi Iwai62430082005-09-05 17:12:29 +02001933 - hp_only Bind Master and Headphone controls as a single control
1934 - swap_hp Swap headphone and master controls
1935 - swap_surround Swap master and surround controls
1936 - ad_sharing For AD1985, turn on OMS bit and use headphone
1937 - alc_jack For ALC65x, turn on the jack sense mode
1938 - inv_eapd Inverted EAPD implementation
1939 - mute_led Bind EAPD bit for turning on/off mute LED
1940
1941For backward compatibility, the corresponding integer value -1, 0,
1942... are accepted, too.
1943
1944For example, if "Master" volume control has no effect on your device
1945but only "Headphone" does, pass ac97_quirk=hp_only module option.
1946
1947
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948Configuring Non-ISAPNP Cards
1949============================
1950
1951When the kernel is configured with ISA-PnP support, the modules
1952supporting the isapnp cards will have module options "isapnp".
1953If this option is set, *only* the ISA-PnP devices will be probed.
1954For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
1955together with the proper i/o and irq configuration.
1956
1957When the kernel is configured without ISA-PnP support, isapnp option
1958will be not built in.
1959
1960
1961Module Autoloading Support
1962==========================
1963
1964The ALSA drivers can be loaded automatically on demand by defining
1965module aliases. The string 'snd-card-%1' is requested for ALSA native
1966devices where %i is sound card number from zero to seven.
1967
1968To auto-load an ALSA driver for OSS services, define the string
1969'sound-slot-%i' where %i means the slot number for OSS, which
1970corresponds to the card index of ALSA. Usually, define this
Tobias Klauserd533f672005-09-10 00:26:46 -07001971as the same card module.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972
1973An example configuration for a single emu10k1 card is like below:
1974----- /etc/modprobe.conf
1975alias snd-card-0 snd-emu10k1
1976alias sound-slot-0 snd-emu10k1
1977----- /etc/modprobe.conf
1978
1979The available number of auto-loaded sound cards depends on the module
1980option "cards_limit" of snd module. As default it's set to 1.
1981To enable the auto-loading of multiple cards, specify the number of
1982sound cards in that option.
1983
1984When multiple cards are available, it'd better to specify the index
1985number for each card via module option, too, so that the order of
1986cards is kept consistent.
1987
1988An example configuration for two sound cards is like below:
1989
1990----- /etc/modprobe.conf
1991# ALSA portion
1992options snd cards_limit=2
1993alias snd-card-0 snd-interwave
1994alias snd-card-1 snd-ens1371
1995options snd-interwave index=0
1996options snd-ens1371 index=1
1997# OSS/Free portion
1998alias sound-slot-0 snd-interwave
1999alias sound-slot-1 snd-ens1371
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02002000----- /etc/modprobe.conf
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001
2002In this example, the interwave card is always loaded as the first card
2003(index 0) and ens1371 as the second (index 1).
2004
Takashi Iwai304cd072007-10-26 15:10:15 +02002005Alternative (and new) way to fixate the slot assignment is to use
2006"slots" option of snd module. In the case above, specify like the
2007following:
2008
2009options snd slots=snd-interwave,snd-ens1371
2010
2011Then, the first slot (#0) is reserved for snd-interwave driver, and
2012the second (#1) for snd-ens1371. You can omit index option in each
2013driver if slots option is used (although you can still have them at
2014the same time as long as they don't conflict).
2015
2016The slots option is especially useful for avoiding the possible
2017hot-plugging and the resultant slot conflict. For example, in the
2018case above again, the first two slots are already reserved. If any
2019other driver (e.g. snd-usb-audio) is loaded before snd-interwave or
2020snd-ens1371, it will be assigned to the third or later slot.
2021
Takashi Iwaia93bbaa2008-05-27 17:59:24 +02002022When a module name is given with '!', the slot will be given for any
2023modules but that name. For example, "slots=!snd-pcsp" will reserve
2024the first slot for any modules but snd-pcsp.
2025
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026
2027ALSA PCM devices to OSS devices mapping
2028=======================================
2029
2030/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
2031/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
2032/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
2033/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
2034/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
2035/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
2036/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
2037/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
2038/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
2039
2040The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
2041sound card number and second means device number. The ALSA devices
2042have either 'c' or 'p' suffix indicating the direction, capture and
2043playback, respectively.
2044
2045Please note that the device mapping above may be varied via the module
2046options of snd-pcm-oss module.
2047
2048
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049Proc interfaces (/proc/asound)
2050==============================
2051
2052/proc/asound/card#/pcm#[cp]/oss
2053-------------------------------
2054 String "erase" - erase all additional informations about OSS applications
2055 String "<app_name> <fragments> <fragment_size> [<options>]"
2056
2057 <app_name> - name of application with (higher priority) or without path
2058 <fragments> - number of fragments or zero if auto
2059 <fragment_size> - size of fragment in bytes or zero if auto
2060 <options> - optional parameters
2061 - disable the application tries to open a pcm device for
2062 this channel but does not want to use it.
2063 (Cause a bug or mmap needs)
2064 It's good for Quake etc...
2065 - direct don't use plugins
2066 - block force block mode (rvplayer)
2067 - non-block force non-block mode
2068 - whole-frag write only whole fragments (optimization affecting
2069 playback only)
2070 - no-silence do not fill silence ahead to avoid clicks
Takashi Iwai10f69f92005-09-08 13:48:34 +02002071 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
2072 instead of filled blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073
2074 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
2075 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
2076 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
2077
2078
Takashi Iwaib6a96912005-05-30 18:27:03 +02002079Early Buffer Allocation
2080=======================
2081
2082Some drivers (e.g. hdsp) require the large contiguous buffers, and
2083sometimes it's too late to find such spaces when the driver module is
2084actually loaded due to memory fragmentation. You can pre-allocate the
2085PCM buffers by loading snd-page-alloc module and write commands to its
2086proc file in prior, for example, in the early boot stage like
2087/etc/init.d/*.local scripts.
2088
2089Reading the proc file /proc/drivers/snd-page-alloc shows the current
2090usage of page allocation. In writing, you can send the following
2091commands to the snd-page-alloc driver:
2092
2093 - add VENDOR DEVICE MASK SIZE BUFFERS
2094
2095 VENDOR and DEVICE are PCI vendor and device IDs. They take
2096 integer numbers (0x prefix is needed for the hex).
2097 MASK is the PCI DMA mask. Pass 0 if not restricted.
2098 SIZE is the size of each buffer to allocate. You can pass
2099 k and m suffix for KB and MB. The max number is 16MB.
2100 BUFFERS is the number of buffers to allocate. It must be greater
2101 than 0. The max number is 4.
2102
2103 - erase
2104
2105 This will erase the all pre-allocated buffers which are not in
2106 use.
2107
2108
Takashi Iwai62430082005-09-05 17:12:29 +02002109Links and Addresses
2110===================
Linus Torvalds1da177e2005-04-16 15:20:36 -07002111
2112 ALSA project homepage
2113 http://www.alsa-project.org
2114
Takashi Iwai30bc4482008-12-09 08:23:45 +01002115 Kernel Bugzilla
2116 http://bugzilla.kernel.org/
Takashi Iwai62430082005-09-05 17:12:29 +02002117
2118 ALSA Developers ML
Rene Herman45051792007-03-21 12:05:06 +01002119 mailto:alsa-devel@alsa-project.org
Takashi Iwai30bc4482008-12-09 08:23:45 +01002120
2121 alsa-info.sh script
2122 http://www.alsa-project.org/alsa-info.sh