blob: ee45454c50befd8045da82079fa90dd2be317949 [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)
349
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100350 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
Takashi Iwaia4efc232005-11-17 17:24:26 +0100352 The power-management is supported.
353
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 Module snd-cmipci
355 -----------------
356
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200357 Module for C-Media CMI8338/8738/8768/8770 PCI sound cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Clemens Ladischc78c9502007-09-03 09:55:49 +0200359 mpu_port - port address of MIDI interface (8338 only):
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200360 0x300,0x310,0x320,0x330 = legacy port,
Takashi Iwaicab5c4c2006-05-04 14:36:08 +0200361 0 = disable (default)
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200362 fm_port - port address of OPL-3 FM synthesizer (8x38 only):
363 0x388 = legacy port,
364 1 = integrated PCI port (default on 8738),
Takashi Iwai2f24d1592007-02-15 18:56:43 +0100365 0 = disable
Takashi Iwai62430082005-09-05 17:12:29 +0200366 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 (default = 1)
368 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
369
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100370 This module supports autoprobe and multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371
Takashi Iwaia4efc232005-11-17 17:24:26 +0100372 The power-management is supported.
373
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 Module snd-cs4231
375 -----------------
376
377 Module for sound cards based on CS4231 ISA chips.
378
379 port - port # for CS4231 chip
380 mpu_port - port # for MPU-401 UART (optional), -1 = disable
381 irq - IRQ # for CS4231 chip
382 mpu_irq - IRQ # for MPU-401 UART
383 dma1 - first DMA # for CS4231 chip
384 dma2 - second DMA # for CS4231 chip
385
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100386 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 thus main port must be specified!!! Other ports are optional.
388
389 The power-management is supported.
390
391 Module snd-cs4232
392 -----------------
393
394 Module for sound cards based on CS4232/CS4232A ISA chips.
395
Rene Herman64e0e2d2007-12-13 16:29:33 +0100396 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
397
398 with isapnp=0, the following options are available:
399
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 port - port # for CS4232 chip (PnP setup - 0x534)
401 cport - control port # for CS4232 chip (PnP setup - 0x120,0x210,0xf00)
402 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
403 fm_port - FM port # for CS4232 chip (PnP setup - 0x388), -1 = disable
404 irq - IRQ # for CS4232 chip (5,7,9,11,12,15)
405 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
406 dma1 - first DMA # for CS4232 chip (0,1,3)
407 dma2 - second DMA # for Yamaha CS4232 chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100409 This module supports multiple cards. This module does not support autoprobe
Rene Herman64e0e2d2007-12-13 16:29:33 +0100410 (if ISA PnP is not used) thus main port must be specified!!! Other ports are
411 optional.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
413 The power-management is supported.
414
415 Module snd-cs4236
416 -----------------
417
418 Module for sound cards based on CS4235/CS4236/CS4236B/CS4237B/
419 CS4238B/CS4239 ISA chips.
420
Rene Herman64e0e2d2007-12-13 16:29:33 +0100421 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
422
423 with isapnp=0, the following options are available:
424
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 port - port # for CS4236 chip (PnP setup - 0x534)
426 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
427 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
428 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
429 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
430 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
431 dma1 - first DMA # for CS4236 chip (0,1,3)
432 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100434 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 (if ISA PnP is not used) thus main port and control port must be
436 specified!!! Other ports are optional.
437
438 The power-management is supported.
439
440 Module snd-cs4281
441 -----------------
442
443 Module for Cirrus Logic CS4281 soundchip.
444
445 dual_codec - Secondary codec ID (0 = disable, default)
446
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100447 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
449 The power-management is supported.
450
451 Module snd-cs46xx
452 -----------------
453
454 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
455 CS4624/CS4630/CS4280 PCI chips.
456
Takashi Iwai62430082005-09-05 17:12:29 +0200457 external_amp - Force to enable external amplifier.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 thinkpad - Force to enable Thinkpad's CLKRUN control.
459 mmap_valid - Support OSS mmap mode (default = 0).
460
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100461 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 Usually external amp and CLKRUN controls are detected automatically
463 from PCI sub vendor/device ids. If they don't work, give the options
464 above explicitly.
465
466 The power-management is supported.
Takashi Iwai621887a2007-05-24 18:46:54 +0200467
468 Module snd-cs5530
469 _________________
470
471 Module for Cyrix/NatSemi Geode 5530 chip.
472
Takashi Iwai3e873172005-11-17 10:15:37 +0100473 Module snd-cs5535audio
474 ----------------------
475
476 Module for multifunction CS5535 companion PCI device
477
Takashi Iwaic00bd742006-05-19 19:22:34 +0200478 The power-management is supported.
Takashi Iwai3e873172005-11-17 10:15:37 +0100479
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200480 Module snd-darla20
481 ------------------
482
483 Module for Echoaudio Darla20
484
485 This module supports multiple cards.
486 The driver requires the firmware loader support on kernel.
487
488 Module snd-darla24
489 ------------------
490
491 Module for Echoaudio Darla24
492
493 This module supports multiple cards.
494 The driver requires the firmware loader support on kernel.
495
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 Module snd-dt019x
497 -----------------
498
499 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
500 only)
501
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100502 This module supports multiple cards. This module is enabled only with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 ISA PnP support.
504
Takashi Iwaia4efc232005-11-17 17:24:26 +0100505 The power-management is supported.
506
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 Module snd-dummy
508 ----------------
509
510 Module for the dummy sound card. This "card" doesn't do any output
511 or input, but you may use this module for any application which
512 requires a sound card (like RealPlayer).
513
Takashi Iwaia4efc232005-11-17 17:24:26 +0100514 The power-management is supported.
515
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200516 Module snd-echo3g
517 -----------------
518
519 Module for Echoaudio 3G cards (Gina3G/Layla3G)
520
521 This module supports multiple cards.
522 The driver requires the firmware loader support on kernel.
523
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 Module snd-emu10k1
525 ------------------
526
527 Module for EMU10K1/EMU10k2 based PCI sound cards.
528 * Sound Blaster Live!
529 * Sound Blaster PCI 512
530 * Emu APS (partially supported)
531 * Sound Blaster Audigy
532
533 extin - bitmap of available external inputs for FX8010 (see bellow)
534 extout - bitmap of available external outputs for FX8010 (see bellow)
535 seq_ports - allocated sequencer ports (4 by default)
536 max_synth_voices - limit of voices used for wavetable (64 by default)
537 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
538 given in MB unit. Default value is 128.
539 enable_ir - enable IR
540
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100541 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
543 Input & Output configurations [extin/extout]
544 * Creative Card wo/Digital out [0x0003/0x1f03]
545 * Creative Card w/Digital out [0x0003/0x1f0f]
546 * Creative Card w/Digital CD in [0x000f/0x1f0f]
547 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
548 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
549 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
550 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
551 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
552 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
553 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
554 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
555 * Creative Card all ins and outs [0x3fff/0x7fff]
556
Takashi Iwaia4efc232005-11-17 17:24:26 +0100557 The power-management is supported.
558
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 Module snd-emu10k1x
560 -------------------
561
562 Module for Creative Emu10k1X (SB Live Dell OEM version)
563
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100564 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
566 Module snd-ens1370
567 ------------------
568
569 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
570 * SoundBlaster PCI 64
571 * SoundBlaster PCI 128
572
573 joystick - Enable joystick (default off)
574
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100575 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100577 The power-management is supported.
578
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 Module snd-ens1371
580 ------------------
581
582 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
583 * SoundBlaster PCI 64
584 * SoundBlaster PCI 128
585 * SoundBlaster Vibra PCI
586
587 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
588 0 = disable (default), 1 = auto-detect
589
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100590 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100592 The power-management is supported.
593
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 Module snd-es968
595 ----------------
596
597 Module for sound cards based on ESS ES968 chip (PnP only).
598
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100599 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600
Takashi Iwaia4efc232005-11-17 17:24:26 +0100601 The power-management is supported.
602
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 Module snd-es1688
604 -----------------
605
606 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
607
608 port - port # for ES-1688 chip (0x220,0x240,0x260)
609 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
610 irq - IRQ # for ES-1688 chip (5,7,9,10)
611 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
612 dma8 - DMA # for ES-1688 chip (0,1,3)
613
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100614 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
616 Module snd-es18xx
617 -----------------
618
619 Module for ESS AudioDrive ES-18xx sound cards.
620
Rene Herman64e0e2d2007-12-13 16:29:33 +0100621 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
622
623 with isapnp=0, the following options are available:
624
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 port - port # for ES-18xx chip (0x220,0x240,0x260)
626 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
627 fm_port - port # for FM (optional, not used)
628 irq - IRQ # for ES-18xx chip (5,7,9,10)
629 dma1 - first DMA # for ES-18xx chip (0,1,3)
630 dma2 - first DMA # for ES-18xx chip (0,1,3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100632 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
633 port if native ISA PnP routines are not used).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 When dma2 is equal with dma1, the driver works as half-duplex.
635
636 The power-management is supported.
637
638 Module snd-es1938
639 -----------------
640
641 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
642
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100643 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644
Takashi Iwaia4efc232005-11-17 17:24:26 +0100645 The power-management is supported.
646
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 Module snd-es1968
648 -----------------
649
650 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
651
652 total_bufsize - total buffer size in kB (1-4096kB)
653 pcm_substreams_p - playback channels (1-8, default=2)
654 pcm_substreams_c - capture channels (1-8, default=0)
655 clock - clock (0 = auto-detection)
656 use_pm - support the power-management (0 = off, 1 = on,
657 2 = auto (default))
658 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
659 joystick - enable joystick (default off)
660
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100661 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662
663 The power-management is supported.
664
665 Module snd-fm801
666 ----------------
667
668 Module for ForteMedia FM801 based PCI sound cards.
669
670 tea575x_tuner - Enable TEA575x tuner
671 - 1 = MediaForte 256-PCS
672 - 2 = MediaForte 256-PCPR
673 - 3 = MediaForte 64-PCR
674 - High 16-bits are video (radio) device number + 1
675 - example: 0x10002 (MediaForte 256-PCPR, device 1)
676
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100677 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678
Takashi Iwaia4efc232005-11-17 17:24:26 +0100679 The power-management is supported.
680
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200681 Module snd-gina20
682 -----------------
683
684 Module for Echoaudio Gina20
685
686 This module supports multiple cards.
687 The driver requires the firmware loader support on kernel.
688
689 Module snd-gina24
690 -----------------
691
692 Module for Echoaudio Gina24
693
694 This module supports multiple cards.
695 The driver requires the firmware loader support on kernel.
696
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697 Module snd-gusclassic
698 ---------------------
699
700 Module for Gravis UltraSound Classic sound card.
701
702 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
703 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
704 dma1 - DMA # for GF1 chip (1,3,5,6,7)
705 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
706 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
707 voices - GF1 voices limit (14-32)
708 pcm_voices - reserved PCM voices
709
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100710 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711
712 Module snd-gusextreme
713 ---------------------
714
715 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
716
717 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
718 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
719 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
720 irq - IRQ # for ES-1688 chip (5,7,9,10)
721 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
722 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
723 dma8 - DMA # for ES-1688 chip (0,1,3)
724 dma1 - DMA # for GF1 chip (1,3,5,6,7)
725 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
726 voices - GF1 voices limit (14-32)
727 pcm_voices - reserved PCM voices
728
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100729 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730
731 Module snd-gusmax
732 -----------------
733
734 Module for Gravis UltraSound MAX sound card.
735
736 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
737 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
738 dma1 - DMA # for GF1 chip (1,3,5,6,7)
739 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
740 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
741 voices - GF1 voices limit (14-32)
742 pcm_voices - reserved PCM voices
743
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100744 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745
746 Module snd-hda-intel
747 --------------------
748
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400749 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8, ICH9, ICH10,
750 PCH, SCH),
751 ATI SB450, SB600, R600, RS600, RS690, RS780, RV610, RV620,
752 RV630, RV635, RV670, RV770,
Takashi Iwai9b878192006-05-17 11:26:39 +0200753 VIA VT8251/VT8237A,
754 SIS966, ULI M5461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100756 [Multiple options for each card instance]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 model - force the model name
Takashi Iwaid2e1c972008-06-10 17:53:34 +0200758 position_fix - Fix DMA pointer (0 = auto, 1 = use LPIB, 2 = POSBUF)
Takashi Iwai95904742007-05-19 17:06:42 +0200759 probe_mask - Bitmask to probe codecs (default = -1, meaning all slots)
Takashi Iwaid4d9cd032008-12-19 15:19:11 +0100760 probe_only - Only probing and no codec initialization (default=off);
761 Useful to check the initial codec status for debugging
Takashi Iwai8c53b962008-06-10 17:53:35 +0200762 bdl_pos_adj - Specifies the DMA IRQ timing delay in samples.
763 Passing -1 will make the driver to choose the appropriate
764 value based on the controller chip.
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100765
766 [Single (global) options]
Takashi Iwai27346162006-01-12 18:28:44 +0100767 single_cmd - Use single immediate commands to communicate with
768 codecs (for debugging only)
Takashi Iwai134a11f2006-11-10 12:08:37 +0100769 enable_msi - Enable Message Signaled Interrupt (MSI) (default = off)
Takashi Iwaidee1b662007-08-13 16:10:30 +0200770 power_save - Automatic power-saving timtout (in second, 0 =
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200771 disable)
Takashi Iwaidee1b662007-08-13 16:10:30 +0200772 power_save_controller - Reset HD-audio controller in power-saving mode
773 (default = on)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100775 This module supports multiple cards and autoprobe.
776
Takashi Iwaicae51172008-12-19 08:36:53 +0100777 See Documentation/sound/alsa/HD-Audio.txt for more details about
778 HD-audio driver.
779
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 Each codec may have a model table for different configurations.
781 If your machine isn't listed there, the default (usually minimal)
782 configuration is set up. You can pass "model=<name>" option to
783 specify a certain model in such a case. There are different
Takashi Iwaicae51172008-12-19 08:36:53 +0100784 models depending on the codec chip. The list of available models
785 is found in HD-Audio-Models.txt
Takashi Iwaidb064e52006-03-16 16:04:58 +0100786
Takashi Iwai6d7b1d72007-02-26 15:56:46 +0100787 The model name "genric" is treated as a special case. When this
788 model is given, the driver uses the generic codec parser without
789 "codec-patch". It's sometimes good for testing and debugging.
790
Takashi Iwai62430082005-09-05 17:12:29 +0200791 If the default configuration doesn't work and one of the above
Takashi Iwai30bc4482008-12-09 08:23:45 +0100792 matches with your device, report it together with alsa-info.sh
793 output (with --no-upload option) to kernel bugzilla or alsa-devel
Takashi Iwai62430082005-09-05 17:12:29 +0200794 ML (see the section "Links and Addresses").
795
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200796 power_save and power_save_controller options are for power-saving
797 mode. See powersave.txt for details.
Takashi Iwaidee1b662007-08-13 16:10:30 +0200798
Takashi Iwaic74db862005-05-12 14:26:27 +0200799 Note 2: If you get click noises on output, try the module option
800 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
801 register value without FIFO size correction as the current
802 DMA pointer. position_fix=2 will make the driver to use
803 the position buffer instead of reading SD_LPIB register.
Michael Kerrisk90f31e32008-09-01 14:03:50 +0200804 (Usually SD_LPIB register is more accurate than the
Takashi Iwaic74db862005-05-12 14:26:27 +0200805 position buffer.)
806
Takashi Iwai27346162006-01-12 18:28:44 +0100807 NB: If you get many "azx_get_response timeout" messages at
808 loading, it's likely a problem of interrupts (e.g. ACPI irq
809 routing). Try to boot with options like "pci=noacpi". Also, you
810 can try "single_cmd=1" module option. This will switch the
811 communication method between HDA controller and codecs to the
812 single immediate commands instead of CORB/RIRB. Basically, the
813 single command mode is provided only for BIOS, and you won't get
814 unsolicited events, too. But, at least, this works independently
815 from the irq. Remember this is a last resort, and should be
816 avoided as much as possible...
817
Takashi Iwai95904742007-05-19 17:06:42 +0200818 MORE NOTES ON "azx_get_response timeout" PROBLEMS:
819 On some hardwares, you may need to add a proper probe_mask option
820 to avoid the "azx_get_response timeout" problem above, instead.
821 This occurs when the access to non-existing or non-working codec slot
822 (likely a modem one) causes a stall of the communication via HD-audio
823 bus. You can see which codec slots are probed by enabling
Takashi Iwai62cf8722008-05-20 12:15:15 +0200824 CONFIG_SND_DEBUG_VERBOSE, or simply from the file name of the codec
Takashi Iwai95904742007-05-19 17:06:42 +0200825 proc files. Then limit the slots to probe by probe_mask option.
826 For example, probe_mask=1 means to probe only the first slot, and
827 probe_mask=4 means only the third slot.
828
Takashi Iwaia4efc232005-11-17 17:24:26 +0100829 The power-management is supported.
830
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 Module snd-hdsp
832 ---------------
833
834 Module for RME Hammerfall DSP audio interface(s)
835
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100836 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837
838 Note: The firmware data can be automatically loaded via hotplug
839 when CONFIG_FW_LOADER is set. Otherwise, you need to load
840 the firmware via hdsploader utility included in alsa-tools
841 package.
842 The firmware data is found in alsa-firmware package.
843
844 Note: snd-page-alloc module does the job which snd-hammerfall-mem
845 module did formerly. It will allocate the buffers in advance
846 when any HDSP cards are found. To make the buffer
847 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +0200848 stage of boot sequence. See "Early Buffer Allocation"
849 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850
Takashi Iwai54704402005-06-03 11:27:00 +0200851 Module snd-hdspm
852 ----------------
853
854 Module for RME HDSP MADI board.
855
856 precise_ptr - Enable precise pointer, or disable.
857 line_outs_monitor - Send playback streams to analog outs by default.
858 enable_monitor - Enable Analog Out on Channel 63/64 by default.
859
860 See hdspm.txt for details.
861
Clemens Ladischc6260262008-01-25 08:41:52 +0100862 Module snd-hifier
863 -----------------
864
865 Module for the MediaTek/TempoTec HiFier Fantasia sound card.
866
867 This module supports autoprobe and multiple cards.
868
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 Module snd-ice1712
870 ------------------
871
872 Module for Envy24 (ICE1712) based PCI sound cards.
873 * MidiMan M Audio Delta 1010
874 * MidiMan M Audio Delta 1010LT
875 * MidiMan M Audio Delta DiO 2496
876 * MidiMan M Audio Delta 66
877 * MidiMan M Audio Delta 44
878 * MidiMan M Audio Delta 410
879 * MidiMan M Audio Audiophile 2496
880 * TerraTec EWS 88MT
881 * TerraTec EWS 88D
882 * TerraTec EWX 24/96
883 * TerraTec DMX 6Fire
Takashi Iwaic9bce912005-05-24 13:41:03 +0200884 * TerraTec Phase 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 * Hoontech SoundTrack DSP 24
886 * Hoontech SoundTrack DSP 24 Value
887 * Hoontech SoundTrack DSP 24 Media 7.1
Takashi Iwaic9bce912005-05-24 13:41:03 +0200888 * Event Electronics, EZ8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 * Digigram VX442
Takashi Iwaic9bce912005-05-24 13:41:03 +0200890 * Lionstracs, Mediastaton
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400891 * Terrasoniq TS 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892
893 model - Use the given board model, one of the following:
894 delta1010, dio2496, delta66, delta44, audiophile, delta410,
895 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
Takashi Iwaic9bce912005-05-24 13:41:03 +0200896 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
897 phase88, mediastation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700898 omni - Omni I/O support for MidiMan M-Audio Delta44/66
Matt LaPlantefa00e7e2006-11-30 04:55:36 +0100899 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transceiver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 in msec resolution, default value is 500 (0.5 sec)
901
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100902 This module supports multiple cards and autoprobe. Note: The consumer part
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 is not used with all Envy24 based cards (for example in the MidiMan Delta
904 serie).
905
Takashi Iwaic9bce912005-05-24 13:41:03 +0200906 Note: The supported board is detected by reading EEPROM or PCI
907 SSID (if EEPROM isn't available). You can override the
908 model by passing "model" module option in case that the
909 driver isn't configured properly or you want to try another
910 type for testing.
911
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 Module snd-ice1724
913 ------------------
914
Takashi Iwaic9bce912005-05-24 13:41:03 +0200915 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100916 * MidiMan M Audio Revolution 5.1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917 * MidiMan M Audio Revolution 7.1
Takashi Iwai56255062006-11-09 16:47:26 +0100918 * MidiMan M Audio Audiophile 192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 * AMP Ltd AUDIO2000
Takashi Iwaic9bce912005-05-24 13:41:03 +0200920 * TerraTec Aureon 5.1 Sky
921 * TerraTec Aureon 7.1 Space
922 * TerraTec Aureon 7.1 Universe
923 * TerraTec Phase 22
924 * TerraTec Phase 28
925 * AudioTrak Prodigy 7.1
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400926 * AudioTrak Prodigy 7.1 LT
927 * AudioTrak Prodigy 7.1 XT
928 * AudioTrak Prodigy 7.1 HIFI
929 * AudioTrak Prodigy 7.1 HD2
Takashi Iwaic9bce912005-05-24 13:41:03 +0200930 * AudioTrak Prodigy 192
931 * Pontis MS300
932 * Albatron K8X800 Pro II
933 * Chaintech ZNF3-150
934 * Chaintech ZNF3-250
935 * Chaintech 9CJS
Takashi Iwai8cfbbac2005-05-27 12:10:40 +0200936 * Chaintech AV-710
Takashi Iwaic9bce912005-05-24 13:41:03 +0200937 * Shuttle SN25P
Shin-ya Okadaf31639b2007-10-23 15:08:18 +0200938 * Onkyo SE-90PCI
939 * Onkyo SE-200PCI
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400940 * ESI Juli@
941 * Hercules Fortissimo IV
942 * EGO-SYS WaveTerminal 192M
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943
944 model - Use the given board model, one of the following:
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100945 revo51, revo71, amp2000, prodigy71, prodigy71lt,
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400946 prodigy71xt, prodigy71hifi, prodigyhd2, prodigy192,
947 juli, aureon51, aureon71, universe, ap192, k8x800,
948 phase22, phase28, ms300, av710, se200pci, se90pci,
949 fortissimo4, sn25p, WT192M
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100951 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
Takashi Iwaic9bce912005-05-24 13:41:03 +0200953 Note: The supported board is detected by reading EEPROM or PCI
954 SSID (if EEPROM isn't available). You can override the
955 model by passing "model" module option in case that the
956 driver isn't configured properly or you want to try another
957 type for testing.
958
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200959 Module snd-indigo
960 -----------------
961
962 Module for Echoaudio Indigo
963
964 This module supports multiple cards.
965 The driver requires the firmware loader support on kernel.
966
967 Module snd-indigodj
968 -------------------
969
970 Module for Echoaudio Indigo DJ
971
972 This module supports multiple cards.
973 The driver requires the firmware loader support on kernel.
974
975 Module snd-indigoio
976 -------------------
977
978 Module for Echoaudio Indigo IO
979
980 This module supports multiple cards.
981 The driver requires the firmware loader support on kernel.
982
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 Module snd-intel8x0
984 -------------------
985
986 Module for AC'97 motherboards from Intel and compatibles.
987 * Intel i810/810E, i815, i820, i830, i84x, MX440
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400988 ICH5, ICH6, ICH7, 6300ESB, ESB2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 * SiS 7012 (SiS 735)
Takashi Iwai89ac9c22006-01-24 10:36:57 +0100990 * NVidia NForce, NForce2, NForce3, MCP04, CK804
991 CK8, CK8S, MCP501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 * AMD AMD768, AMD8111
993 * ALi m5455
994
995 ac97_clock - AC'97 codec clock base (0 = auto-detect)
996 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200997 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998 buggy_irq - Enable workaround for buggy interrupts on some
Takashi Iwaia06147d2005-09-08 19:54:17 +0200999 motherboards (default yes on nForce chips,
1000 otherwise off)
1001 buggy_semaphore - Enable workaround for hardwares with buggy
1002 semaphores (e.g. on some ASUS laptops)
1003 (default off)
Takashi Iwai6c5cfd92006-11-28 17:18:25 +01001004 spdif_aclink - Use S/PDIF over AC-link instead of direct connection
1005 from the controller chip
1006 (0 = off, 1 = on, -1 = default)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001008 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009
1010 Note: the latest driver supports auto-detection of chip clock.
1011 if you still encounter too fast playback, specify the clock
1012 explicitly via the module option "ac97_clock=41194".
1013
1014 Joystick/MIDI ports are not supported by this driver. If your
1015 motherboard has these devices, use the ns558 or snd-mpu401
1016 modules, respectively.
1017
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 The power-management is supported.
1019
1020 Module snd-intel8x0m
1021 --------------------
1022
1023 Module for Intel ICH (i8x0) chipset MC97 modems.
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001024 * Intel i810/810E, i815, i820, i830, i84x, MX440
1025 ICH5, ICH6, ICH7
1026 * SiS 7013 (SiS 735)
1027 * NVidia NForce, NForce2, NForce2s, NForce3
1028 * AMD AMD8111
1029 * ALi m5455
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030
1031 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1032
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001033 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034
1035 Note: The default index value of this module is -2, i.e. the first
1036 slot is excluded.
1037
Takashi Iwaia4efc232005-11-17 17:24:26 +01001038 The power-management is supported.
1039
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040 Module snd-interwave
1041 --------------------
1042
1043 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1044 and other sound cards based on AMD InterWave (tm) chip.
1045
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1047 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1048 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1049 effect - 1 = InterWave effects enable (default 0);
1050 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001051 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1052
1053 with isapnp=0, the following options are available:
1054
1055 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1056 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1057 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1058 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001060 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061
1062 Module snd-interwave-stb
1063 ------------------------
1064
1065 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1066 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1067 circuit for extended control of bass, treble and master volume.
1068
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1070 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1071 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1072 effect - 1 = InterWave effects enable (default 0);
1073 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001074 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1075
1076 with isapnp=0, the following options are available:
1077
1078 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1079 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1080 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1081 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1082 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001084 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085
1086 Module snd-korg1212
1087 -------------------
1088
1089 Module for Korg 1212 IO PCI card
1090
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001091 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001093 Module snd-layla20
1094 ------------------
1095
1096 Module for Echoaudio Layla20
1097
1098 This module supports multiple cards.
1099 The driver requires the firmware loader support on kernel.
1100
1101 Module snd-layla24
1102 ------------------
1103
1104 Module for Echoaudio Layla24
1105
1106 This module supports multiple cards.
1107 The driver requires the firmware loader support on kernel.
1108
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 Module snd-maestro3
1110 -------------------
1111
1112 Module for Allegro/Maestro3 chips
1113
1114 external_amp - enable external amp (enabled by default)
1115 amp_gpio - GPIO pin number for external amp (0-15) or
1116 -1 for default pin (8 for allegro, 1 for
1117 others)
1118
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001119 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120
1121 Note: the binding of amplifier is dependent on hardware.
1122 If there is no sound even though all channels are unmuted, try to
1123 specify other gpio connection via amp_gpio option.
1124 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1125 option.
1126
1127 The power-management is supported.
1128
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001129 Module snd-mia
1130 ---------------
1131
1132 Module for Echoaudio Mia
1133
1134 This module supports multiple cards.
1135 The driver requires the firmware loader support on kernel.
1136
Martin Langer1841f6132006-03-27 12:41:01 +02001137 Module snd-miro
1138 ---------------
1139
1140 Module for Miro soundcards: miroSOUND PCM 1 pro,
1141 miroSOUND PCM 12,
1142 miroSOUND PCM 20 Radio.
1143
1144 port - Port # (0x530,0x604,0xe80,0xf40)
1145 irq - IRQ # (5,7,9,10,11)
1146 dma1 - 1st dma # (0,1,3)
1147 dma2 - 2nd dma # (0,1)
1148 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1149 mpu_irq - MPU-401 irq # (5,7,9,10)
1150 fm_port - FM Port # (0x388)
1151 wss - enable WSS mode
1152 ide - enable onboard ide support
1153
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 Module snd-mixart
1155 -----------------
1156
1157 Module for Digigram miXart8 sound cards.
1158
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001159 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160 Note: One miXart8 board will be represented as 4 alsa cards.
1161 See MIXART.txt for details.
1162
1163 When the driver is compiled as a module and the hotplug firmware
1164 is supported, the firmware data is loaded via hotplug automatically.
1165 Install the necessary firmware files in alsa-firmware package.
1166 When no hotplug fw loader is available, you need to load the
1167 firmware via mixartloader utility in alsa-tools package.
1168
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001169 Module snd-mona
1170 ---------------
1171
1172 Module for Echoaudio Mona
1173
1174 This module supports multiple cards.
1175 The driver requires the firmware loader support on kernel.
1176
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177 Module snd-mpu401
1178 -----------------
1179
1180 Module for MPU-401 UART devices.
1181
1182 port - port number or -1 (disable)
1183 irq - IRQ number or -1 (disable)
1184 pnp - PnP detection - 0 = disable, 1 = enable (default)
1185
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001186 This module supports multiple devices and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187
1188 Module snd-mtpav
1189 ----------------
1190
1191 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1192 port).
1193
1194 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1195 irq - IRQ # for MTPAV (7,5, default=7)
1196 hwports - number of supported hardware ports, default=8.
1197
1198 Module supports only 1 card. This module has no enable option.
1199
Matthias Koenig68ab8012006-07-27 16:59:23 +02001200 Module snd-mts64
1201 ----------------
1202
1203 Module for Ego Systems (ESI) Miditerminal 4140
1204
1205 This module supports multiple devices.
1206 Requires parport (CONFIG_PARPORT).
1207
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208 Module snd-nm256
1209 ----------------
1210
1211 Module for NeoMagic NM256AV/ZX chips
1212
1213 playback_bufsize - max playback frame size in kB (4-128kB)
1214 capture_bufsize - max capture frame size in kB (4-128kB)
1215 force_ac97 - 0 or 1 (disabled by default)
1216 buffer_top - specify buffer top address
1217 use_cache - 0 or 1 (disabled by default)
1218 vaio_hack - alias buffer_top=0x25a800
1219 reset_workaround - enable AC97 RESET workaround for some laptops
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001220 reset_workaround2 - enable extended AC97 RESET workaround for some
1221 other laptops
Linus Torvalds1da177e2005-04-16 15:20:36 -07001222
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +02001223 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224
1225 The power-management is supported.
1226
1227 Note: on some notebooks the buffer address cannot be detected
1228 automatically, or causes hang-up during initialization.
Matt LaPlantefff92892006-10-03 22:47:42 +02001229 In such a case, specify the buffer top address explicitly via
1230 the buffer_top option.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 For example,
1232 Sony F250: buffer_top=0x25a800
1233 Sony F270: buffer_top=0x272800
1234 The driver supports only ac97 codec. It's possible to force
1235 to initialize/use ac97 although it's not detected. In such a
1236 case, use force_ac97=1 option - but *NO* guarantee whether it
1237 works!
1238
1239 Note: The NM256 chip can be linked internally with non-AC97
1240 codecs. This driver supports only the AC97 codec, and won't work
1241 with machines with other (most likely CS423x or OPL3SAx) chips,
1242 even though the device is detected in lspci. In such a case, try
1243 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
Takashi Iwai62430082005-09-05 17:12:29 +02001244 but some doesn't have ISA PnP. You'll need to specify isapnp=0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245 and proper hardware parameters in the case without ISA PnP.
1246
1247 Note: some laptops need a workaround for AC97 RESET. For the
1248 known hardware like Dell Latitude LS and Sony PCG-F305, this
1249 workaround is enabled automatically. For other laptops with a
1250 hard freeze, you can try reset_workaround=1 option.
1251
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001252 Note: Dell Latitude CSx laptops have another problem regarding
1253 AC97 RESET. On these laptops, reset_workaround2 option is
1254 turned on as default. This option is worth to try if the
1255 previous reset_workaround option doesn't help.
1256
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 Note: This driver is really crappy. It's a porting from the
1258 OSS driver, which is a result of black-magic reverse engineering.
1259 The detection of codec will fail if the driver is loaded *after*
1260 X-server as described above. You might be able to force to load
1261 the module, but it may result in hang-up. Hence, make sure that
1262 you load this module *before* X if you encounter this kind of
1263 problem.
1264
1265 Module snd-opl3sa2
1266 ------------------
1267
1268 Module for Yamaha OPL3-SA2/SA3 sound cards.
1269
Rene Herman64e0e2d2007-12-13 16:29:33 +01001270 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1271
1272 with isapnp=0, the following options are available:
1273
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 port - control port # for OPL3-SA chip (0x370)
1275 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1276 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1277 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1278 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1279 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1280 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1281 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001283 This module supports multiple cards and ISA PnP. It does not support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1285
1286 The power-management is supported.
1287
1288 Module snd-opti92x-ad1848
1289 -------------------------
1290
1291 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1292 Module works with OAK Mozart cards as well.
1293
Rene Herman64e0e2d2007-12-13 16:29:33 +01001294 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1295
1296 with isapnp=0, the following options are available:
1297
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1299 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1300 fm_port - port # for OPL3 device (0x388)
1301 irq - IRQ # for WSS chip (5,7,9,10,11)
1302 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1303 dma1 - first DMA # for WSS chip (0,1,3)
1304
1305 This module supports only one card, autoprobe and PnP.
1306
1307 Module snd-opti92x-cs4231
1308 -------------------------
1309
1310 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1311
Rene Herman64e0e2d2007-12-13 16:29:33 +01001312 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1313
1314 with isapnp=0, the following options are available:
1315
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1317 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1318 fm_port - port # for OPL3 device (0x388)
1319 irq - IRQ # for WSS chip (5,7,9,10,11)
1320 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1321 dma1 - first DMA # for WSS chip (0,1,3)
1322 dma2 - second DMA # for WSS chip (0,1,3)
1323
1324 This module supports only one card, autoprobe and PnP.
1325
1326 Module snd-opti93x
1327 ------------------
1328
1329 Module for sound cards based on OPTi 82c93x chips.
1330
Rene Herman64e0e2d2007-12-13 16:29:33 +01001331 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1332
1333 with isapnp=0, the following options are available:
1334
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1336 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1337 fm_port - port # for OPL3 device (0x388)
1338 irq - IRQ # for WSS chip (5,7,9,10,11)
1339 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1340 dma1 - first DMA # for WSS chip (0,1,3)
1341 dma2 - second DMA # for WSS chip (0,1,3)
1342
1343 This module supports only one card, autoprobe and PnP.
1344
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001345 Module snd-oxygen
1346 -----------------
1347
1348 Module for sound cards based on the C-Media CMI8788 chip:
1349 * Asound A-8788
1350 * AuzenTech X-Meridian
1351 * Bgears b-Enspirer
1352 * Club3D Theatron DTS
1353 * HT-Omega Claro
1354 * Razer Barracuda AC-1
1355 * Sondigo Inferno
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001356
1357 This module supports autoprobe and multiple cards.
1358
Stas Sergeevd08cd582008-03-06 11:01:44 +01001359 Module snd-pcsp
1360 -----------------
1361
1362 Module for internal PC-Speaker.
1363
1364 nforce_wa - enable NForce chipset workaround. Expect bad sound.
1365
1366 This module supports system beeps, some kind of PCM playback and
1367 even a few mixer controls.
1368
Markus Bollingere12229b2005-12-06 13:55:26 +01001369 Module snd-pcxhr
1370 ----------------
1371
1372 Module for Digigram PCXHR boards
1373
1374 This module supports multiple cards.
1375
Matthias Koenig757e1192007-01-25 13:15:05 +01001376 Module snd-portman2x4
1377 ---------------------
1378
1379 Module for Midiman Portman 2x4 parallel port MIDI interface
1380
1381 This module supports multiple cards.
1382
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 Module snd-powermac (on ppc only)
1384 ---------------------------------
1385
1386 Module for PowerMac, iMac and iBook on-board soundchips
1387
1388 enable_beep - enable beep using PCM (enabled as default)
1389
1390 Module supports autoprobe a chip.
1391
1392 Note: the driver may have problems regarding endianess.
1393
1394 The power-management is supported.
1395
Takashi Iwai2c484df2005-06-30 18:54:04 +02001396 Module snd-pxa2xx-ac97 (on arm only)
1397 ------------------------------------
1398
1399 Module for AC97 driver for the Intel PXA2xx chip
1400
1401 For ARM architecture only.
1402
Takashi Iwaia4efc232005-11-17 17:24:26 +01001403 The power-management is supported.
1404
Peter Gruber109a9632006-03-27 13:10:28 +02001405 Module snd-riptide
1406 ------------------
1407
1408 Module for Conexant Riptide chip
1409
1410 joystick_port - Joystick port # (default: 0x200)
1411 mpu_port - MPU401 port # (default: 0x330)
1412 opl3_port - OPL3 port # (default: 0x388)
1413
1414 This module supports multiple cards.
1415 The driver requires the firmware loader support on kernel.
1416 You need to install the firmware file "riptide.hex" to the standard
1417 firmware path (e.g. /lib/firmware).
1418
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 Module snd-rme32
1420 ----------------
1421
1422 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1423 Prodif96 and Prodif Gold) sound cards.
1424
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001425 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426
1427 Module snd-rme96
1428 ----------------
1429
1430 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1431
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001432 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433
1434 Module snd-rme9652
1435 ------------------
1436
1437 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1438
1439 precise_ptr - Enable precise pointer (doesn't work reliably).
1440 (default = 0)
1441
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001442 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443
1444 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1445 module did formerly. It will allocate the buffers in advance
1446 when any RME9652 cards are found. To make the buffer
1447 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +02001448 stage of boot sequence. See "Early Buffer Allocation"
1449 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450
1451 Module snd-sa11xx-uda1341 (on arm only)
1452 ---------------------------------------
1453
1454 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1455
1456 Module supports only one card.
1457 Module has no enable and index options.
1458
Takashi Iwaia4efc232005-11-17 17:24:26 +01001459 The power-management is supported.
1460
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 Module snd-sb8
1462 --------------
1463
1464 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1465 SoundBlaster 2.0,
1466 SoundBlaster Pro
1467
1468 port - port # for SB DSP chip (0x220,0x240,0x260)
1469 irq - IRQ # for SB DSP chip (5,7,9,10)
1470 dma8 - DMA # for SB DSP chip (1,3)
1471
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001472 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473
Takashi Iwaia4efc232005-11-17 17:24:26 +01001474 The power-management is supported.
1475
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476 Module snd-sb16 and snd-sbawe
1477 -----------------------------
1478
1479 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1480 SoundBlaster AWE 32 (PnP),
1481 SoundBlaster AWE 64 PnP
1482
Rene Herman64e0e2d2007-12-13 16:29:33 +01001483 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1484 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1485 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1486
1487 with isapnp=0, the following options are available:
1488
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1490 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1491 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1492 (snd-sbawe module only)
1493 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1494 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1495 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001497 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498
1499 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1500 disable 16bit DMA with dma16 = -1 module parameter.
1501 Also, all Sound Blaster 16 type cards can operate in 16-bit
1502 half duplex mode through 8-bit DMA channel by disabling their
1503 16-bit DMA channel.
1504
Takashi Iwaia4efc232005-11-17 17:24:26 +01001505 The power-management is supported.
1506
Takashi Iwai074a6e92007-09-11 22:10:14 +02001507 Module snd-sc6000
1508 -----------------
1509
1510 Module for Gallant SC-6000 soundcard.
1511
1512 port - Port # (0x220 or 0x240)
1513 mss_port - MSS Port # (0x530 or 0xe80)
1514 irq - IRQ # (5,7,9,10,11)
Krzysztof Helt7b758d22007-09-17 14:42:49 +02001515 mpu_irq - MPU-401 IRQ # (5,7,9,10) ,0 - no MPU-401 irq
Takashi Iwai074a6e92007-09-11 22:10:14 +02001516 dma - DMA # (1,3,0)
1517
1518 This module supports multiple cards.
1519
1520 This card is also known as Audio Excel DSP 16 or Zoltrix AV302.
1521
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 Module snd-sgalaxy
1523 ------------------
1524
1525 Module for Aztech Sound Galaxy sound card.
1526
1527 sbport - Port # for SB16 interface (0x220,0x240)
1528 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1529 irq - IRQ # (7,9,10,11)
1530 dma1 - DMA #
1531
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001532 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533
Takashi Iwaia4efc232005-11-17 17:24:26 +01001534 The power-management is supported.
1535
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536 Module snd-sscape
1537 -----------------
1538
1539 Module for ENSONIQ SoundScape PnP cards.
1540
1541 port - Port # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001542 wss_port - WSS Port # (PnP setup)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 irq - IRQ # (PnP setup)
1544 mpu_irq - MPU-401 IRQ # (PnP setup)
1545 dma - DMA # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001546 dma2 - 2nd DMA # (PnP setup, -1 to disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001548 This module supports multiple cards. ISA PnP must be enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 You need sscape_ctl tool in alsa-tools package for loading
1550 the microcode.
1551
1552 Module snd-sun-amd7930 (on sparc only)
1553 --------------------------------------
1554
1555 Module for AMD7930 sound chips found on Sparcs.
1556
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001557 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558
1559 Module snd-sun-cs4231 (on sparc only)
1560 -------------------------------------
1561
1562 Module for CS4231 sound chips found on Sparcs.
1563
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001564 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001566 Module snd-sun-dbri (on sparc only)
1567 -----------------------------------
1568
1569 Module for DBRI sound chips found on Sparcs.
1570
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001571 This module supports multiple cards.
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001572
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 Module snd-wavefront
1574 --------------------
1575
1576 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1577
Rene Herman64e0e2d2007-12-13 16:29:33 +01001578 use_cs4232_midi - Use CS4232 MPU-401 interface
1579 (inaccessibly located inside your computer)
1580 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1581
1582 with isapnp=0, the following options are available:
1583
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 cs4232_pcm_port - Port # for CS4232 PCM interface.
1585 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1586 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1587 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 ics2115_port - Port # for ICS2115
1589 ics2115_irq - IRQ # for ICS2115
1590 fm_port - FM OPL-3 Port #
1591 dma1 - DMA1 # for CS4232 PCM interface.
1592 dma2 - DMA2 # for CS4232 PCM interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593
Takashi Iwaic2b12392007-08-21 15:20:26 +02001594 The below are options for wavefront_synth features:
1595 wf_raw - Assume that we need to boot the OS (default:no)
1596 If yes, then during driver loading, the state of the board is
1597 ignored, and we reset the board and load the firmware anyway.
1598 fx_raw - Assume that the FX process needs help (default:yes)
1599 If false, we'll leave the FX processor in whatever state it is
1600 when the driver is loaded. The default is to download the
1601 microprogram and associated coefficients to set it up for
1602 "default" operation, whatever that means.
1603 debug_default - Debug parameters for card initialization
1604 wait_usecs - How long to wait without sleeping, usecs
1605 (default:150)
1606 This magic number seems to give pretty optimal throughput
1607 based on my limited experimentation.
1608 If you want to play around with it and find a better value, be
1609 my guest. Remember, the idea is to get a number that causes us
1610 to just busy wait for as many WaveFront commands as possible,
1611 without coming up with a number so large that we hog the whole
1612 CPU.
1613 Specifically, with this number, out of about 134,000 status
1614 waits, only about 250 result in a sleep.
1615 sleep_interval - How long to sleep when waiting for reply
1616 (default: 100)
1617 sleep_tries - How many times to try sleeping during a wait
1618 (default: 50)
1619 ospath - Pathname to processed ICS2115 OS firmware
1620 (default:wavefront.os)
1621 The path name of the ISC2115 OS firmware. In the recent
1622 version, it's handled via firmware loader framework, so it
1623 must be installed in the proper path, typically,
1624 /lib/firmware.
1625 reset_time - How long to wait for a reset to take effect
1626 (default:2)
1627 ramcheck_time - How many seconds to wait for the RAM test
1628 (default:20)
1629 osrun_time - How many seconds to wait for the ICS2115 OS
1630 (default:10)
1631
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001632 This module supports multiple cards and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633
Takashi Iwaic2b12392007-08-21 15:20:26 +02001634 Note: the firmware file "wavefront.os" was located in the earlier
1635 version in /etc. Now it's loaded via firmware loader, and
1636 must be in the proper firmware path, such as /lib/firmware.
1637 Copy (or symlink) the file appropriately if you get an error
1638 regarding firmware downloading after upgrading the kernel.
1639
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 Module snd-sonicvibes
1641 ---------------------
1642
1643 Module for S3 SonicVibes PCI sound cards.
1644 * PINE Schubert 32 PCI
1645
1646 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1647 - SoundCard must have onboard SRAM for this.
1648 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1649
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001650 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651
1652 Module snd-serial-u16550
1653 ------------------------
1654
1655 Module for UART16550A serial MIDI ports.
1656
1657 port - port # for UART16550A chip
1658 irq - IRQ # for UART16550A chip, -1 = poll mode
1659 speed - speed in bauds (9600,19200,38400,57600,115200)
1660 38400 = default
1661 base - base for divisor in bauds (57600,115200,230400,460800)
1662 115200 = default
1663 outs - number of MIDI ports in a serial port (1-4)
1664 1 = default
1665 adaptor - Type of adaptor.
1666 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1667 3 = MS-124W M/B, 4 = Generic
1668
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001669 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 thus the main port must be specified!!! Other options are optional.
1671
1672 Module snd-trident
1673 ------------------
1674
1675 Module for Trident 4DWave DX/NX sound cards.
1676 * Best Union Miss Melody 4DWave PCI
1677 * HIS 4DWave PCI
1678 * Warpspeed ONSpeed 4DWave PCI
1679 * AzTech PCI 64-Q3D
1680 * Addonics SV 750
1681 * CHIC True Sound 4Dwave
1682 * Shark Predator4D-PCI
1683 * Jaton SonicWave 4D
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001684 * SiS SI7018 PCI Audio
1685 * Hoontech SoundTrack Digital 4DWave NX
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686
1687 pcm_channels - max channels (voices) reserved for PCM
1688 wavetable_size - max wavetable size in kB (4-?kb)
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 The power-management is supported.
1693
1694 Module snd-usb-audio
1695 --------------------
1696
1697 Module for USB audio and USB MIDI devices.
1698
1699 vid - Vendor ID for the device (optional)
1700 pid - Product ID for the device (optional)
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001701 nrpacks - Max. number of packets per URB (default: 8)
1702 async_unlink - Use async unlink mode (default: yes)
Thibault LE MEURe3113342006-03-14 11:44:53 +01001703 device_setup - Device specific magic number (optional)
1704 - Influence depends on the device
1705 - Default: 0x0000
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001706 ignore_ctl_error - Ignore any USB-controller regarding mixer
1707 interface (default: no)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001709 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001711 NB: nrpacks parameter can be modified dynamically via sysfs.
1712 Don't put the value over 20. Changing via sysfs has no sanity
1713 check.
1714 NB: async_unlink=0 would cause Oops. It remains just for
1715 debugging purpose (if any).
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001716 NB: ignore_ctl_error=1 may help when you get an error at accessing
1717 the mixer element such as URB error -22. This happens on some
1718 buggy USB device or the controller.
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001719
Daniel Mack523f1dc2007-03-26 19:11:24 +02001720 Module snd-usb-caiaq
1721 --------------------
1722
1723 Module for caiaq UB audio interfaces,
1724 * Native Instruments RigKontrol2
1725 * Native Instruments Kore Controller
1726 * Native Instruments Audio Kontrol 1
1727 * Native Instruments Audio 8 DJ
1728
1729 This module supports multiple devices, autoprobe and hotplugging.
1730
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731 Module snd-usb-usx2y
1732 --------------------
1733
1734 Module for Tascam USB US-122, US-224 and US-428 devices.
1735
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001736 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737
1738 Note: you need to load the firmware via usx2yloader utility included
1739 in alsa-tools and alsa-firmware packages.
1740
1741 Module snd-via82xx
1742 ------------------
1743
1744 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001745 8233A, 8233C, 8235, 8237 (south) bridge.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746
1747 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1748 [VIA686A/686B only]
1749 joystick - Enable joystick (default off) [VIA686A/686B only]
1750 ac97_clock - AC'97 codec clock base (default 48000Hz)
1751 dxs_support - support DXS channels,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001752 0 = auto (default), 1 = enable, 2 = disable,
1753 3 = 48k only, 4 = no VRA, 5 = enable any sample
1754 rate and different sample rates on different
1755 channels
1756 [VIA8233/C, 8235, 8237 only]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001758 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001760 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761
1762 Note: on some SMP motherboards like MSI 694D the interrupts might
1763 not be generated properly. In such a case, please try to
1764 set the SMP (or MPS) version on BIOS to 1.1 instead of
1765 default value 1.4. Then the interrupt number will be
1766 assigned under 15. You might also upgrade your BIOS.
1767
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001768 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 channels as the first PCM. On these channels, up to 4
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001770 streams can be played at the same time, and the controller
1771 can perform sample rate conversion with separate rates for
1772 each channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773 As default (dxs_support = 0), 48k fixed rate is chosen
1774 except for the known devices since the output is often
1775 noisy except for 48k on some mother boards due to the
1776 bug of BIOS.
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001777 Please try once dxs_support=5 and if it works on other
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1779 know the PCI subsystem vendor/device id's (output of
1780 "lspci -nv").
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001781 If dxs_support=5 does not work, try dxs_support=4; if it
1782 doesn't work too, try dxs_support=1. (dxs_support=1 is
Takashi Iwai62430082005-09-05 17:12:29 +02001783 usually for old motherboards. The correct implemented
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001784 board should work with 4 or 5.) If it still doesn't
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 work and the default setting is ok, dxs_support=3 is the
1786 right choice. If the default setting doesn't work at all,
1787 try dxs_support=2 to disable the DXS channels.
1788 In any cases, please let us know the result and the
Takashi Iwai62430082005-09-05 17:12:29 +02001789 subsystem vendor/device ids. See "Links and Addresses"
1790 below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791
1792 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Takashi Iwai62430082005-09-05 17:12:29 +02001793 additionally. The mpu_port option is for VIA686 chips only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794
Takashi Iwaia4efc232005-11-17 17:24:26 +01001795 The power-management is supported.
1796
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797 Module snd-via82xx-modem
1798 ------------------------
1799
1800 Module for VIA82xx AC97 modem
1801
1802 ac97_clock - AC'97 codec clock base (default 48000Hz)
1803
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001804 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805
1806 Note: The default index value of this module is -2, i.e. the first
1807 slot is excluded.
1808
Takashi Iwaia4efc232005-11-17 17:24:26 +01001809 The power-management is supported.
1810
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811 Module snd-virmidi
1812 ------------------
1813
1814 Module for virtual rawmidi devices.
1815 This module creates virtual rawmidi devices which communicate
1816 to the corresponding ALSA sequencer ports.
1817
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001818 midi_devs - MIDI devices # (1-4, default=4)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001820 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001822 Module snd-virtuoso
1823 -------------------
1824
Clemens Ladisch5430c722008-07-28 10:28:43 +02001825 Module for sound cards based on the Asus AV100/AV200 chips,
Clemens Ladisch7407a2e2008-09-22 09:12:11 +02001826 i.e., Xonar D1, DX, D2, D2X and HDAV1.3 (Deluxe).
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001827
1828 This module supports autoprobe and multiple cards.
1829
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 Module snd-vx222
1831 ----------------
1832
1833 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1834
1835 mic - Enable Microphone on V222 Mic (NYI)
1836 ibl - Capture IBL size. (default = 0, minimum size)
1837
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001838 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839
1840 When the driver is compiled as a module and the hotplug firmware
1841 is supported, the firmware data is loaded via hotplug automatically.
1842 Install the necessary firmware files in alsa-firmware package.
1843 When no hotplug fw loader is available, you need to load the
1844 firmware via vxloader utility in alsa-tools package. To invoke
1845 vxloader automatically, add the following to /etc/modprobe.conf
1846
1847 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1848
1849 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1850 /etc/modules.conf, instead.)
1851 IBL size defines the interrupts period for PCM. The smaller size
1852 gives smaller latency but leads to more CPU consumption, too.
1853 The size is usually aligned to 126. As default (=0), the smallest
1854 size is chosen. The possible IBL values can be found in
1855 /proc/asound/cardX/vx-status proc file.
1856
Takashi Iwaia4efc232005-11-17 17:24:26 +01001857 The power-management is supported.
1858
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 Module snd-vxpocket
1860 -------------------
1861
Takashi Iwai6d00a312005-06-30 13:40:51 +02001862 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863
1864 ibl - Capture IBL size. (default = 0, minimum size)
1865
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001866 This module supports multiple cards. The module is compiled only when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 PCMCIA is supported on kernel.
1868
Takashi Iwai62430082005-09-05 17:12:29 +02001869 With the older 2.6.x kernel, to activate the driver via the card
1870 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1871 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1872 longer require a config file.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873
1874 When the driver is compiled as a module and the hotplug firmware
1875 is supported, the firmware data is loaded via hotplug automatically.
1876 Install the necessary firmware files in alsa-firmware package.
1877 When no hotplug fw loader is available, you need to load the
1878 firmware via vxloader utility in alsa-tools package.
1879
1880 About capture IBL, see the description of snd-vx222 module.
1881
Takashi Iwaied7cbe32006-05-11 11:30:10 +02001882 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
Takashi Iwai62430082005-09-05 17:12:29 +02001883 ALSA 1.0.10.
1884
Takashi Iwaia4efc232005-11-17 17:24:26 +01001885 The power-management is supported.
1886
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887 Module snd-ymfpci
1888 -----------------
1889
1890 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1891
1892 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1893 1 (auto-detect for YMF744/754 only)
1894 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1895 1 (auto-detect for YMF744/754 only)
1896 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1897 1 (auto-detect)
1898 rear_switch - enable shared rear/line-in switch (bool)
1899
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001900 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901
1902 The power-management is supported.
1903
1904 Module snd-pdaudiocf
1905 --------------------
1906
1907 Module for Sound Core PDAudioCF sound card.
1908
Takashi Iwaia4efc232005-11-17 17:24:26 +01001909 The power-management is supported.
1910
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911
Takashi Iwai62430082005-09-05 17:12:29 +02001912AC97 Quirk Option
1913=================
1914
1915The ac97_quirk option is used to enable/override the workaround for
1916specific devices on drivers for on-board AC'97 controllers like
1917snd-intel8x0. Some hardware have swapped output pins between Master
1918and Headphone, or Surround (thanks to confusion of AC'97
1919specifications from version to version :-)
1920
1921The driver provides the auto-detection of known problematic devices,
1922but some might be unknown or wrongly detected. In such a case, pass
1923the proper value with this option.
1924
1925The following strings are accepted:
1926 - default Don't override the default setting
Takashi Iwai10e4097f2005-11-17 11:04:55 +01001927 - none Disable the quirk
Takashi Iwai62430082005-09-05 17:12:29 +02001928 - hp_only Bind Master and Headphone controls as a single control
1929 - swap_hp Swap headphone and master controls
1930 - swap_surround Swap master and surround controls
1931 - ad_sharing For AD1985, turn on OMS bit and use headphone
1932 - alc_jack For ALC65x, turn on the jack sense mode
1933 - inv_eapd Inverted EAPD implementation
1934 - mute_led Bind EAPD bit for turning on/off mute LED
1935
1936For backward compatibility, the corresponding integer value -1, 0,
1937... are accepted, too.
1938
1939For example, if "Master" volume control has no effect on your device
1940but only "Headphone" does, pass ac97_quirk=hp_only module option.
1941
1942
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943Configuring Non-ISAPNP Cards
1944============================
1945
1946When the kernel is configured with ISA-PnP support, the modules
1947supporting the isapnp cards will have module options "isapnp".
1948If this option is set, *only* the ISA-PnP devices will be probed.
1949For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
1950together with the proper i/o and irq configuration.
1951
1952When the kernel is configured without ISA-PnP support, isapnp option
1953will be not built in.
1954
1955
1956Module Autoloading Support
1957==========================
1958
1959The ALSA drivers can be loaded automatically on demand by defining
1960module aliases. The string 'snd-card-%1' is requested for ALSA native
1961devices where %i is sound card number from zero to seven.
1962
1963To auto-load an ALSA driver for OSS services, define the string
1964'sound-slot-%i' where %i means the slot number for OSS, which
1965corresponds to the card index of ALSA. Usually, define this
Tobias Klauserd533f672005-09-10 00:26:46 -07001966as the same card module.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967
1968An example configuration for a single emu10k1 card is like below:
1969----- /etc/modprobe.conf
1970alias snd-card-0 snd-emu10k1
1971alias sound-slot-0 snd-emu10k1
1972----- /etc/modprobe.conf
1973
1974The available number of auto-loaded sound cards depends on the module
1975option "cards_limit" of snd module. As default it's set to 1.
1976To enable the auto-loading of multiple cards, specify the number of
1977sound cards in that option.
1978
1979When multiple cards are available, it'd better to specify the index
1980number for each card via module option, too, so that the order of
1981cards is kept consistent.
1982
1983An example configuration for two sound cards is like below:
1984
1985----- /etc/modprobe.conf
1986# ALSA portion
1987options snd cards_limit=2
1988alias snd-card-0 snd-interwave
1989alias snd-card-1 snd-ens1371
1990options snd-interwave index=0
1991options snd-ens1371 index=1
1992# OSS/Free portion
1993alias sound-slot-0 snd-interwave
1994alias sound-slot-1 snd-ens1371
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02001995----- /etc/modprobe.conf
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996
1997In this example, the interwave card is always loaded as the first card
1998(index 0) and ens1371 as the second (index 1).
1999
Takashi Iwai304cd072007-10-26 15:10:15 +02002000Alternative (and new) way to fixate the slot assignment is to use
2001"slots" option of snd module. In the case above, specify like the
2002following:
2003
2004options snd slots=snd-interwave,snd-ens1371
2005
2006Then, the first slot (#0) is reserved for snd-interwave driver, and
2007the second (#1) for snd-ens1371. You can omit index option in each
2008driver if slots option is used (although you can still have them at
2009the same time as long as they don't conflict).
2010
2011The slots option is especially useful for avoiding the possible
2012hot-plugging and the resultant slot conflict. For example, in the
2013case above again, the first two slots are already reserved. If any
2014other driver (e.g. snd-usb-audio) is loaded before snd-interwave or
2015snd-ens1371, it will be assigned to the third or later slot.
2016
Takashi Iwaia93bbaa2008-05-27 17:59:24 +02002017When a module name is given with '!', the slot will be given for any
2018modules but that name. For example, "slots=!snd-pcsp" will reserve
2019the first slot for any modules but snd-pcsp.
2020
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021
2022ALSA PCM devices to OSS devices mapping
2023=======================================
2024
2025/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
2026/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
2027/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
2028/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
2029/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
2030/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
2031/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
2032/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
2033/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
2034
2035The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
2036sound card number and second means device number. The ALSA devices
2037have either 'c' or 'p' suffix indicating the direction, capture and
2038playback, respectively.
2039
2040Please note that the device mapping above may be varied via the module
2041options of snd-pcm-oss module.
2042
2043
Linus Torvalds1da177e2005-04-16 15:20:36 -07002044Proc interfaces (/proc/asound)
2045==============================
2046
2047/proc/asound/card#/pcm#[cp]/oss
2048-------------------------------
2049 String "erase" - erase all additional informations about OSS applications
2050 String "<app_name> <fragments> <fragment_size> [<options>]"
2051
2052 <app_name> - name of application with (higher priority) or without path
2053 <fragments> - number of fragments or zero if auto
2054 <fragment_size> - size of fragment in bytes or zero if auto
2055 <options> - optional parameters
2056 - disable the application tries to open a pcm device for
2057 this channel but does not want to use it.
2058 (Cause a bug or mmap needs)
2059 It's good for Quake etc...
2060 - direct don't use plugins
2061 - block force block mode (rvplayer)
2062 - non-block force non-block mode
2063 - whole-frag write only whole fragments (optimization affecting
2064 playback only)
2065 - no-silence do not fill silence ahead to avoid clicks
Takashi Iwai10f69f92005-09-08 13:48:34 +02002066 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
2067 instead of filled blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068
2069 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
2070 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
2071 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
2072
2073
Takashi Iwaib6a96912005-05-30 18:27:03 +02002074Early Buffer Allocation
2075=======================
2076
2077Some drivers (e.g. hdsp) require the large contiguous buffers, and
2078sometimes it's too late to find such spaces when the driver module is
2079actually loaded due to memory fragmentation. You can pre-allocate the
2080PCM buffers by loading snd-page-alloc module and write commands to its
2081proc file in prior, for example, in the early boot stage like
2082/etc/init.d/*.local scripts.
2083
2084Reading the proc file /proc/drivers/snd-page-alloc shows the current
2085usage of page allocation. In writing, you can send the following
2086commands to the snd-page-alloc driver:
2087
2088 - add VENDOR DEVICE MASK SIZE BUFFERS
2089
2090 VENDOR and DEVICE are PCI vendor and device IDs. They take
2091 integer numbers (0x prefix is needed for the hex).
2092 MASK is the PCI DMA mask. Pass 0 if not restricted.
2093 SIZE is the size of each buffer to allocate. You can pass
2094 k and m suffix for KB and MB. The max number is 16MB.
2095 BUFFERS is the number of buffers to allocate. It must be greater
2096 than 0. The max number is 4.
2097
2098 - erase
2099
2100 This will erase the all pre-allocated buffers which are not in
2101 use.
2102
2103
Takashi Iwai62430082005-09-05 17:12:29 +02002104Links and Addresses
2105===================
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106
2107 ALSA project homepage
2108 http://www.alsa-project.org
2109
Takashi Iwai30bc4482008-12-09 08:23:45 +01002110 Kernel Bugzilla
2111 http://bugzilla.kernel.org/
Takashi Iwai62430082005-09-05 17:12:29 +02002112
2113 ALSA Developers ML
Rene Herman45051792007-03-21 12:05:06 +01002114 mailto:alsa-devel@alsa-project.org
Takashi Iwai30bc4482008-12-09 08:23:45 +01002115
2116 alsa-info.sh script
2117 http://www.alsa-project.org/alsa-info.sh