blob: 017e930fa056fccd8cb6d966a11fae788f7263d9 [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.
60 device_mode
61 - permission mask for dynamic sound device filesystem
62 - This is available only when DEVFS is enabled
63 - Default: 0666
64 - E.g.: device_mode=0660
65
66
67 Module snd-pcm-oss
68 ------------------
69
70 The PCM OSS emulation module.
71 This module takes options which change the mapping of devices.
72
73 dsp_map - PCM device number maps assigned to the 1st OSS device.
74 - Default: 0
75 adsp_map - PCM device number maps assigned to the 2st OSS device.
76 - Default: 1
77 nonblock_open
Takashi Iwai62430082005-09-05 17:12:29 +020078 - Don't block opening busy PCM devices. Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
80 For example, when dsp_map=2, /dev/dsp will be mapped to PCM #2 of
81 the card #0. Similarly, when adsp_map=0, /dev/adsp will be mapped
82 to PCM #0 of the card #0.
83 For changing the second or later card, specify the option with
84 commas, such like "dsp_map=0,1".
85
86 nonblock_open option is used to change the behavior of the PCM
87 regarding opening the device. When this option is non-zero,
88 opening a busy OSS PCM device won't be blocked but return
89 immediately with EAGAIN (just like O_NONBLOCK flag).
90
91 Module snd-rawmidi
92 ------------------
93
94 This module takes options which change the mapping of devices.
95 similar to those of the snd-pcm-oss module.
96
97 midi_map - MIDI device number maps assigned to the 1st OSS device.
98 - Default: 0
99 amidi_map - MIDI device number maps assigned to the 2st OSS device.
100 - Default: 1
101
102 Common parameters for top sound card modules
103 --------------------------------------------
104
105 Each of top level sound card module takes the following options.
106
107 index - index (slot #) of sound card
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100108 - Values: 0 through 31 or negative
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 - If nonnegative, assign that index number
110 - if negative, interpret as a bitmask of permissible
111 indices; the first free permitted index is assigned
112 - Default: -1
113 id - card ID (identifier or name)
114 - Can be up to 15 characters long
115 - Default: the card type
116 - A directory by this name is created under /proc/asound/
117 containing information about the card
118 - This ID can be used instead of the index number in
119 identifying the card
120 enable - enable card
121 - Default: enabled, for PCI and ISA PnP cards
122
Rene Hermancf40a312006-03-28 12:38:20 +0200123 Module snd-adlib
124 ----------------
125
126 Module for AdLib FM cards.
127
128 port - port # for OPL chip
129
130 This module supports multiple cards. It does not support autoprobe, so
131 the port must be specified. For actual AdLib FM cards it will be 0x388.
132 Note that this card does not have PCM support and no mixer; only FM
133 synthesis.
134
135 Make sure you have "sbiload" from the alsa-tools package available and,
136 after loading the module, find out the assigned ALSA sequencer port
137 number through "sbiload -l". Example output:
138
139 Port Client name Port name
140 64:0 OPL2 FM synth OPL2 FM Port
141
142 Load the std.sb and drums.sb patches also supplied by sbiload:
143
144 sbiload -p 64:0 std.sb drums.sb
145
146 If you use this driver to drive an OPL3, you can use std.o3 and drums.o3
147 instead. To have the card produce sound, use aplaymidi from alsa-utils:
148
149 aplaymidi -p 64:0 foo.mid
150
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 Module snd-ad1816a
152 ------------------
153
154 Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips.
155
156 port - port # for AD1816A chip (PnP setup)
157 mpu_port - port # for MPU-401 UART (PnP setup)
158 fm_port - port # for OPL3 (PnP setup)
159 irq - IRQ # for AD1816A chip (PnP setup)
160 mpu_irq - IRQ # for MPU-401 UART (PnP setup)
161 dma1 - first DMA # for AD1816A chip (PnP setup)
162 dma2 - second DMA # for AD1816A chip (PnP setup)
Takashi Iwai506d4c62005-08-03 14:02:47 +0200163 clockfreq - Clock frequency for AD1816A chip (default = 0, 33000Hz)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100165 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
167 Module snd-ad1848
168 -----------------
169
170 Module for sound cards based on AD1848/AD1847/CS4248 ISA chips.
171
172 port - port # for AD1848 chip
173 irq - IRQ # for AD1848 chip
174 dma1 - DMA # for AD1848 chip (0,1,3)
175
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100176 This module supports multiple cards. It does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 thus main port must be specified!!! Other ports are optional.
178
Takashi Iwaia4efc232005-11-17 17:24:26 +0100179 The power-management is supported.
180
Clemens Ladisch84010e62005-09-02 07:57:59 +0200181 Module snd-ad1889
182 -----------------
183
184 Module for Analog Devices AD1889 chips.
185
186 ac97_quirk - AC'97 workaround for strange hardware
187 See the description of intel8x0 module for details.
188
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100189 This module supports multiple cards.
Clemens Ladisch84010e62005-09-02 07:57:59 +0200190
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 Module snd-ali5451
192 ------------------
193
194 Module for ALi M5451 PCI chip.
195
196 pcm_channels - Number of hardware channels assigned for PCM
197 spdif - Support SPDIF I/O
198 - Default: disabled
199
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +0200200 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
202 The power-management is supported.
203
204 Module snd-als100
205 -----------------
206
207 Module for sound cards based on Avance Logic ALS100/ALS120 ISA chips.
208
209 port - port # for ALS100 (SB16) chip (PnP setup)
210 irq - IRQ # for ALS100 (SB16) chip (PnP setup)
211 dma8 - 8-bit DMA # for ALS100 (SB16) chip (PnP setup)
212 dma16 - 16-bit DMA # for ALS100 (SB16) chip (PnP setup)
213 mpu_port - port # for MPU-401 UART (PnP setup)
214 mpu_irq - IRQ # for MPU-401 (PnP setup)
215 fm_port - port # for OPL3 FM (PnP setup)
216
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100217 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Takashi Iwaia4efc232005-11-17 17:24:26 +0100219 The power-management is supported.
220
Ash Willisb3a70d52006-03-27 13:20:40 +0200221 Module snd-als300
222 -----------------
223
224 Module for Avance Logic ALS300 and ALS300+
225
226 This module supports multiple cards.
227
228 The power-management is supported.
229
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 Module snd-als4000
231 ------------------
232
233 Module for sound cards based on Avance Logic ALS4000 PCI chip.
234
235 joystick_port - port # for legacy joystick support.
236 0 = disabled (default), 1 = auto-detect
237
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100238 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239
Takashi Iwaia4efc232005-11-17 17:24:26 +0100240 The power-management is supported.
241
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 Module snd-atiixp
243 -----------------
244
Takashi Iwai62430082005-09-05 17:12:29 +0200245 Module for ATI IXP 150/200/250/400 AC97 controllers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
Takashi Iwai62430082005-09-05 17:12:29 +0200247 ac97_clock - AC'97 clock (default = 48000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200249 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 spdif_aclink - S/PDIF transfer over AC-link (default = 1)
251
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200252 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253
Takashi Iwai62430082005-09-05 17:12:29 +0200254 ATI IXP has two different methods to control SPDIF output. One is
255 over AC-link and another is over the "direct" SPDIF output. The
256 implementation depends on the motherboard, and you'll need to
257 choose the correct one via spdif_aclink module option.
258
Takashi Iwaia4efc232005-11-17 17:24:26 +0100259 The power-management is supported.
260
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 Module snd-atiixp-modem
262 -----------------------
263
264 Module for ATI IXP 150/200/250 AC97 modem controllers.
265
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200266 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267
268 Note: The default index value of this module is -2, i.e. the first
269 slot is excluded.
270
Takashi Iwaia4efc232005-11-17 17:24:26 +0100271 The power-management is supported.
272
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 Module snd-au8810, snd-au8820, snd-au8830
274 -----------------------------------------
275
276 Module for Aureal Vortex, Vortex2 and Advantage device.
277
278 pcifix - Control PCI workarounds
279 0 = Disable all workarounds
280 1 = Force the PCI latency of the Aureal card to 0xff
281 2 = Force the Extend PCI#2 Internal Master for Efficient
282 Handling of Dummy Requests on the VIA KT133 AGP Bridge
283 3 = Force both settings
284 255 = Autodetect what is required (default)
285
286 This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
287 EQ, mpu401, gameport. A3D and wavetable support are still in development.
288 Development and reverse engineering work is being coordinated at
289 http://savannah.nongnu.org/projects/openvortex/
290 SPDIF output has a copy of the AC97 codec output, unless you use the
291 "spdif" pcm device, which allows raw data passthru.
292 The hardware EQ hardware and SPDIF is only present in the Vortex2 and
293 Advantage.
294
Takashi Iwai62430082005-09-05 17:12:29 +0200295 Note: Some ALSA mixer applications don't handle the SPDIF sample rate
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 control correctly. If you have problems regarding this, try
297 another ALSA compliant mixer (alsamixer works).
298
299 Module snd-azt2320
300 ------------------
301
302 Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
303
304 port - port # for AZT2320 chip (PnP setup)
305 wss_port - port # for WSS (PnP setup)
306 mpu_port - port # for MPU-401 UART (PnP setup)
307 fm_port - FM port # for AZT2320 chip (PnP setup)
308 irq - IRQ # for AZT2320 (WSS) chip (PnP setup)
309 mpu_irq - IRQ # for MPU-401 UART (PnP setup)
310 dma1 - 1st DMA # for AZT2320 (WSS) chip (PnP setup)
311 dma2 - 2nd DMA # for AZT2320 (WSS) chip (PnP setup)
312
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100313 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
Takashi Iwaia4efc232005-11-17 17:24:26 +0100315 The power-management is supported.
316
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 Module snd-azt3328
318 ------------------
319
320 Module for sound cards based on Aztech AZF3328 PCI chip.
321
322 joystick - Enable joystick (default off)
323
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100324 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
326 Module snd-bt87x
327 ----------------
328
329 Module for video cards based on Bt87x chips.
330
331 digital_rate - Override the default digital rate (Hz)
332 load_all - Load the driver even if the card model isn't known
333
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100334 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335
336 Note: The default index value of this module is -2, i.e. the first
337 slot is excluded.
338
339 Module snd-ca0106
340 -----------------
341
342 Module for Creative Audigy LS and SB Live 24bit
343
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100344 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
346
347 Module snd-cmi8330
348 ------------------
349
350 Module for sound cards based on C-Media CMI8330 ISA chips.
351
352 wssport - port # for CMI8330 chip (WSS)
353 wssirq - IRQ # for CMI8330 chip (WSS)
354 wssdma - first DMA # for CMI8330 chip (WSS)
355 sbport - port # for CMI8330 chip (SB16)
356 sbirq - IRQ # for CMI8330 chip (SB16)
357 sbdma8 - 8bit DMA # for CMI8330 chip (SB16)
358 sbdma16 - 16bit DMA # for CMI8330 chip (SB16)
359
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100360 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
Takashi Iwaia4efc232005-11-17 17:24:26 +0100362 The power-management is supported.
363
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 Module snd-cmipci
365 -----------------
366
367 Module for C-Media CMI8338 and 8738 PCI sound cards.
368
Takashi Iwaicab5c4c2006-05-04 14:36:08 +0200369 mpu_port - 0x300,0x310,0x320,0x330 = legacy port,
370 1 = integrated PCI port,
371 0 = disable (default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 fm_port - 0x388 (default), 0 = disable (default)
Takashi Iwai62430082005-09-05 17:12:29 +0200373 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 (default = 1)
375 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
376
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100377 This module supports autoprobe and multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378
Takashi Iwaia4efc232005-11-17 17:24:26 +0100379 The power-management is supported.
380
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 Module snd-cs4231
382 -----------------
383
384 Module for sound cards based on CS4231 ISA chips.
385
386 port - port # for CS4231 chip
387 mpu_port - port # for MPU-401 UART (optional), -1 = disable
388 irq - IRQ # for CS4231 chip
389 mpu_irq - IRQ # for MPU-401 UART
390 dma1 - first DMA # for CS4231 chip
391 dma2 - second DMA # for CS4231 chip
392
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100393 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 thus main port must be specified!!! Other ports are optional.
395
396 The power-management is supported.
397
398 Module snd-cs4232
399 -----------------
400
401 Module for sound cards based on CS4232/CS4232A ISA chips.
402
403 port - port # for CS4232 chip (PnP setup - 0x534)
404 cport - control port # for CS4232 chip (PnP setup - 0x120,0x210,0xf00)
405 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
406 fm_port - FM port # for CS4232 chip (PnP setup - 0x388), -1 = disable
407 irq - IRQ # for CS4232 chip (5,7,9,11,12,15)
408 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
409 dma1 - first DMA # for CS4232 chip (0,1,3)
410 dma2 - second DMA # for Yamaha CS4232 chip (0,1,3), -1 = disable
411 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
412
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100413 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 thus main port must be specified!!! Other ports are optional.
415
416 The power-management is supported.
417
418 Module snd-cs4236
419 -----------------
420
421 Module for sound cards based on CS4235/CS4236/CS4236B/CS4237B/
422 CS4238B/CS4239 ISA chips.
423
424 port - port # for CS4236 chip (PnP setup - 0x534)
425 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
426 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
427 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
428 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
429 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
430 dma1 - first DMA # for CS4236 chip (0,1,3)
431 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
432 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
433
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100434 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 (if ISA PnP is not used) thus main port and control port must be
436 specified!!! Other ports are optional.
437
438 The power-management is supported.
439
440 Module snd-cs4281
441 -----------------
442
443 Module for Cirrus Logic CS4281 soundchip.
444
445 dual_codec - Secondary codec ID (0 = disable, default)
446
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100447 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
449 The power-management is supported.
450
451 Module snd-cs46xx
452 -----------------
453
454 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
455 CS4624/CS4630/CS4280 PCI chips.
456
Takashi Iwai62430082005-09-05 17:12:29 +0200457 external_amp - Force to enable external amplifier.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 thinkpad - Force to enable Thinkpad's CLKRUN control.
459 mmap_valid - Support OSS mmap mode (default = 0).
460
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100461 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 Usually external amp and CLKRUN controls are detected automatically
463 from PCI sub vendor/device ids. If they don't work, give the options
464 above explicitly.
465
466 The power-management is supported.
467
Takashi Iwai3e873172005-11-17 10:15:37 +0100468 Module snd-cs5535audio
469 ----------------------
470
471 Module for multifunction CS5535 companion PCI device
472
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100473 This module supports multiple cards.
Takashi Iwai3e873172005-11-17 10:15:37 +0100474
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 Module snd-dt019x
476 -----------------
477
478 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
479 only)
480
481 port - Port # (PnP setup)
482 mpu_port - Port # for MPU-401 (PnP setup)
483 fm_port - Port # for FM OPL-3 (PnP setup)
484 irq - IRQ # (PnP setup)
485 mpu_irq - IRQ # for MPU-401 (PnP setup)
486 dma8 - DMA # (PnP setup)
487
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100488 This module supports multiple cards. This module is enabled only with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 ISA PnP support.
490
Takashi Iwaia4efc232005-11-17 17:24:26 +0100491 The power-management is supported.
492
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 Module snd-dummy
494 ----------------
495
496 Module for the dummy sound card. This "card" doesn't do any output
497 or input, but you may use this module for any application which
498 requires a sound card (like RealPlayer).
499
Takashi Iwaia4efc232005-11-17 17:24:26 +0100500 The power-management is supported.
501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 Module snd-emu10k1
503 ------------------
504
505 Module for EMU10K1/EMU10k2 based PCI sound cards.
506 * Sound Blaster Live!
507 * Sound Blaster PCI 512
508 * Emu APS (partially supported)
509 * Sound Blaster Audigy
510
511 extin - bitmap of available external inputs for FX8010 (see bellow)
512 extout - bitmap of available external outputs for FX8010 (see bellow)
513 seq_ports - allocated sequencer ports (4 by default)
514 max_synth_voices - limit of voices used for wavetable (64 by default)
515 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
516 given in MB unit. Default value is 128.
517 enable_ir - enable IR
518
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100519 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520
521 Input & Output configurations [extin/extout]
522 * Creative Card wo/Digital out [0x0003/0x1f03]
523 * Creative Card w/Digital out [0x0003/0x1f0f]
524 * Creative Card w/Digital CD in [0x000f/0x1f0f]
525 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
526 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
527 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
528 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
529 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
530 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
531 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
532 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
533 * Creative Card all ins and outs [0x3fff/0x7fff]
534
Takashi Iwaia4efc232005-11-17 17:24:26 +0100535 The power-management is supported.
536
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 Module snd-emu10k1x
538 -------------------
539
540 Module for Creative Emu10k1X (SB Live Dell OEM version)
541
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100542 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
544 Module snd-ens1370
545 ------------------
546
547 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
548 * SoundBlaster PCI 64
549 * SoundBlaster PCI 128
550
551 joystick - Enable joystick (default off)
552
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100553 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100555 The power-management is supported.
556
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 Module snd-ens1371
558 ------------------
559
560 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
561 * SoundBlaster PCI 64
562 * SoundBlaster PCI 128
563 * SoundBlaster Vibra PCI
564
565 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
566 0 = disable (default), 1 = auto-detect
567
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100568 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100570 The power-management is supported.
571
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 Module snd-es968
573 ----------------
574
575 Module for sound cards based on ESS ES968 chip (PnP only).
576
577 port - port # for ES968 (SB8) chip (PnP setup)
578 irq - IRQ # for ES968 (SB8) chip (PnP setup)
579 dma1 - DMA # for ES968 (SB8) chip (PnP setup)
580
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100581 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582
Takashi Iwaia4efc232005-11-17 17:24:26 +0100583 The power-management is supported.
584
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 Module snd-es1688
586 -----------------
587
588 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
589
590 port - port # for ES-1688 chip (0x220,0x240,0x260)
591 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
592 irq - IRQ # for ES-1688 chip (5,7,9,10)
593 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
594 dma8 - DMA # for ES-1688 chip (0,1,3)
595
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100596 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
598 Module snd-es18xx
599 -----------------
600
601 Module for ESS AudioDrive ES-18xx sound cards.
602
603 port - port # for ES-18xx chip (0x220,0x240,0x260)
604 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
605 fm_port - port # for FM (optional, not used)
606 irq - IRQ # for ES-18xx chip (5,7,9,10)
607 dma1 - first DMA # for ES-18xx chip (0,1,3)
608 dma2 - first DMA # for ES-18xx chip (0,1,3)
609 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
610
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100611 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
612 port if native ISA PnP routines are not used).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 When dma2 is equal with dma1, the driver works as half-duplex.
614
615 The power-management is supported.
616
617 Module snd-es1938
618 -----------------
619
620 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
621
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100622 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
Takashi Iwaia4efc232005-11-17 17:24:26 +0100624 The power-management is supported.
625
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 Module snd-es1968
627 -----------------
628
629 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
630
631 total_bufsize - total buffer size in kB (1-4096kB)
632 pcm_substreams_p - playback channels (1-8, default=2)
633 pcm_substreams_c - capture channels (1-8, default=0)
634 clock - clock (0 = auto-detection)
635 use_pm - support the power-management (0 = off, 1 = on,
636 2 = auto (default))
637 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
638 joystick - enable joystick (default off)
639
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100640 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
642 The power-management is supported.
643
644 Module snd-fm801
645 ----------------
646
647 Module for ForteMedia FM801 based PCI sound cards.
648
649 tea575x_tuner - Enable TEA575x tuner
650 - 1 = MediaForte 256-PCS
651 - 2 = MediaForte 256-PCPR
652 - 3 = MediaForte 64-PCR
653 - High 16-bits are video (radio) device number + 1
654 - example: 0x10002 (MediaForte 256-PCPR, device 1)
655
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100656 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
Takashi Iwaia4efc232005-11-17 17:24:26 +0100658 The power-management is supported.
659
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 Module snd-gusclassic
661 ---------------------
662
663 Module for Gravis UltraSound Classic sound card.
664
665 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
666 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
667 dma1 - DMA # for GF1 chip (1,3,5,6,7)
668 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
669 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
670 voices - GF1 voices limit (14-32)
671 pcm_voices - reserved PCM voices
672
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100673 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674
675 Module snd-gusextreme
676 ---------------------
677
678 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
679
680 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
681 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
682 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
683 irq - IRQ # for ES-1688 chip (5,7,9,10)
684 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
685 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
686 dma8 - DMA # for ES-1688 chip (0,1,3)
687 dma1 - DMA # for GF1 chip (1,3,5,6,7)
688 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
689 voices - GF1 voices limit (14-32)
690 pcm_voices - reserved PCM voices
691
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100692 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
694 Module snd-gusmax
695 -----------------
696
697 Module for Gravis UltraSound MAX sound card.
698
699 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
700 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
701 dma1 - DMA # for GF1 chip (1,3,5,6,7)
702 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
703 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
704 voices - GF1 voices limit (14-32)
705 pcm_voices - reserved PCM voices
706
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100707 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
709 Module snd-hda-intel
710 --------------------
711
Takashi Iwai9b878192006-05-17 11:26:39 +0200712 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8),
713 ATI SB450, SB600, RS600,
714 VIA VT8251/VT8237A,
715 SIS966, ULI M5461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716
717 model - force the model name
Takashi Iwai62430082005-09-05 17:12:29 +0200718 position_fix - Fix DMA pointer (0 = auto, 1 = none, 2 = POSBUF, 3 = FIFO size)
Takashi Iwai27346162006-01-12 18:28:44 +0100719 single_cmd - Use single immediate commands to communicate with
720 codecs (for debugging only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200722 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
724 Each codec may have a model table for different configurations.
725 If your machine isn't listed there, the default (usually minimal)
726 configuration is set up. You can pass "model=<name>" option to
727 specify a certain model in such a case. There are different
728 models depending on the codec chip.
729
730 Model name Description
731 ---------- -----------
732 ALC880
733 3stack 3-jack in back and a headphone out
734 3stack-digout 3-jack in back, a HP out and a SPDIF out
735 5stack 5-jack in back, 2-jack in front
736 5stack-digout 5-jack in back, 2-jack in front, a SPDIF out
Takashi Iwaib6482d42005-06-27 15:32:43 +0200737 6stack 6-jack in back, 2-jack in front
738 6stack-digout 6-jack with a SPDIF out
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 w810 3-jack
Takashi Iwaidfc0ff62005-05-12 14:31:49 +0200740 z71v 3-jack (HP shared SPDIF)
Takashi Iwaie9edcee2005-06-13 14:16:38 +0200741 asus 3-jack
742 uniwill 3-jack
743 F1734 2-jack
Takashi Iwaiae6b8132006-03-03 16:47:17 +0100744 lg LG laptop (m1 express dual)
Takashi Iwaid6815182006-03-23 16:06:23 +0100745 lg-lw LG LW20 laptop
Takashi Iwaib6482d42005-06-27 15:32:43 +0200746 test for testing/debugging purpose, almost all controls can be
747 adjusted. Appearing only when compiled with
748 $CONFIG_SND_DEBUG=y
Takashi Iwaied345f82006-03-01 14:16:53 +0100749 auto auto-config reading BIOS (default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750
Takashi Iwai21be3d12005-09-16 19:18:56 +0200751 ALC260
752 hp HP machines
753 fujitsu Fujitsu S7020
Takashi Iwaied345f82006-03-01 14:16:53 +0100754 acer Acer TravelMate
755 basic fixed pin assignment (old default model)
756 auto auto-config reading BIOS (default)
757
758 ALC262
759 fujitsu Fujitsu Laptop
760 basic fixed pin assignment w/o SPDIF
761 auto auto-config reading BIOS (default)
762
763 ALC882/883/885
764 3stack-dig 3-jack with SPDIF I/O
765 6stck-dig 6-jack digital with SPDIF I/O
766 auto auto-config reading BIOS (default)
767
768 ALC861
769 3stack 3-jack
770 3stack-dig 3-jack with SPDIF I/O
771 6stack-dig 6-jack with SPDIF I/O
772 auto auto-config reading BIOS (default)
Takashi Iwai21be3d12005-09-16 19:18:56 +0200773
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 CMI9880
775 minimal 3-jack in back
776 min_fp 3-jack in back, 2-jack in front
777 full 6-jack in back, 2-jack in front
778 full_dig 6-jack in back, 2-jack in front, SPDIF I/O
779 allout 5-jack in back, 2-jack in front, SPDIF out
Takashi Iwaie9edcee2005-06-13 14:16:38 +0200780 auto auto-config reading BIOS (default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781
Takashi Iwai9230d212006-03-13 13:49:49 +0100782 AD1981
783 basic 3-jack (default)
784 hp HP nx6320
Takashi Iwai01686c52006-04-18 12:54:11 +0200785 thinkpad Lenovo Thinkpad T60/X60/Z60
Takashi Iwai9230d212006-03-13 13:49:49 +0100786
787 AD1986A
788 6stack 6-jack, separate surrounds (default)
789 3stack 3-stack, shared surrounds
790 laptop 2-channel only (FSC V2060, Samsung M50)
Takashi Iwai825aa972006-03-17 10:50:49 +0100791 laptop-eapd 2-channel with EAPD (Samsung R65, ASUS A6J)
Takashi Iwai9230d212006-03-13 13:49:49 +0100792
793 AD1988
794 6stack 6-jack
795 6stack-dig ditto with SPDIF
796 3stack 3-jack
797 3stack-dig ditto with SPDIF
798 laptop 3-jack with hp-jack automute
799 laptop-dig ditto with SPDIF
800 auto auto-confgi reading BIOS (default)
801
Takashi Iwaidb064e52006-03-16 16:04:58 +0100802 STAC7661(?)
803 vaio Setup for VAIO FE550G/SZ110
804
Takashi Iwai62430082005-09-05 17:12:29 +0200805 If the default configuration doesn't work and one of the above
806 matches with your device, report it together with the PCI
807 subsystem ID (output of "lspci -nv") to ALSA BTS or alsa-devel
808 ML (see the section "Links and Addresses").
809
Takashi Iwaic74db862005-05-12 14:26:27 +0200810 Note 2: If you get click noises on output, try the module option
811 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
812 register value without FIFO size correction as the current
813 DMA pointer. position_fix=2 will make the driver to use
814 the position buffer instead of reading SD_LPIB register.
815 (Usually SD_LPLIB register is more accurate than the
816 position buffer.)
817
Takashi Iwai27346162006-01-12 18:28:44 +0100818 NB: If you get many "azx_get_response timeout" messages at
819 loading, it's likely a problem of interrupts (e.g. ACPI irq
820 routing). Try to boot with options like "pci=noacpi". Also, you
821 can try "single_cmd=1" module option. This will switch the
822 communication method between HDA controller and codecs to the
823 single immediate commands instead of CORB/RIRB. Basically, the
824 single command mode is provided only for BIOS, and you won't get
825 unsolicited events, too. But, at least, this works independently
826 from the irq. Remember this is a last resort, and should be
827 avoided as much as possible...
828
Takashi Iwaia4efc232005-11-17 17:24:26 +0100829 The power-management is supported.
830
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 Module snd-hdsp
832 ---------------
833
834 Module for RME Hammerfall DSP audio interface(s)
835
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100836 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837
838 Note: The firmware data can be automatically loaded via hotplug
839 when CONFIG_FW_LOADER is set. Otherwise, you need to load
840 the firmware via hdsploader utility included in alsa-tools
841 package.
842 The firmware data is found in alsa-firmware package.
843
844 Note: snd-page-alloc module does the job which snd-hammerfall-mem
845 module did formerly. It will allocate the buffers in advance
846 when any HDSP cards are found. To make the buffer
847 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +0200848 stage of boot sequence. See "Early Buffer Allocation"
849 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850
Takashi Iwai54704402005-06-03 11:27:00 +0200851 Module snd-hdspm
852 ----------------
853
854 Module for RME HDSP MADI board.
855
856 precise_ptr - Enable precise pointer, or disable.
857 line_outs_monitor - Send playback streams to analog outs by default.
858 enable_monitor - Enable Analog Out on Channel 63/64 by default.
859
860 See hdspm.txt for details.
861
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 Module snd-ice1712
863 ------------------
864
865 Module for Envy24 (ICE1712) based PCI sound cards.
866 * MidiMan M Audio Delta 1010
867 * MidiMan M Audio Delta 1010LT
868 * MidiMan M Audio Delta DiO 2496
869 * MidiMan M Audio Delta 66
870 * MidiMan M Audio Delta 44
871 * MidiMan M Audio Delta 410
872 * MidiMan M Audio Audiophile 2496
873 * TerraTec EWS 88MT
874 * TerraTec EWS 88D
875 * TerraTec EWX 24/96
876 * TerraTec DMX 6Fire
Takashi Iwaic9bce912005-05-24 13:41:03 +0200877 * TerraTec Phase 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 * Hoontech SoundTrack DSP 24
879 * Hoontech SoundTrack DSP 24 Value
880 * Hoontech SoundTrack DSP 24 Media 7.1
Takashi Iwaic9bce912005-05-24 13:41:03 +0200881 * Event Electronics, EZ8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 * Digigram VX442
Takashi Iwaic9bce912005-05-24 13:41:03 +0200883 * Lionstracs, Mediastaton
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884
885 model - Use the given board model, one of the following:
886 delta1010, dio2496, delta66, delta44, audiophile, delta410,
887 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
Takashi Iwaic9bce912005-05-24 13:41:03 +0200888 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
889 phase88, mediastation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890 omni - Omni I/O support for MidiMan M-Audio Delta44/66
891 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transciever)
892 in msec resolution, default value is 500 (0.5 sec)
893
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100894 This module supports multiple cards and autoprobe. Note: The consumer part
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 is not used with all Envy24 based cards (for example in the MidiMan Delta
896 serie).
897
Takashi Iwaic9bce912005-05-24 13:41:03 +0200898 Note: The supported board is detected by reading EEPROM or PCI
899 SSID (if EEPROM isn't available). You can override the
900 model by passing "model" module option in case that the
901 driver isn't configured properly or you want to try another
902 type for testing.
903
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904 Module snd-ice1724
905 ------------------
906
Takashi Iwaic9bce912005-05-24 13:41:03 +0200907 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100908 * MidiMan M Audio Revolution 5.1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 * MidiMan M Audio Revolution 7.1
910 * AMP Ltd AUDIO2000
Takashi Iwaic9bce912005-05-24 13:41:03 +0200911 * TerraTec Aureon 5.1 Sky
912 * TerraTec Aureon 7.1 Space
913 * TerraTec Aureon 7.1 Universe
914 * TerraTec Phase 22
915 * TerraTec Phase 28
916 * AudioTrak Prodigy 7.1
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100917 * AudioTrak Prodigy 7.1LT
Takashi Iwaic9bce912005-05-24 13:41:03 +0200918 * AudioTrak Prodigy 192
919 * Pontis MS300
920 * Albatron K8X800 Pro II
921 * Chaintech ZNF3-150
922 * Chaintech ZNF3-250
923 * Chaintech 9CJS
Takashi Iwai8cfbbac2005-05-27 12:10:40 +0200924 * Chaintech AV-710
Takashi Iwaic9bce912005-05-24 13:41:03 +0200925 * Shuttle SN25P
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926
927 model - Use the given board model, one of the following:
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100928 revo51, revo71, amp2000, prodigy71, prodigy71lt,
929 prodigy192, aureon51, aureon71, universe,
930 k8x800, phase22, phase28, ms300, av710
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100932 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933
Takashi Iwaic9bce912005-05-24 13:41:03 +0200934 Note: The supported board is detected by reading EEPROM or PCI
935 SSID (if EEPROM isn't available). You can override the
936 model by passing "model" module option in case that the
937 driver isn't configured properly or you want to try another
938 type for testing.
939
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 Module snd-intel8x0
941 -------------------
942
943 Module for AC'97 motherboards from Intel and compatibles.
944 * Intel i810/810E, i815, i820, i830, i84x, MX440
Takashi Iwai89ac9c22006-01-24 10:36:57 +0100945 ICH5, ICH6, ICH7, ESB2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 * SiS 7012 (SiS 735)
Takashi Iwai89ac9c22006-01-24 10:36:57 +0100947 * NVidia NForce, NForce2, NForce3, MCP04, CK804
948 CK8, CK8S, MCP501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949 * AMD AMD768, AMD8111
950 * ALi m5455
951
952 ac97_clock - AC'97 codec clock base (0 = auto-detect)
953 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200954 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 buggy_irq - Enable workaround for buggy interrupts on some
Takashi Iwaia06147d2005-09-08 19:54:17 +0200956 motherboards (default yes on nForce chips,
957 otherwise off)
958 buggy_semaphore - Enable workaround for hardwares with buggy
959 semaphores (e.g. on some ASUS laptops)
960 (default off)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200962 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963
964 Note: the latest driver supports auto-detection of chip clock.
965 if you still encounter too fast playback, specify the clock
966 explicitly via the module option "ac97_clock=41194".
967
968 Joystick/MIDI ports are not supported by this driver. If your
969 motherboard has these devices, use the ns558 or snd-mpu401
970 modules, respectively.
971
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 The power-management is supported.
973
974 Module snd-intel8x0m
975 --------------------
976
977 Module for Intel ICH (i8x0) chipset MC97 modems.
Takashi Iwai89ac9c22006-01-24 10:36:57 +0100978 * Intel i810/810E, i815, i820, i830, i84x, MX440
979 ICH5, ICH6, ICH7
980 * SiS 7013 (SiS 735)
981 * NVidia NForce, NForce2, NForce2s, NForce3
982 * AMD AMD8111
983 * ALi m5455
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984
985 ac97_clock - AC'97 codec clock base (0 = auto-detect)
986
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200987 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988
989 Note: The default index value of this module is -2, i.e. the first
990 slot is excluded.
991
Takashi Iwaia4efc232005-11-17 17:24:26 +0100992 The power-management is supported.
993
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994 Module snd-interwave
995 --------------------
996
997 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
998 and other sound cards based on AMD InterWave (tm) chip.
999
1000 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1001 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1002 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1003 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
1004 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1005 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1006 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1007 effect - 1 = InterWave effects enable (default 0);
1008 requires 8 voices
1009
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001010 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011
1012 Module snd-interwave-stb
1013 ------------------------
1014
1015 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1016 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1017 circuit for extended control of bass, treble and master volume.
1018
1019 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1020 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1021 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1022 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1023 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
1024 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1025 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1026 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1027 effect - 1 = InterWave effects enable (default 0);
1028 requires 8 voices
1029
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001030 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031
1032 Module snd-korg1212
1033 -------------------
1034
1035 Module for Korg 1212 IO PCI card
1036
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001037 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038
1039 Module snd-maestro3
1040 -------------------
1041
1042 Module for Allegro/Maestro3 chips
1043
1044 external_amp - enable external amp (enabled by default)
1045 amp_gpio - GPIO pin number for external amp (0-15) or
1046 -1 for default pin (8 for allegro, 1 for
1047 others)
1048
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001049 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050
1051 Note: the binding of amplifier is dependent on hardware.
1052 If there is no sound even though all channels are unmuted, try to
1053 specify other gpio connection via amp_gpio option.
1054 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1055 option.
1056
1057 The power-management is supported.
1058
Martin Langer1841f612006-03-27 12:41:01 +02001059 Module snd-miro
1060 ---------------
1061
1062 Module for Miro soundcards: miroSOUND PCM 1 pro,
1063 miroSOUND PCM 12,
1064 miroSOUND PCM 20 Radio.
1065
1066 port - Port # (0x530,0x604,0xe80,0xf40)
1067 irq - IRQ # (5,7,9,10,11)
1068 dma1 - 1st dma # (0,1,3)
1069 dma2 - 2nd dma # (0,1)
1070 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1071 mpu_irq - MPU-401 irq # (5,7,9,10)
1072 fm_port - FM Port # (0x388)
1073 wss - enable WSS mode
1074 ide - enable onboard ide support
1075
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076 Module snd-mixart
1077 -----------------
1078
1079 Module for Digigram miXart8 sound cards.
1080
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001081 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 Note: One miXart8 board will be represented as 4 alsa cards.
1083 See MIXART.txt for details.
1084
1085 When the driver is compiled as a module and the hotplug firmware
1086 is supported, the firmware data is loaded via hotplug automatically.
1087 Install the necessary firmware files in alsa-firmware package.
1088 When no hotplug fw loader is available, you need to load the
1089 firmware via mixartloader utility in alsa-tools package.
1090
1091 Module snd-mpu401
1092 -----------------
1093
1094 Module for MPU-401 UART devices.
1095
1096 port - port number or -1 (disable)
1097 irq - IRQ number or -1 (disable)
1098 pnp - PnP detection - 0 = disable, 1 = enable (default)
1099
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001100 This module supports multiple devices and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101
1102 Module snd-mtpav
1103 ----------------
1104
1105 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1106 port).
1107
1108 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1109 irq - IRQ # for MTPAV (7,5, default=7)
1110 hwports - number of supported hardware ports, default=8.
1111
1112 Module supports only 1 card. This module has no enable option.
1113
1114 Module snd-nm256
1115 ----------------
1116
1117 Module for NeoMagic NM256AV/ZX chips
1118
1119 playback_bufsize - max playback frame size in kB (4-128kB)
1120 capture_bufsize - max capture frame size in kB (4-128kB)
1121 force_ac97 - 0 or 1 (disabled by default)
1122 buffer_top - specify buffer top address
1123 use_cache - 0 or 1 (disabled by default)
1124 vaio_hack - alias buffer_top=0x25a800
1125 reset_workaround - enable AC97 RESET workaround for some laptops
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001126 reset_workaround2 - enable extended AC97 RESET workaround for some
1127 other laptops
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +02001129 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130
1131 The power-management is supported.
1132
1133 Note: on some notebooks the buffer address cannot be detected
1134 automatically, or causes hang-up during initialization.
1135 In such a case, specify the buffer top address explicity via
1136 buffer_top option.
1137 For example,
1138 Sony F250: buffer_top=0x25a800
1139 Sony F270: buffer_top=0x272800
1140 The driver supports only ac97 codec. It's possible to force
1141 to initialize/use ac97 although it's not detected. In such a
1142 case, use force_ac97=1 option - but *NO* guarantee whether it
1143 works!
1144
1145 Note: The NM256 chip can be linked internally with non-AC97
1146 codecs. This driver supports only the AC97 codec, and won't work
1147 with machines with other (most likely CS423x or OPL3SAx) chips,
1148 even though the device is detected in lspci. In such a case, try
1149 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
Takashi Iwai62430082005-09-05 17:12:29 +02001150 but some doesn't have ISA PnP. You'll need to specify isapnp=0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 and proper hardware parameters in the case without ISA PnP.
1152
1153 Note: some laptops need a workaround for AC97 RESET. For the
1154 known hardware like Dell Latitude LS and Sony PCG-F305, this
1155 workaround is enabled automatically. For other laptops with a
1156 hard freeze, you can try reset_workaround=1 option.
1157
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001158 Note: Dell Latitude CSx laptops have another problem regarding
1159 AC97 RESET. On these laptops, reset_workaround2 option is
1160 turned on as default. This option is worth to try if the
1161 previous reset_workaround option doesn't help.
1162
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163 Note: This driver is really crappy. It's a porting from the
1164 OSS driver, which is a result of black-magic reverse engineering.
1165 The detection of codec will fail if the driver is loaded *after*
1166 X-server as described above. You might be able to force to load
1167 the module, but it may result in hang-up. Hence, make sure that
1168 you load this module *before* X if you encounter this kind of
1169 problem.
1170
1171 Module snd-opl3sa2
1172 ------------------
1173
1174 Module for Yamaha OPL3-SA2/SA3 sound cards.
1175
1176 port - control port # for OPL3-SA chip (0x370)
1177 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1178 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1179 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1180 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1181 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1182 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1183 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
1184 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1185
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001186 This module supports multiple cards and ISA PnP. It does not support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1188
1189 The power-management is supported.
1190
1191 Module snd-opti92x-ad1848
1192 -------------------------
1193
1194 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1195 Module works with OAK Mozart cards as well.
1196
1197 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1198 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1199 fm_port - port # for OPL3 device (0x388)
1200 irq - IRQ # for WSS chip (5,7,9,10,11)
1201 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1202 dma1 - first DMA # for WSS chip (0,1,3)
1203
1204 This module supports only one card, autoprobe and PnP.
1205
1206 Module snd-opti92x-cs4231
1207 -------------------------
1208
1209 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1210
1211 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1212 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1213 fm_port - port # for OPL3 device (0x388)
1214 irq - IRQ # for WSS chip (5,7,9,10,11)
1215 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1216 dma1 - first DMA # for WSS chip (0,1,3)
1217 dma2 - second DMA # for WSS chip (0,1,3)
1218
1219 This module supports only one card, autoprobe and PnP.
1220
1221 Module snd-opti93x
1222 ------------------
1223
1224 Module for sound cards based on OPTi 82c93x chips.
1225
1226 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1227 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1228 fm_port - port # for OPL3 device (0x388)
1229 irq - IRQ # for WSS chip (5,7,9,10,11)
1230 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1231 dma1 - first DMA # for WSS chip (0,1,3)
1232 dma2 - second DMA # for WSS chip (0,1,3)
1233
1234 This module supports only one card, autoprobe and PnP.
1235
Markus Bollingere12229b2005-12-06 13:55:26 +01001236 Module snd-pcxhr
1237 ----------------
1238
1239 Module for Digigram PCXHR boards
1240
1241 This module supports multiple cards.
1242
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243 Module snd-powermac (on ppc only)
1244 ---------------------------------
1245
1246 Module for PowerMac, iMac and iBook on-board soundchips
1247
1248 enable_beep - enable beep using PCM (enabled as default)
1249
1250 Module supports autoprobe a chip.
1251
1252 Note: the driver may have problems regarding endianess.
1253
1254 The power-management is supported.
1255
Takashi Iwai2c484df2005-06-30 18:54:04 +02001256 Module snd-pxa2xx-ac97 (on arm only)
1257 ------------------------------------
1258
1259 Module for AC97 driver for the Intel PXA2xx chip
1260
1261 For ARM architecture only.
1262
Takashi Iwaia4efc232005-11-17 17:24:26 +01001263 The power-management is supported.
1264
Peter Gruber109a9632006-03-27 13:10:28 +02001265 Module snd-riptide
1266 ------------------
1267
1268 Module for Conexant Riptide chip
1269
1270 joystick_port - Joystick port # (default: 0x200)
1271 mpu_port - MPU401 port # (default: 0x330)
1272 opl3_port - OPL3 port # (default: 0x388)
1273
1274 This module supports multiple cards.
1275 The driver requires the firmware loader support on kernel.
1276 You need to install the firmware file "riptide.hex" to the standard
1277 firmware path (e.g. /lib/firmware).
1278
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279 Module snd-rme32
1280 ----------------
1281
1282 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1283 Prodif96 and Prodif Gold) sound cards.
1284
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001285 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286
1287 Module snd-rme96
1288 ----------------
1289
1290 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1291
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001292 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293
1294 Module snd-rme9652
1295 ------------------
1296
1297 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1298
1299 precise_ptr - Enable precise pointer (doesn't work reliably).
1300 (default = 0)
1301
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001302 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303
1304 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1305 module did formerly. It will allocate the buffers in advance
1306 when any RME9652 cards are found. To make the buffer
1307 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +02001308 stage of boot sequence. See "Early Buffer Allocation"
1309 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310
1311 Module snd-sa11xx-uda1341 (on arm only)
1312 ---------------------------------------
1313
1314 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1315
1316 Module supports only one card.
1317 Module has no enable and index options.
1318
Takashi Iwaia4efc232005-11-17 17:24:26 +01001319 The power-management is supported.
1320
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 Module snd-sb8
1322 --------------
1323
1324 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1325 SoundBlaster 2.0,
1326 SoundBlaster Pro
1327
1328 port - port # for SB DSP chip (0x220,0x240,0x260)
1329 irq - IRQ # for SB DSP chip (5,7,9,10)
1330 dma8 - DMA # for SB DSP chip (1,3)
1331
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001332 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333
Takashi Iwaia4efc232005-11-17 17:24:26 +01001334 The power-management is supported.
1335
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 Module snd-sb16 and snd-sbawe
1337 -----------------------------
1338
1339 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1340 SoundBlaster AWE 32 (PnP),
1341 SoundBlaster AWE 64 PnP
1342
1343 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1344 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1345 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1346 (snd-sbawe module only)
1347 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1348 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1349 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
1350 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1351 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1352 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1353
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001354 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355
1356 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1357 disable 16bit DMA with dma16 = -1 module parameter.
1358 Also, all Sound Blaster 16 type cards can operate in 16-bit
1359 half duplex mode through 8-bit DMA channel by disabling their
1360 16-bit DMA channel.
1361
Takashi Iwaia4efc232005-11-17 17:24:26 +01001362 The power-management is supported.
1363
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 Module snd-sgalaxy
1365 ------------------
1366
1367 Module for Aztech Sound Galaxy sound card.
1368
1369 sbport - Port # for SB16 interface (0x220,0x240)
1370 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1371 irq - IRQ # (7,9,10,11)
1372 dma1 - DMA #
1373
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001374 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375
Takashi Iwaia4efc232005-11-17 17:24:26 +01001376 The power-management is supported.
1377
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 Module snd-sscape
1379 -----------------
1380
1381 Module for ENSONIQ SoundScape PnP cards.
1382
1383 port - Port # (PnP setup)
1384 irq - IRQ # (PnP setup)
1385 mpu_irq - MPU-401 IRQ # (PnP setup)
1386 dma - DMA # (PnP setup)
1387
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001388 This module supports multiple cards. ISA PnP must be enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 You need sscape_ctl tool in alsa-tools package for loading
1390 the microcode.
1391
1392 Module snd-sun-amd7930 (on sparc only)
1393 --------------------------------------
1394
1395 Module for AMD7930 sound chips found on Sparcs.
1396
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001397 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398
1399 Module snd-sun-cs4231 (on sparc only)
1400 -------------------------------------
1401
1402 Module for CS4231 sound chips found on Sparcs.
1403
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001404 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001406 Module snd-sun-dbri (on sparc only)
1407 -----------------------------------
1408
1409 Module for DBRI sound chips found on Sparcs.
1410
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001411 This module supports multiple cards.
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001412
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 Module snd-wavefront
1414 --------------------
1415
1416 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1417
1418 cs4232_pcm_port - Port # for CS4232 PCM interface.
1419 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1420 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1421 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
1422 use_cs4232_midi - Use CS4232 MPU-401 interface
1423 (inaccessibly located inside your computer)
1424 ics2115_port - Port # for ICS2115
1425 ics2115_irq - IRQ # for ICS2115
1426 fm_port - FM OPL-3 Port #
1427 dma1 - DMA1 # for CS4232 PCM interface.
1428 dma2 - DMA2 # for CS4232 PCM interface.
1429 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1430
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001431 This module supports multiple cards and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432
1433 Module snd-sonicvibes
1434 ---------------------
1435
1436 Module for S3 SonicVibes PCI sound cards.
1437 * PINE Schubert 32 PCI
1438
1439 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1440 - SoundCard must have onboard SRAM for this.
1441 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1442
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001443 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444
1445 Module snd-serial-u16550
1446 ------------------------
1447
1448 Module for UART16550A serial MIDI ports.
1449
1450 port - port # for UART16550A chip
1451 irq - IRQ # for UART16550A chip, -1 = poll mode
1452 speed - speed in bauds (9600,19200,38400,57600,115200)
1453 38400 = default
1454 base - base for divisor in bauds (57600,115200,230400,460800)
1455 115200 = default
1456 outs - number of MIDI ports in a serial port (1-4)
1457 1 = default
1458 adaptor - Type of adaptor.
1459 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1460 3 = MS-124W M/B, 4 = Generic
1461
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001462 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 thus the main port must be specified!!! Other options are optional.
1464
1465 Module snd-trident
1466 ------------------
1467
1468 Module for Trident 4DWave DX/NX sound cards.
1469 * Best Union Miss Melody 4DWave PCI
1470 * HIS 4DWave PCI
1471 * Warpspeed ONSpeed 4DWave PCI
1472 * AzTech PCI 64-Q3D
1473 * Addonics SV 750
1474 * CHIC True Sound 4Dwave
1475 * Shark Predator4D-PCI
1476 * Jaton SonicWave 4D
1477
1478 pcm_channels - max channels (voices) reserved for PCM
1479 wavetable_size - max wavetable size in kB (4-?kb)
1480
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001481 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001482
1483 The power-management is supported.
1484
1485 Module snd-usb-audio
1486 --------------------
1487
1488 Module for USB audio and USB MIDI devices.
1489
1490 vid - Vendor ID for the device (optional)
1491 pid - Product ID for the device (optional)
Thibault LE MEURe3113342006-03-14 11:44:53 +01001492 device_setup - Device specific magic number (optional)
1493 - Influence depends on the device
1494 - Default: 0x0000
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001496 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497
1498 Module snd-usb-usx2y
1499 --------------------
1500
1501 Module for Tascam USB US-122, US-224 and US-428 devices.
1502
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001503 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504
1505 Note: you need to load the firmware via usx2yloader utility included
1506 in alsa-tools and alsa-firmware packages.
1507
1508 Module snd-via82xx
1509 ------------------
1510
1511 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001512 8233A, 8233C, 8235, 8237 (south) bridge.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513
1514 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1515 [VIA686A/686B only]
1516 joystick - Enable joystick (default off) [VIA686A/686B only]
1517 ac97_clock - AC'97 codec clock base (default 48000Hz)
1518 dxs_support - support DXS channels,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001519 0 = auto (default), 1 = enable, 2 = disable,
1520 3 = 48k only, 4 = no VRA, 5 = enable any sample
1521 rate and different sample rates on different
1522 channels
1523 [VIA8233/C, 8235, 8237 only]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001525 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001527 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001528
1529 Note: on some SMP motherboards like MSI 694D the interrupts might
1530 not be generated properly. In such a case, please try to
1531 set the SMP (or MPS) version on BIOS to 1.1 instead of
1532 default value 1.4. Then the interrupt number will be
1533 assigned under 15. You might also upgrade your BIOS.
1534
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001535 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536 channels as the first PCM. On these channels, up to 4
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001537 streams can be played at the same time, and the controller
1538 can perform sample rate conversion with separate rates for
1539 each channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540 As default (dxs_support = 0), 48k fixed rate is chosen
1541 except for the known devices since the output is often
1542 noisy except for 48k on some mother boards due to the
1543 bug of BIOS.
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001544 Please try once dxs_support=5 and if it works on other
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1546 know the PCI subsystem vendor/device id's (output of
1547 "lspci -nv").
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001548 If dxs_support=5 does not work, try dxs_support=4; if it
1549 doesn't work too, try dxs_support=1. (dxs_support=1 is
Takashi Iwai62430082005-09-05 17:12:29 +02001550 usually for old motherboards. The correct implemented
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001551 board should work with 4 or 5.) If it still doesn't
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 work and the default setting is ok, dxs_support=3 is the
1553 right choice. If the default setting doesn't work at all,
1554 try dxs_support=2 to disable the DXS channels.
1555 In any cases, please let us know the result and the
Takashi Iwai62430082005-09-05 17:12:29 +02001556 subsystem vendor/device ids. See "Links and Addresses"
1557 below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001558
1559 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Takashi Iwai62430082005-09-05 17:12:29 +02001560 additionally. The mpu_port option is for VIA686 chips only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561
Takashi Iwaia4efc232005-11-17 17:24:26 +01001562 The power-management is supported.
1563
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 Module snd-via82xx-modem
1565 ------------------------
1566
1567 Module for VIA82xx AC97 modem
1568
1569 ac97_clock - AC'97 codec clock base (default 48000Hz)
1570
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001571 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572
1573 Note: The default index value of this module is -2, i.e. the first
1574 slot is excluded.
1575
Takashi Iwaia4efc232005-11-17 17:24:26 +01001576 The power-management is supported.
1577
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578 Module snd-virmidi
1579 ------------------
1580
1581 Module for virtual rawmidi devices.
1582 This module creates virtual rawmidi devices which communicate
1583 to the corresponding ALSA sequencer ports.
1584
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001585 midi_devs - MIDI devices # (1-4, default=4)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001587 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588
1589 Module snd-vx222
1590 ----------------
1591
1592 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1593
1594 mic - Enable Microphone on V222 Mic (NYI)
1595 ibl - Capture IBL size. (default = 0, minimum size)
1596
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001597 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598
1599 When the driver is compiled as a module and the hotplug firmware
1600 is supported, the firmware data is loaded via hotplug automatically.
1601 Install the necessary firmware files in alsa-firmware package.
1602 When no hotplug fw loader is available, you need to load the
1603 firmware via vxloader utility in alsa-tools package. To invoke
1604 vxloader automatically, add the following to /etc/modprobe.conf
1605
1606 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1607
1608 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1609 /etc/modules.conf, instead.)
1610 IBL size defines the interrupts period for PCM. The smaller size
1611 gives smaller latency but leads to more CPU consumption, too.
1612 The size is usually aligned to 126. As default (=0), the smallest
1613 size is chosen. The possible IBL values can be found in
1614 /proc/asound/cardX/vx-status proc file.
1615
Takashi Iwaia4efc232005-11-17 17:24:26 +01001616 The power-management is supported.
1617
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 Module snd-vxpocket
1619 -------------------
1620
Takashi Iwai6d00a312005-06-30 13:40:51 +02001621 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622
1623 ibl - Capture IBL size. (default = 0, minimum size)
1624
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001625 This module supports multiple cards. The module is compiled only when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 PCMCIA is supported on kernel.
1627
Takashi Iwai62430082005-09-05 17:12:29 +02001628 With the older 2.6.x kernel, to activate the driver via the card
1629 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1630 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1631 longer require a config file.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632
1633 When the driver is compiled as a module and the hotplug firmware
1634 is supported, the firmware data is loaded via hotplug automatically.
1635 Install the necessary firmware files in alsa-firmware package.
1636 When no hotplug fw loader is available, you need to load the
1637 firmware via vxloader utility in alsa-tools package.
1638
1639 About capture IBL, see the description of snd-vx222 module.
1640
Takashi Iwaied7cbe32006-05-11 11:30:10 +02001641 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
Takashi Iwai62430082005-09-05 17:12:29 +02001642 ALSA 1.0.10.
1643
Takashi Iwaia4efc232005-11-17 17:24:26 +01001644 The power-management is supported.
1645
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 Module snd-ymfpci
1647 -----------------
1648
1649 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1650
1651 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1652 1 (auto-detect for YMF744/754 only)
1653 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1654 1 (auto-detect for YMF744/754 only)
1655 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1656 1 (auto-detect)
1657 rear_switch - enable shared rear/line-in switch (bool)
1658
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001659 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660
1661 The power-management is supported.
1662
1663 Module snd-pdaudiocf
1664 --------------------
1665
1666 Module for Sound Core PDAudioCF sound card.
1667
Takashi Iwaia4efc232005-11-17 17:24:26 +01001668 The power-management is supported.
1669
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670
Takashi Iwai62430082005-09-05 17:12:29 +02001671AC97 Quirk Option
1672=================
1673
1674The ac97_quirk option is used to enable/override the workaround for
1675specific devices on drivers for on-board AC'97 controllers like
1676snd-intel8x0. Some hardware have swapped output pins between Master
1677and Headphone, or Surround (thanks to confusion of AC'97
1678specifications from version to version :-)
1679
1680The driver provides the auto-detection of known problematic devices,
1681but some might be unknown or wrongly detected. In such a case, pass
1682the proper value with this option.
1683
1684The following strings are accepted:
1685 - default Don't override the default setting
Takashi Iwai10e4097f2005-11-17 11:04:55 +01001686 - none Disable the quirk
Takashi Iwai62430082005-09-05 17:12:29 +02001687 - hp_only Bind Master and Headphone controls as a single control
1688 - swap_hp Swap headphone and master controls
1689 - swap_surround Swap master and surround controls
1690 - ad_sharing For AD1985, turn on OMS bit and use headphone
1691 - alc_jack For ALC65x, turn on the jack sense mode
1692 - inv_eapd Inverted EAPD implementation
1693 - mute_led Bind EAPD bit for turning on/off mute LED
1694
1695For backward compatibility, the corresponding integer value -1, 0,
1696... are accepted, too.
1697
1698For example, if "Master" volume control has no effect on your device
1699but only "Headphone" does, pass ac97_quirk=hp_only module option.
1700
1701
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702Configuring Non-ISAPNP Cards
1703============================
1704
1705When the kernel is configured with ISA-PnP support, the modules
1706supporting the isapnp cards will have module options "isapnp".
1707If this option is set, *only* the ISA-PnP devices will be probed.
1708For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
1709together with the proper i/o and irq configuration.
1710
1711When the kernel is configured without ISA-PnP support, isapnp option
1712will be not built in.
1713
1714
1715Module Autoloading Support
1716==========================
1717
1718The ALSA drivers can be loaded automatically on demand by defining
1719module aliases. The string 'snd-card-%1' is requested for ALSA native
1720devices where %i is sound card number from zero to seven.
1721
1722To auto-load an ALSA driver for OSS services, define the string
1723'sound-slot-%i' where %i means the slot number for OSS, which
1724corresponds to the card index of ALSA. Usually, define this
Tobias Klauserd533f672005-09-10 00:26:46 -07001725as the same card module.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726
1727An example configuration for a single emu10k1 card is like below:
1728----- /etc/modprobe.conf
1729alias snd-card-0 snd-emu10k1
1730alias sound-slot-0 snd-emu10k1
1731----- /etc/modprobe.conf
1732
1733The available number of auto-loaded sound cards depends on the module
1734option "cards_limit" of snd module. As default it's set to 1.
1735To enable the auto-loading of multiple cards, specify the number of
1736sound cards in that option.
1737
1738When multiple cards are available, it'd better to specify the index
1739number for each card via module option, too, so that the order of
1740cards is kept consistent.
1741
1742An example configuration for two sound cards is like below:
1743
1744----- /etc/modprobe.conf
1745# ALSA portion
1746options snd cards_limit=2
1747alias snd-card-0 snd-interwave
1748alias snd-card-1 snd-ens1371
1749options snd-interwave index=0
1750options snd-ens1371 index=1
1751# OSS/Free portion
1752alias sound-slot-0 snd-interwave
1753alias sound-slot-1 snd-ens1371
1754----- /etc/moprobe.conf
1755
1756In this example, the interwave card is always loaded as the first card
1757(index 0) and ens1371 as the second (index 1).
1758
1759
1760ALSA PCM devices to OSS devices mapping
1761=======================================
1762
1763/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
1764/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
1765/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
1766/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
1767/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
1768/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
1769/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
1770/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
1771/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
1772
1773The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
1774sound card number and second means device number. The ALSA devices
1775have either 'c' or 'p' suffix indicating the direction, capture and
1776playback, respectively.
1777
1778Please note that the device mapping above may be varied via the module
1779options of snd-pcm-oss module.
1780
1781
1782DEVFS support
1783=============
1784
1785The ALSA driver fully supports the devfs extension.
1786You should add lines below to your devfsd.conf file:
1787
1788LOOKUP snd MODLOAD ACTION snd
1789REGISTER ^sound/.* PERMISSIONS root.audio 660
1790REGISTER ^snd/.* PERMISSIONS root.audio 660
1791
1792Warning: These lines assume that you have the audio group in your system.
1793 Otherwise replace audio word with another group name (root for
1794 example).
1795
1796
1797Proc interfaces (/proc/asound)
1798==============================
1799
1800/proc/asound/card#/pcm#[cp]/oss
1801-------------------------------
1802 String "erase" - erase all additional informations about OSS applications
1803 String "<app_name> <fragments> <fragment_size> [<options>]"
1804
1805 <app_name> - name of application with (higher priority) or without path
1806 <fragments> - number of fragments or zero if auto
1807 <fragment_size> - size of fragment in bytes or zero if auto
1808 <options> - optional parameters
1809 - disable the application tries to open a pcm device for
1810 this channel but does not want to use it.
1811 (Cause a bug or mmap needs)
1812 It's good for Quake etc...
1813 - direct don't use plugins
1814 - block force block mode (rvplayer)
1815 - non-block force non-block mode
1816 - whole-frag write only whole fragments (optimization affecting
1817 playback only)
1818 - no-silence do not fill silence ahead to avoid clicks
Takashi Iwai10f69f92005-09-08 13:48:34 +02001819 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
1820 instead of filled blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821
1822 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
1823 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
1824 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
1825
1826
Takashi Iwaib6a96912005-05-30 18:27:03 +02001827Early Buffer Allocation
1828=======================
1829
1830Some drivers (e.g. hdsp) require the large contiguous buffers, and
1831sometimes it's too late to find such spaces when the driver module is
1832actually loaded due to memory fragmentation. You can pre-allocate the
1833PCM buffers by loading snd-page-alloc module and write commands to its
1834proc file in prior, for example, in the early boot stage like
1835/etc/init.d/*.local scripts.
1836
1837Reading the proc file /proc/drivers/snd-page-alloc shows the current
1838usage of page allocation. In writing, you can send the following
1839commands to the snd-page-alloc driver:
1840
1841 - add VENDOR DEVICE MASK SIZE BUFFERS
1842
1843 VENDOR and DEVICE are PCI vendor and device IDs. They take
1844 integer numbers (0x prefix is needed for the hex).
1845 MASK is the PCI DMA mask. Pass 0 if not restricted.
1846 SIZE is the size of each buffer to allocate. You can pass
1847 k and m suffix for KB and MB. The max number is 16MB.
1848 BUFFERS is the number of buffers to allocate. It must be greater
1849 than 0. The max number is 4.
1850
1851 - erase
1852
1853 This will erase the all pre-allocated buffers which are not in
1854 use.
1855
1856
Takashi Iwai62430082005-09-05 17:12:29 +02001857Links and Addresses
1858===================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859
1860 ALSA project homepage
1861 http://www.alsa-project.org
1862
Takashi Iwai62430082005-09-05 17:12:29 +02001863 ALSA Bug Tracking System
1864 https://bugtrack.alsa-project.org/bugs/
1865
1866 ALSA Developers ML
1867 mailto:alsa-devel@lists.sourceforge.net