blob: dc681badca67c6a7b6d0b4da22c3736cd378faa1 [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.
Takashi Iwai36ce99c2009-08-27 16:45:07 +020063 debug - Specifies the debug message level
64 (0 = disable debug prints, 1 = normal debug messages,
65 2 = verbose debug messages)
66 This option appears only when CONFIG_SND_DEBUG=y.
67 This option can be dynamically changed via sysfs
68 /sys/modules/snd/parameters/debug file.
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70 Module snd-pcm-oss
71 ------------------
72
73 The PCM OSS emulation module.
74 This module takes options which change the mapping of devices.
75
76 dsp_map - PCM device number maps assigned to the 1st OSS device.
77 - Default: 0
78 adsp_map - PCM device number maps assigned to the 2st OSS device.
79 - Default: 1
80 nonblock_open
Takashi Iwai62430082005-09-05 17:12:29 +020081 - Don't block opening busy PCM devices. Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83 For example, when dsp_map=2, /dev/dsp will be mapped to PCM #2 of
84 the card #0. Similarly, when adsp_map=0, /dev/adsp will be mapped
85 to PCM #0 of the card #0.
86 For changing the second or later card, specify the option with
87 commas, such like "dsp_map=0,1".
88
89 nonblock_open option is used to change the behavior of the PCM
90 regarding opening the device. When this option is non-zero,
91 opening a busy OSS PCM device won't be blocked but return
92 immediately with EAGAIN (just like O_NONBLOCK flag).
93
94 Module snd-rawmidi
95 ------------------
96
97 This module takes options which change the mapping of devices.
98 similar to those of the snd-pcm-oss module.
99
100 midi_map - MIDI device number maps assigned to the 1st OSS device.
101 - Default: 0
102 amidi_map - MIDI device number maps assigned to the 2st OSS device.
103 - Default: 1
104
105 Common parameters for top sound card modules
106 --------------------------------------------
107
108 Each of top level sound card module takes the following options.
109
110 index - index (slot #) of sound card
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100111 - Values: 0 through 31 or negative
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 - If nonnegative, assign that index number
113 - if negative, interpret as a bitmask of permissible
114 indices; the first free permitted index is assigned
115 - Default: -1
116 id - card ID (identifier or name)
117 - Can be up to 15 characters long
118 - Default: the card type
119 - A directory by this name is created under /proc/asound/
120 containing information about the card
121 - This ID can be used instead of the index number in
122 identifying the card
123 enable - enable card
124 - Default: enabled, for PCI and ISA PnP cards
125
Rene Hermancf40a312006-03-28 12:38:20 +0200126 Module snd-adlib
127 ----------------
128
129 Module for AdLib FM cards.
130
131 port - port # for OPL chip
132
133 This module supports multiple cards. It does not support autoprobe, so
134 the port must be specified. For actual AdLib FM cards it will be 0x388.
135 Note that this card does not have PCM support and no mixer; only FM
136 synthesis.
137
138 Make sure you have "sbiload" from the alsa-tools package available and,
139 after loading the module, find out the assigned ALSA sequencer port
140 number through "sbiload -l". Example output:
141
142 Port Client name Port name
143 64:0 OPL2 FM synth OPL2 FM Port
144
145 Load the std.sb and drums.sb patches also supplied by sbiload:
146
147 sbiload -p 64:0 std.sb drums.sb
148
149 If you use this driver to drive an OPL3, you can use std.o3 and drums.o3
150 instead. To have the card produce sound, use aplaymidi from alsa-utils:
151
152 aplaymidi -p 64:0 foo.mid
153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 Module snd-ad1816a
155 ------------------
156
157 Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips.
158
Takashi Iwai506d4c62005-08-03 14:02:47 +0200159 clockfreq - Clock frequency for AD1816A chip (default = 0, 33000Hz)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100161 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
163 Module snd-ad1848
164 -----------------
165
166 Module for sound cards based on AD1848/AD1847/CS4248 ISA chips.
167
168 port - port # for AD1848 chip
169 irq - IRQ # for AD1848 chip
170 dma1 - DMA # for AD1848 chip (0,1,3)
171
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100172 This module supports multiple cards. It does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 thus main port must be specified!!! Other ports are optional.
174
Takashi Iwaia4efc232005-11-17 17:24:26 +0100175 The power-management is supported.
176
Clemens Ladisch84010e62005-09-02 07:57:59 +0200177 Module snd-ad1889
178 -----------------
179
180 Module for Analog Devices AD1889 chips.
181
182 ac97_quirk - AC'97 workaround for strange hardware
183 See the description of intel8x0 module for details.
184
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100185 This module supports multiple cards.
Clemens Ladisch84010e62005-09-02 07:57:59 +0200186
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 Module snd-ali5451
188 ------------------
189
190 Module for ALi M5451 PCI chip.
191
192 pcm_channels - Number of hardware channels assigned for PCM
193 spdif - Support SPDIF I/O
194 - Default: disabled
195
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +0200196 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
198 The power-management is supported.
199
200 Module snd-als100
201 -----------------
202
203 Module for sound cards based on Avance Logic ALS100/ALS120 ISA chips.
204
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100205 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Takashi Iwaia4efc232005-11-17 17:24:26 +0100207 The power-management is supported.
208
Ash Willisb3a70d52006-03-27 13:20:40 +0200209 Module snd-als300
210 -----------------
211
212 Module for Avance Logic ALS300 and ALS300+
213
214 This module supports multiple cards.
215
216 The power-management is supported.
217
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 Module snd-als4000
219 ------------------
220
221 Module for sound cards based on Avance Logic ALS4000 PCI chip.
222
223 joystick_port - port # for legacy joystick support.
224 0 = disabled (default), 1 = auto-detect
225
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100226 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
Takashi Iwaia4efc232005-11-17 17:24:26 +0100228 The power-management is supported.
229
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200230 Module snd-asihpi
231 -----------------
232
233 Module for AudioScience ASI soundcards
234
235 enable_hpi_hwdep - enable HPI hwdep for AudioScience soundcard
236
237 This module supports multiple cards.
238 The driver requires the firmware loader support on kernel.
239
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 Module snd-atiixp
241 -----------------
242
Takashi Iwai62430082005-09-05 17:12:29 +0200243 Module for ATI IXP 150/200/250/400 AC97 controllers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
Takashi Iwai62430082005-09-05 17:12:29 +0200245 ac97_clock - AC'97 clock (default = 48000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200247 See "AC97 Quirk Option" section below.
Dan Carpenter14e1d352006-11-20 16:35:18 +0100248 ac97_codec - Workaround to specify which AC'97 codec
249 instead of probing. If this works for you
250 file a bug with your `lspci -vn` output.
251 -2 -- Force probing.
252 -1 -- Default behavior.
253 0-2 -- Use the specified codec.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 spdif_aclink - S/PDIF transfer over AC-link (default = 1)
255
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200256 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
Takashi Iwai62430082005-09-05 17:12:29 +0200258 ATI IXP has two different methods to control SPDIF output. One is
259 over AC-link and another is over the "direct" SPDIF output. The
260 implementation depends on the motherboard, and you'll need to
261 choose the correct one via spdif_aclink module option.
262
Takashi Iwaia4efc232005-11-17 17:24:26 +0100263 The power-management is supported.
264
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 Module snd-atiixp-modem
266 -----------------------
267
268 Module for ATI IXP 150/200/250 AC97 modem controllers.
269
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200270 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
272 Note: The default index value of this module is -2, i.e. the first
273 slot is excluded.
274
Takashi Iwaia4efc232005-11-17 17:24:26 +0100275 The power-management is supported.
276
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 Module snd-au8810, snd-au8820, snd-au8830
278 -----------------------------------------
279
280 Module for Aureal Vortex, Vortex2 and Advantage device.
281
282 pcifix - Control PCI workarounds
283 0 = Disable all workarounds
284 1 = Force the PCI latency of the Aureal card to 0xff
285 2 = Force the Extend PCI#2 Internal Master for Efficient
286 Handling of Dummy Requests on the VIA KT133 AGP Bridge
287 3 = Force both settings
288 255 = Autodetect what is required (default)
289
290 This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
291 EQ, mpu401, gameport. A3D and wavetable support are still in development.
292 Development and reverse engineering work is being coordinated at
293 http://savannah.nongnu.org/projects/openvortex/
294 SPDIF output has a copy of the AC97 codec output, unless you use the
295 "spdif" pcm device, which allows raw data passthru.
296 The hardware EQ hardware and SPDIF is only present in the Vortex2 and
297 Advantage.
298
Takashi Iwai62430082005-09-05 17:12:29 +0200299 Note: Some ALSA mixer applications don't handle the SPDIF sample rate
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 control correctly. If you have problems regarding this, try
301 another ALSA compliant mixer (alsamixer works).
302
Takashi Iwai9e235322008-02-20 12:13:29 +0100303 Module snd-aw2
304 --------------
305
306 Module for Audiowerk2 sound card
307
308 This module supports multiple cards.
309
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 Module snd-azt2320
311 ------------------
312
313 Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
314
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100315 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316
Takashi Iwaia4efc232005-11-17 17:24:26 +0100317 The power-management is supported.
318
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 Module snd-azt3328
320 ------------------
321
322 Module for sound cards based on Aztech AZF3328 PCI chip.
323
324 joystick - Enable joystick (default off)
325
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100326 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
328 Module snd-bt87x
329 ----------------
330
331 Module for video cards based on Bt87x chips.
332
333 digital_rate - Override the default digital rate (Hz)
334 load_all - Load the driver even if the card model isn't known
335
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100336 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
338 Note: The default index value of this module is -2, i.e. the first
339 slot is excluded.
340
341 Module snd-ca0106
342 -----------------
343
344 Module for Creative Audigy LS and SB Live 24bit
345
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100346 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
348
349 Module snd-cmi8330
350 ------------------
351
352 Module for sound cards based on C-Media CMI8330 ISA chips.
353
Rene Herman64e0e2d2007-12-13 16:29:33 +0100354 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
355
356 with isapnp=0, the following options are available:
357
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358 wssport - port # for CMI8330 chip (WSS)
359 wssirq - IRQ # for CMI8330 chip (WSS)
360 wssdma - first DMA # for CMI8330 chip (WSS)
361 sbport - port # for CMI8330 chip (SB16)
362 sbirq - IRQ # for CMI8330 chip (SB16)
363 sbdma8 - 8bit DMA # for CMI8330 chip (SB16)
364 sbdma16 - 16bit DMA # for CMI8330 chip (SB16)
Takashi Iwai9e128fd2009-01-29 11:49:10 +0100365 fmport - (optional) OPL3 I/O port
366 mpuport - (optional) MPU401 I/O port
367 mpuirq - (optional) MPU401 irq #
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100369 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370
Takashi Iwaia4efc232005-11-17 17:24:26 +0100371 The power-management is supported.
372
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 Module snd-cmipci
374 -----------------
375
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200376 Module for C-Media CMI8338/8738/8768/8770 PCI sound cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377
Clemens Ladischc78c9502007-09-03 09:55:49 +0200378 mpu_port - port address of MIDI interface (8338 only):
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200379 0x300,0x310,0x320,0x330 = legacy port,
Takashi Iwaicab5c4c2006-05-04 14:36:08 +0200380 0 = disable (default)
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200381 fm_port - port address of OPL-3 FM synthesizer (8x38 only):
382 0x388 = legacy port,
383 1 = integrated PCI port (default on 8738),
Takashi Iwai2f24d1592007-02-15 18:56:43 +0100384 0 = disable
Takashi Iwai62430082005-09-05 17:12:29 +0200385 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 (default = 1)
387 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
388
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100389 This module supports autoprobe and multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
Takashi Iwaia4efc232005-11-17 17:24:26 +0100391 The power-management is supported.
392
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 Module snd-cs4231
394 -----------------
395
396 Module for sound cards based on CS4231 ISA chips.
397
398 port - port # for CS4231 chip
399 mpu_port - port # for MPU-401 UART (optional), -1 = disable
400 irq - IRQ # for CS4231 chip
401 mpu_irq - IRQ # for MPU-401 UART
402 dma1 - first DMA # for CS4231 chip
403 dma2 - second DMA # for CS4231 chip
404
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100405 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 thus main port must be specified!!! Other ports are optional.
407
408 The power-management is supported.
409
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 Module snd-cs4236
411 -----------------
412
Takashi Iwaic844a5d2009-02-16 23:17:33 +0100413 Module for sound cards based on CS4232/CS4232A,
414 CS4235/CS4236/CS4236B/CS4237B/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 CS4238B/CS4239 ISA chips.
416
Rene Herman64e0e2d2007-12-13 16:29:33 +0100417 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
418
419 with isapnp=0, the following options are available:
420
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 port - port # for CS4236 chip (PnP setup - 0x534)
422 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
423 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
424 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
425 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
426 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
427 dma1 - first DMA # for CS4236 chip (0,1,3)
428 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100430 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 (if ISA PnP is not used) thus main port and control port must be
432 specified!!! Other ports are optional.
433
434 The power-management is supported.
435
Takashi Iwaic844a5d2009-02-16 23:17:33 +0100436 This module is aliased as snd-cs4232 since it provides the old
437 snd-cs4232 functionality, too.
438
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 Module snd-cs4281
440 -----------------
441
442 Module for Cirrus Logic CS4281 soundchip.
443
444 dual_codec - Secondary codec ID (0 = disable, default)
445
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100446 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
448 The power-management is supported.
449
450 Module snd-cs46xx
451 -----------------
452
453 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
454 CS4624/CS4630/CS4280 PCI chips.
455
Takashi Iwai62430082005-09-05 17:12:29 +0200456 external_amp - Force to enable external amplifier.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 thinkpad - Force to enable Thinkpad's CLKRUN control.
458 mmap_valid - Support OSS mmap mode (default = 0).
459
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100460 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 Usually external amp and CLKRUN controls are detected automatically
462 from PCI sub vendor/device ids. If they don't work, give the options
463 above explicitly.
464
465 The power-management is supported.
Takashi Iwai621887a2007-05-24 18:46:54 +0200466
467 Module snd-cs5530
468 _________________
469
470 Module for Cyrix/NatSemi Geode 5530 chip.
471
Takashi Iwai3e873172005-11-17 10:15:37 +0100472 Module snd-cs5535audio
473 ----------------------
474
475 Module for multifunction CS5535 companion PCI device
476
Takashi Iwaic00bd742006-05-19 19:22:34 +0200477 The power-management is supported.
Takashi Iwai3e873172005-11-17 10:15:37 +0100478
Wai Yew CHAY8cc72362009-05-14 08:05:58 +0200479 Module snd-ctxfi
480 ----------------
481
482 Module for Creative Sound Blaster X-Fi boards (20k1 / 20k2 chips)
483 * Creative Sound Blaster X-Fi Titanium Fatal1ty Champion Series
484 * Creative Sound Blaster X-Fi Titanium Fatal1ty Professional Series
485 * Creative Sound Blaster X-Fi Titanium Professional Audio
486 * Creative Sound Blaster X-Fi Titanium
487 * Creative Sound Blaster X-Fi Elite Pro
488 * Creative Sound Blaster X-Fi Platinum
489 * Creative Sound Blaster X-Fi Fatal1ty
490 * Creative Sound Blaster X-Fi XtremeGamer
491 * Creative Sound Blaster X-Fi XtremeMusic
492
493 reference_rate - reference sample rate, 44100 or 48000 (default)
494 multiple - multiple to ref. sample rate, 1 or 2 (default)
Takashi Iwai408bffd2010-01-14 09:19:46 +0100495 subsystem - override the PCI SSID for probing; the value
496 consists of SSVID << 16 | SSDID. The default is
497 zero, which means no override.
Wai Yew CHAY8cc72362009-05-14 08:05:58 +0200498
499 This module supports multiple cards.
500
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200501 Module snd-darla20
502 ------------------
503
504 Module for Echoaudio Darla20
505
506 This module supports multiple cards.
507 The driver requires the firmware loader support on kernel.
508
509 Module snd-darla24
510 ------------------
511
512 Module for Echoaudio Darla24
513
514 This module supports multiple cards.
515 The driver requires the firmware loader support on kernel.
516
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 Module snd-dt019x
518 -----------------
519
520 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
521 only)
522
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100523 This module supports multiple cards. This module is enabled only with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 ISA PnP support.
525
Takashi Iwaia4efc232005-11-17 17:24:26 +0100526 The power-management is supported.
527
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 Module snd-dummy
529 ----------------
530
531 Module for the dummy sound card. This "card" doesn't do any output
532 or input, but you may use this module for any application which
533 requires a sound card (like RealPlayer).
534
Takashi Iwai30681bcf2009-09-03 16:08:08 +0200535 pcm_devs - Number of PCM devices assigned to each card
536 (default = 1, up to 4)
537 pcm_substreams - Number of PCM substreams assigned to each PCM
Takashi Iwai23aebca2009-11-02 14:10:59 +0100538 (default = 8, up to 128)
Takashi Iwai30681bcf2009-09-03 16:08:08 +0200539 hrtimer - Use hrtimer (=1, default) or system timer (=0)
Takashi Iwaia68c4d12009-09-04 12:19:36 +0200540 fake_buffer - Fake buffer allocations (default = 1)
Takashi Iwai30681bcf2009-09-03 16:08:08 +0200541
542 When multiple PCM devices are created, snd-dummy gives different
543 behavior to each PCM device:
544 0 = interleaved with mmap support
545 1 = non-interleaved with mmap support
546 2 = interleaved without mmap
547 3 = non-interleaved without mmap
548
Takashi Iwaia68c4d12009-09-04 12:19:36 +0200549 As default, snd-dummy drivers doesn't allocate the real buffers
550 but either ignores read/write or mmap a single dummy page to all
551 buffer pages, in order to save the resouces. If your apps need
552 the read/ written buffer data to be consistent, pass fake_buffer=0
553 option.
554
Takashi Iwaia4efc232005-11-17 17:24:26 +0100555 The power-management is supported.
556
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200557 Module snd-echo3g
558 -----------------
559
560 Module for Echoaudio 3G cards (Gina3G/Layla3G)
561
562 This module supports multiple cards.
563 The driver requires the firmware loader support on kernel.
564
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 Module snd-emu10k1
566 ------------------
567
568 Module for EMU10K1/EMU10k2 based PCI sound cards.
569 * Sound Blaster Live!
570 * Sound Blaster PCI 512
571 * Emu APS (partially supported)
572 * Sound Blaster Audigy
573
574 extin - bitmap of available external inputs for FX8010 (see bellow)
575 extout - bitmap of available external outputs for FX8010 (see bellow)
576 seq_ports - allocated sequencer ports (4 by default)
577 max_synth_voices - limit of voices used for wavetable (64 by default)
578 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
579 given in MB unit. Default value is 128.
580 enable_ir - enable IR
581
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100582 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583
584 Input & Output configurations [extin/extout]
585 * Creative Card wo/Digital out [0x0003/0x1f03]
586 * Creative Card w/Digital out [0x0003/0x1f0f]
587 * Creative Card w/Digital CD in [0x000f/0x1f0f]
588 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
589 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
590 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
591 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
592 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
593 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
594 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
595 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
596 * Creative Card all ins and outs [0x3fff/0x7fff]
597
Takashi Iwaia4efc232005-11-17 17:24:26 +0100598 The power-management is supported.
599
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 Module snd-emu10k1x
601 -------------------
602
603 Module for Creative Emu10k1X (SB Live Dell OEM version)
604
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100605 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606
607 Module snd-ens1370
608 ------------------
609
610 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
611 * SoundBlaster PCI 64
612 * SoundBlaster PCI 128
613
614 joystick - Enable joystick (default off)
615
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100616 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100618 The power-management is supported.
619
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 Module snd-ens1371
621 ------------------
622
623 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
624 * SoundBlaster PCI 64
625 * SoundBlaster PCI 128
626 * SoundBlaster Vibra PCI
627
628 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
629 0 = disable (default), 1 = auto-detect
630
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100631 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100633 The power-management is supported.
634
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 Module snd-es968
636 ----------------
637
638 Module for sound cards based on ESS ES968 chip (PnP only).
639
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100640 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
Takashi Iwaia4efc232005-11-17 17:24:26 +0100642 The power-management is supported.
643
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 Module snd-es1688
645 -----------------
646
647 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
648
649 port - port # for ES-1688 chip (0x220,0x240,0x260)
Takashi Iwai504a06d2009-01-30 19:59:10 +0100650 fm_port - port # for OPL3 (option; share the same port as default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
652 irq - IRQ # for ES-1688 chip (5,7,9,10)
653 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
654 dma8 - DMA # for ES-1688 chip (0,1,3)
655
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100656 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
658 Module snd-es18xx
659 -----------------
660
661 Module for ESS AudioDrive ES-18xx sound cards.
662
Rene Herman64e0e2d2007-12-13 16:29:33 +0100663 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
664
665 with isapnp=0, the following options are available:
666
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 port - port # for ES-18xx chip (0x220,0x240,0x260)
668 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
669 fm_port - port # for FM (optional, not used)
670 irq - IRQ # for ES-18xx chip (5,7,9,10)
671 dma1 - first DMA # for ES-18xx chip (0,1,3)
672 dma2 - first DMA # for ES-18xx chip (0,1,3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100674 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
675 port if native ISA PnP routines are not used).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 When dma2 is equal with dma1, the driver works as half-duplex.
677
678 The power-management is supported.
679
680 Module snd-es1938
681 -----------------
682
683 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
684
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100685 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686
Takashi Iwaia4efc232005-11-17 17:24:26 +0100687 The power-management is supported.
688
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 Module snd-es1968
690 -----------------
691
692 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
693
694 total_bufsize - total buffer size in kB (1-4096kB)
695 pcm_substreams_p - playback channels (1-8, default=2)
696 pcm_substreams_c - capture channels (1-8, default=0)
697 clock - clock (0 = auto-detection)
698 use_pm - support the power-management (0 = off, 1 = on,
699 2 = auto (default))
700 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
701 joystick - enable joystick (default off)
702
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100703 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704
705 The power-management is supported.
706
707 Module snd-fm801
708 ----------------
709
710 Module for ForteMedia FM801 based PCI sound cards.
711
712 tea575x_tuner - Enable TEA575x tuner
713 - 1 = MediaForte 256-PCS
714 - 2 = MediaForte 256-PCPR
715 - 3 = MediaForte 64-PCR
716 - High 16-bits are video (radio) device number + 1
717 - example: 0x10002 (MediaForte 256-PCPR, device 1)
718
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100719 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720
Takashi Iwaia4efc232005-11-17 17:24:26 +0100721 The power-management is supported.
722
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200723 Module snd-gina20
724 -----------------
725
726 Module for Echoaudio Gina20
727
728 This module supports multiple cards.
729 The driver requires the firmware loader support on kernel.
730
731 Module snd-gina24
732 -----------------
733
734 Module for Echoaudio Gina24
735
736 This module supports multiple cards.
737 The driver requires the firmware loader support on kernel.
738
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 Module snd-gusclassic
740 ---------------------
741
742 Module for Gravis UltraSound Classic sound card.
743
744 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
745 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
746 dma1 - DMA # for GF1 chip (1,3,5,6,7)
747 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
748 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
749 voices - GF1 voices limit (14-32)
750 pcm_voices - reserved PCM voices
751
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100752 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753
754 Module snd-gusextreme
755 ---------------------
756
757 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
758
759 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
760 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
761 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
762 irq - IRQ # for ES-1688 chip (5,7,9,10)
763 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
764 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
765 dma8 - DMA # for ES-1688 chip (0,1,3)
766 dma1 - DMA # for GF1 chip (1,3,5,6,7)
767 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
768 voices - GF1 voices limit (14-32)
769 pcm_voices - reserved PCM voices
770
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100771 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
773 Module snd-gusmax
774 -----------------
775
776 Module for Gravis UltraSound MAX sound card.
777
778 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
779 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
780 dma1 - DMA # for GF1 chip (1,3,5,6,7)
781 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
782 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
783 voices - GF1 voices limit (14-32)
784 pcm_voices - reserved PCM voices
785
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100786 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787
788 Module snd-hda-intel
789 --------------------
790
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400791 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8, ICH9, ICH10,
792 PCH, SCH),
793 ATI SB450, SB600, R600, RS600, RS690, RS780, RV610, RV620,
794 RV630, RV635, RV670, RV770,
Takashi Iwai9b878192006-05-17 11:26:39 +0200795 VIA VT8251/VT8237A,
796 SIS966, ULI M5461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100798 [Multiple options for each card instance]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 model - force the model name
Takashi Iwaid2e1c972008-06-10 17:53:34 +0200800 position_fix - Fix DMA pointer (0 = auto, 1 = use LPIB, 2 = POSBUF)
Takashi Iwai95904742007-05-19 17:06:42 +0200801 probe_mask - Bitmask to probe codecs (default = -1, meaning all slots)
Takashi Iwaiae374d62009-02-13 08:33:55 +0100802 When the bit 8 (0x100) is set, the lower 8 bits are used
803 as the "fixed" codec slots; i.e. the driver probes the
804 slots regardless what hardware reports back
Takashi Iwaid4d9cd032008-12-19 15:19:11 +0100805 probe_only - Only probing and no codec initialization (default=off);
806 Useful to check the initial codec status for debugging
Takashi Iwai8c53b962008-06-10 17:53:35 +0200807 bdl_pos_adj - Specifies the DMA IRQ timing delay in samples.
808 Passing -1 will make the driver to choose the appropriate
809 value based on the controller chip.
Takashi Iwai1e7b8c82009-06-17 17:30:54 +0200810 patch - Specifies the early "patch" files to modify the HD-audio
811 setup before initializing the codecs. This option is
812 available only when CONFIG_SND_HDA_PATCH_LOADER=y is set.
813 See HD-Audio.txt for details.
Takashi Iwaid0193612009-11-16 12:03:49 +0100814 beep_mode - Selects the beep registration mode (0=off, 1=on, 2=
815 dynamic registration via mute switch on/off); the default
816 value is set via CONFIG_SND_HDA_INPUT_BEEP_MODE kconfig.
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100817
818 [Single (global) options]
Takashi Iwai27346162006-01-12 18:28:44 +0100819 single_cmd - Use single immediate commands to communicate with
820 codecs (for debugging only)
Takashi Iwai134a11f2006-11-10 12:08:37 +0100821 enable_msi - Enable Message Signaled Interrupt (MSI) (default = off)
Matt LaPlante19f59462009-04-27 15:06:31 +0200822 power_save - Automatic power-saving timeout (in second, 0 =
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200823 disable)
Takashi Iwaidee1b662007-08-13 16:10:30 +0200824 power_save_controller - Reset HD-audio controller in power-saving mode
825 (default = on)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100827 This module supports multiple cards and autoprobe.
828
Takashi Iwaicae51172008-12-19 08:36:53 +0100829 See Documentation/sound/alsa/HD-Audio.txt for more details about
830 HD-audio driver.
831
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 Each codec may have a model table for different configurations.
833 If your machine isn't listed there, the default (usually minimal)
834 configuration is set up. You can pass "model=<name>" option to
835 specify a certain model in such a case. There are different
Takashi Iwaicae51172008-12-19 08:36:53 +0100836 models depending on the codec chip. The list of available models
837 is found in HD-Audio-Models.txt
Takashi Iwaidb064e52006-03-16 16:04:58 +0100838
Takashi Iwai6d7b1d72007-02-26 15:56:46 +0100839 The model name "genric" is treated as a special case. When this
840 model is given, the driver uses the generic codec parser without
841 "codec-patch". It's sometimes good for testing and debugging.
842
Takashi Iwai62430082005-09-05 17:12:29 +0200843 If the default configuration doesn't work and one of the above
Takashi Iwai30bc4482008-12-09 08:23:45 +0100844 matches with your device, report it together with alsa-info.sh
845 output (with --no-upload option) to kernel bugzilla or alsa-devel
Takashi Iwai62430082005-09-05 17:12:29 +0200846 ML (see the section "Links and Addresses").
847
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200848 power_save and power_save_controller options are for power-saving
849 mode. See powersave.txt for details.
Takashi Iwaidee1b662007-08-13 16:10:30 +0200850
Takashi Iwaic74db862005-05-12 14:26:27 +0200851 Note 2: If you get click noises on output, try the module option
852 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
853 register value without FIFO size correction as the current
854 DMA pointer. position_fix=2 will make the driver to use
855 the position buffer instead of reading SD_LPIB register.
Michael Kerrisk90f31e32008-09-01 14:03:50 +0200856 (Usually SD_LPIB register is more accurate than the
Takashi Iwaic74db862005-05-12 14:26:27 +0200857 position buffer.)
858
Takashi Iwai27346162006-01-12 18:28:44 +0100859 NB: If you get many "azx_get_response timeout" messages at
860 loading, it's likely a problem of interrupts (e.g. ACPI irq
861 routing). Try to boot with options like "pci=noacpi". Also, you
862 can try "single_cmd=1" module option. This will switch the
863 communication method between HDA controller and codecs to the
864 single immediate commands instead of CORB/RIRB. Basically, the
865 single command mode is provided only for BIOS, and you won't get
866 unsolicited events, too. But, at least, this works independently
867 from the irq. Remember this is a last resort, and should be
868 avoided as much as possible...
869
Takashi Iwai95904742007-05-19 17:06:42 +0200870 MORE NOTES ON "azx_get_response timeout" PROBLEMS:
871 On some hardwares, you may need to add a proper probe_mask option
872 to avoid the "azx_get_response timeout" problem above, instead.
873 This occurs when the access to non-existing or non-working codec slot
874 (likely a modem one) causes a stall of the communication via HD-audio
875 bus. You can see which codec slots are probed by enabling
Takashi Iwai62cf8722008-05-20 12:15:15 +0200876 CONFIG_SND_DEBUG_VERBOSE, or simply from the file name of the codec
Takashi Iwai95904742007-05-19 17:06:42 +0200877 proc files. Then limit the slots to probe by probe_mask option.
878 For example, probe_mask=1 means to probe only the first slot, and
879 probe_mask=4 means only the third slot.
880
Takashi Iwaia4efc232005-11-17 17:24:26 +0100881 The power-management is supported.
882
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 Module snd-hdsp
884 ---------------
885
886 Module for RME Hammerfall DSP audio interface(s)
887
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100888 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889
890 Note: The firmware data can be automatically loaded via hotplug
891 when CONFIG_FW_LOADER is set. Otherwise, you need to load
892 the firmware via hdsploader utility included in alsa-tools
893 package.
894 The firmware data is found in alsa-firmware package.
895
896 Note: snd-page-alloc module does the job which snd-hammerfall-mem
897 module did formerly. It will allocate the buffers in advance
898 when any HDSP cards are found. To make the buffer
899 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +0200900 stage of boot sequence. See "Early Buffer Allocation"
901 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
Takashi Iwai54704402005-06-03 11:27:00 +0200903 Module snd-hdspm
904 ----------------
905
906 Module for RME HDSP MADI board.
907
908 precise_ptr - Enable precise pointer, or disable.
909 line_outs_monitor - Send playback streams to analog outs by default.
910 enable_monitor - Enable Analog Out on Channel 63/64 by default.
911
912 See hdspm.txt for details.
913
Clemens Ladischc6260262008-01-25 08:41:52 +0100914 Module snd-hifier
915 -----------------
916
917 Module for the MediaTek/TempoTec HiFier Fantasia sound card.
918
919 This module supports autoprobe and multiple cards.
920
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 Module snd-ice1712
922 ------------------
923
924 Module for Envy24 (ICE1712) based PCI sound cards.
925 * MidiMan M Audio Delta 1010
926 * MidiMan M Audio Delta 1010LT
927 * MidiMan M Audio Delta DiO 2496
928 * MidiMan M Audio Delta 66
929 * MidiMan M Audio Delta 44
930 * MidiMan M Audio Delta 410
931 * MidiMan M Audio Audiophile 2496
932 * TerraTec EWS 88MT
933 * TerraTec EWS 88D
934 * TerraTec EWX 24/96
935 * TerraTec DMX 6Fire
Takashi Iwaic9bce912005-05-24 13:41:03 +0200936 * TerraTec Phase 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 * Hoontech SoundTrack DSP 24
938 * Hoontech SoundTrack DSP 24 Value
939 * Hoontech SoundTrack DSP 24 Media 7.1
Takashi Iwaic9bce912005-05-24 13:41:03 +0200940 * Event Electronics, EZ8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 * Digigram VX442
Takashi Iwaic9bce912005-05-24 13:41:03 +0200942 * Lionstracs, Mediastaton
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400943 * Terrasoniq TS 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944
945 model - Use the given board model, one of the following:
946 delta1010, dio2496, delta66, delta44, audiophile, delta410,
947 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
Takashi Iwaic9bce912005-05-24 13:41:03 +0200948 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
949 phase88, mediastation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 omni - Omni I/O support for MidiMan M-Audio Delta44/66
Matt LaPlantefa00e7e2006-11-30 04:55:36 +0100951 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transceiver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 in msec resolution, default value is 500 (0.5 sec)
953
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100954 This module supports multiple cards and autoprobe. Note: The consumer part
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 is not used with all Envy24 based cards (for example in the MidiMan Delta
956 serie).
957
Takashi Iwaic9bce912005-05-24 13:41:03 +0200958 Note: The supported board is detected by reading EEPROM or PCI
959 SSID (if EEPROM isn't available). You can override the
960 model by passing "model" module option in case that the
961 driver isn't configured properly or you want to try another
962 type for testing.
963
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 Module snd-ice1724
965 ------------------
966
Takashi Iwaic9bce912005-05-24 13:41:03 +0200967 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100968 * MidiMan M Audio Revolution 5.1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 * MidiMan M Audio Revolution 7.1
Takashi Iwai56255062006-11-09 16:47:26 +0100970 * MidiMan M Audio Audiophile 192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 * AMP Ltd AUDIO2000
Takashi Iwaic9bce912005-05-24 13:41:03 +0200972 * TerraTec Aureon 5.1 Sky
973 * TerraTec Aureon 7.1 Space
974 * TerraTec Aureon 7.1 Universe
975 * TerraTec Phase 22
976 * TerraTec Phase 28
977 * AudioTrak Prodigy 7.1
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400978 * AudioTrak Prodigy 7.1 LT
979 * AudioTrak Prodigy 7.1 XT
980 * AudioTrak Prodigy 7.1 HIFI
981 * AudioTrak Prodigy 7.1 HD2
Takashi Iwaic9bce912005-05-24 13:41:03 +0200982 * AudioTrak Prodigy 192
983 * Pontis MS300
984 * Albatron K8X800 Pro II
985 * Chaintech ZNF3-150
986 * Chaintech ZNF3-250
987 * Chaintech 9CJS
Takashi Iwai8cfbbac2005-05-27 12:10:40 +0200988 * Chaintech AV-710
Takashi Iwaic9bce912005-05-24 13:41:03 +0200989 * Shuttle SN25P
Shin-ya Okadaf31639b2007-10-23 15:08:18 +0200990 * Onkyo SE-90PCI
991 * Onkyo SE-200PCI
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400992 * ESI Juli@
Takashi Iwai72cbfd42009-05-06 17:33:19 +0200993 * ESI Maya44
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400994 * Hercules Fortissimo IV
995 * EGO-SYS WaveTerminal 192M
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996
997 model - Use the given board model, one of the following:
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100998 revo51, revo71, amp2000, prodigy71, prodigy71lt,
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400999 prodigy71xt, prodigy71hifi, prodigyhd2, prodigy192,
1000 juli, aureon51, aureon71, universe, ap192, k8x800,
1001 phase22, phase28, ms300, av710, se200pci, se90pci,
Takashi Iwai72cbfd42009-05-06 17:33:19 +02001002 fortissimo4, sn25p, WT192M, maya44
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001004 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005
Takashi Iwaic9bce912005-05-24 13:41:03 +02001006 Note: The supported board is detected by reading EEPROM or PCI
1007 SSID (if EEPROM isn't available). You can override the
1008 model by passing "model" module option in case that the
1009 driver isn't configured properly or you want to try another
1010 type for testing.
1011
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001012 Module snd-indigo
1013 -----------------
1014
1015 Module for Echoaudio Indigo
1016
1017 This module supports multiple cards.
1018 The driver requires the firmware loader support on kernel.
1019
1020 Module snd-indigodj
1021 -------------------
1022
1023 Module for Echoaudio Indigo DJ
1024
1025 This module supports multiple cards.
1026 The driver requires the firmware loader support on kernel.
1027
1028 Module snd-indigoio
1029 -------------------
1030
1031 Module for Echoaudio Indigo IO
1032
1033 This module supports multiple cards.
1034 The driver requires the firmware loader support on kernel.
1035
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 Module snd-intel8x0
1037 -------------------
1038
1039 Module for AC'97 motherboards from Intel and compatibles.
1040 * Intel i810/810E, i815, i820, i830, i84x, MX440
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001041 ICH5, ICH6, ICH7, 6300ESB, ESB2
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 * SiS 7012 (SiS 735)
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001043 * NVidia NForce, NForce2, NForce3, MCP04, CK804
1044 CK8, CK8S, MCP501
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 * AMD AMD768, AMD8111
1046 * ALi m5455
1047
1048 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1049 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001050 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 buggy_irq - Enable workaround for buggy interrupts on some
Takashi Iwaia06147d2005-09-08 19:54:17 +02001052 motherboards (default yes on nForce chips,
1053 otherwise off)
1054 buggy_semaphore - Enable workaround for hardwares with buggy
1055 semaphores (e.g. on some ASUS laptops)
1056 (default off)
Takashi Iwai6c5cfd92006-11-28 17:18:25 +01001057 spdif_aclink - Use S/PDIF over AC-link instead of direct connection
1058 from the controller chip
1059 (0 = off, 1 = on, -1 = default)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001061 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062
1063 Note: the latest driver supports auto-detection of chip clock.
1064 if you still encounter too fast playback, specify the clock
1065 explicitly via the module option "ac97_clock=41194".
1066
1067 Joystick/MIDI ports are not supported by this driver. If your
1068 motherboard has these devices, use the ns558 or snd-mpu401
1069 modules, respectively.
1070
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 The power-management is supported.
1072
1073 Module snd-intel8x0m
1074 --------------------
1075
1076 Module for Intel ICH (i8x0) chipset MC97 modems.
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001077 * Intel i810/810E, i815, i820, i830, i84x, MX440
1078 ICH5, ICH6, ICH7
1079 * SiS 7013 (SiS 735)
1080 * NVidia NForce, NForce2, NForce2s, NForce3
1081 * AMD AMD8111
1082 * ALi m5455
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083
1084 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1085
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001086 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087
1088 Note: The default index value of this module is -2, i.e. the first
1089 slot is excluded.
1090
Takashi Iwaia4efc232005-11-17 17:24:26 +01001091 The power-management is supported.
1092
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093 Module snd-interwave
1094 --------------------
1095
1096 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1097 and other sound cards based on AMD InterWave (tm) chip.
1098
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1100 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1101 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1102 effect - 1 = InterWave effects enable (default 0);
1103 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001104 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1105
1106 with isapnp=0, the following options are available:
1107
1108 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1109 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1110 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1111 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001113 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114
1115 Module snd-interwave-stb
1116 ------------------------
1117
1118 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1119 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1120 circuit for extended control of bass, treble and master volume.
1121
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1123 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1124 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1125 effect - 1 = InterWave effects enable (default 0);
1126 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001127 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1128
1129 with isapnp=0, the following options are available:
1130
1131 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1132 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1133 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1134 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1135 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001137 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138
Krzysztof Helt44eba3e2009-12-23 18:02:41 +01001139 Module snd-jazz16
1140 -------------------
1141
1142 Module for Media Vision Jazz16 chipset. The chipset consists of 3 chips:
1143 MVD1216 + MVA416 + MVA514.
1144
1145 port - port # for SB DSP chip (0x210,0x220,0x230,0x240,0x250,0x260)
1146 irq - IRQ # for SB DSP chip (3,5,7,9,10,15)
1147 dma8 - DMA # for SB DSP chip (1,3)
1148 dma16 - DMA # for SB DSP chip (5,7)
1149 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1150 mpu_irq - MPU-401 irq # (2,3,5,7)
1151
1152 This module supports multiple cards.
1153
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 Module snd-korg1212
1155 -------------------
1156
1157 Module for Korg 1212 IO PCI card
1158
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001159 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001161 Module snd-layla20
1162 ------------------
1163
1164 Module for Echoaudio Layla20
1165
1166 This module supports multiple cards.
1167 The driver requires the firmware loader support on kernel.
1168
1169 Module snd-layla24
1170 ------------------
1171
1172 Module for Echoaudio Layla24
1173
1174 This module supports multiple cards.
1175 The driver requires the firmware loader support on kernel.
1176
Takashi Iwai8338c302009-04-14 12:30:36 +02001177 Module snd-lx6464es
1178 -------------------
1179
1180 Module for Digigram LX6464ES boards
1181
1182 This module supports multiple cards.
1183
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184 Module snd-maestro3
1185 -------------------
1186
1187 Module for Allegro/Maestro3 chips
1188
1189 external_amp - enable external amp (enabled by default)
1190 amp_gpio - GPIO pin number for external amp (0-15) or
1191 -1 for default pin (8 for allegro, 1 for
1192 others)
1193
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001194 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195
1196 Note: the binding of amplifier is dependent on hardware.
1197 If there is no sound even though all channels are unmuted, try to
1198 specify other gpio connection via amp_gpio option.
1199 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1200 option.
1201
1202 The power-management is supported.
1203
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001204 Module snd-mia
1205 ---------------
1206
1207 Module for Echoaudio Mia
1208
1209 This module supports multiple cards.
1210 The driver requires the firmware loader support on kernel.
1211
Martin Langer1841f6132006-03-27 12:41:01 +02001212 Module snd-miro
1213 ---------------
1214
1215 Module for Miro soundcards: miroSOUND PCM 1 pro,
1216 miroSOUND PCM 12,
1217 miroSOUND PCM 20 Radio.
1218
1219 port - Port # (0x530,0x604,0xe80,0xf40)
1220 irq - IRQ # (5,7,9,10,11)
1221 dma1 - 1st dma # (0,1,3)
1222 dma2 - 2nd dma # (0,1)
1223 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1224 mpu_irq - MPU-401 irq # (5,7,9,10)
1225 fm_port - FM Port # (0x388)
1226 wss - enable WSS mode
1227 ide - enable onboard ide support
1228
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 Module snd-mixart
1230 -----------------
1231
1232 Module for Digigram miXart8 sound cards.
1233
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001234 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235 Note: One miXart8 board will be represented as 4 alsa cards.
1236 See MIXART.txt for details.
1237
1238 When the driver is compiled as a module and the hotplug firmware
1239 is supported, the firmware data is loaded via hotplug automatically.
1240 Install the necessary firmware files in alsa-firmware package.
1241 When no hotplug fw loader is available, you need to load the
1242 firmware via mixartloader utility in alsa-tools package.
1243
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001244 Module snd-mona
1245 ---------------
1246
1247 Module for Echoaudio Mona
1248
1249 This module supports multiple cards.
1250 The driver requires the firmware loader support on kernel.
1251
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 Module snd-mpu401
1253 -----------------
1254
1255 Module for MPU-401 UART devices.
1256
1257 port - port number or -1 (disable)
1258 irq - IRQ number or -1 (disable)
1259 pnp - PnP detection - 0 = disable, 1 = enable (default)
1260
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001261 This module supports multiple devices and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262
Takashi Iwaic96330b2009-01-28 08:23:03 +01001263 Module snd-msnd-classic
1264 -----------------------
1265
1266 Module for Turtle Beach MultiSound Classic, Tahiti or Monterey
1267 soundcards.
1268
1269 io - Port # for msnd-classic card
1270 irq - IRQ # for msnd-classic card
1271 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1272 0xe0000 or 0xe8000)
1273 write_ndelay - enable write ndelay (default = 1)
1274 calibrate_signal - calibrate signal (default = 0)
1275 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1276 digital - Digital daughterboard present (default = 0)
1277 cfg - Config port (0x250, 0x260 or 0x270) default = PnP
1278 reset - Reset all devices
1279 mpu_io - MPU401 I/O port
1280 mpu_irq - MPU401 irq#
1281 ide_io0 - IDE port #0
1282 ide_io1 - IDE port #1
1283 ide_irq - IDE irq#
1284 joystick_io - Joystick I/O port
1285
1286 The driver requires firmware files "turtlebeach/msndinit.bin" and
1287 "turtlebeach/msndperm.bin" in the proper firmware directory.
1288
1289 See Documentation/sound/oss/MultiSound for important information
1290 about this driver. Note that it has been discontinued, but the
1291 Voyetra Turtle Beach knowledge base entry for it is still available
1292 at
1293 http://www.turtlebeach.com/site/kb_ftp/790.asp
1294
1295 Module snd-msnd-pinnacle
1296 ------------------------
1297
1298 Module for Turtle Beach MultiSound Pinnacle/Fiji soundcards.
1299
1300 io - Port # for pinnacle/fiji card
1301 irq - IRQ # for pinnalce/fiji card
1302 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1303 0xe0000 or 0xe8000)
1304 write_ndelay - enable write ndelay (default = 1)
1305 calibrate_signal - calibrate signal (default = 0)
1306 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1307
1308 The driver requires firmware files "turtlebeach/pndspini.bin" and
1309 "turtlebeach/pndsperm.bin" in the proper firmware directory.
1310
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 Module snd-mtpav
1312 ----------------
1313
1314 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1315 port).
1316
1317 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1318 irq - IRQ # for MTPAV (7,5, default=7)
1319 hwports - number of supported hardware ports, default=8.
1320
1321 Module supports only 1 card. This module has no enable option.
1322
Matthias Koenig68ab8012006-07-27 16:59:23 +02001323 Module snd-mts64
1324 ----------------
1325
1326 Module for Ego Systems (ESI) Miditerminal 4140
1327
1328 This module supports multiple devices.
1329 Requires parport (CONFIG_PARPORT).
1330
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 Module snd-nm256
1332 ----------------
1333
1334 Module for NeoMagic NM256AV/ZX chips
1335
1336 playback_bufsize - max playback frame size in kB (4-128kB)
1337 capture_bufsize - max capture frame size in kB (4-128kB)
1338 force_ac97 - 0 or 1 (disabled by default)
1339 buffer_top - specify buffer top address
1340 use_cache - 0 or 1 (disabled by default)
1341 vaio_hack - alias buffer_top=0x25a800
1342 reset_workaround - enable AC97 RESET workaround for some laptops
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001343 reset_workaround2 - enable extended AC97 RESET workaround for some
1344 other laptops
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +02001346 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347
1348 The power-management is supported.
1349
1350 Note: on some notebooks the buffer address cannot be detected
1351 automatically, or causes hang-up during initialization.
Matt LaPlantefff92892006-10-03 22:47:42 +02001352 In such a case, specify the buffer top address explicitly via
1353 the buffer_top option.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 For example,
1355 Sony F250: buffer_top=0x25a800
1356 Sony F270: buffer_top=0x272800
1357 The driver supports only ac97 codec. It's possible to force
1358 to initialize/use ac97 although it's not detected. In such a
1359 case, use force_ac97=1 option - but *NO* guarantee whether it
1360 works!
1361
1362 Note: The NM256 chip can be linked internally with non-AC97
1363 codecs. This driver supports only the AC97 codec, and won't work
1364 with machines with other (most likely CS423x or OPL3SAx) chips,
1365 even though the device is detected in lspci. In such a case, try
1366 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
Takashi Iwai62430082005-09-05 17:12:29 +02001367 but some doesn't have ISA PnP. You'll need to specify isapnp=0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 and proper hardware parameters in the case without ISA PnP.
1369
1370 Note: some laptops need a workaround for AC97 RESET. For the
1371 known hardware like Dell Latitude LS and Sony PCG-F305, this
1372 workaround is enabled automatically. For other laptops with a
1373 hard freeze, you can try reset_workaround=1 option.
1374
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001375 Note: Dell Latitude CSx laptops have another problem regarding
1376 AC97 RESET. On these laptops, reset_workaround2 option is
1377 turned on as default. This option is worth to try if the
1378 previous reset_workaround option doesn't help.
1379
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 Note: This driver is really crappy. It's a porting from the
1381 OSS driver, which is a result of black-magic reverse engineering.
1382 The detection of codec will fail if the driver is loaded *after*
1383 X-server as described above. You might be able to force to load
1384 the module, but it may result in hang-up. Hence, make sure that
1385 you load this module *before* X if you encounter this kind of
1386 problem.
1387
1388 Module snd-opl3sa2
1389 ------------------
1390
1391 Module for Yamaha OPL3-SA2/SA3 sound cards.
1392
Rene Herman64e0e2d2007-12-13 16:29:33 +01001393 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1394
1395 with isapnp=0, the following options are available:
1396
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 port - control port # for OPL3-SA chip (0x370)
1398 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1399 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1400 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1401 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1402 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1403 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1404 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001406 This module supports multiple cards and ISA PnP. It does not support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1408
1409 The power-management is supported.
1410
1411 Module snd-opti92x-ad1848
1412 -------------------------
1413
1414 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1415 Module works with OAK Mozart cards as well.
1416
Rene Herman64e0e2d2007-12-13 16:29:33 +01001417 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1418
1419 with isapnp=0, the following options are available:
1420
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1422 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1423 fm_port - port # for OPL3 device (0x388)
1424 irq - IRQ # for WSS chip (5,7,9,10,11)
1425 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1426 dma1 - first DMA # for WSS chip (0,1,3)
1427
1428 This module supports only one card, autoprobe and PnP.
1429
1430 Module snd-opti92x-cs4231
1431 -------------------------
1432
1433 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1434
Rene Herman64e0e2d2007-12-13 16:29:33 +01001435 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1436
1437 with isapnp=0, the following options are available:
1438
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1440 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1441 fm_port - port # for OPL3 device (0x388)
1442 irq - IRQ # for WSS chip (5,7,9,10,11)
1443 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1444 dma1 - first DMA # for WSS chip (0,1,3)
1445 dma2 - second DMA # for WSS chip (0,1,3)
1446
1447 This module supports only one card, autoprobe and PnP.
1448
1449 Module snd-opti93x
1450 ------------------
1451
1452 Module for sound cards based on OPTi 82c93x chips.
1453
Rene Herman64e0e2d2007-12-13 16:29:33 +01001454 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1455
1456 with isapnp=0, the following options are available:
1457
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1459 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1460 fm_port - port # for OPL3 device (0x388)
1461 irq - IRQ # for WSS chip (5,7,9,10,11)
1462 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1463 dma1 - first DMA # for WSS chip (0,1,3)
1464 dma2 - second DMA # for WSS chip (0,1,3)
1465
1466 This module supports only one card, autoprobe and PnP.
1467
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001468 Module snd-oxygen
1469 -----------------
1470
1471 Module for sound cards based on the C-Media CMI8788 chip:
1472 * Asound A-8788
1473 * AuzenTech X-Meridian
1474 * Bgears b-Enspirer
1475 * Club3D Theatron DTS
Clemens Ladischde04b102008-11-26 10:37:23 +01001476 * HT-Omega Claro (plus)
1477 * HT-Omega Claro halo (XT)
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001478 * Razer Barracuda AC-1
1479 * Sondigo Inferno
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001480
1481 This module supports autoprobe and multiple cards.
1482
Stas Sergeevd08cd582008-03-06 11:01:44 +01001483 Module snd-pcsp
1484 -----------------
1485
1486 Module for internal PC-Speaker.
1487
Stas Sergeevbcc2c6b2009-11-01 11:13:19 +01001488 nopcm - Disable PC-Speaker PCM sound. Only beeps remain.
Stas Sergeevd08cd582008-03-06 11:01:44 +01001489 nforce_wa - enable NForce chipset workaround. Expect bad sound.
1490
1491 This module supports system beeps, some kind of PCM playback and
1492 even a few mixer controls.
1493
Markus Bollingere12229b2005-12-06 13:55:26 +01001494 Module snd-pcxhr
1495 ----------------
1496
1497 Module for Digigram PCXHR boards
1498
1499 This module supports multiple cards.
1500
Matthias Koenig757e1192007-01-25 13:15:05 +01001501 Module snd-portman2x4
1502 ---------------------
1503
1504 Module for Midiman Portman 2x4 parallel port MIDI interface
1505
1506 This module supports multiple cards.
1507
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508 Module snd-powermac (on ppc only)
1509 ---------------------------------
1510
1511 Module for PowerMac, iMac and iBook on-board soundchips
1512
1513 enable_beep - enable beep using PCM (enabled as default)
1514
1515 Module supports autoprobe a chip.
1516
1517 Note: the driver may have problems regarding endianess.
1518
1519 The power-management is supported.
1520
Takashi Iwai2c484df2005-06-30 18:54:04 +02001521 Module snd-pxa2xx-ac97 (on arm only)
1522 ------------------------------------
1523
1524 Module for AC97 driver for the Intel PXA2xx chip
1525
1526 For ARM architecture only.
1527
Takashi Iwaia4efc232005-11-17 17:24:26 +01001528 The power-management is supported.
1529
Peter Gruber109a9632006-03-27 13:10:28 +02001530 Module snd-riptide
1531 ------------------
1532
1533 Module for Conexant Riptide chip
1534
1535 joystick_port - Joystick port # (default: 0x200)
1536 mpu_port - MPU401 port # (default: 0x330)
1537 opl3_port - OPL3 port # (default: 0x388)
1538
1539 This module supports multiple cards.
1540 The driver requires the firmware loader support on kernel.
1541 You need to install the firmware file "riptide.hex" to the standard
1542 firmware path (e.g. /lib/firmware).
1543
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 Module snd-rme32
1545 ----------------
1546
1547 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1548 Prodif96 and Prodif Gold) sound cards.
1549
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001550 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551
1552 Module snd-rme96
1553 ----------------
1554
1555 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1556
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001557 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558
1559 Module snd-rme9652
1560 ------------------
1561
1562 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1563
1564 precise_ptr - Enable precise pointer (doesn't work reliably).
1565 (default = 0)
1566
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001567 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568
1569 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1570 module did formerly. It will allocate the buffers in advance
1571 when any RME9652 cards are found. To make the buffer
1572 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +02001573 stage of boot sequence. See "Early Buffer Allocation"
1574 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575
1576 Module snd-sa11xx-uda1341 (on arm only)
1577 ---------------------------------------
1578
1579 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1580
1581 Module supports only one card.
1582 Module has no enable and index options.
1583
Takashi Iwaia4efc232005-11-17 17:24:26 +01001584 The power-management is supported.
1585
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586 Module snd-sb8
1587 --------------
1588
1589 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1590 SoundBlaster 2.0,
1591 SoundBlaster Pro
1592
1593 port - port # for SB DSP chip (0x220,0x240,0x260)
1594 irq - IRQ # for SB DSP chip (5,7,9,10)
1595 dma8 - DMA # for SB DSP chip (1,3)
1596
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001597 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598
Takashi Iwaia4efc232005-11-17 17:24:26 +01001599 The power-management is supported.
1600
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 Module snd-sb16 and snd-sbawe
1602 -----------------------------
1603
1604 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1605 SoundBlaster AWE 32 (PnP),
1606 SoundBlaster AWE 64 PnP
1607
Rene Herman64e0e2d2007-12-13 16:29:33 +01001608 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1609 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1610 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1611
1612 with isapnp=0, the following options are available:
1613
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1615 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1616 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1617 (snd-sbawe module only)
1618 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1619 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1620 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001622 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001623
1624 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1625 disable 16bit DMA with dma16 = -1 module parameter.
1626 Also, all Sound Blaster 16 type cards can operate in 16-bit
1627 half duplex mode through 8-bit DMA channel by disabling their
1628 16-bit DMA channel.
1629
Takashi Iwaia4efc232005-11-17 17:24:26 +01001630 The power-management is supported.
1631
Takashi Iwai074a6e92007-09-11 22:10:14 +02001632 Module snd-sc6000
1633 -----------------
1634
Krzysztof Heltb0ec3a32009-05-03 10:39:19 +02001635 Module for Gallant SC-6000 soundcard and later models: SC-6600
1636 and SC-7000.
Takashi Iwai074a6e92007-09-11 22:10:14 +02001637
1638 port - Port # (0x220 or 0x240)
1639 mss_port - MSS Port # (0x530 or 0xe80)
1640 irq - IRQ # (5,7,9,10,11)
Krzysztof Helt7b758d22007-09-17 14:42:49 +02001641 mpu_irq - MPU-401 IRQ # (5,7,9,10) ,0 - no MPU-401 irq
Takashi Iwai074a6e92007-09-11 22:10:14 +02001642 dma - DMA # (1,3,0)
Krzysztof Heltb0ec3a32009-05-03 10:39:19 +02001643 joystick - Enable gameport - 0 = disable (default), 1 = enable
Takashi Iwai074a6e92007-09-11 22:10:14 +02001644
1645 This module supports multiple cards.
1646
1647 This card is also known as Audio Excel DSP 16 or Zoltrix AV302.
1648
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 Module snd-sgalaxy
1650 ------------------
1651
1652 Module for Aztech Sound Galaxy sound card.
1653
1654 sbport - Port # for SB16 interface (0x220,0x240)
1655 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1656 irq - IRQ # (7,9,10,11)
1657 dma1 - DMA #
1658
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001659 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660
Takashi Iwaia4efc232005-11-17 17:24:26 +01001661 The power-management is supported.
1662
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 Module snd-sscape
1664 -----------------
1665
Krzysztof Heltacd471002009-10-01 00:10:34 +02001666 Module for ENSONIQ SoundScape cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001667
1668 port - Port # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001669 wss_port - WSS Port # (PnP setup)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 irq - IRQ # (PnP setup)
1671 mpu_irq - MPU-401 IRQ # (PnP setup)
1672 dma - DMA # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001673 dma2 - 2nd DMA # (PnP setup, -1 to disable)
Krzysztof Helt1cb0fde2009-10-05 18:18:57 +02001674 joystick - Enable gameport - 0 = disable (default), 1 = enable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675
Krzysztof Heltacd471002009-10-01 00:10:34 +02001676 This module supports multiple cards.
1677
1678 The driver requires the firmware loader support on kernel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679
1680 Module snd-sun-amd7930 (on sparc only)
1681 --------------------------------------
1682
1683 Module for AMD7930 sound chips found on Sparcs.
1684
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001685 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686
1687 Module snd-sun-cs4231 (on sparc only)
1688 -------------------------------------
1689
1690 Module for CS4231 sound chips found on Sparcs.
1691
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001692 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001694 Module snd-sun-dbri (on sparc only)
1695 -----------------------------------
1696
1697 Module for DBRI sound chips found on Sparcs.
1698
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001699 This module supports multiple cards.
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001700
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 Module snd-wavefront
1702 --------------------
1703
1704 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1705
Rene Herman64e0e2d2007-12-13 16:29:33 +01001706 use_cs4232_midi - Use CS4232 MPU-401 interface
1707 (inaccessibly located inside your computer)
1708 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1709
1710 with isapnp=0, the following options are available:
1711
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 cs4232_pcm_port - Port # for CS4232 PCM interface.
1713 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1714 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1715 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716 ics2115_port - Port # for ICS2115
1717 ics2115_irq - IRQ # for ICS2115
1718 fm_port - FM OPL-3 Port #
1719 dma1 - DMA1 # for CS4232 PCM interface.
1720 dma2 - DMA2 # for CS4232 PCM interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721
Takashi Iwaic2b12392007-08-21 15:20:26 +02001722 The below are options for wavefront_synth features:
1723 wf_raw - Assume that we need to boot the OS (default:no)
1724 If yes, then during driver loading, the state of the board is
1725 ignored, and we reset the board and load the firmware anyway.
1726 fx_raw - Assume that the FX process needs help (default:yes)
1727 If false, we'll leave the FX processor in whatever state it is
1728 when the driver is loaded. The default is to download the
1729 microprogram and associated coefficients to set it up for
1730 "default" operation, whatever that means.
1731 debug_default - Debug parameters for card initialization
1732 wait_usecs - How long to wait without sleeping, usecs
1733 (default:150)
1734 This magic number seems to give pretty optimal throughput
1735 based on my limited experimentation.
1736 If you want to play around with it and find a better value, be
1737 my guest. Remember, the idea is to get a number that causes us
1738 to just busy wait for as many WaveFront commands as possible,
1739 without coming up with a number so large that we hog the whole
1740 CPU.
1741 Specifically, with this number, out of about 134,000 status
1742 waits, only about 250 result in a sleep.
1743 sleep_interval - How long to sleep when waiting for reply
1744 (default: 100)
1745 sleep_tries - How many times to try sleeping during a wait
1746 (default: 50)
1747 ospath - Pathname to processed ICS2115 OS firmware
1748 (default:wavefront.os)
1749 The path name of the ISC2115 OS firmware. In the recent
1750 version, it's handled via firmware loader framework, so it
1751 must be installed in the proper path, typically,
1752 /lib/firmware.
1753 reset_time - How long to wait for a reset to take effect
1754 (default:2)
1755 ramcheck_time - How many seconds to wait for the RAM test
1756 (default:20)
1757 osrun_time - How many seconds to wait for the ICS2115 OS
1758 (default:10)
1759
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001760 This module supports multiple cards and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761
Takashi Iwaic2b12392007-08-21 15:20:26 +02001762 Note: the firmware file "wavefront.os" was located in the earlier
1763 version in /etc. Now it's loaded via firmware loader, and
1764 must be in the proper firmware path, such as /lib/firmware.
1765 Copy (or symlink) the file appropriately if you get an error
1766 regarding firmware downloading after upgrading the kernel.
1767
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 Module snd-sonicvibes
1769 ---------------------
1770
1771 Module for S3 SonicVibes PCI sound cards.
1772 * PINE Schubert 32 PCI
1773
1774 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1775 - SoundCard must have onboard SRAM for this.
1776 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1777
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001778 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779
1780 Module snd-serial-u16550
1781 ------------------------
1782
1783 Module for UART16550A serial MIDI ports.
1784
1785 port - port # for UART16550A chip
1786 irq - IRQ # for UART16550A chip, -1 = poll mode
1787 speed - speed in bauds (9600,19200,38400,57600,115200)
1788 38400 = default
1789 base - base for divisor in bauds (57600,115200,230400,460800)
1790 115200 = default
1791 outs - number of MIDI ports in a serial port (1-4)
1792 1 = default
1793 adaptor - Type of adaptor.
1794 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1795 3 = MS-124W M/B, 4 = Generic
1796
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001797 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 thus the main port must be specified!!! Other options are optional.
1799
1800 Module snd-trident
1801 ------------------
1802
1803 Module for Trident 4DWave DX/NX sound cards.
1804 * Best Union Miss Melody 4DWave PCI
1805 * HIS 4DWave PCI
1806 * Warpspeed ONSpeed 4DWave PCI
1807 * AzTech PCI 64-Q3D
1808 * Addonics SV 750
1809 * CHIC True Sound 4Dwave
1810 * Shark Predator4D-PCI
1811 * Jaton SonicWave 4D
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001812 * SiS SI7018 PCI Audio
1813 * Hoontech SoundTrack Digital 4DWave NX
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814
1815 pcm_channels - max channels (voices) reserved for PCM
1816 wavetable_size - max wavetable size in kB (4-?kb)
1817
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001818 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819
1820 The power-management is supported.
1821
Clemens Ladisch63978ab2009-12-14 12:48:35 +01001822 Module snd-ua101
1823 ----------------
1824
Clemens Ladische584bc32010-03-01 16:20:37 +01001825 Module for the Edirol UA-101/UA-1000 audio/MIDI interfaces.
Clemens Ladisch63978ab2009-12-14 12:48:35 +01001826
1827 This module supports multiple devices, autoprobe and hotplugging.
1828
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 Module snd-usb-audio
1830 --------------------
1831
1832 Module for USB audio and USB MIDI devices.
1833
1834 vid - Vendor ID for the device (optional)
1835 pid - Product ID for the device (optional)
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001836 nrpacks - Max. number of packets per URB (default: 8)
1837 async_unlink - Use async unlink mode (default: yes)
Thibault LE MEURe3113342006-03-14 11:44:53 +01001838 device_setup - Device specific magic number (optional)
1839 - Influence depends on the device
1840 - Default: 0x0000
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001841 ignore_ctl_error - Ignore any USB-controller regarding mixer
1842 interface (default: no)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001844 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001845
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001846 NB: nrpacks parameter can be modified dynamically via sysfs.
1847 Don't put the value over 20. Changing via sysfs has no sanity
1848 check.
1849 NB: async_unlink=0 would cause Oops. It remains just for
1850 debugging purpose (if any).
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001851 NB: ignore_ctl_error=1 may help when you get an error at accessing
1852 the mixer element such as URB error -22. This happens on some
1853 buggy USB device or the controller.
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001854
Daniel Mack523f1dc2007-03-26 19:11:24 +02001855 Module snd-usb-caiaq
1856 --------------------
1857
1858 Module for caiaq UB audio interfaces,
1859 * Native Instruments RigKontrol2
1860 * Native Instruments Kore Controller
1861 * Native Instruments Audio Kontrol 1
1862 * Native Instruments Audio 8 DJ
1863
1864 This module supports multiple devices, autoprobe and hotplugging.
1865
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866 Module snd-usb-usx2y
1867 --------------------
1868
1869 Module for Tascam USB US-122, US-224 and US-428 devices.
1870
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001871 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872
1873 Note: you need to load the firmware via usx2yloader utility included
1874 in alsa-tools and alsa-firmware packages.
1875
1876 Module snd-via82xx
1877 ------------------
1878
1879 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001880 8233A, 8233C, 8235, 8237 (south) bridge.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881
1882 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1883 [VIA686A/686B only]
1884 joystick - Enable joystick (default off) [VIA686A/686B only]
1885 ac97_clock - AC'97 codec clock base (default 48000Hz)
1886 dxs_support - support DXS channels,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001887 0 = auto (default), 1 = enable, 2 = disable,
1888 3 = 48k only, 4 = no VRA, 5 = enable any sample
1889 rate and different sample rates on different
1890 channels
1891 [VIA8233/C, 8235, 8237 only]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001893 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001895 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896
1897 Note: on some SMP motherboards like MSI 694D the interrupts might
1898 not be generated properly. In such a case, please try to
1899 set the SMP (or MPS) version on BIOS to 1.1 instead of
1900 default value 1.4. Then the interrupt number will be
1901 assigned under 15. You might also upgrade your BIOS.
1902
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001903 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904 channels as the first PCM. On these channels, up to 4
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001905 streams can be played at the same time, and the controller
1906 can perform sample rate conversion with separate rates for
1907 each channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001908 As default (dxs_support = 0), 48k fixed rate is chosen
1909 except for the known devices since the output is often
1910 noisy except for 48k on some mother boards due to the
1911 bug of BIOS.
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001912 Please try once dxs_support=5 and if it works on other
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1914 know the PCI subsystem vendor/device id's (output of
1915 "lspci -nv").
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001916 If dxs_support=5 does not work, try dxs_support=4; if it
1917 doesn't work too, try dxs_support=1. (dxs_support=1 is
Takashi Iwai62430082005-09-05 17:12:29 +02001918 usually for old motherboards. The correct implemented
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001919 board should work with 4 or 5.) If it still doesn't
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 work and the default setting is ok, dxs_support=3 is the
1921 right choice. If the default setting doesn't work at all,
1922 try dxs_support=2 to disable the DXS channels.
1923 In any cases, please let us know the result and the
Takashi Iwai62430082005-09-05 17:12:29 +02001924 subsystem vendor/device ids. See "Links and Addresses"
1925 below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926
1927 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Takashi Iwai62430082005-09-05 17:12:29 +02001928 additionally. The mpu_port option is for VIA686 chips only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929
Takashi Iwaia4efc232005-11-17 17:24:26 +01001930 The power-management is supported.
1931
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932 Module snd-via82xx-modem
1933 ------------------------
1934
1935 Module for VIA82xx AC97 modem
1936
1937 ac97_clock - AC'97 codec clock base (default 48000Hz)
1938
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001939 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940
1941 Note: The default index value of this module is -2, i.e. the first
1942 slot is excluded.
1943
Takashi Iwaia4efc232005-11-17 17:24:26 +01001944 The power-management is supported.
1945
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946 Module snd-virmidi
1947 ------------------
1948
1949 Module for virtual rawmidi devices.
1950 This module creates virtual rawmidi devices which communicate
1951 to the corresponding ALSA sequencer ports.
1952
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001953 midi_devs - MIDI devices # (1-4, default=4)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001955 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001957 Module snd-virtuoso
1958 -------------------
1959
Clemens Ladisch5430c722008-07-28 10:28:43 +02001960 Module for sound cards based on the Asus AV100/AV200 chips,
Clemens Ladischd1db38c2010-01-18 15:44:04 +01001961 i.e., Xonar D1, DX, D2, D2X, DS, HDAV1.3 (Deluxe), Essence ST
Clemens Ladisch04f98902009-05-25 10:11:29 +02001962 (Deluxe) and Essence STX.
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001963
1964 This module supports autoprobe and multiple cards.
1965
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966 Module snd-vx222
1967 ----------------
1968
1969 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1970
1971 mic - Enable Microphone on V222 Mic (NYI)
1972 ibl - Capture IBL size. (default = 0, minimum size)
1973
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001974 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975
1976 When the driver is compiled as a module and the hotplug firmware
1977 is supported, the firmware data is loaded via hotplug automatically.
1978 Install the necessary firmware files in alsa-firmware package.
1979 When no hotplug fw loader is available, you need to load the
1980 firmware via vxloader utility in alsa-tools package. To invoke
1981 vxloader automatically, add the following to /etc/modprobe.conf
1982
1983 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1984
1985 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1986 /etc/modules.conf, instead.)
1987 IBL size defines the interrupts period for PCM. The smaller size
1988 gives smaller latency but leads to more CPU consumption, too.
1989 The size is usually aligned to 126. As default (=0), the smallest
1990 size is chosen. The possible IBL values can be found in
1991 /proc/asound/cardX/vx-status proc file.
1992
Takashi Iwaia4efc232005-11-17 17:24:26 +01001993 The power-management is supported.
1994
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995 Module snd-vxpocket
1996 -------------------
1997
Takashi Iwai6d00a312005-06-30 13:40:51 +02001998 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999
2000 ibl - Capture IBL size. (default = 0, minimum size)
2001
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01002002 This module supports multiple cards. The module is compiled only when
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003 PCMCIA is supported on kernel.
2004
Takashi Iwai62430082005-09-05 17:12:29 +02002005 With the older 2.6.x kernel, to activate the driver via the card
2006 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
2007 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
2008 longer require a config file.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009
2010 When the driver is compiled as a module and the hotplug firmware
2011 is supported, the firmware data is loaded via hotplug automatically.
2012 Install the necessary firmware files in alsa-firmware package.
2013 When no hotplug fw loader is available, you need to load the
2014 firmware via vxloader utility in alsa-tools package.
2015
2016 About capture IBL, see the description of snd-vx222 module.
2017
Takashi Iwaied7cbe32006-05-11 11:30:10 +02002018 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
Takashi Iwai62430082005-09-05 17:12:29 +02002019 ALSA 1.0.10.
2020
Takashi Iwaia4efc232005-11-17 17:24:26 +01002021 The power-management is supported.
2022
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 Module snd-ymfpci
2024 -----------------
2025
2026 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
2027
2028 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
2029 1 (auto-detect for YMF744/754 only)
2030 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
2031 1 (auto-detect for YMF744/754 only)
2032 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
2033 1 (auto-detect)
2034 rear_switch - enable shared rear/line-in switch (bool)
2035
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01002036 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037
2038 The power-management is supported.
2039
2040 Module snd-pdaudiocf
2041 --------------------
2042
2043 Module for Sound Core PDAudioCF sound card.
2044
Takashi Iwaia4efc232005-11-17 17:24:26 +01002045 The power-management is supported.
2046
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047
Takashi Iwai62430082005-09-05 17:12:29 +02002048AC97 Quirk Option
2049=================
2050
2051The ac97_quirk option is used to enable/override the workaround for
2052specific devices on drivers for on-board AC'97 controllers like
2053snd-intel8x0. Some hardware have swapped output pins between Master
2054and Headphone, or Surround (thanks to confusion of AC'97
2055specifications from version to version :-)
2056
2057The driver provides the auto-detection of known problematic devices,
2058but some might be unknown or wrongly detected. In such a case, pass
2059the proper value with this option.
2060
2061The following strings are accepted:
2062 - default Don't override the default setting
Takashi Iwai10e4097f2005-11-17 11:04:55 +01002063 - none Disable the quirk
Takashi Iwai62430082005-09-05 17:12:29 +02002064 - hp_only Bind Master and Headphone controls as a single control
2065 - swap_hp Swap headphone and master controls
2066 - swap_surround Swap master and surround controls
2067 - ad_sharing For AD1985, turn on OMS bit and use headphone
2068 - alc_jack For ALC65x, turn on the jack sense mode
2069 - inv_eapd Inverted EAPD implementation
2070 - mute_led Bind EAPD bit for turning on/off mute LED
2071
2072For backward compatibility, the corresponding integer value -1, 0,
2073... are accepted, too.
2074
2075For example, if "Master" volume control has no effect on your device
2076but only "Headphone" does, pass ac97_quirk=hp_only module option.
2077
2078
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079Configuring Non-ISAPNP Cards
2080============================
2081
2082When the kernel is configured with ISA-PnP support, the modules
2083supporting the isapnp cards will have module options "isapnp".
2084If this option is set, *only* the ISA-PnP devices will be probed.
2085For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
2086together with the proper i/o and irq configuration.
2087
2088When the kernel is configured without ISA-PnP support, isapnp option
2089will be not built in.
2090
2091
2092Module Autoloading Support
2093==========================
2094
2095The ALSA drivers can be loaded automatically on demand by defining
2096module aliases. The string 'snd-card-%1' is requested for ALSA native
2097devices where %i is sound card number from zero to seven.
2098
2099To auto-load an ALSA driver for OSS services, define the string
2100'sound-slot-%i' where %i means the slot number for OSS, which
2101corresponds to the card index of ALSA. Usually, define this
Tobias Klauserd533f672005-09-10 00:26:46 -07002102as the same card module.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103
2104An example configuration for a single emu10k1 card is like below:
2105----- /etc/modprobe.conf
2106alias snd-card-0 snd-emu10k1
2107alias sound-slot-0 snd-emu10k1
2108----- /etc/modprobe.conf
2109
2110The available number of auto-loaded sound cards depends on the module
2111option "cards_limit" of snd module. As default it's set to 1.
2112To enable the auto-loading of multiple cards, specify the number of
2113sound cards in that option.
2114
2115When multiple cards are available, it'd better to specify the index
2116number for each card via module option, too, so that the order of
2117cards is kept consistent.
2118
2119An example configuration for two sound cards is like below:
2120
2121----- /etc/modprobe.conf
2122# ALSA portion
2123options snd cards_limit=2
2124alias snd-card-0 snd-interwave
2125alias snd-card-1 snd-ens1371
2126options snd-interwave index=0
2127options snd-ens1371 index=1
2128# OSS/Free portion
2129alias sound-slot-0 snd-interwave
2130alias sound-slot-1 snd-ens1371
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02002131----- /etc/modprobe.conf
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132
2133In this example, the interwave card is always loaded as the first card
2134(index 0) and ens1371 as the second (index 1).
2135
Takashi Iwai304cd072007-10-26 15:10:15 +02002136Alternative (and new) way to fixate the slot assignment is to use
2137"slots" option of snd module. In the case above, specify like the
2138following:
2139
2140options snd slots=snd-interwave,snd-ens1371
2141
2142Then, the first slot (#0) is reserved for snd-interwave driver, and
2143the second (#1) for snd-ens1371. You can omit index option in each
2144driver if slots option is used (although you can still have them at
2145the same time as long as they don't conflict).
2146
2147The slots option is especially useful for avoiding the possible
2148hot-plugging and the resultant slot conflict. For example, in the
2149case above again, the first two slots are already reserved. If any
2150other driver (e.g. snd-usb-audio) is loaded before snd-interwave or
2151snd-ens1371, it will be assigned to the third or later slot.
2152
Takashi Iwaia93bbaa2008-05-27 17:59:24 +02002153When a module name is given with '!', the slot will be given for any
2154modules but that name. For example, "slots=!snd-pcsp" will reserve
2155the first slot for any modules but snd-pcsp.
2156
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157
2158ALSA PCM devices to OSS devices mapping
2159=======================================
2160
2161/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
2162/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
2163/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
2164/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
2165/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
2166/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
2167/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
2168/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
2169/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
2170
2171The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
2172sound card number and second means device number. The ALSA devices
2173have either 'c' or 'p' suffix indicating the direction, capture and
2174playback, respectively.
2175
2176Please note that the device mapping above may be varied via the module
2177options of snd-pcm-oss module.
2178
2179
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180Proc interfaces (/proc/asound)
2181==============================
2182
2183/proc/asound/card#/pcm#[cp]/oss
2184-------------------------------
2185 String "erase" - erase all additional informations about OSS applications
2186 String "<app_name> <fragments> <fragment_size> [<options>]"
2187
2188 <app_name> - name of application with (higher priority) or without path
2189 <fragments> - number of fragments or zero if auto
2190 <fragment_size> - size of fragment in bytes or zero if auto
2191 <options> - optional parameters
2192 - disable the application tries to open a pcm device for
2193 this channel but does not want to use it.
2194 (Cause a bug or mmap needs)
2195 It's good for Quake etc...
2196 - direct don't use plugins
2197 - block force block mode (rvplayer)
2198 - non-block force non-block mode
2199 - whole-frag write only whole fragments (optimization affecting
2200 playback only)
2201 - no-silence do not fill silence ahead to avoid clicks
Takashi Iwai10f69f92005-09-08 13:48:34 +02002202 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
2203 instead of filled blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204
2205 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
2206 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
2207 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
2208
2209
Takashi Iwaib6a96912005-05-30 18:27:03 +02002210Early Buffer Allocation
2211=======================
2212
2213Some drivers (e.g. hdsp) require the large contiguous buffers, and
2214sometimes it's too late to find such spaces when the driver module is
2215actually loaded due to memory fragmentation. You can pre-allocate the
2216PCM buffers by loading snd-page-alloc module and write commands to its
2217proc file in prior, for example, in the early boot stage like
2218/etc/init.d/*.local scripts.
2219
2220Reading the proc file /proc/drivers/snd-page-alloc shows the current
2221usage of page allocation. In writing, you can send the following
2222commands to the snd-page-alloc driver:
2223
2224 - add VENDOR DEVICE MASK SIZE BUFFERS
2225
2226 VENDOR and DEVICE are PCI vendor and device IDs. They take
2227 integer numbers (0x prefix is needed for the hex).
2228 MASK is the PCI DMA mask. Pass 0 if not restricted.
2229 SIZE is the size of each buffer to allocate. You can pass
2230 k and m suffix for KB and MB. The max number is 16MB.
2231 BUFFERS is the number of buffers to allocate. It must be greater
2232 than 0. The max number is 4.
2233
2234 - erase
2235
2236 This will erase the all pre-allocated buffers which are not in
2237 use.
2238
2239
Takashi Iwai62430082005-09-05 17:12:29 +02002240Links and Addresses
2241===================
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242
2243 ALSA project homepage
2244 http://www.alsa-project.org
2245
Takashi Iwai30bc4482008-12-09 08:23:45 +01002246 Kernel Bugzilla
2247 http://bugzilla.kernel.org/
Takashi Iwai62430082005-09-05 17:12:29 +02002248
2249 ALSA Developers ML
Rene Herman45051792007-03-21 12:05:06 +01002250 mailto:alsa-devel@alsa-project.org
Takashi Iwai30bc4482008-12-09 08:23:45 +01002251
2252 alsa-info.sh script
2253 http://www.alsa-project.org/alsa-info.sh