blob: a16dd34817d2d97036902764aa080654fedbc919 [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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
61
62 Module snd-pcm-oss
63 ------------------
64
65 The PCM OSS emulation module.
66 This module takes options which change the mapping of devices.
67
68 dsp_map - PCM device number maps assigned to the 1st OSS device.
69 - Default: 0
70 adsp_map - PCM device number maps assigned to the 2st OSS device.
71 - Default: 1
72 nonblock_open
Takashi Iwai62430082005-09-05 17:12:29 +020073 - Don't block opening busy PCM devices. Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
75 For example, when dsp_map=2, /dev/dsp will be mapped to PCM #2 of
76 the card #0. Similarly, when adsp_map=0, /dev/adsp will be mapped
77 to PCM #0 of the card #0.
78 For changing the second or later card, specify the option with
79 commas, such like "dsp_map=0,1".
80
81 nonblock_open option is used to change the behavior of the PCM
82 regarding opening the device. When this option is non-zero,
83 opening a busy OSS PCM device won't be blocked but return
84 immediately with EAGAIN (just like O_NONBLOCK flag).
85
86 Module snd-rawmidi
87 ------------------
88
89 This module takes options which change the mapping of devices.
90 similar to those of the snd-pcm-oss module.
91
92 midi_map - MIDI device number maps assigned to the 1st OSS device.
93 - Default: 0
94 amidi_map - MIDI device number maps assigned to the 2st OSS device.
95 - Default: 1
96
97 Common parameters for top sound card modules
98 --------------------------------------------
99
100 Each of top level sound card module takes the following options.
101
102 index - index (slot #) of sound card
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100103 - Values: 0 through 31 or negative
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 - If nonnegative, assign that index number
105 - if negative, interpret as a bitmask of permissible
106 indices; the first free permitted index is assigned
107 - Default: -1
108 id - card ID (identifier or name)
109 - Can be up to 15 characters long
110 - Default: the card type
111 - A directory by this name is created under /proc/asound/
112 containing information about the card
113 - This ID can be used instead of the index number in
114 identifying the card
115 enable - enable card
116 - Default: enabled, for PCI and ISA PnP cards
117
Rene Hermancf40a312006-03-28 12:38:20 +0200118 Module snd-adlib
119 ----------------
120
121 Module for AdLib FM cards.
122
123 port - port # for OPL chip
124
125 This module supports multiple cards. It does not support autoprobe, so
126 the port must be specified. For actual AdLib FM cards it will be 0x388.
127 Note that this card does not have PCM support and no mixer; only FM
128 synthesis.
129
130 Make sure you have "sbiload" from the alsa-tools package available and,
131 after loading the module, find out the assigned ALSA sequencer port
132 number through "sbiload -l". Example output:
133
134 Port Client name Port name
135 64:0 OPL2 FM synth OPL2 FM Port
136
137 Load the std.sb and drums.sb patches also supplied by sbiload:
138
139 sbiload -p 64:0 std.sb drums.sb
140
141 If you use this driver to drive an OPL3, you can use std.o3 and drums.o3
142 instead. To have the card produce sound, use aplaymidi from alsa-utils:
143
144 aplaymidi -p 64:0 foo.mid
145
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 Module snd-ad1816a
147 ------------------
148
149 Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips.
150
151 port - port # for AD1816A chip (PnP setup)
152 mpu_port - port # for MPU-401 UART (PnP setup)
153 fm_port - port # for OPL3 (PnP setup)
154 irq - IRQ # for AD1816A chip (PnP setup)
155 mpu_irq - IRQ # for MPU-401 UART (PnP setup)
156 dma1 - first DMA # for AD1816A chip (PnP setup)
157 dma2 - second DMA # for AD1816A chip (PnP setup)
Takashi Iwai506d4c62005-08-03 14:02:47 +0200158 clockfreq - Clock frequency for AD1816A chip (default = 0, 33000Hz)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100160 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
162 Module snd-ad1848
163 -----------------
164
165 Module for sound cards based on AD1848/AD1847/CS4248 ISA chips.
166
167 port - port # for AD1848 chip
168 irq - IRQ # for AD1848 chip
169 dma1 - DMA # for AD1848 chip (0,1,3)
170
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100171 This module supports multiple cards. It does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 thus main port must be specified!!! Other ports are optional.
173
Takashi Iwaia4efc232005-11-17 17:24:26 +0100174 The power-management is supported.
175
Clemens Ladisch84010e62005-09-02 07:57:59 +0200176 Module snd-ad1889
177 -----------------
178
179 Module for Analog Devices AD1889 chips.
180
181 ac97_quirk - AC'97 workaround for strange hardware
182 See the description of intel8x0 module for details.
183
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100184 This module supports multiple cards.
Clemens Ladisch84010e62005-09-02 07:57:59 +0200185
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 Module snd-ali5451
187 ------------------
188
189 Module for ALi M5451 PCI chip.
190
191 pcm_channels - Number of hardware channels assigned for PCM
192 spdif - Support SPDIF I/O
193 - Default: disabled
194
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +0200195 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196
197 The power-management is supported.
198
199 Module snd-als100
200 -----------------
201
202 Module for sound cards based on Avance Logic ALS100/ALS120 ISA chips.
203
204 port - port # for ALS100 (SB16) chip (PnP setup)
205 irq - IRQ # for ALS100 (SB16) chip (PnP setup)
206 dma8 - 8-bit DMA # for ALS100 (SB16) chip (PnP setup)
207 dma16 - 16-bit DMA # for ALS100 (SB16) chip (PnP setup)
208 mpu_port - port # for MPU-401 UART (PnP setup)
209 mpu_irq - IRQ # for MPU-401 (PnP setup)
210 fm_port - port # for OPL3 FM (PnP setup)
211
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100212 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
Takashi Iwaia4efc232005-11-17 17:24:26 +0100214 The power-management is supported.
215
Ash Willisb3a70d52006-03-27 13:20:40 +0200216 Module snd-als300
217 -----------------
218
219 Module for Avance Logic ALS300 and ALS300+
220
221 This module supports multiple cards.
222
223 The power-management is supported.
224
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 Module snd-als4000
226 ------------------
227
228 Module for sound cards based on Avance Logic ALS4000 PCI chip.
229
230 joystick_port - port # for legacy joystick support.
231 0 = disabled (default), 1 = auto-detect
232
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100233 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
Takashi Iwaia4efc232005-11-17 17:24:26 +0100235 The power-management is supported.
236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 Module snd-atiixp
238 -----------------
239
Takashi Iwai62430082005-09-05 17:12:29 +0200240 Module for ATI IXP 150/200/250/400 AC97 controllers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
Takashi Iwai62430082005-09-05 17:12:29 +0200242 ac97_clock - AC'97 clock (default = 48000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200244 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 spdif_aclink - S/PDIF transfer over AC-link (default = 1)
246
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200247 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
Takashi Iwai62430082005-09-05 17:12:29 +0200249 ATI IXP has two different methods to control SPDIF output. One is
250 over AC-link and another is over the "direct" SPDIF output. The
251 implementation depends on the motherboard, and you'll need to
252 choose the correct one via spdif_aclink module option.
253
Takashi Iwaia4efc232005-11-17 17:24:26 +0100254 The power-management is supported.
255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 Module snd-atiixp-modem
257 -----------------------
258
259 Module for ATI IXP 150/200/250 AC97 modem controllers.
260
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200261 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
263 Note: The default index value of this module is -2, i.e. the first
264 slot is excluded.
265
Takashi Iwaia4efc232005-11-17 17:24:26 +0100266 The power-management is supported.
267
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 Module snd-au8810, snd-au8820, snd-au8830
269 -----------------------------------------
270
271 Module for Aureal Vortex, Vortex2 and Advantage device.
272
273 pcifix - Control PCI workarounds
274 0 = Disable all workarounds
275 1 = Force the PCI latency of the Aureal card to 0xff
276 2 = Force the Extend PCI#2 Internal Master for Efficient
277 Handling of Dummy Requests on the VIA KT133 AGP Bridge
278 3 = Force both settings
279 255 = Autodetect what is required (default)
280
281 This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
282 EQ, mpu401, gameport. A3D and wavetable support are still in development.
283 Development and reverse engineering work is being coordinated at
284 http://savannah.nongnu.org/projects/openvortex/
285 SPDIF output has a copy of the AC97 codec output, unless you use the
286 "spdif" pcm device, which allows raw data passthru.
287 The hardware EQ hardware and SPDIF is only present in the Vortex2 and
288 Advantage.
289
Takashi Iwai62430082005-09-05 17:12:29 +0200290 Note: Some ALSA mixer applications don't handle the SPDIF sample rate
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 control correctly. If you have problems regarding this, try
292 another ALSA compliant mixer (alsamixer works).
293
294 Module snd-azt2320
295 ------------------
296
297 Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
298
299 port - port # for AZT2320 chip (PnP setup)
300 wss_port - port # for WSS (PnP setup)
301 mpu_port - port # for MPU-401 UART (PnP setup)
302 fm_port - FM port # for AZT2320 chip (PnP setup)
303 irq - IRQ # for AZT2320 (WSS) chip (PnP setup)
304 mpu_irq - IRQ # for MPU-401 UART (PnP setup)
305 dma1 - 1st DMA # for AZT2320 (WSS) chip (PnP setup)
306 dma2 - 2nd DMA # for AZT2320 (WSS) chip (PnP setup)
307
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100308 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
Takashi Iwaia4efc232005-11-17 17:24:26 +0100310 The power-management is supported.
311
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 Module snd-azt3328
313 ------------------
314
315 Module for sound cards based on Aztech AZF3328 PCI chip.
316
317 joystick - Enable joystick (default off)
318
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100319 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320
321 Module snd-bt87x
322 ----------------
323
324 Module for video cards based on Bt87x chips.
325
326 digital_rate - Override the default digital rate (Hz)
327 load_all - Load the driver even if the card model isn't known
328
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100329 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
331 Note: The default index value of this module is -2, i.e. the first
332 slot is excluded.
333
334 Module snd-ca0106
335 -----------------
336
337 Module for Creative Audigy LS and SB Live 24bit
338
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100339 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
341
342 Module snd-cmi8330
343 ------------------
344
345 Module for sound cards based on C-Media CMI8330 ISA chips.
346
347 wssport - port # for CMI8330 chip (WSS)
348 wssirq - IRQ # for CMI8330 chip (WSS)
349 wssdma - first DMA # for CMI8330 chip (WSS)
350 sbport - port # for CMI8330 chip (SB16)
351 sbirq - IRQ # for CMI8330 chip (SB16)
352 sbdma8 - 8bit DMA # for CMI8330 chip (SB16)
353 sbdma16 - 16bit DMA # for CMI8330 chip (SB16)
354
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100355 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356
Takashi Iwaia4efc232005-11-17 17:24:26 +0100357 The power-management is supported.
358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 Module snd-cmipci
360 -----------------
361
362 Module for C-Media CMI8338 and 8738 PCI sound cards.
363
Takashi Iwaicab5c4c2006-05-04 14:36:08 +0200364 mpu_port - 0x300,0x310,0x320,0x330 = legacy port,
365 1 = integrated PCI port,
366 0 = disable (default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 fm_port - 0x388 (default), 0 = disable (default)
Takashi Iwai62430082005-09-05 17:12:29 +0200368 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 (default = 1)
370 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
371
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100372 This module supports autoprobe and multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
Takashi Iwaia4efc232005-11-17 17:24:26 +0100374 The power-management is supported.
375
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 Module snd-cs4231
377 -----------------
378
379 Module for sound cards based on CS4231 ISA chips.
380
381 port - port # for CS4231 chip
382 mpu_port - port # for MPU-401 UART (optional), -1 = disable
383 irq - IRQ # for CS4231 chip
384 mpu_irq - IRQ # for MPU-401 UART
385 dma1 - first DMA # for CS4231 chip
386 dma2 - second DMA # for CS4231 chip
387
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100388 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389 thus main port must be specified!!! Other ports are optional.
390
391 The power-management is supported.
392
393 Module snd-cs4232
394 -----------------
395
396 Module for sound cards based on CS4232/CS4232A ISA chips.
397
398 port - port # for CS4232 chip (PnP setup - 0x534)
399 cport - control port # for CS4232 chip (PnP setup - 0x120,0x210,0xf00)
400 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
401 fm_port - FM port # for CS4232 chip (PnP setup - 0x388), -1 = disable
402 irq - IRQ # for CS4232 chip (5,7,9,11,12,15)
403 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
404 dma1 - first DMA # for CS4232 chip (0,1,3)
405 dma2 - second DMA # for Yamaha CS4232 chip (0,1,3), -1 = disable
406 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
407
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100408 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 thus main port must be specified!!! Other ports are optional.
410
411 The power-management is supported.
412
413 Module snd-cs4236
414 -----------------
415
416 Module for sound cards based on CS4235/CS4236/CS4236B/CS4237B/
417 CS4238B/CS4239 ISA chips.
418
419 port - port # for CS4236 chip (PnP setup - 0x534)
420 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
421 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
422 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
423 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
424 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
425 dma1 - first DMA # for CS4236 chip (0,1,3)
426 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
427 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
428
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100429 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 (if ISA PnP is not used) thus main port and control port must be
431 specified!!! Other ports are optional.
432
433 The power-management is supported.
434
435 Module snd-cs4281
436 -----------------
437
438 Module for Cirrus Logic CS4281 soundchip.
439
440 dual_codec - Secondary codec ID (0 = disable, default)
441
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100442 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
444 The power-management is supported.
445
446 Module snd-cs46xx
447 -----------------
448
449 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
450 CS4624/CS4630/CS4280 PCI chips.
451
Takashi Iwai62430082005-09-05 17:12:29 +0200452 external_amp - Force to enable external amplifier.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 thinkpad - Force to enable Thinkpad's CLKRUN control.
454 mmap_valid - Support OSS mmap mode (default = 0).
455
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100456 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 Usually external amp and CLKRUN controls are detected automatically
458 from PCI sub vendor/device ids. If they don't work, give the options
459 above explicitly.
460
461 The power-management is supported.
462
Takashi Iwai3e873172005-11-17 10:15:37 +0100463 Module snd-cs5535audio
464 ----------------------
465
466 Module for multifunction CS5535 companion PCI device
467
Takashi Iwaic00bd742006-05-19 19:22:34 +0200468 The power-management is supported.
Takashi Iwai3e873172005-11-17 10:15:37 +0100469
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200470 Module snd-darla20
471 ------------------
472
473 Module for Echoaudio Darla20
474
475 This module supports multiple cards.
476 The driver requires the firmware loader support on kernel.
477
478 Module snd-darla24
479 ------------------
480
481 Module for Echoaudio Darla24
482
483 This module supports multiple cards.
484 The driver requires the firmware loader support on kernel.
485
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 Module snd-dt019x
487 -----------------
488
489 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
490 only)
491
492 port - Port # (PnP setup)
493 mpu_port - Port # for MPU-401 (PnP setup)
494 fm_port - Port # for FM OPL-3 (PnP setup)
495 irq - IRQ # (PnP setup)
496 mpu_irq - IRQ # for MPU-401 (PnP setup)
497 dma8 - DMA # (PnP setup)
498
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100499 This module supports multiple cards. This module is enabled only with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 ISA PnP support.
501
Takashi Iwaia4efc232005-11-17 17:24:26 +0100502 The power-management is supported.
503
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 Module snd-dummy
505 ----------------
506
507 Module for the dummy sound card. This "card" doesn't do any output
508 or input, but you may use this module for any application which
509 requires a sound card (like RealPlayer).
510
Takashi Iwaia4efc232005-11-17 17:24:26 +0100511 The power-management is supported.
512
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200513 Module snd-echo3g
514 -----------------
515
516 Module for Echoaudio 3G cards (Gina3G/Layla3G)
517
518 This module supports multiple cards.
519 The driver requires the firmware loader support on kernel.
520
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 Module snd-emu10k1
522 ------------------
523
524 Module for EMU10K1/EMU10k2 based PCI sound cards.
525 * Sound Blaster Live!
526 * Sound Blaster PCI 512
527 * Emu APS (partially supported)
528 * Sound Blaster Audigy
529
530 extin - bitmap of available external inputs for FX8010 (see bellow)
531 extout - bitmap of available external outputs for FX8010 (see bellow)
532 seq_ports - allocated sequencer ports (4 by default)
533 max_synth_voices - limit of voices used for wavetable (64 by default)
534 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
535 given in MB unit. Default value is 128.
536 enable_ir - enable IR
537
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100538 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
540 Input & Output configurations [extin/extout]
541 * Creative Card wo/Digital out [0x0003/0x1f03]
542 * Creative Card w/Digital out [0x0003/0x1f0f]
543 * Creative Card w/Digital CD in [0x000f/0x1f0f]
544 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
545 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
546 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
547 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
548 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
549 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
550 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
551 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
552 * Creative Card all ins and outs [0x3fff/0x7fff]
553
Takashi Iwaia4efc232005-11-17 17:24:26 +0100554 The power-management is supported.
555
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 Module snd-emu10k1x
557 -------------------
558
559 Module for Creative Emu10k1X (SB Live Dell OEM version)
560
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100561 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562
563 Module snd-ens1370
564 ------------------
565
566 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
567 * SoundBlaster PCI 64
568 * SoundBlaster PCI 128
569
570 joystick - Enable joystick (default off)
571
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100572 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100574 The power-management is supported.
575
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 Module snd-ens1371
577 ------------------
578
579 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
580 * SoundBlaster PCI 64
581 * SoundBlaster PCI 128
582 * SoundBlaster Vibra PCI
583
584 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
585 0 = disable (default), 1 = auto-detect
586
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100587 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100589 The power-management is supported.
590
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591 Module snd-es968
592 ----------------
593
594 Module for sound cards based on ESS ES968 chip (PnP only).
595
596 port - port # for ES968 (SB8) chip (PnP setup)
597 irq - IRQ # for ES968 (SB8) chip (PnP setup)
598 dma1 - DMA # for ES968 (SB8) chip (PnP setup)
599
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100600 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
Takashi Iwaia4efc232005-11-17 17:24:26 +0100602 The power-management is supported.
603
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 Module snd-es1688
605 -----------------
606
607 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
608
609 port - port # for ES-1688 chip (0x220,0x240,0x260)
610 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
611 irq - IRQ # for ES-1688 chip (5,7,9,10)
612 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
613 dma8 - DMA # for ES-1688 chip (0,1,3)
614
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100615 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616
617 Module snd-es18xx
618 -----------------
619
620 Module for ESS AudioDrive ES-18xx sound cards.
621
622 port - port # for ES-18xx chip (0x220,0x240,0x260)
623 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
624 fm_port - port # for FM (optional, not used)
625 irq - IRQ # for ES-18xx chip (5,7,9,10)
626 dma1 - first DMA # for ES-18xx chip (0,1,3)
627 dma2 - first DMA # for ES-18xx chip (0,1,3)
628 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
629
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100630 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
631 port if native ISA PnP routines are not used).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 When dma2 is equal with dma1, the driver works as half-duplex.
633
634 The power-management is supported.
635
636 Module snd-es1938
637 -----------------
638
639 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
640
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100641 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642
Takashi Iwaia4efc232005-11-17 17:24:26 +0100643 The power-management is supported.
644
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 Module snd-es1968
646 -----------------
647
648 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
649
650 total_bufsize - total buffer size in kB (1-4096kB)
651 pcm_substreams_p - playback channels (1-8, default=2)
652 pcm_substreams_c - capture channels (1-8, default=0)
653 clock - clock (0 = auto-detection)
654 use_pm - support the power-management (0 = off, 1 = on,
655 2 = auto (default))
656 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
657 joystick - enable joystick (default off)
658
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100659 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
661 The power-management is supported.
662
663 Module snd-fm801
664 ----------------
665
666 Module for ForteMedia FM801 based PCI sound cards.
667
668 tea575x_tuner - Enable TEA575x tuner
669 - 1 = MediaForte 256-PCS
670 - 2 = MediaForte 256-PCPR
671 - 3 = MediaForte 64-PCR
672 - High 16-bits are video (radio) device number + 1
673 - example: 0x10002 (MediaForte 256-PCPR, device 1)
674
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100675 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676
Takashi Iwaia4efc232005-11-17 17:24:26 +0100677 The power-management is supported.
678
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200679 Module snd-gina20
680 -----------------
681
682 Module for Echoaudio Gina20
683
684 This module supports multiple cards.
685 The driver requires the firmware loader support on kernel.
686
687 Module snd-gina24
688 -----------------
689
690 Module for Echoaudio Gina24
691
692 This module supports multiple cards.
693 The driver requires the firmware loader support on kernel.
694
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 Module snd-gusclassic
696 ---------------------
697
698 Module for Gravis UltraSound Classic sound card.
699
700 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
701 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
702 dma1 - DMA # for GF1 chip (1,3,5,6,7)
703 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
704 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
705 voices - GF1 voices limit (14-32)
706 pcm_voices - reserved PCM voices
707
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100708 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
710 Module snd-gusextreme
711 ---------------------
712
713 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
714
715 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
716 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
717 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
718 irq - IRQ # for ES-1688 chip (5,7,9,10)
719 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
720 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
721 dma8 - DMA # for ES-1688 chip (0,1,3)
722 dma1 - DMA # for GF1 chip (1,3,5,6,7)
723 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
724 voices - GF1 voices limit (14-32)
725 pcm_voices - reserved PCM voices
726
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100727 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728
729 Module snd-gusmax
730 -----------------
731
732 Module for Gravis UltraSound MAX sound card.
733
734 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
735 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
736 dma1 - DMA # for GF1 chip (1,3,5,6,7)
737 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
738 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
739 voices - GF1 voices limit (14-32)
740 pcm_voices - reserved PCM voices
741
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100742 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
744 Module snd-hda-intel
745 --------------------
746
Takashi Iwai9b878192006-05-17 11:26:39 +0200747 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8),
748 ATI SB450, SB600, RS600,
749 VIA VT8251/VT8237A,
750 SIS966, ULI M5461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751
752 model - force the model name
Takashi Iwai62430082005-09-05 17:12:29 +0200753 position_fix - Fix DMA pointer (0 = auto, 1 = none, 2 = POSBUF, 3 = FIFO size)
Takashi Iwai27346162006-01-12 18:28:44 +0100754 single_cmd - Use single immediate commands to communicate with
755 codecs (for debugging only)
Takashi Iwai134a11f2006-11-10 12:08:37 +0100756 enable_msi - Enable Message Signaled Interrupt (MSI) (default = off)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200758 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759
760 Each codec may have a model table for different configurations.
761 If your machine isn't listed there, the default (usually minimal)
762 configuration is set up. You can pass "model=<name>" option to
763 specify a certain model in such a case. There are different
764 models depending on the codec chip.
765
766 Model name Description
767 ---------- -----------
768 ALC880
769 3stack 3-jack in back and a headphone out
770 3stack-digout 3-jack in back, a HP out and a SPDIF out
771 5stack 5-jack in back, 2-jack in front
772 5stack-digout 5-jack in back, 2-jack in front, a SPDIF out
Takashi Iwaib6482d42005-06-27 15:32:43 +0200773 6stack 6-jack in back, 2-jack in front
774 6stack-digout 6-jack with a SPDIF out
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 w810 3-jack
Takashi Iwaidfc0ff62005-05-12 14:31:49 +0200776 z71v 3-jack (HP shared SPDIF)
Takashi Iwai4b146cb2006-07-28 14:42:36 +0200777 asus 3-jack (ASUS Mobo)
778 asus-w1v ASUS W1V
779 asus-dig ASUS with SPDIF out
780 asus-dig2 ASUS with SPDIF out (using GPIO2)
Takashi Iwaie9edcee2005-06-13 14:16:38 +0200781 uniwill 3-jack
782 F1734 2-jack
Takashi Iwaiae6b8132006-03-03 16:47:17 +0100783 lg LG laptop (m1 express dual)
Takashi Iwaicd417d42006-09-06 16:03:11 +0200784 lg-lw LG LW20/LW25 laptop
Takashi Iwai4b146cb2006-07-28 14:42:36 +0200785 tcl TCL S700
Takashi Iwai5a053d02006-07-25 14:51:15 +0200786 clevo Clevo laptops (m520G, m665n)
Takashi Iwaib6482d42005-06-27 15:32:43 +0200787 test for testing/debugging purpose, almost all controls can be
788 adjusted. Appearing only when compiled with
789 $CONFIG_SND_DEBUG=y
Takashi Iwaied345f82006-03-01 14:16:53 +0100790 auto auto-config reading BIOS (default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
Takashi Iwai21be3d12005-09-16 19:18:56 +0200792 ALC260
793 hp HP machines
Takashi Iwai4b146cb2006-07-28 14:42:36 +0200794 hp-3013 HP machines (3013-variant)
Takashi Iwai21be3d12005-09-16 19:18:56 +0200795 fujitsu Fujitsu S7020
Takashi Iwaied345f82006-03-01 14:16:53 +0100796 acer Acer TravelMate
797 basic fixed pin assignment (old default model)
798 auto auto-config reading BIOS (default)
799
800 ALC262
801 fujitsu Fujitsu Laptop
Takashi Iwai6d177ba72006-07-25 14:51:15 +0200802 hp-bpc HP xw4400/6400/8400/9400 laptops
Takashi Iwai304dcaa2006-07-25 14:51:16 +0200803 benq Benq ED8
Takashi Iwaied345f82006-03-01 14:16:53 +0100804 basic fixed pin assignment w/o SPDIF
805 auto auto-config reading BIOS (default)
806
Takashi Iwai9c7f8522006-06-28 15:08:22 +0200807 ALC882/885
Takashi Iwaied345f82006-03-01 14:16:53 +0100808 3stack-dig 3-jack with SPDIF I/O
809 6stck-dig 6-jack digital with SPDIF I/O
Takashi Iwai4b146cb2006-07-28 14:42:36 +0200810 arima Arima W820Di1
Takashi Iwaied345f82006-03-01 14:16:53 +0100811 auto auto-config reading BIOS (default)
812
Takashi Iwai9c7f8522006-06-28 15:08:22 +0200813 ALC883/888
814 3stack-dig 3-jack with SPDIF I/O
815 6stack-dig 6-jack digital with SPDIF I/O
Takashi Iwai4b146cb2006-07-28 14:42:36 +0200816 3stack-6ch 3-jack 6-channel
817 3stack-6ch-dig 3-jack 6-channel with SPDIF I/O
818 6stack-dig-demo 6-jack digital for Intel demo board
Vladimir Avdoninbab282b2006-08-22 13:31:58 +0200819 acer Acer laptops (Travelmate 3012WTMi, Aspire 5600, etc)
Tobin Davisc07584c2006-10-13 12:32:16 +0200820 medion Medion Laptops
Takashi Iwai9c7f8522006-06-28 15:08:22 +0200821 auto auto-config reading BIOS (default)
822
823 ALC861/660
Takashi Iwaied345f82006-03-01 14:16:53 +0100824 3stack 3-jack
825 3stack-dig 3-jack with SPDIF I/O
826 6stack-dig 6-jack with SPDIF I/O
Takashi Iwai4b146cb2006-07-28 14:42:36 +0200827 3stack-660 3-jack (for ALC660)
Takashi Iwai22309c32006-08-09 16:57:28 +0200828 uniwill-m31 Uniwill M31 laptop
Tobin Davisa53d1ae2006-10-17 12:00:28 +0200829 toshiba Toshiba laptop support
Takashi Iwaied345f82006-03-01 14:16:53 +0100830 auto auto-config reading BIOS (default)
Takashi Iwai21be3d12005-09-16 19:18:56 +0200831
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 CMI9880
833 minimal 3-jack in back
834 min_fp 3-jack in back, 2-jack in front
835 full 6-jack in back, 2-jack in front
836 full_dig 6-jack in back, 2-jack in front, SPDIF I/O
837 allout 5-jack in back, 2-jack in front, SPDIF out
Takashi Iwaie9edcee2005-06-13 14:16:38 +0200838 auto auto-config reading BIOS (default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839
Takashi Iwai9230d212006-03-13 13:49:49 +0100840 AD1981
841 basic 3-jack (default)
842 hp HP nx6320
Takashi Iwai01686c5f2006-04-18 12:54:11 +0200843 thinkpad Lenovo Thinkpad T60/X60/Z60
Takashi Iwai9230d212006-03-13 13:49:49 +0100844
845 AD1986A
846 6stack 6-jack, separate surrounds (default)
847 3stack 3-stack, shared surrounds
848 laptop 2-channel only (FSC V2060, Samsung M50)
Takashi Iwai825aa9722006-03-17 10:50:49 +0100849 laptop-eapd 2-channel with EAPD (Samsung R65, ASUS A6J)
Takashi Iwai9230d212006-03-13 13:49:49 +0100850
851 AD1988
852 6stack 6-jack
853 6stack-dig ditto with SPDIF
854 3stack 3-jack
855 3stack-dig ditto with SPDIF
856 laptop 3-jack with hp-jack automute
857 laptop-dig ditto with SPDIF
Guillaume Munch99ccc562006-08-16 19:35:12 +0200858 auto auto-config reading BIOS (default)
Takashi Iwai9230d212006-03-13 13:49:49 +0100859
Tobin Davis93ed1502006-09-01 21:03:12 +0200860 STAC9200/9205/9220/9221/9254
861 ref Reference board
862 3stack D945 3stack
863 5stack D945 5stack + SPDIF
864
865 STAC9227/9228/9229/927x
866 ref Reference board
867 3stack D965 3stack
868 5stack D965 5stack + SPDIF
869
Guillaume Munch6d859062006-08-22 17:15:47 +0200870 STAC9872
871 vaio Setup for VAIO FE550G/SZ110
872 vaio-ar Setup for VAIO AR
Takashi Iwaidb064e52006-03-16 16:04:58 +0100873
Takashi Iwai62430082005-09-05 17:12:29 +0200874 If the default configuration doesn't work and one of the above
875 matches with your device, report it together with the PCI
876 subsystem ID (output of "lspci -nv") to ALSA BTS or alsa-devel
877 ML (see the section "Links and Addresses").
878
Takashi Iwaic74db862005-05-12 14:26:27 +0200879 Note 2: If you get click noises on output, try the module option
880 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
881 register value without FIFO size correction as the current
882 DMA pointer. position_fix=2 will make the driver to use
883 the position buffer instead of reading SD_LPIB register.
884 (Usually SD_LPLIB register is more accurate than the
885 position buffer.)
886
Takashi Iwai27346162006-01-12 18:28:44 +0100887 NB: If you get many "azx_get_response timeout" messages at
888 loading, it's likely a problem of interrupts (e.g. ACPI irq
889 routing). Try to boot with options like "pci=noacpi". Also, you
890 can try "single_cmd=1" module option. This will switch the
891 communication method between HDA controller and codecs to the
892 single immediate commands instead of CORB/RIRB. Basically, the
893 single command mode is provided only for BIOS, and you won't get
894 unsolicited events, too. But, at least, this works independently
895 from the irq. Remember this is a last resort, and should be
896 avoided as much as possible...
897
Takashi Iwaia4efc232005-11-17 17:24:26 +0100898 The power-management is supported.
899
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 Module snd-hdsp
901 ---------------
902
903 Module for RME Hammerfall DSP audio interface(s)
904
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100905 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906
907 Note: The firmware data can be automatically loaded via hotplug
908 when CONFIG_FW_LOADER is set. Otherwise, you need to load
909 the firmware via hdsploader utility included in alsa-tools
910 package.
911 The firmware data is found in alsa-firmware package.
912
913 Note: snd-page-alloc module does the job which snd-hammerfall-mem
914 module did formerly. It will allocate the buffers in advance
915 when any HDSP cards are found. To make the buffer
916 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +0200917 stage of boot sequence. See "Early Buffer Allocation"
918 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919
Takashi Iwai54704402005-06-03 11:27:00 +0200920 Module snd-hdspm
921 ----------------
922
923 Module for RME HDSP MADI board.
924
925 precise_ptr - Enable precise pointer, or disable.
926 line_outs_monitor - Send playback streams to analog outs by default.
927 enable_monitor - Enable Analog Out on Channel 63/64 by default.
928
929 See hdspm.txt for details.
930
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931 Module snd-ice1712
932 ------------------
933
934 Module for Envy24 (ICE1712) based PCI sound cards.
935 * MidiMan M Audio Delta 1010
936 * MidiMan M Audio Delta 1010LT
937 * MidiMan M Audio Delta DiO 2496
938 * MidiMan M Audio Delta 66
939 * MidiMan M Audio Delta 44
940 * MidiMan M Audio Delta 410
941 * MidiMan M Audio Audiophile 2496
942 * TerraTec EWS 88MT
943 * TerraTec EWS 88D
944 * TerraTec EWX 24/96
945 * TerraTec DMX 6Fire
Takashi Iwaic9bce912005-05-24 13:41:03 +0200946 * TerraTec Phase 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 * Hoontech SoundTrack DSP 24
948 * Hoontech SoundTrack DSP 24 Value
949 * Hoontech SoundTrack DSP 24 Media 7.1
Takashi Iwaic9bce912005-05-24 13:41:03 +0200950 * Event Electronics, EZ8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951 * Digigram VX442
Takashi Iwaic9bce912005-05-24 13:41:03 +0200952 * Lionstracs, Mediastaton
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953
954 model - Use the given board model, one of the following:
955 delta1010, dio2496, delta66, delta44, audiophile, delta410,
956 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
Takashi Iwaic9bce912005-05-24 13:41:03 +0200957 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
958 phase88, mediastation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 omni - Omni I/O support for MidiMan M-Audio Delta44/66
Matt LaPlantefa00e7e2006-11-30 04:55:36 +0100960 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transceiver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 in msec resolution, default value is 500 (0.5 sec)
962
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100963 This module supports multiple cards and autoprobe. Note: The consumer part
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 is not used with all Envy24 based cards (for example in the MidiMan Delta
965 serie).
966
Takashi Iwaic9bce912005-05-24 13:41:03 +0200967 Note: The supported board is detected by reading EEPROM or PCI
968 SSID (if EEPROM isn't available). You can override the
969 model by passing "model" module option in case that the
970 driver isn't configured properly or you want to try another
971 type for testing.
972
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 Module snd-ice1724
974 ------------------
975
Takashi Iwaic9bce912005-05-24 13:41:03 +0200976 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100977 * MidiMan M Audio Revolution 5.1
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 * MidiMan M Audio Revolution 7.1
979 * AMP Ltd AUDIO2000
Takashi Iwaic9bce912005-05-24 13:41:03 +0200980 * TerraTec Aureon 5.1 Sky
981 * TerraTec Aureon 7.1 Space
982 * TerraTec Aureon 7.1 Universe
983 * TerraTec Phase 22
984 * TerraTec Phase 28
985 * AudioTrak Prodigy 7.1
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100986 * AudioTrak Prodigy 7.1LT
Takashi Iwaic9bce912005-05-24 13:41:03 +0200987 * AudioTrak Prodigy 192
988 * Pontis MS300
989 * Albatron K8X800 Pro II
990 * Chaintech ZNF3-150
991 * Chaintech ZNF3-250
992 * Chaintech 9CJS
Takashi Iwai8cfbbac2005-05-27 12:10:40 +0200993 * Chaintech AV-710
Takashi Iwaic9bce912005-05-24 13:41:03 +0200994 * Shuttle SN25P
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995
996 model - Use the given board model, one of the following:
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +0100997 revo51, revo71, amp2000, prodigy71, prodigy71lt,
998 prodigy192, aureon51, aureon71, universe,
999 k8x800, phase22, phase28, ms300, av710
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001001 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002
Takashi Iwaic9bce912005-05-24 13:41:03 +02001003 Note: The supported board is detected by reading EEPROM or PCI
1004 SSID (if EEPROM isn't available). You can override the
1005 model by passing "model" module option in case that the
1006 driver isn't configured properly or you want to try another
1007 type for testing.
1008
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001009 Module snd-indigo
1010 -----------------
1011
1012 Module for Echoaudio Indigo
1013
1014 This module supports multiple cards.
1015 The driver requires the firmware loader support on kernel.
1016
1017 Module snd-indigodj
1018 -------------------
1019
1020 Module for Echoaudio Indigo DJ
1021
1022 This module supports multiple cards.
1023 The driver requires the firmware loader support on kernel.
1024
1025 Module snd-indigoio
1026 -------------------
1027
1028 Module for Echoaudio Indigo IO
1029
1030 This module supports multiple cards.
1031 The driver requires the firmware loader support on kernel.
1032
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 Module snd-intel8x0
1034 -------------------
1035
1036 Module for AC'97 motherboards from Intel and compatibles.
1037 * Intel i810/810E, i815, i820, i830, i84x, MX440
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001038 ICH5, ICH6, ICH7, ESB2
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 * SiS 7012 (SiS 735)
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001040 * NVidia NForce, NForce2, NForce3, MCP04, CK804
1041 CK8, CK8S, MCP501
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 * AMD AMD768, AMD8111
1043 * ALi m5455
1044
1045 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1046 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001047 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 buggy_irq - Enable workaround for buggy interrupts on some
Takashi Iwaia06147d2005-09-08 19:54:17 +02001049 motherboards (default yes on nForce chips,
1050 otherwise off)
1051 buggy_semaphore - Enable workaround for hardwares with buggy
1052 semaphores (e.g. on some ASUS laptops)
1053 (default off)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001055 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056
1057 Note: the latest driver supports auto-detection of chip clock.
1058 if you still encounter too fast playback, specify the clock
1059 explicitly via the module option "ac97_clock=41194".
1060
1061 Joystick/MIDI ports are not supported by this driver. If your
1062 motherboard has these devices, use the ns558 or snd-mpu401
1063 modules, respectively.
1064
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 The power-management is supported.
1066
1067 Module snd-intel8x0m
1068 --------------------
1069
1070 Module for Intel ICH (i8x0) chipset MC97 modems.
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001071 * Intel i810/810E, i815, i820, i830, i84x, MX440
1072 ICH5, ICH6, ICH7
1073 * SiS 7013 (SiS 735)
1074 * NVidia NForce, NForce2, NForce2s, NForce3
1075 * AMD AMD8111
1076 * ALi m5455
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077
1078 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1079
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001080 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081
1082 Note: The default index value of this module is -2, i.e. the first
1083 slot is excluded.
1084
Takashi Iwaia4efc232005-11-17 17:24:26 +01001085 The power-management is supported.
1086
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 Module snd-interwave
1088 --------------------
1089
1090 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1091 and other sound cards based on AMD InterWave (tm) chip.
1092
1093 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1094 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1095 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1096 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
1097 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1098 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1099 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1100 effect - 1 = InterWave effects enable (default 0);
1101 requires 8 voices
1102
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001103 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104
1105 Module snd-interwave-stb
1106 ------------------------
1107
1108 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1109 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1110 circuit for extended control of bass, treble and master volume.
1111
1112 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1113 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1114 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1115 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1116 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
1117 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1118 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1119 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1120 effect - 1 = InterWave effects enable (default 0);
1121 requires 8 voices
1122
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001123 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001124
1125 Module snd-korg1212
1126 -------------------
1127
1128 Module for Korg 1212 IO PCI card
1129
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001130 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001132 Module snd-layla20
1133 ------------------
1134
1135 Module for Echoaudio Layla20
1136
1137 This module supports multiple cards.
1138 The driver requires the firmware loader support on kernel.
1139
1140 Module snd-layla24
1141 ------------------
1142
1143 Module for Echoaudio Layla24
1144
1145 This module supports multiple cards.
1146 The driver requires the firmware loader support on kernel.
1147
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148 Module snd-maestro3
1149 -------------------
1150
1151 Module for Allegro/Maestro3 chips
1152
1153 external_amp - enable external amp (enabled by default)
1154 amp_gpio - GPIO pin number for external amp (0-15) or
1155 -1 for default pin (8 for allegro, 1 for
1156 others)
1157
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001158 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159
1160 Note: the binding of amplifier is dependent on hardware.
1161 If there is no sound even though all channels are unmuted, try to
1162 specify other gpio connection via amp_gpio option.
1163 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1164 option.
1165
1166 The power-management is supported.
1167
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001168 Module snd-mia
1169 ---------------
1170
1171 Module for Echoaudio Mia
1172
1173 This module supports multiple cards.
1174 The driver requires the firmware loader support on kernel.
1175
Martin Langer1841f6132006-03-27 12:41:01 +02001176 Module snd-miro
1177 ---------------
1178
1179 Module for Miro soundcards: miroSOUND PCM 1 pro,
1180 miroSOUND PCM 12,
1181 miroSOUND PCM 20 Radio.
1182
1183 port - Port # (0x530,0x604,0xe80,0xf40)
1184 irq - IRQ # (5,7,9,10,11)
1185 dma1 - 1st dma # (0,1,3)
1186 dma2 - 2nd dma # (0,1)
1187 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1188 mpu_irq - MPU-401 irq # (5,7,9,10)
1189 fm_port - FM Port # (0x388)
1190 wss - enable WSS mode
1191 ide - enable onboard ide support
1192
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 Module snd-mixart
1194 -----------------
1195
1196 Module for Digigram miXart8 sound cards.
1197
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001198 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199 Note: One miXart8 board will be represented as 4 alsa cards.
1200 See MIXART.txt for details.
1201
1202 When the driver is compiled as a module and the hotplug firmware
1203 is supported, the firmware data is loaded via hotplug automatically.
1204 Install the necessary firmware files in alsa-firmware package.
1205 When no hotplug fw loader is available, you need to load the
1206 firmware via mixartloader utility in alsa-tools package.
1207
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001208 Module snd-mona
1209 ---------------
1210
1211 Module for Echoaudio Mona
1212
1213 This module supports multiple cards.
1214 The driver requires the firmware loader support on kernel.
1215
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 Module snd-mpu401
1217 -----------------
1218
1219 Module for MPU-401 UART devices.
1220
1221 port - port number or -1 (disable)
1222 irq - IRQ number or -1 (disable)
1223 pnp - PnP detection - 0 = disable, 1 = enable (default)
1224
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001225 This module supports multiple devices and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226
1227 Module snd-mtpav
1228 ----------------
1229
1230 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1231 port).
1232
1233 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1234 irq - IRQ # for MTPAV (7,5, default=7)
1235 hwports - number of supported hardware ports, default=8.
1236
1237 Module supports only 1 card. This module has no enable option.
1238
Matthias Koenig68ab8012006-07-27 16:59:23 +02001239 Module snd-mts64
1240 ----------------
1241
1242 Module for Ego Systems (ESI) Miditerminal 4140
1243
1244 This module supports multiple devices.
1245 Requires parport (CONFIG_PARPORT).
1246
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 Module snd-nm256
1248 ----------------
1249
1250 Module for NeoMagic NM256AV/ZX chips
1251
1252 playback_bufsize - max playback frame size in kB (4-128kB)
1253 capture_bufsize - max capture frame size in kB (4-128kB)
1254 force_ac97 - 0 or 1 (disabled by default)
1255 buffer_top - specify buffer top address
1256 use_cache - 0 or 1 (disabled by default)
1257 vaio_hack - alias buffer_top=0x25a800
1258 reset_workaround - enable AC97 RESET workaround for some laptops
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001259 reset_workaround2 - enable extended AC97 RESET workaround for some
1260 other laptops
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +02001262 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263
1264 The power-management is supported.
1265
1266 Note: on some notebooks the buffer address cannot be detected
1267 automatically, or causes hang-up during initialization.
Matt LaPlantefff92892006-10-03 22:47:42 +02001268 In such a case, specify the buffer top address explicitly via
1269 the buffer_top option.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 For example,
1271 Sony F250: buffer_top=0x25a800
1272 Sony F270: buffer_top=0x272800
1273 The driver supports only ac97 codec. It's possible to force
1274 to initialize/use ac97 although it's not detected. In such a
1275 case, use force_ac97=1 option - but *NO* guarantee whether it
1276 works!
1277
1278 Note: The NM256 chip can be linked internally with non-AC97
1279 codecs. This driver supports only the AC97 codec, and won't work
1280 with machines with other (most likely CS423x or OPL3SAx) chips,
1281 even though the device is detected in lspci. In such a case, try
1282 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
Takashi Iwai62430082005-09-05 17:12:29 +02001283 but some doesn't have ISA PnP. You'll need to specify isapnp=0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 and proper hardware parameters in the case without ISA PnP.
1285
1286 Note: some laptops need a workaround for AC97 RESET. For the
1287 known hardware like Dell Latitude LS and Sony PCG-F305, this
1288 workaround is enabled automatically. For other laptops with a
1289 hard freeze, you can try reset_workaround=1 option.
1290
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001291 Note: Dell Latitude CSx laptops have another problem regarding
1292 AC97 RESET. On these laptops, reset_workaround2 option is
1293 turned on as default. This option is worth to try if the
1294 previous reset_workaround option doesn't help.
1295
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 Note: This driver is really crappy. It's a porting from the
1297 OSS driver, which is a result of black-magic reverse engineering.
1298 The detection of codec will fail if the driver is loaded *after*
1299 X-server as described above. You might be able to force to load
1300 the module, but it may result in hang-up. Hence, make sure that
1301 you load this module *before* X if you encounter this kind of
1302 problem.
1303
1304 Module snd-opl3sa2
1305 ------------------
1306
1307 Module for Yamaha OPL3-SA2/SA3 sound cards.
1308
1309 port - control port # for OPL3-SA chip (0x370)
1310 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1311 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1312 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1313 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1314 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1315 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1316 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
1317 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1318
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001319 This module supports multiple cards and ISA PnP. It does not support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1321
1322 The power-management is supported.
1323
1324 Module snd-opti92x-ad1848
1325 -------------------------
1326
1327 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1328 Module works with OAK Mozart cards as well.
1329
1330 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1331 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1332 fm_port - port # for OPL3 device (0x388)
1333 irq - IRQ # for WSS chip (5,7,9,10,11)
1334 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1335 dma1 - first DMA # for WSS chip (0,1,3)
1336
1337 This module supports only one card, autoprobe and PnP.
1338
1339 Module snd-opti92x-cs4231
1340 -------------------------
1341
1342 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1343
1344 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1345 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1346 fm_port - port # for OPL3 device (0x388)
1347 irq - IRQ # for WSS chip (5,7,9,10,11)
1348 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1349 dma1 - first DMA # for WSS chip (0,1,3)
1350 dma2 - second DMA # for WSS chip (0,1,3)
1351
1352 This module supports only one card, autoprobe and PnP.
1353
1354 Module snd-opti93x
1355 ------------------
1356
1357 Module for sound cards based on OPTi 82c93x chips.
1358
1359 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1360 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1361 fm_port - port # for OPL3 device (0x388)
1362 irq - IRQ # for WSS chip (5,7,9,10,11)
1363 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1364 dma1 - first DMA # for WSS chip (0,1,3)
1365 dma2 - second DMA # for WSS chip (0,1,3)
1366
1367 This module supports only one card, autoprobe and PnP.
1368
Markus Bollingere12229b2005-12-06 13:55:26 +01001369 Module snd-pcxhr
1370 ----------------
1371
1372 Module for Digigram PCXHR boards
1373
1374 This module supports multiple cards.
1375
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 Module snd-powermac (on ppc only)
1377 ---------------------------------
1378
1379 Module for PowerMac, iMac and iBook on-board soundchips
1380
1381 enable_beep - enable beep using PCM (enabled as default)
1382
1383 Module supports autoprobe a chip.
1384
1385 Note: the driver may have problems regarding endianess.
1386
1387 The power-management is supported.
1388
Takashi Iwai2c484df2005-06-30 18:54:04 +02001389 Module snd-pxa2xx-ac97 (on arm only)
1390 ------------------------------------
1391
1392 Module for AC97 driver for the Intel PXA2xx chip
1393
1394 For ARM architecture only.
1395
Takashi Iwaia4efc232005-11-17 17:24:26 +01001396 The power-management is supported.
1397
Peter Gruber109a9632006-03-27 13:10:28 +02001398 Module snd-riptide
1399 ------------------
1400
1401 Module for Conexant Riptide chip
1402
1403 joystick_port - Joystick port # (default: 0x200)
1404 mpu_port - MPU401 port # (default: 0x330)
1405 opl3_port - OPL3 port # (default: 0x388)
1406
1407 This module supports multiple cards.
1408 The driver requires the firmware loader support on kernel.
1409 You need to install the firmware file "riptide.hex" to the standard
1410 firmware path (e.g. /lib/firmware).
1411
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 Module snd-rme32
1413 ----------------
1414
1415 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1416 Prodif96 and Prodif Gold) sound cards.
1417
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001418 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419
1420 Module snd-rme96
1421 ----------------
1422
1423 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1424
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001425 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426
1427 Module snd-rme9652
1428 ------------------
1429
1430 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1431
1432 precise_ptr - Enable precise pointer (doesn't work reliably).
1433 (default = 0)
1434
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001435 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436
1437 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1438 module did formerly. It will allocate the buffers in advance
1439 when any RME9652 cards are found. To make the buffer
1440 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +02001441 stage of boot sequence. See "Early Buffer Allocation"
1442 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001443
1444 Module snd-sa11xx-uda1341 (on arm only)
1445 ---------------------------------------
1446
1447 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1448
1449 Module supports only one card.
1450 Module has no enable and index options.
1451
Takashi Iwaia4efc232005-11-17 17:24:26 +01001452 The power-management is supported.
1453
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 Module snd-sb8
1455 --------------
1456
1457 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1458 SoundBlaster 2.0,
1459 SoundBlaster Pro
1460
1461 port - port # for SB DSP chip (0x220,0x240,0x260)
1462 irq - IRQ # for SB DSP chip (5,7,9,10)
1463 dma8 - DMA # for SB DSP chip (1,3)
1464
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001465 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466
Takashi Iwaia4efc232005-11-17 17:24:26 +01001467 The power-management is supported.
1468
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 Module snd-sb16 and snd-sbawe
1470 -----------------------------
1471
1472 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1473 SoundBlaster AWE 32 (PnP),
1474 SoundBlaster AWE 64 PnP
1475
1476 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1477 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1478 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1479 (snd-sbawe module only)
1480 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1481 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1482 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
1483 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1484 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1485 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1486
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001487 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488
1489 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1490 disable 16bit DMA with dma16 = -1 module parameter.
1491 Also, all Sound Blaster 16 type cards can operate in 16-bit
1492 half duplex mode through 8-bit DMA channel by disabling their
1493 16-bit DMA channel.
1494
Takashi Iwaia4efc232005-11-17 17:24:26 +01001495 The power-management is supported.
1496
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497 Module snd-sgalaxy
1498 ------------------
1499
1500 Module for Aztech Sound Galaxy sound card.
1501
1502 sbport - Port # for SB16 interface (0x220,0x240)
1503 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1504 irq - IRQ # (7,9,10,11)
1505 dma1 - DMA #
1506
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001507 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508
Takashi Iwaia4efc232005-11-17 17:24:26 +01001509 The power-management is supported.
1510
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511 Module snd-sscape
1512 -----------------
1513
1514 Module for ENSONIQ SoundScape PnP cards.
1515
1516 port - Port # (PnP setup)
1517 irq - IRQ # (PnP setup)
1518 mpu_irq - MPU-401 IRQ # (PnP setup)
1519 dma - DMA # (PnP setup)
1520
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001521 This module supports multiple cards. ISA PnP must be enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 You need sscape_ctl tool in alsa-tools package for loading
1523 the microcode.
1524
1525 Module snd-sun-amd7930 (on sparc only)
1526 --------------------------------------
1527
1528 Module for AMD7930 sound chips found on Sparcs.
1529
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001530 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531
1532 Module snd-sun-cs4231 (on sparc only)
1533 -------------------------------------
1534
1535 Module for CS4231 sound chips found on Sparcs.
1536
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001537 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001539 Module snd-sun-dbri (on sparc only)
1540 -----------------------------------
1541
1542 Module for DBRI sound chips found on Sparcs.
1543
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001544 This module supports multiple cards.
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001545
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546 Module snd-wavefront
1547 --------------------
1548
1549 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1550
1551 cs4232_pcm_port - Port # for CS4232 PCM interface.
1552 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1553 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1554 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
1555 use_cs4232_midi - Use CS4232 MPU-401 interface
1556 (inaccessibly located inside your computer)
1557 ics2115_port - Port # for ICS2115
1558 ics2115_irq - IRQ # for ICS2115
1559 fm_port - FM OPL-3 Port #
1560 dma1 - DMA1 # for CS4232 PCM interface.
1561 dma2 - DMA2 # for CS4232 PCM interface.
1562 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1563
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001564 This module supports multiple cards and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565
1566 Module snd-sonicvibes
1567 ---------------------
1568
1569 Module for S3 SonicVibes PCI sound cards.
1570 * PINE Schubert 32 PCI
1571
1572 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1573 - SoundCard must have onboard SRAM for this.
1574 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1575
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001576 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001577
1578 Module snd-serial-u16550
1579 ------------------------
1580
1581 Module for UART16550A serial MIDI ports.
1582
1583 port - port # for UART16550A chip
1584 irq - IRQ # for UART16550A chip, -1 = poll mode
1585 speed - speed in bauds (9600,19200,38400,57600,115200)
1586 38400 = default
1587 base - base for divisor in bauds (57600,115200,230400,460800)
1588 115200 = default
1589 outs - number of MIDI ports in a serial port (1-4)
1590 1 = default
1591 adaptor - Type of adaptor.
1592 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1593 3 = MS-124W M/B, 4 = Generic
1594
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001595 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596 thus the main port must be specified!!! Other options are optional.
1597
1598 Module snd-trident
1599 ------------------
1600
1601 Module for Trident 4DWave DX/NX sound cards.
1602 * Best Union Miss Melody 4DWave PCI
1603 * HIS 4DWave PCI
1604 * Warpspeed ONSpeed 4DWave PCI
1605 * AzTech PCI 64-Q3D
1606 * Addonics SV 750
1607 * CHIC True Sound 4Dwave
1608 * Shark Predator4D-PCI
1609 * Jaton SonicWave 4D
1610
1611 pcm_channels - max channels (voices) reserved for PCM
1612 wavetable_size - max wavetable size in kB (4-?kb)
1613
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001614 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615
1616 The power-management is supported.
1617
1618 Module snd-usb-audio
1619 --------------------
1620
1621 Module for USB audio and USB MIDI devices.
1622
1623 vid - Vendor ID for the device (optional)
1624 pid - Product ID for the device (optional)
Thibault LE MEURe3113342006-03-14 11:44:53 +01001625 device_setup - Device specific magic number (optional)
1626 - Influence depends on the device
1627 - Default: 0x0000
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001629 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001630
1631 Module snd-usb-usx2y
1632 --------------------
1633
1634 Module for Tascam USB US-122, US-224 and US-428 devices.
1635
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001636 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637
1638 Note: you need to load the firmware via usx2yloader utility included
1639 in alsa-tools and alsa-firmware packages.
1640
1641 Module snd-via82xx
1642 ------------------
1643
1644 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001645 8233A, 8233C, 8235, 8237 (south) bridge.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646
1647 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1648 [VIA686A/686B only]
1649 joystick - Enable joystick (default off) [VIA686A/686B only]
1650 ac97_clock - AC'97 codec clock base (default 48000Hz)
1651 dxs_support - support DXS channels,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001652 0 = auto (default), 1 = enable, 2 = disable,
1653 3 = 48k only, 4 = no VRA, 5 = enable any sample
1654 rate and different sample rates on different
1655 channels
1656 [VIA8233/C, 8235, 8237 only]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001657 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001658 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001659
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001660 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661
1662 Note: on some SMP motherboards like MSI 694D the interrupts might
1663 not be generated properly. In such a case, please try to
1664 set the SMP (or MPS) version on BIOS to 1.1 instead of
1665 default value 1.4. Then the interrupt number will be
1666 assigned under 15. You might also upgrade your BIOS.
1667
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001668 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 channels as the first PCM. On these channels, up to 4
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001670 streams can be played at the same time, and the controller
1671 can perform sample rate conversion with separate rates for
1672 each channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 As default (dxs_support = 0), 48k fixed rate is chosen
1674 except for the known devices since the output is often
1675 noisy except for 48k on some mother boards due to the
1676 bug of BIOS.
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001677 Please try once dxs_support=5 and if it works on other
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1679 know the PCI subsystem vendor/device id's (output of
1680 "lspci -nv").
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001681 If dxs_support=5 does not work, try dxs_support=4; if it
1682 doesn't work too, try dxs_support=1. (dxs_support=1 is
Takashi Iwai62430082005-09-05 17:12:29 +02001683 usually for old motherboards. The correct implemented
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001684 board should work with 4 or 5.) If it still doesn't
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 work and the default setting is ok, dxs_support=3 is the
1686 right choice. If the default setting doesn't work at all,
1687 try dxs_support=2 to disable the DXS channels.
1688 In any cases, please let us know the result and the
Takashi Iwai62430082005-09-05 17:12:29 +02001689 subsystem vendor/device ids. See "Links and Addresses"
1690 below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691
1692 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Takashi Iwai62430082005-09-05 17:12:29 +02001693 additionally. The mpu_port option is for VIA686 chips only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694
Takashi Iwaia4efc232005-11-17 17:24:26 +01001695 The power-management is supported.
1696
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 Module snd-via82xx-modem
1698 ------------------------
1699
1700 Module for VIA82xx AC97 modem
1701
1702 ac97_clock - AC'97 codec clock base (default 48000Hz)
1703
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001704 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705
1706 Note: The default index value of this module is -2, i.e. the first
1707 slot is excluded.
1708
Takashi Iwaia4efc232005-11-17 17:24:26 +01001709 The power-management is supported.
1710
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711 Module snd-virmidi
1712 ------------------
1713
1714 Module for virtual rawmidi devices.
1715 This module creates virtual rawmidi devices which communicate
1716 to the corresponding ALSA sequencer ports.
1717
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001718 midi_devs - MIDI devices # (1-4, default=4)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001720 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721
1722 Module snd-vx222
1723 ----------------
1724
1725 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1726
1727 mic - Enable Microphone on V222 Mic (NYI)
1728 ibl - Capture IBL size. (default = 0, minimum size)
1729
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001730 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731
1732 When the driver is compiled as a module and the hotplug firmware
1733 is supported, the firmware data is loaded via hotplug automatically.
1734 Install the necessary firmware files in alsa-firmware package.
1735 When no hotplug fw loader is available, you need to load the
1736 firmware via vxloader utility in alsa-tools package. To invoke
1737 vxloader automatically, add the following to /etc/modprobe.conf
1738
1739 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1740
1741 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1742 /etc/modules.conf, instead.)
1743 IBL size defines the interrupts period for PCM. The smaller size
1744 gives smaller latency but leads to more CPU consumption, too.
1745 The size is usually aligned to 126. As default (=0), the smallest
1746 size is chosen. The possible IBL values can be found in
1747 /proc/asound/cardX/vx-status proc file.
1748
Takashi Iwaia4efc232005-11-17 17:24:26 +01001749 The power-management is supported.
1750
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 Module snd-vxpocket
1752 -------------------
1753
Takashi Iwai6d00a312005-06-30 13:40:51 +02001754 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755
1756 ibl - Capture IBL size. (default = 0, minimum size)
1757
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001758 This module supports multiple cards. The module is compiled only when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 PCMCIA is supported on kernel.
1760
Takashi Iwai62430082005-09-05 17:12:29 +02001761 With the older 2.6.x kernel, to activate the driver via the card
1762 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1763 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1764 longer require a config file.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765
1766 When the driver is compiled as a module and the hotplug firmware
1767 is supported, the firmware data is loaded via hotplug automatically.
1768 Install the necessary firmware files in alsa-firmware package.
1769 When no hotplug fw loader is available, you need to load the
1770 firmware via vxloader utility in alsa-tools package.
1771
1772 About capture IBL, see the description of snd-vx222 module.
1773
Takashi Iwaied7cbe32006-05-11 11:30:10 +02001774 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
Takashi Iwai62430082005-09-05 17:12:29 +02001775 ALSA 1.0.10.
1776
Takashi Iwaia4efc232005-11-17 17:24:26 +01001777 The power-management is supported.
1778
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 Module snd-ymfpci
1780 -----------------
1781
1782 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1783
1784 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1785 1 (auto-detect for YMF744/754 only)
1786 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1787 1 (auto-detect for YMF744/754 only)
1788 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1789 1 (auto-detect)
1790 rear_switch - enable shared rear/line-in switch (bool)
1791
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001792 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793
1794 The power-management is supported.
1795
1796 Module snd-pdaudiocf
1797 --------------------
1798
1799 Module for Sound Core PDAudioCF sound card.
1800
Takashi Iwaia4efc232005-11-17 17:24:26 +01001801 The power-management is supported.
1802
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803
Takashi Iwai62430082005-09-05 17:12:29 +02001804AC97 Quirk Option
1805=================
1806
1807The ac97_quirk option is used to enable/override the workaround for
1808specific devices on drivers for on-board AC'97 controllers like
1809snd-intel8x0. Some hardware have swapped output pins between Master
1810and Headphone, or Surround (thanks to confusion of AC'97
1811specifications from version to version :-)
1812
1813The driver provides the auto-detection of known problematic devices,
1814but some might be unknown or wrongly detected. In such a case, pass
1815the proper value with this option.
1816
1817The following strings are accepted:
1818 - default Don't override the default setting
Takashi Iwai10e4097f2005-11-17 11:04:55 +01001819 - none Disable the quirk
Takashi Iwai62430082005-09-05 17:12:29 +02001820 - hp_only Bind Master and Headphone controls as a single control
1821 - swap_hp Swap headphone and master controls
1822 - swap_surround Swap master and surround controls
1823 - ad_sharing For AD1985, turn on OMS bit and use headphone
1824 - alc_jack For ALC65x, turn on the jack sense mode
1825 - inv_eapd Inverted EAPD implementation
1826 - mute_led Bind EAPD bit for turning on/off mute LED
1827
1828For backward compatibility, the corresponding integer value -1, 0,
1829... are accepted, too.
1830
1831For example, if "Master" volume control has no effect on your device
1832but only "Headphone" does, pass ac97_quirk=hp_only module option.
1833
1834
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835Configuring Non-ISAPNP Cards
1836============================
1837
1838When the kernel is configured with ISA-PnP support, the modules
1839supporting the isapnp cards will have module options "isapnp".
1840If this option is set, *only* the ISA-PnP devices will be probed.
1841For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
1842together with the proper i/o and irq configuration.
1843
1844When the kernel is configured without ISA-PnP support, isapnp option
1845will be not built in.
1846
1847
1848Module Autoloading Support
1849==========================
1850
1851The ALSA drivers can be loaded automatically on demand by defining
1852module aliases. The string 'snd-card-%1' is requested for ALSA native
1853devices where %i is sound card number from zero to seven.
1854
1855To auto-load an ALSA driver for OSS services, define the string
1856'sound-slot-%i' where %i means the slot number for OSS, which
1857corresponds to the card index of ALSA. Usually, define this
Tobias Klauserd533f672005-09-10 00:26:46 -07001858as the same card module.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859
1860An example configuration for a single emu10k1 card is like below:
1861----- /etc/modprobe.conf
1862alias snd-card-0 snd-emu10k1
1863alias sound-slot-0 snd-emu10k1
1864----- /etc/modprobe.conf
1865
1866The available number of auto-loaded sound cards depends on the module
1867option "cards_limit" of snd module. As default it's set to 1.
1868To enable the auto-loading of multiple cards, specify the number of
1869sound cards in that option.
1870
1871When multiple cards are available, it'd better to specify the index
1872number for each card via module option, too, so that the order of
1873cards is kept consistent.
1874
1875An example configuration for two sound cards is like below:
1876
1877----- /etc/modprobe.conf
1878# ALSA portion
1879options snd cards_limit=2
1880alias snd-card-0 snd-interwave
1881alias snd-card-1 snd-ens1371
1882options snd-interwave index=0
1883options snd-ens1371 index=1
1884# OSS/Free portion
1885alias sound-slot-0 snd-interwave
1886alias sound-slot-1 snd-ens1371
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02001887----- /etc/modprobe.conf
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888
1889In this example, the interwave card is always loaded as the first card
1890(index 0) and ens1371 as the second (index 1).
1891
1892
1893ALSA PCM devices to OSS devices mapping
1894=======================================
1895
1896/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
1897/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
1898/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
1899/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
1900/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
1901/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
1902/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
1903/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
1904/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
1905
1906The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
1907sound card number and second means device number. The ALSA devices
1908have either 'c' or 'p' suffix indicating the direction, capture and
1909playback, respectively.
1910
1911Please note that the device mapping above may be varied via the module
1912options of snd-pcm-oss module.
1913
1914
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915Proc interfaces (/proc/asound)
1916==============================
1917
1918/proc/asound/card#/pcm#[cp]/oss
1919-------------------------------
1920 String "erase" - erase all additional informations about OSS applications
1921 String "<app_name> <fragments> <fragment_size> [<options>]"
1922
1923 <app_name> - name of application with (higher priority) or without path
1924 <fragments> - number of fragments or zero if auto
1925 <fragment_size> - size of fragment in bytes or zero if auto
1926 <options> - optional parameters
1927 - disable the application tries to open a pcm device for
1928 this channel but does not want to use it.
1929 (Cause a bug or mmap needs)
1930 It's good for Quake etc...
1931 - direct don't use plugins
1932 - block force block mode (rvplayer)
1933 - non-block force non-block mode
1934 - whole-frag write only whole fragments (optimization affecting
1935 playback only)
1936 - no-silence do not fill silence ahead to avoid clicks
Takashi Iwai10f69f92005-09-08 13:48:34 +02001937 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
1938 instead of filled blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939
1940 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
1941 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
1942 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
1943
1944
Takashi Iwaib6a96912005-05-30 18:27:03 +02001945Early Buffer Allocation
1946=======================
1947
1948Some drivers (e.g. hdsp) require the large contiguous buffers, and
1949sometimes it's too late to find such spaces when the driver module is
1950actually loaded due to memory fragmentation. You can pre-allocate the
1951PCM buffers by loading snd-page-alloc module and write commands to its
1952proc file in prior, for example, in the early boot stage like
1953/etc/init.d/*.local scripts.
1954
1955Reading the proc file /proc/drivers/snd-page-alloc shows the current
1956usage of page allocation. In writing, you can send the following
1957commands to the snd-page-alloc driver:
1958
1959 - add VENDOR DEVICE MASK SIZE BUFFERS
1960
1961 VENDOR and DEVICE are PCI vendor and device IDs. They take
1962 integer numbers (0x prefix is needed for the hex).
1963 MASK is the PCI DMA mask. Pass 0 if not restricted.
1964 SIZE is the size of each buffer to allocate. You can pass
1965 k and m suffix for KB and MB. The max number is 16MB.
1966 BUFFERS is the number of buffers to allocate. It must be greater
1967 than 0. The max number is 4.
1968
1969 - erase
1970
1971 This will erase the all pre-allocated buffers which are not in
1972 use.
1973
1974
Takashi Iwai62430082005-09-05 17:12:29 +02001975Links and Addresses
1976===================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977
1978 ALSA project homepage
1979 http://www.alsa-project.org
1980
Takashi Iwai62430082005-09-05 17:12:29 +02001981 ALSA Bug Tracking System
1982 https://bugtrack.alsa-project.org/bugs/
1983
1984 ALSA Developers ML
1985 mailto:alsa-devel@lists.sourceforge.net