blob: 821a99480feb9b10571ac9b9dea50a9322093056 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001
2 Advanced Linux Sound Architecture - Driver
3 ==========================================
4 Configuration guide
5
6
7Kernel Configuration
8====================
9
10To enable ALSA support you need at least to build the kernel with
11primary sound card support (CONFIG_SOUND). Since ALSA can emulate OSS,
12you don't have to choose any of the OSS modules.
13
14Enable "OSS API emulation" (CONFIG_SND_OSSEMUL) and both OSS mixer and
15PCM supports if you want to run OSS applications with ALSA.
16
17If you want to support the WaveTable functionality on cards such as
18SB Live! then you need to enable "Sequencer support"
19(CONFIG_SND_SEQUENCER).
20
21To make ALSA debug messages more verbose, enable the "Verbose printk"
22and "Debug" options. To check for memory leaks, turn on "Debug memory"
23too. "Debug detection" will add checks for the detection of cards.
24
25Please note that all the ALSA ISA drivers support the Linux isapnp API
26(if the card supports ISA PnP). You don't need to configure the cards
27using isapnptools.
28
29
30Creating ALSA devices
31=====================
32
33This depends on your distribution, but normally you use the /dev/MAKEDEV
34script to create the necessary device nodes. On some systems you use a
35script named 'snddevices'.
36
37
38Module parameters
39=================
40
41The user can load modules with options. If the module supports more than
42one card and you have more than one card of the same type then you can
43specify multiple values for the option separated by commas.
44
45Prior to version 0.9.0rc4 options had a 'snd_' prefix. This was removed.
46
47 Module snd
48 ----------
49
50 The core ALSA module. It is used by all ALSA card drivers.
51 It takes the following options which have global effects.
52
53 major - major number for sound driver
54 - Default: 116
55 cards_limit
56 - limiting card index for auto-loading (1-8)
57 - Default: 1
58 - For auto-loading more than one card, specify this
59 option together with snd-card-X aliases.
Takashi Iwai304cd072007-10-26 15:10:15 +020060 slots - Reserve the slot index for the given driver.
61 This option takes multiple strings.
62 See "Module Autoloading Support" section for details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
64 Module snd-pcm-oss
65 ------------------
66
67 The PCM OSS emulation module.
68 This module takes options which change the mapping of devices.
69
70 dsp_map - PCM device number maps assigned to the 1st OSS device.
71 - Default: 0
72 adsp_map - PCM device number maps assigned to the 2st OSS device.
73 - Default: 1
74 nonblock_open
Takashi Iwai62430082005-09-05 17:12:29 +020075 - Don't block opening busy PCM devices. Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
77 For example, when dsp_map=2, /dev/dsp will be mapped to PCM #2 of
78 the card #0. Similarly, when adsp_map=0, /dev/adsp will be mapped
79 to PCM #0 of the card #0.
80 For changing the second or later card, specify the option with
81 commas, such like "dsp_map=0,1".
82
83 nonblock_open option is used to change the behavior of the PCM
84 regarding opening the device. When this option is non-zero,
85 opening a busy OSS PCM device won't be blocked but return
86 immediately with EAGAIN (just like O_NONBLOCK flag).
87
88 Module snd-rawmidi
89 ------------------
90
91 This module takes options which change the mapping of devices.
92 similar to those of the snd-pcm-oss module.
93
94 midi_map - MIDI device number maps assigned to the 1st OSS device.
95 - Default: 0
96 amidi_map - MIDI device number maps assigned to the 2st OSS device.
97 - Default: 1
98
99 Common parameters for top sound card modules
100 --------------------------------------------
101
102 Each of top level sound card module takes the following options.
103
104 index - index (slot #) of sound card
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100105 - Values: 0 through 31 or negative
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 - If nonnegative, assign that index number
107 - if negative, interpret as a bitmask of permissible
108 indices; the first free permitted index is assigned
109 - Default: -1
110 id - card ID (identifier or name)
111 - Can be up to 15 characters long
112 - Default: the card type
113 - A directory by this name is created under /proc/asound/
114 containing information about the card
115 - This ID can be used instead of the index number in
116 identifying the card
117 enable - enable card
118 - Default: enabled, for PCI and ISA PnP cards
119
Rene Hermancf40a312006-03-28 12:38:20 +0200120 Module snd-adlib
121 ----------------
122
123 Module for AdLib FM cards.
124
125 port - port # for OPL chip
126
127 This module supports multiple cards. It does not support autoprobe, so
128 the port must be specified. For actual AdLib FM cards it will be 0x388.
129 Note that this card does not have PCM support and no mixer; only FM
130 synthesis.
131
132 Make sure you have "sbiload" from the alsa-tools package available and,
133 after loading the module, find out the assigned ALSA sequencer port
134 number through "sbiload -l". Example output:
135
136 Port Client name Port name
137 64:0 OPL2 FM synth OPL2 FM Port
138
139 Load the std.sb and drums.sb patches also supplied by sbiload:
140
141 sbiload -p 64:0 std.sb drums.sb
142
143 If you use this driver to drive an OPL3, you can use std.o3 and drums.o3
144 instead. To have the card produce sound, use aplaymidi from alsa-utils:
145
146 aplaymidi -p 64:0 foo.mid
147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 Module snd-ad1816a
149 ------------------
150
151 Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips.
152
Takashi Iwai506d4c62005-08-03 14:02:47 +0200153 clockfreq - Clock frequency for AD1816A chip (default = 0, 33000Hz)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100155 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156
157 Module snd-ad1848
158 -----------------
159
160 Module for sound cards based on AD1848/AD1847/CS4248 ISA chips.
161
162 port - port # for AD1848 chip
163 irq - IRQ # for AD1848 chip
164 dma1 - DMA # for AD1848 chip (0,1,3)
165
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100166 This module supports multiple cards. It does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 thus main port must be specified!!! Other ports are optional.
168
Takashi Iwaia4efc232005-11-17 17:24:26 +0100169 The power-management is supported.
170
Clemens Ladisch84010e62005-09-02 07:57:59 +0200171 Module snd-ad1889
172 -----------------
173
174 Module for Analog Devices AD1889 chips.
175
176 ac97_quirk - AC'97 workaround for strange hardware
177 See the description of intel8x0 module for details.
178
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100179 This module supports multiple cards.
Clemens Ladisch84010e62005-09-02 07:57:59 +0200180
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 Module snd-ali5451
182 ------------------
183
184 Module for ALi M5451 PCI chip.
185
186 pcm_channels - Number of hardware channels assigned for PCM
187 spdif - Support SPDIF I/O
188 - Default: disabled
189
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +0200190 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191
192 The power-management is supported.
193
194 Module snd-als100
195 -----------------
196
197 Module for sound cards based on Avance Logic ALS100/ALS120 ISA chips.
198
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100199 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Takashi Iwaia4efc232005-11-17 17:24:26 +0100201 The power-management is supported.
202
Ash Willisb3a70d52006-03-27 13:20:40 +0200203 Module snd-als300
204 -----------------
205
206 Module for Avance Logic ALS300 and ALS300+
207
208 This module supports multiple cards.
209
210 The power-management is supported.
211
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 Module snd-als4000
213 ------------------
214
215 Module for sound cards based on Avance Logic ALS4000 PCI chip.
216
217 joystick_port - port # for legacy joystick support.
218 0 = disabled (default), 1 = auto-detect
219
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100220 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Takashi Iwaia4efc232005-11-17 17:24:26 +0100222 The power-management is supported.
223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 Module snd-atiixp
225 -----------------
226
Takashi Iwai62430082005-09-05 17:12:29 +0200227 Module for ATI IXP 150/200/250/400 AC97 controllers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Takashi Iwai62430082005-09-05 17:12:29 +0200229 ac97_clock - AC'97 clock (default = 48000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200231 See "AC97 Quirk Option" section below.
Dan Carpenter14e1d352006-11-20 16:35:18 +0100232 ac97_codec - Workaround to specify which AC'97 codec
233 instead of probing. If this works for you
234 file a bug with your `lspci -vn` output.
235 -2 -- Force probing.
236 -1 -- Default behavior.
237 0-2 -- Use the specified codec.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 spdif_aclink - S/PDIF transfer over AC-link (default = 1)
239
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200240 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
Takashi Iwai62430082005-09-05 17:12:29 +0200242 ATI IXP has two different methods to control SPDIF output. One is
243 over AC-link and another is over the "direct" SPDIF output. The
244 implementation depends on the motherboard, and you'll need to
245 choose the correct one via spdif_aclink module option.
246
Takashi Iwaia4efc232005-11-17 17:24:26 +0100247 The power-management is supported.
248
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 Module snd-atiixp-modem
250 -----------------------
251
252 Module for ATI IXP 150/200/250 AC97 modem controllers.
253
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200254 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
256 Note: The default index value of this module is -2, i.e. the first
257 slot is excluded.
258
Takashi Iwaia4efc232005-11-17 17:24:26 +0100259 The power-management is supported.
260
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 Module snd-au8810, snd-au8820, snd-au8830
262 -----------------------------------------
263
264 Module for Aureal Vortex, Vortex2 and Advantage device.
265
266 pcifix - Control PCI workarounds
267 0 = Disable all workarounds
268 1 = Force the PCI latency of the Aureal card to 0xff
269 2 = Force the Extend PCI#2 Internal Master for Efficient
270 Handling of Dummy Requests on the VIA KT133 AGP Bridge
271 3 = Force both settings
272 255 = Autodetect what is required (default)
273
274 This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
275 EQ, mpu401, gameport. A3D and wavetable support are still in development.
276 Development and reverse engineering work is being coordinated at
277 http://savannah.nongnu.org/projects/openvortex/
278 SPDIF output has a copy of the AC97 codec output, unless you use the
279 "spdif" pcm device, which allows raw data passthru.
280 The hardware EQ hardware and SPDIF is only present in the Vortex2 and
281 Advantage.
282
Takashi Iwai62430082005-09-05 17:12:29 +0200283 Note: Some ALSA mixer applications don't handle the SPDIF sample rate
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 control correctly. If you have problems regarding this, try
285 another ALSA compliant mixer (alsamixer works).
286
Takashi Iwai9e235322008-02-20 12:13:29 +0100287 Module snd-aw2
288 --------------
289
290 Module for Audiowerk2 sound card
291
292 This module supports multiple cards.
293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 Module snd-azt2320
295 ------------------
296
297 Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
298
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100299 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
Takashi Iwaia4efc232005-11-17 17:24:26 +0100301 The power-management is supported.
302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 Module snd-azt3328
304 ------------------
305
306 Module for sound cards based on Aztech AZF3328 PCI chip.
307
308 joystick - Enable joystick (default off)
309
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100310 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
312 Module snd-bt87x
313 ----------------
314
315 Module for video cards based on Bt87x chips.
316
317 digital_rate - Override the default digital rate (Hz)
318 load_all - Load the driver even if the card model isn't known
319
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100320 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
322 Note: The default index value of this module is -2, i.e. the first
323 slot is excluded.
324
325 Module snd-ca0106
326 -----------------
327
328 Module for Creative Audigy LS and SB Live 24bit
329
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100330 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
332
333 Module snd-cmi8330
334 ------------------
335
336 Module for sound cards based on C-Media CMI8330 ISA chips.
337
Rene Herman64e0e2d2007-12-13 16:29:33 +0100338 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
339
340 with isapnp=0, the following options are available:
341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 wssport - port # for CMI8330 chip (WSS)
343 wssirq - IRQ # for CMI8330 chip (WSS)
344 wssdma - first DMA # for CMI8330 chip (WSS)
345 sbport - port # for CMI8330 chip (SB16)
346 sbirq - IRQ # for CMI8330 chip (SB16)
347 sbdma8 - 8bit DMA # for CMI8330 chip (SB16)
348 sbdma16 - 16bit DMA # for CMI8330 chip (SB16)
Takashi Iwai9e128fd2009-01-29 11:49:10 +0100349 fmport - (optional) OPL3 I/O port
350 mpuport - (optional) MPU401 I/O port
351 mpuirq - (optional) MPU401 irq #
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100353 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
Takashi Iwaia4efc232005-11-17 17:24:26 +0100355 The power-management is supported.
356
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 Module snd-cmipci
358 -----------------
359
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200360 Module for C-Media CMI8338/8738/8768/8770 PCI sound cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
Clemens Ladischc78c9502007-09-03 09:55:49 +0200362 mpu_port - port address of MIDI interface (8338 only):
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200363 0x300,0x310,0x320,0x330 = legacy port,
Takashi Iwaicab5c4c2006-05-04 14:36:08 +0200364 0 = disable (default)
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200365 fm_port - port address of OPL-3 FM synthesizer (8x38 only):
366 0x388 = legacy port,
367 1 = integrated PCI port (default on 8738),
Takashi Iwai2f24d1592007-02-15 18:56:43 +0100368 0 = disable
Takashi Iwai62430082005-09-05 17:12:29 +0200369 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 (default = 1)
371 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
372
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100373 This module supports autoprobe and multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
Takashi Iwaia4efc232005-11-17 17:24:26 +0100375 The power-management is supported.
376
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 Module snd-cs4231
378 -----------------
379
380 Module for sound cards based on CS4231 ISA chips.
381
382 port - port # for CS4231 chip
383 mpu_port - port # for MPU-401 UART (optional), -1 = disable
384 irq - IRQ # for CS4231 chip
385 mpu_irq - IRQ # for MPU-401 UART
386 dma1 - first DMA # for CS4231 chip
387 dma2 - second DMA # for CS4231 chip
388
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100389 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 thus main port must be specified!!! Other ports are optional.
391
392 The power-management is supported.
393
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 Module snd-cs4236
395 -----------------
396
Takashi Iwaic844a5d2009-02-16 23:17:33 +0100397 Module for sound cards based on CS4232/CS4232A,
398 CS4235/CS4236/CS4236B/CS4237B/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 CS4238B/CS4239 ISA chips.
400
Rene Herman64e0e2d2007-12-13 16:29:33 +0100401 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
402
403 with isapnp=0, the following options are available:
404
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 port - port # for CS4236 chip (PnP setup - 0x534)
406 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
407 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
408 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
409 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
410 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
411 dma1 - first DMA # for CS4236 chip (0,1,3)
412 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100414 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 (if ISA PnP is not used) thus main port and control port must be
416 specified!!! Other ports are optional.
417
418 The power-management is supported.
419
Takashi Iwaic844a5d2009-02-16 23:17:33 +0100420 This module is aliased as snd-cs4232 since it provides the old
421 snd-cs4232 functionality, too.
422
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 Module snd-cs4281
424 -----------------
425
426 Module for Cirrus Logic CS4281 soundchip.
427
428 dual_codec - Secondary codec ID (0 = disable, default)
429
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100430 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
432 The power-management is supported.
433
434 Module snd-cs46xx
435 -----------------
436
437 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
438 CS4624/CS4630/CS4280 PCI chips.
439
Takashi Iwai62430082005-09-05 17:12:29 +0200440 external_amp - Force to enable external amplifier.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 thinkpad - Force to enable Thinkpad's CLKRUN control.
442 mmap_valid - Support OSS mmap mode (default = 0).
443
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100444 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 Usually external amp and CLKRUN controls are detected automatically
446 from PCI sub vendor/device ids. If they don't work, give the options
447 above explicitly.
448
449 The power-management is supported.
Takashi Iwai621887a2007-05-24 18:46:54 +0200450
451 Module snd-cs5530
452 _________________
453
454 Module for Cyrix/NatSemi Geode 5530 chip.
455
Takashi Iwai3e873172005-11-17 10:15:37 +0100456 Module snd-cs5535audio
457 ----------------------
458
459 Module for multifunction CS5535 companion PCI device
460
Takashi Iwaic00bd742006-05-19 19:22:34 +0200461 The power-management is supported.
Takashi Iwai3e873172005-11-17 10:15:37 +0100462
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200463 Module snd-darla20
464 ------------------
465
466 Module for Echoaudio Darla20
467
468 This module supports multiple cards.
469 The driver requires the firmware loader support on kernel.
470
471 Module snd-darla24
472 ------------------
473
474 Module for Echoaudio Darla24
475
476 This module supports multiple cards.
477 The driver requires the firmware loader support on kernel.
478
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 Module snd-dt019x
480 -----------------
481
482 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
483 only)
484
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100485 This module supports multiple cards. This module is enabled only with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 ISA PnP support.
487
Takashi Iwaia4efc232005-11-17 17:24:26 +0100488 The power-management is supported.
489
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 Module snd-dummy
491 ----------------
492
493 Module for the dummy sound card. This "card" doesn't do any output
494 or input, but you may use this module for any application which
495 requires a sound card (like RealPlayer).
496
Takashi Iwaia4efc232005-11-17 17:24:26 +0100497 The power-management is supported.
498
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200499 Module snd-echo3g
500 -----------------
501
502 Module for Echoaudio 3G cards (Gina3G/Layla3G)
503
504 This module supports multiple cards.
505 The driver requires the firmware loader support on kernel.
506
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 Module snd-emu10k1
508 ------------------
509
510 Module for EMU10K1/EMU10k2 based PCI sound cards.
511 * Sound Blaster Live!
512 * Sound Blaster PCI 512
513 * Emu APS (partially supported)
514 * Sound Blaster Audigy
515
516 extin - bitmap of available external inputs for FX8010 (see bellow)
517 extout - bitmap of available external outputs for FX8010 (see bellow)
518 seq_ports - allocated sequencer ports (4 by default)
519 max_synth_voices - limit of voices used for wavetable (64 by default)
520 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
521 given in MB unit. Default value is 128.
522 enable_ir - enable IR
523
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100524 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
526 Input & Output configurations [extin/extout]
527 * Creative Card wo/Digital out [0x0003/0x1f03]
528 * Creative Card w/Digital out [0x0003/0x1f0f]
529 * Creative Card w/Digital CD in [0x000f/0x1f0f]
530 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
531 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
532 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
533 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
534 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
535 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
536 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
537 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
538 * Creative Card all ins and outs [0x3fff/0x7fff]
539
Takashi Iwaia4efc232005-11-17 17:24:26 +0100540 The power-management is supported.
541
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 Module snd-emu10k1x
543 -------------------
544
545 Module for Creative Emu10k1X (SB Live Dell OEM version)
546
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100547 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
549 Module snd-ens1370
550 ------------------
551
552 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
553 * SoundBlaster PCI 64
554 * SoundBlaster PCI 128
555
556 joystick - Enable joystick (default off)
557
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100558 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100560 The power-management is supported.
561
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 Module snd-ens1371
563 ------------------
564
565 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
566 * SoundBlaster PCI 64
567 * SoundBlaster PCI 128
568 * SoundBlaster Vibra PCI
569
570 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
571 0 = disable (default), 1 = auto-detect
572
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100573 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100575 The power-management is supported.
576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 Module snd-es968
578 ----------------
579
580 Module for sound cards based on ESS ES968 chip (PnP only).
581
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100582 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583
Takashi Iwaia4efc232005-11-17 17:24:26 +0100584 The power-management is supported.
585
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 Module snd-es1688
587 -----------------
588
589 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
590
591 port - port # for ES-1688 chip (0x220,0x240,0x260)
Takashi Iwai504a06d2009-01-30 19:59:10 +0100592 fm_port - port # for OPL3 (option; share the same port as default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
594 irq - IRQ # for ES-1688 chip (5,7,9,10)
595 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
596 dma8 - DMA # for ES-1688 chip (0,1,3)
597
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100598 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
600 Module snd-es18xx
601 -----------------
602
603 Module for ESS AudioDrive ES-18xx sound cards.
604
Rene Herman64e0e2d2007-12-13 16:29:33 +0100605 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
606
607 with isapnp=0, the following options are available:
608
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 port - port # for ES-18xx chip (0x220,0x240,0x260)
610 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
611 fm_port - port # for FM (optional, not used)
612 irq - IRQ # for ES-18xx chip (5,7,9,10)
613 dma1 - first DMA # for ES-18xx chip (0,1,3)
614 dma2 - first DMA # for ES-18xx chip (0,1,3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100616 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
617 port if native ISA PnP routines are not used).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 When dma2 is equal with dma1, the driver works as half-duplex.
619
620 The power-management is supported.
621
622 Module snd-es1938
623 -----------------
624
625 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
626
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100627 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628
Takashi Iwaia4efc232005-11-17 17:24:26 +0100629 The power-management is supported.
630
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 Module snd-es1968
632 -----------------
633
634 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
635
636 total_bufsize - total buffer size in kB (1-4096kB)
637 pcm_substreams_p - playback channels (1-8, default=2)
638 pcm_substreams_c - capture channels (1-8, default=0)
639 clock - clock (0 = auto-detection)
640 use_pm - support the power-management (0 = off, 1 = on,
641 2 = auto (default))
642 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
643 joystick - enable joystick (default off)
644
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100645 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646
647 The power-management is supported.
648
649 Module snd-fm801
650 ----------------
651
652 Module for ForteMedia FM801 based PCI sound cards.
653
654 tea575x_tuner - Enable TEA575x tuner
655 - 1 = MediaForte 256-PCS
656 - 2 = MediaForte 256-PCPR
657 - 3 = MediaForte 64-PCR
658 - High 16-bits are video (radio) device number + 1
659 - example: 0x10002 (MediaForte 256-PCPR, device 1)
660
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100661 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662
Takashi Iwaia4efc232005-11-17 17:24:26 +0100663 The power-management is supported.
664
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200665 Module snd-gina20
666 -----------------
667
668 Module for Echoaudio Gina20
669
670 This module supports multiple cards.
671 The driver requires the firmware loader support on kernel.
672
673 Module snd-gina24
674 -----------------
675
676 Module for Echoaudio Gina24
677
678 This module supports multiple cards.
679 The driver requires the firmware loader support on kernel.
680
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 Module snd-gusclassic
682 ---------------------
683
684 Module for Gravis UltraSound Classic sound card.
685
686 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
687 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
688 dma1 - DMA # for GF1 chip (1,3,5,6,7)
689 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
690 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
691 voices - GF1 voices limit (14-32)
692 pcm_voices - reserved PCM voices
693
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100694 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695
696 Module snd-gusextreme
697 ---------------------
698
699 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
700
701 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
702 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
703 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
704 irq - IRQ # for ES-1688 chip (5,7,9,10)
705 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
706 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
707 dma8 - DMA # for ES-1688 chip (0,1,3)
708 dma1 - DMA # for GF1 chip (1,3,5,6,7)
709 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
710 voices - GF1 voices limit (14-32)
711 pcm_voices - reserved PCM voices
712
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100713 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
715 Module snd-gusmax
716 -----------------
717
718 Module for Gravis UltraSound MAX sound card.
719
720 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
721 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
722 dma1 - DMA # for GF1 chip (1,3,5,6,7)
723 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
724 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
725 voices - GF1 voices limit (14-32)
726 pcm_voices - reserved PCM voices
727
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100728 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729
730 Module snd-hda-intel
731 --------------------
732
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400733 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8, ICH9, ICH10,
734 PCH, SCH),
735 ATI SB450, SB600, R600, RS600, RS690, RS780, RV610, RV620,
736 RV630, RV635, RV670, RV770,
Takashi Iwai9b878192006-05-17 11:26:39 +0200737 VIA VT8251/VT8237A,
738 SIS966, ULI M5461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100740 [Multiple options for each card instance]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 model - force the model name
Takashi Iwaid2e1c972008-06-10 17:53:34 +0200742 position_fix - Fix DMA pointer (0 = auto, 1 = use LPIB, 2 = POSBUF)
Takashi Iwai95904742007-05-19 17:06:42 +0200743 probe_mask - Bitmask to probe codecs (default = -1, meaning all slots)
Takashi Iwaiae374d62009-02-13 08:33:55 +0100744 When the bit 8 (0x100) is set, the lower 8 bits are used
745 as the "fixed" codec slots; i.e. the driver probes the
746 slots regardless what hardware reports back
Takashi Iwaid4d9cd032008-12-19 15:19:11 +0100747 probe_only - Only probing and no codec initialization (default=off);
748 Useful to check the initial codec status for debugging
Takashi Iwai8c53b962008-06-10 17:53:35 +0200749 bdl_pos_adj - Specifies the DMA IRQ timing delay in samples.
750 Passing -1 will make the driver to choose the appropriate
751 value based on the controller chip.
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100752
753 [Single (global) options]
Takashi Iwai27346162006-01-12 18:28:44 +0100754 single_cmd - Use single immediate commands to communicate with
755 codecs (for debugging only)
Takashi Iwai134a11f2006-11-10 12:08:37 +0100756 enable_msi - Enable Message Signaled Interrupt (MSI) (default = off)
Takashi Iwaidee1b662007-08-13 16:10:30 +0200757 power_save - Automatic power-saving timtout (in second, 0 =
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200758 disable)
Takashi Iwaidee1b662007-08-13 16:10:30 +0200759 power_save_controller - Reset HD-audio controller in power-saving mode
760 (default = on)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100762 This module supports multiple cards and autoprobe.
763
Takashi Iwaicae51172008-12-19 08:36:53 +0100764 See Documentation/sound/alsa/HD-Audio.txt for more details about
765 HD-audio driver.
766
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 Each codec may have a model table for different configurations.
768 If your machine isn't listed there, the default (usually minimal)
769 configuration is set up. You can pass "model=<name>" option to
770 specify a certain model in such a case. There are different
Takashi Iwaicae51172008-12-19 08:36:53 +0100771 models depending on the codec chip. The list of available models
772 is found in HD-Audio-Models.txt
Takashi Iwaidb064e52006-03-16 16:04:58 +0100773
Takashi Iwai6d7b1d72007-02-26 15:56:46 +0100774 The model name "genric" is treated as a special case. When this
775 model is given, the driver uses the generic codec parser without
776 "codec-patch". It's sometimes good for testing and debugging.
777
Takashi Iwai62430082005-09-05 17:12:29 +0200778 If the default configuration doesn't work and one of the above
Takashi Iwai30bc4482008-12-09 08:23:45 +0100779 matches with your device, report it together with alsa-info.sh
780 output (with --no-upload option) to kernel bugzilla or alsa-devel
Takashi Iwai62430082005-09-05 17:12:29 +0200781 ML (see the section "Links and Addresses").
782
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200783 power_save and power_save_controller options are for power-saving
784 mode. See powersave.txt for details.
Takashi Iwaidee1b662007-08-13 16:10:30 +0200785
Takashi Iwaic74db862005-05-12 14:26:27 +0200786 Note 2: If you get click noises on output, try the module option
787 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
788 register value without FIFO size correction as the current
789 DMA pointer. position_fix=2 will make the driver to use
790 the position buffer instead of reading SD_LPIB register.
Michael Kerrisk90f31e32008-09-01 14:03:50 +0200791 (Usually SD_LPIB register is more accurate than the
Takashi Iwaic74db862005-05-12 14:26:27 +0200792 position buffer.)
793
Takashi Iwai27346162006-01-12 18:28:44 +0100794 NB: If you get many "azx_get_response timeout" messages at
795 loading, it's likely a problem of interrupts (e.g. ACPI irq
796 routing). Try to boot with options like "pci=noacpi". Also, you
797 can try "single_cmd=1" module option. This will switch the
798 communication method between HDA controller and codecs to the
799 single immediate commands instead of CORB/RIRB. Basically, the
800 single command mode is provided only for BIOS, and you won't get
801 unsolicited events, too. But, at least, this works independently
802 from the irq. Remember this is a last resort, and should be
803 avoided as much as possible...
804
Takashi Iwai95904742007-05-19 17:06:42 +0200805 MORE NOTES ON "azx_get_response timeout" PROBLEMS:
806 On some hardwares, you may need to add a proper probe_mask option
807 to avoid the "azx_get_response timeout" problem above, instead.
808 This occurs when the access to non-existing or non-working codec slot
809 (likely a modem one) causes a stall of the communication via HD-audio
810 bus. You can see which codec slots are probed by enabling
Takashi Iwai62cf8722008-05-20 12:15:15 +0200811 CONFIG_SND_DEBUG_VERBOSE, or simply from the file name of the codec
Takashi Iwai95904742007-05-19 17:06:42 +0200812 proc files. Then limit the slots to probe by probe_mask option.
813 For example, probe_mask=1 means to probe only the first slot, and
814 probe_mask=4 means only the third slot.
815
Takashi Iwaia4efc232005-11-17 17:24:26 +0100816 The power-management is supported.
817
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 Module snd-hdsp
819 ---------------
820
821 Module for RME Hammerfall DSP audio interface(s)
822
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100823 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824
825 Note: The firmware data can be automatically loaded via hotplug
826 when CONFIG_FW_LOADER is set. Otherwise, you need to load
827 the firmware via hdsploader utility included in alsa-tools
828 package.
829 The firmware data is found in alsa-firmware package.
830
831 Note: snd-page-alloc module does the job which snd-hammerfall-mem
832 module did formerly. It will allocate the buffers in advance
833 when any HDSP cards are found. To make the buffer
834 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +0200835 stage of boot sequence. See "Early Buffer Allocation"
836 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837
Takashi Iwai54704402005-06-03 11:27:00 +0200838 Module snd-hdspm
839 ----------------
840
841 Module for RME HDSP MADI board.
842
843 precise_ptr - Enable precise pointer, or disable.
844 line_outs_monitor - Send playback streams to analog outs by default.
845 enable_monitor - Enable Analog Out on Channel 63/64 by default.
846
847 See hdspm.txt for details.
848
Clemens Ladischc6260262008-01-25 08:41:52 +0100849 Module snd-hifier
850 -----------------
851
852 Module for the MediaTek/TempoTec HiFier Fantasia sound card.
853
854 This module supports autoprobe and multiple cards.
855
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 Module snd-ice1712
857 ------------------
858
859 Module for Envy24 (ICE1712) based PCI sound cards.
860 * MidiMan M Audio Delta 1010
861 * MidiMan M Audio Delta 1010LT
862 * MidiMan M Audio Delta DiO 2496
863 * MidiMan M Audio Delta 66
864 * MidiMan M Audio Delta 44
865 * MidiMan M Audio Delta 410
866 * MidiMan M Audio Audiophile 2496
867 * TerraTec EWS 88MT
868 * TerraTec EWS 88D
869 * TerraTec EWX 24/96
870 * TerraTec DMX 6Fire
Takashi Iwaic9bce912005-05-24 13:41:03 +0200871 * TerraTec Phase 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 * Hoontech SoundTrack DSP 24
873 * Hoontech SoundTrack DSP 24 Value
874 * Hoontech SoundTrack DSP 24 Media 7.1
Takashi Iwaic9bce912005-05-24 13:41:03 +0200875 * Event Electronics, EZ8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 * Digigram VX442
Takashi Iwaic9bce912005-05-24 13:41:03 +0200877 * Lionstracs, Mediastaton
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400878 * Terrasoniq TS 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879
880 model - Use the given board model, one of the following:
881 delta1010, dio2496, delta66, delta44, audiophile, delta410,
882 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
Takashi Iwaic9bce912005-05-24 13:41:03 +0200883 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
884 phase88, mediastation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 omni - Omni I/O support for MidiMan M-Audio Delta44/66
Matt LaPlantefa00e7e2006-11-30 04:55:36 +0100886 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transceiver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 in msec resolution, default value is 500 (0.5 sec)
888
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100889 This module supports multiple cards and autoprobe. Note: The consumer part
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 is not used with all Envy24 based cards (for example in the MidiMan Delta
891 serie).
892
Takashi Iwaic9bce912005-05-24 13:41:03 +0200893 Note: The supported board is detected by reading EEPROM or PCI
894 SSID (if EEPROM isn't available). You can override the
895 model by passing "model" module option in case that the
896 driver isn't configured properly or you want to try another
897 type for testing.
898
Linus Torvalds1da177e2005-04-16 15:20:36 -0700899 Module snd-ice1724
900 ------------------
901
Takashi Iwaic9bce912005-05-24 13:41:03 +0200902 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100903 * MidiMan M Audio Revolution 5.1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 * MidiMan M Audio Revolution 7.1
Takashi Iwai56255062006-11-09 16:47:26 +0100905 * MidiMan M Audio Audiophile 192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906 * AMP Ltd AUDIO2000
Takashi Iwaic9bce912005-05-24 13:41:03 +0200907 * TerraTec Aureon 5.1 Sky
908 * TerraTec Aureon 7.1 Space
909 * TerraTec Aureon 7.1 Universe
910 * TerraTec Phase 22
911 * TerraTec Phase 28
912 * AudioTrak Prodigy 7.1
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400913 * AudioTrak Prodigy 7.1 LT
914 * AudioTrak Prodigy 7.1 XT
915 * AudioTrak Prodigy 7.1 HIFI
916 * AudioTrak Prodigy 7.1 HD2
Takashi Iwaic9bce912005-05-24 13:41:03 +0200917 * AudioTrak Prodigy 192
918 * Pontis MS300
919 * Albatron K8X800 Pro II
920 * Chaintech ZNF3-150
921 * Chaintech ZNF3-250
922 * Chaintech 9CJS
Takashi Iwai8cfbbac2005-05-27 12:10:40 +0200923 * Chaintech AV-710
Takashi Iwaic9bce912005-05-24 13:41:03 +0200924 * Shuttle SN25P
Shin-ya Okadaf31639b2007-10-23 15:08:18 +0200925 * Onkyo SE-90PCI
926 * Onkyo SE-200PCI
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400927 * ESI Juli@
Takashi Iwai72cbfd42009-05-06 17:33:19 +0200928 * ESI Maya44
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400929 * Hercules Fortissimo IV
930 * EGO-SYS WaveTerminal 192M
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931
932 model - Use the given board model, one of the following:
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100933 revo51, revo71, amp2000, prodigy71, prodigy71lt,
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400934 prodigy71xt, prodigy71hifi, prodigyhd2, prodigy192,
935 juli, aureon51, aureon71, universe, ap192, k8x800,
936 phase22, phase28, ms300, av710, se200pci, se90pci,
Takashi Iwai72cbfd42009-05-06 17:33:19 +0200937 fortissimo4, sn25p, WT192M, maya44
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100939 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940
Takashi Iwaic9bce912005-05-24 13:41:03 +0200941 Note: The supported board is detected by reading EEPROM or PCI
942 SSID (if EEPROM isn't available). You can override the
943 model by passing "model" module option in case that the
944 driver isn't configured properly or you want to try another
945 type for testing.
946
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200947 Module snd-indigo
948 -----------------
949
950 Module for Echoaudio Indigo
951
952 This module supports multiple cards.
953 The driver requires the firmware loader support on kernel.
954
955 Module snd-indigodj
956 -------------------
957
958 Module for Echoaudio Indigo DJ
959
960 This module supports multiple cards.
961 The driver requires the firmware loader support on kernel.
962
963 Module snd-indigoio
964 -------------------
965
966 Module for Echoaudio Indigo IO
967
968 This module supports multiple cards.
969 The driver requires the firmware loader support on kernel.
970
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 Module snd-intel8x0
972 -------------------
973
974 Module for AC'97 motherboards from Intel and compatibles.
975 * Intel i810/810E, i815, i820, i830, i84x, MX440
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400976 ICH5, ICH6, ICH7, 6300ESB, ESB2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 * SiS 7012 (SiS 735)
Takashi Iwai89ac9c22006-01-24 10:36:57 +0100978 * NVidia NForce, NForce2, NForce3, MCP04, CK804
979 CK8, CK8S, MCP501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 * AMD AMD768, AMD8111
981 * ALi m5455
982
983 ac97_clock - AC'97 codec clock base (0 = auto-detect)
984 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200985 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 buggy_irq - Enable workaround for buggy interrupts on some
Takashi Iwaia06147d2005-09-08 19:54:17 +0200987 motherboards (default yes on nForce chips,
988 otherwise off)
989 buggy_semaphore - Enable workaround for hardwares with buggy
990 semaphores (e.g. on some ASUS laptops)
991 (default off)
Takashi Iwai6c5cfd92006-11-28 17:18:25 +0100992 spdif_aclink - Use S/PDIF over AC-link instead of direct connection
993 from the controller chip
994 (0 = off, 1 = on, -1 = default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200996 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997
998 Note: the latest driver supports auto-detection of chip clock.
999 if you still encounter too fast playback, specify the clock
1000 explicitly via the module option "ac97_clock=41194".
1001
1002 Joystick/MIDI ports are not supported by this driver. If your
1003 motherboard has these devices, use the ns558 or snd-mpu401
1004 modules, respectively.
1005
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 The power-management is supported.
1007
1008 Module snd-intel8x0m
1009 --------------------
1010
1011 Module for Intel ICH (i8x0) chipset MC97 modems.
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001012 * Intel i810/810E, i815, i820, i830, i84x, MX440
1013 ICH5, ICH6, ICH7
1014 * SiS 7013 (SiS 735)
1015 * NVidia NForce, NForce2, NForce2s, NForce3
1016 * AMD AMD8111
1017 * ALi m5455
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018
1019 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1020
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001021 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022
1023 Note: The default index value of this module is -2, i.e. the first
1024 slot is excluded.
1025
Takashi Iwaia4efc232005-11-17 17:24:26 +01001026 The power-management is supported.
1027
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028 Module snd-interwave
1029 --------------------
1030
1031 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1032 and other sound cards based on AMD InterWave (tm) chip.
1033
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1035 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1036 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1037 effect - 1 = InterWave effects enable (default 0);
1038 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001039 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1040
1041 with isapnp=0, the following options are available:
1042
1043 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1044 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1045 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1046 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001048 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049
1050 Module snd-interwave-stb
1051 ------------------------
1052
1053 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1054 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1055 circuit for extended control of bass, treble and master volume.
1056
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1058 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1059 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1060 effect - 1 = InterWave effects enable (default 0);
1061 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001062 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1063
1064 with isapnp=0, the following options are available:
1065
1066 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1067 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1068 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1069 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1070 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001072 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073
1074 Module snd-korg1212
1075 -------------------
1076
1077 Module for Korg 1212 IO PCI card
1078
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001079 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001081 Module snd-layla20
1082 ------------------
1083
1084 Module for Echoaudio Layla20
1085
1086 This module supports multiple cards.
1087 The driver requires the firmware loader support on kernel.
1088
1089 Module snd-layla24
1090 ------------------
1091
1092 Module for Echoaudio Layla24
1093
1094 This module supports multiple cards.
1095 The driver requires the firmware loader support on kernel.
1096
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 Module snd-maestro3
1098 -------------------
1099
1100 Module for Allegro/Maestro3 chips
1101
1102 external_amp - enable external amp (enabled by default)
1103 amp_gpio - GPIO pin number for external amp (0-15) or
1104 -1 for default pin (8 for allegro, 1 for
1105 others)
1106
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001107 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108
1109 Note: the binding of amplifier is dependent on hardware.
1110 If there is no sound even though all channels are unmuted, try to
1111 specify other gpio connection via amp_gpio option.
1112 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1113 option.
1114
1115 The power-management is supported.
1116
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001117 Module snd-mia
1118 ---------------
1119
1120 Module for Echoaudio Mia
1121
1122 This module supports multiple cards.
1123 The driver requires the firmware loader support on kernel.
1124
Martin Langer1841f6132006-03-27 12:41:01 +02001125 Module snd-miro
1126 ---------------
1127
1128 Module for Miro soundcards: miroSOUND PCM 1 pro,
1129 miroSOUND PCM 12,
1130 miroSOUND PCM 20 Radio.
1131
1132 port - Port # (0x530,0x604,0xe80,0xf40)
1133 irq - IRQ # (5,7,9,10,11)
1134 dma1 - 1st dma # (0,1,3)
1135 dma2 - 2nd dma # (0,1)
1136 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1137 mpu_irq - MPU-401 irq # (5,7,9,10)
1138 fm_port - FM Port # (0x388)
1139 wss - enable WSS mode
1140 ide - enable onboard ide support
1141
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 Module snd-mixart
1143 -----------------
1144
1145 Module for Digigram miXart8 sound cards.
1146
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001147 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148 Note: One miXart8 board will be represented as 4 alsa cards.
1149 See MIXART.txt for details.
1150
1151 When the driver is compiled as a module and the hotplug firmware
1152 is supported, the firmware data is loaded via hotplug automatically.
1153 Install the necessary firmware files in alsa-firmware package.
1154 When no hotplug fw loader is available, you need to load the
1155 firmware via mixartloader utility in alsa-tools package.
1156
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001157 Module snd-mona
1158 ---------------
1159
1160 Module for Echoaudio Mona
1161
1162 This module supports multiple cards.
1163 The driver requires the firmware loader support on kernel.
1164
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165 Module snd-mpu401
1166 -----------------
1167
1168 Module for MPU-401 UART devices.
1169
1170 port - port number or -1 (disable)
1171 irq - IRQ number or -1 (disable)
1172 pnp - PnP detection - 0 = disable, 1 = enable (default)
1173
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001174 This module supports multiple devices and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175
Takashi Iwaic96330b2009-01-28 08:23:03 +01001176 Module snd-msnd-classic
1177 -----------------------
1178
1179 Module for Turtle Beach MultiSound Classic, Tahiti or Monterey
1180 soundcards.
1181
1182 io - Port # for msnd-classic card
1183 irq - IRQ # for msnd-classic card
1184 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1185 0xe0000 or 0xe8000)
1186 write_ndelay - enable write ndelay (default = 1)
1187 calibrate_signal - calibrate signal (default = 0)
1188 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1189 digital - Digital daughterboard present (default = 0)
1190 cfg - Config port (0x250, 0x260 or 0x270) default = PnP
1191 reset - Reset all devices
1192 mpu_io - MPU401 I/O port
1193 mpu_irq - MPU401 irq#
1194 ide_io0 - IDE port #0
1195 ide_io1 - IDE port #1
1196 ide_irq - IDE irq#
1197 joystick_io - Joystick I/O port
1198
1199 The driver requires firmware files "turtlebeach/msndinit.bin" and
1200 "turtlebeach/msndperm.bin" in the proper firmware directory.
1201
1202 See Documentation/sound/oss/MultiSound for important information
1203 about this driver. Note that it has been discontinued, but the
1204 Voyetra Turtle Beach knowledge base entry for it is still available
1205 at
1206 http://www.turtlebeach.com/site/kb_ftp/790.asp
1207
1208 Module snd-msnd-pinnacle
1209 ------------------------
1210
1211 Module for Turtle Beach MultiSound Pinnacle/Fiji soundcards.
1212
1213 io - Port # for pinnacle/fiji card
1214 irq - IRQ # for pinnalce/fiji card
1215 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1216 0xe0000 or 0xe8000)
1217 write_ndelay - enable write ndelay (default = 1)
1218 calibrate_signal - calibrate signal (default = 0)
1219 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1220
1221 The driver requires firmware files "turtlebeach/pndspini.bin" and
1222 "turtlebeach/pndsperm.bin" in the proper firmware directory.
1223
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 Module snd-mtpav
1225 ----------------
1226
1227 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1228 port).
1229
1230 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1231 irq - IRQ # for MTPAV (7,5, default=7)
1232 hwports - number of supported hardware ports, default=8.
1233
1234 Module supports only 1 card. This module has no enable option.
1235
Matthias Koenig68ab8012006-07-27 16:59:23 +02001236 Module snd-mts64
1237 ----------------
1238
1239 Module for Ego Systems (ESI) Miditerminal 4140
1240
1241 This module supports multiple devices.
1242 Requires parport (CONFIG_PARPORT).
1243
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 Module snd-nm256
1245 ----------------
1246
1247 Module for NeoMagic NM256AV/ZX chips
1248
1249 playback_bufsize - max playback frame size in kB (4-128kB)
1250 capture_bufsize - max capture frame size in kB (4-128kB)
1251 force_ac97 - 0 or 1 (disabled by default)
1252 buffer_top - specify buffer top address
1253 use_cache - 0 or 1 (disabled by default)
1254 vaio_hack - alias buffer_top=0x25a800
1255 reset_workaround - enable AC97 RESET workaround for some laptops
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001256 reset_workaround2 - enable extended AC97 RESET workaround for some
1257 other laptops
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +02001259 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260
1261 The power-management is supported.
1262
1263 Note: on some notebooks the buffer address cannot be detected
1264 automatically, or causes hang-up during initialization.
Matt LaPlantefff92892006-10-03 22:47:42 +02001265 In such a case, specify the buffer top address explicitly via
1266 the buffer_top option.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 For example,
1268 Sony F250: buffer_top=0x25a800
1269 Sony F270: buffer_top=0x272800
1270 The driver supports only ac97 codec. It's possible to force
1271 to initialize/use ac97 although it's not detected. In such a
1272 case, use force_ac97=1 option - but *NO* guarantee whether it
1273 works!
1274
1275 Note: The NM256 chip can be linked internally with non-AC97
1276 codecs. This driver supports only the AC97 codec, and won't work
1277 with machines with other (most likely CS423x or OPL3SAx) chips,
1278 even though the device is detected in lspci. In such a case, try
1279 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
Takashi Iwai62430082005-09-05 17:12:29 +02001280 but some doesn't have ISA PnP. You'll need to specify isapnp=0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 and proper hardware parameters in the case without ISA PnP.
1282
1283 Note: some laptops need a workaround for AC97 RESET. For the
1284 known hardware like Dell Latitude LS and Sony PCG-F305, this
1285 workaround is enabled automatically. For other laptops with a
1286 hard freeze, you can try reset_workaround=1 option.
1287
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001288 Note: Dell Latitude CSx laptops have another problem regarding
1289 AC97 RESET. On these laptops, reset_workaround2 option is
1290 turned on as default. This option is worth to try if the
1291 previous reset_workaround option doesn't help.
1292
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 Note: This driver is really crappy. It's a porting from the
1294 OSS driver, which is a result of black-magic reverse engineering.
1295 The detection of codec will fail if the driver is loaded *after*
1296 X-server as described above. You might be able to force to load
1297 the module, but it may result in hang-up. Hence, make sure that
1298 you load this module *before* X if you encounter this kind of
1299 problem.
1300
1301 Module snd-opl3sa2
1302 ------------------
1303
1304 Module for Yamaha OPL3-SA2/SA3 sound cards.
1305
Rene Herman64e0e2d2007-12-13 16:29:33 +01001306 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1307
1308 with isapnp=0, the following options are available:
1309
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310 port - control port # for OPL3-SA chip (0x370)
1311 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1312 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1313 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1314 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1315 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1316 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1317 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001319 This module supports multiple cards and ISA PnP. It does not support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1321
1322 The power-management is supported.
1323
1324 Module snd-opti92x-ad1848
1325 -------------------------
1326
1327 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1328 Module works with OAK Mozart cards as well.
1329
Rene Herman64e0e2d2007-12-13 16:29:33 +01001330 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1331
1332 with isapnp=0, the following options are available:
1333
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1335 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1336 fm_port - port # for OPL3 device (0x388)
1337 irq - IRQ # for WSS chip (5,7,9,10,11)
1338 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1339 dma1 - first DMA # for WSS chip (0,1,3)
1340
1341 This module supports only one card, autoprobe and PnP.
1342
1343 Module snd-opti92x-cs4231
1344 -------------------------
1345
1346 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1347
Rene Herman64e0e2d2007-12-13 16:29:33 +01001348 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1349
1350 with isapnp=0, the following options are available:
1351
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1353 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1354 fm_port - port # for OPL3 device (0x388)
1355 irq - IRQ # for WSS chip (5,7,9,10,11)
1356 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1357 dma1 - first DMA # for WSS chip (0,1,3)
1358 dma2 - second DMA # for WSS chip (0,1,3)
1359
1360 This module supports only one card, autoprobe and PnP.
1361
1362 Module snd-opti93x
1363 ------------------
1364
1365 Module for sound cards based on OPTi 82c93x chips.
1366
Rene Herman64e0e2d2007-12-13 16:29:33 +01001367 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1368
1369 with isapnp=0, the following options are available:
1370
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1372 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1373 fm_port - port # for OPL3 device (0x388)
1374 irq - IRQ # for WSS chip (5,7,9,10,11)
1375 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1376 dma1 - first DMA # for WSS chip (0,1,3)
1377 dma2 - second DMA # for WSS chip (0,1,3)
1378
1379 This module supports only one card, autoprobe and PnP.
1380
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001381 Module snd-oxygen
1382 -----------------
1383
1384 Module for sound cards based on the C-Media CMI8788 chip:
1385 * Asound A-8788
1386 * AuzenTech X-Meridian
1387 * Bgears b-Enspirer
1388 * Club3D Theatron DTS
Clemens Ladischde04b102008-11-26 10:37:23 +01001389 * HT-Omega Claro (plus)
1390 * HT-Omega Claro halo (XT)
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001391 * Razer Barracuda AC-1
1392 * Sondigo Inferno
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001393
1394 This module supports autoprobe and multiple cards.
1395
Stas Sergeevd08cd582008-03-06 11:01:44 +01001396 Module snd-pcsp
1397 -----------------
1398
1399 Module for internal PC-Speaker.
1400
1401 nforce_wa - enable NForce chipset workaround. Expect bad sound.
1402
1403 This module supports system beeps, some kind of PCM playback and
1404 even a few mixer controls.
1405
Markus Bollingere12229b2005-12-06 13:55:26 +01001406 Module snd-pcxhr
1407 ----------------
1408
1409 Module for Digigram PCXHR boards
1410
1411 This module supports multiple cards.
1412
Matthias Koenig757e1192007-01-25 13:15:05 +01001413 Module snd-portman2x4
1414 ---------------------
1415
1416 Module for Midiman Portman 2x4 parallel port MIDI interface
1417
1418 This module supports multiple cards.
1419
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420 Module snd-powermac (on ppc only)
1421 ---------------------------------
1422
1423 Module for PowerMac, iMac and iBook on-board soundchips
1424
1425 enable_beep - enable beep using PCM (enabled as default)
1426
1427 Module supports autoprobe a chip.
1428
1429 Note: the driver may have problems regarding endianess.
1430
1431 The power-management is supported.
1432
Takashi Iwai2c484df2005-06-30 18:54:04 +02001433 Module snd-pxa2xx-ac97 (on arm only)
1434 ------------------------------------
1435
1436 Module for AC97 driver for the Intel PXA2xx chip
1437
1438 For ARM architecture only.
1439
Takashi Iwaia4efc232005-11-17 17:24:26 +01001440 The power-management is supported.
1441
Peter Gruber109a9632006-03-27 13:10:28 +02001442 Module snd-riptide
1443 ------------------
1444
1445 Module for Conexant Riptide chip
1446
1447 joystick_port - Joystick port # (default: 0x200)
1448 mpu_port - MPU401 port # (default: 0x330)
1449 opl3_port - OPL3 port # (default: 0x388)
1450
1451 This module supports multiple cards.
1452 The driver requires the firmware loader support on kernel.
1453 You need to install the firmware file "riptide.hex" to the standard
1454 firmware path (e.g. /lib/firmware).
1455
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456 Module snd-rme32
1457 ----------------
1458
1459 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1460 Prodif96 and Prodif Gold) sound cards.
1461
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001462 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463
1464 Module snd-rme96
1465 ----------------
1466
1467 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1468
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001469 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470
1471 Module snd-rme9652
1472 ------------------
1473
1474 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1475
1476 precise_ptr - Enable precise pointer (doesn't work reliably).
1477 (default = 0)
1478
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001479 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001480
1481 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1482 module did formerly. It will allocate the buffers in advance
1483 when any RME9652 cards are found. To make the buffer
1484 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +02001485 stage of boot sequence. See "Early Buffer Allocation"
1486 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001487
1488 Module snd-sa11xx-uda1341 (on arm only)
1489 ---------------------------------------
1490
1491 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1492
1493 Module supports only one card.
1494 Module has no enable and index options.
1495
Takashi Iwaia4efc232005-11-17 17:24:26 +01001496 The power-management is supported.
1497
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 Module snd-sb8
1499 --------------
1500
1501 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1502 SoundBlaster 2.0,
1503 SoundBlaster Pro
1504
1505 port - port # for SB DSP chip (0x220,0x240,0x260)
1506 irq - IRQ # for SB DSP chip (5,7,9,10)
1507 dma8 - DMA # for SB DSP chip (1,3)
1508
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001509 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001510
Takashi Iwaia4efc232005-11-17 17:24:26 +01001511 The power-management is supported.
1512
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513 Module snd-sb16 and snd-sbawe
1514 -----------------------------
1515
1516 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1517 SoundBlaster AWE 32 (PnP),
1518 SoundBlaster AWE 64 PnP
1519
Rene Herman64e0e2d2007-12-13 16:29:33 +01001520 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1521 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1522 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1523
1524 with isapnp=0, the following options are available:
1525
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1527 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1528 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1529 (snd-sbawe module only)
1530 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1531 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1532 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001534 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535
1536 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1537 disable 16bit DMA with dma16 = -1 module parameter.
1538 Also, all Sound Blaster 16 type cards can operate in 16-bit
1539 half duplex mode through 8-bit DMA channel by disabling their
1540 16-bit DMA channel.
1541
Takashi Iwaia4efc232005-11-17 17:24:26 +01001542 The power-management is supported.
1543
Takashi Iwai074a6e92007-09-11 22:10:14 +02001544 Module snd-sc6000
1545 -----------------
1546
1547 Module for Gallant SC-6000 soundcard.
1548
1549 port - Port # (0x220 or 0x240)
1550 mss_port - MSS Port # (0x530 or 0xe80)
1551 irq - IRQ # (5,7,9,10,11)
Krzysztof Helt7b758d22007-09-17 14:42:49 +02001552 mpu_irq - MPU-401 IRQ # (5,7,9,10) ,0 - no MPU-401 irq
Takashi Iwai074a6e92007-09-11 22:10:14 +02001553 dma - DMA # (1,3,0)
1554
1555 This module supports multiple cards.
1556
1557 This card is also known as Audio Excel DSP 16 or Zoltrix AV302.
1558
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 Module snd-sgalaxy
1560 ------------------
1561
1562 Module for Aztech Sound Galaxy sound card.
1563
1564 sbport - Port # for SB16 interface (0x220,0x240)
1565 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1566 irq - IRQ # (7,9,10,11)
1567 dma1 - DMA #
1568
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001569 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570
Takashi Iwaia4efc232005-11-17 17:24:26 +01001571 The power-management is supported.
1572
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 Module snd-sscape
1574 -----------------
1575
1576 Module for ENSONIQ SoundScape PnP cards.
1577
1578 port - Port # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001579 wss_port - WSS Port # (PnP setup)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580 irq - IRQ # (PnP setup)
1581 mpu_irq - MPU-401 IRQ # (PnP setup)
1582 dma - DMA # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001583 dma2 - 2nd DMA # (PnP setup, -1 to disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001585 This module supports multiple cards. ISA PnP must be enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 You need sscape_ctl tool in alsa-tools package for loading
1587 the microcode.
1588
1589 Module snd-sun-amd7930 (on sparc only)
1590 --------------------------------------
1591
1592 Module for AMD7930 sound chips found on Sparcs.
1593
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001594 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595
1596 Module snd-sun-cs4231 (on sparc only)
1597 -------------------------------------
1598
1599 Module for CS4231 sound chips found on Sparcs.
1600
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001601 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001603 Module snd-sun-dbri (on sparc only)
1604 -----------------------------------
1605
1606 Module for DBRI sound chips found on Sparcs.
1607
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001608 This module supports multiple cards.
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001609
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 Module snd-wavefront
1611 --------------------
1612
1613 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1614
Rene Herman64e0e2d2007-12-13 16:29:33 +01001615 use_cs4232_midi - Use CS4232 MPU-401 interface
1616 (inaccessibly located inside your computer)
1617 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1618
1619 with isapnp=0, the following options are available:
1620
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 cs4232_pcm_port - Port # for CS4232 PCM interface.
1622 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1623 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1624 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625 ics2115_port - Port # for ICS2115
1626 ics2115_irq - IRQ # for ICS2115
1627 fm_port - FM OPL-3 Port #
1628 dma1 - DMA1 # for CS4232 PCM interface.
1629 dma2 - DMA2 # for CS4232 PCM interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630
Takashi Iwaic2b12392007-08-21 15:20:26 +02001631 The below are options for wavefront_synth features:
1632 wf_raw - Assume that we need to boot the OS (default:no)
1633 If yes, then during driver loading, the state of the board is
1634 ignored, and we reset the board and load the firmware anyway.
1635 fx_raw - Assume that the FX process needs help (default:yes)
1636 If false, we'll leave the FX processor in whatever state it is
1637 when the driver is loaded. The default is to download the
1638 microprogram and associated coefficients to set it up for
1639 "default" operation, whatever that means.
1640 debug_default - Debug parameters for card initialization
1641 wait_usecs - How long to wait without sleeping, usecs
1642 (default:150)
1643 This magic number seems to give pretty optimal throughput
1644 based on my limited experimentation.
1645 If you want to play around with it and find a better value, be
1646 my guest. Remember, the idea is to get a number that causes us
1647 to just busy wait for as many WaveFront commands as possible,
1648 without coming up with a number so large that we hog the whole
1649 CPU.
1650 Specifically, with this number, out of about 134,000 status
1651 waits, only about 250 result in a sleep.
1652 sleep_interval - How long to sleep when waiting for reply
1653 (default: 100)
1654 sleep_tries - How many times to try sleeping during a wait
1655 (default: 50)
1656 ospath - Pathname to processed ICS2115 OS firmware
1657 (default:wavefront.os)
1658 The path name of the ISC2115 OS firmware. In the recent
1659 version, it's handled via firmware loader framework, so it
1660 must be installed in the proper path, typically,
1661 /lib/firmware.
1662 reset_time - How long to wait for a reset to take effect
1663 (default:2)
1664 ramcheck_time - How many seconds to wait for the RAM test
1665 (default:20)
1666 osrun_time - How many seconds to wait for the ICS2115 OS
1667 (default:10)
1668
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001669 This module supports multiple cards and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670
Takashi Iwaic2b12392007-08-21 15:20:26 +02001671 Note: the firmware file "wavefront.os" was located in the earlier
1672 version in /etc. Now it's loaded via firmware loader, and
1673 must be in the proper firmware path, such as /lib/firmware.
1674 Copy (or symlink) the file appropriately if you get an error
1675 regarding firmware downloading after upgrading the kernel.
1676
Linus Torvalds1da177e2005-04-16 15:20:36 -07001677 Module snd-sonicvibes
1678 ---------------------
1679
1680 Module for S3 SonicVibes PCI sound cards.
1681 * PINE Schubert 32 PCI
1682
1683 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1684 - SoundCard must have onboard SRAM for this.
1685 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1686
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001687 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688
1689 Module snd-serial-u16550
1690 ------------------------
1691
1692 Module for UART16550A serial MIDI ports.
1693
1694 port - port # for UART16550A chip
1695 irq - IRQ # for UART16550A chip, -1 = poll mode
1696 speed - speed in bauds (9600,19200,38400,57600,115200)
1697 38400 = default
1698 base - base for divisor in bauds (57600,115200,230400,460800)
1699 115200 = default
1700 outs - number of MIDI ports in a serial port (1-4)
1701 1 = default
1702 adaptor - Type of adaptor.
1703 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1704 3 = MS-124W M/B, 4 = Generic
1705
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001706 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707 thus the main port must be specified!!! Other options are optional.
1708
1709 Module snd-trident
1710 ------------------
1711
1712 Module for Trident 4DWave DX/NX sound cards.
1713 * Best Union Miss Melody 4DWave PCI
1714 * HIS 4DWave PCI
1715 * Warpspeed ONSpeed 4DWave PCI
1716 * AzTech PCI 64-Q3D
1717 * Addonics SV 750
1718 * CHIC True Sound 4Dwave
1719 * Shark Predator4D-PCI
1720 * Jaton SonicWave 4D
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001721 * SiS SI7018 PCI Audio
1722 * Hoontech SoundTrack Digital 4DWave NX
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723
1724 pcm_channels - max channels (voices) reserved for PCM
1725 wavetable_size - max wavetable size in kB (4-?kb)
1726
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001727 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001728
1729 The power-management is supported.
1730
1731 Module snd-usb-audio
1732 --------------------
1733
1734 Module for USB audio and USB MIDI devices.
1735
1736 vid - Vendor ID for the device (optional)
1737 pid - Product ID for the device (optional)
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001738 nrpacks - Max. number of packets per URB (default: 8)
1739 async_unlink - Use async unlink mode (default: yes)
Thibault LE MEURe3113342006-03-14 11:44:53 +01001740 device_setup - Device specific magic number (optional)
1741 - Influence depends on the device
1742 - Default: 0x0000
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001743 ignore_ctl_error - Ignore any USB-controller regarding mixer
1744 interface (default: no)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001746 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001747
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001748 NB: nrpacks parameter can be modified dynamically via sysfs.
1749 Don't put the value over 20. Changing via sysfs has no sanity
1750 check.
1751 NB: async_unlink=0 would cause Oops. It remains just for
1752 debugging purpose (if any).
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001753 NB: ignore_ctl_error=1 may help when you get an error at accessing
1754 the mixer element such as URB error -22. This happens on some
1755 buggy USB device or the controller.
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001756
Daniel Mack523f1dc2007-03-26 19:11:24 +02001757 Module snd-usb-caiaq
1758 --------------------
1759
1760 Module for caiaq UB audio interfaces,
1761 * Native Instruments RigKontrol2
1762 * Native Instruments Kore Controller
1763 * Native Instruments Audio Kontrol 1
1764 * Native Instruments Audio 8 DJ
1765
1766 This module supports multiple devices, autoprobe and hotplugging.
1767
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 Module snd-usb-usx2y
1769 --------------------
1770
1771 Module for Tascam USB US-122, US-224 and US-428 devices.
1772
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001773 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774
1775 Note: you need to load the firmware via usx2yloader utility included
1776 in alsa-tools and alsa-firmware packages.
1777
1778 Module snd-via82xx
1779 ------------------
1780
1781 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001782 8233A, 8233C, 8235, 8237 (south) bridge.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783
1784 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1785 [VIA686A/686B only]
1786 joystick - Enable joystick (default off) [VIA686A/686B only]
1787 ac97_clock - AC'97 codec clock base (default 48000Hz)
1788 dxs_support - support DXS channels,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001789 0 = auto (default), 1 = enable, 2 = disable,
1790 3 = 48k only, 4 = no VRA, 5 = enable any sample
1791 rate and different sample rates on different
1792 channels
1793 [VIA8233/C, 8235, 8237 only]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001795 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001797 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798
1799 Note: on some SMP motherboards like MSI 694D the interrupts might
1800 not be generated properly. In such a case, please try to
1801 set the SMP (or MPS) version on BIOS to 1.1 instead of
1802 default value 1.4. Then the interrupt number will be
1803 assigned under 15. You might also upgrade your BIOS.
1804
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001805 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 channels as the first PCM. On these channels, up to 4
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001807 streams can be played at the same time, and the controller
1808 can perform sample rate conversion with separate rates for
1809 each channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810 As default (dxs_support = 0), 48k fixed rate is chosen
1811 except for the known devices since the output is often
1812 noisy except for 48k on some mother boards due to the
1813 bug of BIOS.
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001814 Please try once dxs_support=5 and if it works on other
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1816 know the PCI subsystem vendor/device id's (output of
1817 "lspci -nv").
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001818 If dxs_support=5 does not work, try dxs_support=4; if it
1819 doesn't work too, try dxs_support=1. (dxs_support=1 is
Takashi Iwai62430082005-09-05 17:12:29 +02001820 usually for old motherboards. The correct implemented
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001821 board should work with 4 or 5.) If it still doesn't
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 work and the default setting is ok, dxs_support=3 is the
1823 right choice. If the default setting doesn't work at all,
1824 try dxs_support=2 to disable the DXS channels.
1825 In any cases, please let us know the result and the
Takashi Iwai62430082005-09-05 17:12:29 +02001826 subsystem vendor/device ids. See "Links and Addresses"
1827 below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828
1829 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Takashi Iwai62430082005-09-05 17:12:29 +02001830 additionally. The mpu_port option is for VIA686 chips only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831
Takashi Iwaia4efc232005-11-17 17:24:26 +01001832 The power-management is supported.
1833
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 Module snd-via82xx-modem
1835 ------------------------
1836
1837 Module for VIA82xx AC97 modem
1838
1839 ac97_clock - AC'97 codec clock base (default 48000Hz)
1840
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001841 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842
1843 Note: The default index value of this module is -2, i.e. the first
1844 slot is excluded.
1845
Takashi Iwaia4efc232005-11-17 17:24:26 +01001846 The power-management is supported.
1847
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848 Module snd-virmidi
1849 ------------------
1850
1851 Module for virtual rawmidi devices.
1852 This module creates virtual rawmidi devices which communicate
1853 to the corresponding ALSA sequencer ports.
1854
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001855 midi_devs - MIDI devices # (1-4, default=4)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001857 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001859 Module snd-virtuoso
1860 -------------------
1861
Clemens Ladisch5430c722008-07-28 10:28:43 +02001862 Module for sound cards based on the Asus AV100/AV200 chips,
Clemens Ladisch930738d2009-02-26 09:27:20 +01001863 i.e., Xonar D1, DX, D2, D2X, HDAV1.3 (Deluxe), and Essence STX.
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001864
1865 This module supports autoprobe and multiple cards.
1866
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 Module snd-vx222
1868 ----------------
1869
1870 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1871
1872 mic - Enable Microphone on V222 Mic (NYI)
1873 ibl - Capture IBL size. (default = 0, minimum size)
1874
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001875 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876
1877 When the driver is compiled as a module and the hotplug firmware
1878 is supported, the firmware data is loaded via hotplug automatically.
1879 Install the necessary firmware files in alsa-firmware package.
1880 When no hotplug fw loader is available, you need to load the
1881 firmware via vxloader utility in alsa-tools package. To invoke
1882 vxloader automatically, add the following to /etc/modprobe.conf
1883
1884 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1885
1886 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1887 /etc/modules.conf, instead.)
1888 IBL size defines the interrupts period for PCM. The smaller size
1889 gives smaller latency but leads to more CPU consumption, too.
1890 The size is usually aligned to 126. As default (=0), the smallest
1891 size is chosen. The possible IBL values can be found in
1892 /proc/asound/cardX/vx-status proc file.
1893
Takashi Iwaia4efc232005-11-17 17:24:26 +01001894 The power-management is supported.
1895
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 Module snd-vxpocket
1897 -------------------
1898
Takashi Iwai6d00a312005-06-30 13:40:51 +02001899 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900
1901 ibl - Capture IBL size. (default = 0, minimum size)
1902
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001903 This module supports multiple cards. The module is compiled only when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 PCMCIA is supported on kernel.
1905
Takashi Iwai62430082005-09-05 17:12:29 +02001906 With the older 2.6.x kernel, to activate the driver via the card
1907 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1908 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1909 longer require a config file.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910
1911 When the driver is compiled as a module and the hotplug firmware
1912 is supported, the firmware data is loaded via hotplug automatically.
1913 Install the necessary firmware files in alsa-firmware package.
1914 When no hotplug fw loader is available, you need to load the
1915 firmware via vxloader utility in alsa-tools package.
1916
1917 About capture IBL, see the description of snd-vx222 module.
1918
Takashi Iwaied7cbe32006-05-11 11:30:10 +02001919 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
Takashi Iwai62430082005-09-05 17:12:29 +02001920 ALSA 1.0.10.
1921
Takashi Iwaia4efc232005-11-17 17:24:26 +01001922 The power-management is supported.
1923
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924 Module snd-ymfpci
1925 -----------------
1926
1927 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1928
1929 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1930 1 (auto-detect for YMF744/754 only)
1931 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1932 1 (auto-detect for YMF744/754 only)
1933 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1934 1 (auto-detect)
1935 rear_switch - enable shared rear/line-in switch (bool)
1936
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001937 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938
1939 The power-management is supported.
1940
1941 Module snd-pdaudiocf
1942 --------------------
1943
1944 Module for Sound Core PDAudioCF sound card.
1945
Takashi Iwaia4efc232005-11-17 17:24:26 +01001946 The power-management is supported.
1947
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948
Takashi Iwai62430082005-09-05 17:12:29 +02001949AC97 Quirk Option
1950=================
1951
1952The ac97_quirk option is used to enable/override the workaround for
1953specific devices on drivers for on-board AC'97 controllers like
1954snd-intel8x0. Some hardware have swapped output pins between Master
1955and Headphone, or Surround (thanks to confusion of AC'97
1956specifications from version to version :-)
1957
1958The driver provides the auto-detection of known problematic devices,
1959but some might be unknown or wrongly detected. In such a case, pass
1960the proper value with this option.
1961
1962The following strings are accepted:
1963 - default Don't override the default setting
Takashi Iwai10e4097f2005-11-17 11:04:55 +01001964 - none Disable the quirk
Takashi Iwai62430082005-09-05 17:12:29 +02001965 - hp_only Bind Master and Headphone controls as a single control
1966 - swap_hp Swap headphone and master controls
1967 - swap_surround Swap master and surround controls
1968 - ad_sharing For AD1985, turn on OMS bit and use headphone
1969 - alc_jack For ALC65x, turn on the jack sense mode
1970 - inv_eapd Inverted EAPD implementation
1971 - mute_led Bind EAPD bit for turning on/off mute LED
1972
1973For backward compatibility, the corresponding integer value -1, 0,
1974... are accepted, too.
1975
1976For example, if "Master" volume control has no effect on your device
1977but only "Headphone" does, pass ac97_quirk=hp_only module option.
1978
1979
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980Configuring Non-ISAPNP Cards
1981============================
1982
1983When the kernel is configured with ISA-PnP support, the modules
1984supporting the isapnp cards will have module options "isapnp".
1985If this option is set, *only* the ISA-PnP devices will be probed.
1986For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
1987together with the proper i/o and irq configuration.
1988
1989When the kernel is configured without ISA-PnP support, isapnp option
1990will be not built in.
1991
1992
1993Module Autoloading Support
1994==========================
1995
1996The ALSA drivers can be loaded automatically on demand by defining
1997module aliases. The string 'snd-card-%1' is requested for ALSA native
1998devices where %i is sound card number from zero to seven.
1999
2000To auto-load an ALSA driver for OSS services, define the string
2001'sound-slot-%i' where %i means the slot number for OSS, which
2002corresponds to the card index of ALSA. Usually, define this
Tobias Klauserd533f672005-09-10 00:26:46 -07002003as the same card module.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004
2005An example configuration for a single emu10k1 card is like below:
2006----- /etc/modprobe.conf
2007alias snd-card-0 snd-emu10k1
2008alias sound-slot-0 snd-emu10k1
2009----- /etc/modprobe.conf
2010
2011The available number of auto-loaded sound cards depends on the module
2012option "cards_limit" of snd module. As default it's set to 1.
2013To enable the auto-loading of multiple cards, specify the number of
2014sound cards in that option.
2015
2016When multiple cards are available, it'd better to specify the index
2017number for each card via module option, too, so that the order of
2018cards is kept consistent.
2019
2020An example configuration for two sound cards is like below:
2021
2022----- /etc/modprobe.conf
2023# ALSA portion
2024options snd cards_limit=2
2025alias snd-card-0 snd-interwave
2026alias snd-card-1 snd-ens1371
2027options snd-interwave index=0
2028options snd-ens1371 index=1
2029# OSS/Free portion
2030alias sound-slot-0 snd-interwave
2031alias sound-slot-1 snd-ens1371
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02002032----- /etc/modprobe.conf
Linus Torvalds1da177e2005-04-16 15:20:36 -07002033
2034In this example, the interwave card is always loaded as the first card
2035(index 0) and ens1371 as the second (index 1).
2036
Takashi Iwai304cd072007-10-26 15:10:15 +02002037Alternative (and new) way to fixate the slot assignment is to use
2038"slots" option of snd module. In the case above, specify like the
2039following:
2040
2041options snd slots=snd-interwave,snd-ens1371
2042
2043Then, the first slot (#0) is reserved for snd-interwave driver, and
2044the second (#1) for snd-ens1371. You can omit index option in each
2045driver if slots option is used (although you can still have them at
2046the same time as long as they don't conflict).
2047
2048The slots option is especially useful for avoiding the possible
2049hot-plugging and the resultant slot conflict. For example, in the
2050case above again, the first two slots are already reserved. If any
2051other driver (e.g. snd-usb-audio) is loaded before snd-interwave or
2052snd-ens1371, it will be assigned to the third or later slot.
2053
Takashi Iwaia93bbaa2008-05-27 17:59:24 +02002054When a module name is given with '!', the slot will be given for any
2055modules but that name. For example, "slots=!snd-pcsp" will reserve
2056the first slot for any modules but snd-pcsp.
2057
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058
2059ALSA PCM devices to OSS devices mapping
2060=======================================
2061
2062/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
2063/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
2064/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
2065/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
2066/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
2067/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
2068/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
2069/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
2070/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
2071
2072The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
2073sound card number and second means device number. The ALSA devices
2074have either 'c' or 'p' suffix indicating the direction, capture and
2075playback, respectively.
2076
2077Please note that the device mapping above may be varied via the module
2078options of snd-pcm-oss module.
2079
2080
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081Proc interfaces (/proc/asound)
2082==============================
2083
2084/proc/asound/card#/pcm#[cp]/oss
2085-------------------------------
2086 String "erase" - erase all additional informations about OSS applications
2087 String "<app_name> <fragments> <fragment_size> [<options>]"
2088
2089 <app_name> - name of application with (higher priority) or without path
2090 <fragments> - number of fragments or zero if auto
2091 <fragment_size> - size of fragment in bytes or zero if auto
2092 <options> - optional parameters
2093 - disable the application tries to open a pcm device for
2094 this channel but does not want to use it.
2095 (Cause a bug or mmap needs)
2096 It's good for Quake etc...
2097 - direct don't use plugins
2098 - block force block mode (rvplayer)
2099 - non-block force non-block mode
2100 - whole-frag write only whole fragments (optimization affecting
2101 playback only)
2102 - no-silence do not fill silence ahead to avoid clicks
Takashi Iwai10f69f92005-09-08 13:48:34 +02002103 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
2104 instead of filled blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105
2106 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
2107 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
2108 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
2109
2110
Takashi Iwaib6a96912005-05-30 18:27:03 +02002111Early Buffer Allocation
2112=======================
2113
2114Some drivers (e.g. hdsp) require the large contiguous buffers, and
2115sometimes it's too late to find such spaces when the driver module is
2116actually loaded due to memory fragmentation. You can pre-allocate the
2117PCM buffers by loading snd-page-alloc module and write commands to its
2118proc file in prior, for example, in the early boot stage like
2119/etc/init.d/*.local scripts.
2120
2121Reading the proc file /proc/drivers/snd-page-alloc shows the current
2122usage of page allocation. In writing, you can send the following
2123commands to the snd-page-alloc driver:
2124
2125 - add VENDOR DEVICE MASK SIZE BUFFERS
2126
2127 VENDOR and DEVICE are PCI vendor and device IDs. They take
2128 integer numbers (0x prefix is needed for the hex).
2129 MASK is the PCI DMA mask. Pass 0 if not restricted.
2130 SIZE is the size of each buffer to allocate. You can pass
2131 k and m suffix for KB and MB. The max number is 16MB.
2132 BUFFERS is the number of buffers to allocate. It must be greater
2133 than 0. The max number is 4.
2134
2135 - erase
2136
2137 This will erase the all pre-allocated buffers which are not in
2138 use.
2139
2140
Takashi Iwai62430082005-09-05 17:12:29 +02002141Links and Addresses
2142===================
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143
2144 ALSA project homepage
2145 http://www.alsa-project.org
2146
Takashi Iwai30bc4482008-12-09 08:23:45 +01002147 Kernel Bugzilla
2148 http://bugzilla.kernel.org/
Takashi Iwai62430082005-09-05 17:12:29 +02002149
2150 ALSA Developers ML
Rene Herman45051792007-03-21 12:05:06 +01002151 mailto:alsa-devel@alsa-project.org
Takashi Iwai30bc4482008-12-09 08:23:45 +01002152
2153 alsa-info.sh script
2154 http://www.alsa-project.org/alsa-info.sh