blob: cc8a701871998c7076d7380f6645e148945891cb [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
516 Module snd-ens1371
517 ------------------
518
519 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
520 * SoundBlaster PCI 64
521 * SoundBlaster PCI 128
522 * SoundBlaster Vibra PCI
523
524 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
525 0 = disable (default), 1 = auto-detect
526
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100527 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
529 Module snd-es968
530 ----------------
531
532 Module for sound cards based on ESS ES968 chip (PnP only).
533
534 port - port # for ES968 (SB8) chip (PnP setup)
535 irq - IRQ # for ES968 (SB8) chip (PnP setup)
536 dma1 - DMA # for ES968 (SB8) chip (PnP setup)
537
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100538 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
Takashi Iwaia4efc232005-11-17 17:24:26 +0100540 The power-management is supported.
541
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 Module snd-es1688
543 -----------------
544
545 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
546
547 port - port # for ES-1688 chip (0x220,0x240,0x260)
548 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
549 irq - IRQ # for ES-1688 chip (5,7,9,10)
550 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
551 dma8 - DMA # for ES-1688 chip (0,1,3)
552
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100553 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
555 Module snd-es18xx
556 -----------------
557
558 Module for ESS AudioDrive ES-18xx sound cards.
559
560 port - port # for ES-18xx chip (0x220,0x240,0x260)
561 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
562 fm_port - port # for FM (optional, not used)
563 irq - IRQ # for ES-18xx chip (5,7,9,10)
564 dma1 - first DMA # for ES-18xx chip (0,1,3)
565 dma2 - first DMA # for ES-18xx chip (0,1,3)
566 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
567
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100568 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
569 port if native ISA PnP routines are not used).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570 When dma2 is equal with dma1, the driver works as half-duplex.
571
572 The power-management is supported.
573
574 Module snd-es1938
575 -----------------
576
577 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
578
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100579 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
Takashi Iwaia4efc232005-11-17 17:24:26 +0100581 The power-management is supported.
582
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 Module snd-es1968
584 -----------------
585
586 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
587
588 total_bufsize - total buffer size in kB (1-4096kB)
589 pcm_substreams_p - playback channels (1-8, default=2)
590 pcm_substreams_c - capture channels (1-8, default=0)
591 clock - clock (0 = auto-detection)
592 use_pm - support the power-management (0 = off, 1 = on,
593 2 = auto (default))
594 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
595 joystick - enable joystick (default off)
596
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100597 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598
599 The power-management is supported.
600
601 Module snd-fm801
602 ----------------
603
604 Module for ForteMedia FM801 based PCI sound cards.
605
606 tea575x_tuner - Enable TEA575x tuner
607 - 1 = MediaForte 256-PCS
608 - 2 = MediaForte 256-PCPR
609 - 3 = MediaForte 64-PCR
610 - High 16-bits are video (radio) device number + 1
611 - example: 0x10002 (MediaForte 256-PCPR, device 1)
612
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100613 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614
Takashi Iwaia4efc232005-11-17 17:24:26 +0100615 The power-management is supported.
616
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 Module snd-gusclassic
618 ---------------------
619
620 Module for Gravis UltraSound Classic sound card.
621
622 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
623 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
624 dma1 - DMA # for GF1 chip (1,3,5,6,7)
625 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
626 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
627 voices - GF1 voices limit (14-32)
628 pcm_voices - reserved PCM voices
629
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100630 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
632 Module snd-gusextreme
633 ---------------------
634
635 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
636
637 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
638 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
639 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
640 irq - IRQ # for ES-1688 chip (5,7,9,10)
641 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
642 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
643 dma8 - DMA # for ES-1688 chip (0,1,3)
644 dma1 - DMA # for GF1 chip (1,3,5,6,7)
645 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
646 voices - GF1 voices limit (14-32)
647 pcm_voices - reserved PCM voices
648
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100649 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
651 Module snd-gusmax
652 -----------------
653
654 Module for Gravis UltraSound MAX sound card.
655
656 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
657 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
658 dma1 - DMA # for GF1 chip (1,3,5,6,7)
659 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
660 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
661 voices - GF1 voices limit (14-32)
662 pcm_voices - reserved PCM voices
663
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100664 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665
666 Module snd-hda-intel
667 --------------------
668
Takashi Iwaifc20a562005-05-12 15:00:41 +0200669 Module for Intel HD Audio (ICH6, ICH6M, ICH7), ATI SB450,
670 VIA VT8251/VT8237A
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671
672 model - force the model name
Takashi Iwai62430082005-09-05 17:12:29 +0200673 position_fix - Fix DMA pointer (0 = auto, 1 = none, 2 = POSBUF, 3 = FIFO size)
Takashi Iwai27346162006-01-12 18:28:44 +0100674 single_cmd - Use single immediate commands to communicate with
675 codecs (for debugging only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200677 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678
679 Each codec may have a model table for different configurations.
680 If your machine isn't listed there, the default (usually minimal)
681 configuration is set up. You can pass "model=<name>" option to
682 specify a certain model in such a case. There are different
683 models depending on the codec chip.
684
685 Model name Description
686 ---------- -----------
687 ALC880
688 3stack 3-jack in back and a headphone out
689 3stack-digout 3-jack in back, a HP out and a SPDIF out
690 5stack 5-jack in back, 2-jack in front
691 5stack-digout 5-jack in back, 2-jack in front, a SPDIF out
Takashi Iwaib6482d42005-06-27 15:32:43 +0200692 6stack 6-jack in back, 2-jack in front
693 6stack-digout 6-jack with a SPDIF out
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694 w810 3-jack
Takashi Iwaidfc0ff62005-05-12 14:31:49 +0200695 z71v 3-jack (HP shared SPDIF)
Takashi Iwaie9edcee2005-06-13 14:16:38 +0200696 asus 3-jack
697 uniwill 3-jack
698 F1734 2-jack
Takashi Iwaib6482d42005-06-27 15:32:43 +0200699 test for testing/debugging purpose, almost all controls can be
700 adjusted. Appearing only when compiled with
701 $CONFIG_SND_DEBUG=y
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702
Takashi Iwai21be3d12005-09-16 19:18:56 +0200703 ALC260
704 hp HP machines
705 fujitsu Fujitsu S7020
706
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 CMI9880
708 minimal 3-jack in back
709 min_fp 3-jack in back, 2-jack in front
710 full 6-jack in back, 2-jack in front
711 full_dig 6-jack in back, 2-jack in front, SPDIF I/O
712 allout 5-jack in back, 2-jack in front, SPDIF out
Takashi Iwaie9edcee2005-06-13 14:16:38 +0200713 auto auto-config reading BIOS (default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
Takashi Iwai62430082005-09-05 17:12:29 +0200715 If the default configuration doesn't work and one of the above
716 matches with your device, report it together with the PCI
717 subsystem ID (output of "lspci -nv") to ALSA BTS or alsa-devel
718 ML (see the section "Links and Addresses").
719
Takashi Iwaic74db862005-05-12 14:26:27 +0200720 Note 2: If you get click noises on output, try the module option
721 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
722 register value without FIFO size correction as the current
723 DMA pointer. position_fix=2 will make the driver to use
724 the position buffer instead of reading SD_LPIB register.
725 (Usually SD_LPLIB register is more accurate than the
726 position buffer.)
727
Takashi Iwai27346162006-01-12 18:28:44 +0100728 NB: If you get many "azx_get_response timeout" messages at
729 loading, it's likely a problem of interrupts (e.g. ACPI irq
730 routing). Try to boot with options like "pci=noacpi". Also, you
731 can try "single_cmd=1" module option. This will switch the
732 communication method between HDA controller and codecs to the
733 single immediate commands instead of CORB/RIRB. Basically, the
734 single command mode is provided only for BIOS, and you won't get
735 unsolicited events, too. But, at least, this works independently
736 from the irq. Remember this is a last resort, and should be
737 avoided as much as possible...
738
Takashi Iwaia4efc232005-11-17 17:24:26 +0100739 The power-management is supported.
740
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 Module snd-hdsp
742 ---------------
743
744 Module for RME Hammerfall DSP audio interface(s)
745
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100746 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747
748 Note: The firmware data can be automatically loaded via hotplug
749 when CONFIG_FW_LOADER is set. Otherwise, you need to load
750 the firmware via hdsploader utility included in alsa-tools
751 package.
752 The firmware data is found in alsa-firmware package.
753
754 Note: snd-page-alloc module does the job which snd-hammerfall-mem
755 module did formerly. It will allocate the buffers in advance
756 when any HDSP cards are found. To make the buffer
757 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +0200758 stage of boot sequence. See "Early Buffer Allocation"
759 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760
Takashi Iwai54704402005-06-03 11:27:00 +0200761 Module snd-hdspm
762 ----------------
763
764 Module for RME HDSP MADI board.
765
766 precise_ptr - Enable precise pointer, or disable.
767 line_outs_monitor - Send playback streams to analog outs by default.
768 enable_monitor - Enable Analog Out on Channel 63/64 by default.
769
770 See hdspm.txt for details.
771
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 Module snd-ice1712
773 ------------------
774
775 Module for Envy24 (ICE1712) based PCI sound cards.
776 * MidiMan M Audio Delta 1010
777 * MidiMan M Audio Delta 1010LT
778 * MidiMan M Audio Delta DiO 2496
779 * MidiMan M Audio Delta 66
780 * MidiMan M Audio Delta 44
781 * MidiMan M Audio Delta 410
782 * MidiMan M Audio Audiophile 2496
783 * TerraTec EWS 88MT
784 * TerraTec EWS 88D
785 * TerraTec EWX 24/96
786 * TerraTec DMX 6Fire
Takashi Iwaic9bce912005-05-24 13:41:03 +0200787 * TerraTec Phase 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 * Hoontech SoundTrack DSP 24
789 * Hoontech SoundTrack DSP 24 Value
790 * Hoontech SoundTrack DSP 24 Media 7.1
Takashi Iwaic9bce912005-05-24 13:41:03 +0200791 * Event Electronics, EZ8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 * Digigram VX442
Takashi Iwaic9bce912005-05-24 13:41:03 +0200793 * Lionstracs, Mediastaton
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794
795 model - Use the given board model, one of the following:
796 delta1010, dio2496, delta66, delta44, audiophile, delta410,
797 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
Takashi Iwaic9bce912005-05-24 13:41:03 +0200798 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
799 phase88, mediastation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 omni - Omni I/O support for MidiMan M-Audio Delta44/66
801 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transciever)
802 in msec resolution, default value is 500 (0.5 sec)
803
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100804 This module supports multiple cards and autoprobe. Note: The consumer part
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 is not used with all Envy24 based cards (for example in the MidiMan Delta
806 serie).
807
Takashi Iwaic9bce912005-05-24 13:41:03 +0200808 Note: The supported board is detected by reading EEPROM or PCI
809 SSID (if EEPROM isn't available). You can override the
810 model by passing "model" module option in case that the
811 driver isn't configured properly or you want to try another
812 type for testing.
813
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 Module snd-ice1724
815 ------------------
816
Takashi Iwaic9bce912005-05-24 13:41:03 +0200817 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 * MidiMan M Audio Revolution 7.1
819 * AMP Ltd AUDIO2000
Takashi Iwaic9bce912005-05-24 13:41:03 +0200820 * TerraTec Aureon 5.1 Sky
821 * TerraTec Aureon 7.1 Space
822 * TerraTec Aureon 7.1 Universe
823 * TerraTec Phase 22
824 * TerraTec Phase 28
825 * AudioTrak Prodigy 7.1
826 * AudioTrak Prodigy 192
827 * Pontis MS300
828 * Albatron K8X800 Pro II
829 * Chaintech ZNF3-150
830 * Chaintech ZNF3-250
831 * Chaintech 9CJS
Takashi Iwai8cfbbac2005-05-27 12:10:40 +0200832 * Chaintech AV-710
Takashi Iwaic9bce912005-05-24 13:41:03 +0200833 * Shuttle SN25P
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
835 model - Use the given board model, one of the following:
Takashi Iwaic9bce912005-05-24 13:41:03 +0200836 revo71, amp2000, prodigy71, prodigy192, aureon51,
Takashi Iwai8cfbbac2005-05-27 12:10:40 +0200837 aureon71, universe, k8x800, phase22, phase28, ms300,
838 av710
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100840 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841
Takashi Iwaic9bce912005-05-24 13:41:03 +0200842 Note: The supported board is detected by reading EEPROM or PCI
843 SSID (if EEPROM isn't available). You can override the
844 model by passing "model" module option in case that the
845 driver isn't configured properly or you want to try another
846 type for testing.
847
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 Module snd-intel8x0
849 -------------------
850
851 Module for AC'97 motherboards from Intel and compatibles.
852 * Intel i810/810E, i815, i820, i830, i84x, MX440
Takashi Iwai89ac9c22006-01-24 10:36:57 +0100853 ICH5, ICH6, ICH7, ESB2
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 * SiS 7012 (SiS 735)
Takashi Iwai89ac9c22006-01-24 10:36:57 +0100855 * NVidia NForce, NForce2, NForce3, MCP04, CK804
856 CK8, CK8S, MCP501
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 * AMD AMD768, AMD8111
858 * ALi m5455
859
860 ac97_clock - AC'97 codec clock base (0 = auto-detect)
861 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200862 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 buggy_irq - Enable workaround for buggy interrupts on some
Takashi Iwaia06147d2005-09-08 19:54:17 +0200864 motherboards (default yes on nForce chips,
865 otherwise off)
866 buggy_semaphore - Enable workaround for hardwares with buggy
867 semaphores (e.g. on some ASUS laptops)
868 (default off)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200870 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871
872 Note: the latest driver supports auto-detection of chip clock.
873 if you still encounter too fast playback, specify the clock
874 explicitly via the module option "ac97_clock=41194".
875
876 Joystick/MIDI ports are not supported by this driver. If your
877 motherboard has these devices, use the ns558 or snd-mpu401
878 modules, respectively.
879
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 The power-management is supported.
881
882 Module snd-intel8x0m
883 --------------------
884
885 Module for Intel ICH (i8x0) chipset MC97 modems.
Takashi Iwai89ac9c22006-01-24 10:36:57 +0100886 * Intel i810/810E, i815, i820, i830, i84x, MX440
887 ICH5, ICH6, ICH7
888 * SiS 7013 (SiS 735)
889 * NVidia NForce, NForce2, NForce2s, NForce3
890 * AMD AMD8111
891 * ALi m5455
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892
893 ac97_clock - AC'97 codec clock base (0 = auto-detect)
894
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200895 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700896
897 Note: The default index value of this module is -2, i.e. the first
898 slot is excluded.
899
Takashi Iwaia4efc232005-11-17 17:24:26 +0100900 The power-management is supported.
901
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 Module snd-interwave
903 --------------------
904
905 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
906 and other sound cards based on AMD InterWave (tm) chip.
907
908 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
909 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
910 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
911 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
912 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
913 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
914 pcm_voices - reserved PCM voices for the synthesizer (default 2)
915 effect - 1 = InterWave effects enable (default 0);
916 requires 8 voices
917
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100918 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919
920 Module snd-interwave-stb
921 ------------------------
922
923 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
924 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
925 circuit for extended control of bass, treble and master volume.
926
927 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
928 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
929 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
930 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
931 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
932 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
933 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
934 pcm_voices - reserved PCM voices for the synthesizer (default 2)
935 effect - 1 = InterWave effects enable (default 0);
936 requires 8 voices
937
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100938 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939
940 Module snd-korg1212
941 -------------------
942
943 Module for Korg 1212 IO PCI card
944
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100945 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946
947 Module snd-maestro3
948 -------------------
949
950 Module for Allegro/Maestro3 chips
951
952 external_amp - enable external amp (enabled by default)
953 amp_gpio - GPIO pin number for external amp (0-15) or
954 -1 for default pin (8 for allegro, 1 for
955 others)
956
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100957 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958
959 Note: the binding of amplifier is dependent on hardware.
960 If there is no sound even though all channels are unmuted, try to
961 specify other gpio connection via amp_gpio option.
962 For example, a Panasonic notebook might need "amp_gpio=0x0d"
963 option.
964
965 The power-management is supported.
966
967 Module snd-mixart
968 -----------------
969
970 Module for Digigram miXart8 sound cards.
971
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100972 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 Note: One miXart8 board will be represented as 4 alsa cards.
974 See MIXART.txt for details.
975
976 When the driver is compiled as a module and the hotplug firmware
977 is supported, the firmware data is loaded via hotplug automatically.
978 Install the necessary firmware files in alsa-firmware package.
979 When no hotplug fw loader is available, you need to load the
980 firmware via mixartloader utility in alsa-tools package.
981
982 Module snd-mpu401
983 -----------------
984
985 Module for MPU-401 UART devices.
986
987 port - port number or -1 (disable)
988 irq - IRQ number or -1 (disable)
989 pnp - PnP detection - 0 = disable, 1 = enable (default)
990
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100991 This module supports multiple devices and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992
993 Module snd-mtpav
994 ----------------
995
996 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
997 port).
998
999 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1000 irq - IRQ # for MTPAV (7,5, default=7)
1001 hwports - number of supported hardware ports, default=8.
1002
1003 Module supports only 1 card. This module has no enable option.
1004
1005 Module snd-nm256
1006 ----------------
1007
1008 Module for NeoMagic NM256AV/ZX chips
1009
1010 playback_bufsize - max playback frame size in kB (4-128kB)
1011 capture_bufsize - max capture frame size in kB (4-128kB)
1012 force_ac97 - 0 or 1 (disabled by default)
1013 buffer_top - specify buffer top address
1014 use_cache - 0 or 1 (disabled by default)
1015 vaio_hack - alias buffer_top=0x25a800
1016 reset_workaround - enable AC97 RESET workaround for some laptops
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001017 reset_workaround2 - enable extended AC97 RESET workaround for some
1018 other laptops
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +02001020 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021
1022 The power-management is supported.
1023
1024 Note: on some notebooks the buffer address cannot be detected
1025 automatically, or causes hang-up during initialization.
1026 In such a case, specify the buffer top address explicity via
1027 buffer_top option.
1028 For example,
1029 Sony F250: buffer_top=0x25a800
1030 Sony F270: buffer_top=0x272800
1031 The driver supports only ac97 codec. It's possible to force
1032 to initialize/use ac97 although it's not detected. In such a
1033 case, use force_ac97=1 option - but *NO* guarantee whether it
1034 works!
1035
1036 Note: The NM256 chip can be linked internally with non-AC97
1037 codecs. This driver supports only the AC97 codec, and won't work
1038 with machines with other (most likely CS423x or OPL3SAx) chips,
1039 even though the device is detected in lspci. In such a case, try
1040 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
Takashi Iwai62430082005-09-05 17:12:29 +02001041 but some doesn't have ISA PnP. You'll need to specify isapnp=0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 and proper hardware parameters in the case without ISA PnP.
1043
1044 Note: some laptops need a workaround for AC97 RESET. For the
1045 known hardware like Dell Latitude LS and Sony PCG-F305, this
1046 workaround is enabled automatically. For other laptops with a
1047 hard freeze, you can try reset_workaround=1 option.
1048
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001049 Note: Dell Latitude CSx laptops have another problem regarding
1050 AC97 RESET. On these laptops, reset_workaround2 option is
1051 turned on as default. This option is worth to try if the
1052 previous reset_workaround option doesn't help.
1053
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 Note: This driver is really crappy. It's a porting from the
1055 OSS driver, which is a result of black-magic reverse engineering.
1056 The detection of codec will fail if the driver is loaded *after*
1057 X-server as described above. You might be able to force to load
1058 the module, but it may result in hang-up. Hence, make sure that
1059 you load this module *before* X if you encounter this kind of
1060 problem.
1061
1062 Module snd-opl3sa2
1063 ------------------
1064
1065 Module for Yamaha OPL3-SA2/SA3 sound cards.
1066
1067 port - control port # for OPL3-SA chip (0x370)
1068 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1069 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1070 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1071 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1072 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1073 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1074 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
1075 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1076
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001077 This module supports multiple cards and ISA PnP. It does not support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1079
1080 The power-management is supported.
1081
1082 Module snd-opti92x-ad1848
1083 -------------------------
1084
1085 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1086 Module works with OAK Mozart cards as well.
1087
1088 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1089 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1090 fm_port - port # for OPL3 device (0x388)
1091 irq - IRQ # for WSS chip (5,7,9,10,11)
1092 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1093 dma1 - first DMA # for WSS chip (0,1,3)
1094
1095 This module supports only one card, autoprobe and PnP.
1096
1097 Module snd-opti92x-cs4231
1098 -------------------------
1099
1100 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1101
1102 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1103 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1104 fm_port - port # for OPL3 device (0x388)
1105 irq - IRQ # for WSS chip (5,7,9,10,11)
1106 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1107 dma1 - first DMA # for WSS chip (0,1,3)
1108 dma2 - second DMA # for WSS chip (0,1,3)
1109
1110 This module supports only one card, autoprobe and PnP.
1111
1112 Module snd-opti93x
1113 ------------------
1114
1115 Module for sound cards based on OPTi 82c93x chips.
1116
1117 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1118 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1119 fm_port - port # for OPL3 device (0x388)
1120 irq - IRQ # for WSS chip (5,7,9,10,11)
1121 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1122 dma1 - first DMA # for WSS chip (0,1,3)
1123 dma2 - second DMA # for WSS chip (0,1,3)
1124
1125 This module supports only one card, autoprobe and PnP.
1126
Markus Bollingere12229b2005-12-06 13:55:26 +01001127 Module snd-pcxhr
1128 ----------------
1129
1130 Module for Digigram PCXHR boards
1131
1132 This module supports multiple cards.
1133
Linus Torvalds1da177e2005-04-16 15:20:36 -07001134 Module snd-powermac (on ppc only)
1135 ---------------------------------
1136
1137 Module for PowerMac, iMac and iBook on-board soundchips
1138
1139 enable_beep - enable beep using PCM (enabled as default)
1140
1141 Module supports autoprobe a chip.
1142
1143 Note: the driver may have problems regarding endianess.
1144
1145 The power-management is supported.
1146
Takashi Iwai2c484df2005-06-30 18:54:04 +02001147 Module snd-pxa2xx-ac97 (on arm only)
1148 ------------------------------------
1149
1150 Module for AC97 driver for the Intel PXA2xx chip
1151
1152 For ARM architecture only.
1153
Takashi Iwaia4efc232005-11-17 17:24:26 +01001154 The power-management is supported.
1155
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156 Module snd-rme32
1157 ----------------
1158
1159 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1160 Prodif96 and Prodif Gold) sound cards.
1161
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001162 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001163
1164 Module snd-rme96
1165 ----------------
1166
1167 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1168
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001169 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170
1171 Module snd-rme9652
1172 ------------------
1173
1174 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1175
1176 precise_ptr - Enable precise pointer (doesn't work reliably).
1177 (default = 0)
1178
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001179 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180
1181 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1182 module did formerly. It will allocate the buffers in advance
1183 when any RME9652 cards are found. To make the buffer
1184 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +02001185 stage of boot sequence. See "Early Buffer Allocation"
1186 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001187
1188 Module snd-sa11xx-uda1341 (on arm only)
1189 ---------------------------------------
1190
1191 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1192
1193 Module supports only one card.
1194 Module has no enable and index options.
1195
Takashi Iwaia4efc232005-11-17 17:24:26 +01001196 The power-management is supported.
1197
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198 Module snd-sb8
1199 --------------
1200
1201 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1202 SoundBlaster 2.0,
1203 SoundBlaster Pro
1204
1205 port - port # for SB DSP chip (0x220,0x240,0x260)
1206 irq - IRQ # for SB DSP chip (5,7,9,10)
1207 dma8 - DMA # for SB DSP chip (1,3)
1208
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001209 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210
Takashi Iwaia4efc232005-11-17 17:24:26 +01001211 The power-management is supported.
1212
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 Module snd-sb16 and snd-sbawe
1214 -----------------------------
1215
1216 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1217 SoundBlaster AWE 32 (PnP),
1218 SoundBlaster AWE 64 PnP
1219
1220 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1221 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1222 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1223 (snd-sbawe module only)
1224 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1225 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1226 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
1227 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1228 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1229 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1230
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001231 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232
1233 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1234 disable 16bit DMA with dma16 = -1 module parameter.
1235 Also, all Sound Blaster 16 type cards can operate in 16-bit
1236 half duplex mode through 8-bit DMA channel by disabling their
1237 16-bit DMA channel.
1238
Takashi Iwaia4efc232005-11-17 17:24:26 +01001239 The power-management is supported.
1240
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 Module snd-sgalaxy
1242 ------------------
1243
1244 Module for Aztech Sound Galaxy sound card.
1245
1246 sbport - Port # for SB16 interface (0x220,0x240)
1247 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1248 irq - IRQ # (7,9,10,11)
1249 dma1 - DMA #
1250
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001251 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252
Takashi Iwaia4efc232005-11-17 17:24:26 +01001253 The power-management is supported.
1254
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 Module snd-sscape
1256 -----------------
1257
1258 Module for ENSONIQ SoundScape PnP cards.
1259
1260 port - Port # (PnP setup)
1261 irq - IRQ # (PnP setup)
1262 mpu_irq - MPU-401 IRQ # (PnP setup)
1263 dma - DMA # (PnP setup)
1264
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001265 This module supports multiple cards. ISA PnP must be enabled.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 You need sscape_ctl tool in alsa-tools package for loading
1267 the microcode.
1268
1269 Module snd-sun-amd7930 (on sparc only)
1270 --------------------------------------
1271
1272 Module for AMD7930 sound chips found on Sparcs.
1273
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001274 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275
1276 Module snd-sun-cs4231 (on sparc only)
1277 -------------------------------------
1278
1279 Module for CS4231 sound chips found on Sparcs.
1280
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001281 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001283 Module snd-sun-dbri (on sparc only)
1284 -----------------------------------
1285
1286 Module for DBRI sound chips found on Sparcs.
1287
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001288 This module supports multiple cards.
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001289
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290 Module snd-wavefront
1291 --------------------
1292
1293 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1294
1295 cs4232_pcm_port - Port # for CS4232 PCM interface.
1296 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1297 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1298 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
1299 use_cs4232_midi - Use CS4232 MPU-401 interface
1300 (inaccessibly located inside your computer)
1301 ics2115_port - Port # for ICS2115
1302 ics2115_irq - IRQ # for ICS2115
1303 fm_port - FM OPL-3 Port #
1304 dma1 - DMA1 # for CS4232 PCM interface.
1305 dma2 - DMA2 # for CS4232 PCM interface.
1306 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1307
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001308 This module supports multiple cards and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309
1310 Module snd-sonicvibes
1311 ---------------------
1312
1313 Module for S3 SonicVibes PCI sound cards.
1314 * PINE Schubert 32 PCI
1315
1316 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1317 - SoundCard must have onboard SRAM for this.
1318 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1319
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001320 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321
1322 Module snd-serial-u16550
1323 ------------------------
1324
1325 Module for UART16550A serial MIDI ports.
1326
1327 port - port # for UART16550A chip
1328 irq - IRQ # for UART16550A chip, -1 = poll mode
1329 speed - speed in bauds (9600,19200,38400,57600,115200)
1330 38400 = default
1331 base - base for divisor in bauds (57600,115200,230400,460800)
1332 115200 = default
1333 outs - number of MIDI ports in a serial port (1-4)
1334 1 = default
1335 adaptor - Type of adaptor.
1336 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1337 3 = MS-124W M/B, 4 = Generic
1338
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001339 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 thus the main port must be specified!!! Other options are optional.
1341
1342 Module snd-trident
1343 ------------------
1344
1345 Module for Trident 4DWave DX/NX sound cards.
1346 * Best Union Miss Melody 4DWave PCI
1347 * HIS 4DWave PCI
1348 * Warpspeed ONSpeed 4DWave PCI
1349 * AzTech PCI 64-Q3D
1350 * Addonics SV 750
1351 * CHIC True Sound 4Dwave
1352 * Shark Predator4D-PCI
1353 * Jaton SonicWave 4D
1354
1355 pcm_channels - max channels (voices) reserved for PCM
1356 wavetable_size - max wavetable size in kB (4-?kb)
1357
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001358 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359
1360 The power-management is supported.
1361
1362 Module snd-usb-audio
1363 --------------------
1364
1365 Module for USB audio and USB MIDI devices.
1366
1367 vid - Vendor ID for the device (optional)
1368 pid - Product ID for the device (optional)
1369
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001370 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371
1372 Module snd-usb-usx2y
1373 --------------------
1374
1375 Module for Tascam USB US-122, US-224 and US-428 devices.
1376
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001377 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378
1379 Note: you need to load the firmware via usx2yloader utility included
1380 in alsa-tools and alsa-firmware packages.
1381
1382 Module snd-via82xx
1383 ------------------
1384
1385 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001386 8233A, 8233C, 8235, 8237 (south) bridge.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387
1388 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1389 [VIA686A/686B only]
1390 joystick - Enable joystick (default off) [VIA686A/686B only]
1391 ac97_clock - AC'97 codec clock base (default 48000Hz)
1392 dxs_support - support DXS channels,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001393 0 = auto (default), 1 = enable, 2 = disable,
1394 3 = 48k only, 4 = no VRA, 5 = enable any sample
1395 rate and different sample rates on different
1396 channels
1397 [VIA8233/C, 8235, 8237 only]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001399 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001401 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402
1403 Note: on some SMP motherboards like MSI 694D the interrupts might
1404 not be generated properly. In such a case, please try to
1405 set the SMP (or MPS) version on BIOS to 1.1 instead of
1406 default value 1.4. Then the interrupt number will be
1407 assigned under 15. You might also upgrade your BIOS.
1408
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001409 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 channels as the first PCM. On these channels, up to 4
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001411 streams can be played at the same time, and the controller
1412 can perform sample rate conversion with separate rates for
1413 each channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 As default (dxs_support = 0), 48k fixed rate is chosen
1415 except for the known devices since the output is often
1416 noisy except for 48k on some mother boards due to the
1417 bug of BIOS.
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001418 Please try once dxs_support=5 and if it works on other
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1420 know the PCI subsystem vendor/device id's (output of
1421 "lspci -nv").
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001422 If dxs_support=5 does not work, try dxs_support=4; if it
1423 doesn't work too, try dxs_support=1. (dxs_support=1 is
Takashi Iwai62430082005-09-05 17:12:29 +02001424 usually for old motherboards. The correct implemented
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001425 board should work with 4 or 5.) If it still doesn't
Linus Torvalds1da177e2005-04-16 15:20:36 -07001426 work and the default setting is ok, dxs_support=3 is the
1427 right choice. If the default setting doesn't work at all,
1428 try dxs_support=2 to disable the DXS channels.
1429 In any cases, please let us know the result and the
Takashi Iwai62430082005-09-05 17:12:29 +02001430 subsystem vendor/device ids. See "Links and Addresses"
1431 below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432
1433 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Takashi Iwai62430082005-09-05 17:12:29 +02001434 additionally. The mpu_port option is for VIA686 chips only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001435
Takashi Iwaia4efc232005-11-17 17:24:26 +01001436 The power-management is supported.
1437
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 Module snd-via82xx-modem
1439 ------------------------
1440
1441 Module for VIA82xx AC97 modem
1442
1443 ac97_clock - AC'97 codec clock base (default 48000Hz)
1444
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001445 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446
1447 Note: The default index value of this module is -2, i.e. the first
1448 slot is excluded.
1449
Takashi Iwaia4efc232005-11-17 17:24:26 +01001450 The power-management is supported.
1451
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 Module snd-virmidi
1453 ------------------
1454
1455 Module for virtual rawmidi devices.
1456 This module creates virtual rawmidi devices which communicate
1457 to the corresponding ALSA sequencer ports.
1458
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001459 midi_devs - MIDI devices # (1-4, default=4)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001461 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462
1463 Module snd-vx222
1464 ----------------
1465
1466 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1467
1468 mic - Enable Microphone on V222 Mic (NYI)
1469 ibl - Capture IBL size. (default = 0, minimum size)
1470
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001471 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472
1473 When the driver is compiled as a module and the hotplug firmware
1474 is supported, the firmware data is loaded via hotplug automatically.
1475 Install the necessary firmware files in alsa-firmware package.
1476 When no hotplug fw loader is available, you need to load the
1477 firmware via vxloader utility in alsa-tools package. To invoke
1478 vxloader automatically, add the following to /etc/modprobe.conf
1479
1480 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1481
1482 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1483 /etc/modules.conf, instead.)
1484 IBL size defines the interrupts period for PCM. The smaller size
1485 gives smaller latency but leads to more CPU consumption, too.
1486 The size is usually aligned to 126. As default (=0), the smallest
1487 size is chosen. The possible IBL values can be found in
1488 /proc/asound/cardX/vx-status proc file.
1489
Takashi Iwaia4efc232005-11-17 17:24:26 +01001490 The power-management is supported.
1491
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 Module snd-vxpocket
1493 -------------------
1494
Takashi Iwai6d00a312005-06-30 13:40:51 +02001495 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001496
1497 ibl - Capture IBL size. (default = 0, minimum size)
1498
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001499 This module supports multiple cards. The module is compiled only when
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500 PCMCIA is supported on kernel.
1501
Takashi Iwai62430082005-09-05 17:12:29 +02001502 With the older 2.6.x kernel, to activate the driver via the card
1503 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1504 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1505 longer require a config file.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506
1507 When the driver is compiled as a module and the hotplug firmware
1508 is supported, the firmware data is loaded via hotplug automatically.
1509 Install the necessary firmware files in alsa-firmware package.
1510 When no hotplug fw loader is available, you need to load the
1511 firmware via vxloader utility in alsa-tools package.
1512
1513 About capture IBL, see the description of snd-vx222 module.
1514
1515 Note: the driver is build only when CONFIG_ISA is set.
1516
Takashi Iwai62430082005-09-05 17:12:29 +02001517 Note2: snd-vxp440 driver is merged to snd-vxpocket driver since
1518 ALSA 1.0.10.
1519
Takashi Iwaia4efc232005-11-17 17:24:26 +01001520 The power-management is supported.
1521
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 Module snd-ymfpci
1523 -----------------
1524
1525 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1526
1527 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1528 1 (auto-detect for YMF744/754 only)
1529 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1530 1 (auto-detect for YMF744/754 only)
1531 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1532 1 (auto-detect)
1533 rear_switch - enable shared rear/line-in switch (bool)
1534
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001535 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536
1537 The power-management is supported.
1538
1539 Module snd-pdaudiocf
1540 --------------------
1541
1542 Module for Sound Core PDAudioCF sound card.
1543
1544 Note: the driver is build only when CONFIG_ISA is set.
1545
Takashi Iwaia4efc232005-11-17 17:24:26 +01001546 The power-management is supported.
1547
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548
Takashi Iwai62430082005-09-05 17:12:29 +02001549AC97 Quirk Option
1550=================
1551
1552The ac97_quirk option is used to enable/override the workaround for
1553specific devices on drivers for on-board AC'97 controllers like
1554snd-intel8x0. Some hardware have swapped output pins between Master
1555and Headphone, or Surround (thanks to confusion of AC'97
1556specifications from version to version :-)
1557
1558The driver provides the auto-detection of known problematic devices,
1559but some might be unknown or wrongly detected. In such a case, pass
1560the proper value with this option.
1561
1562The following strings are accepted:
1563 - default Don't override the default setting
Takashi Iwai10e4097f2005-11-17 11:04:55 +01001564 - none Disable the quirk
Takashi Iwai62430082005-09-05 17:12:29 +02001565 - hp_only Bind Master and Headphone controls as a single control
1566 - swap_hp Swap headphone and master controls
1567 - swap_surround Swap master and surround controls
1568 - ad_sharing For AD1985, turn on OMS bit and use headphone
1569 - alc_jack For ALC65x, turn on the jack sense mode
1570 - inv_eapd Inverted EAPD implementation
1571 - mute_led Bind EAPD bit for turning on/off mute LED
1572
1573For backward compatibility, the corresponding integer value -1, 0,
1574... are accepted, too.
1575
1576For example, if "Master" volume control has no effect on your device
1577but only "Headphone" does, pass ac97_quirk=hp_only module option.
1578
1579
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580Configuring Non-ISAPNP Cards
1581============================
1582
1583When the kernel is configured with ISA-PnP support, the modules
1584supporting the isapnp cards will have module options "isapnp".
1585If this option is set, *only* the ISA-PnP devices will be probed.
1586For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
1587together with the proper i/o and irq configuration.
1588
1589When the kernel is configured without ISA-PnP support, isapnp option
1590will be not built in.
1591
1592
1593Module Autoloading Support
1594==========================
1595
1596The ALSA drivers can be loaded automatically on demand by defining
1597module aliases. The string 'snd-card-%1' is requested for ALSA native
1598devices where %i is sound card number from zero to seven.
1599
1600To auto-load an ALSA driver for OSS services, define the string
1601'sound-slot-%i' where %i means the slot number for OSS, which
1602corresponds to the card index of ALSA. Usually, define this
Tobias Klauserd533f672005-09-10 00:26:46 -07001603as the same card module.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604
1605An example configuration for a single emu10k1 card is like below:
1606----- /etc/modprobe.conf
1607alias snd-card-0 snd-emu10k1
1608alias sound-slot-0 snd-emu10k1
1609----- /etc/modprobe.conf
1610
1611The available number of auto-loaded sound cards depends on the module
1612option "cards_limit" of snd module. As default it's set to 1.
1613To enable the auto-loading of multiple cards, specify the number of
1614sound cards in that option.
1615
1616When multiple cards are available, it'd better to specify the index
1617number for each card via module option, too, so that the order of
1618cards is kept consistent.
1619
1620An example configuration for two sound cards is like below:
1621
1622----- /etc/modprobe.conf
1623# ALSA portion
1624options snd cards_limit=2
1625alias snd-card-0 snd-interwave
1626alias snd-card-1 snd-ens1371
1627options snd-interwave index=0
1628options snd-ens1371 index=1
1629# OSS/Free portion
1630alias sound-slot-0 snd-interwave
1631alias sound-slot-1 snd-ens1371
1632----- /etc/moprobe.conf
1633
1634In this example, the interwave card is always loaded as the first card
1635(index 0) and ens1371 as the second (index 1).
1636
1637
1638ALSA PCM devices to OSS devices mapping
1639=======================================
1640
1641/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
1642/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
1643/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
1644/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
1645/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
1646/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
1647/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
1648/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
1649/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
1650
1651The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
1652sound card number and second means device number. The ALSA devices
1653have either 'c' or 'p' suffix indicating the direction, capture and
1654playback, respectively.
1655
1656Please note that the device mapping above may be varied via the module
1657options of snd-pcm-oss module.
1658
1659
1660DEVFS support
1661=============
1662
1663The ALSA driver fully supports the devfs extension.
1664You should add lines below to your devfsd.conf file:
1665
1666LOOKUP snd MODLOAD ACTION snd
1667REGISTER ^sound/.* PERMISSIONS root.audio 660
1668REGISTER ^snd/.* PERMISSIONS root.audio 660
1669
1670Warning: These lines assume that you have the audio group in your system.
1671 Otherwise replace audio word with another group name (root for
1672 example).
1673
1674
1675Proc interfaces (/proc/asound)
1676==============================
1677
1678/proc/asound/card#/pcm#[cp]/oss
1679-------------------------------
1680 String "erase" - erase all additional informations about OSS applications
1681 String "<app_name> <fragments> <fragment_size> [<options>]"
1682
1683 <app_name> - name of application with (higher priority) or without path
1684 <fragments> - number of fragments or zero if auto
1685 <fragment_size> - size of fragment in bytes or zero if auto
1686 <options> - optional parameters
1687 - disable the application tries to open a pcm device for
1688 this channel but does not want to use it.
1689 (Cause a bug or mmap needs)
1690 It's good for Quake etc...
1691 - direct don't use plugins
1692 - block force block mode (rvplayer)
1693 - non-block force non-block mode
1694 - whole-frag write only whole fragments (optimization affecting
1695 playback only)
1696 - no-silence do not fill silence ahead to avoid clicks
Takashi Iwai10f69f92005-09-08 13:48:34 +02001697 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
1698 instead of filled blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699
1700 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
1701 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
1702 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
1703
1704
Takashi Iwaib6a96912005-05-30 18:27:03 +02001705Early Buffer Allocation
1706=======================
1707
1708Some drivers (e.g. hdsp) require the large contiguous buffers, and
1709sometimes it's too late to find such spaces when the driver module is
1710actually loaded due to memory fragmentation. You can pre-allocate the
1711PCM buffers by loading snd-page-alloc module and write commands to its
1712proc file in prior, for example, in the early boot stage like
1713/etc/init.d/*.local scripts.
1714
1715Reading the proc file /proc/drivers/snd-page-alloc shows the current
1716usage of page allocation. In writing, you can send the following
1717commands to the snd-page-alloc driver:
1718
1719 - add VENDOR DEVICE MASK SIZE BUFFERS
1720
1721 VENDOR and DEVICE are PCI vendor and device IDs. They take
1722 integer numbers (0x prefix is needed for the hex).
1723 MASK is the PCI DMA mask. Pass 0 if not restricted.
1724 SIZE is the size of each buffer to allocate. You can pass
1725 k and m suffix for KB and MB. The max number is 16MB.
1726 BUFFERS is the number of buffers to allocate. It must be greater
1727 than 0. The max number is 4.
1728
1729 - erase
1730
1731 This will erase the all pre-allocated buffers which are not in
1732 use.
1733
1734
Takashi Iwai62430082005-09-05 17:12:29 +02001735Links and Addresses
1736===================
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737
1738 ALSA project homepage
1739 http://www.alsa-project.org
1740
Takashi Iwai62430082005-09-05 17:12:29 +02001741 ALSA Bug Tracking System
1742 https://bugtrack.alsa-project.org/bugs/
1743
1744 ALSA Developers ML
1745 mailto:alsa-devel@lists.sourceforge.net