blob: c83fd7b6420165cfc34c7fad0c1e5a46551cc8fb [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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 Module snd-atiixp
231 -----------------
232
Takashi Iwai62430082005-09-05 17:12:29 +0200233 Module for ATI IXP 150/200/250/400 AC97 controllers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Takashi Iwai62430082005-09-05 17:12:29 +0200235 ac97_clock - AC'97 clock (default = 48000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200237 See "AC97 Quirk Option" section below.
Dan Carpenter14e1d352006-11-20 16:35:18 +0100238 ac97_codec - Workaround to specify which AC'97 codec
239 instead of probing. If this works for you
240 file a bug with your `lspci -vn` output.
241 -2 -- Force probing.
242 -1 -- Default behavior.
243 0-2 -- Use the specified codec.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 spdif_aclink - S/PDIF transfer over AC-link (default = 1)
245
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200246 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Takashi Iwai62430082005-09-05 17:12:29 +0200248 ATI IXP has two different methods to control SPDIF output. One is
249 over AC-link and another is over the "direct" SPDIF output. The
250 implementation depends on the motherboard, and you'll need to
251 choose the correct one via spdif_aclink module option.
252
Takashi Iwaia4efc232005-11-17 17:24:26 +0100253 The power-management is supported.
254
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 Module snd-atiixp-modem
256 -----------------------
257
258 Module for ATI IXP 150/200/250 AC97 modem controllers.
259
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200260 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
262 Note: The default index value of this module is -2, i.e. the first
263 slot is excluded.
264
Takashi Iwaia4efc232005-11-17 17:24:26 +0100265 The power-management is supported.
266
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 Module snd-au8810, snd-au8820, snd-au8830
268 -----------------------------------------
269
270 Module for Aureal Vortex, Vortex2 and Advantage device.
271
272 pcifix - Control PCI workarounds
273 0 = Disable all workarounds
274 1 = Force the PCI latency of the Aureal card to 0xff
275 2 = Force the Extend PCI#2 Internal Master for Efficient
276 Handling of Dummy Requests on the VIA KT133 AGP Bridge
277 3 = Force both settings
278 255 = Autodetect what is required (default)
279
280 This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
281 EQ, mpu401, gameport. A3D and wavetable support are still in development.
282 Development and reverse engineering work is being coordinated at
283 http://savannah.nongnu.org/projects/openvortex/
284 SPDIF output has a copy of the AC97 codec output, unless you use the
285 "spdif" pcm device, which allows raw data passthru.
286 The hardware EQ hardware and SPDIF is only present in the Vortex2 and
287 Advantage.
288
Takashi Iwai62430082005-09-05 17:12:29 +0200289 Note: Some ALSA mixer applications don't handle the SPDIF sample rate
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 control correctly. If you have problems regarding this, try
291 another ALSA compliant mixer (alsamixer works).
292
Takashi Iwai9e235322008-02-20 12:13:29 +0100293 Module snd-aw2
294 --------------
295
296 Module for Audiowerk2 sound card
297
298 This module supports multiple cards.
299
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 Module snd-azt2320
301 ------------------
302
303 Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
304
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100305 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306
Takashi Iwaia4efc232005-11-17 17:24:26 +0100307 The power-management is supported.
308
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 Module snd-azt3328
310 ------------------
311
312 Module for sound cards based on Aztech AZF3328 PCI chip.
313
314 joystick - Enable joystick (default off)
315
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100316 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
318 Module snd-bt87x
319 ----------------
320
321 Module for video cards based on Bt87x chips.
322
323 digital_rate - Override the default digital rate (Hz)
324 load_all - Load the driver even if the card model isn't known
325
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100326 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
328 Note: The default index value of this module is -2, i.e. the first
329 slot is excluded.
330
331 Module snd-ca0106
332 -----------------
333
334 Module for Creative Audigy LS and SB Live 24bit
335
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100336 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337
338
339 Module snd-cmi8330
340 ------------------
341
342 Module for sound cards based on C-Media CMI8330 ISA chips.
343
Rene Herman64e0e2d2007-12-13 16:29:33 +0100344 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
345
346 with isapnp=0, the following options are available:
347
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 wssport - port # for CMI8330 chip (WSS)
349 wssirq - IRQ # for CMI8330 chip (WSS)
350 wssdma - first DMA # for CMI8330 chip (WSS)
351 sbport - port # for CMI8330 chip (SB16)
352 sbirq - IRQ # for CMI8330 chip (SB16)
353 sbdma8 - 8bit DMA # for CMI8330 chip (SB16)
354 sbdma16 - 16bit DMA # for CMI8330 chip (SB16)
Takashi Iwai9e128fd2009-01-29 11:49:10 +0100355 fmport - (optional) OPL3 I/O port
356 mpuport - (optional) MPU401 I/O port
357 mpuirq - (optional) MPU401 irq #
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100359 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
Takashi Iwaia4efc232005-11-17 17:24:26 +0100361 The power-management is supported.
362
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 Module snd-cmipci
364 -----------------
365
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200366 Module for C-Media CMI8338/8738/8768/8770 PCI sound cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367
Clemens Ladischc78c9502007-09-03 09:55:49 +0200368 mpu_port - port address of MIDI interface (8338 only):
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200369 0x300,0x310,0x320,0x330 = legacy port,
Takashi Iwaicab5c4c2006-05-04 14:36:08 +0200370 0 = disable (default)
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200371 fm_port - port address of OPL-3 FM synthesizer (8x38 only):
372 0x388 = legacy port,
373 1 = integrated PCI port (default on 8738),
Takashi Iwai2f24d1592007-02-15 18:56:43 +0100374 0 = disable
Takashi Iwai62430082005-09-05 17:12:29 +0200375 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 (default = 1)
377 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
378
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100379 This module supports autoprobe and multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
Takashi Iwaia4efc232005-11-17 17:24:26 +0100381 The power-management is supported.
382
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 Module snd-cs4231
384 -----------------
385
386 Module for sound cards based on CS4231 ISA chips.
387
388 port - port # for CS4231 chip
389 mpu_port - port # for MPU-401 UART (optional), -1 = disable
390 irq - IRQ # for CS4231 chip
391 mpu_irq - IRQ # for MPU-401 UART
392 dma1 - first DMA # for CS4231 chip
393 dma2 - second DMA # for CS4231 chip
394
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100395 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 thus main port must be specified!!! Other ports are optional.
397
398 The power-management is supported.
399
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 Module snd-cs4236
401 -----------------
402
Takashi Iwaic844a5d2009-02-16 23:17:33 +0100403 Module for sound cards based on CS4232/CS4232A,
404 CS4235/CS4236/CS4236B/CS4237B/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 CS4238B/CS4239 ISA chips.
406
Rene Herman64e0e2d2007-12-13 16:29:33 +0100407 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
408
409 with isapnp=0, the following options are available:
410
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 port - port # for CS4236 chip (PnP setup - 0x534)
412 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
413 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
414 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
415 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
416 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
417 dma1 - first DMA # for CS4236 chip (0,1,3)
418 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100420 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 (if ISA PnP is not used) thus main port and control port must be
422 specified!!! Other ports are optional.
423
424 The power-management is supported.
425
Takashi Iwaic844a5d2009-02-16 23:17:33 +0100426 This module is aliased as snd-cs4232 since it provides the old
427 snd-cs4232 functionality, too.
428
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 Module snd-cs4281
430 -----------------
431
432 Module for Cirrus Logic CS4281 soundchip.
433
434 dual_codec - Secondary codec ID (0 = disable, default)
435
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100436 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437
438 The power-management is supported.
439
440 Module snd-cs46xx
441 -----------------
442
443 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
444 CS4624/CS4630/CS4280 PCI chips.
445
Takashi Iwai62430082005-09-05 17:12:29 +0200446 external_amp - Force to enable external amplifier.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 thinkpad - Force to enable Thinkpad's CLKRUN control.
448 mmap_valid - Support OSS mmap mode (default = 0).
449
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100450 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 Usually external amp and CLKRUN controls are detected automatically
452 from PCI sub vendor/device ids. If they don't work, give the options
453 above explicitly.
454
455 The power-management is supported.
Takashi Iwai621887a2007-05-24 18:46:54 +0200456
457 Module snd-cs5530
458 _________________
459
460 Module for Cyrix/NatSemi Geode 5530 chip.
461
Takashi Iwai3e873172005-11-17 10:15:37 +0100462 Module snd-cs5535audio
463 ----------------------
464
465 Module for multifunction CS5535 companion PCI device
466
Takashi Iwaic00bd742006-05-19 19:22:34 +0200467 The power-management is supported.
Takashi Iwai3e873172005-11-17 10:15:37 +0100468
Wai Yew CHAY8cc72362009-05-14 08:05:58 +0200469 Module snd-ctxfi
470 ----------------
471
472 Module for Creative Sound Blaster X-Fi boards (20k1 / 20k2 chips)
473 * Creative Sound Blaster X-Fi Titanium Fatal1ty Champion Series
474 * Creative Sound Blaster X-Fi Titanium Fatal1ty Professional Series
475 * Creative Sound Blaster X-Fi Titanium Professional Audio
476 * Creative Sound Blaster X-Fi Titanium
477 * Creative Sound Blaster X-Fi Elite Pro
478 * Creative Sound Blaster X-Fi Platinum
479 * Creative Sound Blaster X-Fi Fatal1ty
480 * Creative Sound Blaster X-Fi XtremeGamer
481 * Creative Sound Blaster X-Fi XtremeMusic
482
483 reference_rate - reference sample rate, 44100 or 48000 (default)
484 multiple - multiple to ref. sample rate, 1 or 2 (default)
Takashi Iwai408bffd2010-01-14 09:19:46 +0100485 subsystem - override the PCI SSID for probing; the value
486 consists of SSVID << 16 | SSDID. The default is
487 zero, which means no override.
Wai Yew CHAY8cc72362009-05-14 08:05:58 +0200488
489 This module supports multiple cards.
490
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200491 Module snd-darla20
492 ------------------
493
494 Module for Echoaudio Darla20
495
496 This module supports multiple cards.
497 The driver requires the firmware loader support on kernel.
498
499 Module snd-darla24
500 ------------------
501
502 Module for Echoaudio Darla24
503
504 This module supports multiple cards.
505 The driver requires the firmware loader support on kernel.
506
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 Module snd-dt019x
508 -----------------
509
510 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
511 only)
512
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100513 This module supports multiple cards. This module is enabled only with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 ISA PnP support.
515
Takashi Iwaia4efc232005-11-17 17:24:26 +0100516 The power-management is supported.
517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 Module snd-dummy
519 ----------------
520
521 Module for the dummy sound card. This "card" doesn't do any output
522 or input, but you may use this module for any application which
523 requires a sound card (like RealPlayer).
524
Takashi Iwai30681bcf2009-09-03 16:08:08 +0200525 pcm_devs - Number of PCM devices assigned to each card
526 (default = 1, up to 4)
527 pcm_substreams - Number of PCM substreams assigned to each PCM
Takashi Iwai23aebca2009-11-02 14:10:59 +0100528 (default = 8, up to 128)
Takashi Iwai30681bcf2009-09-03 16:08:08 +0200529 hrtimer - Use hrtimer (=1, default) or system timer (=0)
Takashi Iwaia68c4d12009-09-04 12:19:36 +0200530 fake_buffer - Fake buffer allocations (default = 1)
Takashi Iwai30681bcf2009-09-03 16:08:08 +0200531
532 When multiple PCM devices are created, snd-dummy gives different
533 behavior to each PCM device:
534 0 = interleaved with mmap support
535 1 = non-interleaved with mmap support
536 2 = interleaved without mmap
537 3 = non-interleaved without mmap
538
Takashi Iwaia68c4d12009-09-04 12:19:36 +0200539 As default, snd-dummy drivers doesn't allocate the real buffers
540 but either ignores read/write or mmap a single dummy page to all
541 buffer pages, in order to save the resouces. If your apps need
542 the read/ written buffer data to be consistent, pass fake_buffer=0
543 option.
544
Takashi Iwaia4efc232005-11-17 17:24:26 +0100545 The power-management is supported.
546
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200547 Module snd-echo3g
548 -----------------
549
550 Module for Echoaudio 3G cards (Gina3G/Layla3G)
551
552 This module supports multiple cards.
553 The driver requires the firmware loader support on kernel.
554
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 Module snd-emu10k1
556 ------------------
557
558 Module for EMU10K1/EMU10k2 based PCI sound cards.
559 * Sound Blaster Live!
560 * Sound Blaster PCI 512
561 * Emu APS (partially supported)
562 * Sound Blaster Audigy
563
564 extin - bitmap of available external inputs for FX8010 (see bellow)
565 extout - bitmap of available external outputs for FX8010 (see bellow)
566 seq_ports - allocated sequencer ports (4 by default)
567 max_synth_voices - limit of voices used for wavetable (64 by default)
568 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
569 given in MB unit. Default value is 128.
570 enable_ir - enable IR
571
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100572 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
574 Input & Output configurations [extin/extout]
575 * Creative Card wo/Digital out [0x0003/0x1f03]
576 * Creative Card w/Digital out [0x0003/0x1f0f]
577 * Creative Card w/Digital CD in [0x000f/0x1f0f]
578 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
579 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
580 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
581 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
582 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
583 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
584 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
585 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
586 * Creative Card all ins and outs [0x3fff/0x7fff]
587
Takashi Iwaia4efc232005-11-17 17:24:26 +0100588 The power-management is supported.
589
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 Module snd-emu10k1x
591 -------------------
592
593 Module for Creative Emu10k1X (SB Live Dell OEM version)
594
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100595 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596
597 Module snd-ens1370
598 ------------------
599
600 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
601 * SoundBlaster PCI 64
602 * SoundBlaster PCI 128
603
604 joystick - Enable joystick (default off)
605
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100606 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100608 The power-management is supported.
609
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 Module snd-ens1371
611 ------------------
612
613 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
614 * SoundBlaster PCI 64
615 * SoundBlaster PCI 128
616 * SoundBlaster Vibra PCI
617
618 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
619 0 = disable (default), 1 = auto-detect
620
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100621 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100623 The power-management is supported.
624
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 Module snd-es968
626 ----------------
627
628 Module for sound cards based on ESS ES968 chip (PnP only).
629
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100630 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
Takashi Iwaia4efc232005-11-17 17:24:26 +0100632 The power-management is supported.
633
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 Module snd-es1688
635 -----------------
636
637 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
638
639 port - port # for ES-1688 chip (0x220,0x240,0x260)
Takashi Iwai504a06d2009-01-30 19:59:10 +0100640 fm_port - port # for OPL3 (option; share the same port as default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
642 irq - IRQ # for ES-1688 chip (5,7,9,10)
643 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
644 dma8 - DMA # for ES-1688 chip (0,1,3)
645
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100646 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647
648 Module snd-es18xx
649 -----------------
650
651 Module for ESS AudioDrive ES-18xx sound cards.
652
Rene Herman64e0e2d2007-12-13 16:29:33 +0100653 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
654
655 with isapnp=0, the following options are available:
656
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 port - port # for ES-18xx chip (0x220,0x240,0x260)
658 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
659 fm_port - port # for FM (optional, not used)
660 irq - IRQ # for ES-18xx chip (5,7,9,10)
661 dma1 - first DMA # for ES-18xx chip (0,1,3)
662 dma2 - first DMA # for ES-18xx chip (0,1,3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100664 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
665 port if native ISA PnP routines are not used).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 When dma2 is equal with dma1, the driver works as half-duplex.
667
668 The power-management is supported.
669
670 Module snd-es1938
671 -----------------
672
673 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
674
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100675 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676
Takashi Iwaia4efc232005-11-17 17:24:26 +0100677 The power-management is supported.
678
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 Module snd-es1968
680 -----------------
681
682 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
683
684 total_bufsize - total buffer size in kB (1-4096kB)
685 pcm_substreams_p - playback channels (1-8, default=2)
686 pcm_substreams_c - capture channels (1-8, default=0)
687 clock - clock (0 = auto-detection)
688 use_pm - support the power-management (0 = off, 1 = on,
689 2 = auto (default))
690 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
691 joystick - enable joystick (default off)
692
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100693 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694
695 The power-management is supported.
696
697 Module snd-fm801
698 ----------------
699
700 Module for ForteMedia FM801 based PCI sound cards.
701
702 tea575x_tuner - Enable TEA575x tuner
703 - 1 = MediaForte 256-PCS
704 - 2 = MediaForte 256-PCPR
705 - 3 = MediaForte 64-PCR
706 - High 16-bits are video (radio) device number + 1
707 - example: 0x10002 (MediaForte 256-PCPR, device 1)
708
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100709 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710
Takashi Iwaia4efc232005-11-17 17:24:26 +0100711 The power-management is supported.
712
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200713 Module snd-gina20
714 -----------------
715
716 Module for Echoaudio Gina20
717
718 This module supports multiple cards.
719 The driver requires the firmware loader support on kernel.
720
721 Module snd-gina24
722 -----------------
723
724 Module for Echoaudio Gina24
725
726 This module supports multiple cards.
727 The driver requires the firmware loader support on kernel.
728
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 Module snd-gusclassic
730 ---------------------
731
732 Module for Gravis UltraSound Classic sound card.
733
734 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
735 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
736 dma1 - DMA # for GF1 chip (1,3,5,6,7)
737 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
738 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
739 voices - GF1 voices limit (14-32)
740 pcm_voices - reserved PCM voices
741
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100742 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
744 Module snd-gusextreme
745 ---------------------
746
747 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
748
749 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
750 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
751 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
752 irq - IRQ # for ES-1688 chip (5,7,9,10)
753 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
754 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
755 dma8 - DMA # for ES-1688 chip (0,1,3)
756 dma1 - DMA # for GF1 chip (1,3,5,6,7)
757 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
758 voices - GF1 voices limit (14-32)
759 pcm_voices - reserved PCM voices
760
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100761 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762
763 Module snd-gusmax
764 -----------------
765
766 Module for Gravis UltraSound MAX sound card.
767
768 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
769 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
770 dma1 - DMA # for GF1 chip (1,3,5,6,7)
771 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
772 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
773 voices - GF1 voices limit (14-32)
774 pcm_voices - reserved PCM voices
775
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100776 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777
778 Module snd-hda-intel
779 --------------------
780
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400781 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8, ICH9, ICH10,
782 PCH, SCH),
783 ATI SB450, SB600, R600, RS600, RS690, RS780, RV610, RV620,
784 RV630, RV635, RV670, RV770,
Takashi Iwai9b878192006-05-17 11:26:39 +0200785 VIA VT8251/VT8237A,
786 SIS966, ULI M5461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100788 [Multiple options for each card instance]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 model - force the model name
Takashi Iwaid2e1c972008-06-10 17:53:34 +0200790 position_fix - Fix DMA pointer (0 = auto, 1 = use LPIB, 2 = POSBUF)
Takashi Iwai95904742007-05-19 17:06:42 +0200791 probe_mask - Bitmask to probe codecs (default = -1, meaning all slots)
Takashi Iwaiae374d62009-02-13 08:33:55 +0100792 When the bit 8 (0x100) is set, the lower 8 bits are used
793 as the "fixed" codec slots; i.e. the driver probes the
794 slots regardless what hardware reports back
Takashi Iwaid4d9cd032008-12-19 15:19:11 +0100795 probe_only - Only probing and no codec initialization (default=off);
796 Useful to check the initial codec status for debugging
Takashi Iwai8c53b962008-06-10 17:53:35 +0200797 bdl_pos_adj - Specifies the DMA IRQ timing delay in samples.
798 Passing -1 will make the driver to choose the appropriate
799 value based on the controller chip.
Takashi Iwai1e7b8c82009-06-17 17:30:54 +0200800 patch - Specifies the early "patch" files to modify the HD-audio
801 setup before initializing the codecs. This option is
802 available only when CONFIG_SND_HDA_PATCH_LOADER=y is set.
803 See HD-Audio.txt for details.
Takashi Iwaid0193612009-11-16 12:03:49 +0100804 beep_mode - Selects the beep registration mode (0=off, 1=on, 2=
805 dynamic registration via mute switch on/off); the default
806 value is set via CONFIG_SND_HDA_INPUT_BEEP_MODE kconfig.
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100807
808 [Single (global) options]
Takashi Iwai27346162006-01-12 18:28:44 +0100809 single_cmd - Use single immediate commands to communicate with
810 codecs (for debugging only)
Takashi Iwai134a11f2006-11-10 12:08:37 +0100811 enable_msi - Enable Message Signaled Interrupt (MSI) (default = off)
Matt LaPlante19f59462009-04-27 15:06:31 +0200812 power_save - Automatic power-saving timeout (in second, 0 =
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200813 disable)
Takashi Iwaidee1b662007-08-13 16:10:30 +0200814 power_save_controller - Reset HD-audio controller in power-saving mode
815 (default = on)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100817 This module supports multiple cards and autoprobe.
818
Takashi Iwaicae51172008-12-19 08:36:53 +0100819 See Documentation/sound/alsa/HD-Audio.txt for more details about
820 HD-audio driver.
821
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 Each codec may have a model table for different configurations.
823 If your machine isn't listed there, the default (usually minimal)
824 configuration is set up. You can pass "model=<name>" option to
825 specify a certain model in such a case. There are different
Takashi Iwaicae51172008-12-19 08:36:53 +0100826 models depending on the codec chip. The list of available models
827 is found in HD-Audio-Models.txt
Takashi Iwaidb064e52006-03-16 16:04:58 +0100828
Takashi Iwai6d7b1d72007-02-26 15:56:46 +0100829 The model name "genric" is treated as a special case. When this
830 model is given, the driver uses the generic codec parser without
831 "codec-patch". It's sometimes good for testing and debugging.
832
Takashi Iwai62430082005-09-05 17:12:29 +0200833 If the default configuration doesn't work and one of the above
Takashi Iwai30bc4482008-12-09 08:23:45 +0100834 matches with your device, report it together with alsa-info.sh
835 output (with --no-upload option) to kernel bugzilla or alsa-devel
Takashi Iwai62430082005-09-05 17:12:29 +0200836 ML (see the section "Links and Addresses").
837
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200838 power_save and power_save_controller options are for power-saving
839 mode. See powersave.txt for details.
Takashi Iwaidee1b662007-08-13 16:10:30 +0200840
Takashi Iwaic74db862005-05-12 14:26:27 +0200841 Note 2: If you get click noises on output, try the module option
842 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
843 register value without FIFO size correction as the current
844 DMA pointer. position_fix=2 will make the driver to use
845 the position buffer instead of reading SD_LPIB register.
Michael Kerrisk90f31e32008-09-01 14:03:50 +0200846 (Usually SD_LPIB register is more accurate than the
Takashi Iwaic74db862005-05-12 14:26:27 +0200847 position buffer.)
848
Takashi Iwai27346162006-01-12 18:28:44 +0100849 NB: If you get many "azx_get_response timeout" messages at
850 loading, it's likely a problem of interrupts (e.g. ACPI irq
851 routing). Try to boot with options like "pci=noacpi". Also, you
852 can try "single_cmd=1" module option. This will switch the
853 communication method between HDA controller and codecs to the
854 single immediate commands instead of CORB/RIRB. Basically, the
855 single command mode is provided only for BIOS, and you won't get
856 unsolicited events, too. But, at least, this works independently
857 from the irq. Remember this is a last resort, and should be
858 avoided as much as possible...
859
Takashi Iwai95904742007-05-19 17:06:42 +0200860 MORE NOTES ON "azx_get_response timeout" PROBLEMS:
861 On some hardwares, you may need to add a proper probe_mask option
862 to avoid the "azx_get_response timeout" problem above, instead.
863 This occurs when the access to non-existing or non-working codec slot
864 (likely a modem one) causes a stall of the communication via HD-audio
865 bus. You can see which codec slots are probed by enabling
Takashi Iwai62cf8722008-05-20 12:15:15 +0200866 CONFIG_SND_DEBUG_VERBOSE, or simply from the file name of the codec
Takashi Iwai95904742007-05-19 17:06:42 +0200867 proc files. Then limit the slots to probe by probe_mask option.
868 For example, probe_mask=1 means to probe only the first slot, and
869 probe_mask=4 means only the third slot.
870
Takashi Iwaia4efc232005-11-17 17:24:26 +0100871 The power-management is supported.
872
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 Module snd-hdsp
874 ---------------
875
876 Module for RME Hammerfall DSP audio interface(s)
877
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100878 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879
880 Note: The firmware data can be automatically loaded via hotplug
881 when CONFIG_FW_LOADER is set. Otherwise, you need to load
882 the firmware via hdsploader utility included in alsa-tools
883 package.
884 The firmware data is found in alsa-firmware package.
885
886 Note: snd-page-alloc module does the job which snd-hammerfall-mem
887 module did formerly. It will allocate the buffers in advance
888 when any HDSP cards are found. To make the buffer
889 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +0200890 stage of boot sequence. See "Early Buffer Allocation"
891 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892
Takashi Iwai54704402005-06-03 11:27:00 +0200893 Module snd-hdspm
894 ----------------
895
896 Module for RME HDSP MADI board.
897
898 precise_ptr - Enable precise pointer, or disable.
899 line_outs_monitor - Send playback streams to analog outs by default.
900 enable_monitor - Enable Analog Out on Channel 63/64 by default.
901
902 See hdspm.txt for details.
903
Clemens Ladischc6260262008-01-25 08:41:52 +0100904 Module snd-hifier
905 -----------------
906
907 Module for the MediaTek/TempoTec HiFier Fantasia sound card.
908
909 This module supports autoprobe and multiple cards.
910
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 Module snd-ice1712
912 ------------------
913
914 Module for Envy24 (ICE1712) based PCI sound cards.
915 * MidiMan M Audio Delta 1010
916 * MidiMan M Audio Delta 1010LT
917 * MidiMan M Audio Delta DiO 2496
918 * MidiMan M Audio Delta 66
919 * MidiMan M Audio Delta 44
920 * MidiMan M Audio Delta 410
921 * MidiMan M Audio Audiophile 2496
922 * TerraTec EWS 88MT
923 * TerraTec EWS 88D
924 * TerraTec EWX 24/96
925 * TerraTec DMX 6Fire
Takashi Iwaic9bce912005-05-24 13:41:03 +0200926 * TerraTec Phase 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927 * Hoontech SoundTrack DSP 24
928 * Hoontech SoundTrack DSP 24 Value
929 * Hoontech SoundTrack DSP 24 Media 7.1
Takashi Iwaic9bce912005-05-24 13:41:03 +0200930 * Event Electronics, EZ8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 * Digigram VX442
Takashi Iwaic9bce912005-05-24 13:41:03 +0200932 * Lionstracs, Mediastaton
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400933 * Terrasoniq TS 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934
935 model - Use the given board model, one of the following:
936 delta1010, dio2496, delta66, delta44, audiophile, delta410,
937 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
Takashi Iwaic9bce912005-05-24 13:41:03 +0200938 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
939 phase88, mediastation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 omni - Omni I/O support for MidiMan M-Audio Delta44/66
Matt LaPlantefa00e7e2006-11-30 04:55:36 +0100941 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transceiver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 in msec resolution, default value is 500 (0.5 sec)
943
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100944 This module supports multiple cards and autoprobe. Note: The consumer part
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 is not used with all Envy24 based cards (for example in the MidiMan Delta
946 serie).
947
Takashi Iwaic9bce912005-05-24 13:41:03 +0200948 Note: The supported board is detected by reading EEPROM or PCI
949 SSID (if EEPROM isn't available). You can override the
950 model by passing "model" module option in case that the
951 driver isn't configured properly or you want to try another
952 type for testing.
953
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 Module snd-ice1724
955 ------------------
956
Takashi Iwaic9bce912005-05-24 13:41:03 +0200957 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100958 * MidiMan M Audio Revolution 5.1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 * MidiMan M Audio Revolution 7.1
Takashi Iwai56255062006-11-09 16:47:26 +0100960 * MidiMan M Audio Audiophile 192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 * AMP Ltd AUDIO2000
Takashi Iwaic9bce912005-05-24 13:41:03 +0200962 * TerraTec Aureon 5.1 Sky
963 * TerraTec Aureon 7.1 Space
964 * TerraTec Aureon 7.1 Universe
965 * TerraTec Phase 22
966 * TerraTec Phase 28
967 * AudioTrak Prodigy 7.1
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400968 * AudioTrak Prodigy 7.1 LT
969 * AudioTrak Prodigy 7.1 XT
970 * AudioTrak Prodigy 7.1 HIFI
971 * AudioTrak Prodigy 7.1 HD2
Takashi Iwaic9bce912005-05-24 13:41:03 +0200972 * AudioTrak Prodigy 192
973 * Pontis MS300
974 * Albatron K8X800 Pro II
975 * Chaintech ZNF3-150
976 * Chaintech ZNF3-250
977 * Chaintech 9CJS
Takashi Iwai8cfbbac2005-05-27 12:10:40 +0200978 * Chaintech AV-710
Takashi Iwaic9bce912005-05-24 13:41:03 +0200979 * Shuttle SN25P
Shin-ya Okadaf31639b2007-10-23 15:08:18 +0200980 * Onkyo SE-90PCI
981 * Onkyo SE-200PCI
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400982 * ESI Juli@
Takashi Iwai72cbfd42009-05-06 17:33:19 +0200983 * ESI Maya44
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400984 * Hercules Fortissimo IV
985 * EGO-SYS WaveTerminal 192M
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986
987 model - Use the given board model, one of the following:
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100988 revo51, revo71, amp2000, prodigy71, prodigy71lt,
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400989 prodigy71xt, prodigy71hifi, prodigyhd2, prodigy192,
990 juli, aureon51, aureon71, universe, ap192, k8x800,
991 phase22, phase28, ms300, av710, se200pci, se90pci,
Takashi Iwai72cbfd42009-05-06 17:33:19 +0200992 fortissimo4, sn25p, WT192M, maya44
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100994 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995
Takashi Iwaic9bce912005-05-24 13:41:03 +0200996 Note: The supported board is detected by reading EEPROM or PCI
997 SSID (if EEPROM isn't available). You can override the
998 model by passing "model" module option in case that the
999 driver isn't configured properly or you want to try another
1000 type for testing.
1001
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001002 Module snd-indigo
1003 -----------------
1004
1005 Module for Echoaudio Indigo
1006
1007 This module supports multiple cards.
1008 The driver requires the firmware loader support on kernel.
1009
1010 Module snd-indigodj
1011 -------------------
1012
1013 Module for Echoaudio Indigo DJ
1014
1015 This module supports multiple cards.
1016 The driver requires the firmware loader support on kernel.
1017
1018 Module snd-indigoio
1019 -------------------
1020
1021 Module for Echoaudio Indigo IO
1022
1023 This module supports multiple cards.
1024 The driver requires the firmware loader support on kernel.
1025
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 Module snd-intel8x0
1027 -------------------
1028
1029 Module for AC'97 motherboards from Intel and compatibles.
1030 * Intel i810/810E, i815, i820, i830, i84x, MX440
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001031 ICH5, ICH6, ICH7, 6300ESB, ESB2
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 * SiS 7012 (SiS 735)
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001033 * NVidia NForce, NForce2, NForce3, MCP04, CK804
1034 CK8, CK8S, MCP501
Linus Torvalds1da177e2005-04-16 15:20:36 -07001035 * AMD AMD768, AMD8111
1036 * ALi m5455
1037
1038 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1039 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001040 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 buggy_irq - Enable workaround for buggy interrupts on some
Takashi Iwaia06147d2005-09-08 19:54:17 +02001042 motherboards (default yes on nForce chips,
1043 otherwise off)
1044 buggy_semaphore - Enable workaround for hardwares with buggy
1045 semaphores (e.g. on some ASUS laptops)
1046 (default off)
Takashi Iwai6c5cfd92006-11-28 17:18:25 +01001047 spdif_aclink - Use S/PDIF over AC-link instead of direct connection
1048 from the controller chip
1049 (0 = off, 1 = on, -1 = default)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001051 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052
1053 Note: the latest driver supports auto-detection of chip clock.
1054 if you still encounter too fast playback, specify the clock
1055 explicitly via the module option "ac97_clock=41194".
1056
1057 Joystick/MIDI ports are not supported by this driver. If your
1058 motherboard has these devices, use the ns558 or snd-mpu401
1059 modules, respectively.
1060
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 The power-management is supported.
1062
1063 Module snd-intel8x0m
1064 --------------------
1065
1066 Module for Intel ICH (i8x0) chipset MC97 modems.
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001067 * Intel i810/810E, i815, i820, i830, i84x, MX440
1068 ICH5, ICH6, ICH7
1069 * SiS 7013 (SiS 735)
1070 * NVidia NForce, NForce2, NForce2s, NForce3
1071 * AMD AMD8111
1072 * ALi m5455
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073
1074 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1075
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001076 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077
1078 Note: The default index value of this module is -2, i.e. the first
1079 slot is excluded.
1080
Takashi Iwaia4efc232005-11-17 17:24:26 +01001081 The power-management is supported.
1082
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083 Module snd-interwave
1084 --------------------
1085
1086 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1087 and other sound cards based on AMD InterWave (tm) chip.
1088
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1090 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1091 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1092 effect - 1 = InterWave effects enable (default 0);
1093 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001094 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1095
1096 with isapnp=0, the following options are available:
1097
1098 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1099 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1100 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1101 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001103 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104
1105 Module snd-interwave-stb
1106 ------------------------
1107
1108 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1109 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1110 circuit for extended control of bass, treble and master volume.
1111
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1113 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1114 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1115 effect - 1 = InterWave effects enable (default 0);
1116 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001117 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1118
1119 with isapnp=0, the following options are available:
1120
1121 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1122 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1123 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1124 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1125 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001127 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128
Krzysztof Helt44eba3e2009-12-23 18:02:41 +01001129 Module snd-jazz16
1130 -------------------
1131
1132 Module for Media Vision Jazz16 chipset. The chipset consists of 3 chips:
1133 MVD1216 + MVA416 + MVA514.
1134
1135 port - port # for SB DSP chip (0x210,0x220,0x230,0x240,0x250,0x260)
1136 irq - IRQ # for SB DSP chip (3,5,7,9,10,15)
1137 dma8 - DMA # for SB DSP chip (1,3)
1138 dma16 - DMA # for SB DSP chip (5,7)
1139 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1140 mpu_irq - MPU-401 irq # (2,3,5,7)
1141
1142 This module supports multiple cards.
1143
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144 Module snd-korg1212
1145 -------------------
1146
1147 Module for Korg 1212 IO PCI card
1148
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001149 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001151 Module snd-layla20
1152 ------------------
1153
1154 Module for Echoaudio Layla20
1155
1156 This module supports multiple cards.
1157 The driver requires the firmware loader support on kernel.
1158
1159 Module snd-layla24
1160 ------------------
1161
1162 Module for Echoaudio Layla24
1163
1164 This module supports multiple cards.
1165 The driver requires the firmware loader support on kernel.
1166
Takashi Iwai8338c302009-04-14 12:30:36 +02001167 Module snd-lx6464es
1168 -------------------
1169
1170 Module for Digigram LX6464ES boards
1171
1172 This module supports multiple cards.
1173
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 Module snd-maestro3
1175 -------------------
1176
1177 Module for Allegro/Maestro3 chips
1178
1179 external_amp - enable external amp (enabled by default)
1180 amp_gpio - GPIO pin number for external amp (0-15) or
1181 -1 for default pin (8 for allegro, 1 for
1182 others)
1183
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001184 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185
1186 Note: the binding of amplifier is dependent on hardware.
1187 If there is no sound even though all channels are unmuted, try to
1188 specify other gpio connection via amp_gpio option.
1189 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1190 option.
1191
1192 The power-management is supported.
1193
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001194 Module snd-mia
1195 ---------------
1196
1197 Module for Echoaudio Mia
1198
1199 This module supports multiple cards.
1200 The driver requires the firmware loader support on kernel.
1201
Martin Langer1841f6132006-03-27 12:41:01 +02001202 Module snd-miro
1203 ---------------
1204
1205 Module for Miro soundcards: miroSOUND PCM 1 pro,
1206 miroSOUND PCM 12,
1207 miroSOUND PCM 20 Radio.
1208
1209 port - Port # (0x530,0x604,0xe80,0xf40)
1210 irq - IRQ # (5,7,9,10,11)
1211 dma1 - 1st dma # (0,1,3)
1212 dma2 - 2nd dma # (0,1)
1213 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1214 mpu_irq - MPU-401 irq # (5,7,9,10)
1215 fm_port - FM Port # (0x388)
1216 wss - enable WSS mode
1217 ide - enable onboard ide support
1218
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 Module snd-mixart
1220 -----------------
1221
1222 Module for Digigram miXart8 sound cards.
1223
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001224 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001225 Note: One miXart8 board will be represented as 4 alsa cards.
1226 See MIXART.txt for details.
1227
1228 When the driver is compiled as a module and the hotplug firmware
1229 is supported, the firmware data is loaded via hotplug automatically.
1230 Install the necessary firmware files in alsa-firmware package.
1231 When no hotplug fw loader is available, you need to load the
1232 firmware via mixartloader utility in alsa-tools package.
1233
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001234 Module snd-mona
1235 ---------------
1236
1237 Module for Echoaudio Mona
1238
1239 This module supports multiple cards.
1240 The driver requires the firmware loader support on kernel.
1241
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 Module snd-mpu401
1243 -----------------
1244
1245 Module for MPU-401 UART devices.
1246
1247 port - port number or -1 (disable)
1248 irq - IRQ number or -1 (disable)
1249 pnp - PnP detection - 0 = disable, 1 = enable (default)
1250
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001251 This module supports multiple devices and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252
Takashi Iwaic96330b2009-01-28 08:23:03 +01001253 Module snd-msnd-classic
1254 -----------------------
1255
1256 Module for Turtle Beach MultiSound Classic, Tahiti or Monterey
1257 soundcards.
1258
1259 io - Port # for msnd-classic card
1260 irq - IRQ # for msnd-classic card
1261 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1262 0xe0000 or 0xe8000)
1263 write_ndelay - enable write ndelay (default = 1)
1264 calibrate_signal - calibrate signal (default = 0)
1265 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1266 digital - Digital daughterboard present (default = 0)
1267 cfg - Config port (0x250, 0x260 or 0x270) default = PnP
1268 reset - Reset all devices
1269 mpu_io - MPU401 I/O port
1270 mpu_irq - MPU401 irq#
1271 ide_io0 - IDE port #0
1272 ide_io1 - IDE port #1
1273 ide_irq - IDE irq#
1274 joystick_io - Joystick I/O port
1275
1276 The driver requires firmware files "turtlebeach/msndinit.bin" and
1277 "turtlebeach/msndperm.bin" in the proper firmware directory.
1278
1279 See Documentation/sound/oss/MultiSound for important information
1280 about this driver. Note that it has been discontinued, but the
1281 Voyetra Turtle Beach knowledge base entry for it is still available
1282 at
1283 http://www.turtlebeach.com/site/kb_ftp/790.asp
1284
1285 Module snd-msnd-pinnacle
1286 ------------------------
1287
1288 Module for Turtle Beach MultiSound Pinnacle/Fiji soundcards.
1289
1290 io - Port # for pinnacle/fiji card
1291 irq - IRQ # for pinnalce/fiji card
1292 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1293 0xe0000 or 0xe8000)
1294 write_ndelay - enable write ndelay (default = 1)
1295 calibrate_signal - calibrate signal (default = 0)
1296 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1297
1298 The driver requires firmware files "turtlebeach/pndspini.bin" and
1299 "turtlebeach/pndsperm.bin" in the proper firmware directory.
1300
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301 Module snd-mtpav
1302 ----------------
1303
1304 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1305 port).
1306
1307 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1308 irq - IRQ # for MTPAV (7,5, default=7)
1309 hwports - number of supported hardware ports, default=8.
1310
1311 Module supports only 1 card. This module has no enable option.
1312
Matthias Koenig68ab8012006-07-27 16:59:23 +02001313 Module snd-mts64
1314 ----------------
1315
1316 Module for Ego Systems (ESI) Miditerminal 4140
1317
1318 This module supports multiple devices.
1319 Requires parport (CONFIG_PARPORT).
1320
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 Module snd-nm256
1322 ----------------
1323
1324 Module for NeoMagic NM256AV/ZX chips
1325
1326 playback_bufsize - max playback frame size in kB (4-128kB)
1327 capture_bufsize - max capture frame size in kB (4-128kB)
1328 force_ac97 - 0 or 1 (disabled by default)
1329 buffer_top - specify buffer top address
1330 use_cache - 0 or 1 (disabled by default)
1331 vaio_hack - alias buffer_top=0x25a800
1332 reset_workaround - enable AC97 RESET workaround for some laptops
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001333 reset_workaround2 - enable extended AC97 RESET workaround for some
1334 other laptops
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +02001336 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337
1338 The power-management is supported.
1339
1340 Note: on some notebooks the buffer address cannot be detected
1341 automatically, or causes hang-up during initialization.
Matt LaPlantefff92892006-10-03 22:47:42 +02001342 In such a case, specify the buffer top address explicitly via
1343 the buffer_top option.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 For example,
1345 Sony F250: buffer_top=0x25a800
1346 Sony F270: buffer_top=0x272800
1347 The driver supports only ac97 codec. It's possible to force
1348 to initialize/use ac97 although it's not detected. In such a
1349 case, use force_ac97=1 option - but *NO* guarantee whether it
1350 works!
1351
1352 Note: The NM256 chip can be linked internally with non-AC97
1353 codecs. This driver supports only the AC97 codec, and won't work
1354 with machines with other (most likely CS423x or OPL3SAx) chips,
1355 even though the device is detected in lspci. In such a case, try
1356 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
Takashi Iwai62430082005-09-05 17:12:29 +02001357 but some doesn't have ISA PnP. You'll need to specify isapnp=0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 and proper hardware parameters in the case without ISA PnP.
1359
1360 Note: some laptops need a workaround for AC97 RESET. For the
1361 known hardware like Dell Latitude LS and Sony PCG-F305, this
1362 workaround is enabled automatically. For other laptops with a
1363 hard freeze, you can try reset_workaround=1 option.
1364
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001365 Note: Dell Latitude CSx laptops have another problem regarding
1366 AC97 RESET. On these laptops, reset_workaround2 option is
1367 turned on as default. This option is worth to try if the
1368 previous reset_workaround option doesn't help.
1369
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 Note: This driver is really crappy. It's a porting from the
1371 OSS driver, which is a result of black-magic reverse engineering.
1372 The detection of codec will fail if the driver is loaded *after*
1373 X-server as described above. You might be able to force to load
1374 the module, but it may result in hang-up. Hence, make sure that
1375 you load this module *before* X if you encounter this kind of
1376 problem.
1377
1378 Module snd-opl3sa2
1379 ------------------
1380
1381 Module for Yamaha OPL3-SA2/SA3 sound cards.
1382
Rene Herman64e0e2d2007-12-13 16:29:33 +01001383 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1384
1385 with isapnp=0, the following options are available:
1386
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 port - control port # for OPL3-SA chip (0x370)
1388 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1389 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1390 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1391 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1392 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1393 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1394 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001396 This module supports multiple cards and ISA PnP. It does not support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1398
1399 The power-management is supported.
1400
1401 Module snd-opti92x-ad1848
1402 -------------------------
1403
1404 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1405 Module works with OAK Mozart cards as well.
1406
Rene Herman64e0e2d2007-12-13 16:29:33 +01001407 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1408
1409 with isapnp=0, the following options are available:
1410
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1412 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1413 fm_port - port # for OPL3 device (0x388)
1414 irq - IRQ # for WSS chip (5,7,9,10,11)
1415 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1416 dma1 - first DMA # for WSS chip (0,1,3)
1417
1418 This module supports only one card, autoprobe and PnP.
1419
1420 Module snd-opti92x-cs4231
1421 -------------------------
1422
1423 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1424
Rene Herman64e0e2d2007-12-13 16:29:33 +01001425 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1426
1427 with isapnp=0, the following options are available:
1428
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1430 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1431 fm_port - port # for OPL3 device (0x388)
1432 irq - IRQ # for WSS chip (5,7,9,10,11)
1433 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1434 dma1 - first DMA # for WSS chip (0,1,3)
1435 dma2 - second DMA # for WSS chip (0,1,3)
1436
1437 This module supports only one card, autoprobe and PnP.
1438
1439 Module snd-opti93x
1440 ------------------
1441
1442 Module for sound cards based on OPTi 82c93x chips.
1443
Rene Herman64e0e2d2007-12-13 16:29:33 +01001444 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1445
1446 with isapnp=0, the following options are available:
1447
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1449 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1450 fm_port - port # for OPL3 device (0x388)
1451 irq - IRQ # for WSS chip (5,7,9,10,11)
1452 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1453 dma1 - first DMA # for WSS chip (0,1,3)
1454 dma2 - second DMA # for WSS chip (0,1,3)
1455
1456 This module supports only one card, autoprobe and PnP.
1457
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001458 Module snd-oxygen
1459 -----------------
1460
1461 Module for sound cards based on the C-Media CMI8788 chip:
1462 * Asound A-8788
1463 * AuzenTech X-Meridian
1464 * Bgears b-Enspirer
1465 * Club3D Theatron DTS
Clemens Ladischde04b102008-11-26 10:37:23 +01001466 * HT-Omega Claro (plus)
1467 * HT-Omega Claro halo (XT)
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001468 * Razer Barracuda AC-1
1469 * Sondigo Inferno
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001470
1471 This module supports autoprobe and multiple cards.
1472
Stas Sergeevd08cd582008-03-06 11:01:44 +01001473 Module snd-pcsp
1474 -----------------
1475
1476 Module for internal PC-Speaker.
1477
Stas Sergeevbcc2c6b2009-11-01 11:13:19 +01001478 nopcm - Disable PC-Speaker PCM sound. Only beeps remain.
Stas Sergeevd08cd582008-03-06 11:01:44 +01001479 nforce_wa - enable NForce chipset workaround. Expect bad sound.
1480
1481 This module supports system beeps, some kind of PCM playback and
1482 even a few mixer controls.
1483
Markus Bollingere12229b2005-12-06 13:55:26 +01001484 Module snd-pcxhr
1485 ----------------
1486
1487 Module for Digigram PCXHR boards
1488
1489 This module supports multiple cards.
1490
Matthias Koenig757e1192007-01-25 13:15:05 +01001491 Module snd-portman2x4
1492 ---------------------
1493
1494 Module for Midiman Portman 2x4 parallel port MIDI interface
1495
1496 This module supports multiple cards.
1497
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 Module snd-powermac (on ppc only)
1499 ---------------------------------
1500
1501 Module for PowerMac, iMac and iBook on-board soundchips
1502
1503 enable_beep - enable beep using PCM (enabled as default)
1504
1505 Module supports autoprobe a chip.
1506
1507 Note: the driver may have problems regarding endianess.
1508
1509 The power-management is supported.
1510
Takashi Iwai2c484df2005-06-30 18:54:04 +02001511 Module snd-pxa2xx-ac97 (on arm only)
1512 ------------------------------------
1513
1514 Module for AC97 driver for the Intel PXA2xx chip
1515
1516 For ARM architecture only.
1517
Takashi Iwaia4efc232005-11-17 17:24:26 +01001518 The power-management is supported.
1519
Peter Gruber109a9632006-03-27 13:10:28 +02001520 Module snd-riptide
1521 ------------------
1522
1523 Module for Conexant Riptide chip
1524
1525 joystick_port - Joystick port # (default: 0x200)
1526 mpu_port - MPU401 port # (default: 0x330)
1527 opl3_port - OPL3 port # (default: 0x388)
1528
1529 This module supports multiple cards.
1530 The driver requires the firmware loader support on kernel.
1531 You need to install the firmware file "riptide.hex" to the standard
1532 firmware path (e.g. /lib/firmware).
1533
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 Module snd-rme32
1535 ----------------
1536
1537 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1538 Prodif96 and Prodif Gold) sound cards.
1539
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001540 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541
1542 Module snd-rme96
1543 ----------------
1544
1545 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1546
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001547 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548
1549 Module snd-rme9652
1550 ------------------
1551
1552 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1553
1554 precise_ptr - Enable precise pointer (doesn't work reliably).
1555 (default = 0)
1556
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001557 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558
1559 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1560 module did formerly. It will allocate the buffers in advance
1561 when any RME9652 cards are found. To make the buffer
1562 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +02001563 stage of boot sequence. See "Early Buffer Allocation"
1564 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565
1566 Module snd-sa11xx-uda1341 (on arm only)
1567 ---------------------------------------
1568
1569 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1570
1571 Module supports only one card.
1572 Module has no enable and index options.
1573
Takashi Iwaia4efc232005-11-17 17:24:26 +01001574 The power-management is supported.
1575
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576 Module snd-sb8
1577 --------------
1578
1579 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1580 SoundBlaster 2.0,
1581 SoundBlaster Pro
1582
1583 port - port # for SB DSP chip (0x220,0x240,0x260)
1584 irq - IRQ # for SB DSP chip (5,7,9,10)
1585 dma8 - DMA # for SB DSP chip (1,3)
1586
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001587 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588
Takashi Iwaia4efc232005-11-17 17:24:26 +01001589 The power-management is supported.
1590
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591 Module snd-sb16 and snd-sbawe
1592 -----------------------------
1593
1594 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1595 SoundBlaster AWE 32 (PnP),
1596 SoundBlaster AWE 64 PnP
1597
Rene Herman64e0e2d2007-12-13 16:29:33 +01001598 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1599 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1600 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1601
1602 with isapnp=0, the following options are available:
1603
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1605 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1606 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1607 (snd-sbawe module only)
1608 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1609 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1610 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001612 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613
1614 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1615 disable 16bit DMA with dma16 = -1 module parameter.
1616 Also, all Sound Blaster 16 type cards can operate in 16-bit
1617 half duplex mode through 8-bit DMA channel by disabling their
1618 16-bit DMA channel.
1619
Takashi Iwaia4efc232005-11-17 17:24:26 +01001620 The power-management is supported.
1621
Takashi Iwai074a6e92007-09-11 22:10:14 +02001622 Module snd-sc6000
1623 -----------------
1624
Krzysztof Heltb0ec3a32009-05-03 10:39:19 +02001625 Module for Gallant SC-6000 soundcard and later models: SC-6600
1626 and SC-7000.
Takashi Iwai074a6e92007-09-11 22:10:14 +02001627
1628 port - Port # (0x220 or 0x240)
1629 mss_port - MSS Port # (0x530 or 0xe80)
1630 irq - IRQ # (5,7,9,10,11)
Krzysztof Helt7b758d22007-09-17 14:42:49 +02001631 mpu_irq - MPU-401 IRQ # (5,7,9,10) ,0 - no MPU-401 irq
Takashi Iwai074a6e92007-09-11 22:10:14 +02001632 dma - DMA # (1,3,0)
Krzysztof Heltb0ec3a32009-05-03 10:39:19 +02001633 joystick - Enable gameport - 0 = disable (default), 1 = enable
Takashi Iwai074a6e92007-09-11 22:10:14 +02001634
1635 This module supports multiple cards.
1636
1637 This card is also known as Audio Excel DSP 16 or Zoltrix AV302.
1638
Linus Torvalds1da177e2005-04-16 15:20:36 -07001639 Module snd-sgalaxy
1640 ------------------
1641
1642 Module for Aztech Sound Galaxy sound card.
1643
1644 sbport - Port # for SB16 interface (0x220,0x240)
1645 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1646 irq - IRQ # (7,9,10,11)
1647 dma1 - DMA #
1648
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001649 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650
Takashi Iwaia4efc232005-11-17 17:24:26 +01001651 The power-management is supported.
1652
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 Module snd-sscape
1654 -----------------
1655
Krzysztof Heltacd471002009-10-01 00:10:34 +02001656 Module for ENSONIQ SoundScape cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657
1658 port - Port # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001659 wss_port - WSS Port # (PnP setup)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 irq - IRQ # (PnP setup)
1661 mpu_irq - MPU-401 IRQ # (PnP setup)
1662 dma - DMA # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001663 dma2 - 2nd DMA # (PnP setup, -1 to disable)
Krzysztof Helt1cb0fde2009-10-05 18:18:57 +02001664 joystick - Enable gameport - 0 = disable (default), 1 = enable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665
Krzysztof Heltacd471002009-10-01 00:10:34 +02001666 This module supports multiple cards.
1667
1668 The driver requires the firmware loader support on kernel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669
1670 Module snd-sun-amd7930 (on sparc only)
1671 --------------------------------------
1672
1673 Module for AMD7930 sound chips found on Sparcs.
1674
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001675 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676
1677 Module snd-sun-cs4231 (on sparc only)
1678 -------------------------------------
1679
1680 Module for CS4231 sound chips found on Sparcs.
1681
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001682 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001684 Module snd-sun-dbri (on sparc only)
1685 -----------------------------------
1686
1687 Module for DBRI sound chips found on Sparcs.
1688
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001689 This module supports multiple cards.
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001690
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691 Module snd-wavefront
1692 --------------------
1693
1694 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1695
Rene Herman64e0e2d2007-12-13 16:29:33 +01001696 use_cs4232_midi - Use CS4232 MPU-401 interface
1697 (inaccessibly located inside your computer)
1698 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1699
1700 with isapnp=0, the following options are available:
1701
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702 cs4232_pcm_port - Port # for CS4232 PCM interface.
1703 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1704 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1705 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 ics2115_port - Port # for ICS2115
1707 ics2115_irq - IRQ # for ICS2115
1708 fm_port - FM OPL-3 Port #
1709 dma1 - DMA1 # for CS4232 PCM interface.
1710 dma2 - DMA2 # for CS4232 PCM interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711
Takashi Iwaic2b12392007-08-21 15:20:26 +02001712 The below are options for wavefront_synth features:
1713 wf_raw - Assume that we need to boot the OS (default:no)
1714 If yes, then during driver loading, the state of the board is
1715 ignored, and we reset the board and load the firmware anyway.
1716 fx_raw - Assume that the FX process needs help (default:yes)
1717 If false, we'll leave the FX processor in whatever state it is
1718 when the driver is loaded. The default is to download the
1719 microprogram and associated coefficients to set it up for
1720 "default" operation, whatever that means.
1721 debug_default - Debug parameters for card initialization
1722 wait_usecs - How long to wait without sleeping, usecs
1723 (default:150)
1724 This magic number seems to give pretty optimal throughput
1725 based on my limited experimentation.
1726 If you want to play around with it and find a better value, be
1727 my guest. Remember, the idea is to get a number that causes us
1728 to just busy wait for as many WaveFront commands as possible,
1729 without coming up with a number so large that we hog the whole
1730 CPU.
1731 Specifically, with this number, out of about 134,000 status
1732 waits, only about 250 result in a sleep.
1733 sleep_interval - How long to sleep when waiting for reply
1734 (default: 100)
1735 sleep_tries - How many times to try sleeping during a wait
1736 (default: 50)
1737 ospath - Pathname to processed ICS2115 OS firmware
1738 (default:wavefront.os)
1739 The path name of the ISC2115 OS firmware. In the recent
1740 version, it's handled via firmware loader framework, so it
1741 must be installed in the proper path, typically,
1742 /lib/firmware.
1743 reset_time - How long to wait for a reset to take effect
1744 (default:2)
1745 ramcheck_time - How many seconds to wait for the RAM test
1746 (default:20)
1747 osrun_time - How many seconds to wait for the ICS2115 OS
1748 (default:10)
1749
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001750 This module supports multiple cards and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751
Takashi Iwaic2b12392007-08-21 15:20:26 +02001752 Note: the firmware file "wavefront.os" was located in the earlier
1753 version in /etc. Now it's loaded via firmware loader, and
1754 must be in the proper firmware path, such as /lib/firmware.
1755 Copy (or symlink) the file appropriately if you get an error
1756 regarding firmware downloading after upgrading the kernel.
1757
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 Module snd-sonicvibes
1759 ---------------------
1760
1761 Module for S3 SonicVibes PCI sound cards.
1762 * PINE Schubert 32 PCI
1763
1764 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1765 - SoundCard must have onboard SRAM for this.
1766 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1767
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001768 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769
1770 Module snd-serial-u16550
1771 ------------------------
1772
1773 Module for UART16550A serial MIDI ports.
1774
1775 port - port # for UART16550A chip
1776 irq - IRQ # for UART16550A chip, -1 = poll mode
1777 speed - speed in bauds (9600,19200,38400,57600,115200)
1778 38400 = default
1779 base - base for divisor in bauds (57600,115200,230400,460800)
1780 115200 = default
1781 outs - number of MIDI ports in a serial port (1-4)
1782 1 = default
1783 adaptor - Type of adaptor.
1784 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1785 3 = MS-124W M/B, 4 = Generic
1786
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001787 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788 thus the main port must be specified!!! Other options are optional.
1789
1790 Module snd-trident
1791 ------------------
1792
1793 Module for Trident 4DWave DX/NX sound cards.
1794 * Best Union Miss Melody 4DWave PCI
1795 * HIS 4DWave PCI
1796 * Warpspeed ONSpeed 4DWave PCI
1797 * AzTech PCI 64-Q3D
1798 * Addonics SV 750
1799 * CHIC True Sound 4Dwave
1800 * Shark Predator4D-PCI
1801 * Jaton SonicWave 4D
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001802 * SiS SI7018 PCI Audio
1803 * Hoontech SoundTrack Digital 4DWave NX
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804
1805 pcm_channels - max channels (voices) reserved for PCM
1806 wavetable_size - max wavetable size in kB (4-?kb)
1807
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001808 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809
1810 The power-management is supported.
1811
Clemens Ladisch63978ab2009-12-14 12:48:35 +01001812 Module snd-ua101
1813 ----------------
1814
1815 Module for the Edirol UA-101 audio/MIDI interface.
1816
1817 This module supports multiple devices, autoprobe and hotplugging.
1818
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819 Module snd-usb-audio
1820 --------------------
1821
1822 Module for USB audio and USB MIDI devices.
1823
1824 vid - Vendor ID for the device (optional)
1825 pid - Product ID for the device (optional)
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001826 nrpacks - Max. number of packets per URB (default: 8)
1827 async_unlink - Use async unlink mode (default: yes)
Thibault LE MEURe3113342006-03-14 11:44:53 +01001828 device_setup - Device specific magic number (optional)
1829 - Influence depends on the device
1830 - Default: 0x0000
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001831 ignore_ctl_error - Ignore any USB-controller regarding mixer
1832 interface (default: no)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001834 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001836 NB: nrpacks parameter can be modified dynamically via sysfs.
1837 Don't put the value over 20. Changing via sysfs has no sanity
1838 check.
1839 NB: async_unlink=0 would cause Oops. It remains just for
1840 debugging purpose (if any).
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001841 NB: ignore_ctl_error=1 may help when you get an error at accessing
1842 the mixer element such as URB error -22. This happens on some
1843 buggy USB device or the controller.
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001844
Daniel Mack523f1dc2007-03-26 19:11:24 +02001845 Module snd-usb-caiaq
1846 --------------------
1847
1848 Module for caiaq UB audio interfaces,
1849 * Native Instruments RigKontrol2
1850 * Native Instruments Kore Controller
1851 * Native Instruments Audio Kontrol 1
1852 * Native Instruments Audio 8 DJ
1853
1854 This module supports multiple devices, autoprobe and hotplugging.
1855
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 Module snd-usb-usx2y
1857 --------------------
1858
1859 Module for Tascam USB US-122, US-224 and US-428 devices.
1860
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001861 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862
1863 Note: you need to load the firmware via usx2yloader utility included
1864 in alsa-tools and alsa-firmware packages.
1865
1866 Module snd-via82xx
1867 ------------------
1868
1869 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001870 8233A, 8233C, 8235, 8237 (south) bridge.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871
1872 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1873 [VIA686A/686B only]
1874 joystick - Enable joystick (default off) [VIA686A/686B only]
1875 ac97_clock - AC'97 codec clock base (default 48000Hz)
1876 dxs_support - support DXS channels,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001877 0 = auto (default), 1 = enable, 2 = disable,
1878 3 = 48k only, 4 = no VRA, 5 = enable any sample
1879 rate and different sample rates on different
1880 channels
1881 [VIA8233/C, 8235, 8237 only]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001883 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001885 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886
1887 Note: on some SMP motherboards like MSI 694D the interrupts might
1888 not be generated properly. In such a case, please try to
1889 set the SMP (or MPS) version on BIOS to 1.1 instead of
1890 default value 1.4. Then the interrupt number will be
1891 assigned under 15. You might also upgrade your BIOS.
1892
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001893 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894 channels as the first PCM. On these channels, up to 4
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001895 streams can be played at the same time, and the controller
1896 can perform sample rate conversion with separate rates for
1897 each channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 As default (dxs_support = 0), 48k fixed rate is chosen
1899 except for the known devices since the output is often
1900 noisy except for 48k on some mother boards due to the
1901 bug of BIOS.
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001902 Please try once dxs_support=5 and if it works on other
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1904 know the PCI subsystem vendor/device id's (output of
1905 "lspci -nv").
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001906 If dxs_support=5 does not work, try dxs_support=4; if it
1907 doesn't work too, try dxs_support=1. (dxs_support=1 is
Takashi Iwai62430082005-09-05 17:12:29 +02001908 usually for old motherboards. The correct implemented
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001909 board should work with 4 or 5.) If it still doesn't
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 work and the default setting is ok, dxs_support=3 is the
1911 right choice. If the default setting doesn't work at all,
1912 try dxs_support=2 to disable the DXS channels.
1913 In any cases, please let us know the result and the
Takashi Iwai62430082005-09-05 17:12:29 +02001914 subsystem vendor/device ids. See "Links and Addresses"
1915 below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916
1917 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Takashi Iwai62430082005-09-05 17:12:29 +02001918 additionally. The mpu_port option is for VIA686 chips only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919
Takashi Iwaia4efc232005-11-17 17:24:26 +01001920 The power-management is supported.
1921
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922 Module snd-via82xx-modem
1923 ------------------------
1924
1925 Module for VIA82xx AC97 modem
1926
1927 ac97_clock - AC'97 codec clock base (default 48000Hz)
1928
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001929 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930
1931 Note: The default index value of this module is -2, i.e. the first
1932 slot is excluded.
1933
Takashi Iwaia4efc232005-11-17 17:24:26 +01001934 The power-management is supported.
1935
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 Module snd-virmidi
1937 ------------------
1938
1939 Module for virtual rawmidi devices.
1940 This module creates virtual rawmidi devices which communicate
1941 to the corresponding ALSA sequencer ports.
1942
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001943 midi_devs - MIDI devices # (1-4, default=4)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001945 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001947 Module snd-virtuoso
1948 -------------------
1949
Clemens Ladisch5430c722008-07-28 10:28:43 +02001950 Module for sound cards based on the Asus AV100/AV200 chips,
Clemens Ladisch04f98902009-05-25 10:11:29 +02001951 i.e., Xonar D1, DX, D2, D2X, HDAV1.3 (Deluxe), Essence ST
1952 (Deluxe) and Essence STX.
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001953
1954 This module supports autoprobe and multiple cards.
1955
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 Module snd-vx222
1957 ----------------
1958
1959 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1960
1961 mic - Enable Microphone on V222 Mic (NYI)
1962 ibl - Capture IBL size. (default = 0, minimum size)
1963
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001964 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965
1966 When the driver is compiled as a module and the hotplug firmware
1967 is supported, the firmware data is loaded via hotplug automatically.
1968 Install the necessary firmware files in alsa-firmware package.
1969 When no hotplug fw loader is available, you need to load the
1970 firmware via vxloader utility in alsa-tools package. To invoke
1971 vxloader automatically, add the following to /etc/modprobe.conf
1972
1973 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1974
1975 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1976 /etc/modules.conf, instead.)
1977 IBL size defines the interrupts period for PCM. The smaller size
1978 gives smaller latency but leads to more CPU consumption, too.
1979 The size is usually aligned to 126. As default (=0), the smallest
1980 size is chosen. The possible IBL values can be found in
1981 /proc/asound/cardX/vx-status proc file.
1982
Takashi Iwaia4efc232005-11-17 17:24:26 +01001983 The power-management is supported.
1984
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985 Module snd-vxpocket
1986 -------------------
1987
Takashi Iwai6d00a312005-06-30 13:40:51 +02001988 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989
1990 ibl - Capture IBL size. (default = 0, minimum size)
1991
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001992 This module supports multiple cards. The module is compiled only when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993 PCMCIA is supported on kernel.
1994
Takashi Iwai62430082005-09-05 17:12:29 +02001995 With the older 2.6.x kernel, to activate the driver via the card
1996 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1997 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1998 longer require a config file.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999
2000 When the driver is compiled as a module and the hotplug firmware
2001 is supported, the firmware data is loaded via hotplug automatically.
2002 Install the necessary firmware files in alsa-firmware package.
2003 When no hotplug fw loader is available, you need to load the
2004 firmware via vxloader utility in alsa-tools package.
2005
2006 About capture IBL, see the description of snd-vx222 module.
2007
Takashi Iwaied7cbe32006-05-11 11:30:10 +02002008 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
Takashi Iwai62430082005-09-05 17:12:29 +02002009 ALSA 1.0.10.
2010
Takashi Iwaia4efc232005-11-17 17:24:26 +01002011 The power-management is supported.
2012
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013 Module snd-ymfpci
2014 -----------------
2015
2016 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
2017
2018 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
2019 1 (auto-detect for YMF744/754 only)
2020 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
2021 1 (auto-detect for YMF744/754 only)
2022 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
2023 1 (auto-detect)
2024 rear_switch - enable shared rear/line-in switch (bool)
2025
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01002026 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027
2028 The power-management is supported.
2029
2030 Module snd-pdaudiocf
2031 --------------------
2032
2033 Module for Sound Core PDAudioCF sound card.
2034
Takashi Iwaia4efc232005-11-17 17:24:26 +01002035 The power-management is supported.
2036
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037
Takashi Iwai62430082005-09-05 17:12:29 +02002038AC97 Quirk Option
2039=================
2040
2041The ac97_quirk option is used to enable/override the workaround for
2042specific devices on drivers for on-board AC'97 controllers like
2043snd-intel8x0. Some hardware have swapped output pins between Master
2044and Headphone, or Surround (thanks to confusion of AC'97
2045specifications from version to version :-)
2046
2047The driver provides the auto-detection of known problematic devices,
2048but some might be unknown or wrongly detected. In such a case, pass
2049the proper value with this option.
2050
2051The following strings are accepted:
2052 - default Don't override the default setting
Takashi Iwai10e4097f2005-11-17 11:04:55 +01002053 - none Disable the quirk
Takashi Iwai62430082005-09-05 17:12:29 +02002054 - hp_only Bind Master and Headphone controls as a single control
2055 - swap_hp Swap headphone and master controls
2056 - swap_surround Swap master and surround controls
2057 - ad_sharing For AD1985, turn on OMS bit and use headphone
2058 - alc_jack For ALC65x, turn on the jack sense mode
2059 - inv_eapd Inverted EAPD implementation
2060 - mute_led Bind EAPD bit for turning on/off mute LED
2061
2062For backward compatibility, the corresponding integer value -1, 0,
2063... are accepted, too.
2064
2065For example, if "Master" volume control has no effect on your device
2066but only "Headphone" does, pass ac97_quirk=hp_only module option.
2067
2068
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069Configuring Non-ISAPNP Cards
2070============================
2071
2072When the kernel is configured with ISA-PnP support, the modules
2073supporting the isapnp cards will have module options "isapnp".
2074If this option is set, *only* the ISA-PnP devices will be probed.
2075For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
2076together with the proper i/o and irq configuration.
2077
2078When the kernel is configured without ISA-PnP support, isapnp option
2079will be not built in.
2080
2081
2082Module Autoloading Support
2083==========================
2084
2085The ALSA drivers can be loaded automatically on demand by defining
2086module aliases. The string 'snd-card-%1' is requested for ALSA native
2087devices where %i is sound card number from zero to seven.
2088
2089To auto-load an ALSA driver for OSS services, define the string
2090'sound-slot-%i' where %i means the slot number for OSS, which
2091corresponds to the card index of ALSA. Usually, define this
Tobias Klauserd533f672005-09-10 00:26:46 -07002092as the same card module.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093
2094An example configuration for a single emu10k1 card is like below:
2095----- /etc/modprobe.conf
2096alias snd-card-0 snd-emu10k1
2097alias sound-slot-0 snd-emu10k1
2098----- /etc/modprobe.conf
2099
2100The available number of auto-loaded sound cards depends on the module
2101option "cards_limit" of snd module. As default it's set to 1.
2102To enable the auto-loading of multiple cards, specify the number of
2103sound cards in that option.
2104
2105When multiple cards are available, it'd better to specify the index
2106number for each card via module option, too, so that the order of
2107cards is kept consistent.
2108
2109An example configuration for two sound cards is like below:
2110
2111----- /etc/modprobe.conf
2112# ALSA portion
2113options snd cards_limit=2
2114alias snd-card-0 snd-interwave
2115alias snd-card-1 snd-ens1371
2116options snd-interwave index=0
2117options snd-ens1371 index=1
2118# OSS/Free portion
2119alias sound-slot-0 snd-interwave
2120alias sound-slot-1 snd-ens1371
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02002121----- /etc/modprobe.conf
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122
2123In this example, the interwave card is always loaded as the first card
2124(index 0) and ens1371 as the second (index 1).
2125
Takashi Iwai304cd072007-10-26 15:10:15 +02002126Alternative (and new) way to fixate the slot assignment is to use
2127"slots" option of snd module. In the case above, specify like the
2128following:
2129
2130options snd slots=snd-interwave,snd-ens1371
2131
2132Then, the first slot (#0) is reserved for snd-interwave driver, and
2133the second (#1) for snd-ens1371. You can omit index option in each
2134driver if slots option is used (although you can still have them at
2135the same time as long as they don't conflict).
2136
2137The slots option is especially useful for avoiding the possible
2138hot-plugging and the resultant slot conflict. For example, in the
2139case above again, the first two slots are already reserved. If any
2140other driver (e.g. snd-usb-audio) is loaded before snd-interwave or
2141snd-ens1371, it will be assigned to the third or later slot.
2142
Takashi Iwaia93bbaa2008-05-27 17:59:24 +02002143When a module name is given with '!', the slot will be given for any
2144modules but that name. For example, "slots=!snd-pcsp" will reserve
2145the first slot for any modules but snd-pcsp.
2146
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147
2148ALSA PCM devices to OSS devices mapping
2149=======================================
2150
2151/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
2152/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
2153/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
2154/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
2155/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
2156/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
2157/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
2158/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
2159/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
2160
2161The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
2162sound card number and second means device number. The ALSA devices
2163have either 'c' or 'p' suffix indicating the direction, capture and
2164playback, respectively.
2165
2166Please note that the device mapping above may be varied via the module
2167options of snd-pcm-oss module.
2168
2169
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170Proc interfaces (/proc/asound)
2171==============================
2172
2173/proc/asound/card#/pcm#[cp]/oss
2174-------------------------------
2175 String "erase" - erase all additional informations about OSS applications
2176 String "<app_name> <fragments> <fragment_size> [<options>]"
2177
2178 <app_name> - name of application with (higher priority) or without path
2179 <fragments> - number of fragments or zero if auto
2180 <fragment_size> - size of fragment in bytes or zero if auto
2181 <options> - optional parameters
2182 - disable the application tries to open a pcm device for
2183 this channel but does not want to use it.
2184 (Cause a bug or mmap needs)
2185 It's good for Quake etc...
2186 - direct don't use plugins
2187 - block force block mode (rvplayer)
2188 - non-block force non-block mode
2189 - whole-frag write only whole fragments (optimization affecting
2190 playback only)
2191 - no-silence do not fill silence ahead to avoid clicks
Takashi Iwai10f69f92005-09-08 13:48:34 +02002192 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
2193 instead of filled blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194
2195 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
2196 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
2197 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
2198
2199
Takashi Iwaib6a96912005-05-30 18:27:03 +02002200Early Buffer Allocation
2201=======================
2202
2203Some drivers (e.g. hdsp) require the large contiguous buffers, and
2204sometimes it's too late to find such spaces when the driver module is
2205actually loaded due to memory fragmentation. You can pre-allocate the
2206PCM buffers by loading snd-page-alloc module and write commands to its
2207proc file in prior, for example, in the early boot stage like
2208/etc/init.d/*.local scripts.
2209
2210Reading the proc file /proc/drivers/snd-page-alloc shows the current
2211usage of page allocation. In writing, you can send the following
2212commands to the snd-page-alloc driver:
2213
2214 - add VENDOR DEVICE MASK SIZE BUFFERS
2215
2216 VENDOR and DEVICE are PCI vendor and device IDs. They take
2217 integer numbers (0x prefix is needed for the hex).
2218 MASK is the PCI DMA mask. Pass 0 if not restricted.
2219 SIZE is the size of each buffer to allocate. You can pass
2220 k and m suffix for KB and MB. The max number is 16MB.
2221 BUFFERS is the number of buffers to allocate. It must be greater
2222 than 0. The max number is 4.
2223
2224 - erase
2225
2226 This will erase the all pre-allocated buffers which are not in
2227 use.
2228
2229
Takashi Iwai62430082005-09-05 17:12:29 +02002230Links and Addresses
2231===================
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232
2233 ALSA project homepage
2234 http://www.alsa-project.org
2235
Takashi Iwai30bc4482008-12-09 08:23:45 +01002236 Kernel Bugzilla
2237 http://bugzilla.kernel.org/
Takashi Iwai62430082005-09-05 17:12:29 +02002238
2239 ALSA Developers ML
Rene Herman45051792007-03-21 12:05:06 +01002240 mailto:alsa-devel@alsa-project.org
Takashi Iwai30bc4482008-12-09 08:23:45 +01002241
2242 alsa-info.sh script
2243 http://www.alsa-project.org/alsa-info.sh