blob: 57fe4f3ca2c046a616cb0cce392fa77faa406bee [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001
2 Advanced Linux Sound Architecture - Driver
3 ==========================================
4 Configuration guide
5
6
7Kernel Configuration
8====================
9
10To enable ALSA support you need at least to build the kernel with
11primary sound card support (CONFIG_SOUND). Since ALSA can emulate OSS,
12you don't have to choose any of the OSS modules.
13
14Enable "OSS API emulation" (CONFIG_SND_OSSEMUL) and both OSS mixer and
15PCM supports if you want to run OSS applications with ALSA.
16
17If you want to support the WaveTable functionality on cards such as
18SB Live! then you need to enable "Sequencer support"
19(CONFIG_SND_SEQUENCER).
20
21To make ALSA debug messages more verbose, enable the "Verbose printk"
22and "Debug" options. To check for memory leaks, turn on "Debug memory"
23too. "Debug detection" will add checks for the detection of cards.
24
25Please note that all the ALSA ISA drivers support the Linux isapnp API
26(if the card supports ISA PnP). You don't need to configure the cards
27using isapnptools.
28
29
30Creating ALSA devices
31=====================
32
33This depends on your distribution, but normally you use the /dev/MAKEDEV
34script to create the necessary device nodes. On some systems you use a
35script named 'snddevices'.
36
37
38Module parameters
39=================
40
41The user can load modules with options. If the module supports more than
42one card and you have more than one card of the same type then you can
43specify multiple values for the option separated by commas.
44
45Prior to version 0.9.0rc4 options had a 'snd_' prefix. This was removed.
46
47 Module snd
48 ----------
49
50 The core ALSA module. It is used by all ALSA card drivers.
51 It takes the following options which have global effects.
52
53 major - major number for sound driver
54 - Default: 116
55 cards_limit
56 - limiting card index for auto-loading (1-8)
57 - Default: 1
58 - For auto-loading more than one card, specify this
59 option together with snd-card-X aliases.
Takashi Iwai304cd072007-10-26 15:10:15 +020060 slots - Reserve the slot index for the given driver.
61 This option takes multiple strings.
62 See "Module Autoloading Support" section for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
64 Module snd-pcm-oss
65 ------------------
66
67 The PCM OSS emulation module.
68 This module takes options which change the mapping of devices.
69
70 dsp_map - PCM device number maps assigned to the 1st OSS device.
71 - Default: 0
72 adsp_map - PCM device number maps assigned to the 2st OSS device.
73 - Default: 1
74 nonblock_open
Takashi Iwai62430082005-09-05 17:12:29 +020075 - Don't block opening busy PCM devices. Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77 For example, when dsp_map=2, /dev/dsp will be mapped to PCM #2 of
78 the card #0. Similarly, when adsp_map=0, /dev/adsp will be mapped
79 to PCM #0 of the card #0.
80 For changing the second or later card, specify the option with
81 commas, such like "dsp_map=0,1".
82
83 nonblock_open option is used to change the behavior of the PCM
84 regarding opening the device. When this option is non-zero,
85 opening a busy OSS PCM device won't be blocked but return
86 immediately with EAGAIN (just like O_NONBLOCK flag).
87
88 Module snd-rawmidi
89 ------------------
90
91 This module takes options which change the mapping of devices.
92 similar to those of the snd-pcm-oss module.
93
94 midi_map - MIDI device number maps assigned to the 1st OSS device.
95 - Default: 0
96 amidi_map - MIDI device number maps assigned to the 2st OSS device.
97 - Default: 1
98
99 Common parameters for top sound card modules
100 --------------------------------------------
101
102 Each of top level sound card module takes the following options.
103
104 index - index (slot #) of sound card
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100105 - Values: 0 through 31 or negative
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 - If nonnegative, assign that index number
107 - if negative, interpret as a bitmask of permissible
108 indices; the first free permitted index is assigned
109 - Default: -1
110 id - card ID (identifier or name)
111 - Can be up to 15 characters long
112 - Default: the card type
113 - A directory by this name is created under /proc/asound/
114 containing information about the card
115 - This ID can be used instead of the index number in
116 identifying the card
117 enable - enable card
118 - Default: enabled, for PCI and ISA PnP cards
119
Rene Hermancf40a312006-03-28 12:38:20 +0200120 Module snd-adlib
121 ----------------
122
123 Module for AdLib FM cards.
124
125 port - port # for OPL chip
126
127 This module supports multiple cards. It does not support autoprobe, so
128 the port must be specified. For actual AdLib FM cards it will be 0x388.
129 Note that this card does not have PCM support and no mixer; only FM
130 synthesis.
131
132 Make sure you have "sbiload" from the alsa-tools package available and,
133 after loading the module, find out the assigned ALSA sequencer port
134 number through "sbiload -l". Example output:
135
136 Port Client name Port name
137 64:0 OPL2 FM synth OPL2 FM Port
138
139 Load the std.sb and drums.sb patches also supplied by sbiload:
140
141 sbiload -p 64:0 std.sb drums.sb
142
143 If you use this driver to drive an OPL3, you can use std.o3 and drums.o3
144 instead. To have the card produce sound, use aplaymidi from alsa-utils:
145
146 aplaymidi -p 64:0 foo.mid
147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 Module snd-ad1816a
149 ------------------
150
151 Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips.
152
Takashi Iwai506d4c62005-08-03 14:02:47 +0200153 clockfreq - Clock frequency for AD1816A chip (default = 0, 33000Hz)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100155 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
157 Module snd-ad1848
158 -----------------
159
160 Module for sound cards based on AD1848/AD1847/CS4248 ISA chips.
161
162 port - port # for AD1848 chip
163 irq - IRQ # for AD1848 chip
164 dma1 - DMA # for AD1848 chip (0,1,3)
165
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100166 This module supports multiple cards. It does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 thus main port must be specified!!! Other ports are optional.
168
Takashi Iwaia4efc232005-11-17 17:24:26 +0100169 The power-management is supported.
170
Clemens Ladisch84010e62005-09-02 07:57:59 +0200171 Module snd-ad1889
172 -----------------
173
174 Module for Analog Devices AD1889 chips.
175
176 ac97_quirk - AC'97 workaround for strange hardware
177 See the description of intel8x0 module for details.
178
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100179 This module supports multiple cards.
Clemens Ladisch84010e62005-09-02 07:57:59 +0200180
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 Module snd-ali5451
182 ------------------
183
184 Module for ALi M5451 PCI chip.
185
186 pcm_channels - Number of hardware channels assigned for PCM
187 spdif - Support SPDIF I/O
188 - Default: disabled
189
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +0200190 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
192 The power-management is supported.
193
194 Module snd-als100
195 -----------------
196
197 Module for sound cards based on Avance Logic ALS100/ALS120 ISA chips.
198
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100199 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Takashi Iwaia4efc232005-11-17 17:24:26 +0100201 The power-management is supported.
202
Ash Willisb3a70d52006-03-27 13:20:40 +0200203 Module snd-als300
204 -----------------
205
206 Module for Avance Logic ALS300 and ALS300+
207
208 This module supports multiple cards.
209
210 The power-management is supported.
211
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 Module snd-als4000
213 ------------------
214
215 Module for sound cards based on Avance Logic ALS4000 PCI chip.
216
217 joystick_port - port # for legacy joystick support.
218 0 = disabled (default), 1 = auto-detect
219
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100220 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Takashi Iwaia4efc232005-11-17 17:24:26 +0100222 The power-management is supported.
223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 Module snd-atiixp
225 -----------------
226
Takashi Iwai62430082005-09-05 17:12:29 +0200227 Module for ATI IXP 150/200/250/400 AC97 controllers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Takashi Iwai62430082005-09-05 17:12:29 +0200229 ac97_clock - AC'97 clock (default = 48000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200231 See "AC97 Quirk Option" section below.
Dan Carpenter14e1d352006-11-20 16:35:18 +0100232 ac97_codec - Workaround to specify which AC'97 codec
233 instead of probing. If this works for you
234 file a bug with your `lspci -vn` output.
235 -2 -- Force probing.
236 -1 -- Default behavior.
237 0-2 -- Use the specified codec.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 spdif_aclink - S/PDIF transfer over AC-link (default = 1)
239
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200240 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
Takashi Iwai62430082005-09-05 17:12:29 +0200242 ATI IXP has two different methods to control SPDIF output. One is
243 over AC-link and another is over the "direct" SPDIF output. The
244 implementation depends on the motherboard, and you'll need to
245 choose the correct one via spdif_aclink module option.
246
Takashi Iwaia4efc232005-11-17 17:24:26 +0100247 The power-management is supported.
248
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 Module snd-atiixp-modem
250 -----------------------
251
252 Module for ATI IXP 150/200/250 AC97 modem controllers.
253
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200254 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
256 Note: The default index value of this module is -2, i.e. the first
257 slot is excluded.
258
Takashi Iwaia4efc232005-11-17 17:24:26 +0100259 The power-management is supported.
260
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 Module snd-au8810, snd-au8820, snd-au8830
262 -----------------------------------------
263
264 Module for Aureal Vortex, Vortex2 and Advantage device.
265
266 pcifix - Control PCI workarounds
267 0 = Disable all workarounds
268 1 = Force the PCI latency of the Aureal card to 0xff
269 2 = Force the Extend PCI#2 Internal Master for Efficient
270 Handling of Dummy Requests on the VIA KT133 AGP Bridge
271 3 = Force both settings
272 255 = Autodetect what is required (default)
273
274 This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
275 EQ, mpu401, gameport. A3D and wavetable support are still in development.
276 Development and reverse engineering work is being coordinated at
277 http://savannah.nongnu.org/projects/openvortex/
278 SPDIF output has a copy of the AC97 codec output, unless you use the
279 "spdif" pcm device, which allows raw data passthru.
280 The hardware EQ hardware and SPDIF is only present in the Vortex2 and
281 Advantage.
282
Takashi Iwai62430082005-09-05 17:12:29 +0200283 Note: Some ALSA mixer applications don't handle the SPDIF sample rate
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 control correctly. If you have problems regarding this, try
285 another ALSA compliant mixer (alsamixer works).
286
Takashi Iwai9e235322008-02-20 12:13:29 +0100287 Module snd-aw2
288 --------------
289
290 Module for Audiowerk2 sound card
291
292 This module supports multiple cards.
293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 Module snd-azt2320
295 ------------------
296
297 Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
298
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100299 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
Takashi Iwaia4efc232005-11-17 17:24:26 +0100301 The power-management is supported.
302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 Module snd-azt3328
304 ------------------
305
306 Module for sound cards based on Aztech AZF3328 PCI chip.
307
308 joystick - Enable joystick (default off)
309
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100310 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
312 Module snd-bt87x
313 ----------------
314
315 Module for video cards based on Bt87x chips.
316
317 digital_rate - Override the default digital rate (Hz)
318 load_all - Load the driver even if the card model isn't known
319
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100320 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
322 Note: The default index value of this module is -2, i.e. the first
323 slot is excluded.
324
325 Module snd-ca0106
326 -----------------
327
328 Module for Creative Audigy LS and SB Live 24bit
329
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100330 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
332
333 Module snd-cmi8330
334 ------------------
335
336 Module for sound cards based on C-Media CMI8330 ISA chips.
337
Rene Herman64e0e2d2007-12-13 16:29:33 +0100338 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
339
340 with isapnp=0, the following options are available:
341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 wssport - port # for CMI8330 chip (WSS)
343 wssirq - IRQ # for CMI8330 chip (WSS)
344 wssdma - first DMA # for CMI8330 chip (WSS)
345 sbport - port # for CMI8330 chip (SB16)
346 sbirq - IRQ # for CMI8330 chip (SB16)
347 sbdma8 - 8bit DMA # for CMI8330 chip (SB16)
348 sbdma16 - 16bit DMA # for CMI8330 chip (SB16)
Takashi Iwai9e128fd2009-01-29 11:49:10 +0100349 fmport - (optional) OPL3 I/O port
350 mpuport - (optional) MPU401 I/O port
351 mpuirq - (optional) MPU401 irq #
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100353 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
Takashi Iwaia4efc232005-11-17 17:24:26 +0100355 The power-management is supported.
356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 Module snd-cmipci
358 -----------------
359
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200360 Module for C-Media CMI8338/8738/8768/8770 PCI sound cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
Clemens Ladischc78c9502007-09-03 09:55:49 +0200362 mpu_port - port address of MIDI interface (8338 only):
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200363 0x300,0x310,0x320,0x330 = legacy port,
Takashi Iwaicab5c4c2006-05-04 14:36:08 +0200364 0 = disable (default)
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200365 fm_port - port address of OPL-3 FM synthesizer (8x38 only):
366 0x388 = legacy port,
367 1 = integrated PCI port (default on 8738),
Takashi Iwai2f24d1592007-02-15 18:56:43 +0100368 0 = disable
Takashi Iwai62430082005-09-05 17:12:29 +0200369 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 (default = 1)
371 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
372
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100373 This module supports autoprobe and multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
Takashi Iwaia4efc232005-11-17 17:24:26 +0100375 The power-management is supported.
376
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 Module snd-cs4231
378 -----------------
379
380 Module for sound cards based on CS4231 ISA chips.
381
382 port - port # for CS4231 chip
383 mpu_port - port # for MPU-401 UART (optional), -1 = disable
384 irq - IRQ # for CS4231 chip
385 mpu_irq - IRQ # for MPU-401 UART
386 dma1 - first DMA # for CS4231 chip
387 dma2 - second DMA # for CS4231 chip
388
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100389 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 thus main port must be specified!!! Other ports are optional.
391
392 The power-management is supported.
393
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 Module snd-cs4236
395 -----------------
396
Takashi Iwaic844a5d2009-02-16 23:17:33 +0100397 Module for sound cards based on CS4232/CS4232A,
398 CS4235/CS4236/CS4236B/CS4237B/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 CS4238B/CS4239 ISA chips.
400
Rene Herman64e0e2d2007-12-13 16:29:33 +0100401 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
402
403 with isapnp=0, the following options are available:
404
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 port - port # for CS4236 chip (PnP setup - 0x534)
406 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
407 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
408 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
409 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
410 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
411 dma1 - first DMA # for CS4236 chip (0,1,3)
412 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100414 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 (if ISA PnP is not used) thus main port and control port must be
416 specified!!! Other ports are optional.
417
418 The power-management is supported.
419
Takashi Iwaic844a5d2009-02-16 23:17:33 +0100420 This module is aliased as snd-cs4232 since it provides the old
421 snd-cs4232 functionality, too.
422
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 Module snd-cs4281
424 -----------------
425
426 Module for Cirrus Logic CS4281 soundchip.
427
428 dual_codec - Secondary codec ID (0 = disable, default)
429
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100430 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
432 The power-management is supported.
433
434 Module snd-cs46xx
435 -----------------
436
437 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
438 CS4624/CS4630/CS4280 PCI chips.
439
Takashi Iwai62430082005-09-05 17:12:29 +0200440 external_amp - Force to enable external amplifier.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 thinkpad - Force to enable Thinkpad's CLKRUN control.
442 mmap_valid - Support OSS mmap mode (default = 0).
443
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100444 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 Usually external amp and CLKRUN controls are detected automatically
446 from PCI sub vendor/device ids. If they don't work, give the options
447 above explicitly.
448
449 The power-management is supported.
Takashi Iwai621887a2007-05-24 18:46:54 +0200450
451 Module snd-cs5530
452 _________________
453
454 Module for Cyrix/NatSemi Geode 5530 chip.
455
Takashi Iwai3e873172005-11-17 10:15:37 +0100456 Module snd-cs5535audio
457 ----------------------
458
459 Module for multifunction CS5535 companion PCI device
460
Takashi Iwaic00bd742006-05-19 19:22:34 +0200461 The power-management is supported.
Takashi Iwai3e873172005-11-17 10:15:37 +0100462
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200463 Module snd-darla20
464 ------------------
465
466 Module for Echoaudio Darla20
467
468 This module supports multiple cards.
469 The driver requires the firmware loader support on kernel.
470
471 Module snd-darla24
472 ------------------
473
474 Module for Echoaudio Darla24
475
476 This module supports multiple cards.
477 The driver requires the firmware loader support on kernel.
478
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 Module snd-dt019x
480 -----------------
481
482 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
483 only)
484
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100485 This module supports multiple cards. This module is enabled only with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 ISA PnP support.
487
Takashi Iwaia4efc232005-11-17 17:24:26 +0100488 The power-management is supported.
489
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 Module snd-dummy
491 ----------------
492
493 Module for the dummy sound card. This "card" doesn't do any output
494 or input, but you may use this module for any application which
495 requires a sound card (like RealPlayer).
496
Takashi Iwaia4efc232005-11-17 17:24:26 +0100497 The power-management is supported.
498
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200499 Module snd-echo3g
500 -----------------
501
502 Module for Echoaudio 3G cards (Gina3G/Layla3G)
503
504 This module supports multiple cards.
505 The driver requires the firmware loader support on kernel.
506
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 Module snd-emu10k1
508 ------------------
509
510 Module for EMU10K1/EMU10k2 based PCI sound cards.
511 * Sound Blaster Live!
512 * Sound Blaster PCI 512
513 * Emu APS (partially supported)
514 * Sound Blaster Audigy
515
516 extin - bitmap of available external inputs for FX8010 (see bellow)
517 extout - bitmap of available external outputs for FX8010 (see bellow)
518 seq_ports - allocated sequencer ports (4 by default)
519 max_synth_voices - limit of voices used for wavetable (64 by default)
520 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
521 given in MB unit. Default value is 128.
522 enable_ir - enable IR
523
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100524 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
526 Input & Output configurations [extin/extout]
527 * Creative Card wo/Digital out [0x0003/0x1f03]
528 * Creative Card w/Digital out [0x0003/0x1f0f]
529 * Creative Card w/Digital CD in [0x000f/0x1f0f]
530 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
531 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
532 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
533 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
534 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
535 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
536 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
537 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
538 * Creative Card all ins and outs [0x3fff/0x7fff]
539
Takashi Iwaia4efc232005-11-17 17:24:26 +0100540 The power-management is supported.
541
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 Module snd-emu10k1x
543 -------------------
544
545 Module for Creative Emu10k1X (SB Live Dell OEM version)
546
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100547 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
549 Module snd-ens1370
550 ------------------
551
552 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
553 * SoundBlaster PCI 64
554 * SoundBlaster PCI 128
555
556 joystick - Enable joystick (default off)
557
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100558 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100560 The power-management is supported.
561
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 Module snd-ens1371
563 ------------------
564
565 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
566 * SoundBlaster PCI 64
567 * SoundBlaster PCI 128
568 * SoundBlaster Vibra PCI
569
570 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
571 0 = disable (default), 1 = auto-detect
572
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100573 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100575 The power-management is supported.
576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 Module snd-es968
578 ----------------
579
580 Module for sound cards based on ESS ES968 chip (PnP only).
581
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100582 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583
Takashi Iwaia4efc232005-11-17 17:24:26 +0100584 The power-management is supported.
585
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 Module snd-es1688
587 -----------------
588
589 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
590
591 port - port # for ES-1688 chip (0x220,0x240,0x260)
Takashi Iwai504a06d2009-01-30 19:59:10 +0100592 fm_port - port # for OPL3 (option; share the same port as default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
594 irq - IRQ # for ES-1688 chip (5,7,9,10)
595 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
596 dma8 - DMA # for ES-1688 chip (0,1,3)
597
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100598 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
600 Module snd-es18xx
601 -----------------
602
603 Module for ESS AudioDrive ES-18xx sound cards.
604
Rene Herman64e0e2d2007-12-13 16:29:33 +0100605 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
606
607 with isapnp=0, the following options are available:
608
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 port - port # for ES-18xx chip (0x220,0x240,0x260)
610 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
611 fm_port - port # for FM (optional, not used)
612 irq - IRQ # for ES-18xx chip (5,7,9,10)
613 dma1 - first DMA # for ES-18xx chip (0,1,3)
614 dma2 - first DMA # for ES-18xx chip (0,1,3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100616 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
617 port if native ISA PnP routines are not used).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 When dma2 is equal with dma1, the driver works as half-duplex.
619
620 The power-management is supported.
621
622 Module snd-es1938
623 -----------------
624
625 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
626
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100627 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
Takashi Iwaia4efc232005-11-17 17:24:26 +0100629 The power-management is supported.
630
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 Module snd-es1968
632 -----------------
633
634 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
635
636 total_bufsize - total buffer size in kB (1-4096kB)
637 pcm_substreams_p - playback channels (1-8, default=2)
638 pcm_substreams_c - capture channels (1-8, default=0)
639 clock - clock (0 = auto-detection)
640 use_pm - support the power-management (0 = off, 1 = on,
641 2 = auto (default))
642 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
643 joystick - enable joystick (default off)
644
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100645 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646
647 The power-management is supported.
648
649 Module snd-fm801
650 ----------------
651
652 Module for ForteMedia FM801 based PCI sound cards.
653
654 tea575x_tuner - Enable TEA575x tuner
655 - 1 = MediaForte 256-PCS
656 - 2 = MediaForte 256-PCPR
657 - 3 = MediaForte 64-PCR
658 - High 16-bits are video (radio) device number + 1
659 - example: 0x10002 (MediaForte 256-PCPR, device 1)
660
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100661 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662
Takashi Iwaia4efc232005-11-17 17:24:26 +0100663 The power-management is supported.
664
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200665 Module snd-gina20
666 -----------------
667
668 Module for Echoaudio Gina20
669
670 This module supports multiple cards.
671 The driver requires the firmware loader support on kernel.
672
673 Module snd-gina24
674 -----------------
675
676 Module for Echoaudio Gina24
677
678 This module supports multiple cards.
679 The driver requires the firmware loader support on kernel.
680
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 Module snd-gusclassic
682 ---------------------
683
684 Module for Gravis UltraSound Classic sound card.
685
686 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
687 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
688 dma1 - DMA # for GF1 chip (1,3,5,6,7)
689 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
690 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
691 voices - GF1 voices limit (14-32)
692 pcm_voices - reserved PCM voices
693
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100694 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695
696 Module snd-gusextreme
697 ---------------------
698
699 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
700
701 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
702 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
703 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
704 irq - IRQ # for ES-1688 chip (5,7,9,10)
705 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
706 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
707 dma8 - DMA # for ES-1688 chip (0,1,3)
708 dma1 - DMA # for GF1 chip (1,3,5,6,7)
709 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
710 voices - GF1 voices limit (14-32)
711 pcm_voices - reserved PCM voices
712
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100713 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
715 Module snd-gusmax
716 -----------------
717
718 Module for Gravis UltraSound MAX sound card.
719
720 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
721 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
722 dma1 - DMA # for GF1 chip (1,3,5,6,7)
723 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
724 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
725 voices - GF1 voices limit (14-32)
726 pcm_voices - reserved PCM voices
727
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100728 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729
730 Module snd-hda-intel
731 --------------------
732
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400733 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8, ICH9, ICH10,
734 PCH, SCH),
735 ATI SB450, SB600, R600, RS600, RS690, RS780, RV610, RV620,
736 RV630, RV635, RV670, RV770,
Takashi Iwai9b878192006-05-17 11:26:39 +0200737 VIA VT8251/VT8237A,
738 SIS966, ULI M5461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100740 [Multiple options for each card instance]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 model - force the model name
Takashi Iwaid2e1c972008-06-10 17:53:34 +0200742 position_fix - Fix DMA pointer (0 = auto, 1 = use LPIB, 2 = POSBUF)
Takashi Iwai95904742007-05-19 17:06:42 +0200743 probe_mask - Bitmask to probe codecs (default = -1, meaning all slots)
Takashi Iwaid4d9cd032008-12-19 15:19:11 +0100744 probe_only - Only probing and no codec initialization (default=off);
745 Useful to check the initial codec status for debugging
Takashi Iwai8c53b962008-06-10 17:53:35 +0200746 bdl_pos_adj - Specifies the DMA IRQ timing delay in samples.
747 Passing -1 will make the driver to choose the appropriate
748 value based on the controller chip.
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100749
750 [Single (global) options]
Takashi Iwai27346162006-01-12 18:28:44 +0100751 single_cmd - Use single immediate commands to communicate with
752 codecs (for debugging only)
Takashi Iwai134a11f2006-11-10 12:08:37 +0100753 enable_msi - Enable Message Signaled Interrupt (MSI) (default = off)
Takashi Iwaidee1b662007-08-13 16:10:30 +0200754 power_save - Automatic power-saving timtout (in second, 0 =
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200755 disable)
Takashi Iwaidee1b662007-08-13 16:10:30 +0200756 power_save_controller - Reset HD-audio controller in power-saving mode
757 (default = on)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100759 This module supports multiple cards and autoprobe.
760
Takashi Iwaicae51172008-12-19 08:36:53 +0100761 See Documentation/sound/alsa/HD-Audio.txt for more details about
762 HD-audio driver.
763
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 Each codec may have a model table for different configurations.
765 If your machine isn't listed there, the default (usually minimal)
766 configuration is set up. You can pass "model=<name>" option to
767 specify a certain model in such a case. There are different
Takashi Iwaicae51172008-12-19 08:36:53 +0100768 models depending on the codec chip. The list of available models
769 is found in HD-Audio-Models.txt
Takashi Iwaidb064e52006-03-16 16:04:58 +0100770
Takashi Iwai6d7b1d72007-02-26 15:56:46 +0100771 The model name "genric" is treated as a special case. When this
772 model is given, the driver uses the generic codec parser without
773 "codec-patch". It's sometimes good for testing and debugging.
774
Takashi Iwai62430082005-09-05 17:12:29 +0200775 If the default configuration doesn't work and one of the above
Takashi Iwai30bc4482008-12-09 08:23:45 +0100776 matches with your device, report it together with alsa-info.sh
777 output (with --no-upload option) to kernel bugzilla or alsa-devel
Takashi Iwai62430082005-09-05 17:12:29 +0200778 ML (see the section "Links and Addresses").
779
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200780 power_save and power_save_controller options are for power-saving
781 mode. See powersave.txt for details.
Takashi Iwaidee1b662007-08-13 16:10:30 +0200782
Takashi Iwaic74db862005-05-12 14:26:27 +0200783 Note 2: If you get click noises on output, try the module option
784 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
785 register value without FIFO size correction as the current
786 DMA pointer. position_fix=2 will make the driver to use
787 the position buffer instead of reading SD_LPIB register.
Michael Kerrisk90f31e32008-09-01 14:03:50 +0200788 (Usually SD_LPIB register is more accurate than the
Takashi Iwaic74db862005-05-12 14:26:27 +0200789 position buffer.)
790
Takashi Iwai27346162006-01-12 18:28:44 +0100791 NB: If you get many "azx_get_response timeout" messages at
792 loading, it's likely a problem of interrupts (e.g. ACPI irq
793 routing). Try to boot with options like "pci=noacpi". Also, you
794 can try "single_cmd=1" module option. This will switch the
795 communication method between HDA controller and codecs to the
796 single immediate commands instead of CORB/RIRB. Basically, the
797 single command mode is provided only for BIOS, and you won't get
798 unsolicited events, too. But, at least, this works independently
799 from the irq. Remember this is a last resort, and should be
800 avoided as much as possible...
801
Takashi Iwai95904742007-05-19 17:06:42 +0200802 MORE NOTES ON "azx_get_response timeout" PROBLEMS:
803 On some hardwares, you may need to add a proper probe_mask option
804 to avoid the "azx_get_response timeout" problem above, instead.
805 This occurs when the access to non-existing or non-working codec slot
806 (likely a modem one) causes a stall of the communication via HD-audio
807 bus. You can see which codec slots are probed by enabling
Takashi Iwai62cf8722008-05-20 12:15:15 +0200808 CONFIG_SND_DEBUG_VERBOSE, or simply from the file name of the codec
Takashi Iwai95904742007-05-19 17:06:42 +0200809 proc files. Then limit the slots to probe by probe_mask option.
810 For example, probe_mask=1 means to probe only the first slot, and
811 probe_mask=4 means only the third slot.
812
Takashi Iwaia4efc232005-11-17 17:24:26 +0100813 The power-management is supported.
814
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 Module snd-hdsp
816 ---------------
817
818 Module for RME Hammerfall DSP audio interface(s)
819
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100820 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821
822 Note: The firmware data can be automatically loaded via hotplug
823 when CONFIG_FW_LOADER is set. Otherwise, you need to load
824 the firmware via hdsploader utility included in alsa-tools
825 package.
826 The firmware data is found in alsa-firmware package.
827
828 Note: snd-page-alloc module does the job which snd-hammerfall-mem
829 module did formerly. It will allocate the buffers in advance
830 when any HDSP cards are found. To make the buffer
831 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +0200832 stage of boot sequence. See "Early Buffer Allocation"
833 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
Takashi Iwai54704402005-06-03 11:27:00 +0200835 Module snd-hdspm
836 ----------------
837
838 Module for RME HDSP MADI board.
839
840 precise_ptr - Enable precise pointer, or disable.
841 line_outs_monitor - Send playback streams to analog outs by default.
842 enable_monitor - Enable Analog Out on Channel 63/64 by default.
843
844 See hdspm.txt for details.
845
Clemens Ladischc6260262008-01-25 08:41:52 +0100846 Module snd-hifier
847 -----------------
848
849 Module for the MediaTek/TempoTec HiFier Fantasia sound card.
850
851 This module supports autoprobe and multiple cards.
852
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 Module snd-ice1712
854 ------------------
855
856 Module for Envy24 (ICE1712) based PCI sound cards.
857 * MidiMan M Audio Delta 1010
858 * MidiMan M Audio Delta 1010LT
859 * MidiMan M Audio Delta DiO 2496
860 * MidiMan M Audio Delta 66
861 * MidiMan M Audio Delta 44
862 * MidiMan M Audio Delta 410
863 * MidiMan M Audio Audiophile 2496
864 * TerraTec EWS 88MT
865 * TerraTec EWS 88D
866 * TerraTec EWX 24/96
867 * TerraTec DMX 6Fire
Takashi Iwaic9bce912005-05-24 13:41:03 +0200868 * TerraTec Phase 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 * Hoontech SoundTrack DSP 24
870 * Hoontech SoundTrack DSP 24 Value
871 * Hoontech SoundTrack DSP 24 Media 7.1
Takashi Iwaic9bce912005-05-24 13:41:03 +0200872 * Event Electronics, EZ8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 * Digigram VX442
Takashi Iwaic9bce912005-05-24 13:41:03 +0200874 * Lionstracs, Mediastaton
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400875 * Terrasoniq TS 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876
877 model - Use the given board model, one of the following:
878 delta1010, dio2496, delta66, delta44, audiophile, delta410,
879 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
Takashi Iwaic9bce912005-05-24 13:41:03 +0200880 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
881 phase88, mediastation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 omni - Omni I/O support for MidiMan M-Audio Delta44/66
Matt LaPlantefa00e7e2006-11-30 04:55:36 +0100883 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transceiver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 in msec resolution, default value is 500 (0.5 sec)
885
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100886 This module supports multiple cards and autoprobe. Note: The consumer part
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 is not used with all Envy24 based cards (for example in the MidiMan Delta
888 serie).
889
Takashi Iwaic9bce912005-05-24 13:41:03 +0200890 Note: The supported board is detected by reading EEPROM or PCI
891 SSID (if EEPROM isn't available). You can override the
892 model by passing "model" module option in case that the
893 driver isn't configured properly or you want to try another
894 type for testing.
895
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 Module snd-ice1724
897 ------------------
898
Takashi Iwaic9bce912005-05-24 13:41:03 +0200899 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100900 * MidiMan M Audio Revolution 5.1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 * MidiMan M Audio Revolution 7.1
Takashi Iwai56255062006-11-09 16:47:26 +0100902 * MidiMan M Audio Audiophile 192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 * AMP Ltd AUDIO2000
Takashi Iwaic9bce912005-05-24 13:41:03 +0200904 * TerraTec Aureon 5.1 Sky
905 * TerraTec Aureon 7.1 Space
906 * TerraTec Aureon 7.1 Universe
907 * TerraTec Phase 22
908 * TerraTec Phase 28
909 * AudioTrak Prodigy 7.1
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400910 * AudioTrak Prodigy 7.1 LT
911 * AudioTrak Prodigy 7.1 XT
912 * AudioTrak Prodigy 7.1 HIFI
913 * AudioTrak Prodigy 7.1 HD2
Takashi Iwaic9bce912005-05-24 13:41:03 +0200914 * AudioTrak Prodigy 192
915 * Pontis MS300
916 * Albatron K8X800 Pro II
917 * Chaintech ZNF3-150
918 * Chaintech ZNF3-250
919 * Chaintech 9CJS
Takashi Iwai8cfbbac2005-05-27 12:10:40 +0200920 * Chaintech AV-710
Takashi Iwaic9bce912005-05-24 13:41:03 +0200921 * Shuttle SN25P
Shin-ya Okadaf31639b2007-10-23 15:08:18 +0200922 * Onkyo SE-90PCI
923 * Onkyo SE-200PCI
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400924 * ESI Juli@
925 * Hercules Fortissimo IV
926 * EGO-SYS WaveTerminal 192M
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927
928 model - Use the given board model, one of the following:
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100929 revo51, revo71, amp2000, prodigy71, prodigy71lt,
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400930 prodigy71xt, prodigy71hifi, prodigyhd2, prodigy192,
931 juli, aureon51, aureon71, universe, ap192, k8x800,
932 phase22, phase28, ms300, av710, se200pci, se90pci,
933 fortissimo4, sn25p, WT192M
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100935 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936
Takashi Iwaic9bce912005-05-24 13:41:03 +0200937 Note: The supported board is detected by reading EEPROM or PCI
938 SSID (if EEPROM isn't available). You can override the
939 model by passing "model" module option in case that the
940 driver isn't configured properly or you want to try another
941 type for testing.
942
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200943 Module snd-indigo
944 -----------------
945
946 Module for Echoaudio Indigo
947
948 This module supports multiple cards.
949 The driver requires the firmware loader support on kernel.
950
951 Module snd-indigodj
952 -------------------
953
954 Module for Echoaudio Indigo DJ
955
956 This module supports multiple cards.
957 The driver requires the firmware loader support on kernel.
958
959 Module snd-indigoio
960 -------------------
961
962 Module for Echoaudio Indigo IO
963
964 This module supports multiple cards.
965 The driver requires the firmware loader support on kernel.
966
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 Module snd-intel8x0
968 -------------------
969
970 Module for AC'97 motherboards from Intel and compatibles.
971 * Intel i810/810E, i815, i820, i830, i84x, MX440
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400972 ICH5, ICH6, ICH7, 6300ESB, ESB2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 * SiS 7012 (SiS 735)
Takashi Iwai89ac9c22006-01-24 10:36:57 +0100974 * NVidia NForce, NForce2, NForce3, MCP04, CK804
975 CK8, CK8S, MCP501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976 * AMD AMD768, AMD8111
977 * ALi m5455
978
979 ac97_clock - AC'97 codec clock base (0 = auto-detect)
980 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200981 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 buggy_irq - Enable workaround for buggy interrupts on some
Takashi Iwaia06147d2005-09-08 19:54:17 +0200983 motherboards (default yes on nForce chips,
984 otherwise off)
985 buggy_semaphore - Enable workaround for hardwares with buggy
986 semaphores (e.g. on some ASUS laptops)
987 (default off)
Takashi Iwai6c5cfd92006-11-28 17:18:25 +0100988 spdif_aclink - Use S/PDIF over AC-link instead of direct connection
989 from the controller chip
990 (0 = off, 1 = on, -1 = default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200992 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993
994 Note: the latest driver supports auto-detection of chip clock.
995 if you still encounter too fast playback, specify the clock
996 explicitly via the module option "ac97_clock=41194".
997
998 Joystick/MIDI ports are not supported by this driver. If your
999 motherboard has these devices, use the ns558 or snd-mpu401
1000 modules, respectively.
1001
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 The power-management is supported.
1003
1004 Module snd-intel8x0m
1005 --------------------
1006
1007 Module for Intel ICH (i8x0) chipset MC97 modems.
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001008 * Intel i810/810E, i815, i820, i830, i84x, MX440
1009 ICH5, ICH6, ICH7
1010 * SiS 7013 (SiS 735)
1011 * NVidia NForce, NForce2, NForce2s, NForce3
1012 * AMD AMD8111
1013 * ALi m5455
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014
1015 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1016
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001017 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018
1019 Note: The default index value of this module is -2, i.e. the first
1020 slot is excluded.
1021
Takashi Iwaia4efc232005-11-17 17:24:26 +01001022 The power-management is supported.
1023
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 Module snd-interwave
1025 --------------------
1026
1027 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1028 and other sound cards based on AMD InterWave (tm) chip.
1029
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1031 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1032 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1033 effect - 1 = InterWave effects enable (default 0);
1034 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001035 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1036
1037 with isapnp=0, the following options are available:
1038
1039 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1040 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1041 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1042 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001044 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045
1046 Module snd-interwave-stb
1047 ------------------------
1048
1049 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1050 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1051 circuit for extended control of bass, treble and master volume.
1052
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1054 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1055 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1056 effect - 1 = InterWave effects enable (default 0);
1057 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001058 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1059
1060 with isapnp=0, the following options are available:
1061
1062 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1063 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1064 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1065 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1066 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001068 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069
1070 Module snd-korg1212
1071 -------------------
1072
1073 Module for Korg 1212 IO PCI card
1074
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001075 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001077 Module snd-layla20
1078 ------------------
1079
1080 Module for Echoaudio Layla20
1081
1082 This module supports multiple cards.
1083 The driver requires the firmware loader support on kernel.
1084
1085 Module snd-layla24
1086 ------------------
1087
1088 Module for Echoaudio Layla24
1089
1090 This module supports multiple cards.
1091 The driver requires the firmware loader support on kernel.
1092
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 Module snd-maestro3
1094 -------------------
1095
1096 Module for Allegro/Maestro3 chips
1097
1098 external_amp - enable external amp (enabled by default)
1099 amp_gpio - GPIO pin number for external amp (0-15) or
1100 -1 for default pin (8 for allegro, 1 for
1101 others)
1102
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001103 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104
1105 Note: the binding of amplifier is dependent on hardware.
1106 If there is no sound even though all channels are unmuted, try to
1107 specify other gpio connection via amp_gpio option.
1108 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1109 option.
1110
1111 The power-management is supported.
1112
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001113 Module snd-mia
1114 ---------------
1115
1116 Module for Echoaudio Mia
1117
1118 This module supports multiple cards.
1119 The driver requires the firmware loader support on kernel.
1120
Martin Langer1841f6132006-03-27 12:41:01 +02001121 Module snd-miro
1122 ---------------
1123
1124 Module for Miro soundcards: miroSOUND PCM 1 pro,
1125 miroSOUND PCM 12,
1126 miroSOUND PCM 20 Radio.
1127
1128 port - Port # (0x530,0x604,0xe80,0xf40)
1129 irq - IRQ # (5,7,9,10,11)
1130 dma1 - 1st dma # (0,1,3)
1131 dma2 - 2nd dma # (0,1)
1132 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1133 mpu_irq - MPU-401 irq # (5,7,9,10)
1134 fm_port - FM Port # (0x388)
1135 wss - enable WSS mode
1136 ide - enable onboard ide support
1137
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 Module snd-mixart
1139 -----------------
1140
1141 Module for Digigram miXart8 sound cards.
1142
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001143 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 Note: One miXart8 board will be represented as 4 alsa cards.
1145 See MIXART.txt for details.
1146
1147 When the driver is compiled as a module and the hotplug firmware
1148 is supported, the firmware data is loaded via hotplug automatically.
1149 Install the necessary firmware files in alsa-firmware package.
1150 When no hotplug fw loader is available, you need to load the
1151 firmware via mixartloader utility in alsa-tools package.
1152
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001153 Module snd-mona
1154 ---------------
1155
1156 Module for Echoaudio Mona
1157
1158 This module supports multiple cards.
1159 The driver requires the firmware loader support on kernel.
1160
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161 Module snd-mpu401
1162 -----------------
1163
1164 Module for MPU-401 UART devices.
1165
1166 port - port number or -1 (disable)
1167 irq - IRQ number or -1 (disable)
1168 pnp - PnP detection - 0 = disable, 1 = enable (default)
1169
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001170 This module supports multiple devices and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001171
1172 Module snd-mtpav
1173 ----------------
1174
1175 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1176 port).
1177
1178 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1179 irq - IRQ # for MTPAV (7,5, default=7)
1180 hwports - number of supported hardware ports, default=8.
1181
1182 Module supports only 1 card. This module has no enable option.
1183
Matthias Koenig68ab8012006-07-27 16:59:23 +02001184 Module snd-mts64
1185 ----------------
1186
1187 Module for Ego Systems (ESI) Miditerminal 4140
1188
1189 This module supports multiple devices.
1190 Requires parport (CONFIG_PARPORT).
1191
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 Module snd-nm256
1193 ----------------
1194
1195 Module for NeoMagic NM256AV/ZX chips
1196
1197 playback_bufsize - max playback frame size in kB (4-128kB)
1198 capture_bufsize - max capture frame size in kB (4-128kB)
1199 force_ac97 - 0 or 1 (disabled by default)
1200 buffer_top - specify buffer top address
1201 use_cache - 0 or 1 (disabled by default)
1202 vaio_hack - alias buffer_top=0x25a800
1203 reset_workaround - enable AC97 RESET workaround for some laptops
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001204 reset_workaround2 - enable extended AC97 RESET workaround for some
1205 other laptops
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +02001207 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208
1209 The power-management is supported.
1210
1211 Note: on some notebooks the buffer address cannot be detected
1212 automatically, or causes hang-up during initialization.
Matt LaPlantefff92892006-10-03 22:47:42 +02001213 In such a case, specify the buffer top address explicitly via
1214 the buffer_top option.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215 For example,
1216 Sony F250: buffer_top=0x25a800
1217 Sony F270: buffer_top=0x272800
1218 The driver supports only ac97 codec. It's possible to force
1219 to initialize/use ac97 although it's not detected. In such a
1220 case, use force_ac97=1 option - but *NO* guarantee whether it
1221 works!
1222
1223 Note: The NM256 chip can be linked internally with non-AC97
1224 codecs. This driver supports only the AC97 codec, and won't work
1225 with machines with other (most likely CS423x or OPL3SAx) chips,
1226 even though the device is detected in lspci. In such a case, try
1227 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
Takashi Iwai62430082005-09-05 17:12:29 +02001228 but some doesn't have ISA PnP. You'll need to specify isapnp=0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 and proper hardware parameters in the case without ISA PnP.
1230
1231 Note: some laptops need a workaround for AC97 RESET. For the
1232 known hardware like Dell Latitude LS and Sony PCG-F305, this
1233 workaround is enabled automatically. For other laptops with a
1234 hard freeze, you can try reset_workaround=1 option.
1235
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001236 Note: Dell Latitude CSx laptops have another problem regarding
1237 AC97 RESET. On these laptops, reset_workaround2 option is
1238 turned on as default. This option is worth to try if the
1239 previous reset_workaround option doesn't help.
1240
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 Note: This driver is really crappy. It's a porting from the
1242 OSS driver, which is a result of black-magic reverse engineering.
1243 The detection of codec will fail if the driver is loaded *after*
1244 X-server as described above. You might be able to force to load
1245 the module, but it may result in hang-up. Hence, make sure that
1246 you load this module *before* X if you encounter this kind of
1247 problem.
1248
1249 Module snd-opl3sa2
1250 ------------------
1251
1252 Module for Yamaha OPL3-SA2/SA3 sound cards.
1253
Rene Herman64e0e2d2007-12-13 16:29:33 +01001254 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1255
1256 with isapnp=0, the following options are available:
1257
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258 port - control port # for OPL3-SA chip (0x370)
1259 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1260 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1261 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1262 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1263 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1264 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1265 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001267 This module supports multiple cards and ISA PnP. It does not support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1269
1270 The power-management is supported.
1271
1272 Module snd-opti92x-ad1848
1273 -------------------------
1274
1275 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1276 Module works with OAK Mozart cards as well.
1277
Rene Herman64e0e2d2007-12-13 16:29:33 +01001278 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1279
1280 with isapnp=0, the following options are available:
1281
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1283 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1284 fm_port - port # for OPL3 device (0x388)
1285 irq - IRQ # for WSS chip (5,7,9,10,11)
1286 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1287 dma1 - first DMA # for WSS chip (0,1,3)
1288
1289 This module supports only one card, autoprobe and PnP.
1290
1291 Module snd-opti92x-cs4231
1292 -------------------------
1293
1294 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1295
Rene Herman64e0e2d2007-12-13 16:29:33 +01001296 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1297
1298 with isapnp=0, the following options are available:
1299
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1301 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1302 fm_port - port # for OPL3 device (0x388)
1303 irq - IRQ # for WSS chip (5,7,9,10,11)
1304 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1305 dma1 - first DMA # for WSS chip (0,1,3)
1306 dma2 - second DMA # for WSS chip (0,1,3)
1307
1308 This module supports only one card, autoprobe and PnP.
1309
1310 Module snd-opti93x
1311 ------------------
1312
1313 Module for sound cards based on OPTi 82c93x chips.
1314
Rene Herman64e0e2d2007-12-13 16:29:33 +01001315 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1316
1317 with isapnp=0, the following options are available:
1318
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1320 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1321 fm_port - port # for OPL3 device (0x388)
1322 irq - IRQ # for WSS chip (5,7,9,10,11)
1323 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1324 dma1 - first DMA # for WSS chip (0,1,3)
1325 dma2 - second DMA # for WSS chip (0,1,3)
1326
1327 This module supports only one card, autoprobe and PnP.
1328
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001329 Module snd-oxygen
1330 -----------------
1331
1332 Module for sound cards based on the C-Media CMI8788 chip:
1333 * Asound A-8788
1334 * AuzenTech X-Meridian
1335 * Bgears b-Enspirer
1336 * Club3D Theatron DTS
Clemens Ladischde04b102008-11-26 10:37:23 +01001337 * HT-Omega Claro (plus)
1338 * HT-Omega Claro halo (XT)
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001339 * Razer Barracuda AC-1
1340 * Sondigo Inferno
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001341
1342 This module supports autoprobe and multiple cards.
1343
Stas Sergeevd08cd582008-03-06 11:01:44 +01001344 Module snd-pcsp
1345 -----------------
1346
1347 Module for internal PC-Speaker.
1348
1349 nforce_wa - enable NForce chipset workaround. Expect bad sound.
1350
1351 This module supports system beeps, some kind of PCM playback and
1352 even a few mixer controls.
1353
Markus Bollingere12229b2005-12-06 13:55:26 +01001354 Module snd-pcxhr
1355 ----------------
1356
1357 Module for Digigram PCXHR boards
1358
1359 This module supports multiple cards.
1360
Matthias Koenig757e1192007-01-25 13:15:05 +01001361 Module snd-portman2x4
1362 ---------------------
1363
1364 Module for Midiman Portman 2x4 parallel port MIDI interface
1365
1366 This module supports multiple cards.
1367
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 Module snd-powermac (on ppc only)
1369 ---------------------------------
1370
1371 Module for PowerMac, iMac and iBook on-board soundchips
1372
1373 enable_beep - enable beep using PCM (enabled as default)
1374
1375 Module supports autoprobe a chip.
1376
1377 Note: the driver may have problems regarding endianess.
1378
1379 The power-management is supported.
1380
Takashi Iwai2c484df2005-06-30 18:54:04 +02001381 Module snd-pxa2xx-ac97 (on arm only)
1382 ------------------------------------
1383
1384 Module for AC97 driver for the Intel PXA2xx chip
1385
1386 For ARM architecture only.
1387
Takashi Iwaia4efc232005-11-17 17:24:26 +01001388 The power-management is supported.
1389
Peter Gruber109a9632006-03-27 13:10:28 +02001390 Module snd-riptide
1391 ------------------
1392
1393 Module for Conexant Riptide chip
1394
1395 joystick_port - Joystick port # (default: 0x200)
1396 mpu_port - MPU401 port # (default: 0x330)
1397 opl3_port - OPL3 port # (default: 0x388)
1398
1399 This module supports multiple cards.
1400 The driver requires the firmware loader support on kernel.
1401 You need to install the firmware file "riptide.hex" to the standard
1402 firmware path (e.g. /lib/firmware).
1403
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 Module snd-rme32
1405 ----------------
1406
1407 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1408 Prodif96 and Prodif Gold) sound cards.
1409
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001410 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411
1412 Module snd-rme96
1413 ----------------
1414
1415 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1416
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001417 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418
1419 Module snd-rme9652
1420 ------------------
1421
1422 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1423
1424 precise_ptr - Enable precise pointer (doesn't work reliably).
1425 (default = 0)
1426
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001427 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428
1429 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1430 module did formerly. It will allocate the buffers in advance
1431 when any RME9652 cards are found. To make the buffer
1432 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +02001433 stage of boot sequence. See "Early Buffer Allocation"
1434 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435
1436 Module snd-sa11xx-uda1341 (on arm only)
1437 ---------------------------------------
1438
1439 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1440
1441 Module supports only one card.
1442 Module has no enable and index options.
1443
Takashi Iwaia4efc232005-11-17 17:24:26 +01001444 The power-management is supported.
1445
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 Module snd-sb8
1447 --------------
1448
1449 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1450 SoundBlaster 2.0,
1451 SoundBlaster Pro
1452
1453 port - port # for SB DSP chip (0x220,0x240,0x260)
1454 irq - IRQ # for SB DSP chip (5,7,9,10)
1455 dma8 - DMA # for SB DSP chip (1,3)
1456
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001457 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458
Takashi Iwaia4efc232005-11-17 17:24:26 +01001459 The power-management is supported.
1460
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 Module snd-sb16 and snd-sbawe
1462 -----------------------------
1463
1464 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1465 SoundBlaster AWE 32 (PnP),
1466 SoundBlaster AWE 64 PnP
1467
Rene Herman64e0e2d2007-12-13 16:29:33 +01001468 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1469 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1470 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1471
1472 with isapnp=0, the following options are available:
1473
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1475 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1476 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1477 (snd-sbawe module only)
1478 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1479 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1480 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001482 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483
1484 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1485 disable 16bit DMA with dma16 = -1 module parameter.
1486 Also, all Sound Blaster 16 type cards can operate in 16-bit
1487 half duplex mode through 8-bit DMA channel by disabling their
1488 16-bit DMA channel.
1489
Takashi Iwaia4efc232005-11-17 17:24:26 +01001490 The power-management is supported.
1491
Takashi Iwai074a6e92007-09-11 22:10:14 +02001492 Module snd-sc6000
1493 -----------------
1494
1495 Module for Gallant SC-6000 soundcard.
1496
1497 port - Port # (0x220 or 0x240)
1498 mss_port - MSS Port # (0x530 or 0xe80)
1499 irq - IRQ # (5,7,9,10,11)
Krzysztof Helt7b758d22007-09-17 14:42:49 +02001500 mpu_irq - MPU-401 IRQ # (5,7,9,10) ,0 - no MPU-401 irq
Takashi Iwai074a6e92007-09-11 22:10:14 +02001501 dma - DMA # (1,3,0)
1502
1503 This module supports multiple cards.
1504
1505 This card is also known as Audio Excel DSP 16 or Zoltrix AV302.
1506
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 Module snd-sgalaxy
1508 ------------------
1509
1510 Module for Aztech Sound Galaxy sound card.
1511
1512 sbport - Port # for SB16 interface (0x220,0x240)
1513 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1514 irq - IRQ # (7,9,10,11)
1515 dma1 - DMA #
1516
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001517 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518
Takashi Iwaia4efc232005-11-17 17:24:26 +01001519 The power-management is supported.
1520
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 Module snd-sscape
1522 -----------------
1523
1524 Module for ENSONIQ SoundScape PnP cards.
1525
1526 port - Port # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001527 wss_port - WSS Port # (PnP setup)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528 irq - IRQ # (PnP setup)
1529 mpu_irq - MPU-401 IRQ # (PnP setup)
1530 dma - DMA # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001531 dma2 - 2nd DMA # (PnP setup, -1 to disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001533 This module supports multiple cards. ISA PnP must be enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 You need sscape_ctl tool in alsa-tools package for loading
1535 the microcode.
1536
1537 Module snd-sun-amd7930 (on sparc only)
1538 --------------------------------------
1539
1540 Module for AMD7930 sound chips found on Sparcs.
1541
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001542 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543
1544 Module snd-sun-cs4231 (on sparc only)
1545 -------------------------------------
1546
1547 Module for CS4231 sound chips found on Sparcs.
1548
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001549 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001550
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001551 Module snd-sun-dbri (on sparc only)
1552 -----------------------------------
1553
1554 Module for DBRI sound chips found on Sparcs.
1555
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001556 This module supports multiple cards.
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001557
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 Module snd-wavefront
1559 --------------------
1560
1561 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1562
Rene Herman64e0e2d2007-12-13 16:29:33 +01001563 use_cs4232_midi - Use CS4232 MPU-401 interface
1564 (inaccessibly located inside your computer)
1565 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1566
1567 with isapnp=0, the following options are available:
1568
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 cs4232_pcm_port - Port # for CS4232 PCM interface.
1570 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1571 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1572 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 ics2115_port - Port # for ICS2115
1574 ics2115_irq - IRQ # for ICS2115
1575 fm_port - FM OPL-3 Port #
1576 dma1 - DMA1 # for CS4232 PCM interface.
1577 dma2 - DMA2 # for CS4232 PCM interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578
Takashi Iwaic2b12392007-08-21 15:20:26 +02001579 The below are options for wavefront_synth features:
1580 wf_raw - Assume that we need to boot the OS (default:no)
1581 If yes, then during driver loading, the state of the board is
1582 ignored, and we reset the board and load the firmware anyway.
1583 fx_raw - Assume that the FX process needs help (default:yes)
1584 If false, we'll leave the FX processor in whatever state it is
1585 when the driver is loaded. The default is to download the
1586 microprogram and associated coefficients to set it up for
1587 "default" operation, whatever that means.
1588 debug_default - Debug parameters for card initialization
1589 wait_usecs - How long to wait without sleeping, usecs
1590 (default:150)
1591 This magic number seems to give pretty optimal throughput
1592 based on my limited experimentation.
1593 If you want to play around with it and find a better value, be
1594 my guest. Remember, the idea is to get a number that causes us
1595 to just busy wait for as many WaveFront commands as possible,
1596 without coming up with a number so large that we hog the whole
1597 CPU.
1598 Specifically, with this number, out of about 134,000 status
1599 waits, only about 250 result in a sleep.
1600 sleep_interval - How long to sleep when waiting for reply
1601 (default: 100)
1602 sleep_tries - How many times to try sleeping during a wait
1603 (default: 50)
1604 ospath - Pathname to processed ICS2115 OS firmware
1605 (default:wavefront.os)
1606 The path name of the ISC2115 OS firmware. In the recent
1607 version, it's handled via firmware loader framework, so it
1608 must be installed in the proper path, typically,
1609 /lib/firmware.
1610 reset_time - How long to wait for a reset to take effect
1611 (default:2)
1612 ramcheck_time - How many seconds to wait for the RAM test
1613 (default:20)
1614 osrun_time - How many seconds to wait for the ICS2115 OS
1615 (default:10)
1616
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001617 This module supports multiple cards and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618
Takashi Iwaic2b12392007-08-21 15:20:26 +02001619 Note: the firmware file "wavefront.os" was located in the earlier
1620 version in /etc. Now it's loaded via firmware loader, and
1621 must be in the proper firmware path, such as /lib/firmware.
1622 Copy (or symlink) the file appropriately if you get an error
1623 regarding firmware downloading after upgrading the kernel.
1624
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625 Module snd-sonicvibes
1626 ---------------------
1627
1628 Module for S3 SonicVibes PCI sound cards.
1629 * PINE Schubert 32 PCI
1630
1631 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1632 - SoundCard must have onboard SRAM for this.
1633 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1634
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001635 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636
1637 Module snd-serial-u16550
1638 ------------------------
1639
1640 Module for UART16550A serial MIDI ports.
1641
1642 port - port # for UART16550A chip
1643 irq - IRQ # for UART16550A chip, -1 = poll mode
1644 speed - speed in bauds (9600,19200,38400,57600,115200)
1645 38400 = default
1646 base - base for divisor in bauds (57600,115200,230400,460800)
1647 115200 = default
1648 outs - number of MIDI ports in a serial port (1-4)
1649 1 = default
1650 adaptor - Type of adaptor.
1651 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1652 3 = MS-124W M/B, 4 = Generic
1653
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001654 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 thus the main port must be specified!!! Other options are optional.
1656
1657 Module snd-trident
1658 ------------------
1659
1660 Module for Trident 4DWave DX/NX sound cards.
1661 * Best Union Miss Melody 4DWave PCI
1662 * HIS 4DWave PCI
1663 * Warpspeed ONSpeed 4DWave PCI
1664 * AzTech PCI 64-Q3D
1665 * Addonics SV 750
1666 * CHIC True Sound 4Dwave
1667 * Shark Predator4D-PCI
1668 * Jaton SonicWave 4D
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001669 * SiS SI7018 PCI Audio
1670 * Hoontech SoundTrack Digital 4DWave NX
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671
1672 pcm_channels - max channels (voices) reserved for PCM
1673 wavetable_size - max wavetable size in kB (4-?kb)
1674
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001675 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676
1677 The power-management is supported.
1678
1679 Module snd-usb-audio
1680 --------------------
1681
1682 Module for USB audio and USB MIDI devices.
1683
1684 vid - Vendor ID for the device (optional)
1685 pid - Product ID for the device (optional)
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001686 nrpacks - Max. number of packets per URB (default: 8)
1687 async_unlink - Use async unlink mode (default: yes)
Thibault LE MEURe3113342006-03-14 11:44:53 +01001688 device_setup - Device specific magic number (optional)
1689 - Influence depends on the device
1690 - Default: 0x0000
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001691 ignore_ctl_error - Ignore any USB-controller regarding mixer
1692 interface (default: no)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001694 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001696 NB: nrpacks parameter can be modified dynamically via sysfs.
1697 Don't put the value over 20. Changing via sysfs has no sanity
1698 check.
1699 NB: async_unlink=0 would cause Oops. It remains just for
1700 debugging purpose (if any).
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001701 NB: ignore_ctl_error=1 may help when you get an error at accessing
1702 the mixer element such as URB error -22. This happens on some
1703 buggy USB device or the controller.
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001704
Daniel Mack523f1dc2007-03-26 19:11:24 +02001705 Module snd-usb-caiaq
1706 --------------------
1707
1708 Module for caiaq UB audio interfaces,
1709 * Native Instruments RigKontrol2
1710 * Native Instruments Kore Controller
1711 * Native Instruments Audio Kontrol 1
1712 * Native Instruments Audio 8 DJ
1713
1714 This module supports multiple devices, autoprobe and hotplugging.
1715
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716 Module snd-usb-usx2y
1717 --------------------
1718
1719 Module for Tascam USB US-122, US-224 and US-428 devices.
1720
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001721 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722
1723 Note: you need to load the firmware via usx2yloader utility included
1724 in alsa-tools and alsa-firmware packages.
1725
1726 Module snd-via82xx
1727 ------------------
1728
1729 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001730 8233A, 8233C, 8235, 8237 (south) bridge.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731
1732 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1733 [VIA686A/686B only]
1734 joystick - Enable joystick (default off) [VIA686A/686B only]
1735 ac97_clock - AC'97 codec clock base (default 48000Hz)
1736 dxs_support - support DXS channels,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001737 0 = auto (default), 1 = enable, 2 = disable,
1738 3 = 48k only, 4 = no VRA, 5 = enable any sample
1739 rate and different sample rates on different
1740 channels
1741 [VIA8233/C, 8235, 8237 only]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001743 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001745 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746
1747 Note: on some SMP motherboards like MSI 694D the interrupts might
1748 not be generated properly. In such a case, please try to
1749 set the SMP (or MPS) version on BIOS to 1.1 instead of
1750 default value 1.4. Then the interrupt number will be
1751 assigned under 15. You might also upgrade your BIOS.
1752
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001753 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754 channels as the first PCM. On these channels, up to 4
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001755 streams can be played at the same time, and the controller
1756 can perform sample rate conversion with separate rates for
1757 each channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 As default (dxs_support = 0), 48k fixed rate is chosen
1759 except for the known devices since the output is often
1760 noisy except for 48k on some mother boards due to the
1761 bug of BIOS.
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001762 Please try once dxs_support=5 and if it works on other
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1764 know the PCI subsystem vendor/device id's (output of
1765 "lspci -nv").
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001766 If dxs_support=5 does not work, try dxs_support=4; if it
1767 doesn't work too, try dxs_support=1. (dxs_support=1 is
Takashi Iwai62430082005-09-05 17:12:29 +02001768 usually for old motherboards. The correct implemented
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001769 board should work with 4 or 5.) If it still doesn't
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770 work and the default setting is ok, dxs_support=3 is the
1771 right choice. If the default setting doesn't work at all,
1772 try dxs_support=2 to disable the DXS channels.
1773 In any cases, please let us know the result and the
Takashi Iwai62430082005-09-05 17:12:29 +02001774 subsystem vendor/device ids. See "Links and Addresses"
1775 below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776
1777 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Takashi Iwai62430082005-09-05 17:12:29 +02001778 additionally. The mpu_port option is for VIA686 chips only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779
Takashi Iwaia4efc232005-11-17 17:24:26 +01001780 The power-management is supported.
1781
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782 Module snd-via82xx-modem
1783 ------------------------
1784
1785 Module for VIA82xx AC97 modem
1786
1787 ac97_clock - AC'97 codec clock base (default 48000Hz)
1788
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001789 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001790
1791 Note: The default index value of this module is -2, i.e. the first
1792 slot is excluded.
1793
Takashi Iwaia4efc232005-11-17 17:24:26 +01001794 The power-management is supported.
1795
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 Module snd-virmidi
1797 ------------------
1798
1799 Module for virtual rawmidi devices.
1800 This module creates virtual rawmidi devices which communicate
1801 to the corresponding ALSA sequencer ports.
1802
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001803 midi_devs - MIDI devices # (1-4, default=4)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001805 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001807 Module snd-virtuoso
1808 -------------------
1809
Clemens Ladisch5430c722008-07-28 10:28:43 +02001810 Module for sound cards based on the Asus AV100/AV200 chips,
Clemens Ladisch7407a2e2008-09-22 09:12:11 +02001811 i.e., Xonar D1, DX, D2, D2X and HDAV1.3 (Deluxe).
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001812
1813 This module supports autoprobe and multiple cards.
1814
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 Module snd-vx222
1816 ----------------
1817
1818 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1819
1820 mic - Enable Microphone on V222 Mic (NYI)
1821 ibl - Capture IBL size. (default = 0, minimum size)
1822
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001823 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824
1825 When the driver is compiled as a module and the hotplug firmware
1826 is supported, the firmware data is loaded via hotplug automatically.
1827 Install the necessary firmware files in alsa-firmware package.
1828 When no hotplug fw loader is available, you need to load the
1829 firmware via vxloader utility in alsa-tools package. To invoke
1830 vxloader automatically, add the following to /etc/modprobe.conf
1831
1832 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1833
1834 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1835 /etc/modules.conf, instead.)
1836 IBL size defines the interrupts period for PCM. The smaller size
1837 gives smaller latency but leads to more CPU consumption, too.
1838 The size is usually aligned to 126. As default (=0), the smallest
1839 size is chosen. The possible IBL values can be found in
1840 /proc/asound/cardX/vx-status proc file.
1841
Takashi Iwaia4efc232005-11-17 17:24:26 +01001842 The power-management is supported.
1843
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 Module snd-vxpocket
1845 -------------------
1846
Takashi Iwai6d00a312005-06-30 13:40:51 +02001847 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848
1849 ibl - Capture IBL size. (default = 0, minimum size)
1850
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001851 This module supports multiple cards. The module is compiled only when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852 PCMCIA is supported on kernel.
1853
Takashi Iwai62430082005-09-05 17:12:29 +02001854 With the older 2.6.x kernel, to activate the driver via the card
1855 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1856 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1857 longer require a config file.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858
1859 When the driver is compiled as a module and the hotplug firmware
1860 is supported, the firmware data is loaded via hotplug automatically.
1861 Install the necessary firmware files in alsa-firmware package.
1862 When no hotplug fw loader is available, you need to load the
1863 firmware via vxloader utility in alsa-tools package.
1864
1865 About capture IBL, see the description of snd-vx222 module.
1866
Takashi Iwaied7cbe32006-05-11 11:30:10 +02001867 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
Takashi Iwai62430082005-09-05 17:12:29 +02001868 ALSA 1.0.10.
1869
Takashi Iwaia4efc232005-11-17 17:24:26 +01001870 The power-management is supported.
1871
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872 Module snd-ymfpci
1873 -----------------
1874
1875 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1876
1877 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1878 1 (auto-detect for YMF744/754 only)
1879 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1880 1 (auto-detect for YMF744/754 only)
1881 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1882 1 (auto-detect)
1883 rear_switch - enable shared rear/line-in switch (bool)
1884
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001885 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886
1887 The power-management is supported.
1888
1889 Module snd-pdaudiocf
1890 --------------------
1891
1892 Module for Sound Core PDAudioCF sound card.
1893
Takashi Iwaia4efc232005-11-17 17:24:26 +01001894 The power-management is supported.
1895
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896
Takashi Iwai62430082005-09-05 17:12:29 +02001897AC97 Quirk Option
1898=================
1899
1900The ac97_quirk option is used to enable/override the workaround for
1901specific devices on drivers for on-board AC'97 controllers like
1902snd-intel8x0. Some hardware have swapped output pins between Master
1903and Headphone, or Surround (thanks to confusion of AC'97
1904specifications from version to version :-)
1905
1906The driver provides the auto-detection of known problematic devices,
1907but some might be unknown or wrongly detected. In such a case, pass
1908the proper value with this option.
1909
1910The following strings are accepted:
1911 - default Don't override the default setting
Takashi Iwai10e4097f2005-11-17 11:04:55 +01001912 - none Disable the quirk
Takashi Iwai62430082005-09-05 17:12:29 +02001913 - hp_only Bind Master and Headphone controls as a single control
1914 - swap_hp Swap headphone and master controls
1915 - swap_surround Swap master and surround controls
1916 - ad_sharing For AD1985, turn on OMS bit and use headphone
1917 - alc_jack For ALC65x, turn on the jack sense mode
1918 - inv_eapd Inverted EAPD implementation
1919 - mute_led Bind EAPD bit for turning on/off mute LED
1920
1921For backward compatibility, the corresponding integer value -1, 0,
1922... are accepted, too.
1923
1924For example, if "Master" volume control has no effect on your device
1925but only "Headphone" does, pass ac97_quirk=hp_only module option.
1926
1927
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928Configuring Non-ISAPNP Cards
1929============================
1930
1931When the kernel is configured with ISA-PnP support, the modules
1932supporting the isapnp cards will have module options "isapnp".
1933If this option is set, *only* the ISA-PnP devices will be probed.
1934For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
1935together with the proper i/o and irq configuration.
1936
1937When the kernel is configured without ISA-PnP support, isapnp option
1938will be not built in.
1939
1940
1941Module Autoloading Support
1942==========================
1943
1944The ALSA drivers can be loaded automatically on demand by defining
1945module aliases. The string 'snd-card-%1' is requested for ALSA native
1946devices where %i is sound card number from zero to seven.
1947
1948To auto-load an ALSA driver for OSS services, define the string
1949'sound-slot-%i' where %i means the slot number for OSS, which
1950corresponds to the card index of ALSA. Usually, define this
Tobias Klauserd533f672005-09-10 00:26:46 -07001951as the same card module.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952
1953An example configuration for a single emu10k1 card is like below:
1954----- /etc/modprobe.conf
1955alias snd-card-0 snd-emu10k1
1956alias sound-slot-0 snd-emu10k1
1957----- /etc/modprobe.conf
1958
1959The available number of auto-loaded sound cards depends on the module
1960option "cards_limit" of snd module. As default it's set to 1.
1961To enable the auto-loading of multiple cards, specify the number of
1962sound cards in that option.
1963
1964When multiple cards are available, it'd better to specify the index
1965number for each card via module option, too, so that the order of
1966cards is kept consistent.
1967
1968An example configuration for two sound cards is like below:
1969
1970----- /etc/modprobe.conf
1971# ALSA portion
1972options snd cards_limit=2
1973alias snd-card-0 snd-interwave
1974alias snd-card-1 snd-ens1371
1975options snd-interwave index=0
1976options snd-ens1371 index=1
1977# OSS/Free portion
1978alias sound-slot-0 snd-interwave
1979alias sound-slot-1 snd-ens1371
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02001980----- /etc/modprobe.conf
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981
1982In this example, the interwave card is always loaded as the first card
1983(index 0) and ens1371 as the second (index 1).
1984
Takashi Iwai304cd072007-10-26 15:10:15 +02001985Alternative (and new) way to fixate the slot assignment is to use
1986"slots" option of snd module. In the case above, specify like the
1987following:
1988
1989options snd slots=snd-interwave,snd-ens1371
1990
1991Then, the first slot (#0) is reserved for snd-interwave driver, and
1992the second (#1) for snd-ens1371. You can omit index option in each
1993driver if slots option is used (although you can still have them at
1994the same time as long as they don't conflict).
1995
1996The slots option is especially useful for avoiding the possible
1997hot-plugging and the resultant slot conflict. For example, in the
1998case above again, the first two slots are already reserved. If any
1999other driver (e.g. snd-usb-audio) is loaded before snd-interwave or
2000snd-ens1371, it will be assigned to the third or later slot.
2001
Takashi Iwaia93bbaa2008-05-27 17:59:24 +02002002When a module name is given with '!', the slot will be given for any
2003modules but that name. For example, "slots=!snd-pcsp" will reserve
2004the first slot for any modules but snd-pcsp.
2005
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006
2007ALSA PCM devices to OSS devices mapping
2008=======================================
2009
2010/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
2011/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
2012/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
2013/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
2014/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
2015/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
2016/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
2017/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
2018/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
2019
2020The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
2021sound card number and second means device number. The ALSA devices
2022have either 'c' or 'p' suffix indicating the direction, capture and
2023playback, respectively.
2024
2025Please note that the device mapping above may be varied via the module
2026options of snd-pcm-oss module.
2027
2028
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029Proc interfaces (/proc/asound)
2030==============================
2031
2032/proc/asound/card#/pcm#[cp]/oss
2033-------------------------------
2034 String "erase" - erase all additional informations about OSS applications
2035 String "<app_name> <fragments> <fragment_size> [<options>]"
2036
2037 <app_name> - name of application with (higher priority) or without path
2038 <fragments> - number of fragments or zero if auto
2039 <fragment_size> - size of fragment in bytes or zero if auto
2040 <options> - optional parameters
2041 - disable the application tries to open a pcm device for
2042 this channel but does not want to use it.
2043 (Cause a bug or mmap needs)
2044 It's good for Quake etc...
2045 - direct don't use plugins
2046 - block force block mode (rvplayer)
2047 - non-block force non-block mode
2048 - whole-frag write only whole fragments (optimization affecting
2049 playback only)
2050 - no-silence do not fill silence ahead to avoid clicks
Takashi Iwai10f69f92005-09-08 13:48:34 +02002051 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
2052 instead of filled blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053
2054 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
2055 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
2056 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
2057
2058
Takashi Iwaib6a96912005-05-30 18:27:03 +02002059Early Buffer Allocation
2060=======================
2061
2062Some drivers (e.g. hdsp) require the large contiguous buffers, and
2063sometimes it's too late to find such spaces when the driver module is
2064actually loaded due to memory fragmentation. You can pre-allocate the
2065PCM buffers by loading snd-page-alloc module and write commands to its
2066proc file in prior, for example, in the early boot stage like
2067/etc/init.d/*.local scripts.
2068
2069Reading the proc file /proc/drivers/snd-page-alloc shows the current
2070usage of page allocation. In writing, you can send the following
2071commands to the snd-page-alloc driver:
2072
2073 - add VENDOR DEVICE MASK SIZE BUFFERS
2074
2075 VENDOR and DEVICE are PCI vendor and device IDs. They take
2076 integer numbers (0x prefix is needed for the hex).
2077 MASK is the PCI DMA mask. Pass 0 if not restricted.
2078 SIZE is the size of each buffer to allocate. You can pass
2079 k and m suffix for KB and MB. The max number is 16MB.
2080 BUFFERS is the number of buffers to allocate. It must be greater
2081 than 0. The max number is 4.
2082
2083 - erase
2084
2085 This will erase the all pre-allocated buffers which are not in
2086 use.
2087
2088
Takashi Iwai62430082005-09-05 17:12:29 +02002089Links and Addresses
2090===================
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091
2092 ALSA project homepage
2093 http://www.alsa-project.org
2094
Takashi Iwai30bc4482008-12-09 08:23:45 +01002095 Kernel Bugzilla
2096 http://bugzilla.kernel.org/
Takashi Iwai62430082005-09-05 17:12:29 +02002097
2098 ALSA Developers ML
Rene Herman45051792007-03-21 12:05:06 +01002099 mailto:alsa-devel@alsa-project.org
Takashi Iwai30bc4482008-12-09 08:23:45 +01002100
2101 alsa-info.sh script
2102 http://www.alsa-project.org/alsa-info.sh