blob: 8e5b3488b3708da89dac8f42651d8d211854eabe [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)
485
486 This module supports multiple cards.
487
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200488 Module snd-darla20
489 ------------------
490
491 Module for Echoaudio Darla20
492
493 This module supports multiple cards.
494 The driver requires the firmware loader support on kernel.
495
496 Module snd-darla24
497 ------------------
498
499 Module for Echoaudio Darla24
500
501 This module supports multiple cards.
502 The driver requires the firmware loader support on kernel.
503
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 Module snd-dt019x
505 -----------------
506
507 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
508 only)
509
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100510 This module supports multiple cards. This module is enabled only with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 ISA PnP support.
512
Takashi Iwaia4efc232005-11-17 17:24:26 +0100513 The power-management is supported.
514
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 Module snd-dummy
516 ----------------
517
518 Module for the dummy sound card. This "card" doesn't do any output
519 or input, but you may use this module for any application which
520 requires a sound card (like RealPlayer).
521
Takashi Iwaia4efc232005-11-17 17:24:26 +0100522 The power-management is supported.
523
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200524 Module snd-echo3g
525 -----------------
526
527 Module for Echoaudio 3G cards (Gina3G/Layla3G)
528
529 This module supports multiple cards.
530 The driver requires the firmware loader support on kernel.
531
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 Module snd-emu10k1
533 ------------------
534
535 Module for EMU10K1/EMU10k2 based PCI sound cards.
536 * Sound Blaster Live!
537 * Sound Blaster PCI 512
538 * Emu APS (partially supported)
539 * Sound Blaster Audigy
540
541 extin - bitmap of available external inputs for FX8010 (see bellow)
542 extout - bitmap of available external outputs for FX8010 (see bellow)
543 seq_ports - allocated sequencer ports (4 by default)
544 max_synth_voices - limit of voices used for wavetable (64 by default)
545 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
546 given in MB unit. Default value is 128.
547 enable_ir - enable IR
548
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100549 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
551 Input & Output configurations [extin/extout]
552 * Creative Card wo/Digital out [0x0003/0x1f03]
553 * Creative Card w/Digital out [0x0003/0x1f0f]
554 * Creative Card w/Digital CD in [0x000f/0x1f0f]
555 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
556 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
557 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
558 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
559 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
560 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
561 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
562 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
563 * Creative Card all ins and outs [0x3fff/0x7fff]
564
Takashi Iwaia4efc232005-11-17 17:24:26 +0100565 The power-management is supported.
566
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 Module snd-emu10k1x
568 -------------------
569
570 Module for Creative Emu10k1X (SB Live Dell OEM version)
571
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100572 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
574 Module snd-ens1370
575 ------------------
576
577 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
578 * SoundBlaster PCI 64
579 * SoundBlaster PCI 128
580
581 joystick - Enable joystick (default off)
582
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100583 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100585 The power-management is supported.
586
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 Module snd-ens1371
588 ------------------
589
590 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
591 * SoundBlaster PCI 64
592 * SoundBlaster PCI 128
593 * SoundBlaster Vibra PCI
594
595 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
596 0 = disable (default), 1 = auto-detect
597
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100598 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100600 The power-management is supported.
601
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 Module snd-es968
603 ----------------
604
605 Module for sound cards based on ESS ES968 chip (PnP only).
606
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100607 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
Takashi Iwaia4efc232005-11-17 17:24:26 +0100609 The power-management is supported.
610
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 Module snd-es1688
612 -----------------
613
614 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
615
616 port - port # for ES-1688 chip (0x220,0x240,0x260)
Takashi Iwai504a06d2009-01-30 19:59:10 +0100617 fm_port - port # for OPL3 (option; share the same port as default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
619 irq - IRQ # for ES-1688 chip (5,7,9,10)
620 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
621 dma8 - DMA # for ES-1688 chip (0,1,3)
622
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100623 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
625 Module snd-es18xx
626 -----------------
627
628 Module for ESS AudioDrive ES-18xx sound cards.
629
Rene Herman64e0e2d2007-12-13 16:29:33 +0100630 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
631
632 with isapnp=0, the following options are available:
633
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 port - port # for ES-18xx chip (0x220,0x240,0x260)
635 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
636 fm_port - port # for FM (optional, not used)
637 irq - IRQ # for ES-18xx chip (5,7,9,10)
638 dma1 - first DMA # for ES-18xx chip (0,1,3)
639 dma2 - first DMA # for ES-18xx chip (0,1,3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100641 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
642 port if native ISA PnP routines are not used).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 When dma2 is equal with dma1, the driver works as half-duplex.
644
645 The power-management is supported.
646
647 Module snd-es1938
648 -----------------
649
650 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
651
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100652 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
Takashi Iwaia4efc232005-11-17 17:24:26 +0100654 The power-management is supported.
655
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 Module snd-es1968
657 -----------------
658
659 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
660
661 total_bufsize - total buffer size in kB (1-4096kB)
662 pcm_substreams_p - playback channels (1-8, default=2)
663 pcm_substreams_c - capture channels (1-8, default=0)
664 clock - clock (0 = auto-detection)
665 use_pm - support the power-management (0 = off, 1 = on,
666 2 = auto (default))
667 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
668 joystick - enable joystick (default off)
669
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100670 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671
672 The power-management is supported.
673
674 Module snd-fm801
675 ----------------
676
677 Module for ForteMedia FM801 based PCI sound cards.
678
679 tea575x_tuner - Enable TEA575x tuner
680 - 1 = MediaForte 256-PCS
681 - 2 = MediaForte 256-PCPR
682 - 3 = MediaForte 64-PCR
683 - High 16-bits are video (radio) device number + 1
684 - example: 0x10002 (MediaForte 256-PCPR, device 1)
685
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100686 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
Takashi Iwaia4efc232005-11-17 17:24:26 +0100688 The power-management is supported.
689
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200690 Module snd-gina20
691 -----------------
692
693 Module for Echoaudio Gina20
694
695 This module supports multiple cards.
696 The driver requires the firmware loader support on kernel.
697
698 Module snd-gina24
699 -----------------
700
701 Module for Echoaudio Gina24
702
703 This module supports multiple cards.
704 The driver requires the firmware loader support on kernel.
705
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 Module snd-gusclassic
707 ---------------------
708
709 Module for Gravis UltraSound Classic sound card.
710
711 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
712 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
713 dma1 - DMA # for GF1 chip (1,3,5,6,7)
714 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
715 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
716 voices - GF1 voices limit (14-32)
717 pcm_voices - reserved PCM voices
718
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100719 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720
721 Module snd-gusextreme
722 ---------------------
723
724 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
725
726 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
727 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
728 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
729 irq - IRQ # for ES-1688 chip (5,7,9,10)
730 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
731 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
732 dma8 - DMA # for ES-1688 chip (0,1,3)
733 dma1 - DMA # for GF1 chip (1,3,5,6,7)
734 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
735 voices - GF1 voices limit (14-32)
736 pcm_voices - reserved PCM voices
737
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100738 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
740 Module snd-gusmax
741 -----------------
742
743 Module for Gravis UltraSound MAX sound card.
744
745 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
746 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
747 dma1 - DMA # for GF1 chip (1,3,5,6,7)
748 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
749 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
750 voices - GF1 voices limit (14-32)
751 pcm_voices - reserved PCM voices
752
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100753 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754
755 Module snd-hda-intel
756 --------------------
757
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400758 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8, ICH9, ICH10,
759 PCH, SCH),
760 ATI SB450, SB600, R600, RS600, RS690, RS780, RV610, RV620,
761 RV630, RV635, RV670, RV770,
Takashi Iwai9b878192006-05-17 11:26:39 +0200762 VIA VT8251/VT8237A,
763 SIS966, ULI M5461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100765 [Multiple options for each card instance]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 model - force the model name
Takashi Iwaid2e1c972008-06-10 17:53:34 +0200767 position_fix - Fix DMA pointer (0 = auto, 1 = use LPIB, 2 = POSBUF)
Takashi Iwai95904742007-05-19 17:06:42 +0200768 probe_mask - Bitmask to probe codecs (default = -1, meaning all slots)
Takashi Iwaiae374d62009-02-13 08:33:55 +0100769 When the bit 8 (0x100) is set, the lower 8 bits are used
770 as the "fixed" codec slots; i.e. the driver probes the
771 slots regardless what hardware reports back
Takashi Iwaid4d9cd032008-12-19 15:19:11 +0100772 probe_only - Only probing and no codec initialization (default=off);
773 Useful to check the initial codec status for debugging
Takashi Iwai8c53b962008-06-10 17:53:35 +0200774 bdl_pos_adj - Specifies the DMA IRQ timing delay in samples.
775 Passing -1 will make the driver to choose the appropriate
776 value based on the controller chip.
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100777
778 [Single (global) options]
Takashi Iwai27346162006-01-12 18:28:44 +0100779 single_cmd - Use single immediate commands to communicate with
780 codecs (for debugging only)
Takashi Iwai134a11f2006-11-10 12:08:37 +0100781 enable_msi - Enable Message Signaled Interrupt (MSI) (default = off)
Matt LaPlante19f59462009-04-27 15:06:31 +0200782 power_save - Automatic power-saving timeout (in second, 0 =
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200783 disable)
Takashi Iwaidee1b662007-08-13 16:10:30 +0200784 power_save_controller - Reset HD-audio controller in power-saving mode
785 (default = on)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100787 This module supports multiple cards and autoprobe.
788
Takashi Iwaicae51172008-12-19 08:36:53 +0100789 See Documentation/sound/alsa/HD-Audio.txt for more details about
790 HD-audio driver.
791
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 Each codec may have a model table for different configurations.
793 If your machine isn't listed there, the default (usually minimal)
794 configuration is set up. You can pass "model=<name>" option to
795 specify a certain model in such a case. There are different
Takashi Iwaicae51172008-12-19 08:36:53 +0100796 models depending on the codec chip. The list of available models
797 is found in HD-Audio-Models.txt
Takashi Iwaidb064e52006-03-16 16:04:58 +0100798
Takashi Iwai6d7b1d72007-02-26 15:56:46 +0100799 The model name "genric" is treated as a special case. When this
800 model is given, the driver uses the generic codec parser without
801 "codec-patch". It's sometimes good for testing and debugging.
802
Takashi Iwai62430082005-09-05 17:12:29 +0200803 If the default configuration doesn't work and one of the above
Takashi Iwai30bc4482008-12-09 08:23:45 +0100804 matches with your device, report it together with alsa-info.sh
805 output (with --no-upload option) to kernel bugzilla or alsa-devel
Takashi Iwai62430082005-09-05 17:12:29 +0200806 ML (see the section "Links and Addresses").
807
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200808 power_save and power_save_controller options are for power-saving
809 mode. See powersave.txt for details.
Takashi Iwaidee1b662007-08-13 16:10:30 +0200810
Takashi Iwaic74db862005-05-12 14:26:27 +0200811 Note 2: If you get click noises on output, try the module option
812 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
813 register value without FIFO size correction as the current
814 DMA pointer. position_fix=2 will make the driver to use
815 the position buffer instead of reading SD_LPIB register.
Michael Kerrisk90f31e32008-09-01 14:03:50 +0200816 (Usually SD_LPIB register is more accurate than the
Takashi Iwaic74db862005-05-12 14:26:27 +0200817 position buffer.)
818
Takashi Iwai27346162006-01-12 18:28:44 +0100819 NB: If you get many "azx_get_response timeout" messages at
820 loading, it's likely a problem of interrupts (e.g. ACPI irq
821 routing). Try to boot with options like "pci=noacpi". Also, you
822 can try "single_cmd=1" module option. This will switch the
823 communication method between HDA controller and codecs to the
824 single immediate commands instead of CORB/RIRB. Basically, the
825 single command mode is provided only for BIOS, and you won't get
826 unsolicited events, too. But, at least, this works independently
827 from the irq. Remember this is a last resort, and should be
828 avoided as much as possible...
829
Takashi Iwai95904742007-05-19 17:06:42 +0200830 MORE NOTES ON "azx_get_response timeout" PROBLEMS:
831 On some hardwares, you may need to add a proper probe_mask option
832 to avoid the "azx_get_response timeout" problem above, instead.
833 This occurs when the access to non-existing or non-working codec slot
834 (likely a modem one) causes a stall of the communication via HD-audio
835 bus. You can see which codec slots are probed by enabling
Takashi Iwai62cf8722008-05-20 12:15:15 +0200836 CONFIG_SND_DEBUG_VERBOSE, or simply from the file name of the codec
Takashi Iwai95904742007-05-19 17:06:42 +0200837 proc files. Then limit the slots to probe by probe_mask option.
838 For example, probe_mask=1 means to probe only the first slot, and
839 probe_mask=4 means only the third slot.
840
Takashi Iwaia4efc232005-11-17 17:24:26 +0100841 The power-management is supported.
842
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 Module snd-hdsp
844 ---------------
845
846 Module for RME Hammerfall DSP audio interface(s)
847
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100848 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849
850 Note: The firmware data can be automatically loaded via hotplug
851 when CONFIG_FW_LOADER is set. Otherwise, you need to load
852 the firmware via hdsploader utility included in alsa-tools
853 package.
854 The firmware data is found in alsa-firmware package.
855
856 Note: snd-page-alloc module does the job which snd-hammerfall-mem
857 module did formerly. It will allocate the buffers in advance
858 when any HDSP cards are found. To make the buffer
859 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +0200860 stage of boot sequence. See "Early Buffer Allocation"
861 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862
Takashi Iwai54704402005-06-03 11:27:00 +0200863 Module snd-hdspm
864 ----------------
865
866 Module for RME HDSP MADI board.
867
868 precise_ptr - Enable precise pointer, or disable.
869 line_outs_monitor - Send playback streams to analog outs by default.
870 enable_monitor - Enable Analog Out on Channel 63/64 by default.
871
872 See hdspm.txt for details.
873
Clemens Ladischc6260262008-01-25 08:41:52 +0100874 Module snd-hifier
875 -----------------
876
877 Module for the MediaTek/TempoTec HiFier Fantasia sound card.
878
879 This module supports autoprobe and multiple cards.
880
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 Module snd-ice1712
882 ------------------
883
884 Module for Envy24 (ICE1712) based PCI sound cards.
885 * MidiMan M Audio Delta 1010
886 * MidiMan M Audio Delta 1010LT
887 * MidiMan M Audio Delta DiO 2496
888 * MidiMan M Audio Delta 66
889 * MidiMan M Audio Delta 44
890 * MidiMan M Audio Delta 410
891 * MidiMan M Audio Audiophile 2496
892 * TerraTec EWS 88MT
893 * TerraTec EWS 88D
894 * TerraTec EWX 24/96
895 * TerraTec DMX 6Fire
Takashi Iwaic9bce912005-05-24 13:41:03 +0200896 * TerraTec Phase 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 * Hoontech SoundTrack DSP 24
898 * Hoontech SoundTrack DSP 24 Value
899 * Hoontech SoundTrack DSP 24 Media 7.1
Takashi Iwaic9bce912005-05-24 13:41:03 +0200900 * Event Electronics, EZ8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901 * Digigram VX442
Takashi Iwaic9bce912005-05-24 13:41:03 +0200902 * Lionstracs, Mediastaton
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400903 * Terrasoniq TS 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
905 model - Use the given board model, one of the following:
906 delta1010, dio2496, delta66, delta44, audiophile, delta410,
907 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
Takashi Iwaic9bce912005-05-24 13:41:03 +0200908 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
909 phase88, mediastation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 omni - Omni I/O support for MidiMan M-Audio Delta44/66
Matt LaPlantefa00e7e2006-11-30 04:55:36 +0100911 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transceiver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 in msec resolution, default value is 500 (0.5 sec)
913
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100914 This module supports multiple cards and autoprobe. Note: The consumer part
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915 is not used with all Envy24 based cards (for example in the MidiMan Delta
916 serie).
917
Takashi Iwaic9bce912005-05-24 13:41:03 +0200918 Note: The supported board is detected by reading EEPROM or PCI
919 SSID (if EEPROM isn't available). You can override the
920 model by passing "model" module option in case that the
921 driver isn't configured properly or you want to try another
922 type for testing.
923
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924 Module snd-ice1724
925 ------------------
926
Takashi Iwaic9bce912005-05-24 13:41:03 +0200927 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100928 * MidiMan M Audio Revolution 5.1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 * MidiMan M Audio Revolution 7.1
Takashi Iwai56255062006-11-09 16:47:26 +0100930 * MidiMan M Audio Audiophile 192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 * AMP Ltd AUDIO2000
Takashi Iwaic9bce912005-05-24 13:41:03 +0200932 * TerraTec Aureon 5.1 Sky
933 * TerraTec Aureon 7.1 Space
934 * TerraTec Aureon 7.1 Universe
935 * TerraTec Phase 22
936 * TerraTec Phase 28
937 * AudioTrak Prodigy 7.1
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400938 * AudioTrak Prodigy 7.1 LT
939 * AudioTrak Prodigy 7.1 XT
940 * AudioTrak Prodigy 7.1 HIFI
941 * AudioTrak Prodigy 7.1 HD2
Takashi Iwaic9bce912005-05-24 13:41:03 +0200942 * AudioTrak Prodigy 192
943 * Pontis MS300
944 * Albatron K8X800 Pro II
945 * Chaintech ZNF3-150
946 * Chaintech ZNF3-250
947 * Chaintech 9CJS
Takashi Iwai8cfbbac2005-05-27 12:10:40 +0200948 * Chaintech AV-710
Takashi Iwaic9bce912005-05-24 13:41:03 +0200949 * Shuttle SN25P
Shin-ya Okadaf31639b2007-10-23 15:08:18 +0200950 * Onkyo SE-90PCI
951 * Onkyo SE-200PCI
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400952 * ESI Juli@
Takashi Iwai72cbfd42009-05-06 17:33:19 +0200953 * ESI Maya44
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400954 * Hercules Fortissimo IV
955 * EGO-SYS WaveTerminal 192M
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956
957 model - Use the given board model, one of the following:
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100958 revo51, revo71, amp2000, prodigy71, prodigy71lt,
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400959 prodigy71xt, prodigy71hifi, prodigyhd2, prodigy192,
960 juli, aureon51, aureon71, universe, ap192, k8x800,
961 phase22, phase28, ms300, av710, se200pci, se90pci,
Takashi Iwai72cbfd42009-05-06 17:33:19 +0200962 fortissimo4, sn25p, WT192M, maya44
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100964 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
Takashi Iwaic9bce912005-05-24 13:41:03 +0200966 Note: The supported board is detected by reading EEPROM or PCI
967 SSID (if EEPROM isn't available). You can override the
968 model by passing "model" module option in case that the
969 driver isn't configured properly or you want to try another
970 type for testing.
971
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200972 Module snd-indigo
973 -----------------
974
975 Module for Echoaudio Indigo
976
977 This module supports multiple cards.
978 The driver requires the firmware loader support on kernel.
979
980 Module snd-indigodj
981 -------------------
982
983 Module for Echoaudio Indigo DJ
984
985 This module supports multiple cards.
986 The driver requires the firmware loader support on kernel.
987
988 Module snd-indigoio
989 -------------------
990
991 Module for Echoaudio Indigo IO
992
993 This module supports multiple cards.
994 The driver requires the firmware loader support on kernel.
995
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 Module snd-intel8x0
997 -------------------
998
999 Module for AC'97 motherboards from Intel and compatibles.
1000 * Intel i810/810E, i815, i820, i830, i84x, MX440
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001001 ICH5, ICH6, ICH7, 6300ESB, ESB2
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 * SiS 7012 (SiS 735)
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001003 * NVidia NForce, NForce2, NForce3, MCP04, CK804
1004 CK8, CK8S, MCP501
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 * AMD AMD768, AMD8111
1006 * ALi m5455
1007
1008 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1009 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001010 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 buggy_irq - Enable workaround for buggy interrupts on some
Takashi Iwaia06147d2005-09-08 19:54:17 +02001012 motherboards (default yes on nForce chips,
1013 otherwise off)
1014 buggy_semaphore - Enable workaround for hardwares with buggy
1015 semaphores (e.g. on some ASUS laptops)
1016 (default off)
Takashi Iwai6c5cfd92006-11-28 17:18:25 +01001017 spdif_aclink - Use S/PDIF over AC-link instead of direct connection
1018 from the controller chip
1019 (0 = off, 1 = on, -1 = default)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001021 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022
1023 Note: the latest driver supports auto-detection of chip clock.
1024 if you still encounter too fast playback, specify the clock
1025 explicitly via the module option "ac97_clock=41194".
1026
1027 Joystick/MIDI ports are not supported by this driver. If your
1028 motherboard has these devices, use the ns558 or snd-mpu401
1029 modules, respectively.
1030
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 The power-management is supported.
1032
1033 Module snd-intel8x0m
1034 --------------------
1035
1036 Module for Intel ICH (i8x0) chipset MC97 modems.
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001037 * Intel i810/810E, i815, i820, i830, i84x, MX440
1038 ICH5, ICH6, ICH7
1039 * SiS 7013 (SiS 735)
1040 * NVidia NForce, NForce2, NForce2s, NForce3
1041 * AMD AMD8111
1042 * ALi m5455
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043
1044 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1045
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001046 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047
1048 Note: The default index value of this module is -2, i.e. the first
1049 slot is excluded.
1050
Takashi Iwaia4efc232005-11-17 17:24:26 +01001051 The power-management is supported.
1052
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 Module snd-interwave
1054 --------------------
1055
1056 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1057 and other sound cards based on AMD InterWave (tm) chip.
1058
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1060 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1061 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1062 effect - 1 = InterWave effects enable (default 0);
1063 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001064 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1065
1066 with isapnp=0, the following options are available:
1067
1068 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1069 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1070 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1071 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001073 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074
1075 Module snd-interwave-stb
1076 ------------------------
1077
1078 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1079 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1080 circuit for extended control of bass, treble and master volume.
1081
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1083 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1084 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1085 effect - 1 = InterWave effects enable (default 0);
1086 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001087 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1088
1089 with isapnp=0, the following options are available:
1090
1091 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1092 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1093 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1094 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1095 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001097 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098
1099 Module snd-korg1212
1100 -------------------
1101
1102 Module for Korg 1212 IO PCI card
1103
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001104 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001106 Module snd-layla20
1107 ------------------
1108
1109 Module for Echoaudio Layla20
1110
1111 This module supports multiple cards.
1112 The driver requires the firmware loader support on kernel.
1113
1114 Module snd-layla24
1115 ------------------
1116
1117 Module for Echoaudio Layla24
1118
1119 This module supports multiple cards.
1120 The driver requires the firmware loader support on kernel.
1121
Takashi Iwai8338c302009-04-14 12:30:36 +02001122 Module snd-lx6464es
1123 -------------------
1124
1125 Module for Digigram LX6464ES boards
1126
1127 This module supports multiple cards.
1128
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 Module snd-maestro3
1130 -------------------
1131
1132 Module for Allegro/Maestro3 chips
1133
1134 external_amp - enable external amp (enabled by default)
1135 amp_gpio - GPIO pin number for external amp (0-15) or
1136 -1 for default pin (8 for allegro, 1 for
1137 others)
1138
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001139 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140
1141 Note: the binding of amplifier is dependent on hardware.
1142 If there is no sound even though all channels are unmuted, try to
1143 specify other gpio connection via amp_gpio option.
1144 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1145 option.
1146
1147 The power-management is supported.
1148
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001149 Module snd-mia
1150 ---------------
1151
1152 Module for Echoaudio Mia
1153
1154 This module supports multiple cards.
1155 The driver requires the firmware loader support on kernel.
1156
Martin Langer1841f6132006-03-27 12:41:01 +02001157 Module snd-miro
1158 ---------------
1159
1160 Module for Miro soundcards: miroSOUND PCM 1 pro,
1161 miroSOUND PCM 12,
1162 miroSOUND PCM 20 Radio.
1163
1164 port - Port # (0x530,0x604,0xe80,0xf40)
1165 irq - IRQ # (5,7,9,10,11)
1166 dma1 - 1st dma # (0,1,3)
1167 dma2 - 2nd dma # (0,1)
1168 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1169 mpu_irq - MPU-401 irq # (5,7,9,10)
1170 fm_port - FM Port # (0x388)
1171 wss - enable WSS mode
1172 ide - enable onboard ide support
1173
Linus Torvalds1da177e2005-04-16 15:20:36 -07001174 Module snd-mixart
1175 -----------------
1176
1177 Module for Digigram miXart8 sound cards.
1178
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001179 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 Note: One miXart8 board will be represented as 4 alsa cards.
1181 See MIXART.txt for details.
1182
1183 When the driver is compiled as a module and the hotplug firmware
1184 is supported, the firmware data is loaded via hotplug automatically.
1185 Install the necessary firmware files in alsa-firmware package.
1186 When no hotplug fw loader is available, you need to load the
1187 firmware via mixartloader utility in alsa-tools package.
1188
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001189 Module snd-mona
1190 ---------------
1191
1192 Module for Echoaudio Mona
1193
1194 This module supports multiple cards.
1195 The driver requires the firmware loader support on kernel.
1196
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 Module snd-mpu401
1198 -----------------
1199
1200 Module for MPU-401 UART devices.
1201
1202 port - port number or -1 (disable)
1203 irq - IRQ number or -1 (disable)
1204 pnp - PnP detection - 0 = disable, 1 = enable (default)
1205
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001206 This module supports multiple devices and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207
Takashi Iwaic96330b2009-01-28 08:23:03 +01001208 Module snd-msnd-classic
1209 -----------------------
1210
1211 Module for Turtle Beach MultiSound Classic, Tahiti or Monterey
1212 soundcards.
1213
1214 io - Port # for msnd-classic card
1215 irq - IRQ # for msnd-classic card
1216 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1217 0xe0000 or 0xe8000)
1218 write_ndelay - enable write ndelay (default = 1)
1219 calibrate_signal - calibrate signal (default = 0)
1220 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1221 digital - Digital daughterboard present (default = 0)
1222 cfg - Config port (0x250, 0x260 or 0x270) default = PnP
1223 reset - Reset all devices
1224 mpu_io - MPU401 I/O port
1225 mpu_irq - MPU401 irq#
1226 ide_io0 - IDE port #0
1227 ide_io1 - IDE port #1
1228 ide_irq - IDE irq#
1229 joystick_io - Joystick I/O port
1230
1231 The driver requires firmware files "turtlebeach/msndinit.bin" and
1232 "turtlebeach/msndperm.bin" in the proper firmware directory.
1233
1234 See Documentation/sound/oss/MultiSound for important information
1235 about this driver. Note that it has been discontinued, but the
1236 Voyetra Turtle Beach knowledge base entry for it is still available
1237 at
1238 http://www.turtlebeach.com/site/kb_ftp/790.asp
1239
1240 Module snd-msnd-pinnacle
1241 ------------------------
1242
1243 Module for Turtle Beach MultiSound Pinnacle/Fiji soundcards.
1244
1245 io - Port # for pinnacle/fiji card
1246 irq - IRQ # for pinnalce/fiji card
1247 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1248 0xe0000 or 0xe8000)
1249 write_ndelay - enable write ndelay (default = 1)
1250 calibrate_signal - calibrate signal (default = 0)
1251 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1252
1253 The driver requires firmware files "turtlebeach/pndspini.bin" and
1254 "turtlebeach/pndsperm.bin" in the proper firmware directory.
1255
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256 Module snd-mtpav
1257 ----------------
1258
1259 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1260 port).
1261
1262 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1263 irq - IRQ # for MTPAV (7,5, default=7)
1264 hwports - number of supported hardware ports, default=8.
1265
1266 Module supports only 1 card. This module has no enable option.
1267
Matthias Koenig68ab8012006-07-27 16:59:23 +02001268 Module snd-mts64
1269 ----------------
1270
1271 Module for Ego Systems (ESI) Miditerminal 4140
1272
1273 This module supports multiple devices.
1274 Requires parport (CONFIG_PARPORT).
1275
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 Module snd-nm256
1277 ----------------
1278
1279 Module for NeoMagic NM256AV/ZX chips
1280
1281 playback_bufsize - max playback frame size in kB (4-128kB)
1282 capture_bufsize - max capture frame size in kB (4-128kB)
1283 force_ac97 - 0 or 1 (disabled by default)
1284 buffer_top - specify buffer top address
1285 use_cache - 0 or 1 (disabled by default)
1286 vaio_hack - alias buffer_top=0x25a800
1287 reset_workaround - enable AC97 RESET workaround for some laptops
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001288 reset_workaround2 - enable extended AC97 RESET workaround for some
1289 other laptops
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +02001291 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292
1293 The power-management is supported.
1294
1295 Note: on some notebooks the buffer address cannot be detected
1296 automatically, or causes hang-up during initialization.
Matt LaPlantefff92892006-10-03 22:47:42 +02001297 In such a case, specify the buffer top address explicitly via
1298 the buffer_top option.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 For example,
1300 Sony F250: buffer_top=0x25a800
1301 Sony F270: buffer_top=0x272800
1302 The driver supports only ac97 codec. It's possible to force
1303 to initialize/use ac97 although it's not detected. In such a
1304 case, use force_ac97=1 option - but *NO* guarantee whether it
1305 works!
1306
1307 Note: The NM256 chip can be linked internally with non-AC97
1308 codecs. This driver supports only the AC97 codec, and won't work
1309 with machines with other (most likely CS423x or OPL3SAx) chips,
1310 even though the device is detected in lspci. In such a case, try
1311 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
Takashi Iwai62430082005-09-05 17:12:29 +02001312 but some doesn't have ISA PnP. You'll need to specify isapnp=0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 and proper hardware parameters in the case without ISA PnP.
1314
1315 Note: some laptops need a workaround for AC97 RESET. For the
1316 known hardware like Dell Latitude LS and Sony PCG-F305, this
1317 workaround is enabled automatically. For other laptops with a
1318 hard freeze, you can try reset_workaround=1 option.
1319
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001320 Note: Dell Latitude CSx laptops have another problem regarding
1321 AC97 RESET. On these laptops, reset_workaround2 option is
1322 turned on as default. This option is worth to try if the
1323 previous reset_workaround option doesn't help.
1324
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 Note: This driver is really crappy. It's a porting from the
1326 OSS driver, which is a result of black-magic reverse engineering.
1327 The detection of codec will fail if the driver is loaded *after*
1328 X-server as described above. You might be able to force to load
1329 the module, but it may result in hang-up. Hence, make sure that
1330 you load this module *before* X if you encounter this kind of
1331 problem.
1332
1333 Module snd-opl3sa2
1334 ------------------
1335
1336 Module for Yamaha OPL3-SA2/SA3 sound cards.
1337
Rene Herman64e0e2d2007-12-13 16:29:33 +01001338 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1339
1340 with isapnp=0, the following options are available:
1341
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342 port - control port # for OPL3-SA chip (0x370)
1343 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1344 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1345 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1346 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1347 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1348 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1349 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001351 This module supports multiple cards and ISA PnP. It does not support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1353
1354 The power-management is supported.
1355
1356 Module snd-opti92x-ad1848
1357 -------------------------
1358
1359 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1360 Module works with OAK Mozart cards as well.
1361
Rene Herman64e0e2d2007-12-13 16:29:33 +01001362 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1363
1364 with isapnp=0, the following options are available:
1365
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1367 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1368 fm_port - port # for OPL3 device (0x388)
1369 irq - IRQ # for WSS chip (5,7,9,10,11)
1370 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1371 dma1 - first DMA # for WSS chip (0,1,3)
1372
1373 This module supports only one card, autoprobe and PnP.
1374
1375 Module snd-opti92x-cs4231
1376 -------------------------
1377
1378 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1379
Rene Herman64e0e2d2007-12-13 16:29:33 +01001380 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1381
1382 with isapnp=0, the following options are available:
1383
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1385 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1386 fm_port - port # for OPL3 device (0x388)
1387 irq - IRQ # for WSS chip (5,7,9,10,11)
1388 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1389 dma1 - first DMA # for WSS chip (0,1,3)
1390 dma2 - second DMA # for WSS chip (0,1,3)
1391
1392 This module supports only one card, autoprobe and PnP.
1393
1394 Module snd-opti93x
1395 ------------------
1396
1397 Module for sound cards based on OPTi 82c93x chips.
1398
Rene Herman64e0e2d2007-12-13 16:29:33 +01001399 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1400
1401 with isapnp=0, the following options are available:
1402
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1404 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1405 fm_port - port # for OPL3 device (0x388)
1406 irq - IRQ # for WSS chip (5,7,9,10,11)
1407 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1408 dma1 - first DMA # for WSS chip (0,1,3)
1409 dma2 - second DMA # for WSS chip (0,1,3)
1410
1411 This module supports only one card, autoprobe and PnP.
1412
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001413 Module snd-oxygen
1414 -----------------
1415
1416 Module for sound cards based on the C-Media CMI8788 chip:
1417 * Asound A-8788
1418 * AuzenTech X-Meridian
1419 * Bgears b-Enspirer
1420 * Club3D Theatron DTS
Clemens Ladischde04b102008-11-26 10:37:23 +01001421 * HT-Omega Claro (plus)
1422 * HT-Omega Claro halo (XT)
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001423 * Razer Barracuda AC-1
1424 * Sondigo Inferno
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001425
1426 This module supports autoprobe and multiple cards.
1427
Stas Sergeevd08cd582008-03-06 11:01:44 +01001428 Module snd-pcsp
1429 -----------------
1430
1431 Module for internal PC-Speaker.
1432
1433 nforce_wa - enable NForce chipset workaround. Expect bad sound.
1434
1435 This module supports system beeps, some kind of PCM playback and
1436 even a few mixer controls.
1437
Markus Bollingere12229b2005-12-06 13:55:26 +01001438 Module snd-pcxhr
1439 ----------------
1440
1441 Module for Digigram PCXHR boards
1442
1443 This module supports multiple cards.
1444
Matthias Koenig757e1192007-01-25 13:15:05 +01001445 Module snd-portman2x4
1446 ---------------------
1447
1448 Module for Midiman Portman 2x4 parallel port MIDI interface
1449
1450 This module supports multiple cards.
1451
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 Module snd-powermac (on ppc only)
1453 ---------------------------------
1454
1455 Module for PowerMac, iMac and iBook on-board soundchips
1456
1457 enable_beep - enable beep using PCM (enabled as default)
1458
1459 Module supports autoprobe a chip.
1460
1461 Note: the driver may have problems regarding endianess.
1462
1463 The power-management is supported.
1464
Takashi Iwai2c484df2005-06-30 18:54:04 +02001465 Module snd-pxa2xx-ac97 (on arm only)
1466 ------------------------------------
1467
1468 Module for AC97 driver for the Intel PXA2xx chip
1469
1470 For ARM architecture only.
1471
Takashi Iwaia4efc232005-11-17 17:24:26 +01001472 The power-management is supported.
1473
Peter Gruber109a9632006-03-27 13:10:28 +02001474 Module snd-riptide
1475 ------------------
1476
1477 Module for Conexant Riptide chip
1478
1479 joystick_port - Joystick port # (default: 0x200)
1480 mpu_port - MPU401 port # (default: 0x330)
1481 opl3_port - OPL3 port # (default: 0x388)
1482
1483 This module supports multiple cards.
1484 The driver requires the firmware loader support on kernel.
1485 You need to install the firmware file "riptide.hex" to the standard
1486 firmware path (e.g. /lib/firmware).
1487
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 Module snd-rme32
1489 ----------------
1490
1491 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1492 Prodif96 and Prodif Gold) sound cards.
1493
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001494 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495
1496 Module snd-rme96
1497 ----------------
1498
1499 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1500
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001501 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502
1503 Module snd-rme9652
1504 ------------------
1505
1506 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1507
1508 precise_ptr - Enable precise pointer (doesn't work reliably).
1509 (default = 0)
1510
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001511 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512
1513 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1514 module did formerly. It will allocate the buffers in advance
1515 when any RME9652 cards are found. To make the buffer
1516 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +02001517 stage of boot sequence. See "Early Buffer Allocation"
1518 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001519
1520 Module snd-sa11xx-uda1341 (on arm only)
1521 ---------------------------------------
1522
1523 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1524
1525 Module supports only one card.
1526 Module has no enable and index options.
1527
Takashi Iwaia4efc232005-11-17 17:24:26 +01001528 The power-management is supported.
1529
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530 Module snd-sb8
1531 --------------
1532
1533 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1534 SoundBlaster 2.0,
1535 SoundBlaster Pro
1536
1537 port - port # for SB DSP chip (0x220,0x240,0x260)
1538 irq - IRQ # for SB DSP chip (5,7,9,10)
1539 dma8 - DMA # for SB DSP chip (1,3)
1540
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001541 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542
Takashi Iwaia4efc232005-11-17 17:24:26 +01001543 The power-management is supported.
1544
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 Module snd-sb16 and snd-sbawe
1546 -----------------------------
1547
1548 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1549 SoundBlaster AWE 32 (PnP),
1550 SoundBlaster AWE 64 PnP
1551
Rene Herman64e0e2d2007-12-13 16:29:33 +01001552 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1553 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1554 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1555
1556 with isapnp=0, the following options are available:
1557
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1559 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1560 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1561 (snd-sbawe module only)
1562 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1563 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1564 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001566 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567
1568 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1569 disable 16bit DMA with dma16 = -1 module parameter.
1570 Also, all Sound Blaster 16 type cards can operate in 16-bit
1571 half duplex mode through 8-bit DMA channel by disabling their
1572 16-bit DMA channel.
1573
Takashi Iwaia4efc232005-11-17 17:24:26 +01001574 The power-management is supported.
1575
Takashi Iwai074a6e92007-09-11 22:10:14 +02001576 Module snd-sc6000
1577 -----------------
1578
Krzysztof Heltb0ec3a32009-05-03 10:39:19 +02001579 Module for Gallant SC-6000 soundcard and later models: SC-6600
1580 and SC-7000.
Takashi Iwai074a6e92007-09-11 22:10:14 +02001581
1582 port - Port # (0x220 or 0x240)
1583 mss_port - MSS Port # (0x530 or 0xe80)
1584 irq - IRQ # (5,7,9,10,11)
Krzysztof Helt7b758d22007-09-17 14:42:49 +02001585 mpu_irq - MPU-401 IRQ # (5,7,9,10) ,0 - no MPU-401 irq
Takashi Iwai074a6e92007-09-11 22:10:14 +02001586 dma - DMA # (1,3,0)
Krzysztof Heltb0ec3a32009-05-03 10:39:19 +02001587 joystick - Enable gameport - 0 = disable (default), 1 = enable
Takashi Iwai074a6e92007-09-11 22:10:14 +02001588
1589 This module supports multiple cards.
1590
1591 This card is also known as Audio Excel DSP 16 or Zoltrix AV302.
1592
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 Module snd-sgalaxy
1594 ------------------
1595
1596 Module for Aztech Sound Galaxy sound card.
1597
1598 sbport - Port # for SB16 interface (0x220,0x240)
1599 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1600 irq - IRQ # (7,9,10,11)
1601 dma1 - DMA #
1602
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001603 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604
Takashi Iwaia4efc232005-11-17 17:24:26 +01001605 The power-management is supported.
1606
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 Module snd-sscape
1608 -----------------
1609
1610 Module for ENSONIQ SoundScape PnP cards.
1611
1612 port - Port # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001613 wss_port - WSS Port # (PnP setup)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 irq - IRQ # (PnP setup)
1615 mpu_irq - MPU-401 IRQ # (PnP setup)
1616 dma - DMA # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001617 dma2 - 2nd DMA # (PnP setup, -1 to disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001619 This module supports multiple cards. ISA PnP must be enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 You need sscape_ctl tool in alsa-tools package for loading
1621 the microcode.
1622
1623 Module snd-sun-amd7930 (on sparc only)
1624 --------------------------------------
1625
1626 Module for AMD7930 sound chips found on Sparcs.
1627
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001628 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629
1630 Module snd-sun-cs4231 (on sparc only)
1631 -------------------------------------
1632
1633 Module for CS4231 sound chips found on Sparcs.
1634
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001635 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001637 Module snd-sun-dbri (on sparc only)
1638 -----------------------------------
1639
1640 Module for DBRI sound chips found on Sparcs.
1641
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001642 This module supports multiple cards.
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001643
Linus Torvalds1da177e2005-04-16 15:20:36 -07001644 Module snd-wavefront
1645 --------------------
1646
1647 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1648
Rene Herman64e0e2d2007-12-13 16:29:33 +01001649 use_cs4232_midi - Use CS4232 MPU-401 interface
1650 (inaccessibly located inside your computer)
1651 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1652
1653 with isapnp=0, the following options are available:
1654
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655 cs4232_pcm_port - Port # for CS4232 PCM interface.
1656 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1657 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1658 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659 ics2115_port - Port # for ICS2115
1660 ics2115_irq - IRQ # for ICS2115
1661 fm_port - FM OPL-3 Port #
1662 dma1 - DMA1 # for CS4232 PCM interface.
1663 dma2 - DMA2 # for CS4232 PCM interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664
Takashi Iwaic2b12392007-08-21 15:20:26 +02001665 The below are options for wavefront_synth features:
1666 wf_raw - Assume that we need to boot the OS (default:no)
1667 If yes, then during driver loading, the state of the board is
1668 ignored, and we reset the board and load the firmware anyway.
1669 fx_raw - Assume that the FX process needs help (default:yes)
1670 If false, we'll leave the FX processor in whatever state it is
1671 when the driver is loaded. The default is to download the
1672 microprogram and associated coefficients to set it up for
1673 "default" operation, whatever that means.
1674 debug_default - Debug parameters for card initialization
1675 wait_usecs - How long to wait without sleeping, usecs
1676 (default:150)
1677 This magic number seems to give pretty optimal throughput
1678 based on my limited experimentation.
1679 If you want to play around with it and find a better value, be
1680 my guest. Remember, the idea is to get a number that causes us
1681 to just busy wait for as many WaveFront commands as possible,
1682 without coming up with a number so large that we hog the whole
1683 CPU.
1684 Specifically, with this number, out of about 134,000 status
1685 waits, only about 250 result in a sleep.
1686 sleep_interval - How long to sleep when waiting for reply
1687 (default: 100)
1688 sleep_tries - How many times to try sleeping during a wait
1689 (default: 50)
1690 ospath - Pathname to processed ICS2115 OS firmware
1691 (default:wavefront.os)
1692 The path name of the ISC2115 OS firmware. In the recent
1693 version, it's handled via firmware loader framework, so it
1694 must be installed in the proper path, typically,
1695 /lib/firmware.
1696 reset_time - How long to wait for a reset to take effect
1697 (default:2)
1698 ramcheck_time - How many seconds to wait for the RAM test
1699 (default:20)
1700 osrun_time - How many seconds to wait for the ICS2115 OS
1701 (default:10)
1702
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001703 This module supports multiple cards and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001704
Takashi Iwaic2b12392007-08-21 15:20:26 +02001705 Note: the firmware file "wavefront.os" was located in the earlier
1706 version in /etc. Now it's loaded via firmware loader, and
1707 must be in the proper firmware path, such as /lib/firmware.
1708 Copy (or symlink) the file appropriately if you get an error
1709 regarding firmware downloading after upgrading the kernel.
1710
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711 Module snd-sonicvibes
1712 ---------------------
1713
1714 Module for S3 SonicVibes PCI sound cards.
1715 * PINE Schubert 32 PCI
1716
1717 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1718 - SoundCard must have onboard SRAM for this.
1719 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1720
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001721 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722
1723 Module snd-serial-u16550
1724 ------------------------
1725
1726 Module for UART16550A serial MIDI ports.
1727
1728 port - port # for UART16550A chip
1729 irq - IRQ # for UART16550A chip, -1 = poll mode
1730 speed - speed in bauds (9600,19200,38400,57600,115200)
1731 38400 = default
1732 base - base for divisor in bauds (57600,115200,230400,460800)
1733 115200 = default
1734 outs - number of MIDI ports in a serial port (1-4)
1735 1 = default
1736 adaptor - Type of adaptor.
1737 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1738 3 = MS-124W M/B, 4 = Generic
1739
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001740 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741 thus the main port must be specified!!! Other options are optional.
1742
1743 Module snd-trident
1744 ------------------
1745
1746 Module for Trident 4DWave DX/NX sound cards.
1747 * Best Union Miss Melody 4DWave PCI
1748 * HIS 4DWave PCI
1749 * Warpspeed ONSpeed 4DWave PCI
1750 * AzTech PCI 64-Q3D
1751 * Addonics SV 750
1752 * CHIC True Sound 4Dwave
1753 * Shark Predator4D-PCI
1754 * Jaton SonicWave 4D
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001755 * SiS SI7018 PCI Audio
1756 * Hoontech SoundTrack Digital 4DWave NX
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757
1758 pcm_channels - max channels (voices) reserved for PCM
1759 wavetable_size - max wavetable size in kB (4-?kb)
1760
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001761 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001762
1763 The power-management is supported.
1764
1765 Module snd-usb-audio
1766 --------------------
1767
1768 Module for USB audio and USB MIDI devices.
1769
1770 vid - Vendor ID for the device (optional)
1771 pid - Product ID for the device (optional)
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001772 nrpacks - Max. number of packets per URB (default: 8)
1773 async_unlink - Use async unlink mode (default: yes)
Thibault LE MEURe3113342006-03-14 11:44:53 +01001774 device_setup - Device specific magic number (optional)
1775 - Influence depends on the device
1776 - Default: 0x0000
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001777 ignore_ctl_error - Ignore any USB-controller regarding mixer
1778 interface (default: no)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001780 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001782 NB: nrpacks parameter can be modified dynamically via sysfs.
1783 Don't put the value over 20. Changing via sysfs has no sanity
1784 check.
1785 NB: async_unlink=0 would cause Oops. It remains just for
1786 debugging purpose (if any).
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001787 NB: ignore_ctl_error=1 may help when you get an error at accessing
1788 the mixer element such as URB error -22. This happens on some
1789 buggy USB device or the controller.
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001790
Daniel Mack523f1dc2007-03-26 19:11:24 +02001791 Module snd-usb-caiaq
1792 --------------------
1793
1794 Module for caiaq UB audio interfaces,
1795 * Native Instruments RigKontrol2
1796 * Native Instruments Kore Controller
1797 * Native Instruments Audio Kontrol 1
1798 * Native Instruments Audio 8 DJ
1799
1800 This module supports multiple devices, autoprobe and hotplugging.
1801
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 Module snd-usb-usx2y
1803 --------------------
1804
1805 Module for Tascam USB US-122, US-224 and US-428 devices.
1806
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001807 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808
1809 Note: you need to load the firmware via usx2yloader utility included
1810 in alsa-tools and alsa-firmware packages.
1811
1812 Module snd-via82xx
1813 ------------------
1814
1815 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001816 8233A, 8233C, 8235, 8237 (south) bridge.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817
1818 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1819 [VIA686A/686B only]
1820 joystick - Enable joystick (default off) [VIA686A/686B only]
1821 ac97_clock - AC'97 codec clock base (default 48000Hz)
1822 dxs_support - support DXS channels,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001823 0 = auto (default), 1 = enable, 2 = disable,
1824 3 = 48k only, 4 = no VRA, 5 = enable any sample
1825 rate and different sample rates on different
1826 channels
1827 [VIA8233/C, 8235, 8237 only]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001829 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001831 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832
1833 Note: on some SMP motherboards like MSI 694D the interrupts might
1834 not be generated properly. In such a case, please try to
1835 set the SMP (or MPS) version on BIOS to 1.1 instead of
1836 default value 1.4. Then the interrupt number will be
1837 assigned under 15. You might also upgrade your BIOS.
1838
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001839 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 channels as the first PCM. On these channels, up to 4
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001841 streams can be played at the same time, and the controller
1842 can perform sample rate conversion with separate rates for
1843 each channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001844 As default (dxs_support = 0), 48k fixed rate is chosen
1845 except for the known devices since the output is often
1846 noisy except for 48k on some mother boards due to the
1847 bug of BIOS.
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001848 Please try once dxs_support=5 and if it works on other
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1850 know the PCI subsystem vendor/device id's (output of
1851 "lspci -nv").
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001852 If dxs_support=5 does not work, try dxs_support=4; if it
1853 doesn't work too, try dxs_support=1. (dxs_support=1 is
Takashi Iwai62430082005-09-05 17:12:29 +02001854 usually for old motherboards. The correct implemented
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001855 board should work with 4 or 5.) If it still doesn't
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 work and the default setting is ok, dxs_support=3 is the
1857 right choice. If the default setting doesn't work at all,
1858 try dxs_support=2 to disable the DXS channels.
1859 In any cases, please let us know the result and the
Takashi Iwai62430082005-09-05 17:12:29 +02001860 subsystem vendor/device ids. See "Links and Addresses"
1861 below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862
1863 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Takashi Iwai62430082005-09-05 17:12:29 +02001864 additionally. The mpu_port option is for VIA686 chips only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865
Takashi Iwaia4efc232005-11-17 17:24:26 +01001866 The power-management is supported.
1867
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 Module snd-via82xx-modem
1869 ------------------------
1870
1871 Module for VIA82xx AC97 modem
1872
1873 ac97_clock - AC'97 codec clock base (default 48000Hz)
1874
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001875 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876
1877 Note: The default index value of this module is -2, i.e. the first
1878 slot is excluded.
1879
Takashi Iwaia4efc232005-11-17 17:24:26 +01001880 The power-management is supported.
1881
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882 Module snd-virmidi
1883 ------------------
1884
1885 Module for virtual rawmidi devices.
1886 This module creates virtual rawmidi devices which communicate
1887 to the corresponding ALSA sequencer ports.
1888
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001889 midi_devs - MIDI devices # (1-4, default=4)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001891 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001893 Module snd-virtuoso
1894 -------------------
1895
Clemens Ladisch5430c722008-07-28 10:28:43 +02001896 Module for sound cards based on the Asus AV100/AV200 chips,
Clemens Ladisch04f98902009-05-25 10:11:29 +02001897 i.e., Xonar D1, DX, D2, D2X, HDAV1.3 (Deluxe), Essence ST
1898 (Deluxe) and Essence STX.
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001899
1900 This module supports autoprobe and multiple cards.
1901
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902 Module snd-vx222
1903 ----------------
1904
1905 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1906
1907 mic - Enable Microphone on V222 Mic (NYI)
1908 ibl - Capture IBL size. (default = 0, minimum size)
1909
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001910 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911
1912 When the driver is compiled as a module and the hotplug firmware
1913 is supported, the firmware data is loaded via hotplug automatically.
1914 Install the necessary firmware files in alsa-firmware package.
1915 When no hotplug fw loader is available, you need to load the
1916 firmware via vxloader utility in alsa-tools package. To invoke
1917 vxloader automatically, add the following to /etc/modprobe.conf
1918
1919 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1920
1921 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1922 /etc/modules.conf, instead.)
1923 IBL size defines the interrupts period for PCM. The smaller size
1924 gives smaller latency but leads to more CPU consumption, too.
1925 The size is usually aligned to 126. As default (=0), the smallest
1926 size is chosen. The possible IBL values can be found in
1927 /proc/asound/cardX/vx-status proc file.
1928
Takashi Iwaia4efc232005-11-17 17:24:26 +01001929 The power-management is supported.
1930
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 Module snd-vxpocket
1932 -------------------
1933
Takashi Iwai6d00a312005-06-30 13:40:51 +02001934 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935
1936 ibl - Capture IBL size. (default = 0, minimum size)
1937
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001938 This module supports multiple cards. The module is compiled only when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939 PCMCIA is supported on kernel.
1940
Takashi Iwai62430082005-09-05 17:12:29 +02001941 With the older 2.6.x kernel, to activate the driver via the card
1942 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1943 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1944 longer require a config file.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945
1946 When the driver is compiled as a module and the hotplug firmware
1947 is supported, the firmware data is loaded via hotplug automatically.
1948 Install the necessary firmware files in alsa-firmware package.
1949 When no hotplug fw loader is available, you need to load the
1950 firmware via vxloader utility in alsa-tools package.
1951
1952 About capture IBL, see the description of snd-vx222 module.
1953
Takashi Iwaied7cbe32006-05-11 11:30:10 +02001954 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
Takashi Iwai62430082005-09-05 17:12:29 +02001955 ALSA 1.0.10.
1956
Takashi Iwaia4efc232005-11-17 17:24:26 +01001957 The power-management is supported.
1958
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959 Module snd-ymfpci
1960 -----------------
1961
1962 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1963
1964 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1965 1 (auto-detect for YMF744/754 only)
1966 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1967 1 (auto-detect for YMF744/754 only)
1968 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1969 1 (auto-detect)
1970 rear_switch - enable shared rear/line-in switch (bool)
1971
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001972 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973
1974 The power-management is supported.
1975
1976 Module snd-pdaudiocf
1977 --------------------
1978
1979 Module for Sound Core PDAudioCF sound card.
1980
Takashi Iwaia4efc232005-11-17 17:24:26 +01001981 The power-management is supported.
1982
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983
Takashi Iwai62430082005-09-05 17:12:29 +02001984AC97 Quirk Option
1985=================
1986
1987The ac97_quirk option is used to enable/override the workaround for
1988specific devices on drivers for on-board AC'97 controllers like
1989snd-intel8x0. Some hardware have swapped output pins between Master
1990and Headphone, or Surround (thanks to confusion of AC'97
1991specifications from version to version :-)
1992
1993The driver provides the auto-detection of known problematic devices,
1994but some might be unknown or wrongly detected. In such a case, pass
1995the proper value with this option.
1996
1997The following strings are accepted:
1998 - default Don't override the default setting
Takashi Iwai10e4097f2005-11-17 11:04:55 +01001999 - none Disable the quirk
Takashi Iwai62430082005-09-05 17:12:29 +02002000 - hp_only Bind Master and Headphone controls as a single control
2001 - swap_hp Swap headphone and master controls
2002 - swap_surround Swap master and surround controls
2003 - ad_sharing For AD1985, turn on OMS bit and use headphone
2004 - alc_jack For ALC65x, turn on the jack sense mode
2005 - inv_eapd Inverted EAPD implementation
2006 - mute_led Bind EAPD bit for turning on/off mute LED
2007
2008For backward compatibility, the corresponding integer value -1, 0,
2009... are accepted, too.
2010
2011For example, if "Master" volume control has no effect on your device
2012but only "Headphone" does, pass ac97_quirk=hp_only module option.
2013
2014
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015Configuring Non-ISAPNP Cards
2016============================
2017
2018When the kernel is configured with ISA-PnP support, the modules
2019supporting the isapnp cards will have module options "isapnp".
2020If this option is set, *only* the ISA-PnP devices will be probed.
2021For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
2022together with the proper i/o and irq configuration.
2023
2024When the kernel is configured without ISA-PnP support, isapnp option
2025will be not built in.
2026
2027
2028Module Autoloading Support
2029==========================
2030
2031The ALSA drivers can be loaded automatically on demand by defining
2032module aliases. The string 'snd-card-%1' is requested for ALSA native
2033devices where %i is sound card number from zero to seven.
2034
2035To auto-load an ALSA driver for OSS services, define the string
2036'sound-slot-%i' where %i means the slot number for OSS, which
2037corresponds to the card index of ALSA. Usually, define this
Tobias Klauserd533f672005-09-10 00:26:46 -07002038as the same card module.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039
2040An example configuration for a single emu10k1 card is like below:
2041----- /etc/modprobe.conf
2042alias snd-card-0 snd-emu10k1
2043alias sound-slot-0 snd-emu10k1
2044----- /etc/modprobe.conf
2045
2046The available number of auto-loaded sound cards depends on the module
2047option "cards_limit" of snd module. As default it's set to 1.
2048To enable the auto-loading of multiple cards, specify the number of
2049sound cards in that option.
2050
2051When multiple cards are available, it'd better to specify the index
2052number for each card via module option, too, so that the order of
2053cards is kept consistent.
2054
2055An example configuration for two sound cards is like below:
2056
2057----- /etc/modprobe.conf
2058# ALSA portion
2059options snd cards_limit=2
2060alias snd-card-0 snd-interwave
2061alias snd-card-1 snd-ens1371
2062options snd-interwave index=0
2063options snd-ens1371 index=1
2064# OSS/Free portion
2065alias sound-slot-0 snd-interwave
2066alias sound-slot-1 snd-ens1371
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02002067----- /etc/modprobe.conf
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068
2069In this example, the interwave card is always loaded as the first card
2070(index 0) and ens1371 as the second (index 1).
2071
Takashi Iwai304cd072007-10-26 15:10:15 +02002072Alternative (and new) way to fixate the slot assignment is to use
2073"slots" option of snd module. In the case above, specify like the
2074following:
2075
2076options snd slots=snd-interwave,snd-ens1371
2077
2078Then, the first slot (#0) is reserved for snd-interwave driver, and
2079the second (#1) for snd-ens1371. You can omit index option in each
2080driver if slots option is used (although you can still have them at
2081the same time as long as they don't conflict).
2082
2083The slots option is especially useful for avoiding the possible
2084hot-plugging and the resultant slot conflict. For example, in the
2085case above again, the first two slots are already reserved. If any
2086other driver (e.g. snd-usb-audio) is loaded before snd-interwave or
2087snd-ens1371, it will be assigned to the third or later slot.
2088
Takashi Iwaia93bbaa2008-05-27 17:59:24 +02002089When a module name is given with '!', the slot will be given for any
2090modules but that name. For example, "slots=!snd-pcsp" will reserve
2091the first slot for any modules but snd-pcsp.
2092
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093
2094ALSA PCM devices to OSS devices mapping
2095=======================================
2096
2097/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
2098/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
2099/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
2100/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
2101/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
2102/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
2103/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
2104/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
2105/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
2106
2107The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
2108sound card number and second means device number. The ALSA devices
2109have either 'c' or 'p' suffix indicating the direction, capture and
2110playback, respectively.
2111
2112Please note that the device mapping above may be varied via the module
2113options of snd-pcm-oss module.
2114
2115
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116Proc interfaces (/proc/asound)
2117==============================
2118
2119/proc/asound/card#/pcm#[cp]/oss
2120-------------------------------
2121 String "erase" - erase all additional informations about OSS applications
2122 String "<app_name> <fragments> <fragment_size> [<options>]"
2123
2124 <app_name> - name of application with (higher priority) or without path
2125 <fragments> - number of fragments or zero if auto
2126 <fragment_size> - size of fragment in bytes or zero if auto
2127 <options> - optional parameters
2128 - disable the application tries to open a pcm device for
2129 this channel but does not want to use it.
2130 (Cause a bug or mmap needs)
2131 It's good for Quake etc...
2132 - direct don't use plugins
2133 - block force block mode (rvplayer)
2134 - non-block force non-block mode
2135 - whole-frag write only whole fragments (optimization affecting
2136 playback only)
2137 - no-silence do not fill silence ahead to avoid clicks
Takashi Iwai10f69f92005-09-08 13:48:34 +02002138 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
2139 instead of filled blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140
2141 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
2142 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
2143 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
2144
2145
Takashi Iwaib6a96912005-05-30 18:27:03 +02002146Early Buffer Allocation
2147=======================
2148
2149Some drivers (e.g. hdsp) require the large contiguous buffers, and
2150sometimes it's too late to find such spaces when the driver module is
2151actually loaded due to memory fragmentation. You can pre-allocate the
2152PCM buffers by loading snd-page-alloc module and write commands to its
2153proc file in prior, for example, in the early boot stage like
2154/etc/init.d/*.local scripts.
2155
2156Reading the proc file /proc/drivers/snd-page-alloc shows the current
2157usage of page allocation. In writing, you can send the following
2158commands to the snd-page-alloc driver:
2159
2160 - add VENDOR DEVICE MASK SIZE BUFFERS
2161
2162 VENDOR and DEVICE are PCI vendor and device IDs. They take
2163 integer numbers (0x prefix is needed for the hex).
2164 MASK is the PCI DMA mask. Pass 0 if not restricted.
2165 SIZE is the size of each buffer to allocate. You can pass
2166 k and m suffix for KB and MB. The max number is 16MB.
2167 BUFFERS is the number of buffers to allocate. It must be greater
2168 than 0. The max number is 4.
2169
2170 - erase
2171
2172 This will erase the all pre-allocated buffers which are not in
2173 use.
2174
2175
Takashi Iwai62430082005-09-05 17:12:29 +02002176Links and Addresses
2177===================
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178
2179 ALSA project homepage
2180 http://www.alsa-project.org
2181
Takashi Iwai30bc4482008-12-09 08:23:45 +01002182 Kernel Bugzilla
2183 http://bugzilla.kernel.org/
Takashi Iwai62430082005-09-05 17:12:29 +02002184
2185 ALSA Developers ML
Rene Herman45051792007-03-21 12:05:06 +01002186 mailto:alsa-devel@alsa-project.org
Takashi Iwai30bc4482008-12-09 08:23:45 +01002187
2188 alsa-info.sh script
2189 http://www.alsa-project.org/alsa-info.sh