blob: 414700b996aef21b28571aa0ad3c750fa4e8314c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001
2 Advanced Linux Sound Architecture - Driver
3 ==========================================
4 Configuration guide
5
6
7Kernel Configuration
8====================
9
10To enable ALSA support you need at least to build the kernel with
11primary sound card support (CONFIG_SOUND). Since ALSA can emulate OSS,
12you don't have to choose any of the OSS modules.
13
14Enable "OSS API emulation" (CONFIG_SND_OSSEMUL) and both OSS mixer and
15PCM supports if you want to run OSS applications with ALSA.
16
17If you want to support the WaveTable functionality on cards such as
18SB Live! then you need to enable "Sequencer support"
19(CONFIG_SND_SEQUENCER).
20
21To make ALSA debug messages more verbose, enable the "Verbose printk"
22and "Debug" options. To check for memory leaks, turn on "Debug memory"
23too. "Debug detection" will add checks for the detection of cards.
24
25Please note that all the ALSA ISA drivers support the Linux isapnp API
26(if the card supports ISA PnP). You don't need to configure the cards
27using isapnptools.
28
29
30Creating ALSA devices
31=====================
32
33This depends on your distribution, but normally you use the /dev/MAKEDEV
34script to create the necessary device nodes. On some systems you use a
35script named 'snddevices'.
36
37
38Module parameters
39=================
40
41The user can load modules with options. If the module supports more than
42one card and you have more than one card of the same type then you can
43specify multiple values for the option separated by commas.
44
45Prior to version 0.9.0rc4 options had a 'snd_' prefix. This was removed.
46
47 Module snd
48 ----------
49
50 The core ALSA module. It is used by all ALSA card drivers.
51 It takes the following options which have global effects.
52
53 major - major number for sound driver
54 - Default: 116
55 cards_limit
56 - limiting card index for auto-loading (1-8)
57 - Default: 1
58 - For auto-loading more than one card, specify this
59 option together with snd-card-X aliases.
Takashi Iwai304cd072007-10-26 15:10:15 +020060 slots - Reserve the slot index for the given driver.
61 This option takes multiple strings.
62 See "Module Autoloading Support" section for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
64 Module snd-pcm-oss
65 ------------------
66
67 The PCM OSS emulation module.
68 This module takes options which change the mapping of devices.
69
70 dsp_map - PCM device number maps assigned to the 1st OSS device.
71 - Default: 0
72 adsp_map - PCM device number maps assigned to the 2st OSS device.
73 - Default: 1
74 nonblock_open
Takashi Iwai62430082005-09-05 17:12:29 +020075 - Don't block opening busy PCM devices. Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77 For example, when dsp_map=2, /dev/dsp will be mapped to PCM #2 of
78 the card #0. Similarly, when adsp_map=0, /dev/adsp will be mapped
79 to PCM #0 of the card #0.
80 For changing the second or later card, specify the option with
81 commas, such like "dsp_map=0,1".
82
83 nonblock_open option is used to change the behavior of the PCM
84 regarding opening the device. When this option is non-zero,
85 opening a busy OSS PCM device won't be blocked but return
86 immediately with EAGAIN (just like O_NONBLOCK flag).
87
88 Module snd-rawmidi
89 ------------------
90
91 This module takes options which change the mapping of devices.
92 similar to those of the snd-pcm-oss module.
93
94 midi_map - MIDI device number maps assigned to the 1st OSS device.
95 - Default: 0
96 amidi_map - MIDI device number maps assigned to the 2st OSS device.
97 - Default: 1
98
99 Common parameters for top sound card modules
100 --------------------------------------------
101
102 Each of top level sound card module takes the following options.
103
104 index - index (slot #) of sound card
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100105 - Values: 0 through 31 or negative
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 - If nonnegative, assign that index number
107 - if negative, interpret as a bitmask of permissible
108 indices; the first free permitted index is assigned
109 - Default: -1
110 id - card ID (identifier or name)
111 - Can be up to 15 characters long
112 - Default: the card type
113 - A directory by this name is created under /proc/asound/
114 containing information about the card
115 - This ID can be used instead of the index number in
116 identifying the card
117 enable - enable card
118 - Default: enabled, for PCI and ISA PnP cards
119
Rene Hermancf40a312006-03-28 12:38:20 +0200120 Module snd-adlib
121 ----------------
122
123 Module for AdLib FM cards.
124
125 port - port # for OPL chip
126
127 This module supports multiple cards. It does not support autoprobe, so
128 the port must be specified. For actual AdLib FM cards it will be 0x388.
129 Note that this card does not have PCM support and no mixer; only FM
130 synthesis.
131
132 Make sure you have "sbiload" from the alsa-tools package available and,
133 after loading the module, find out the assigned ALSA sequencer port
134 number through "sbiload -l". Example output:
135
136 Port Client name Port name
137 64:0 OPL2 FM synth OPL2 FM Port
138
139 Load the std.sb and drums.sb patches also supplied by sbiload:
140
141 sbiload -p 64:0 std.sb drums.sb
142
143 If you use this driver to drive an OPL3, you can use std.o3 and drums.o3
144 instead. To have the card produce sound, use aplaymidi from alsa-utils:
145
146 aplaymidi -p 64:0 foo.mid
147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 Module snd-ad1816a
149 ------------------
150
151 Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips.
152
Takashi Iwai506d4c62005-08-03 14:02:47 +0200153 clockfreq - Clock frequency for AD1816A chip (default = 0, 33000Hz)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100155 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
157 Module snd-ad1848
158 -----------------
159
160 Module for sound cards based on AD1848/AD1847/CS4248 ISA chips.
161
162 port - port # for AD1848 chip
163 irq - IRQ # for AD1848 chip
164 dma1 - DMA # for AD1848 chip (0,1,3)
165
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100166 This module supports multiple cards. It does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 thus main port must be specified!!! Other ports are optional.
168
Takashi Iwaia4efc232005-11-17 17:24:26 +0100169 The power-management is supported.
170
Clemens Ladisch84010e62005-09-02 07:57:59 +0200171 Module snd-ad1889
172 -----------------
173
174 Module for Analog Devices AD1889 chips.
175
176 ac97_quirk - AC'97 workaround for strange hardware
177 See the description of intel8x0 module for details.
178
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100179 This module supports multiple cards.
Clemens Ladisch84010e62005-09-02 07:57:59 +0200180
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 Module snd-ali5451
182 ------------------
183
184 Module for ALi M5451 PCI chip.
185
186 pcm_channels - Number of hardware channels assigned for PCM
187 spdif - Support SPDIF I/O
188 - Default: disabled
189
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +0200190 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
192 The power-management is supported.
193
194 Module snd-als100
195 -----------------
196
197 Module for sound cards based on Avance Logic ALS100/ALS120 ISA chips.
198
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100199 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Takashi Iwaia4efc232005-11-17 17:24:26 +0100201 The power-management is supported.
202
Ash Willisb3a70d52006-03-27 13:20:40 +0200203 Module snd-als300
204 -----------------
205
206 Module for Avance Logic ALS300 and ALS300+
207
208 This module supports multiple cards.
209
210 The power-management is supported.
211
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 Module snd-als4000
213 ------------------
214
215 Module for sound cards based on Avance Logic ALS4000 PCI chip.
216
217 joystick_port - port # for legacy joystick support.
218 0 = disabled (default), 1 = auto-detect
219
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100220 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Takashi Iwaia4efc232005-11-17 17:24:26 +0100222 The power-management is supported.
223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 Module snd-atiixp
225 -----------------
226
Takashi Iwai62430082005-09-05 17:12:29 +0200227 Module for ATI IXP 150/200/250/400 AC97 controllers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Takashi Iwai62430082005-09-05 17:12:29 +0200229 ac97_clock - AC'97 clock (default = 48000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200231 See "AC97 Quirk Option" section below.
Dan Carpenter14e1d352006-11-20 16:35:18 +0100232 ac97_codec - Workaround to specify which AC'97 codec
233 instead of probing. If this works for you
234 file a bug with your `lspci -vn` output.
235 -2 -- Force probing.
236 -1 -- Default behavior.
237 0-2 -- Use the specified codec.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 spdif_aclink - S/PDIF transfer over AC-link (default = 1)
239
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200240 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
Takashi Iwai62430082005-09-05 17:12:29 +0200242 ATI IXP has two different methods to control SPDIF output. One is
243 over AC-link and another is over the "direct" SPDIF output. The
244 implementation depends on the motherboard, and you'll need to
245 choose the correct one via spdif_aclink module option.
246
Takashi Iwaia4efc232005-11-17 17:24:26 +0100247 The power-management is supported.
248
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 Module snd-atiixp-modem
250 -----------------------
251
252 Module for ATI IXP 150/200/250 AC97 modem controllers.
253
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200254 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
256 Note: The default index value of this module is -2, i.e. the first
257 slot is excluded.
258
Takashi Iwaia4efc232005-11-17 17:24:26 +0100259 The power-management is supported.
260
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 Module snd-au8810, snd-au8820, snd-au8830
262 -----------------------------------------
263
264 Module for Aureal Vortex, Vortex2 and Advantage device.
265
266 pcifix - Control PCI workarounds
267 0 = Disable all workarounds
268 1 = Force the PCI latency of the Aureal card to 0xff
269 2 = Force the Extend PCI#2 Internal Master for Efficient
270 Handling of Dummy Requests on the VIA KT133 AGP Bridge
271 3 = Force both settings
272 255 = Autodetect what is required (default)
273
274 This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
275 EQ, mpu401, gameport. A3D and wavetable support are still in development.
276 Development and reverse engineering work is being coordinated at
277 http://savannah.nongnu.org/projects/openvortex/
278 SPDIF output has a copy of the AC97 codec output, unless you use the
279 "spdif" pcm device, which allows raw data passthru.
280 The hardware EQ hardware and SPDIF is only present in the Vortex2 and
281 Advantage.
282
Takashi Iwai62430082005-09-05 17:12:29 +0200283 Note: Some ALSA mixer applications don't handle the SPDIF sample rate
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 control correctly. If you have problems regarding this, try
285 another ALSA compliant mixer (alsamixer works).
286
Takashi Iwai9e235322008-02-20 12:13:29 +0100287 Module snd-aw2
288 --------------
289
290 Module for Audiowerk2 sound card
291
292 This module supports multiple cards.
293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 Module snd-azt2320
295 ------------------
296
297 Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
298
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100299 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
Takashi Iwaia4efc232005-11-17 17:24:26 +0100301 The power-management is supported.
302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 Module snd-azt3328
304 ------------------
305
306 Module for sound cards based on Aztech AZF3328 PCI chip.
307
308 joystick - Enable joystick (default off)
309
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100310 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
312 Module snd-bt87x
313 ----------------
314
315 Module for video cards based on Bt87x chips.
316
317 digital_rate - Override the default digital rate (Hz)
318 load_all - Load the driver even if the card model isn't known
319
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100320 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
322 Note: The default index value of this module is -2, i.e. the first
323 slot is excluded.
324
325 Module snd-ca0106
326 -----------------
327
328 Module for Creative Audigy LS and SB Live 24bit
329
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100330 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
332
333 Module snd-cmi8330
334 ------------------
335
336 Module for sound cards based on C-Media CMI8330 ISA chips.
337
Rene Herman64e0e2d2007-12-13 16:29:33 +0100338 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
339
340 with isapnp=0, the following options are available:
341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 wssport - port # for CMI8330 chip (WSS)
343 wssirq - IRQ # for CMI8330 chip (WSS)
344 wssdma - first DMA # for CMI8330 chip (WSS)
345 sbport - port # for CMI8330 chip (SB16)
346 sbirq - IRQ # for CMI8330 chip (SB16)
347 sbdma8 - 8bit DMA # for CMI8330 chip (SB16)
348 sbdma16 - 16bit DMA # for CMI8330 chip (SB16)
Takashi Iwai9e128fd2009-01-29 11:49:10 +0100349 fmport - (optional) OPL3 I/O port
350 mpuport - (optional) MPU401 I/O port
351 mpuirq - (optional) MPU401 irq #
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100353 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
Takashi Iwaia4efc232005-11-17 17:24:26 +0100355 The power-management is supported.
356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 Module snd-cmipci
358 -----------------
359
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200360 Module for C-Media CMI8338/8738/8768/8770 PCI sound cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
Clemens Ladischc78c9502007-09-03 09:55:49 +0200362 mpu_port - port address of MIDI interface (8338 only):
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200363 0x300,0x310,0x320,0x330 = legacy port,
Takashi Iwaicab5c4c2006-05-04 14:36:08 +0200364 0 = disable (default)
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200365 fm_port - port address of OPL-3 FM synthesizer (8x38 only):
366 0x388 = legacy port,
367 1 = integrated PCI port (default on 8738),
Takashi Iwai2f24d1592007-02-15 18:56:43 +0100368 0 = disable
Takashi Iwai62430082005-09-05 17:12:29 +0200369 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 (default = 1)
371 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
372
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100373 This module supports autoprobe and multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
Takashi Iwaia4efc232005-11-17 17:24:26 +0100375 The power-management is supported.
376
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 Module snd-cs4231
378 -----------------
379
380 Module for sound cards based on CS4231 ISA chips.
381
382 port - port # for CS4231 chip
383 mpu_port - port # for MPU-401 UART (optional), -1 = disable
384 irq - IRQ # for CS4231 chip
385 mpu_irq - IRQ # for MPU-401 UART
386 dma1 - first DMA # for CS4231 chip
387 dma2 - second DMA # for CS4231 chip
388
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100389 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 thus main port must be specified!!! Other ports are optional.
391
392 The power-management is supported.
393
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 Module snd-cs4236
395 -----------------
396
Takashi Iwaic844a5d2009-02-16 23:17:33 +0100397 Module for sound cards based on CS4232/CS4232A,
398 CS4235/CS4236/CS4236B/CS4237B/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 CS4238B/CS4239 ISA chips.
400
Rene Herman64e0e2d2007-12-13 16:29:33 +0100401 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
402
403 with isapnp=0, the following options are available:
404
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 port - port # for CS4236 chip (PnP setup - 0x534)
406 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
407 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
408 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
409 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
410 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
411 dma1 - first DMA # for CS4236 chip (0,1,3)
412 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100414 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 (if ISA PnP is not used) thus main port and control port must be
416 specified!!! Other ports are optional.
417
418 The power-management is supported.
419
Takashi Iwaic844a5d2009-02-16 23:17:33 +0100420 This module is aliased as snd-cs4232 since it provides the old
421 snd-cs4232 functionality, too.
422
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 Module snd-cs4281
424 -----------------
425
426 Module for Cirrus Logic CS4281 soundchip.
427
428 dual_codec - Secondary codec ID (0 = disable, default)
429
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100430 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
432 The power-management is supported.
433
434 Module snd-cs46xx
435 -----------------
436
437 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
438 CS4624/CS4630/CS4280 PCI chips.
439
Takashi Iwai62430082005-09-05 17:12:29 +0200440 external_amp - Force to enable external amplifier.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 thinkpad - Force to enable Thinkpad's CLKRUN control.
442 mmap_valid - Support OSS mmap mode (default = 0).
443
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100444 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 Usually external amp and CLKRUN controls are detected automatically
446 from PCI sub vendor/device ids. If they don't work, give the options
447 above explicitly.
448
449 The power-management is supported.
Takashi Iwai621887a2007-05-24 18:46:54 +0200450
451 Module snd-cs5530
452 _________________
453
454 Module for Cyrix/NatSemi Geode 5530 chip.
455
Takashi Iwai3e873172005-11-17 10:15:37 +0100456 Module snd-cs5535audio
457 ----------------------
458
459 Module for multifunction CS5535 companion PCI device
460
Takashi Iwaic00bd742006-05-19 19:22:34 +0200461 The power-management is supported.
Takashi Iwai3e873172005-11-17 10:15:37 +0100462
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200463 Module snd-darla20
464 ------------------
465
466 Module for Echoaudio Darla20
467
468 This module supports multiple cards.
469 The driver requires the firmware loader support on kernel.
470
471 Module snd-darla24
472 ------------------
473
474 Module for Echoaudio Darla24
475
476 This module supports multiple cards.
477 The driver requires the firmware loader support on kernel.
478
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 Module snd-dt019x
480 -----------------
481
482 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
483 only)
484
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100485 This module supports multiple cards. This module is enabled only with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 ISA PnP support.
487
Takashi Iwaia4efc232005-11-17 17:24:26 +0100488 The power-management is supported.
489
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 Module snd-dummy
491 ----------------
492
493 Module for the dummy sound card. This "card" doesn't do any output
494 or input, but you may use this module for any application which
495 requires a sound card (like RealPlayer).
496
Takashi Iwaia4efc232005-11-17 17:24:26 +0100497 The power-management is supported.
498
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200499 Module snd-echo3g
500 -----------------
501
502 Module for Echoaudio 3G cards (Gina3G/Layla3G)
503
504 This module supports multiple cards.
505 The driver requires the firmware loader support on kernel.
506
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 Module snd-emu10k1
508 ------------------
509
510 Module for EMU10K1/EMU10k2 based PCI sound cards.
511 * Sound Blaster Live!
512 * Sound Blaster PCI 512
513 * Emu APS (partially supported)
514 * Sound Blaster Audigy
515
516 extin - bitmap of available external inputs for FX8010 (see bellow)
517 extout - bitmap of available external outputs for FX8010 (see bellow)
518 seq_ports - allocated sequencer ports (4 by default)
519 max_synth_voices - limit of voices used for wavetable (64 by default)
520 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
521 given in MB unit. Default value is 128.
522 enable_ir - enable IR
523
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100524 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
526 Input & Output configurations [extin/extout]
527 * Creative Card wo/Digital out [0x0003/0x1f03]
528 * Creative Card w/Digital out [0x0003/0x1f0f]
529 * Creative Card w/Digital CD in [0x000f/0x1f0f]
530 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
531 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
532 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
533 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
534 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
535 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
536 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
537 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
538 * Creative Card all ins and outs [0x3fff/0x7fff]
539
Takashi Iwaia4efc232005-11-17 17:24:26 +0100540 The power-management is supported.
541
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 Module snd-emu10k1x
543 -------------------
544
545 Module for Creative Emu10k1X (SB Live Dell OEM version)
546
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100547 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
549 Module snd-ens1370
550 ------------------
551
552 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
553 * SoundBlaster PCI 64
554 * SoundBlaster PCI 128
555
556 joystick - Enable joystick (default off)
557
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100558 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100560 The power-management is supported.
561
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 Module snd-ens1371
563 ------------------
564
565 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
566 * SoundBlaster PCI 64
567 * SoundBlaster PCI 128
568 * SoundBlaster Vibra PCI
569
570 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
571 0 = disable (default), 1 = auto-detect
572
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100573 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100575 The power-management is supported.
576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 Module snd-es968
578 ----------------
579
580 Module for sound cards based on ESS ES968 chip (PnP only).
581
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100582 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583
Takashi Iwaia4efc232005-11-17 17:24:26 +0100584 The power-management is supported.
585
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 Module snd-es1688
587 -----------------
588
589 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
590
591 port - port # for ES-1688 chip (0x220,0x240,0x260)
Takashi Iwai504a06d2009-01-30 19:59:10 +0100592 fm_port - port # for OPL3 (option; share the same port as default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
594 irq - IRQ # for ES-1688 chip (5,7,9,10)
595 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
596 dma8 - DMA # for ES-1688 chip (0,1,3)
597
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100598 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
600 Module snd-es18xx
601 -----------------
602
603 Module for ESS AudioDrive ES-18xx sound cards.
604
Rene Herman64e0e2d2007-12-13 16:29:33 +0100605 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
606
607 with isapnp=0, the following options are available:
608
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 port - port # for ES-18xx chip (0x220,0x240,0x260)
610 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
611 fm_port - port # for FM (optional, not used)
612 irq - IRQ # for ES-18xx chip (5,7,9,10)
613 dma1 - first DMA # for ES-18xx chip (0,1,3)
614 dma2 - first DMA # for ES-18xx chip (0,1,3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100616 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
617 port if native ISA PnP routines are not used).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 When dma2 is equal with dma1, the driver works as half-duplex.
619
620 The power-management is supported.
621
622 Module snd-es1938
623 -----------------
624
625 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
626
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100627 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
Takashi Iwaia4efc232005-11-17 17:24:26 +0100629 The power-management is supported.
630
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 Module snd-es1968
632 -----------------
633
634 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
635
636 total_bufsize - total buffer size in kB (1-4096kB)
637 pcm_substreams_p - playback channels (1-8, default=2)
638 pcm_substreams_c - capture channels (1-8, default=0)
639 clock - clock (0 = auto-detection)
640 use_pm - support the power-management (0 = off, 1 = on,
641 2 = auto (default))
642 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
643 joystick - enable joystick (default off)
644
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100645 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646
647 The power-management is supported.
648
649 Module snd-fm801
650 ----------------
651
652 Module for ForteMedia FM801 based PCI sound cards.
653
654 tea575x_tuner - Enable TEA575x tuner
655 - 1 = MediaForte 256-PCS
656 - 2 = MediaForte 256-PCPR
657 - 3 = MediaForte 64-PCR
658 - High 16-bits are video (radio) device number + 1
659 - example: 0x10002 (MediaForte 256-PCPR, device 1)
660
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100661 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662
Takashi Iwaia4efc232005-11-17 17:24:26 +0100663 The power-management is supported.
664
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200665 Module snd-gina20
666 -----------------
667
668 Module for Echoaudio Gina20
669
670 This module supports multiple cards.
671 The driver requires the firmware loader support on kernel.
672
673 Module snd-gina24
674 -----------------
675
676 Module for Echoaudio Gina24
677
678 This module supports multiple cards.
679 The driver requires the firmware loader support on kernel.
680
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 Module snd-gusclassic
682 ---------------------
683
684 Module for Gravis UltraSound Classic sound card.
685
686 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
687 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
688 dma1 - DMA # for GF1 chip (1,3,5,6,7)
689 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
690 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
691 voices - GF1 voices limit (14-32)
692 pcm_voices - reserved PCM voices
693
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100694 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695
696 Module snd-gusextreme
697 ---------------------
698
699 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
700
701 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
702 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
703 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
704 irq - IRQ # for ES-1688 chip (5,7,9,10)
705 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
706 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
707 dma8 - DMA # for ES-1688 chip (0,1,3)
708 dma1 - DMA # for GF1 chip (1,3,5,6,7)
709 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
710 voices - GF1 voices limit (14-32)
711 pcm_voices - reserved PCM voices
712
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100713 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
715 Module snd-gusmax
716 -----------------
717
718 Module for Gravis UltraSound MAX sound card.
719
720 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
721 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
722 dma1 - DMA # for GF1 chip (1,3,5,6,7)
723 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
724 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
725 voices - GF1 voices limit (14-32)
726 pcm_voices - reserved PCM voices
727
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100728 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729
730 Module snd-hda-intel
731 --------------------
732
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400733 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8, ICH9, ICH10,
734 PCH, SCH),
735 ATI SB450, SB600, R600, RS600, RS690, RS780, RV610, RV620,
736 RV630, RV635, RV670, RV770,
Takashi Iwai9b878192006-05-17 11:26:39 +0200737 VIA VT8251/VT8237A,
738 SIS966, ULI M5461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100740 [Multiple options for each card instance]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 model - force the model name
Takashi Iwaid2e1c972008-06-10 17:53:34 +0200742 position_fix - Fix DMA pointer (0 = auto, 1 = use LPIB, 2 = POSBUF)
Takashi Iwai95904742007-05-19 17:06:42 +0200743 probe_mask - Bitmask to probe codecs (default = -1, meaning all slots)
Takashi Iwaiae374d62009-02-13 08:33:55 +0100744 When the bit 8 (0x100) is set, the lower 8 bits are used
745 as the "fixed" codec slots; i.e. the driver probes the
746 slots regardless what hardware reports back
Takashi Iwaid4d9cd032008-12-19 15:19:11 +0100747 probe_only - Only probing and no codec initialization (default=off);
748 Useful to check the initial codec status for debugging
Takashi Iwai8c53b962008-06-10 17:53:35 +0200749 bdl_pos_adj - Specifies the DMA IRQ timing delay in samples.
750 Passing -1 will make the driver to choose the appropriate
751 value based on the controller chip.
Takashi Iwai1e7b8c82009-06-17 17:30:54 +0200752 patch - Specifies the early "patch" files to modify the HD-audio
753 setup before initializing the codecs. This option is
754 available only when CONFIG_SND_HDA_PATCH_LOADER=y is set.
755 See HD-Audio.txt for details.
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100756
757 [Single (global) options]
Takashi Iwai27346162006-01-12 18:28:44 +0100758 single_cmd - Use single immediate commands to communicate with
759 codecs (for debugging only)
Takashi Iwai134a11f2006-11-10 12:08:37 +0100760 enable_msi - Enable Message Signaled Interrupt (MSI) (default = off)
Takashi Iwaidee1b662007-08-13 16:10:30 +0200761 power_save - Automatic power-saving timtout (in second, 0 =
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200762 disable)
Takashi Iwaidee1b662007-08-13 16:10:30 +0200763 power_save_controller - Reset HD-audio controller in power-saving mode
764 (default = on)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100766 This module supports multiple cards and autoprobe.
767
Takashi Iwaicae51172008-12-19 08:36:53 +0100768 See Documentation/sound/alsa/HD-Audio.txt for more details about
769 HD-audio driver.
770
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 Each codec may have a model table for different configurations.
772 If your machine isn't listed there, the default (usually minimal)
773 configuration is set up. You can pass "model=<name>" option to
774 specify a certain model in such a case. There are different
Takashi Iwaicae51172008-12-19 08:36:53 +0100775 models depending on the codec chip. The list of available models
776 is found in HD-Audio-Models.txt
Takashi Iwaidb064e52006-03-16 16:04:58 +0100777
Takashi Iwai6d7b1d72007-02-26 15:56:46 +0100778 The model name "genric" is treated as a special case. When this
779 model is given, the driver uses the generic codec parser without
780 "codec-patch". It's sometimes good for testing and debugging.
781
Takashi Iwai62430082005-09-05 17:12:29 +0200782 If the default configuration doesn't work and one of the above
Takashi Iwai30bc4482008-12-09 08:23:45 +0100783 matches with your device, report it together with alsa-info.sh
784 output (with --no-upload option) to kernel bugzilla or alsa-devel
Takashi Iwai62430082005-09-05 17:12:29 +0200785 ML (see the section "Links and Addresses").
786
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200787 power_save and power_save_controller options are for power-saving
788 mode. See powersave.txt for details.
Takashi Iwaidee1b662007-08-13 16:10:30 +0200789
Takashi Iwaic74db862005-05-12 14:26:27 +0200790 Note 2: If you get click noises on output, try the module option
791 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
792 register value without FIFO size correction as the current
793 DMA pointer. position_fix=2 will make the driver to use
794 the position buffer instead of reading SD_LPIB register.
Michael Kerrisk90f31e32008-09-01 14:03:50 +0200795 (Usually SD_LPIB register is more accurate than the
Takashi Iwaic74db862005-05-12 14:26:27 +0200796 position buffer.)
797
Takashi Iwai27346162006-01-12 18:28:44 +0100798 NB: If you get many "azx_get_response timeout" messages at
799 loading, it's likely a problem of interrupts (e.g. ACPI irq
800 routing). Try to boot with options like "pci=noacpi". Also, you
801 can try "single_cmd=1" module option. This will switch the
802 communication method between HDA controller and codecs to the
803 single immediate commands instead of CORB/RIRB. Basically, the
804 single command mode is provided only for BIOS, and you won't get
805 unsolicited events, too. But, at least, this works independently
806 from the irq. Remember this is a last resort, and should be
807 avoided as much as possible...
808
Takashi Iwai95904742007-05-19 17:06:42 +0200809 MORE NOTES ON "azx_get_response timeout" PROBLEMS:
810 On some hardwares, you may need to add a proper probe_mask option
811 to avoid the "azx_get_response timeout" problem above, instead.
812 This occurs when the access to non-existing or non-working codec slot
813 (likely a modem one) causes a stall of the communication via HD-audio
814 bus. You can see which codec slots are probed by enabling
Takashi Iwai62cf8722008-05-20 12:15:15 +0200815 CONFIG_SND_DEBUG_VERBOSE, or simply from the file name of the codec
Takashi Iwai95904742007-05-19 17:06:42 +0200816 proc files. Then limit the slots to probe by probe_mask option.
817 For example, probe_mask=1 means to probe only the first slot, and
818 probe_mask=4 means only the third slot.
819
Takashi Iwaia4efc232005-11-17 17:24:26 +0100820 The power-management is supported.
821
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 Module snd-hdsp
823 ---------------
824
825 Module for RME Hammerfall DSP audio interface(s)
826
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100827 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828
829 Note: The firmware data can be automatically loaded via hotplug
830 when CONFIG_FW_LOADER is set. Otherwise, you need to load
831 the firmware via hdsploader utility included in alsa-tools
832 package.
833 The firmware data is found in alsa-firmware package.
834
835 Note: snd-page-alloc module does the job which snd-hammerfall-mem
836 module did formerly. It will allocate the buffers in advance
837 when any HDSP cards are found. To make the buffer
838 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +0200839 stage of boot sequence. See "Early Buffer Allocation"
840 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841
Takashi Iwai54704402005-06-03 11:27:00 +0200842 Module snd-hdspm
843 ----------------
844
845 Module for RME HDSP MADI board.
846
847 precise_ptr - Enable precise pointer, or disable.
848 line_outs_monitor - Send playback streams to analog outs by default.
849 enable_monitor - Enable Analog Out on Channel 63/64 by default.
850
851 See hdspm.txt for details.
852
Clemens Ladischc6260262008-01-25 08:41:52 +0100853 Module snd-hifier
854 -----------------
855
856 Module for the MediaTek/TempoTec HiFier Fantasia sound card.
857
858 This module supports autoprobe and multiple cards.
859
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 Module snd-ice1712
861 ------------------
862
863 Module for Envy24 (ICE1712) based PCI sound cards.
864 * MidiMan M Audio Delta 1010
865 * MidiMan M Audio Delta 1010LT
866 * MidiMan M Audio Delta DiO 2496
867 * MidiMan M Audio Delta 66
868 * MidiMan M Audio Delta 44
869 * MidiMan M Audio Delta 410
870 * MidiMan M Audio Audiophile 2496
871 * TerraTec EWS 88MT
872 * TerraTec EWS 88D
873 * TerraTec EWX 24/96
874 * TerraTec DMX 6Fire
Takashi Iwaic9bce912005-05-24 13:41:03 +0200875 * TerraTec Phase 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 * Hoontech SoundTrack DSP 24
877 * Hoontech SoundTrack DSP 24 Value
878 * Hoontech SoundTrack DSP 24 Media 7.1
Takashi Iwaic9bce912005-05-24 13:41:03 +0200879 * Event Electronics, EZ8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 * Digigram VX442
Takashi Iwaic9bce912005-05-24 13:41:03 +0200881 * Lionstracs, Mediastaton
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400882 * Terrasoniq TS 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883
884 model - Use the given board model, one of the following:
885 delta1010, dio2496, delta66, delta44, audiophile, delta410,
886 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
Takashi Iwaic9bce912005-05-24 13:41:03 +0200887 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
888 phase88, mediastation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 omni - Omni I/O support for MidiMan M-Audio Delta44/66
Matt LaPlantefa00e7e2006-11-30 04:55:36 +0100890 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transceiver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891 in msec resolution, default value is 500 (0.5 sec)
892
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100893 This module supports multiple cards and autoprobe. Note: The consumer part
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 is not used with all Envy24 based cards (for example in the MidiMan Delta
895 serie).
896
Takashi Iwaic9bce912005-05-24 13:41:03 +0200897 Note: The supported board is detected by reading EEPROM or PCI
898 SSID (if EEPROM isn't available). You can override the
899 model by passing "model" module option in case that the
900 driver isn't configured properly or you want to try another
901 type for testing.
902
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 Module snd-ice1724
904 ------------------
905
Takashi Iwaic9bce912005-05-24 13:41:03 +0200906 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100907 * MidiMan M Audio Revolution 5.1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 * MidiMan M Audio Revolution 7.1
Takashi Iwai56255062006-11-09 16:47:26 +0100909 * MidiMan M Audio Audiophile 192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 * AMP Ltd AUDIO2000
Takashi Iwaic9bce912005-05-24 13:41:03 +0200911 * TerraTec Aureon 5.1 Sky
912 * TerraTec Aureon 7.1 Space
913 * TerraTec Aureon 7.1 Universe
914 * TerraTec Phase 22
915 * TerraTec Phase 28
916 * AudioTrak Prodigy 7.1
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400917 * AudioTrak Prodigy 7.1 LT
918 * AudioTrak Prodigy 7.1 XT
919 * AudioTrak Prodigy 7.1 HIFI
920 * AudioTrak Prodigy 7.1 HD2
Takashi Iwaic9bce912005-05-24 13:41:03 +0200921 * AudioTrak Prodigy 192
922 * Pontis MS300
923 * Albatron K8X800 Pro II
924 * Chaintech ZNF3-150
925 * Chaintech ZNF3-250
926 * Chaintech 9CJS
Takashi Iwai8cfbbac2005-05-27 12:10:40 +0200927 * Chaintech AV-710
Takashi Iwaic9bce912005-05-24 13:41:03 +0200928 * Shuttle SN25P
Shin-ya Okadaf31639b2007-10-23 15:08:18 +0200929 * Onkyo SE-90PCI
930 * Onkyo SE-200PCI
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400931 * ESI Juli@
932 * Hercules Fortissimo IV
933 * EGO-SYS WaveTerminal 192M
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934
935 model - Use the given board model, one of the following:
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100936 revo51, revo71, amp2000, prodigy71, prodigy71lt,
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400937 prodigy71xt, prodigy71hifi, prodigyhd2, prodigy192,
938 juli, aureon51, aureon71, universe, ap192, k8x800,
939 phase22, phase28, ms300, av710, se200pci, se90pci,
940 fortissimo4, sn25p, WT192M
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100942 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943
Takashi Iwaic9bce912005-05-24 13:41:03 +0200944 Note: The supported board is detected by reading EEPROM or PCI
945 SSID (if EEPROM isn't available). You can override the
946 model by passing "model" module option in case that the
947 driver isn't configured properly or you want to try another
948 type for testing.
949
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200950 Module snd-indigo
951 -----------------
952
953 Module for Echoaudio Indigo
954
955 This module supports multiple cards.
956 The driver requires the firmware loader support on kernel.
957
958 Module snd-indigodj
959 -------------------
960
961 Module for Echoaudio Indigo DJ
962
963 This module supports multiple cards.
964 The driver requires the firmware loader support on kernel.
965
966 Module snd-indigoio
967 -------------------
968
969 Module for Echoaudio Indigo IO
970
971 This module supports multiple cards.
972 The driver requires the firmware loader support on kernel.
973
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 Module snd-intel8x0
975 -------------------
976
977 Module for AC'97 motherboards from Intel and compatibles.
978 * Intel i810/810E, i815, i820, i830, i84x, MX440
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400979 ICH5, ICH6, ICH7, 6300ESB, ESB2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 * SiS 7012 (SiS 735)
Takashi Iwai89ac9c22006-01-24 10:36:57 +0100981 * NVidia NForce, NForce2, NForce3, MCP04, CK804
982 CK8, CK8S, MCP501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 * AMD AMD768, AMD8111
984 * ALi m5455
985
986 ac97_clock - AC'97 codec clock base (0 = auto-detect)
987 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200988 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 buggy_irq - Enable workaround for buggy interrupts on some
Takashi Iwaia06147d2005-09-08 19:54:17 +0200990 motherboards (default yes on nForce chips,
991 otherwise off)
992 buggy_semaphore - Enable workaround for hardwares with buggy
993 semaphores (e.g. on some ASUS laptops)
994 (default off)
Takashi Iwai6c5cfd92006-11-28 17:18:25 +0100995 spdif_aclink - Use S/PDIF over AC-link instead of direct connection
996 from the controller chip
997 (0 = off, 1 = on, -1 = default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200999 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000
1001 Note: the latest driver supports auto-detection of chip clock.
1002 if you still encounter too fast playback, specify the clock
1003 explicitly via the module option "ac97_clock=41194".
1004
1005 Joystick/MIDI ports are not supported by this driver. If your
1006 motherboard has these devices, use the ns558 or snd-mpu401
1007 modules, respectively.
1008
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 The power-management is supported.
1010
1011 Module snd-intel8x0m
1012 --------------------
1013
1014 Module for Intel ICH (i8x0) chipset MC97 modems.
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001015 * Intel i810/810E, i815, i820, i830, i84x, MX440
1016 ICH5, ICH6, ICH7
1017 * SiS 7013 (SiS 735)
1018 * NVidia NForce, NForce2, NForce2s, NForce3
1019 * AMD AMD8111
1020 * ALi m5455
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021
1022 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1023
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001024 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025
1026 Note: The default index value of this module is -2, i.e. the first
1027 slot is excluded.
1028
Takashi Iwaia4efc232005-11-17 17:24:26 +01001029 The power-management is supported.
1030
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 Module snd-interwave
1032 --------------------
1033
1034 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1035 and other sound cards based on AMD InterWave (tm) chip.
1036
Linus Torvalds1da177e2005-04-16 15:20:36 -07001037 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1038 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1039 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1040 effect - 1 = InterWave effects enable (default 0);
1041 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001042 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1043
1044 with isapnp=0, the following options are available:
1045
1046 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1047 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1048 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1049 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001051 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052
1053 Module snd-interwave-stb
1054 ------------------------
1055
1056 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1057 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1058 circuit for extended control of bass, treble and master volume.
1059
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1061 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1062 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1063 effect - 1 = InterWave effects enable (default 0);
1064 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001065 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1066
1067 with isapnp=0, the following options are available:
1068
1069 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1070 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1071 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1072 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1073 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001075 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076
1077 Module snd-korg1212
1078 -------------------
1079
1080 Module for Korg 1212 IO PCI card
1081
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001082 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001084 Module snd-layla20
1085 ------------------
1086
1087 Module for Echoaudio Layla20
1088
1089 This module supports multiple cards.
1090 The driver requires the firmware loader support on kernel.
1091
1092 Module snd-layla24
1093 ------------------
1094
1095 Module for Echoaudio Layla24
1096
1097 This module supports multiple cards.
1098 The driver requires the firmware loader support on kernel.
1099
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 Module snd-maestro3
1101 -------------------
1102
1103 Module for Allegro/Maestro3 chips
1104
1105 external_amp - enable external amp (enabled by default)
1106 amp_gpio - GPIO pin number for external amp (0-15) or
1107 -1 for default pin (8 for allegro, 1 for
1108 others)
1109
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001110 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111
1112 Note: the binding of amplifier is dependent on hardware.
1113 If there is no sound even though all channels are unmuted, try to
1114 specify other gpio connection via amp_gpio option.
1115 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1116 option.
1117
1118 The power-management is supported.
1119
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001120 Module snd-mia
1121 ---------------
1122
1123 Module for Echoaudio Mia
1124
1125 This module supports multiple cards.
1126 The driver requires the firmware loader support on kernel.
1127
Martin Langer1841f6132006-03-27 12:41:01 +02001128 Module snd-miro
1129 ---------------
1130
1131 Module for Miro soundcards: miroSOUND PCM 1 pro,
1132 miroSOUND PCM 12,
1133 miroSOUND PCM 20 Radio.
1134
1135 port - Port # (0x530,0x604,0xe80,0xf40)
1136 irq - IRQ # (5,7,9,10,11)
1137 dma1 - 1st dma # (0,1,3)
1138 dma2 - 2nd dma # (0,1)
1139 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1140 mpu_irq - MPU-401 irq # (5,7,9,10)
1141 fm_port - FM Port # (0x388)
1142 wss - enable WSS mode
1143 ide - enable onboard ide support
1144
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 Module snd-mixart
1146 -----------------
1147
1148 Module for Digigram miXart8 sound cards.
1149
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001150 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 Note: One miXart8 board will be represented as 4 alsa cards.
1152 See MIXART.txt for details.
1153
1154 When the driver is compiled as a module and the hotplug firmware
1155 is supported, the firmware data is loaded via hotplug automatically.
1156 Install the necessary firmware files in alsa-firmware package.
1157 When no hotplug fw loader is available, you need to load the
1158 firmware via mixartloader utility in alsa-tools package.
1159
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001160 Module snd-mona
1161 ---------------
1162
1163 Module for Echoaudio Mona
1164
1165 This module supports multiple cards.
1166 The driver requires the firmware loader support on kernel.
1167
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 Module snd-mpu401
1169 -----------------
1170
1171 Module for MPU-401 UART devices.
1172
1173 port - port number or -1 (disable)
1174 irq - IRQ number or -1 (disable)
1175 pnp - PnP detection - 0 = disable, 1 = enable (default)
1176
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001177 This module supports multiple devices and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178
Takashi Iwaic96330b2009-01-28 08:23:03 +01001179 Module snd-msnd-classic
1180 -----------------------
1181
1182 Module for Turtle Beach MultiSound Classic, Tahiti or Monterey
1183 soundcards.
1184
1185 io - Port # for msnd-classic card
1186 irq - IRQ # for msnd-classic card
1187 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1188 0xe0000 or 0xe8000)
1189 write_ndelay - enable write ndelay (default = 1)
1190 calibrate_signal - calibrate signal (default = 0)
1191 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1192 digital - Digital daughterboard present (default = 0)
1193 cfg - Config port (0x250, 0x260 or 0x270) default = PnP
1194 reset - Reset all devices
1195 mpu_io - MPU401 I/O port
1196 mpu_irq - MPU401 irq#
1197 ide_io0 - IDE port #0
1198 ide_io1 - IDE port #1
1199 ide_irq - IDE irq#
1200 joystick_io - Joystick I/O port
1201
1202 The driver requires firmware files "turtlebeach/msndinit.bin" and
1203 "turtlebeach/msndperm.bin" in the proper firmware directory.
1204
1205 See Documentation/sound/oss/MultiSound for important information
1206 about this driver. Note that it has been discontinued, but the
1207 Voyetra Turtle Beach knowledge base entry for it is still available
1208 at
1209 http://www.turtlebeach.com/site/kb_ftp/790.asp
1210
1211 Module snd-msnd-pinnacle
1212 ------------------------
1213
1214 Module for Turtle Beach MultiSound Pinnacle/Fiji soundcards.
1215
1216 io - Port # for pinnacle/fiji card
1217 irq - IRQ # for pinnalce/fiji card
1218 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1219 0xe0000 or 0xe8000)
1220 write_ndelay - enable write ndelay (default = 1)
1221 calibrate_signal - calibrate signal (default = 0)
1222 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1223
1224 The driver requires firmware files "turtlebeach/pndspini.bin" and
1225 "turtlebeach/pndsperm.bin" in the proper firmware directory.
1226
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227 Module snd-mtpav
1228 ----------------
1229
1230 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1231 port).
1232
1233 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1234 irq - IRQ # for MTPAV (7,5, default=7)
1235 hwports - number of supported hardware ports, default=8.
1236
1237 Module supports only 1 card. This module has no enable option.
1238
Matthias Koenig68ab8012006-07-27 16:59:23 +02001239 Module snd-mts64
1240 ----------------
1241
1242 Module for Ego Systems (ESI) Miditerminal 4140
1243
1244 This module supports multiple devices.
1245 Requires parport (CONFIG_PARPORT).
1246
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 Module snd-nm256
1248 ----------------
1249
1250 Module for NeoMagic NM256AV/ZX chips
1251
1252 playback_bufsize - max playback frame size in kB (4-128kB)
1253 capture_bufsize - max capture frame size in kB (4-128kB)
1254 force_ac97 - 0 or 1 (disabled by default)
1255 buffer_top - specify buffer top address
1256 use_cache - 0 or 1 (disabled by default)
1257 vaio_hack - alias buffer_top=0x25a800
1258 reset_workaround - enable AC97 RESET workaround for some laptops
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001259 reset_workaround2 - enable extended AC97 RESET workaround for some
1260 other laptops
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +02001262 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263
1264 The power-management is supported.
1265
1266 Note: on some notebooks the buffer address cannot be detected
1267 automatically, or causes hang-up during initialization.
Matt LaPlantefff92892006-10-03 22:47:42 +02001268 In such a case, specify the buffer top address explicitly via
1269 the buffer_top option.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 For example,
1271 Sony F250: buffer_top=0x25a800
1272 Sony F270: buffer_top=0x272800
1273 The driver supports only ac97 codec. It's possible to force
1274 to initialize/use ac97 although it's not detected. In such a
1275 case, use force_ac97=1 option - but *NO* guarantee whether it
1276 works!
1277
1278 Note: The NM256 chip can be linked internally with non-AC97
1279 codecs. This driver supports only the AC97 codec, and won't work
1280 with machines with other (most likely CS423x or OPL3SAx) chips,
1281 even though the device is detected in lspci. In such a case, try
1282 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
Takashi Iwai62430082005-09-05 17:12:29 +02001283 but some doesn't have ISA PnP. You'll need to specify isapnp=0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 and proper hardware parameters in the case without ISA PnP.
1285
1286 Note: some laptops need a workaround for AC97 RESET. For the
1287 known hardware like Dell Latitude LS and Sony PCG-F305, this
1288 workaround is enabled automatically. For other laptops with a
1289 hard freeze, you can try reset_workaround=1 option.
1290
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001291 Note: Dell Latitude CSx laptops have another problem regarding
1292 AC97 RESET. On these laptops, reset_workaround2 option is
1293 turned on as default. This option is worth to try if the
1294 previous reset_workaround option doesn't help.
1295
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 Note: This driver is really crappy. It's a porting from the
1297 OSS driver, which is a result of black-magic reverse engineering.
1298 The detection of codec will fail if the driver is loaded *after*
1299 X-server as described above. You might be able to force to load
1300 the module, but it may result in hang-up. Hence, make sure that
1301 you load this module *before* X if you encounter this kind of
1302 problem.
1303
1304 Module snd-opl3sa2
1305 ------------------
1306
1307 Module for Yamaha OPL3-SA2/SA3 sound cards.
1308
Rene Herman64e0e2d2007-12-13 16:29:33 +01001309 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1310
1311 with isapnp=0, the following options are available:
1312
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 port - control port # for OPL3-SA chip (0x370)
1314 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1315 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1316 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1317 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1318 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1319 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1320 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001322 This module supports multiple cards and ISA PnP. It does not support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1324
1325 The power-management is supported.
1326
1327 Module snd-opti92x-ad1848
1328 -------------------------
1329
1330 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1331 Module works with OAK Mozart cards as well.
1332
Rene Herman64e0e2d2007-12-13 16:29:33 +01001333 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1334
1335 with isapnp=0, the following options are available:
1336
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1338 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1339 fm_port - port # for OPL3 device (0x388)
1340 irq - IRQ # for WSS chip (5,7,9,10,11)
1341 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1342 dma1 - first DMA # for WSS chip (0,1,3)
1343
1344 This module supports only one card, autoprobe and PnP.
1345
1346 Module snd-opti92x-cs4231
1347 -------------------------
1348
1349 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1350
Rene Herman64e0e2d2007-12-13 16:29:33 +01001351 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1352
1353 with isapnp=0, the following options are available:
1354
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1356 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1357 fm_port - port # for OPL3 device (0x388)
1358 irq - IRQ # for WSS chip (5,7,9,10,11)
1359 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1360 dma1 - first DMA # for WSS chip (0,1,3)
1361 dma2 - second DMA # for WSS chip (0,1,3)
1362
1363 This module supports only one card, autoprobe and PnP.
1364
1365 Module snd-opti93x
1366 ------------------
1367
1368 Module for sound cards based on OPTi 82c93x chips.
1369
Rene Herman64e0e2d2007-12-13 16:29:33 +01001370 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1371
1372 with isapnp=0, the following options are available:
1373
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1375 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1376 fm_port - port # for OPL3 device (0x388)
1377 irq - IRQ # for WSS chip (5,7,9,10,11)
1378 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1379 dma1 - first DMA # for WSS chip (0,1,3)
1380 dma2 - second DMA # for WSS chip (0,1,3)
1381
1382 This module supports only one card, autoprobe and PnP.
1383
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001384 Module snd-oxygen
1385 -----------------
1386
1387 Module for sound cards based on the C-Media CMI8788 chip:
1388 * Asound A-8788
1389 * AuzenTech X-Meridian
1390 * Bgears b-Enspirer
1391 * Club3D Theatron DTS
Clemens Ladischde04b102008-11-26 10:37:23 +01001392 * HT-Omega Claro (plus)
1393 * HT-Omega Claro halo (XT)
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001394 * Razer Barracuda AC-1
1395 * Sondigo Inferno
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001396
1397 This module supports autoprobe and multiple cards.
1398
Stas Sergeevd08cd582008-03-06 11:01:44 +01001399 Module snd-pcsp
1400 -----------------
1401
1402 Module for internal PC-Speaker.
1403
1404 nforce_wa - enable NForce chipset workaround. Expect bad sound.
1405
1406 This module supports system beeps, some kind of PCM playback and
1407 even a few mixer controls.
1408
Markus Bollingere12229b2005-12-06 13:55:26 +01001409 Module snd-pcxhr
1410 ----------------
1411
1412 Module for Digigram PCXHR boards
1413
1414 This module supports multiple cards.
1415
Matthias Koenig757e1192007-01-25 13:15:05 +01001416 Module snd-portman2x4
1417 ---------------------
1418
1419 Module for Midiman Portman 2x4 parallel port MIDI interface
1420
1421 This module supports multiple cards.
1422
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 Module snd-powermac (on ppc only)
1424 ---------------------------------
1425
1426 Module for PowerMac, iMac and iBook on-board soundchips
1427
1428 enable_beep - enable beep using PCM (enabled as default)
1429
1430 Module supports autoprobe a chip.
1431
1432 Note: the driver may have problems regarding endianess.
1433
1434 The power-management is supported.
1435
Takashi Iwai2c484df2005-06-30 18:54:04 +02001436 Module snd-pxa2xx-ac97 (on arm only)
1437 ------------------------------------
1438
1439 Module for AC97 driver for the Intel PXA2xx chip
1440
1441 For ARM architecture only.
1442
Takashi Iwaia4efc232005-11-17 17:24:26 +01001443 The power-management is supported.
1444
Peter Gruber109a9632006-03-27 13:10:28 +02001445 Module snd-riptide
1446 ------------------
1447
1448 Module for Conexant Riptide chip
1449
1450 joystick_port - Joystick port # (default: 0x200)
1451 mpu_port - MPU401 port # (default: 0x330)
1452 opl3_port - OPL3 port # (default: 0x388)
1453
1454 This module supports multiple cards.
1455 The driver requires the firmware loader support on kernel.
1456 You need to install the firmware file "riptide.hex" to the standard
1457 firmware path (e.g. /lib/firmware).
1458
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459 Module snd-rme32
1460 ----------------
1461
1462 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1463 Prodif96 and Prodif Gold) sound cards.
1464
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001465 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466
1467 Module snd-rme96
1468 ----------------
1469
1470 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1471
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001472 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473
1474 Module snd-rme9652
1475 ------------------
1476
1477 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1478
1479 precise_ptr - Enable precise pointer (doesn't work reliably).
1480 (default = 0)
1481
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001482 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483
1484 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1485 module did formerly. It will allocate the buffers in advance
1486 when any RME9652 cards are found. To make the buffer
1487 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +02001488 stage of boot sequence. See "Early Buffer Allocation"
1489 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490
1491 Module snd-sa11xx-uda1341 (on arm only)
1492 ---------------------------------------
1493
1494 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1495
1496 Module supports only one card.
1497 Module has no enable and index options.
1498
Takashi Iwaia4efc232005-11-17 17:24:26 +01001499 The power-management is supported.
1500
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 Module snd-sb8
1502 --------------
1503
1504 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1505 SoundBlaster 2.0,
1506 SoundBlaster Pro
1507
1508 port - port # for SB DSP chip (0x220,0x240,0x260)
1509 irq - IRQ # for SB DSP chip (5,7,9,10)
1510 dma8 - DMA # for SB DSP chip (1,3)
1511
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001512 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513
Takashi Iwaia4efc232005-11-17 17:24:26 +01001514 The power-management is supported.
1515
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 Module snd-sb16 and snd-sbawe
1517 -----------------------------
1518
1519 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1520 SoundBlaster AWE 32 (PnP),
1521 SoundBlaster AWE 64 PnP
1522
Rene Herman64e0e2d2007-12-13 16:29:33 +01001523 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1524 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1525 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1526
1527 with isapnp=0, the following options are available:
1528
Linus Torvalds1da177e2005-04-16 15:20:36 -07001529 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1530 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1531 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1532 (snd-sbawe module only)
1533 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1534 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1535 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001537 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538
1539 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1540 disable 16bit DMA with dma16 = -1 module parameter.
1541 Also, all Sound Blaster 16 type cards can operate in 16-bit
1542 half duplex mode through 8-bit DMA channel by disabling their
1543 16-bit DMA channel.
1544
Takashi Iwaia4efc232005-11-17 17:24:26 +01001545 The power-management is supported.
1546
Takashi Iwai074a6e92007-09-11 22:10:14 +02001547 Module snd-sc6000
1548 -----------------
1549
1550 Module for Gallant SC-6000 soundcard.
1551
1552 port - Port # (0x220 or 0x240)
1553 mss_port - MSS Port # (0x530 or 0xe80)
1554 irq - IRQ # (5,7,9,10,11)
Krzysztof Helt7b758d22007-09-17 14:42:49 +02001555 mpu_irq - MPU-401 IRQ # (5,7,9,10) ,0 - no MPU-401 irq
Takashi Iwai074a6e92007-09-11 22:10:14 +02001556 dma - DMA # (1,3,0)
1557
1558 This module supports multiple cards.
1559
1560 This card is also known as Audio Excel DSP 16 or Zoltrix AV302.
1561
Linus Torvalds1da177e2005-04-16 15:20:36 -07001562 Module snd-sgalaxy
1563 ------------------
1564
1565 Module for Aztech Sound Galaxy sound card.
1566
1567 sbport - Port # for SB16 interface (0x220,0x240)
1568 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1569 irq - IRQ # (7,9,10,11)
1570 dma1 - DMA #
1571
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001572 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573
Takashi Iwaia4efc232005-11-17 17:24:26 +01001574 The power-management is supported.
1575
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 Module snd-sscape
1577 -----------------
1578
1579 Module for ENSONIQ SoundScape PnP cards.
1580
1581 port - Port # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001582 wss_port - WSS Port # (PnP setup)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583 irq - IRQ # (PnP setup)
1584 mpu_irq - MPU-401 IRQ # (PnP setup)
1585 dma - DMA # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001586 dma2 - 2nd DMA # (PnP setup, -1 to disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001588 This module supports multiple cards. ISA PnP must be enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001589 You need sscape_ctl tool in alsa-tools package for loading
1590 the microcode.
1591
1592 Module snd-sun-amd7930 (on sparc only)
1593 --------------------------------------
1594
1595 Module for AMD7930 sound chips found on Sparcs.
1596
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001597 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598
1599 Module snd-sun-cs4231 (on sparc only)
1600 -------------------------------------
1601
1602 Module for CS4231 sound chips found on Sparcs.
1603
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001604 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001606 Module snd-sun-dbri (on sparc only)
1607 -----------------------------------
1608
1609 Module for DBRI sound chips found on Sparcs.
1610
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001611 This module supports multiple cards.
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001612
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 Module snd-wavefront
1614 --------------------
1615
1616 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1617
Rene Herman64e0e2d2007-12-13 16:29:33 +01001618 use_cs4232_midi - Use CS4232 MPU-401 interface
1619 (inaccessibly located inside your computer)
1620 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1621
1622 with isapnp=0, the following options are available:
1623
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 cs4232_pcm_port - Port # for CS4232 PCM interface.
1625 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1626 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1627 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 ics2115_port - Port # for ICS2115
1629 ics2115_irq - IRQ # for ICS2115
1630 fm_port - FM OPL-3 Port #
1631 dma1 - DMA1 # for CS4232 PCM interface.
1632 dma2 - DMA2 # for CS4232 PCM interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633
Takashi Iwaic2b12392007-08-21 15:20:26 +02001634 The below are options for wavefront_synth features:
1635 wf_raw - Assume that we need to boot the OS (default:no)
1636 If yes, then during driver loading, the state of the board is
1637 ignored, and we reset the board and load the firmware anyway.
1638 fx_raw - Assume that the FX process needs help (default:yes)
1639 If false, we'll leave the FX processor in whatever state it is
1640 when the driver is loaded. The default is to download the
1641 microprogram and associated coefficients to set it up for
1642 "default" operation, whatever that means.
1643 debug_default - Debug parameters for card initialization
1644 wait_usecs - How long to wait without sleeping, usecs
1645 (default:150)
1646 This magic number seems to give pretty optimal throughput
1647 based on my limited experimentation.
1648 If you want to play around with it and find a better value, be
1649 my guest. Remember, the idea is to get a number that causes us
1650 to just busy wait for as many WaveFront commands as possible,
1651 without coming up with a number so large that we hog the whole
1652 CPU.
1653 Specifically, with this number, out of about 134,000 status
1654 waits, only about 250 result in a sleep.
1655 sleep_interval - How long to sleep when waiting for reply
1656 (default: 100)
1657 sleep_tries - How many times to try sleeping during a wait
1658 (default: 50)
1659 ospath - Pathname to processed ICS2115 OS firmware
1660 (default:wavefront.os)
1661 The path name of the ISC2115 OS firmware. In the recent
1662 version, it's handled via firmware loader framework, so it
1663 must be installed in the proper path, typically,
1664 /lib/firmware.
1665 reset_time - How long to wait for a reset to take effect
1666 (default:2)
1667 ramcheck_time - How many seconds to wait for the RAM test
1668 (default:20)
1669 osrun_time - How many seconds to wait for the ICS2115 OS
1670 (default:10)
1671
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001672 This module supports multiple cards and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673
Takashi Iwaic2b12392007-08-21 15:20:26 +02001674 Note: the firmware file "wavefront.os" was located in the earlier
1675 version in /etc. Now it's loaded via firmware loader, and
1676 must be in the proper firmware path, such as /lib/firmware.
1677 Copy (or symlink) the file appropriately if you get an error
1678 regarding firmware downloading after upgrading the kernel.
1679
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 Module snd-sonicvibes
1681 ---------------------
1682
1683 Module for S3 SonicVibes PCI sound cards.
1684 * PINE Schubert 32 PCI
1685
1686 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1687 - SoundCard must have onboard SRAM for this.
1688 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1689
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001690 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691
1692 Module snd-serial-u16550
1693 ------------------------
1694
1695 Module for UART16550A serial MIDI ports.
1696
1697 port - port # for UART16550A chip
1698 irq - IRQ # for UART16550A chip, -1 = poll mode
1699 speed - speed in bauds (9600,19200,38400,57600,115200)
1700 38400 = default
1701 base - base for divisor in bauds (57600,115200,230400,460800)
1702 115200 = default
1703 outs - number of MIDI ports in a serial port (1-4)
1704 1 = default
1705 adaptor - Type of adaptor.
1706 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1707 3 = MS-124W M/B, 4 = Generic
1708
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001709 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710 thus the main port must be specified!!! Other options are optional.
1711
1712 Module snd-trident
1713 ------------------
1714
1715 Module for Trident 4DWave DX/NX sound cards.
1716 * Best Union Miss Melody 4DWave PCI
1717 * HIS 4DWave PCI
1718 * Warpspeed ONSpeed 4DWave PCI
1719 * AzTech PCI 64-Q3D
1720 * Addonics SV 750
1721 * CHIC True Sound 4Dwave
1722 * Shark Predator4D-PCI
1723 * Jaton SonicWave 4D
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001724 * SiS SI7018 PCI Audio
1725 * Hoontech SoundTrack Digital 4DWave NX
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726
1727 pcm_channels - max channels (voices) reserved for PCM
1728 wavetable_size - max wavetable size in kB (4-?kb)
1729
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001730 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731
1732 The power-management is supported.
1733
1734 Module snd-usb-audio
1735 --------------------
1736
1737 Module for USB audio and USB MIDI devices.
1738
1739 vid - Vendor ID for the device (optional)
1740 pid - Product ID for the device (optional)
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001741 nrpacks - Max. number of packets per URB (default: 8)
1742 async_unlink - Use async unlink mode (default: yes)
Thibault LE MEURe3113342006-03-14 11:44:53 +01001743 device_setup - Device specific magic number (optional)
1744 - Influence depends on the device
1745 - Default: 0x0000
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001746 ignore_ctl_error - Ignore any USB-controller regarding mixer
1747 interface (default: no)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001749 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001751 NB: nrpacks parameter can be modified dynamically via sysfs.
1752 Don't put the value over 20. Changing via sysfs has no sanity
1753 check.
1754 NB: async_unlink=0 would cause Oops. It remains just for
1755 debugging purpose (if any).
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001756 NB: ignore_ctl_error=1 may help when you get an error at accessing
1757 the mixer element such as URB error -22. This happens on some
1758 buggy USB device or the controller.
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001759
Daniel Mack523f1dc2007-03-26 19:11:24 +02001760 Module snd-usb-caiaq
1761 --------------------
1762
1763 Module for caiaq UB audio interfaces,
1764 * Native Instruments RigKontrol2
1765 * Native Instruments Kore Controller
1766 * Native Instruments Audio Kontrol 1
1767 * Native Instruments Audio 8 DJ
1768
1769 This module supports multiple devices, autoprobe and hotplugging.
1770
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 Module snd-usb-usx2y
1772 --------------------
1773
1774 Module for Tascam USB US-122, US-224 and US-428 devices.
1775
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001776 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777
1778 Note: you need to load the firmware via usx2yloader utility included
1779 in alsa-tools and alsa-firmware packages.
1780
1781 Module snd-via82xx
1782 ------------------
1783
1784 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001785 8233A, 8233C, 8235, 8237 (south) bridge.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786
1787 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1788 [VIA686A/686B only]
1789 joystick - Enable joystick (default off) [VIA686A/686B only]
1790 ac97_clock - AC'97 codec clock base (default 48000Hz)
1791 dxs_support - support DXS channels,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001792 0 = auto (default), 1 = enable, 2 = disable,
1793 3 = 48k only, 4 = no VRA, 5 = enable any sample
1794 rate and different sample rates on different
1795 channels
1796 [VIA8233/C, 8235, 8237 only]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001798 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001800 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801
1802 Note: on some SMP motherboards like MSI 694D the interrupts might
1803 not be generated properly. In such a case, please try to
1804 set the SMP (or MPS) version on BIOS to 1.1 instead of
1805 default value 1.4. Then the interrupt number will be
1806 assigned under 15. You might also upgrade your BIOS.
1807
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001808 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 channels as the first PCM. On these channels, up to 4
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001810 streams can be played at the same time, and the controller
1811 can perform sample rate conversion with separate rates for
1812 each channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 As default (dxs_support = 0), 48k fixed rate is chosen
1814 except for the known devices since the output is often
1815 noisy except for 48k on some mother boards due to the
1816 bug of BIOS.
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001817 Please try once dxs_support=5 and if it works on other
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1819 know the PCI subsystem vendor/device id's (output of
1820 "lspci -nv").
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001821 If dxs_support=5 does not work, try dxs_support=4; if it
1822 doesn't work too, try dxs_support=1. (dxs_support=1 is
Takashi Iwai62430082005-09-05 17:12:29 +02001823 usually for old motherboards. The correct implemented
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001824 board should work with 4 or 5.) If it still doesn't
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825 work and the default setting is ok, dxs_support=3 is the
1826 right choice. If the default setting doesn't work at all,
1827 try dxs_support=2 to disable the DXS channels.
1828 In any cases, please let us know the result and the
Takashi Iwai62430082005-09-05 17:12:29 +02001829 subsystem vendor/device ids. See "Links and Addresses"
1830 below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831
1832 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Takashi Iwai62430082005-09-05 17:12:29 +02001833 additionally. The mpu_port option is for VIA686 chips only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834
Takashi Iwaia4efc232005-11-17 17:24:26 +01001835 The power-management is supported.
1836
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 Module snd-via82xx-modem
1838 ------------------------
1839
1840 Module for VIA82xx AC97 modem
1841
1842 ac97_clock - AC'97 codec clock base (default 48000Hz)
1843
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001844 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845
1846 Note: The default index value of this module is -2, i.e. the first
1847 slot is excluded.
1848
Takashi Iwaia4efc232005-11-17 17:24:26 +01001849 The power-management is supported.
1850
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 Module snd-virmidi
1852 ------------------
1853
1854 Module for virtual rawmidi devices.
1855 This module creates virtual rawmidi devices which communicate
1856 to the corresponding ALSA sequencer ports.
1857
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001858 midi_devs - MIDI devices # (1-4, default=4)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001860 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001862 Module snd-virtuoso
1863 -------------------
1864
Clemens Ladisch5430c722008-07-28 10:28:43 +02001865 Module for sound cards based on the Asus AV100/AV200 chips,
Clemens Ladisch930738d2009-02-26 09:27:20 +01001866 i.e., Xonar D1, DX, D2, D2X, HDAV1.3 (Deluxe), and Essence STX.
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001867
1868 This module supports autoprobe and multiple cards.
1869
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870 Module snd-vx222
1871 ----------------
1872
1873 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1874
1875 mic - Enable Microphone on V222 Mic (NYI)
1876 ibl - Capture IBL size. (default = 0, minimum size)
1877
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001878 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001879
1880 When the driver is compiled as a module and the hotplug firmware
1881 is supported, the firmware data is loaded via hotplug automatically.
1882 Install the necessary firmware files in alsa-firmware package.
1883 When no hotplug fw loader is available, you need to load the
1884 firmware via vxloader utility in alsa-tools package. To invoke
1885 vxloader automatically, add the following to /etc/modprobe.conf
1886
1887 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1888
1889 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1890 /etc/modules.conf, instead.)
1891 IBL size defines the interrupts period for PCM. The smaller size
1892 gives smaller latency but leads to more CPU consumption, too.
1893 The size is usually aligned to 126. As default (=0), the smallest
1894 size is chosen. The possible IBL values can be found in
1895 /proc/asound/cardX/vx-status proc file.
1896
Takashi Iwaia4efc232005-11-17 17:24:26 +01001897 The power-management is supported.
1898
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 Module snd-vxpocket
1900 -------------------
1901
Takashi Iwai6d00a312005-06-30 13:40:51 +02001902 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903
1904 ibl - Capture IBL size. (default = 0, minimum size)
1905
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001906 This module supports multiple cards. The module is compiled only when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907 PCMCIA is supported on kernel.
1908
Takashi Iwai62430082005-09-05 17:12:29 +02001909 With the older 2.6.x kernel, to activate the driver via the card
1910 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1911 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1912 longer require a config file.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913
1914 When the driver is compiled as a module and the hotplug firmware
1915 is supported, the firmware data is loaded via hotplug automatically.
1916 Install the necessary firmware files in alsa-firmware package.
1917 When no hotplug fw loader is available, you need to load the
1918 firmware via vxloader utility in alsa-tools package.
1919
1920 About capture IBL, see the description of snd-vx222 module.
1921
Takashi Iwaied7cbe32006-05-11 11:30:10 +02001922 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
Takashi Iwai62430082005-09-05 17:12:29 +02001923 ALSA 1.0.10.
1924
Takashi Iwaia4efc232005-11-17 17:24:26 +01001925 The power-management is supported.
1926
Linus Torvalds1da177e2005-04-16 15:20:36 -07001927 Module snd-ymfpci
1928 -----------------
1929
1930 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1931
1932 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1933 1 (auto-detect for YMF744/754 only)
1934 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1935 1 (auto-detect for YMF744/754 only)
1936 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1937 1 (auto-detect)
1938 rear_switch - enable shared rear/line-in switch (bool)
1939
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001940 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941
1942 The power-management is supported.
1943
1944 Module snd-pdaudiocf
1945 --------------------
1946
1947 Module for Sound Core PDAudioCF sound card.
1948
Takashi Iwaia4efc232005-11-17 17:24:26 +01001949 The power-management is supported.
1950
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951
Takashi Iwai62430082005-09-05 17:12:29 +02001952AC97 Quirk Option
1953=================
1954
1955The ac97_quirk option is used to enable/override the workaround for
1956specific devices on drivers for on-board AC'97 controllers like
1957snd-intel8x0. Some hardware have swapped output pins between Master
1958and Headphone, or Surround (thanks to confusion of AC'97
1959specifications from version to version :-)
1960
1961The driver provides the auto-detection of known problematic devices,
1962but some might be unknown or wrongly detected. In such a case, pass
1963the proper value with this option.
1964
1965The following strings are accepted:
1966 - default Don't override the default setting
Takashi Iwai10e4097f2005-11-17 11:04:55 +01001967 - none Disable the quirk
Takashi Iwai62430082005-09-05 17:12:29 +02001968 - hp_only Bind Master and Headphone controls as a single control
1969 - swap_hp Swap headphone and master controls
1970 - swap_surround Swap master and surround controls
1971 - ad_sharing For AD1985, turn on OMS bit and use headphone
1972 - alc_jack For ALC65x, turn on the jack sense mode
1973 - inv_eapd Inverted EAPD implementation
1974 - mute_led Bind EAPD bit for turning on/off mute LED
1975
1976For backward compatibility, the corresponding integer value -1, 0,
1977... are accepted, too.
1978
1979For example, if "Master" volume control has no effect on your device
1980but only "Headphone" does, pass ac97_quirk=hp_only module option.
1981
1982
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983Configuring Non-ISAPNP Cards
1984============================
1985
1986When the kernel is configured with ISA-PnP support, the modules
1987supporting the isapnp cards will have module options "isapnp".
1988If this option is set, *only* the ISA-PnP devices will be probed.
1989For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
1990together with the proper i/o and irq configuration.
1991
1992When the kernel is configured without ISA-PnP support, isapnp option
1993will be not built in.
1994
1995
1996Module Autoloading Support
1997==========================
1998
1999The ALSA drivers can be loaded automatically on demand by defining
2000module aliases. The string 'snd-card-%1' is requested for ALSA native
2001devices where %i is sound card number from zero to seven.
2002
2003To auto-load an ALSA driver for OSS services, define the string
2004'sound-slot-%i' where %i means the slot number for OSS, which
2005corresponds to the card index of ALSA. Usually, define this
Tobias Klauserd533f672005-09-10 00:26:46 -07002006as the same card module.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007
2008An example configuration for a single emu10k1 card is like below:
2009----- /etc/modprobe.conf
2010alias snd-card-0 snd-emu10k1
2011alias sound-slot-0 snd-emu10k1
2012----- /etc/modprobe.conf
2013
2014The available number of auto-loaded sound cards depends on the module
2015option "cards_limit" of snd module. As default it's set to 1.
2016To enable the auto-loading of multiple cards, specify the number of
2017sound cards in that option.
2018
2019When multiple cards are available, it'd better to specify the index
2020number for each card via module option, too, so that the order of
2021cards is kept consistent.
2022
2023An example configuration for two sound cards is like below:
2024
2025----- /etc/modprobe.conf
2026# ALSA portion
2027options snd cards_limit=2
2028alias snd-card-0 snd-interwave
2029alias snd-card-1 snd-ens1371
2030options snd-interwave index=0
2031options snd-ens1371 index=1
2032# OSS/Free portion
2033alias sound-slot-0 snd-interwave
2034alias sound-slot-1 snd-ens1371
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02002035----- /etc/modprobe.conf
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036
2037In this example, the interwave card is always loaded as the first card
2038(index 0) and ens1371 as the second (index 1).
2039
Takashi Iwai304cd072007-10-26 15:10:15 +02002040Alternative (and new) way to fixate the slot assignment is to use
2041"slots" option of snd module. In the case above, specify like the
2042following:
2043
2044options snd slots=snd-interwave,snd-ens1371
2045
2046Then, the first slot (#0) is reserved for snd-interwave driver, and
2047the second (#1) for snd-ens1371. You can omit index option in each
2048driver if slots option is used (although you can still have them at
2049the same time as long as they don't conflict).
2050
2051The slots option is especially useful for avoiding the possible
2052hot-plugging and the resultant slot conflict. For example, in the
2053case above again, the first two slots are already reserved. If any
2054other driver (e.g. snd-usb-audio) is loaded before snd-interwave or
2055snd-ens1371, it will be assigned to the third or later slot.
2056
Takashi Iwaia93bbaa2008-05-27 17:59:24 +02002057When a module name is given with '!', the slot will be given for any
2058modules but that name. For example, "slots=!snd-pcsp" will reserve
2059the first slot for any modules but snd-pcsp.
2060
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061
2062ALSA PCM devices to OSS devices mapping
2063=======================================
2064
2065/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
2066/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
2067/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
2068/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
2069/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
2070/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
2071/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
2072/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
2073/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
2074
2075The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
2076sound card number and second means device number. The ALSA devices
2077have either 'c' or 'p' suffix indicating the direction, capture and
2078playback, respectively.
2079
2080Please note that the device mapping above may be varied via the module
2081options of snd-pcm-oss module.
2082
2083
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084Proc interfaces (/proc/asound)
2085==============================
2086
2087/proc/asound/card#/pcm#[cp]/oss
2088-------------------------------
2089 String "erase" - erase all additional informations about OSS applications
2090 String "<app_name> <fragments> <fragment_size> [<options>]"
2091
2092 <app_name> - name of application with (higher priority) or without path
2093 <fragments> - number of fragments or zero if auto
2094 <fragment_size> - size of fragment in bytes or zero if auto
2095 <options> - optional parameters
2096 - disable the application tries to open a pcm device for
2097 this channel but does not want to use it.
2098 (Cause a bug or mmap needs)
2099 It's good for Quake etc...
2100 - direct don't use plugins
2101 - block force block mode (rvplayer)
2102 - non-block force non-block mode
2103 - whole-frag write only whole fragments (optimization affecting
2104 playback only)
2105 - no-silence do not fill silence ahead to avoid clicks
Takashi Iwai10f69f92005-09-08 13:48:34 +02002106 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
2107 instead of filled blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108
2109 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
2110 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
2111 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
2112
2113
Takashi Iwaib6a96912005-05-30 18:27:03 +02002114Early Buffer Allocation
2115=======================
2116
2117Some drivers (e.g. hdsp) require the large contiguous buffers, and
2118sometimes it's too late to find such spaces when the driver module is
2119actually loaded due to memory fragmentation. You can pre-allocate the
2120PCM buffers by loading snd-page-alloc module and write commands to its
2121proc file in prior, for example, in the early boot stage like
2122/etc/init.d/*.local scripts.
2123
2124Reading the proc file /proc/drivers/snd-page-alloc shows the current
2125usage of page allocation. In writing, you can send the following
2126commands to the snd-page-alloc driver:
2127
2128 - add VENDOR DEVICE MASK SIZE BUFFERS
2129
2130 VENDOR and DEVICE are PCI vendor and device IDs. They take
2131 integer numbers (0x prefix is needed for the hex).
2132 MASK is the PCI DMA mask. Pass 0 if not restricted.
2133 SIZE is the size of each buffer to allocate. You can pass
2134 k and m suffix for KB and MB. The max number is 16MB.
2135 BUFFERS is the number of buffers to allocate. It must be greater
2136 than 0. The max number is 4.
2137
2138 - erase
2139
2140 This will erase the all pre-allocated buffers which are not in
2141 use.
2142
2143
Takashi Iwai62430082005-09-05 17:12:29 +02002144Links and Addresses
2145===================
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146
2147 ALSA project homepage
2148 http://www.alsa-project.org
2149
Takashi Iwai30bc4482008-12-09 08:23:45 +01002150 Kernel Bugzilla
2151 http://bugzilla.kernel.org/
Takashi Iwai62430082005-09-05 17:12:29 +02002152
2153 ALSA Developers ML
Rene Herman45051792007-03-21 12:05:06 +01002154 mailto:alsa-devel@alsa-project.org
Takashi Iwai30bc4482008-12-09 08:23:45 +01002155
2156 alsa-info.sh script
2157 http://www.alsa-project.org/alsa-info.sh