blob: dcc9cd9633ddd8dbed7670afbcd6fa7d2aa30aa4 [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
123 Module snd-ad1816a
124 ------------------
125
126 Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips.
127
128 port - port # for AD1816A chip (PnP setup)
129 mpu_port - port # for MPU-401 UART (PnP setup)
130 fm_port - port # for OPL3 (PnP setup)
131 irq - IRQ # for AD1816A chip (PnP setup)
132 mpu_irq - IRQ # for MPU-401 UART (PnP setup)
133 dma1 - first DMA # for AD1816A chip (PnP setup)
134 dma2 - second DMA # for AD1816A chip (PnP setup)
Takashi Iwai506d4c62005-08-03 14:02:47 +0200135 clockfreq - Clock frequency for AD1816A chip (default = 0, 33000Hz)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100137 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
139 Module snd-ad1848
140 -----------------
141
142 Module for sound cards based on AD1848/AD1847/CS4248 ISA chips.
143
144 port - port # for AD1848 chip
145 irq - IRQ # for AD1848 chip
146 dma1 - DMA # for AD1848 chip (0,1,3)
147
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100148 This module supports multiple cards. It does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 thus main port must be specified!!! Other ports are optional.
150
Takashi Iwaia4efc232005-11-17 17:24:26 +0100151 The power-management is supported.
152
Clemens Ladisch84010e62005-09-02 07:57:59 +0200153 Module snd-ad1889
154 -----------------
155
156 Module for Analog Devices AD1889 chips.
157
158 ac97_quirk - AC'97 workaround for strange hardware
159 See the description of intel8x0 module for details.
160
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100161 This module supports multiple cards.
Clemens Ladisch84010e62005-09-02 07:57:59 +0200162
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 Module snd-ali5451
164 ------------------
165
166 Module for ALi M5451 PCI chip.
167
168 pcm_channels - Number of hardware channels assigned for PCM
169 spdif - Support SPDIF I/O
170 - Default: disabled
171
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +0200172 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
174 The power-management is supported.
175
176 Module snd-als100
177 -----------------
178
179 Module for sound cards based on Avance Logic ALS100/ALS120 ISA chips.
180
181 port - port # for ALS100 (SB16) chip (PnP setup)
182 irq - IRQ # for ALS100 (SB16) chip (PnP setup)
183 dma8 - 8-bit DMA # for ALS100 (SB16) chip (PnP setup)
184 dma16 - 16-bit DMA # for ALS100 (SB16) chip (PnP setup)
185 mpu_port - port # for MPU-401 UART (PnP setup)
186 mpu_irq - IRQ # for MPU-401 (PnP setup)
187 fm_port - port # for OPL3 FM (PnP setup)
188
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100189 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
Takashi Iwaia4efc232005-11-17 17:24:26 +0100191 The power-management is supported.
192
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 Module snd-als4000
194 ------------------
195
196 Module for sound cards based on Avance Logic ALS4000 PCI chip.
197
198 joystick_port - port # for legacy joystick support.
199 0 = disabled (default), 1 = auto-detect
200
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100201 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
Takashi Iwaia4efc232005-11-17 17:24:26 +0100203 The power-management is supported.
204
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 Module snd-atiixp
206 -----------------
207
Takashi Iwai62430082005-09-05 17:12:29 +0200208 Module for ATI IXP 150/200/250/400 AC97 controllers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
Takashi Iwai62430082005-09-05 17:12:29 +0200210 ac97_clock - AC'97 clock (default = 48000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200212 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 spdif_aclink - S/PDIF transfer over AC-link (default = 1)
214
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200215 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Takashi Iwai62430082005-09-05 17:12:29 +0200217 ATI IXP has two different methods to control SPDIF output. One is
218 over AC-link and another is over the "direct" SPDIF output. The
219 implementation depends on the motherboard, and you'll need to
220 choose the correct one via spdif_aclink module option.
221
Takashi Iwaia4efc232005-11-17 17:24:26 +0100222 The power-management is supported.
223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 Module snd-atiixp-modem
225 -----------------------
226
227 Module for ATI IXP 150/200/250 AC97 modem controllers.
228
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200229 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
231 Note: The default index value of this module is -2, i.e. the first
232 slot is excluded.
233
Takashi Iwaia4efc232005-11-17 17:24:26 +0100234 The power-management is supported.
235
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 Module snd-au8810, snd-au8820, snd-au8830
237 -----------------------------------------
238
239 Module for Aureal Vortex, Vortex2 and Advantage device.
240
241 pcifix - Control PCI workarounds
242 0 = Disable all workarounds
243 1 = Force the PCI latency of the Aureal card to 0xff
244 2 = Force the Extend PCI#2 Internal Master for Efficient
245 Handling of Dummy Requests on the VIA KT133 AGP Bridge
246 3 = Force both settings
247 255 = Autodetect what is required (default)
248
249 This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
250 EQ, mpu401, gameport. A3D and wavetable support are still in development.
251 Development and reverse engineering work is being coordinated at
252 http://savannah.nongnu.org/projects/openvortex/
253 SPDIF output has a copy of the AC97 codec output, unless you use the
254 "spdif" pcm device, which allows raw data passthru.
255 The hardware EQ hardware and SPDIF is only present in the Vortex2 and
256 Advantage.
257
Takashi Iwai62430082005-09-05 17:12:29 +0200258 Note: Some ALSA mixer applications don't handle the SPDIF sample rate
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 control correctly. If you have problems regarding this, try
260 another ALSA compliant mixer (alsamixer works).
261
262 Module snd-azt2320
263 ------------------
264
265 Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
266
267 port - port # for AZT2320 chip (PnP setup)
268 wss_port - port # for WSS (PnP setup)
269 mpu_port - port # for MPU-401 UART (PnP setup)
270 fm_port - FM port # for AZT2320 chip (PnP setup)
271 irq - IRQ # for AZT2320 (WSS) chip (PnP setup)
272 mpu_irq - IRQ # for MPU-401 UART (PnP setup)
273 dma1 - 1st DMA # for AZT2320 (WSS) chip (PnP setup)
274 dma2 - 2nd DMA # for AZT2320 (WSS) chip (PnP setup)
275
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100276 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
Takashi Iwaia4efc232005-11-17 17:24:26 +0100278 The power-management is supported.
279
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 Module snd-azt3328
281 ------------------
282
283 Module for sound cards based on Aztech AZF3328 PCI chip.
284
285 joystick - Enable joystick (default off)
286
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100287 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
289 Module snd-bt87x
290 ----------------
291
292 Module for video cards based on Bt87x chips.
293
294 digital_rate - Override the default digital rate (Hz)
295 load_all - Load the driver even if the card model isn't known
296
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100297 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298
299 Note: The default index value of this module is -2, i.e. the first
300 slot is excluded.
301
302 Module snd-ca0106
303 -----------------
304
305 Module for Creative Audigy LS and SB Live 24bit
306
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100307 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
309
310 Module snd-cmi8330
311 ------------------
312
313 Module for sound cards based on C-Media CMI8330 ISA chips.
314
315 wssport - port # for CMI8330 chip (WSS)
316 wssirq - IRQ # for CMI8330 chip (WSS)
317 wssdma - first DMA # for CMI8330 chip (WSS)
318 sbport - port # for CMI8330 chip (SB16)
319 sbirq - IRQ # for CMI8330 chip (SB16)
320 sbdma8 - 8bit DMA # for CMI8330 chip (SB16)
321 sbdma16 - 16bit DMA # for CMI8330 chip (SB16)
322
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100323 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
Takashi Iwaia4efc232005-11-17 17:24:26 +0100325 The power-management is supported.
326
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 Module snd-cmipci
328 -----------------
329
330 Module for C-Media CMI8338 and 8738 PCI sound cards.
331
332 mpu_port - 0x300,0x310,0x320,0x330, 0 = disable (default)
333 fm_port - 0x388 (default), 0 = disable (default)
Takashi Iwai62430082005-09-05 17:12:29 +0200334 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 (default = 1)
336 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
337
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100338 This module supports autoprobe and multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339
Takashi Iwaia4efc232005-11-17 17:24:26 +0100340 The power-management is supported.
341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 Module snd-cs4231
343 -----------------
344
345 Module for sound cards based on CS4231 ISA chips.
346
347 port - port # for CS4231 chip
348 mpu_port - port # for MPU-401 UART (optional), -1 = disable
349 irq - IRQ # for CS4231 chip
350 mpu_irq - IRQ # for MPU-401 UART
351 dma1 - first DMA # for CS4231 chip
352 dma2 - second DMA # for CS4231 chip
353
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100354 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 thus main port must be specified!!! Other ports are optional.
356
357 The power-management is supported.
358
359 Module snd-cs4232
360 -----------------
361
362 Module for sound cards based on CS4232/CS4232A ISA chips.
363
364 port - port # for CS4232 chip (PnP setup - 0x534)
365 cport - control port # for CS4232 chip (PnP setup - 0x120,0x210,0xf00)
366 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
367 fm_port - FM port # for CS4232 chip (PnP setup - 0x388), -1 = disable
368 irq - IRQ # for CS4232 chip (5,7,9,11,12,15)
369 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
370 dma1 - first DMA # for CS4232 chip (0,1,3)
371 dma2 - second DMA # for Yamaha CS4232 chip (0,1,3), -1 = disable
372 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
373
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100374 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 thus main port must be specified!!! Other ports are optional.
376
377 The power-management is supported.
378
379 Module snd-cs4236
380 -----------------
381
382 Module for sound cards based on CS4235/CS4236/CS4236B/CS4237B/
383 CS4238B/CS4239 ISA chips.
384
385 port - port # for CS4236 chip (PnP setup - 0x534)
386 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
387 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
388 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
389 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
390 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
391 dma1 - first DMA # for CS4236 chip (0,1,3)
392 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
393 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
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 (if ISA PnP is not used) thus main port and control port must be
397 specified!!! Other ports are optional.
398
399 The power-management is supported.
400
401 Module snd-cs4281
402 -----------------
403
404 Module for Cirrus Logic CS4281 soundchip.
405
406 dual_codec - Secondary codec ID (0 = disable, default)
407
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100408 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
410 The power-management is supported.
411
412 Module snd-cs46xx
413 -----------------
414
415 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
416 CS4624/CS4630/CS4280 PCI chips.
417
Takashi Iwai62430082005-09-05 17:12:29 +0200418 external_amp - Force to enable external amplifier.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 thinkpad - Force to enable Thinkpad's CLKRUN control.
420 mmap_valid - Support OSS mmap mode (default = 0).
421
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100422 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 Usually external amp and CLKRUN controls are detected automatically
424 from PCI sub vendor/device ids. If they don't work, give the options
425 above explicitly.
426
427 The power-management is supported.
428
Takashi Iwai3e873172005-11-17 10:15:37 +0100429 Module snd-cs5535audio
430 ----------------------
431
432 Module for multifunction CS5535 companion PCI device
433
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100434 This module supports multiple cards.
Takashi Iwai3e873172005-11-17 10:15:37 +0100435
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 Module snd-dt019x
437 -----------------
438
439 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
440 only)
441
442 port - Port # (PnP setup)
443 mpu_port - Port # for MPU-401 (PnP setup)
444 fm_port - Port # for FM OPL-3 (PnP setup)
445 irq - IRQ # (PnP setup)
446 mpu_irq - IRQ # for MPU-401 (PnP setup)
447 dma8 - DMA # (PnP setup)
448
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100449 This module supports multiple cards. This module is enabled only with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 ISA PnP support.
451
Takashi Iwaia4efc232005-11-17 17:24:26 +0100452 The power-management is supported.
453
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 Module snd-dummy
455 ----------------
456
457 Module for the dummy sound card. This "card" doesn't do any output
458 or input, but you may use this module for any application which
459 requires a sound card (like RealPlayer).
460
Takashi Iwaia4efc232005-11-17 17:24:26 +0100461 The power-management is supported.
462
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 Module snd-emu10k1
464 ------------------
465
466 Module for EMU10K1/EMU10k2 based PCI sound cards.
467 * Sound Blaster Live!
468 * Sound Blaster PCI 512
469 * Emu APS (partially supported)
470 * Sound Blaster Audigy
471
472 extin - bitmap of available external inputs for FX8010 (see bellow)
473 extout - bitmap of available external outputs for FX8010 (see bellow)
474 seq_ports - allocated sequencer ports (4 by default)
475 max_synth_voices - limit of voices used for wavetable (64 by default)
476 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
477 given in MB unit. Default value is 128.
478 enable_ir - enable IR
479
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100480 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
482 Input & Output configurations [extin/extout]
483 * Creative Card wo/Digital out [0x0003/0x1f03]
484 * Creative Card w/Digital out [0x0003/0x1f0f]
485 * Creative Card w/Digital CD in [0x000f/0x1f0f]
486 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
487 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
488 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
489 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
490 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
491 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
492 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
493 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
494 * Creative Card all ins and outs [0x3fff/0x7fff]
495
Takashi Iwaia4efc232005-11-17 17:24:26 +0100496 The power-management is supported.
497
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 Module snd-emu10k1x
499 -------------------
500
501 Module for Creative Emu10k1X (SB Live Dell OEM version)
502
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100503 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504
505 Module snd-ens1370
506 ------------------
507
508 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
509 * SoundBlaster PCI 64
510 * SoundBlaster PCI 128
511
512 joystick - Enable joystick (default off)
513
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100514 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100516 The power-management is supported.
517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 Module snd-ens1371
519 ------------------
520
521 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
522 * SoundBlaster PCI 64
523 * SoundBlaster PCI 128
524 * SoundBlaster Vibra PCI
525
526 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
527 0 = disable (default), 1 = auto-detect
528
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100529 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100531 The power-management is supported.
532
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 Module snd-es968
534 ----------------
535
536 Module for sound cards based on ESS ES968 chip (PnP only).
537
538 port - port # for ES968 (SB8) chip (PnP setup)
539 irq - IRQ # for ES968 (SB8) chip (PnP setup)
540 dma1 - DMA # for ES968 (SB8) chip (PnP setup)
541
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100542 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
Takashi Iwaia4efc232005-11-17 17:24:26 +0100544 The power-management is supported.
545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 Module snd-es1688
547 -----------------
548
549 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
550
551 port - port # for ES-1688 chip (0x220,0x240,0x260)
552 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
553 irq - IRQ # for ES-1688 chip (5,7,9,10)
554 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
555 dma8 - DMA # for ES-1688 chip (0,1,3)
556
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100557 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
559 Module snd-es18xx
560 -----------------
561
562 Module for ESS AudioDrive ES-18xx sound cards.
563
564 port - port # for ES-18xx chip (0x220,0x240,0x260)
565 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
566 fm_port - port # for FM (optional, not used)
567 irq - IRQ # for ES-18xx chip (5,7,9,10)
568 dma1 - first DMA # for ES-18xx chip (0,1,3)
569 dma2 - first DMA # for ES-18xx chip (0,1,3)
570 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
571
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100572 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
573 port if native ISA PnP routines are not used).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 When dma2 is equal with dma1, the driver works as half-duplex.
575
576 The power-management is supported.
577
578 Module snd-es1938
579 -----------------
580
581 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
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 Iwaia4efc232005-11-17 17:24:26 +0100585 The power-management is supported.
586
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 Module snd-es1968
588 -----------------
589
590 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
591
592 total_bufsize - total buffer size in kB (1-4096kB)
593 pcm_substreams_p - playback channels (1-8, default=2)
594 pcm_substreams_c - capture channels (1-8, default=0)
595 clock - clock (0 = auto-detection)
596 use_pm - support the power-management (0 = off, 1 = on,
597 2 = auto (default))
598 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
599 joystick - enable joystick (default off)
600
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100601 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
603 The power-management is supported.
604
605 Module snd-fm801
606 ----------------
607
608 Module for ForteMedia FM801 based PCI sound cards.
609
610 tea575x_tuner - Enable TEA575x tuner
611 - 1 = MediaForte 256-PCS
612 - 2 = MediaForte 256-PCPR
613 - 3 = MediaForte 64-PCR
614 - High 16-bits are video (radio) device number + 1
615 - example: 0x10002 (MediaForte 256-PCPR, device 1)
616
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100617 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618
Takashi Iwaia4efc232005-11-17 17:24:26 +0100619 The power-management is supported.
620
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 Module snd-gusclassic
622 ---------------------
623
624 Module for Gravis UltraSound Classic sound card.
625
626 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
627 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
628 dma1 - DMA # for GF1 chip (1,3,5,6,7)
629 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
630 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
631 voices - GF1 voices limit (14-32)
632 pcm_voices - reserved PCM voices
633
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100634 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635
636 Module snd-gusextreme
637 ---------------------
638
639 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
640
641 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
642 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
643 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
644 irq - IRQ # for ES-1688 chip (5,7,9,10)
645 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
646 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
647 dma8 - DMA # for ES-1688 chip (0,1,3)
648 dma1 - DMA # for GF1 chip (1,3,5,6,7)
649 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
650 voices - GF1 voices limit (14-32)
651 pcm_voices - reserved PCM voices
652
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100653 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
655 Module snd-gusmax
656 -----------------
657
658 Module for Gravis UltraSound MAX sound card.
659
660 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
661 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
662 dma1 - DMA # for GF1 chip (1,3,5,6,7)
663 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
664 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
665 voices - GF1 voices limit (14-32)
666 pcm_voices - reserved PCM voices
667
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100668 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
670 Module snd-hda-intel
671 --------------------
672
Takashi Iwaifc20a562005-05-12 15:00:41 +0200673 Module for Intel HD Audio (ICH6, ICH6M, ICH7), ATI SB450,
674 VIA VT8251/VT8237A
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675
676 model - force the model name
Takashi Iwai62430082005-09-05 17:12:29 +0200677 position_fix - Fix DMA pointer (0 = auto, 1 = none, 2 = POSBUF, 3 = FIFO size)
Takashi Iwai27346162006-01-12 18:28:44 +0100678 single_cmd - Use single immediate commands to communicate with
679 codecs (for debugging only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200681 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
683 Each codec may have a model table for different configurations.
684 If your machine isn't listed there, the default (usually minimal)
685 configuration is set up. You can pass "model=<name>" option to
686 specify a certain model in such a case. There are different
687 models depending on the codec chip.
688
689 Model name Description
690 ---------- -----------
691 ALC880
692 3stack 3-jack in back and a headphone out
693 3stack-digout 3-jack in back, a HP out and a SPDIF out
694 5stack 5-jack in back, 2-jack in front
695 5stack-digout 5-jack in back, 2-jack in front, a SPDIF out
Takashi Iwaib6482d42005-06-27 15:32:43 +0200696 6stack 6-jack in back, 2-jack in front
697 6stack-digout 6-jack with a SPDIF out
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698 w810 3-jack
Takashi Iwaidfc0ff62005-05-12 14:31:49 +0200699 z71v 3-jack (HP shared SPDIF)
Takashi Iwaie9edcee2005-06-13 14:16:38 +0200700 asus 3-jack
701 uniwill 3-jack
702 F1734 2-jack
Takashi Iwaiae6b8132006-03-03 16:47:17 +0100703 lg LG laptop (m1 express dual)
Takashi Iwaib6482d42005-06-27 15:32:43 +0200704 test for testing/debugging purpose, almost all controls can be
705 adjusted. Appearing only when compiled with
706 $CONFIG_SND_DEBUG=y
Takashi Iwaied345f82006-03-01 14:16:53 +0100707 auto auto-config reading BIOS (default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
Takashi Iwai21be3d12005-09-16 19:18:56 +0200709 ALC260
710 hp HP machines
711 fujitsu Fujitsu S7020
Takashi Iwaied345f82006-03-01 14:16:53 +0100712 acer Acer TravelMate
713 basic fixed pin assignment (old default model)
714 auto auto-config reading BIOS (default)
715
716 ALC262
717 fujitsu Fujitsu Laptop
718 basic fixed pin assignment w/o SPDIF
719 auto auto-config reading BIOS (default)
720
721 ALC882/883/885
722 3stack-dig 3-jack with SPDIF I/O
723 6stck-dig 6-jack digital with SPDIF I/O
724 auto auto-config reading BIOS (default)
725
726 ALC861
727 3stack 3-jack
728 3stack-dig 3-jack with SPDIF I/O
729 6stack-dig 6-jack with SPDIF I/O
730 auto auto-config reading BIOS (default)
Takashi Iwai21be3d12005-09-16 19:18:56 +0200731
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 CMI9880
733 minimal 3-jack in back
734 min_fp 3-jack in back, 2-jack in front
735 full 6-jack in back, 2-jack in front
736 full_dig 6-jack in back, 2-jack in front, SPDIF I/O
737 allout 5-jack in back, 2-jack in front, SPDIF out
Takashi Iwaie9edcee2005-06-13 14:16:38 +0200738 auto auto-config reading BIOS (default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739
Takashi Iwai9230d212006-03-13 13:49:49 +0100740 AD1981
741 basic 3-jack (default)
742 hp HP nx6320
743
744 AD1986A
745 6stack 6-jack, separate surrounds (default)
746 3stack 3-stack, shared surrounds
747 laptop 2-channel only (FSC V2060, Samsung M50)
748
749 AD1988
750 6stack 6-jack
751 6stack-dig ditto with SPDIF
752 3stack 3-jack
753 3stack-dig ditto with SPDIF
754 laptop 3-jack with hp-jack automute
755 laptop-dig ditto with SPDIF
756 auto auto-confgi reading BIOS (default)
757
Takashi Iwaidb064e52006-03-16 16:04:58 +0100758 STAC7661(?)
759 vaio Setup for VAIO FE550G/SZ110
760
Takashi Iwai62430082005-09-05 17:12:29 +0200761 If the default configuration doesn't work and one of the above
762 matches with your device, report it together with the PCI
763 subsystem ID (output of "lspci -nv") to ALSA BTS or alsa-devel
764 ML (see the section "Links and Addresses").
765
Takashi Iwaic74db862005-05-12 14:26:27 +0200766 Note 2: If you get click noises on output, try the module option
767 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
768 register value without FIFO size correction as the current
769 DMA pointer. position_fix=2 will make the driver to use
770 the position buffer instead of reading SD_LPIB register.
771 (Usually SD_LPLIB register is more accurate than the
772 position buffer.)
773
Takashi Iwai27346162006-01-12 18:28:44 +0100774 NB: If you get many "azx_get_response timeout" messages at
775 loading, it's likely a problem of interrupts (e.g. ACPI irq
776 routing). Try to boot with options like "pci=noacpi". Also, you
777 can try "single_cmd=1" module option. This will switch the
778 communication method between HDA controller and codecs to the
779 single immediate commands instead of CORB/RIRB. Basically, the
780 single command mode is provided only for BIOS, and you won't get
781 unsolicited events, too. But, at least, this works independently
782 from the irq. Remember this is a last resort, and should be
783 avoided as much as possible...
784
Takashi Iwaia4efc232005-11-17 17:24:26 +0100785 The power-management is supported.
786
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 Module snd-hdsp
788 ---------------
789
790 Module for RME Hammerfall DSP audio interface(s)
791
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100792 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793
794 Note: The firmware data can be automatically loaded via hotplug
795 when CONFIG_FW_LOADER is set. Otherwise, you need to load
796 the firmware via hdsploader utility included in alsa-tools
797 package.
798 The firmware data is found in alsa-firmware package.
799
800 Note: snd-page-alloc module does the job which snd-hammerfall-mem
801 module did formerly. It will allocate the buffers in advance
802 when any HDSP cards are found. To make the buffer
803 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +0200804 stage of boot sequence. See "Early Buffer Allocation"
805 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806
Takashi Iwai54704402005-06-03 11:27:00 +0200807 Module snd-hdspm
808 ----------------
809
810 Module for RME HDSP MADI board.
811
812 precise_ptr - Enable precise pointer, or disable.
813 line_outs_monitor - Send playback streams to analog outs by default.
814 enable_monitor - Enable Analog Out on Channel 63/64 by default.
815
816 See hdspm.txt for details.
817
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 Module snd-ice1712
819 ------------------
820
821 Module for Envy24 (ICE1712) based PCI sound cards.
822 * MidiMan M Audio Delta 1010
823 * MidiMan M Audio Delta 1010LT
824 * MidiMan M Audio Delta DiO 2496
825 * MidiMan M Audio Delta 66
826 * MidiMan M Audio Delta 44
827 * MidiMan M Audio Delta 410
828 * MidiMan M Audio Audiophile 2496
829 * TerraTec EWS 88MT
830 * TerraTec EWS 88D
831 * TerraTec EWX 24/96
832 * TerraTec DMX 6Fire
Takashi Iwaic9bce912005-05-24 13:41:03 +0200833 * TerraTec Phase 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 * Hoontech SoundTrack DSP 24
835 * Hoontech SoundTrack DSP 24 Value
836 * Hoontech SoundTrack DSP 24 Media 7.1
Takashi Iwaic9bce912005-05-24 13:41:03 +0200837 * Event Electronics, EZ8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 * Digigram VX442
Takashi Iwaic9bce912005-05-24 13:41:03 +0200839 * Lionstracs, Mediastaton
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840
841 model - Use the given board model, one of the following:
842 delta1010, dio2496, delta66, delta44, audiophile, delta410,
843 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
Takashi Iwaic9bce912005-05-24 13:41:03 +0200844 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
845 phase88, mediastation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 omni - Omni I/O support for MidiMan M-Audio Delta44/66
847 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transciever)
848 in msec resolution, default value is 500 (0.5 sec)
849
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100850 This module supports multiple cards and autoprobe. Note: The consumer part
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 is not used with all Envy24 based cards (for example in the MidiMan Delta
852 serie).
853
Takashi Iwaic9bce912005-05-24 13:41:03 +0200854 Note: The supported board is detected by reading EEPROM or PCI
855 SSID (if EEPROM isn't available). You can override the
856 model by passing "model" module option in case that the
857 driver isn't configured properly or you want to try another
858 type for testing.
859
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 Module snd-ice1724
861 ------------------
862
Takashi Iwaic9bce912005-05-24 13:41:03 +0200863 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100864 * MidiMan M Audio Revolution 5.1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 * MidiMan M Audio Revolution 7.1
866 * AMP Ltd AUDIO2000
Takashi Iwaic9bce912005-05-24 13:41:03 +0200867 * TerraTec Aureon 5.1 Sky
868 * TerraTec Aureon 7.1 Space
869 * TerraTec Aureon 7.1 Universe
870 * TerraTec Phase 22
871 * TerraTec Phase 28
872 * AudioTrak Prodigy 7.1
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100873 * AudioTrak Prodigy 7.1LT
Takashi Iwaic9bce912005-05-24 13:41:03 +0200874 * AudioTrak Prodigy 192
875 * Pontis MS300
876 * Albatron K8X800 Pro II
877 * Chaintech ZNF3-150
878 * Chaintech ZNF3-250
879 * Chaintech 9CJS
Takashi Iwai8cfbbac2005-05-27 12:10:40 +0200880 * Chaintech AV-710
Takashi Iwaic9bce912005-05-24 13:41:03 +0200881 * Shuttle SN25P
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882
883 model - Use the given board model, one of the following:
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100884 revo51, revo71, amp2000, prodigy71, prodigy71lt,
885 prodigy192, aureon51, aureon71, universe,
886 k8x800, phase22, phase28, ms300, av710
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100888 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889
Takashi Iwaic9bce912005-05-24 13:41:03 +0200890 Note: The supported board is detected by reading EEPROM or PCI
891 SSID (if EEPROM isn't available). You can override the
892 model by passing "model" module option in case that the
893 driver isn't configured properly or you want to try another
894 type for testing.
895
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896 Module snd-intel8x0
897 -------------------
898
899 Module for AC'97 motherboards from Intel and compatibles.
900 * Intel i810/810E, i815, i820, i830, i84x, MX440
Takashi Iwai89ac9c22006-01-24 10:36:57 +0100901 ICH5, ICH6, ICH7, ESB2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 * SiS 7012 (SiS 735)
Takashi Iwai89ac9c22006-01-24 10:36:57 +0100903 * NVidia NForce, NForce2, NForce3, MCP04, CK804
904 CK8, CK8S, MCP501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 * AMD AMD768, AMD8111
906 * ALi m5455
907
908 ac97_clock - AC'97 codec clock base (0 = auto-detect)
909 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200910 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911 buggy_irq - Enable workaround for buggy interrupts on some
Takashi Iwaia06147d2005-09-08 19:54:17 +0200912 motherboards (default yes on nForce chips,
913 otherwise off)
914 buggy_semaphore - Enable workaround for hardwares with buggy
915 semaphores (e.g. on some ASUS laptops)
916 (default off)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200918 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919
920 Note: the latest driver supports auto-detection of chip clock.
921 if you still encounter too fast playback, specify the clock
922 explicitly via the module option "ac97_clock=41194".
923
924 Joystick/MIDI ports are not supported by this driver. If your
925 motherboard has these devices, use the ns558 or snd-mpu401
926 modules, respectively.
927
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928 The power-management is supported.
929
930 Module snd-intel8x0m
931 --------------------
932
933 Module for Intel ICH (i8x0) chipset MC97 modems.
Takashi Iwai89ac9c22006-01-24 10:36:57 +0100934 * Intel i810/810E, i815, i820, i830, i84x, MX440
935 ICH5, ICH6, ICH7
936 * SiS 7013 (SiS 735)
937 * NVidia NForce, NForce2, NForce2s, NForce3
938 * AMD AMD8111
939 * ALi m5455
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940
941 ac97_clock - AC'97 codec clock base (0 = auto-detect)
942
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200943 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944
945 Note: The default index value of this module is -2, i.e. the first
946 slot is excluded.
947
Takashi Iwaia4efc232005-11-17 17:24:26 +0100948 The power-management is supported.
949
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 Module snd-interwave
951 --------------------
952
953 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
954 and other sound cards based on AMD InterWave (tm) chip.
955
956 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
957 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
958 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
959 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
960 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
961 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
962 pcm_voices - reserved PCM voices for the synthesizer (default 2)
963 effect - 1 = InterWave effects enable (default 0);
964 requires 8 voices
965
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100966 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967
968 Module snd-interwave-stb
969 ------------------------
970
971 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
972 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
973 circuit for extended control of bass, treble and master volume.
974
975 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
976 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
977 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
978 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
979 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
980 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
981 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
982 pcm_voices - reserved PCM voices for the synthesizer (default 2)
983 effect - 1 = InterWave effects enable (default 0);
984 requires 8 voices
985
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100986 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987
988 Module snd-korg1212
989 -------------------
990
991 Module for Korg 1212 IO PCI card
992
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100993 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994
995 Module snd-maestro3
996 -------------------
997
998 Module for Allegro/Maestro3 chips
999
1000 external_amp - enable external amp (enabled by default)
1001 amp_gpio - GPIO pin number for external amp (0-15) or
1002 -1 for default pin (8 for allegro, 1 for
1003 others)
1004
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001005 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006
1007 Note: the binding of amplifier is dependent on hardware.
1008 If there is no sound even though all channels are unmuted, try to
1009 specify other gpio connection via amp_gpio option.
1010 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1011 option.
1012
1013 The power-management is supported.
1014
1015 Module snd-mixart
1016 -----------------
1017
1018 Module for Digigram miXart8 sound cards.
1019
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001020 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 Note: One miXart8 board will be represented as 4 alsa cards.
1022 See MIXART.txt for details.
1023
1024 When the driver is compiled as a module and the hotplug firmware
1025 is supported, the firmware data is loaded via hotplug automatically.
1026 Install the necessary firmware files in alsa-firmware package.
1027 When no hotplug fw loader is available, you need to load the
1028 firmware via mixartloader utility in alsa-tools package.
1029
1030 Module snd-mpu401
1031 -----------------
1032
1033 Module for MPU-401 UART devices.
1034
1035 port - port number or -1 (disable)
1036 irq - IRQ number or -1 (disable)
1037 pnp - PnP detection - 0 = disable, 1 = enable (default)
1038
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001039 This module supports multiple devices and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040
1041 Module snd-mtpav
1042 ----------------
1043
1044 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1045 port).
1046
1047 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1048 irq - IRQ # for MTPAV (7,5, default=7)
1049 hwports - number of supported hardware ports, default=8.
1050
1051 Module supports only 1 card. This module has no enable option.
1052
1053 Module snd-nm256
1054 ----------------
1055
1056 Module for NeoMagic NM256AV/ZX chips
1057
1058 playback_bufsize - max playback frame size in kB (4-128kB)
1059 capture_bufsize - max capture frame size in kB (4-128kB)
1060 force_ac97 - 0 or 1 (disabled by default)
1061 buffer_top - specify buffer top address
1062 use_cache - 0 or 1 (disabled by default)
1063 vaio_hack - alias buffer_top=0x25a800
1064 reset_workaround - enable AC97 RESET workaround for some laptops
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001065 reset_workaround2 - enable extended AC97 RESET workaround for some
1066 other laptops
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +02001068 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069
1070 The power-management is supported.
1071
1072 Note: on some notebooks the buffer address cannot be detected
1073 automatically, or causes hang-up during initialization.
1074 In such a case, specify the buffer top address explicity via
1075 buffer_top option.
1076 For example,
1077 Sony F250: buffer_top=0x25a800
1078 Sony F270: buffer_top=0x272800
1079 The driver supports only ac97 codec. It's possible to force
1080 to initialize/use ac97 although it's not detected. In such a
1081 case, use force_ac97=1 option - but *NO* guarantee whether it
1082 works!
1083
1084 Note: The NM256 chip can be linked internally with non-AC97
1085 codecs. This driver supports only the AC97 codec, and won't work
1086 with machines with other (most likely CS423x or OPL3SAx) chips,
1087 even though the device is detected in lspci. In such a case, try
1088 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
Takashi Iwai62430082005-09-05 17:12:29 +02001089 but some doesn't have ISA PnP. You'll need to specify isapnp=0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001090 and proper hardware parameters in the case without ISA PnP.
1091
1092 Note: some laptops need a workaround for AC97 RESET. For the
1093 known hardware like Dell Latitude LS and Sony PCG-F305, this
1094 workaround is enabled automatically. For other laptops with a
1095 hard freeze, you can try reset_workaround=1 option.
1096
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001097 Note: Dell Latitude CSx laptops have another problem regarding
1098 AC97 RESET. On these laptops, reset_workaround2 option is
1099 turned on as default. This option is worth to try if the
1100 previous reset_workaround option doesn't help.
1101
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102 Note: This driver is really crappy. It's a porting from the
1103 OSS driver, which is a result of black-magic reverse engineering.
1104 The detection of codec will fail if the driver is loaded *after*
1105 X-server as described above. You might be able to force to load
1106 the module, but it may result in hang-up. Hence, make sure that
1107 you load this module *before* X if you encounter this kind of
1108 problem.
1109
1110 Module snd-opl3sa2
1111 ------------------
1112
1113 Module for Yamaha OPL3-SA2/SA3 sound cards.
1114
1115 port - control port # for OPL3-SA chip (0x370)
1116 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1117 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1118 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1119 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1120 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1121 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1122 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
1123 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1124
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001125 This module supports multiple cards and ISA PnP. It does not support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001126 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1127
1128 The power-management is supported.
1129
1130 Module snd-opti92x-ad1848
1131 -------------------------
1132
1133 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1134 Module works with OAK Mozart cards as well.
1135
1136 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1137 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1138 fm_port - port # for OPL3 device (0x388)
1139 irq - IRQ # for WSS chip (5,7,9,10,11)
1140 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1141 dma1 - first DMA # for WSS chip (0,1,3)
1142
1143 This module supports only one card, autoprobe and PnP.
1144
1145 Module snd-opti92x-cs4231
1146 -------------------------
1147
1148 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1149
1150 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1151 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1152 fm_port - port # for OPL3 device (0x388)
1153 irq - IRQ # for WSS chip (5,7,9,10,11)
1154 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1155 dma1 - first DMA # for WSS chip (0,1,3)
1156 dma2 - second DMA # for WSS chip (0,1,3)
1157
1158 This module supports only one card, autoprobe and PnP.
1159
1160 Module snd-opti93x
1161 ------------------
1162
1163 Module for sound cards based on OPTi 82c93x chips.
1164
1165 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1166 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1167 fm_port - port # for OPL3 device (0x388)
1168 irq - IRQ # for WSS chip (5,7,9,10,11)
1169 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1170 dma1 - first DMA # for WSS chip (0,1,3)
1171 dma2 - second DMA # for WSS chip (0,1,3)
1172
1173 This module supports only one card, autoprobe and PnP.
1174
Markus Bollingere12229b2005-12-06 13:55:26 +01001175 Module snd-pcxhr
1176 ----------------
1177
1178 Module for Digigram PCXHR boards
1179
1180 This module supports multiple cards.
1181
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 Module snd-powermac (on ppc only)
1183 ---------------------------------
1184
1185 Module for PowerMac, iMac and iBook on-board soundchips
1186
1187 enable_beep - enable beep using PCM (enabled as default)
1188
1189 Module supports autoprobe a chip.
1190
1191 Note: the driver may have problems regarding endianess.
1192
1193 The power-management is supported.
1194
Takashi Iwai2c484df2005-06-30 18:54:04 +02001195 Module snd-pxa2xx-ac97 (on arm only)
1196 ------------------------------------
1197
1198 Module for AC97 driver for the Intel PXA2xx chip
1199
1200 For ARM architecture only.
1201
Takashi Iwaia4efc232005-11-17 17:24:26 +01001202 The power-management is supported.
1203
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 Module snd-rme32
1205 ----------------
1206
1207 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1208 Prodif96 and Prodif Gold) sound cards.
1209
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001210 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001211
1212 Module snd-rme96
1213 ----------------
1214
1215 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1216
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001217 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218
1219 Module snd-rme9652
1220 ------------------
1221
1222 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1223
1224 precise_ptr - Enable precise pointer (doesn't work reliably).
1225 (default = 0)
1226
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001227 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228
1229 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1230 module did formerly. It will allocate the buffers in advance
1231 when any RME9652 cards are found. To make the buffer
1232 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +02001233 stage of boot sequence. See "Early Buffer Allocation"
1234 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235
1236 Module snd-sa11xx-uda1341 (on arm only)
1237 ---------------------------------------
1238
1239 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1240
1241 Module supports only one card.
1242 Module has no enable and index options.
1243
Takashi Iwaia4efc232005-11-17 17:24:26 +01001244 The power-management is supported.
1245
Linus Torvalds1da177e2005-04-16 15:20:36 -07001246 Module snd-sb8
1247 --------------
1248
1249 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1250 SoundBlaster 2.0,
1251 SoundBlaster Pro
1252
1253 port - port # for SB DSP chip (0x220,0x240,0x260)
1254 irq - IRQ # for SB DSP chip (5,7,9,10)
1255 dma8 - DMA # for SB DSP chip (1,3)
1256
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001257 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258
Takashi Iwaia4efc232005-11-17 17:24:26 +01001259 The power-management is supported.
1260
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 Module snd-sb16 and snd-sbawe
1262 -----------------------------
1263
1264 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1265 SoundBlaster AWE 32 (PnP),
1266 SoundBlaster AWE 64 PnP
1267
1268 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1269 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1270 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1271 (snd-sbawe module only)
1272 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1273 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1274 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
1275 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1276 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1277 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1278
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001279 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280
1281 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1282 disable 16bit DMA with dma16 = -1 module parameter.
1283 Also, all Sound Blaster 16 type cards can operate in 16-bit
1284 half duplex mode through 8-bit DMA channel by disabling their
1285 16-bit DMA channel.
1286
Takashi Iwaia4efc232005-11-17 17:24:26 +01001287 The power-management is supported.
1288
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 Module snd-sgalaxy
1290 ------------------
1291
1292 Module for Aztech Sound Galaxy sound card.
1293
1294 sbport - Port # for SB16 interface (0x220,0x240)
1295 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1296 irq - IRQ # (7,9,10,11)
1297 dma1 - DMA #
1298
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001299 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001300
Takashi Iwaia4efc232005-11-17 17:24:26 +01001301 The power-management is supported.
1302
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 Module snd-sscape
1304 -----------------
1305
1306 Module for ENSONIQ SoundScape PnP cards.
1307
1308 port - Port # (PnP setup)
1309 irq - IRQ # (PnP setup)
1310 mpu_irq - MPU-401 IRQ # (PnP setup)
1311 dma - DMA # (PnP setup)
1312
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001313 This module supports multiple cards. ISA PnP must be enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314 You need sscape_ctl tool in alsa-tools package for loading
1315 the microcode.
1316
1317 Module snd-sun-amd7930 (on sparc only)
1318 --------------------------------------
1319
1320 Module for AMD7930 sound chips found on Sparcs.
1321
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001322 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323
1324 Module snd-sun-cs4231 (on sparc only)
1325 -------------------------------------
1326
1327 Module for CS4231 sound chips found on Sparcs.
1328
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001329 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001331 Module snd-sun-dbri (on sparc only)
1332 -----------------------------------
1333
1334 Module for DBRI sound chips found on Sparcs.
1335
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001336 This module supports multiple cards.
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001337
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 Module snd-wavefront
1339 --------------------
1340
1341 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1342
1343 cs4232_pcm_port - Port # for CS4232 PCM interface.
1344 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1345 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1346 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
1347 use_cs4232_midi - Use CS4232 MPU-401 interface
1348 (inaccessibly located inside your computer)
1349 ics2115_port - Port # for ICS2115
1350 ics2115_irq - IRQ # for ICS2115
1351 fm_port - FM OPL-3 Port #
1352 dma1 - DMA1 # for CS4232 PCM interface.
1353 dma2 - DMA2 # for CS4232 PCM interface.
1354 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1355
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001356 This module supports multiple cards and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357
1358 Module snd-sonicvibes
1359 ---------------------
1360
1361 Module for S3 SonicVibes PCI sound cards.
1362 * PINE Schubert 32 PCI
1363
1364 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1365 - SoundCard must have onboard SRAM for this.
1366 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1367
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001368 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369
1370 Module snd-serial-u16550
1371 ------------------------
1372
1373 Module for UART16550A serial MIDI ports.
1374
1375 port - port # for UART16550A chip
1376 irq - IRQ # for UART16550A chip, -1 = poll mode
1377 speed - speed in bauds (9600,19200,38400,57600,115200)
1378 38400 = default
1379 base - base for divisor in bauds (57600,115200,230400,460800)
1380 115200 = default
1381 outs - number of MIDI ports in a serial port (1-4)
1382 1 = default
1383 adaptor - Type of adaptor.
1384 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1385 3 = MS-124W M/B, 4 = Generic
1386
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001387 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 thus the main port must be specified!!! Other options are optional.
1389
1390 Module snd-trident
1391 ------------------
1392
1393 Module for Trident 4DWave DX/NX sound cards.
1394 * Best Union Miss Melody 4DWave PCI
1395 * HIS 4DWave PCI
1396 * Warpspeed ONSpeed 4DWave PCI
1397 * AzTech PCI 64-Q3D
1398 * Addonics SV 750
1399 * CHIC True Sound 4Dwave
1400 * Shark Predator4D-PCI
1401 * Jaton SonicWave 4D
1402
1403 pcm_channels - max channels (voices) reserved for PCM
1404 wavetable_size - max wavetable size in kB (4-?kb)
1405
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001406 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407
1408 The power-management is supported.
1409
1410 Module snd-usb-audio
1411 --------------------
1412
1413 Module for USB audio and USB MIDI devices.
1414
1415 vid - Vendor ID for the device (optional)
1416 pid - Product ID for the device (optional)
Thibault LE MEURe3113342006-03-14 11:44:53 +01001417 device_setup - Device specific magic number (optional)
1418 - Influence depends on the device
1419 - Default: 0x0000
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001421 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422
1423 Module snd-usb-usx2y
1424 --------------------
1425
1426 Module for Tascam USB US-122, US-224 and US-428 devices.
1427
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001428 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429
1430 Note: you need to load the firmware via usx2yloader utility included
1431 in alsa-tools and alsa-firmware packages.
1432
1433 Module snd-via82xx
1434 ------------------
1435
1436 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001437 8233A, 8233C, 8235, 8237 (south) bridge.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438
1439 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1440 [VIA686A/686B only]
1441 joystick - Enable joystick (default off) [VIA686A/686B only]
1442 ac97_clock - AC'97 codec clock base (default 48000Hz)
1443 dxs_support - support DXS channels,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001444 0 = auto (default), 1 = enable, 2 = disable,
1445 3 = 48k only, 4 = no VRA, 5 = enable any sample
1446 rate and different sample rates on different
1447 channels
1448 [VIA8233/C, 8235, 8237 only]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001450 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001452 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453
1454 Note: on some SMP motherboards like MSI 694D the interrupts might
1455 not be generated properly. In such a case, please try to
1456 set the SMP (or MPS) version on BIOS to 1.1 instead of
1457 default value 1.4. Then the interrupt number will be
1458 assigned under 15. You might also upgrade your BIOS.
1459
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001460 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 channels as the first PCM. On these channels, up to 4
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001462 streams can be played at the same time, and the controller
1463 can perform sample rate conversion with separate rates for
1464 each channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465 As default (dxs_support = 0), 48k fixed rate is chosen
1466 except for the known devices since the output is often
1467 noisy except for 48k on some mother boards due to the
1468 bug of BIOS.
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001469 Please try once dxs_support=5 and if it works on other
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1471 know the PCI subsystem vendor/device id's (output of
1472 "lspci -nv").
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001473 If dxs_support=5 does not work, try dxs_support=4; if it
1474 doesn't work too, try dxs_support=1. (dxs_support=1 is
Takashi Iwai62430082005-09-05 17:12:29 +02001475 usually for old motherboards. The correct implemented
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001476 board should work with 4 or 5.) If it still doesn't
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 work and the default setting is ok, dxs_support=3 is the
1478 right choice. If the default setting doesn't work at all,
1479 try dxs_support=2 to disable the DXS channels.
1480 In any cases, please let us know the result and the
Takashi Iwai62430082005-09-05 17:12:29 +02001481 subsystem vendor/device ids. See "Links and Addresses"
1482 below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001483
1484 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Takashi Iwai62430082005-09-05 17:12:29 +02001485 additionally. The mpu_port option is for VIA686 chips only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486
Takashi Iwaia4efc232005-11-17 17:24:26 +01001487 The power-management is supported.
1488
Linus Torvalds1da177e2005-04-16 15:20:36 -07001489 Module snd-via82xx-modem
1490 ------------------------
1491
1492 Module for VIA82xx AC97 modem
1493
1494 ac97_clock - AC'97 codec clock base (default 48000Hz)
1495
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001496 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497
1498 Note: The default index value of this module is -2, i.e. the first
1499 slot is excluded.
1500
Takashi Iwaia4efc232005-11-17 17:24:26 +01001501 The power-management is supported.
1502
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 Module snd-virmidi
1504 ------------------
1505
1506 Module for virtual rawmidi devices.
1507 This module creates virtual rawmidi devices which communicate
1508 to the corresponding ALSA sequencer ports.
1509
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001510 midi_devs - MIDI devices # (1-4, default=4)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001512 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001513
1514 Module snd-vx222
1515 ----------------
1516
1517 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1518
1519 mic - Enable Microphone on V222 Mic (NYI)
1520 ibl - Capture IBL size. (default = 0, minimum size)
1521
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001522 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523
1524 When the driver is compiled as a module and the hotplug firmware
1525 is supported, the firmware data is loaded via hotplug automatically.
1526 Install the necessary firmware files in alsa-firmware package.
1527 When no hotplug fw loader is available, you need to load the
1528 firmware via vxloader utility in alsa-tools package. To invoke
1529 vxloader automatically, add the following to /etc/modprobe.conf
1530
1531 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1532
1533 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1534 /etc/modules.conf, instead.)
1535 IBL size defines the interrupts period for PCM. The smaller size
1536 gives smaller latency but leads to more CPU consumption, too.
1537 The size is usually aligned to 126. As default (=0), the smallest
1538 size is chosen. The possible IBL values can be found in
1539 /proc/asound/cardX/vx-status proc file.
1540
Takashi Iwaia4efc232005-11-17 17:24:26 +01001541 The power-management is supported.
1542
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543 Module snd-vxpocket
1544 -------------------
1545
Takashi Iwai6d00a312005-06-30 13:40:51 +02001546 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547
1548 ibl - Capture IBL size. (default = 0, minimum size)
1549
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001550 This module supports multiple cards. The module is compiled only when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 PCMCIA is supported on kernel.
1552
Takashi Iwai62430082005-09-05 17:12:29 +02001553 With the older 2.6.x kernel, to activate the driver via the card
1554 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1555 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1556 longer require a config file.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557
1558 When the driver is compiled as a module and the hotplug firmware
1559 is supported, the firmware data is loaded via hotplug automatically.
1560 Install the necessary firmware files in alsa-firmware package.
1561 When no hotplug fw loader is available, you need to load the
1562 firmware via vxloader utility in alsa-tools package.
1563
1564 About capture IBL, see the description of snd-vx222 module.
1565
1566 Note: the driver is build only when CONFIG_ISA is set.
1567
Takashi Iwai62430082005-09-05 17:12:29 +02001568 Note2: snd-vxp440 driver is merged to snd-vxpocket driver since
1569 ALSA 1.0.10.
1570
Takashi Iwaia4efc232005-11-17 17:24:26 +01001571 The power-management is supported.
1572
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573 Module snd-ymfpci
1574 -----------------
1575
1576 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1577
1578 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1579 1 (auto-detect for YMF744/754 only)
1580 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1581 1 (auto-detect for YMF744/754 only)
1582 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1583 1 (auto-detect)
1584 rear_switch - enable shared rear/line-in switch (bool)
1585
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001586 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587
1588 The power-management is supported.
1589
1590 Module snd-pdaudiocf
1591 --------------------
1592
1593 Module for Sound Core PDAudioCF sound card.
1594
1595 Note: the driver is build only when CONFIG_ISA is set.
1596
Takashi Iwaia4efc232005-11-17 17:24:26 +01001597 The power-management is supported.
1598
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599
Takashi Iwai62430082005-09-05 17:12:29 +02001600AC97 Quirk Option
1601=================
1602
1603The ac97_quirk option is used to enable/override the workaround for
1604specific devices on drivers for on-board AC'97 controllers like
1605snd-intel8x0. Some hardware have swapped output pins between Master
1606and Headphone, or Surround (thanks to confusion of AC'97
1607specifications from version to version :-)
1608
1609The driver provides the auto-detection of known problematic devices,
1610but some might be unknown or wrongly detected. In such a case, pass
1611the proper value with this option.
1612
1613The following strings are accepted:
1614 - default Don't override the default setting
Takashi Iwai10e4097f2005-11-17 11:04:55 +01001615 - none Disable the quirk
Takashi Iwai62430082005-09-05 17:12:29 +02001616 - hp_only Bind Master and Headphone controls as a single control
1617 - swap_hp Swap headphone and master controls
1618 - swap_surround Swap master and surround controls
1619 - ad_sharing For AD1985, turn on OMS bit and use headphone
1620 - alc_jack For ALC65x, turn on the jack sense mode
1621 - inv_eapd Inverted EAPD implementation
1622 - mute_led Bind EAPD bit for turning on/off mute LED
1623
1624For backward compatibility, the corresponding integer value -1, 0,
1625... are accepted, too.
1626
1627For example, if "Master" volume control has no effect on your device
1628but only "Headphone" does, pass ac97_quirk=hp_only module option.
1629
1630
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631Configuring Non-ISAPNP Cards
1632============================
1633
1634When the kernel is configured with ISA-PnP support, the modules
1635supporting the isapnp cards will have module options "isapnp".
1636If this option is set, *only* the ISA-PnP devices will be probed.
1637For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
1638together with the proper i/o and irq configuration.
1639
1640When the kernel is configured without ISA-PnP support, isapnp option
1641will be not built in.
1642
1643
1644Module Autoloading Support
1645==========================
1646
1647The ALSA drivers can be loaded automatically on demand by defining
1648module aliases. The string 'snd-card-%1' is requested for ALSA native
1649devices where %i is sound card number from zero to seven.
1650
1651To auto-load an ALSA driver for OSS services, define the string
1652'sound-slot-%i' where %i means the slot number for OSS, which
1653corresponds to the card index of ALSA. Usually, define this
Tobias Klauserd533f672005-09-10 00:26:46 -07001654as the same card module.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655
1656An example configuration for a single emu10k1 card is like below:
1657----- /etc/modprobe.conf
1658alias snd-card-0 snd-emu10k1
1659alias sound-slot-0 snd-emu10k1
1660----- /etc/modprobe.conf
1661
1662The available number of auto-loaded sound cards depends on the module
1663option "cards_limit" of snd module. As default it's set to 1.
1664To enable the auto-loading of multiple cards, specify the number of
1665sound cards in that option.
1666
1667When multiple cards are available, it'd better to specify the index
1668number for each card via module option, too, so that the order of
1669cards is kept consistent.
1670
1671An example configuration for two sound cards is like below:
1672
1673----- /etc/modprobe.conf
1674# ALSA portion
1675options snd cards_limit=2
1676alias snd-card-0 snd-interwave
1677alias snd-card-1 snd-ens1371
1678options snd-interwave index=0
1679options snd-ens1371 index=1
1680# OSS/Free portion
1681alias sound-slot-0 snd-interwave
1682alias sound-slot-1 snd-ens1371
1683----- /etc/moprobe.conf
1684
1685In this example, the interwave card is always loaded as the first card
1686(index 0) and ens1371 as the second (index 1).
1687
1688
1689ALSA PCM devices to OSS devices mapping
1690=======================================
1691
1692/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
1693/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
1694/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
1695/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
1696/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
1697/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
1698/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
1699/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
1700/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
1701
1702The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
1703sound card number and second means device number. The ALSA devices
1704have either 'c' or 'p' suffix indicating the direction, capture and
1705playback, respectively.
1706
1707Please note that the device mapping above may be varied via the module
1708options of snd-pcm-oss module.
1709
1710
1711DEVFS support
1712=============
1713
1714The ALSA driver fully supports the devfs extension.
1715You should add lines below to your devfsd.conf file:
1716
1717LOOKUP snd MODLOAD ACTION snd
1718REGISTER ^sound/.* PERMISSIONS root.audio 660
1719REGISTER ^snd/.* PERMISSIONS root.audio 660
1720
1721Warning: These lines assume that you have the audio group in your system.
1722 Otherwise replace audio word with another group name (root for
1723 example).
1724
1725
1726Proc interfaces (/proc/asound)
1727==============================
1728
1729/proc/asound/card#/pcm#[cp]/oss
1730-------------------------------
1731 String "erase" - erase all additional informations about OSS applications
1732 String "<app_name> <fragments> <fragment_size> [<options>]"
1733
1734 <app_name> - name of application with (higher priority) or without path
1735 <fragments> - number of fragments or zero if auto
1736 <fragment_size> - size of fragment in bytes or zero if auto
1737 <options> - optional parameters
1738 - disable the application tries to open a pcm device for
1739 this channel but does not want to use it.
1740 (Cause a bug or mmap needs)
1741 It's good for Quake etc...
1742 - direct don't use plugins
1743 - block force block mode (rvplayer)
1744 - non-block force non-block mode
1745 - whole-frag write only whole fragments (optimization affecting
1746 playback only)
1747 - no-silence do not fill silence ahead to avoid clicks
Takashi Iwai10f69f92005-09-08 13:48:34 +02001748 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
1749 instead of filled blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750
1751 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
1752 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
1753 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
1754
1755
Takashi Iwaib6a96912005-05-30 18:27:03 +02001756Early Buffer Allocation
1757=======================
1758
1759Some drivers (e.g. hdsp) require the large contiguous buffers, and
1760sometimes it's too late to find such spaces when the driver module is
1761actually loaded due to memory fragmentation. You can pre-allocate the
1762PCM buffers by loading snd-page-alloc module and write commands to its
1763proc file in prior, for example, in the early boot stage like
1764/etc/init.d/*.local scripts.
1765
1766Reading the proc file /proc/drivers/snd-page-alloc shows the current
1767usage of page allocation. In writing, you can send the following
1768commands to the snd-page-alloc driver:
1769
1770 - add VENDOR DEVICE MASK SIZE BUFFERS
1771
1772 VENDOR and DEVICE are PCI vendor and device IDs. They take
1773 integer numbers (0x prefix is needed for the hex).
1774 MASK is the PCI DMA mask. Pass 0 if not restricted.
1775 SIZE is the size of each buffer to allocate. You can pass
1776 k and m suffix for KB and MB. The max number is 16MB.
1777 BUFFERS is the number of buffers to allocate. It must be greater
1778 than 0. The max number is 4.
1779
1780 - erase
1781
1782 This will erase the all pre-allocated buffers which are not in
1783 use.
1784
1785
Takashi Iwai62430082005-09-05 17:12:29 +02001786Links and Addresses
1787===================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788
1789 ALSA project homepage
1790 http://www.alsa-project.org
1791
Takashi Iwai62430082005-09-05 17:12:29 +02001792 ALSA Bug Tracking System
1793 https://bugtrack.alsa-project.org/bugs/
1794
1795 ALSA Developers ML
1796 mailto:alsa-devel@lists.sourceforge.net