blob: f1a1787e71e5d8d9dbe436a6e19f79a77387d3c3 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001
2 Advanced Linux Sound Architecture - Driver
3 ==========================================
4 Configuration guide
5
6
7Kernel Configuration
8====================
9
10To enable ALSA support you need at least to build the kernel with
11primary sound card support (CONFIG_SOUND). Since ALSA can emulate OSS,
12you don't have to choose any of the OSS modules.
13
14Enable "OSS API emulation" (CONFIG_SND_OSSEMUL) and both OSS mixer and
15PCM supports if you want to run OSS applications with ALSA.
16
17If you want to support the WaveTable functionality on cards such as
18SB Live! then you need to enable "Sequencer support"
19(CONFIG_SND_SEQUENCER).
20
21To make ALSA debug messages more verbose, enable the "Verbose printk"
22and "Debug" options. To check for memory leaks, turn on "Debug memory"
23too. "Debug detection" will add checks for the detection of cards.
24
25Please note that all the ALSA ISA drivers support the Linux isapnp API
26(if the card supports ISA PnP). You don't need to configure the cards
27using isapnptools.
28
29
30Creating ALSA devices
31=====================
32
33This depends on your distribution, but normally you use the /dev/MAKEDEV
34script to create the necessary device nodes. On some systems you use a
35script named 'snddevices'.
36
37
38Module parameters
39=================
40
41The user can load modules with options. If the module supports more than
42one card and you have more than one card of the same type then you can
43specify multiple values for the option separated by commas.
44
45Prior to version 0.9.0rc4 options had a 'snd_' prefix. This was removed.
46
47 Module snd
48 ----------
49
50 The core ALSA module. It is used by all ALSA card drivers.
51 It takes the following options which have global effects.
52
53 major - major number for sound driver
54 - Default: 116
55 cards_limit
56 - limiting card index for auto-loading (1-8)
57 - Default: 1
58 - For auto-loading more than one card, specify this
59 option together with snd-card-X aliases.
Takashi Iwai304cd072007-10-26 15:10:15 +020060 slots - Reserve the slot index for the given driver.
61 This option takes multiple strings.
62 See "Module Autoloading Support" section for details.
Takashi Iwai36ce99c2009-08-27 16:45:07 +020063 debug - Specifies the debug message level
64 (0 = disable debug prints, 1 = normal debug messages,
65 2 = verbose debug messages)
66 This option appears only when CONFIG_SND_DEBUG=y.
67 This option can be dynamically changed via sysfs
68 /sys/modules/snd/parameters/debug file.
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70 Module snd-pcm-oss
71 ------------------
72
73 The PCM OSS emulation module.
74 This module takes options which change the mapping of devices.
75
76 dsp_map - PCM device number maps assigned to the 1st OSS device.
77 - Default: 0
78 adsp_map - PCM device number maps assigned to the 2st OSS device.
79 - Default: 1
80 nonblock_open
Takashi Iwai62430082005-09-05 17:12:29 +020081 - Don't block opening busy PCM devices. Default: 1
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83 For example, when dsp_map=2, /dev/dsp will be mapped to PCM #2 of
84 the card #0. Similarly, when adsp_map=0, /dev/adsp will be mapped
85 to PCM #0 of the card #0.
86 For changing the second or later card, specify the option with
87 commas, such like "dsp_map=0,1".
88
89 nonblock_open option is used to change the behavior of the PCM
90 regarding opening the device. When this option is non-zero,
91 opening a busy OSS PCM device won't be blocked but return
92 immediately with EAGAIN (just like O_NONBLOCK flag).
93
94 Module snd-rawmidi
95 ------------------
96
97 This module takes options which change the mapping of devices.
98 similar to those of the snd-pcm-oss module.
99
100 midi_map - MIDI device number maps assigned to the 1st OSS device.
101 - Default: 0
102 amidi_map - MIDI device number maps assigned to the 2st OSS device.
103 - Default: 1
104
105 Common parameters for top sound card modules
106 --------------------------------------------
107
108 Each of top level sound card module takes the following options.
109
110 index - index (slot #) of sound card
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100111 - Values: 0 through 31 or negative
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 - If nonnegative, assign that index number
113 - if negative, interpret as a bitmask of permissible
114 indices; the first free permitted index is assigned
115 - Default: -1
116 id - card ID (identifier or name)
117 - Can be up to 15 characters long
118 - Default: the card type
119 - A directory by this name is created under /proc/asound/
120 containing information about the card
121 - This ID can be used instead of the index number in
122 identifying the card
123 enable - enable card
124 - Default: enabled, for PCI and ISA PnP cards
125
Rene Hermancf40a312006-03-28 12:38:20 +0200126 Module snd-adlib
127 ----------------
128
129 Module for AdLib FM cards.
130
131 port - port # for OPL chip
132
133 This module supports multiple cards. It does not support autoprobe, so
134 the port must be specified. For actual AdLib FM cards it will be 0x388.
135 Note that this card does not have PCM support and no mixer; only FM
136 synthesis.
137
138 Make sure you have "sbiload" from the alsa-tools package available and,
139 after loading the module, find out the assigned ALSA sequencer port
140 number through "sbiload -l". Example output:
141
142 Port Client name Port name
143 64:0 OPL2 FM synth OPL2 FM Port
144
145 Load the std.sb and drums.sb patches also supplied by sbiload:
146
147 sbiload -p 64:0 std.sb drums.sb
148
149 If you use this driver to drive an OPL3, you can use std.o3 and drums.o3
150 instead. To have the card produce sound, use aplaymidi from alsa-utils:
151
152 aplaymidi -p 64:0 foo.mid
153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 Module snd-ad1816a
155 ------------------
156
157 Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips.
158
Takashi Iwai506d4c62005-08-03 14:02:47 +0200159 clockfreq - Clock frequency for AD1816A chip (default = 0, 33000Hz)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100161 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
163 Module snd-ad1848
164 -----------------
165
166 Module for sound cards based on AD1848/AD1847/CS4248 ISA chips.
167
168 port - port # for AD1848 chip
169 irq - IRQ # for AD1848 chip
170 dma1 - DMA # for AD1848 chip (0,1,3)
171
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100172 This module supports multiple cards. It does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 thus main port must be specified!!! Other ports are optional.
174
Takashi Iwaia4efc232005-11-17 17:24:26 +0100175 The power-management is supported.
176
Clemens Ladisch84010e62005-09-02 07:57:59 +0200177 Module snd-ad1889
178 -----------------
179
180 Module for Analog Devices AD1889 chips.
181
182 ac97_quirk - AC'97 workaround for strange hardware
183 See the description of intel8x0 module for details.
184
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100185 This module supports multiple cards.
Clemens Ladisch84010e62005-09-02 07:57:59 +0200186
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187 Module snd-ali5451
188 ------------------
189
190 Module for ALi M5451 PCI chip.
191
192 pcm_channels - Number of hardware channels assigned for PCM
193 spdif - Support SPDIF I/O
194 - Default: disabled
195
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +0200196 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197
198 The power-management is supported.
199
200 Module snd-als100
201 -----------------
202
203 Module for sound cards based on Avance Logic ALS100/ALS120 ISA chips.
204
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100205 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
Takashi Iwaia4efc232005-11-17 17:24:26 +0100207 The power-management is supported.
208
Ash Willisb3a70d52006-03-27 13:20:40 +0200209 Module snd-als300
210 -----------------
211
212 Module for Avance Logic ALS300 and ALS300+
213
214 This module supports multiple cards.
215
216 The power-management is supported.
217
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 Module snd-als4000
219 ------------------
220
221 Module for sound cards based on Avance Logic ALS4000 PCI chip.
222
223 joystick_port - port # for legacy joystick support.
224 0 = disabled (default), 1 = auto-detect
225
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100226 This module supports multiple cards, autoprobe and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
Takashi Iwaia4efc232005-11-17 17:24:26 +0100228 The power-management is supported.
229
Eliot Blennerhassett719f82d2010-04-21 18:17:39 +0200230 Module snd-asihpi
231 -----------------
232
233 Module for AudioScience ASI soundcards
234
235 enable_hpi_hwdep - enable HPI hwdep for AudioScience soundcard
236
237 This module supports multiple cards.
238 The driver requires the firmware loader support on kernel.
239
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 Module snd-atiixp
241 -----------------
242
Takashi Iwai62430082005-09-05 17:12:29 +0200243 Module for ATI IXP 150/200/250/400 AC97 controllers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244
Takashi Iwai62430082005-09-05 17:12:29 +0200245 ac97_clock - AC'97 clock (default = 48000)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +0200247 See "AC97 Quirk Option" section below.
Dan Carpenter14e1d352006-11-20 16:35:18 +0100248 ac97_codec - Workaround to specify which AC'97 codec
249 instead of probing. If this works for you
250 file a bug with your `lspci -vn` output.
251 -2 -- Force probing.
252 -1 -- Default behavior.
253 0-2 -- Use the specified codec.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 spdif_aclink - S/PDIF transfer over AC-link (default = 1)
255
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200256 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
Takashi Iwai62430082005-09-05 17:12:29 +0200258 ATI IXP has two different methods to control SPDIF output. One is
259 over AC-link and another is over the "direct" SPDIF output. The
260 implementation depends on the motherboard, and you'll need to
261 choose the correct one via spdif_aclink module option.
262
Takashi Iwaia4efc232005-11-17 17:24:26 +0100263 The power-management is supported.
264
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 Module snd-atiixp-modem
266 -----------------------
267
268 Module for ATI IXP 150/200/250 AC97 modem controllers.
269
Clemens Ladischb7fe4622005-10-04 08:46:51 +0200270 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
272 Note: The default index value of this module is -2, i.e. the first
273 slot is excluded.
274
Takashi Iwaia4efc232005-11-17 17:24:26 +0100275 The power-management is supported.
276
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 Module snd-au8810, snd-au8820, snd-au8830
278 -----------------------------------------
279
280 Module for Aureal Vortex, Vortex2 and Advantage device.
281
282 pcifix - Control PCI workarounds
283 0 = Disable all workarounds
284 1 = Force the PCI latency of the Aureal card to 0xff
285 2 = Force the Extend PCI#2 Internal Master for Efficient
286 Handling of Dummy Requests on the VIA KT133 AGP Bridge
287 3 = Force both settings
288 255 = Autodetect what is required (default)
289
290 This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
291 EQ, mpu401, gameport. A3D and wavetable support are still in development.
292 Development and reverse engineering work is being coordinated at
293 http://savannah.nongnu.org/projects/openvortex/
294 SPDIF output has a copy of the AC97 codec output, unless you use the
295 "spdif" pcm device, which allows raw data passthru.
296 The hardware EQ hardware and SPDIF is only present in the Vortex2 and
297 Advantage.
298
Takashi Iwai62430082005-09-05 17:12:29 +0200299 Note: Some ALSA mixer applications don't handle the SPDIF sample rate
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 control correctly. If you have problems regarding this, try
301 another ALSA compliant mixer (alsamixer works).
302
René Herman49531192010-08-11 13:08:06 +0200303 Module snd-azt1605
304 ------------------
305
306 Module for Aztech Sound Galaxy soundcards based on the Aztech AZT1605
307 chipset.
308
309 port - port # for BASE (0x220,0x240,0x260,0x280)
310 wss_port - port # for WSS (0x530,0x604,0xe80,0xf40)
311 irq - IRQ # for WSS (7,9,10,11)
312 dma1 - DMA # for WSS playback (0,1,3)
313 dma2 - DMA # for WSS capture (0,1), -1 = disabled (default)
314 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disabled (default)
315 mpu_irq - IRQ # for MPU-401 UART (3,5,7,9), -1 = disabled (default)
316 fm_port - port # for OPL3 (0x388), -1 = disabled (default)
317
318 This module supports multiple cards. It does not support autoprobe: port,
319 wss_port, irq and dma1 have to be specified. The other values are
320 optional.
321
322 "port" needs to match the BASE ADDRESS jumper on the card (0x220 or 0x240)
323 or the value stored in the card's EEPROM for cards that have an EEPROM and
324 their "CONFIG MODE" jumper set to "EEPROM SETTING". The other values can
325 be choosen freely from the options enumerated above.
326
327 If dma2 is specified and different from dma1, the card will operate in
328 full-duplex mode. When dma1=3, only dma2=0 is valid and the only way to
329 enable capture since only channels 0 and 1 are available for capture.
330
331 Generic settings are "port=0x220 wss_port=0x530 irq=10 dma1=1 dma2=0
332 mpu_port=0x330 mpu_irq=9 fm_port=0x388".
333
334 Whatever IRQ and DMA channels you pick, be sure to reserve them for
335 legacy ISA in your BIOS.
336
337 Module snd-azt2316
338 ------------------
339
340 Module for Aztech Sound Galaxy soundcards based on the Aztech AZT2316
341 chipset.
342
343 port - port # for BASE (0x220,0x240,0x260,0x280)
344 wss_port - port # for WSS (0x530,0x604,0xe80,0xf40)
345 irq - IRQ # for WSS (7,9,10,11)
346 dma1 - DMA # for WSS playback (0,1,3)
347 dma2 - DMA # for WSS capture (0,1), -1 = disabled (default)
348 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disabled (default)
349 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10), -1 = disabled (default)
350 fm_port - port # for OPL3 (0x388), -1 = disabled (default)
351
352 This module supports multiple cards. It does not support autoprobe: port,
353 wss_port, irq and dma1 have to be specified. The other values are
354 optional.
355
356 "port" needs to match the BASE ADDRESS jumper on the card (0x220 or 0x240)
357 or the value stored in the card's EEPROM for cards that have an EEPROM and
358 their "CONFIG MODE" jumper set to "EEPROM SETTING". The other values can
359 be choosen freely from the options enumerated above.
360
361 If dma2 is specified and different from dma1, the card will operate in
362 full-duplex mode. When dma1=3, only dma2=0 is valid and the only way to
363 enable capture since only channels 0 and 1 are available for capture.
364
365 Generic settings are "port=0x220 wss_port=0x530 irq=10 dma1=1 dma2=0
366 mpu_port=0x330 mpu_irq=9 fm_port=0x388".
367
368 Whatever IRQ and DMA channels you pick, be sure to reserve them for
369 legacy ISA in your BIOS.
370
Takashi Iwai9e235322008-02-20 12:13:29 +0100371 Module snd-aw2
372 --------------
373
374 Module for Audiowerk2 sound card
375
376 This module supports multiple cards.
377
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378 Module snd-azt2320
379 ------------------
380
381 Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
382
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100383 This module supports multiple cards, PnP and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384
Takashi Iwaia4efc232005-11-17 17:24:26 +0100385 The power-management is supported.
386
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 Module snd-azt3328
388 ------------------
389
390 Module for sound cards based on Aztech AZF3328 PCI chip.
391
392 joystick - Enable joystick (default off)
393
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100394 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395
396 Module snd-bt87x
397 ----------------
398
399 Module for video cards based on Bt87x chips.
400
401 digital_rate - Override the default digital rate (Hz)
402 load_all - Load the driver even if the card model isn't known
403
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100404 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
406 Note: The default index value of this module is -2, i.e. the first
407 slot is excluded.
408
409 Module snd-ca0106
410 -----------------
411
412 Module for Creative Audigy LS and SB Live 24bit
413
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100414 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415
416
417 Module snd-cmi8330
418 ------------------
419
420 Module for sound cards based on C-Media CMI8330 ISA chips.
421
Rene Herman64e0e2d2007-12-13 16:29:33 +0100422 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
423
424 with isapnp=0, the following options are available:
425
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 wssport - port # for CMI8330 chip (WSS)
427 wssirq - IRQ # for CMI8330 chip (WSS)
428 wssdma - first DMA # for CMI8330 chip (WSS)
429 sbport - port # for CMI8330 chip (SB16)
430 sbirq - IRQ # for CMI8330 chip (SB16)
431 sbdma8 - 8bit DMA # for CMI8330 chip (SB16)
432 sbdma16 - 16bit DMA # for CMI8330 chip (SB16)
Takashi Iwai9e128fd2009-01-29 11:49:10 +0100433 fmport - (optional) OPL3 I/O port
434 mpuport - (optional) MPU401 I/O port
435 mpuirq - (optional) MPU401 irq #
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100437 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438
Takashi Iwaia4efc232005-11-17 17:24:26 +0100439 The power-management is supported.
440
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 Module snd-cmipci
442 -----------------
443
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200444 Module for C-Media CMI8338/8738/8768/8770 PCI sound cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
Clemens Ladischc78c9502007-09-03 09:55:49 +0200446 mpu_port - port address of MIDI interface (8338 only):
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200447 0x300,0x310,0x320,0x330 = legacy port,
Takashi Iwaicab5c4c2006-05-04 14:36:08 +0200448 0 = disable (default)
Clemens Ladisch45c41b42007-08-22 09:45:03 +0200449 fm_port - port address of OPL-3 FM synthesizer (8x38 only):
450 0x388 = legacy port,
451 1 = integrated PCI port (default on 8738),
Takashi Iwai2f24d1592007-02-15 18:56:43 +0100452 0 = disable
Takashi Iwai62430082005-09-05 17:12:29 +0200453 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 (default = 1)
455 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
456
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100457 This module supports autoprobe and multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458
Takashi Iwaia4efc232005-11-17 17:24:26 +0100459 The power-management is supported.
460
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 Module snd-cs4231
462 -----------------
463
464 Module for sound cards based on CS4231 ISA chips.
465
466 port - port # for CS4231 chip
467 mpu_port - port # for MPU-401 UART (optional), -1 = disable
468 irq - IRQ # for CS4231 chip
469 mpu_irq - IRQ # for MPU-401 UART
470 dma1 - first DMA # for CS4231 chip
471 dma2 - second DMA # for CS4231 chip
472
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100473 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 thus main port must be specified!!! Other ports are optional.
475
476 The power-management is supported.
477
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478 Module snd-cs4236
479 -----------------
480
Takashi Iwaic844a5d2009-02-16 23:17:33 +0100481 Module for sound cards based on CS4232/CS4232A,
482 CS4235/CS4236/CS4236B/CS4237B/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 CS4238B/CS4239 ISA chips.
484
Rene Herman64e0e2d2007-12-13 16:29:33 +0100485 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
486
487 with isapnp=0, the following options are available:
488
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 port - port # for CS4236 chip (PnP setup - 0x534)
490 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
491 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
492 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
493 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
494 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
495 dma1 - first DMA # for CS4236 chip (0,1,3)
496 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100498 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 (if ISA PnP is not used) thus main port and control port must be
500 specified!!! Other ports are optional.
501
502 The power-management is supported.
503
Takashi Iwaic844a5d2009-02-16 23:17:33 +0100504 This module is aliased as snd-cs4232 since it provides the old
505 snd-cs4232 functionality, too.
506
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 Module snd-cs4281
508 -----------------
509
510 Module for Cirrus Logic CS4281 soundchip.
511
512 dual_codec - Secondary codec ID (0 = disable, default)
513
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100514 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
516 The power-management is supported.
517
518 Module snd-cs46xx
519 -----------------
520
521 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
522 CS4624/CS4630/CS4280 PCI chips.
523
Takashi Iwai62430082005-09-05 17:12:29 +0200524 external_amp - Force to enable external amplifier.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 thinkpad - Force to enable Thinkpad's CLKRUN control.
526 mmap_valid - Support OSS mmap mode (default = 0).
527
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100528 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 Usually external amp and CLKRUN controls are detected automatically
530 from PCI sub vendor/device ids. If they don't work, give the options
531 above explicitly.
532
533 The power-management is supported.
Takashi Iwai621887a2007-05-24 18:46:54 +0200534
535 Module snd-cs5530
536 _________________
537
538 Module for Cyrix/NatSemi Geode 5530 chip.
539
Takashi Iwai3e873172005-11-17 10:15:37 +0100540 Module snd-cs5535audio
541 ----------------------
542
543 Module for multifunction CS5535 companion PCI device
544
Takashi Iwaic00bd742006-05-19 19:22:34 +0200545 The power-management is supported.
Takashi Iwai3e873172005-11-17 10:15:37 +0100546
Wai Yew CHAY8cc72362009-05-14 08:05:58 +0200547 Module snd-ctxfi
548 ----------------
549
550 Module for Creative Sound Blaster X-Fi boards (20k1 / 20k2 chips)
551 * Creative Sound Blaster X-Fi Titanium Fatal1ty Champion Series
552 * Creative Sound Blaster X-Fi Titanium Fatal1ty Professional Series
553 * Creative Sound Blaster X-Fi Titanium Professional Audio
554 * Creative Sound Blaster X-Fi Titanium
555 * Creative Sound Blaster X-Fi Elite Pro
556 * Creative Sound Blaster X-Fi Platinum
557 * Creative Sound Blaster X-Fi Fatal1ty
558 * Creative Sound Blaster X-Fi XtremeGamer
559 * Creative Sound Blaster X-Fi XtremeMusic
560
561 reference_rate - reference sample rate, 44100 or 48000 (default)
562 multiple - multiple to ref. sample rate, 1 or 2 (default)
Takashi Iwai408bffd2010-01-14 09:19:46 +0100563 subsystem - override the PCI SSID for probing; the value
564 consists of SSVID << 16 | SSDID. The default is
565 zero, which means no override.
Wai Yew CHAY8cc72362009-05-14 08:05:58 +0200566
567 This module supports multiple cards.
568
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200569 Module snd-darla20
570 ------------------
571
572 Module for Echoaudio Darla20
573
574 This module supports multiple cards.
575 The driver requires the firmware loader support on kernel.
576
577 Module snd-darla24
578 ------------------
579
580 Module for Echoaudio Darla24
581
582 This module supports multiple cards.
583 The driver requires the firmware loader support on kernel.
584
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 Module snd-dt019x
586 -----------------
587
588 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
589 only)
590
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100591 This module supports multiple cards. This module is enabled only with
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 ISA PnP support.
593
Takashi Iwaia4efc232005-11-17 17:24:26 +0100594 The power-management is supported.
595
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 Module snd-dummy
597 ----------------
598
599 Module for the dummy sound card. This "card" doesn't do any output
600 or input, but you may use this module for any application which
601 requires a sound card (like RealPlayer).
602
Takashi Iwai30681bcf2009-09-03 16:08:08 +0200603 pcm_devs - Number of PCM devices assigned to each card
604 (default = 1, up to 4)
605 pcm_substreams - Number of PCM substreams assigned to each PCM
Takashi Iwai23aebca2009-11-02 14:10:59 +0100606 (default = 8, up to 128)
Takashi Iwai30681bcf2009-09-03 16:08:08 +0200607 hrtimer - Use hrtimer (=1, default) or system timer (=0)
Takashi Iwaia68c4d12009-09-04 12:19:36 +0200608 fake_buffer - Fake buffer allocations (default = 1)
Takashi Iwai30681bcf2009-09-03 16:08:08 +0200609
610 When multiple PCM devices are created, snd-dummy gives different
611 behavior to each PCM device:
612 0 = interleaved with mmap support
613 1 = non-interleaved with mmap support
614 2 = interleaved without mmap
615 3 = non-interleaved without mmap
616
Takashi Iwaia68c4d12009-09-04 12:19:36 +0200617 As default, snd-dummy drivers doesn't allocate the real buffers
618 but either ignores read/write or mmap a single dummy page to all
619 buffer pages, in order to save the resouces. If your apps need
620 the read/ written buffer data to be consistent, pass fake_buffer=0
621 option.
622
Takashi Iwaia4efc232005-11-17 17:24:26 +0100623 The power-management is supported.
624
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200625 Module snd-echo3g
626 -----------------
627
628 Module for Echoaudio 3G cards (Gina3G/Layla3G)
629
630 This module supports multiple cards.
631 The driver requires the firmware loader support on kernel.
632
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 Module snd-emu10k1
634 ------------------
635
636 Module for EMU10K1/EMU10k2 based PCI sound cards.
637 * Sound Blaster Live!
638 * Sound Blaster PCI 512
639 * Emu APS (partially supported)
640 * Sound Blaster Audigy
641
642 extin - bitmap of available external inputs for FX8010 (see bellow)
643 extout - bitmap of available external outputs for FX8010 (see bellow)
644 seq_ports - allocated sequencer ports (4 by default)
645 max_synth_voices - limit of voices used for wavetable (64 by default)
646 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
647 given in MB unit. Default value is 128.
648 enable_ir - enable IR
649
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100650 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651
652 Input & Output configurations [extin/extout]
653 * Creative Card wo/Digital out [0x0003/0x1f03]
654 * Creative Card w/Digital out [0x0003/0x1f0f]
655 * Creative Card w/Digital CD in [0x000f/0x1f0f]
656 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
657 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
658 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
659 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
660 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
661 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
662 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
663 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
664 * Creative Card all ins and outs [0x3fff/0x7fff]
665
Takashi Iwaia4efc232005-11-17 17:24:26 +0100666 The power-management is supported.
667
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 Module snd-emu10k1x
669 -------------------
670
671 Module for Creative Emu10k1X (SB Live Dell OEM version)
672
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100673 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674
675 Module snd-ens1370
676 ------------------
677
678 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
679 * SoundBlaster PCI 64
680 * SoundBlaster PCI 128
681
682 joystick - Enable joystick (default off)
683
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100684 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100686 The power-management is supported.
687
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 Module snd-ens1371
689 ------------------
690
691 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
692 * SoundBlaster PCI 64
693 * SoundBlaster PCI 128
694 * SoundBlaster Vibra PCI
695
696 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
697 0 = disable (default), 1 = auto-detect
698
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100699 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700
Takashi Iwaid6ec8942006-01-20 14:05:06 +0100701 The power-management is supported.
702
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 Module snd-es1688
704 -----------------
705
706 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
707
Krzysztof Helta20971b2010-05-10 09:47:32 +0200708 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
Krzysztof Helta20971b2010-05-10 09:47:32 +0200711 fm_port - port # for OPL3 (option; share the same port as default)
712
713 with isapnp=0, the following additional options are available:
714 port - port # for ES-1688 chip (0x220,0x240,0x260)
715 irq - IRQ # for ES-1688 chip (5,7,9,10)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 dma8 - DMA # for ES-1688 chip (0,1,3)
717
Krzysztof Helta20971b2010-05-10 09:47:32 +0200718 This module supports multiple cards and autoprobe (without MPU-401 port)
719 and PnP with the ES968 chip.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720
721 Module snd-es18xx
722 -----------------
723
724 Module for ESS AudioDrive ES-18xx sound cards.
725
Rene Herman64e0e2d2007-12-13 16:29:33 +0100726 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
727
728 with isapnp=0, the following options are available:
729
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 port - port # for ES-18xx chip (0x220,0x240,0x260)
731 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
732 fm_port - port # for FM (optional, not used)
733 irq - IRQ # for ES-18xx chip (5,7,9,10)
734 dma1 - first DMA # for ES-18xx chip (0,1,3)
735 dma2 - first DMA # for ES-18xx chip (0,1,3)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100737 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
738 port if native ISA PnP routines are not used).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 When dma2 is equal with dma1, the driver works as half-duplex.
740
741 The power-management is supported.
742
743 Module snd-es1938
744 -----------------
745
746 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
747
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100748 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
Takashi Iwaia4efc232005-11-17 17:24:26 +0100750 The power-management is supported.
751
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 Module snd-es1968
753 -----------------
754
755 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
756
757 total_bufsize - total buffer size in kB (1-4096kB)
758 pcm_substreams_p - playback channels (1-8, default=2)
759 pcm_substreams_c - capture channels (1-8, default=0)
760 clock - clock (0 = auto-detection)
761 use_pm - support the power-management (0 = off, 1 = on,
762 2 = auto (default))
763 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
764 joystick - enable joystick (default off)
765
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100766 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767
768 The power-management is supported.
769
770 Module snd-fm801
771 ----------------
772
773 Module for ForteMedia FM801 based PCI sound cards.
774
775 tea575x_tuner - Enable TEA575x tuner
776 - 1 = MediaForte 256-PCS
777 - 2 = MediaForte 256-PCPR
778 - 3 = MediaForte 64-PCR
779 - High 16-bits are video (radio) device number + 1
780 - example: 0x10002 (MediaForte 256-PCPR, device 1)
781
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100782 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783
Takashi Iwaia4efc232005-11-17 17:24:26 +0100784 The power-management is supported.
785
Giuliano Pochinidd7b2542006-06-28 13:53:41 +0200786 Module snd-gina20
787 -----------------
788
789 Module for Echoaudio Gina20
790
791 This module supports multiple cards.
792 The driver requires the firmware loader support on kernel.
793
794 Module snd-gina24
795 -----------------
796
797 Module for Echoaudio Gina24
798
799 This module supports multiple cards.
800 The driver requires the firmware loader support on kernel.
801
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 Module snd-gusclassic
803 ---------------------
804
805 Module for Gravis UltraSound Classic sound card.
806
807 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
808 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
809 dma1 - DMA # for GF1 chip (1,3,5,6,7)
810 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
811 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
812 voices - GF1 voices limit (14-32)
813 pcm_voices - reserved PCM voices
814
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100815 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816
817 Module snd-gusextreme
818 ---------------------
819
820 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
821
822 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
823 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
824 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
825 irq - IRQ # for ES-1688 chip (5,7,9,10)
826 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
827 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
828 dma8 - DMA # for ES-1688 chip (0,1,3)
829 dma1 - DMA # for GF1 chip (1,3,5,6,7)
830 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
831 voices - GF1 voices limit (14-32)
832 pcm_voices - reserved PCM voices
833
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100834 This module supports multiple cards and autoprobe (without MPU-401 port).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835
836 Module snd-gusmax
837 -----------------
838
839 Module for Gravis UltraSound MAX sound card.
840
841 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
842 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
843 dma1 - DMA # for GF1 chip (1,3,5,6,7)
844 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
845 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
846 voices - GF1 voices limit (14-32)
847 pcm_voices - reserved PCM voices
848
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100849 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850
851 Module snd-hda-intel
852 --------------------
853
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400854 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8, ICH9, ICH10,
855 PCH, SCH),
856 ATI SB450, SB600, R600, RS600, RS690, RS780, RV610, RV620,
857 RV630, RV635, RV670, RV770,
Takashi Iwai9b878192006-05-17 11:26:39 +0200858 VIA VT8251/VT8237A,
859 SIS966, ULI M5461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100861 [Multiple options for each card instance]
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 model - force the model name
Takashi Iwaid2e1c972008-06-10 17:53:34 +0200863 position_fix - Fix DMA pointer (0 = auto, 1 = use LPIB, 2 = POSBUF)
Takashi Iwai95904742007-05-19 17:06:42 +0200864 probe_mask - Bitmask to probe codecs (default = -1, meaning all slots)
Takashi Iwaiae374d62009-02-13 08:33:55 +0100865 When the bit 8 (0x100) is set, the lower 8 bits are used
866 as the "fixed" codec slots; i.e. the driver probes the
867 slots regardless what hardware reports back
Takashi Iwaid4d9cd032008-12-19 15:19:11 +0100868 probe_only - Only probing and no codec initialization (default=off);
869 Useful to check the initial codec status for debugging
Takashi Iwai8c53b962008-06-10 17:53:35 +0200870 bdl_pos_adj - Specifies the DMA IRQ timing delay in samples.
871 Passing -1 will make the driver to choose the appropriate
872 value based on the controller chip.
Takashi Iwai1e7b8c82009-06-17 17:30:54 +0200873 patch - Specifies the early "patch" files to modify the HD-audio
874 setup before initializing the codecs. This option is
875 available only when CONFIG_SND_HDA_PATCH_LOADER=y is set.
876 See HD-Audio.txt for details.
Takashi Iwaid0193612009-11-16 12:03:49 +0100877 beep_mode - Selects the beep registration mode (0=off, 1=on, 2=
878 dynamic registration via mute switch on/off); the default
879 value is set via CONFIG_SND_HDA_INPUT_BEEP_MODE kconfig.
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100880
881 [Single (global) options]
Takashi Iwai27346162006-01-12 18:28:44 +0100882 single_cmd - Use single immediate commands to communicate with
883 codecs (for debugging only)
Takashi Iwai134a11f2006-11-10 12:08:37 +0100884 enable_msi - Enable Message Signaled Interrupt (MSI) (default = off)
Matt LaPlante19f59462009-04-27 15:06:31 +0200885 power_save - Automatic power-saving timeout (in second, 0 =
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200886 disable)
Takashi Iwaidee1b662007-08-13 16:10:30 +0200887 power_save_controller - Reset HD-audio controller in power-saving mode
888 (default = on)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889
Takashi Iwai5aba4f82008-01-07 15:16:37 +0100890 This module supports multiple cards and autoprobe.
891
Takashi Iwaicae51172008-12-19 08:36:53 +0100892 See Documentation/sound/alsa/HD-Audio.txt for more details about
893 HD-audio driver.
894
Linus Torvalds1da177e2005-04-16 15:20:36 -0700895 Each codec may have a model table for different configurations.
896 If your machine isn't listed there, the default (usually minimal)
897 configuration is set up. You can pass "model=<name>" option to
898 specify a certain model in such a case. There are different
Takashi Iwaicae51172008-12-19 08:36:53 +0100899 models depending on the codec chip. The list of available models
900 is found in HD-Audio-Models.txt
Takashi Iwaidb064e52006-03-16 16:04:58 +0100901
Takashi Iwai6d7b1d72007-02-26 15:56:46 +0100902 The model name "genric" is treated as a special case. When this
903 model is given, the driver uses the generic codec parser without
904 "codec-patch". It's sometimes good for testing and debugging.
905
Takashi Iwai62430082005-09-05 17:12:29 +0200906 If the default configuration doesn't work and one of the above
Takashi Iwai30bc4482008-12-09 08:23:45 +0100907 matches with your device, report it together with alsa-info.sh
908 output (with --no-upload option) to kernel bugzilla or alsa-devel
Takashi Iwai62430082005-09-05 17:12:29 +0200909 ML (see the section "Links and Addresses").
910
Takashi Iwai3723e2d2007-09-17 19:08:32 +0200911 power_save and power_save_controller options are for power-saving
912 mode. See powersave.txt for details.
Takashi Iwaidee1b662007-08-13 16:10:30 +0200913
Takashi Iwaic74db862005-05-12 14:26:27 +0200914 Note 2: If you get click noises on output, try the module option
915 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
916 register value without FIFO size correction as the current
917 DMA pointer. position_fix=2 will make the driver to use
918 the position buffer instead of reading SD_LPIB register.
Michael Kerrisk90f31e32008-09-01 14:03:50 +0200919 (Usually SD_LPIB register is more accurate than the
Takashi Iwaic74db862005-05-12 14:26:27 +0200920 position buffer.)
921
Takashi Iwai27346162006-01-12 18:28:44 +0100922 NB: If you get many "azx_get_response timeout" messages at
923 loading, it's likely a problem of interrupts (e.g. ACPI irq
924 routing). Try to boot with options like "pci=noacpi". Also, you
925 can try "single_cmd=1" module option. This will switch the
926 communication method between HDA controller and codecs to the
927 single immediate commands instead of CORB/RIRB. Basically, the
928 single command mode is provided only for BIOS, and you won't get
929 unsolicited events, too. But, at least, this works independently
930 from the irq. Remember this is a last resort, and should be
931 avoided as much as possible...
932
Takashi Iwai95904742007-05-19 17:06:42 +0200933 MORE NOTES ON "azx_get_response timeout" PROBLEMS:
934 On some hardwares, you may need to add a proper probe_mask option
935 to avoid the "azx_get_response timeout" problem above, instead.
936 This occurs when the access to non-existing or non-working codec slot
937 (likely a modem one) causes a stall of the communication via HD-audio
938 bus. You can see which codec slots are probed by enabling
Takashi Iwai62cf8722008-05-20 12:15:15 +0200939 CONFIG_SND_DEBUG_VERBOSE, or simply from the file name of the codec
Takashi Iwai95904742007-05-19 17:06:42 +0200940 proc files. Then limit the slots to probe by probe_mask option.
941 For example, probe_mask=1 means to probe only the first slot, and
942 probe_mask=4 means only the third slot.
943
Takashi Iwaia4efc232005-11-17 17:24:26 +0100944 The power-management is supported.
945
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 Module snd-hdsp
947 ---------------
948
949 Module for RME Hammerfall DSP audio interface(s)
950
Clemens Ladisch0ef797c2005-11-21 07:30:20 +0100951 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
953 Note: The firmware data can be automatically loaded via hotplug
954 when CONFIG_FW_LOADER is set. Otherwise, you need to load
955 the firmware via hdsploader utility included in alsa-tools
956 package.
957 The firmware data is found in alsa-firmware package.
958
959 Note: snd-page-alloc module does the job which snd-hammerfall-mem
960 module did formerly. It will allocate the buffers in advance
961 when any HDSP cards are found. To make the buffer
962 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +0200963 stage of boot sequence. See "Early Buffer Allocation"
964 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
Takashi Iwai54704402005-06-03 11:27:00 +0200966 Module snd-hdspm
967 ----------------
968
969 Module for RME HDSP MADI board.
970
971 precise_ptr - Enable precise pointer, or disable.
972 line_outs_monitor - Send playback streams to analog outs by default.
973 enable_monitor - Enable Analog Out on Channel 63/64 by default.
974
975 See hdspm.txt for details.
976
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977 Module snd-ice1712
978 ------------------
979
980 Module for Envy24 (ICE1712) based PCI sound cards.
981 * MidiMan M Audio Delta 1010
982 * MidiMan M Audio Delta 1010LT
983 * MidiMan M Audio Delta DiO 2496
984 * MidiMan M Audio Delta 66
985 * MidiMan M Audio Delta 44
986 * MidiMan M Audio Delta 410
987 * MidiMan M Audio Audiophile 2496
988 * TerraTec EWS 88MT
989 * TerraTec EWS 88D
990 * TerraTec EWX 24/96
991 * TerraTec DMX 6Fire
Takashi Iwaic9bce912005-05-24 13:41:03 +0200992 * TerraTec Phase 88
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 * Hoontech SoundTrack DSP 24
994 * Hoontech SoundTrack DSP 24 Value
995 * Hoontech SoundTrack DSP 24 Media 7.1
Takashi Iwaic9bce912005-05-24 13:41:03 +0200996 * Event Electronics, EZ8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997 * Digigram VX442
Takashi Iwaic9bce912005-05-24 13:41:03 +0200998 * Lionstracs, Mediastaton
Alexander Beregalov6ef10902008-08-13 00:10:55 +0400999 * Terrasoniq TS 88
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000
1001 model - Use the given board model, one of the following:
1002 delta1010, dio2496, delta66, delta44, audiophile, delta410,
1003 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
Takashi Iwaic9bce912005-05-24 13:41:03 +02001004 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
1005 phase88, mediastation
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 omni - Omni I/O support for MidiMan M-Audio Delta44/66
Matt LaPlantefa00e7e2006-11-30 04:55:36 +01001007 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transceiver)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 in msec resolution, default value is 500 (0.5 sec)
1009
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001010 This module supports multiple cards and autoprobe. Note: The consumer part
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 is not used with all Envy24 based cards (for example in the MidiMan Delta
1012 serie).
1013
Takashi Iwaic9bce912005-05-24 13:41:03 +02001014 Note: The supported board is detected by reading EEPROM or PCI
1015 SSID (if EEPROM isn't available). You can override the
1016 model by passing "model" module option in case that the
1017 driver isn't configured properly or you want to try another
1018 type for testing.
1019
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020 Module snd-ice1724
1021 ------------------
1022
Takashi Iwaic9bce912005-05-24 13:41:03 +02001023 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +01001024 * MidiMan M Audio Revolution 5.1
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 * MidiMan M Audio Revolution 7.1
Takashi Iwai56255062006-11-09 16:47:26 +01001026 * MidiMan M Audio Audiophile 192
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 * AMP Ltd AUDIO2000
Takashi Iwaic9bce912005-05-24 13:41:03 +02001028 * TerraTec Aureon 5.1 Sky
1029 * TerraTec Aureon 7.1 Space
1030 * TerraTec Aureon 7.1 Universe
1031 * TerraTec Phase 22
1032 * TerraTec Phase 28
1033 * AudioTrak Prodigy 7.1
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001034 * AudioTrak Prodigy 7.1 LT
1035 * AudioTrak Prodigy 7.1 XT
1036 * AudioTrak Prodigy 7.1 HIFI
1037 * AudioTrak Prodigy 7.1 HD2
Takashi Iwaic9bce912005-05-24 13:41:03 +02001038 * AudioTrak Prodigy 192
1039 * Pontis MS300
1040 * Albatron K8X800 Pro II
1041 * Chaintech ZNF3-150
1042 * Chaintech ZNF3-250
1043 * Chaintech 9CJS
Takashi Iwai8cfbbac2005-05-27 12:10:40 +02001044 * Chaintech AV-710
Takashi Iwaic9bce912005-05-24 13:41:03 +02001045 * Shuttle SN25P
Shin-ya Okadaf31639b2007-10-23 15:08:18 +02001046 * Onkyo SE-90PCI
1047 * Onkyo SE-200PCI
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001048 * ESI Juli@
Takashi Iwai72cbfd42009-05-06 17:33:19 +02001049 * ESI Maya44
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001050 * Hercules Fortissimo IV
1051 * EGO-SYS WaveTerminal 192M
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052
1053 model - Use the given board model, one of the following:
Takashi Iwai7a6c8ff2006-01-13 13:56:33 +01001054 revo51, revo71, amp2000, prodigy71, prodigy71lt,
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001055 prodigy71xt, prodigy71hifi, prodigyhd2, prodigy192,
1056 juli, aureon51, aureon71, universe, ap192, k8x800,
1057 phase22, phase28, ms300, av710, se200pci, se90pci,
Takashi Iwai72cbfd42009-05-06 17:33:19 +02001058 fortissimo4, sn25p, WT192M, maya44
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001060 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061
Takashi Iwaic9bce912005-05-24 13:41:03 +02001062 Note: The supported board is detected by reading EEPROM or PCI
1063 SSID (if EEPROM isn't available). You can override the
1064 model by passing "model" module option in case that the
1065 driver isn't configured properly or you want to try another
1066 type for testing.
1067
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001068 Module snd-indigo
1069 -----------------
1070
1071 Module for Echoaudio Indigo
1072
1073 This module supports multiple cards.
1074 The driver requires the firmware loader support on kernel.
1075
1076 Module snd-indigodj
1077 -------------------
1078
1079 Module for Echoaudio Indigo DJ
1080
1081 This module supports multiple cards.
1082 The driver requires the firmware loader support on kernel.
1083
1084 Module snd-indigoio
1085 -------------------
1086
1087 Module for Echoaudio Indigo IO
1088
1089 This module supports multiple cards.
1090 The driver requires the firmware loader support on kernel.
1091
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 Module snd-intel8x0
1093 -------------------
1094
1095 Module for AC'97 motherboards from Intel and compatibles.
1096 * Intel i810/810E, i815, i820, i830, i84x, MX440
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001097 ICH5, ICH6, ICH7, 6300ESB, ESB2
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 * SiS 7012 (SiS 735)
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001099 * NVidia NForce, NForce2, NForce3, MCP04, CK804
1100 CK8, CK8S, MCP501
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 * AMD AMD768, AMD8111
1102 * ALi m5455
1103
1104 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1105 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001106 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107 buggy_irq - Enable workaround for buggy interrupts on some
Takashi Iwaia06147d2005-09-08 19:54:17 +02001108 motherboards (default yes on nForce chips,
1109 otherwise off)
1110 buggy_semaphore - Enable workaround for hardwares with buggy
1111 semaphores (e.g. on some ASUS laptops)
1112 (default off)
Takashi Iwai6c5cfd92006-11-28 17:18:25 +01001113 spdif_aclink - Use S/PDIF over AC-link instead of direct connection
1114 from the controller chip
1115 (0 = off, 1 = on, -1 = default)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001117 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001118
1119 Note: the latest driver supports auto-detection of chip clock.
1120 if you still encounter too fast playback, specify the clock
1121 explicitly via the module option "ac97_clock=41194".
1122
1123 Joystick/MIDI ports are not supported by this driver. If your
1124 motherboard has these devices, use the ns558 or snd-mpu401
1125 modules, respectively.
1126
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 The power-management is supported.
1128
1129 Module snd-intel8x0m
1130 --------------------
1131
1132 Module for Intel ICH (i8x0) chipset MC97 modems.
Takashi Iwai89ac9c22006-01-24 10:36:57 +01001133 * Intel i810/810E, i815, i820, i830, i84x, MX440
1134 ICH5, ICH6, ICH7
1135 * SiS 7013 (SiS 735)
1136 * NVidia NForce, NForce2, NForce2s, NForce3
1137 * AMD AMD8111
1138 * ALi m5455
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139
1140 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1141
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001142 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143
1144 Note: The default index value of this module is -2, i.e. the first
1145 slot is excluded.
1146
Takashi Iwaia4efc232005-11-17 17:24:26 +01001147 The power-management is supported.
1148
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 Module snd-interwave
1150 --------------------
1151
1152 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1153 and other sound cards based on AMD InterWave (tm) chip.
1154
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1156 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1157 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1158 effect - 1 = InterWave effects enable (default 0);
1159 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001160 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1161
1162 with isapnp=0, the following options are available:
1163
1164 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1165 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1166 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1167 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001169 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001170
1171 Module snd-interwave-stb
1172 ------------------------
1173
1174 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1175 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1176 circuit for extended control of bass, treble and master volume.
1177
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1179 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1180 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1181 effect - 1 = InterWave effects enable (default 0);
1182 requires 8 voices
Rene Herman64e0e2d2007-12-13 16:29:33 +01001183 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1184
1185 with isapnp=0, the following options are available:
1186
1187 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1188 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1189 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1190 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1191 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001193 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194
Krzysztof Helt44eba3e2009-12-23 18:02:41 +01001195 Module snd-jazz16
1196 -------------------
1197
1198 Module for Media Vision Jazz16 chipset. The chipset consists of 3 chips:
1199 MVD1216 + MVA416 + MVA514.
1200
1201 port - port # for SB DSP chip (0x210,0x220,0x230,0x240,0x250,0x260)
1202 irq - IRQ # for SB DSP chip (3,5,7,9,10,15)
1203 dma8 - DMA # for SB DSP chip (1,3)
1204 dma16 - DMA # for SB DSP chip (5,7)
1205 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1206 mpu_irq - MPU-401 irq # (2,3,5,7)
1207
1208 This module supports multiple cards.
1209
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 Module snd-korg1212
1211 -------------------
1212
1213 Module for Korg 1212 IO PCI card
1214
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001215 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001217 Module snd-layla20
1218 ------------------
1219
1220 Module for Echoaudio Layla20
1221
1222 This module supports multiple cards.
1223 The driver requires the firmware loader support on kernel.
1224
1225 Module snd-layla24
1226 ------------------
1227
1228 Module for Echoaudio Layla24
1229
1230 This module supports multiple cards.
1231 The driver requires the firmware loader support on kernel.
1232
Takashi Iwai8338c302009-04-14 12:30:36 +02001233 Module snd-lx6464es
1234 -------------------
1235
1236 Module for Digigram LX6464ES boards
1237
1238 This module supports multiple cards.
1239
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240 Module snd-maestro3
1241 -------------------
1242
1243 Module for Allegro/Maestro3 chips
1244
1245 external_amp - enable external amp (enabled by default)
1246 amp_gpio - GPIO pin number for external amp (0-15) or
1247 -1 for default pin (8 for allegro, 1 for
1248 others)
1249
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001250 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251
1252 Note: the binding of amplifier is dependent on hardware.
1253 If there is no sound even though all channels are unmuted, try to
1254 specify other gpio connection via amp_gpio option.
1255 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1256 option.
1257
1258 The power-management is supported.
1259
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001260 Module snd-mia
1261 ---------------
1262
1263 Module for Echoaudio Mia
1264
1265 This module supports multiple cards.
1266 The driver requires the firmware loader support on kernel.
1267
Martin Langer1841f6132006-03-27 12:41:01 +02001268 Module snd-miro
1269 ---------------
1270
1271 Module for Miro soundcards: miroSOUND PCM 1 pro,
1272 miroSOUND PCM 12,
1273 miroSOUND PCM 20 Radio.
1274
1275 port - Port # (0x530,0x604,0xe80,0xf40)
1276 irq - IRQ # (5,7,9,10,11)
1277 dma1 - 1st dma # (0,1,3)
1278 dma2 - 2nd dma # (0,1)
1279 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1280 mpu_irq - MPU-401 irq # (5,7,9,10)
1281 fm_port - FM Port # (0x388)
1282 wss - enable WSS mode
1283 ide - enable onboard ide support
1284
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 Module snd-mixart
1286 -----------------
1287
1288 Module for Digigram miXart8 sound cards.
1289
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001290 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 Note: One miXart8 board will be represented as 4 alsa cards.
1292 See MIXART.txt for details.
1293
1294 When the driver is compiled as a module and the hotplug firmware
1295 is supported, the firmware data is loaded via hotplug automatically.
1296 Install the necessary firmware files in alsa-firmware package.
1297 When no hotplug fw loader is available, you need to load the
1298 firmware via mixartloader utility in alsa-tools package.
1299
Giuliano Pochinidd7b2542006-06-28 13:53:41 +02001300 Module snd-mona
1301 ---------------
1302
1303 Module for Echoaudio Mona
1304
1305 This module supports multiple cards.
1306 The driver requires the firmware loader support on kernel.
1307
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 Module snd-mpu401
1309 -----------------
1310
1311 Module for MPU-401 UART devices.
1312
1313 port - port number or -1 (disable)
1314 irq - IRQ number or -1 (disable)
1315 pnp - PnP detection - 0 = disable, 1 = enable (default)
1316
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001317 This module supports multiple devices and PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318
Takashi Iwaic96330b2009-01-28 08:23:03 +01001319 Module snd-msnd-classic
1320 -----------------------
1321
1322 Module for Turtle Beach MultiSound Classic, Tahiti or Monterey
1323 soundcards.
1324
1325 io - Port # for msnd-classic card
1326 irq - IRQ # for msnd-classic card
1327 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1328 0xe0000 or 0xe8000)
1329 write_ndelay - enable write ndelay (default = 1)
1330 calibrate_signal - calibrate signal (default = 0)
1331 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1332 digital - Digital daughterboard present (default = 0)
1333 cfg - Config port (0x250, 0x260 or 0x270) default = PnP
1334 reset - Reset all devices
1335 mpu_io - MPU401 I/O port
1336 mpu_irq - MPU401 irq#
1337 ide_io0 - IDE port #0
1338 ide_io1 - IDE port #1
1339 ide_irq - IDE irq#
1340 joystick_io - Joystick I/O port
1341
1342 The driver requires firmware files "turtlebeach/msndinit.bin" and
1343 "turtlebeach/msndperm.bin" in the proper firmware directory.
1344
1345 See Documentation/sound/oss/MultiSound for important information
1346 about this driver. Note that it has been discontinued, but the
1347 Voyetra Turtle Beach knowledge base entry for it is still available
1348 at
Justin P. Mattock0ea6e612010-07-23 20:51:24 -07001349 http://www.turtlebeach.com
Takashi Iwaic96330b2009-01-28 08:23:03 +01001350
1351 Module snd-msnd-pinnacle
1352 ------------------------
1353
1354 Module for Turtle Beach MultiSound Pinnacle/Fiji soundcards.
1355
1356 io - Port # for pinnacle/fiji card
1357 irq - IRQ # for pinnalce/fiji card
1358 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1359 0xe0000 or 0xe8000)
1360 write_ndelay - enable write ndelay (default = 1)
1361 calibrate_signal - calibrate signal (default = 0)
1362 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1363
1364 The driver requires firmware files "turtlebeach/pndspini.bin" and
1365 "turtlebeach/pndsperm.bin" in the proper firmware directory.
1366
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 Module snd-mtpav
1368 ----------------
1369
1370 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1371 port).
1372
1373 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1374 irq - IRQ # for MTPAV (7,5, default=7)
1375 hwports - number of supported hardware ports, default=8.
1376
1377 Module supports only 1 card. This module has no enable option.
1378
Matthias Koenig68ab8012006-07-27 16:59:23 +02001379 Module snd-mts64
1380 ----------------
1381
1382 Module for Ego Systems (ESI) Miditerminal 4140
1383
1384 This module supports multiple devices.
1385 Requires parport (CONFIG_PARPORT).
1386
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 Module snd-nm256
1388 ----------------
1389
1390 Module for NeoMagic NM256AV/ZX chips
1391
1392 playback_bufsize - max playback frame size in kB (4-128kB)
1393 capture_bufsize - max capture frame size in kB (4-128kB)
1394 force_ac97 - 0 or 1 (disabled by default)
1395 buffer_top - specify buffer top address
1396 use_cache - 0 or 1 (disabled by default)
1397 vaio_hack - alias buffer_top=0x25a800
1398 reset_workaround - enable AC97 RESET workaround for some laptops
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001399 reset_workaround2 - enable extended AC97 RESET workaround for some
1400 other laptops
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401
Takashi Iwai8a3fb4d2005-10-20 17:10:49 +02001402 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403
1404 The power-management is supported.
1405
1406 Note: on some notebooks the buffer address cannot be detected
1407 automatically, or causes hang-up during initialization.
Matt LaPlantefff92892006-10-03 22:47:42 +02001408 In such a case, specify the buffer top address explicitly via
1409 the buffer_top option.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 For example,
1411 Sony F250: buffer_top=0x25a800
1412 Sony F270: buffer_top=0x272800
1413 The driver supports only ac97 codec. It's possible to force
1414 to initialize/use ac97 although it's not detected. In such a
1415 case, use force_ac97=1 option - but *NO* guarantee whether it
1416 works!
1417
1418 Note: The NM256 chip can be linked internally with non-AC97
1419 codecs. This driver supports only the AC97 codec, and won't work
1420 with machines with other (most likely CS423x or OPL3SAx) chips,
1421 even though the device is detected in lspci. In such a case, try
1422 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
Takashi Iwai62430082005-09-05 17:12:29 +02001423 but some doesn't have ISA PnP. You'll need to specify isapnp=0
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424 and proper hardware parameters in the case without ISA PnP.
1425
1426 Note: some laptops need a workaround for AC97 RESET. For the
1427 known hardware like Dell Latitude LS and Sony PCG-F305, this
1428 workaround is enabled automatically. For other laptops with a
1429 hard freeze, you can try reset_workaround=1 option.
1430
Takashi Iwaid1f38cf2005-10-19 16:04:27 +02001431 Note: Dell Latitude CSx laptops have another problem regarding
1432 AC97 RESET. On these laptops, reset_workaround2 option is
1433 turned on as default. This option is worth to try if the
1434 previous reset_workaround option doesn't help.
1435
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436 Note: This driver is really crappy. It's a porting from the
1437 OSS driver, which is a result of black-magic reverse engineering.
1438 The detection of codec will fail if the driver is loaded *after*
1439 X-server as described above. You might be able to force to load
1440 the module, but it may result in hang-up. Hence, make sure that
1441 you load this module *before* X if you encounter this kind of
1442 problem.
1443
1444 Module snd-opl3sa2
1445 ------------------
1446
1447 Module for Yamaha OPL3-SA2/SA3 sound cards.
1448
Rene Herman64e0e2d2007-12-13 16:29:33 +01001449 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1450
1451 with isapnp=0, the following options are available:
1452
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 port - control port # for OPL3-SA chip (0x370)
1454 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1455 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1456 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1457 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1458 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1459 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1460 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001462 This module supports multiple cards and ISA PnP. It does not support
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1464
1465 The power-management is supported.
1466
1467 Module snd-opti92x-ad1848
1468 -------------------------
1469
1470 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1471 Module works with OAK Mozart cards as well.
1472
Rene Herman64e0e2d2007-12-13 16:29:33 +01001473 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1474
1475 with isapnp=0, the following options are available:
1476
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1478 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1479 fm_port - port # for OPL3 device (0x388)
1480 irq - IRQ # for WSS chip (5,7,9,10,11)
1481 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1482 dma1 - first DMA # for WSS chip (0,1,3)
1483
1484 This module supports only one card, autoprobe and PnP.
1485
1486 Module snd-opti92x-cs4231
1487 -------------------------
1488
1489 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1490
Rene Herman64e0e2d2007-12-13 16:29:33 +01001491 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1492
1493 with isapnp=0, the following options are available:
1494
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1496 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1497 fm_port - port # for OPL3 device (0x388)
1498 irq - IRQ # for WSS chip (5,7,9,10,11)
1499 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1500 dma1 - first DMA # for WSS chip (0,1,3)
1501 dma2 - second DMA # for WSS chip (0,1,3)
1502
1503 This module supports only one card, autoprobe and PnP.
1504
1505 Module snd-opti93x
1506 ------------------
1507
1508 Module for sound cards based on OPTi 82c93x chips.
1509
Rene Herman64e0e2d2007-12-13 16:29:33 +01001510 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1511
1512 with isapnp=0, the following options are available:
1513
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1515 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1516 fm_port - port # for OPL3 device (0x388)
1517 irq - IRQ # for WSS chip (5,7,9,10,11)
1518 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1519 dma1 - first DMA # for WSS chip (0,1,3)
1520 dma2 - second DMA # for WSS chip (0,1,3)
1521
1522 This module supports only one card, autoprobe and PnP.
1523
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001524 Module snd-oxygen
1525 -----------------
1526
Clemens Ladisch45c1de82010-11-02 17:08:37 +01001527 Module for sound cards based on the C-Media CMI8787/8788 chip:
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001528 * Asound A-8788
1529 * AuzenTech X-Meridian
1530 * Bgears b-Enspirer
1531 * Club3D Theatron DTS
Clemens Ladischde04b102008-11-26 10:37:23 +01001532 * HT-Omega Claro (plus)
1533 * HT-Omega Claro halo (XT)
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001534 * Razer Barracuda AC-1
1535 * Sondigo Inferno
Clemens Ladisch45c1de82010-11-02 17:08:37 +01001536 * TempoTec HiFier Fantasia
Clemens Ladisch48a8a262008-01-21 08:43:06 +01001537
1538 This module supports autoprobe and multiple cards.
1539
Stas Sergeevd08cd582008-03-06 11:01:44 +01001540 Module snd-pcsp
1541 -----------------
1542
1543 Module for internal PC-Speaker.
1544
Stas Sergeevbcc2c6b2009-11-01 11:13:19 +01001545 nopcm - Disable PC-Speaker PCM sound. Only beeps remain.
Stas Sergeevd08cd582008-03-06 11:01:44 +01001546 nforce_wa - enable NForce chipset workaround. Expect bad sound.
1547
1548 This module supports system beeps, some kind of PCM playback and
1549 even a few mixer controls.
1550
Markus Bollingere12229b2005-12-06 13:55:26 +01001551 Module snd-pcxhr
1552 ----------------
1553
1554 Module for Digigram PCXHR boards
1555
1556 This module supports multiple cards.
1557
Matthias Koenig757e1192007-01-25 13:15:05 +01001558 Module snd-portman2x4
1559 ---------------------
1560
1561 Module for Midiman Portman 2x4 parallel port MIDI interface
1562
1563 This module supports multiple cards.
1564
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 Module snd-powermac (on ppc only)
1566 ---------------------------------
1567
1568 Module for PowerMac, iMac and iBook on-board soundchips
1569
1570 enable_beep - enable beep using PCM (enabled as default)
1571
1572 Module supports autoprobe a chip.
1573
1574 Note: the driver may have problems regarding endianess.
1575
1576 The power-management is supported.
1577
Takashi Iwai2c484df2005-06-30 18:54:04 +02001578 Module snd-pxa2xx-ac97 (on arm only)
1579 ------------------------------------
1580
1581 Module for AC97 driver for the Intel PXA2xx chip
1582
1583 For ARM architecture only.
1584
Takashi Iwaia4efc232005-11-17 17:24:26 +01001585 The power-management is supported.
1586
Peter Gruber109a9632006-03-27 13:10:28 +02001587 Module snd-riptide
1588 ------------------
1589
1590 Module for Conexant Riptide chip
1591
1592 joystick_port - Joystick port # (default: 0x200)
1593 mpu_port - MPU401 port # (default: 0x330)
1594 opl3_port - OPL3 port # (default: 0x388)
1595
1596 This module supports multiple cards.
1597 The driver requires the firmware loader support on kernel.
1598 You need to install the firmware file "riptide.hex" to the standard
1599 firmware path (e.g. /lib/firmware).
1600
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 Module snd-rme32
1602 ----------------
1603
1604 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1605 Prodif96 and Prodif Gold) sound cards.
1606
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001607 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608
1609 Module snd-rme96
1610 ----------------
1611
1612 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1613
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001614 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615
1616 Module snd-rme9652
1617 ------------------
1618
1619 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1620
1621 precise_ptr - Enable precise pointer (doesn't work reliably).
1622 (default = 0)
1623
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001624 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625
1626 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1627 module did formerly. It will allocate the buffers in advance
1628 when any RME9652 cards are found. To make the buffer
1629 allocation sure, load snd-page-alloc module in the early
Takashi Iwaib6a96912005-05-30 18:27:03 +02001630 stage of boot sequence. See "Early Buffer Allocation"
1631 section.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632
1633 Module snd-sa11xx-uda1341 (on arm only)
1634 ---------------------------------------
1635
1636 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1637
1638 Module supports only one card.
1639 Module has no enable and index options.
1640
Takashi Iwaia4efc232005-11-17 17:24:26 +01001641 The power-management is supported.
1642
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 Module snd-sb8
1644 --------------
1645
1646 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1647 SoundBlaster 2.0,
1648 SoundBlaster Pro
1649
1650 port - port # for SB DSP chip (0x220,0x240,0x260)
1651 irq - IRQ # for SB DSP chip (5,7,9,10)
1652 dma8 - DMA # for SB DSP chip (1,3)
1653
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001654 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655
Takashi Iwaia4efc232005-11-17 17:24:26 +01001656 The power-management is supported.
1657
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 Module snd-sb16 and snd-sbawe
1659 -----------------------------
1660
1661 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1662 SoundBlaster AWE 32 (PnP),
1663 SoundBlaster AWE 64 PnP
1664
Rene Herman64e0e2d2007-12-13 16:29:33 +01001665 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1666 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1667 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1668
1669 with isapnp=0, the following options are available:
1670
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1672 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1673 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1674 (snd-sbawe module only)
1675 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1676 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1677 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001679 This module supports multiple cards, autoprobe and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680
1681 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1682 disable 16bit DMA with dma16 = -1 module parameter.
1683 Also, all Sound Blaster 16 type cards can operate in 16-bit
1684 half duplex mode through 8-bit DMA channel by disabling their
1685 16-bit DMA channel.
1686
Takashi Iwaia4efc232005-11-17 17:24:26 +01001687 The power-management is supported.
1688
Takashi Iwai074a6e92007-09-11 22:10:14 +02001689 Module snd-sc6000
1690 -----------------
1691
Krzysztof Heltb0ec3a32009-05-03 10:39:19 +02001692 Module for Gallant SC-6000 soundcard and later models: SC-6600
1693 and SC-7000.
Takashi Iwai074a6e92007-09-11 22:10:14 +02001694
1695 port - Port # (0x220 or 0x240)
1696 mss_port - MSS Port # (0x530 or 0xe80)
1697 irq - IRQ # (5,7,9,10,11)
Krzysztof Helt7b758d22007-09-17 14:42:49 +02001698 mpu_irq - MPU-401 IRQ # (5,7,9,10) ,0 - no MPU-401 irq
Takashi Iwai074a6e92007-09-11 22:10:14 +02001699 dma - DMA # (1,3,0)
Krzysztof Heltb0ec3a32009-05-03 10:39:19 +02001700 joystick - Enable gameport - 0 = disable (default), 1 = enable
Takashi Iwai074a6e92007-09-11 22:10:14 +02001701
1702 This module supports multiple cards.
1703
1704 This card is also known as Audio Excel DSP 16 or Zoltrix AV302.
1705
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 Module snd-sscape
1707 -----------------
1708
Krzysztof Heltacd471002009-10-01 00:10:34 +02001709 Module for ENSONIQ SoundScape cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710
1711 port - Port # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001712 wss_port - WSS Port # (PnP setup)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001713 irq - IRQ # (PnP setup)
1714 mpu_irq - MPU-401 IRQ # (PnP setup)
1715 dma - DMA # (PnP setup)
Takashi Iwaiadf12952007-09-17 16:26:16 +02001716 dma2 - 2nd DMA # (PnP setup, -1 to disable)
Krzysztof Helt1cb0fde2009-10-05 18:18:57 +02001717 joystick - Enable gameport - 0 = disable (default), 1 = enable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001718
Krzysztof Heltacd471002009-10-01 00:10:34 +02001719 This module supports multiple cards.
1720
1721 The driver requires the firmware loader support on kernel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722
1723 Module snd-sun-amd7930 (on sparc only)
1724 --------------------------------------
1725
1726 Module for AMD7930 sound chips found on Sparcs.
1727
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001728 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729
1730 Module snd-sun-cs4231 (on sparc only)
1731 -------------------------------------
1732
1733 Module for CS4231 sound chips found on Sparcs.
1734
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001735 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001736
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001737 Module snd-sun-dbri (on sparc only)
1738 -----------------------------------
1739
1740 Module for DBRI sound chips found on Sparcs.
1741
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001742 This module supports multiple cards.
Takashi Iwai1bd9deb2005-06-30 18:26:20 +02001743
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744 Module snd-wavefront
1745 --------------------
1746
1747 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1748
Rene Herman64e0e2d2007-12-13 16:29:33 +01001749 use_cs4232_midi - Use CS4232 MPU-401 interface
1750 (inaccessibly located inside your computer)
1751 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1752
1753 with isapnp=0, the following options are available:
1754
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 cs4232_pcm_port - Port # for CS4232 PCM interface.
1756 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1757 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1758 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 ics2115_port - Port # for ICS2115
1760 ics2115_irq - IRQ # for ICS2115
1761 fm_port - FM OPL-3 Port #
1762 dma1 - DMA1 # for CS4232 PCM interface.
1763 dma2 - DMA2 # for CS4232 PCM interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764
Takashi Iwaic2b12392007-08-21 15:20:26 +02001765 The below are options for wavefront_synth features:
1766 wf_raw - Assume that we need to boot the OS (default:no)
1767 If yes, then during driver loading, the state of the board is
1768 ignored, and we reset the board and load the firmware anyway.
1769 fx_raw - Assume that the FX process needs help (default:yes)
1770 If false, we'll leave the FX processor in whatever state it is
1771 when the driver is loaded. The default is to download the
1772 microprogram and associated coefficients to set it up for
1773 "default" operation, whatever that means.
1774 debug_default - Debug parameters for card initialization
1775 wait_usecs - How long to wait without sleeping, usecs
1776 (default:150)
1777 This magic number seems to give pretty optimal throughput
1778 based on my limited experimentation.
1779 If you want to play around with it and find a better value, be
1780 my guest. Remember, the idea is to get a number that causes us
1781 to just busy wait for as many WaveFront commands as possible,
1782 without coming up with a number so large that we hog the whole
1783 CPU.
1784 Specifically, with this number, out of about 134,000 status
1785 waits, only about 250 result in a sleep.
1786 sleep_interval - How long to sleep when waiting for reply
1787 (default: 100)
1788 sleep_tries - How many times to try sleeping during a wait
1789 (default: 50)
1790 ospath - Pathname to processed ICS2115 OS firmware
1791 (default:wavefront.os)
1792 The path name of the ISC2115 OS firmware. In the recent
1793 version, it's handled via firmware loader framework, so it
1794 must be installed in the proper path, typically,
1795 /lib/firmware.
1796 reset_time - How long to wait for a reset to take effect
1797 (default:2)
1798 ramcheck_time - How many seconds to wait for the RAM test
1799 (default:20)
1800 osrun_time - How many seconds to wait for the ICS2115 OS
1801 (default:10)
1802
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001803 This module supports multiple cards and ISA PnP.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804
Takashi Iwaic2b12392007-08-21 15:20:26 +02001805 Note: the firmware file "wavefront.os" was located in the earlier
1806 version in /etc. Now it's loaded via firmware loader, and
1807 must be in the proper firmware path, such as /lib/firmware.
1808 Copy (or symlink) the file appropriately if you get an error
1809 regarding firmware downloading after upgrading the kernel.
1810
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811 Module snd-sonicvibes
1812 ---------------------
1813
1814 Module for S3 SonicVibes PCI sound cards.
1815 * PINE Schubert 32 PCI
1816
1817 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1818 - SoundCard must have onboard SRAM for this.
1819 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1820
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001821 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822
1823 Module snd-serial-u16550
1824 ------------------------
1825
1826 Module for UART16550A serial MIDI ports.
1827
1828 port - port # for UART16550A chip
1829 irq - IRQ # for UART16550A chip, -1 = poll mode
1830 speed - speed in bauds (9600,19200,38400,57600,115200)
1831 38400 = default
1832 base - base for divisor in bauds (57600,115200,230400,460800)
1833 115200 = default
1834 outs - number of MIDI ports in a serial port (1-4)
1835 1 = default
1836 adaptor - Type of adaptor.
1837 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1838 3 = MS-124W M/B, 4 = Generic
1839
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001840 This module supports multiple cards. This module does not support autoprobe
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 thus the main port must be specified!!! Other options are optional.
1842
1843 Module snd-trident
1844 ------------------
1845
1846 Module for Trident 4DWave DX/NX sound cards.
1847 * Best Union Miss Melody 4DWave PCI
1848 * HIS 4DWave PCI
1849 * Warpspeed ONSpeed 4DWave PCI
1850 * AzTech PCI 64-Q3D
1851 * Addonics SV 750
1852 * CHIC True Sound 4Dwave
1853 * Shark Predator4D-PCI
1854 * Jaton SonicWave 4D
Alexander Beregalov6ef10902008-08-13 00:10:55 +04001855 * SiS SI7018 PCI Audio
1856 * Hoontech SoundTrack Digital 4DWave NX
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857
1858 pcm_channels - max channels (voices) reserved for PCM
1859 wavetable_size - max wavetable size in kB (4-?kb)
1860
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001861 This module supports multiple cards and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862
1863 The power-management is supported.
1864
Clemens Ladisch63978ab2009-12-14 12:48:35 +01001865 Module snd-ua101
1866 ----------------
1867
Clemens Ladische584bc32010-03-01 16:20:37 +01001868 Module for the Edirol UA-101/UA-1000 audio/MIDI interfaces.
Clemens Ladisch63978ab2009-12-14 12:48:35 +01001869
1870 This module supports multiple devices, autoprobe and hotplugging.
1871
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872 Module snd-usb-audio
1873 --------------------
1874
1875 Module for USB audio and USB MIDI devices.
1876
1877 vid - Vendor ID for the device (optional)
1878 pid - Product ID for the device (optional)
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001879 nrpacks - Max. number of packets per URB (default: 8)
1880 async_unlink - Use async unlink mode (default: yes)
Thibault LE MEURe3113342006-03-14 11:44:53 +01001881 device_setup - Device specific magic number (optional)
1882 - Influence depends on the device
1883 - Default: 0x0000
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001884 ignore_ctl_error - Ignore any USB-controller regarding mixer
1885 interface (default: no)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001887 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001889 NB: nrpacks parameter can be modified dynamically via sysfs.
1890 Don't put the value over 20. Changing via sysfs has no sanity
1891 check.
1892 NB: async_unlink=0 would cause Oops. It remains just for
1893 debugging purpose (if any).
Takashi Iwai7a9b8062008-08-13 15:40:53 +02001894 NB: ignore_ctl_error=1 may help when you get an error at accessing
1895 the mixer element such as URB error -22. This happens on some
1896 buggy USB device or the controller.
Takashi Iwai8a8f2662008-08-13 15:27:43 +02001897
Daniel Mack523f1dc2007-03-26 19:11:24 +02001898 Module snd-usb-caiaq
1899 --------------------
1900
1901 Module for caiaq UB audio interfaces,
1902 * Native Instruments RigKontrol2
1903 * Native Instruments Kore Controller
1904 * Native Instruments Audio Kontrol 1
1905 * Native Instruments Audio 8 DJ
1906
1907 This module supports multiple devices, autoprobe and hotplugging.
1908
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 Module snd-usb-usx2y
1910 --------------------
1911
1912 Module for Tascam USB US-122, US-224 and US-428 devices.
1913
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001914 This module supports multiple devices, autoprobe and hotplugging.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915
1916 Note: you need to load the firmware via usx2yloader utility included
1917 in alsa-tools and alsa-firmware packages.
1918
1919 Module snd-via82xx
1920 ------------------
1921
1922 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001923 8233A, 8233C, 8235, 8237 (south) bridge.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924
1925 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1926 [VIA686A/686B only]
1927 joystick - Enable joystick (default off) [VIA686A/686B only]
1928 ac97_clock - AC'97 codec clock base (default 48000Hz)
1929 dxs_support - support DXS channels,
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001930 0 = auto (default), 1 = enable, 2 = disable,
1931 3 = 48k only, 4 = no VRA, 5 = enable any sample
1932 rate and different sample rates on different
1933 channels
1934 [VIA8233/C, 8235, 8237 only]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 ac97_quirk - AC'97 workaround for strange hardware
Takashi Iwai62430082005-09-05 17:12:29 +02001936 See "AC97 Quirk Option" section below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001938 This module supports one chip and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939
1940 Note: on some SMP motherboards like MSI 694D the interrupts might
1941 not be generated properly. In such a case, please try to
1942 set the SMP (or MPS) version on BIOS to 1.1 instead of
1943 default value 1.4. Then the interrupt number will be
1944 assigned under 15. You might also upgrade your BIOS.
1945
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001946 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947 channels as the first PCM. On these channels, up to 4
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001948 streams can be played at the same time, and the controller
1949 can perform sample rate conversion with separate rates for
1950 each channel.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951 As default (dxs_support = 0), 48k fixed rate is chosen
1952 except for the known devices since the output is often
1953 noisy except for 48k on some mother boards due to the
1954 bug of BIOS.
Sergey Vlasov2d7eb7c2005-04-11 15:04:33 +02001955 Please try once dxs_support=5 and if it works on other
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1957 know the PCI subsystem vendor/device id's (output of
1958 "lspci -nv").
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001959 If dxs_support=5 does not work, try dxs_support=4; if it
1960 doesn't work too, try dxs_support=1. (dxs_support=1 is
Takashi Iwai62430082005-09-05 17:12:29 +02001961 usually for old motherboards. The correct implemented
Takashi Iwaicdc27f32005-05-27 11:11:02 +02001962 board should work with 4 or 5.) If it still doesn't
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963 work and the default setting is ok, dxs_support=3 is the
1964 right choice. If the default setting doesn't work at all,
1965 try dxs_support=2 to disable the DXS channels.
1966 In any cases, please let us know the result and the
Takashi Iwai62430082005-09-05 17:12:29 +02001967 subsystem vendor/device ids. See "Links and Addresses"
1968 below.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969
1970 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
Takashi Iwai62430082005-09-05 17:12:29 +02001971 additionally. The mpu_port option is for VIA686 chips only.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972
Takashi Iwaia4efc232005-11-17 17:24:26 +01001973 The power-management is supported.
1974
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 Module snd-via82xx-modem
1976 ------------------------
1977
1978 Module for VIA82xx AC97 modem
1979
1980 ac97_clock - AC'97 codec clock base (default 48000Hz)
1981
Clemens Ladischb7fe4622005-10-04 08:46:51 +02001982 This module supports one card and autoprobe.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983
1984 Note: The default index value of this module is -2, i.e. the first
1985 slot is excluded.
1986
Takashi Iwaia4efc232005-11-17 17:24:26 +01001987 The power-management is supported.
1988
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 Module snd-virmidi
1990 ------------------
1991
1992 Module for virtual rawmidi devices.
1993 This module creates virtual rawmidi devices which communicate
1994 to the corresponding ALSA sequencer ports.
1995
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001996 midi_devs - MIDI devices # (1-4, default=4)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01001998 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999
Clemens Ladisch48a8a262008-01-21 08:43:06 +01002000 Module snd-virtuoso
2001 -------------------
2002
Clemens Ladisch5430c722008-07-28 10:28:43 +02002003 Module for sound cards based on the Asus AV100/AV200 chips,
Clemens Ladischd1db38c2010-01-18 15:44:04 +01002004 i.e., Xonar D1, DX, D2, D2X, DS, HDAV1.3 (Deluxe), Essence ST
Clemens Ladisch04f98902009-05-25 10:11:29 +02002005 (Deluxe) and Essence STX.
Clemens Ladisch48a8a262008-01-21 08:43:06 +01002006
2007 This module supports autoprobe and multiple cards.
2008
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009 Module snd-vx222
2010 ----------------
2011
2012 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
2013
2014 mic - Enable Microphone on V222 Mic (NYI)
2015 ibl - Capture IBL size. (default = 0, minimum size)
2016
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01002017 This module supports multiple cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018
2019 When the driver is compiled as a module and the hotplug firmware
2020 is supported, the firmware data is loaded via hotplug automatically.
2021 Install the necessary firmware files in alsa-firmware package.
2022 When no hotplug fw loader is available, you need to load the
2023 firmware via vxloader utility in alsa-tools package. To invoke
2024 vxloader automatically, add the following to /etc/modprobe.conf
2025
2026 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
2027
2028 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
2029 /etc/modules.conf, instead.)
2030 IBL size defines the interrupts period for PCM. The smaller size
2031 gives smaller latency but leads to more CPU consumption, too.
2032 The size is usually aligned to 126. As default (=0), the smallest
2033 size is chosen. The possible IBL values can be found in
2034 /proc/asound/cardX/vx-status proc file.
2035
Takashi Iwaia4efc232005-11-17 17:24:26 +01002036 The power-management is supported.
2037
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 Module snd-vxpocket
2039 -------------------
2040
Takashi Iwai6d00a312005-06-30 13:40:51 +02002041 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042
2043 ibl - Capture IBL size. (default = 0, minimum size)
2044
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01002045 This module supports multiple cards. The module is compiled only when
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046 PCMCIA is supported on kernel.
2047
Takashi Iwai62430082005-09-05 17:12:29 +02002048 With the older 2.6.x kernel, to activate the driver via the card
2049 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
2050 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
2051 longer require a config file.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002052
2053 When the driver is compiled as a module and the hotplug firmware
2054 is supported, the firmware data is loaded via hotplug automatically.
2055 Install the necessary firmware files in alsa-firmware package.
2056 When no hotplug fw loader is available, you need to load the
2057 firmware via vxloader utility in alsa-tools package.
2058
2059 About capture IBL, see the description of snd-vx222 module.
2060
Takashi Iwaied7cbe32006-05-11 11:30:10 +02002061 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
Takashi Iwai62430082005-09-05 17:12:29 +02002062 ALSA 1.0.10.
2063
Takashi Iwaia4efc232005-11-17 17:24:26 +01002064 The power-management is supported.
2065
Linus Torvalds1da177e2005-04-16 15:20:36 -07002066 Module snd-ymfpci
2067 -----------------
2068
2069 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
2070
2071 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
2072 1 (auto-detect for YMF744/754 only)
2073 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
2074 1 (auto-detect for YMF744/754 only)
2075 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
2076 1 (auto-detect)
2077 rear_switch - enable shared rear/line-in switch (bool)
2078
Clemens Ladisch0ef797c2005-11-21 07:30:20 +01002079 This module supports autoprobe and multiple chips.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080
2081 The power-management is supported.
2082
2083 Module snd-pdaudiocf
2084 --------------------
2085
2086 Module for Sound Core PDAudioCF sound card.
2087
Takashi Iwaia4efc232005-11-17 17:24:26 +01002088 The power-management is supported.
2089
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090
Takashi Iwai62430082005-09-05 17:12:29 +02002091AC97 Quirk Option
2092=================
2093
2094The ac97_quirk option is used to enable/override the workaround for
2095specific devices on drivers for on-board AC'97 controllers like
2096snd-intel8x0. Some hardware have swapped output pins between Master
2097and Headphone, or Surround (thanks to confusion of AC'97
2098specifications from version to version :-)
2099
2100The driver provides the auto-detection of known problematic devices,
2101but some might be unknown or wrongly detected. In such a case, pass
2102the proper value with this option.
2103
2104The following strings are accepted:
2105 - default Don't override the default setting
Takashi Iwai10e4097f2005-11-17 11:04:55 +01002106 - none Disable the quirk
Takashi Iwai62430082005-09-05 17:12:29 +02002107 - hp_only Bind Master and Headphone controls as a single control
2108 - swap_hp Swap headphone and master controls
2109 - swap_surround Swap master and surround controls
2110 - ad_sharing For AD1985, turn on OMS bit and use headphone
2111 - alc_jack For ALC65x, turn on the jack sense mode
2112 - inv_eapd Inverted EAPD implementation
2113 - mute_led Bind EAPD bit for turning on/off mute LED
2114
2115For backward compatibility, the corresponding integer value -1, 0,
2116... are accepted, too.
2117
2118For example, if "Master" volume control has no effect on your device
2119but only "Headphone" does, pass ac97_quirk=hp_only module option.
2120
2121
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122Configuring Non-ISAPNP Cards
2123============================
2124
2125When the kernel is configured with ISA-PnP support, the modules
2126supporting the isapnp cards will have module options "isapnp".
2127If this option is set, *only* the ISA-PnP devices will be probed.
2128For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
2129together with the proper i/o and irq configuration.
2130
2131When the kernel is configured without ISA-PnP support, isapnp option
2132will be not built in.
2133
2134
2135Module Autoloading Support
2136==========================
2137
2138The ALSA drivers can be loaded automatically on demand by defining
2139module aliases. The string 'snd-card-%1' is requested for ALSA native
2140devices where %i is sound card number from zero to seven.
2141
2142To auto-load an ALSA driver for OSS services, define the string
2143'sound-slot-%i' where %i means the slot number for OSS, which
2144corresponds to the card index of ALSA. Usually, define this
Tobias Klauserd533f672005-09-10 00:26:46 -07002145as the same card module.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146
2147An example configuration for a single emu10k1 card is like below:
2148----- /etc/modprobe.conf
2149alias snd-card-0 snd-emu10k1
2150alias sound-slot-0 snd-emu10k1
2151----- /etc/modprobe.conf
2152
2153The available number of auto-loaded sound cards depends on the module
2154option "cards_limit" of snd module. As default it's set to 1.
2155To enable the auto-loading of multiple cards, specify the number of
2156sound cards in that option.
2157
2158When multiple cards are available, it'd better to specify the index
2159number for each card via module option, too, so that the order of
2160cards is kept consistent.
2161
2162An example configuration for two sound cards is like below:
2163
2164----- /etc/modprobe.conf
2165# ALSA portion
2166options snd cards_limit=2
2167alias snd-card-0 snd-interwave
2168alias snd-card-1 snd-ens1371
2169options snd-interwave index=0
2170options snd-ens1371 index=1
2171# OSS/Free portion
2172alias sound-slot-0 snd-interwave
2173alias sound-slot-1 snd-ens1371
Matt LaPlante2fe0ae72006-10-03 22:50:39 +02002174----- /etc/modprobe.conf
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175
2176In this example, the interwave card is always loaded as the first card
2177(index 0) and ens1371 as the second (index 1).
2178
Takashi Iwai304cd072007-10-26 15:10:15 +02002179Alternative (and new) way to fixate the slot assignment is to use
2180"slots" option of snd module. In the case above, specify like the
2181following:
2182
2183options snd slots=snd-interwave,snd-ens1371
2184
2185Then, the first slot (#0) is reserved for snd-interwave driver, and
2186the second (#1) for snd-ens1371. You can omit index option in each
2187driver if slots option is used (although you can still have them at
2188the same time as long as they don't conflict).
2189
2190The slots option is especially useful for avoiding the possible
2191hot-plugging and the resultant slot conflict. For example, in the
2192case above again, the first two slots are already reserved. If any
2193other driver (e.g. snd-usb-audio) is loaded before snd-interwave or
2194snd-ens1371, it will be assigned to the third or later slot.
2195
Takashi Iwaia93bbaa2008-05-27 17:59:24 +02002196When a module name is given with '!', the slot will be given for any
2197modules but that name. For example, "slots=!snd-pcsp" will reserve
2198the first slot for any modules but snd-pcsp.
2199
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200
2201ALSA PCM devices to OSS devices mapping
2202=======================================
2203
2204/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
2205/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
2206/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
2207/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
2208/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
2209/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
2210/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
2211/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
2212/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
2213
2214The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
2215sound card number and second means device number. The ALSA devices
2216have either 'c' or 'p' suffix indicating the direction, capture and
2217playback, respectively.
2218
2219Please note that the device mapping above may be varied via the module
2220options of snd-pcm-oss module.
2221
2222
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223Proc interfaces (/proc/asound)
2224==============================
2225
2226/proc/asound/card#/pcm#[cp]/oss
2227-------------------------------
2228 String "erase" - erase all additional informations about OSS applications
2229 String "<app_name> <fragments> <fragment_size> [<options>]"
2230
2231 <app_name> - name of application with (higher priority) or without path
2232 <fragments> - number of fragments or zero if auto
2233 <fragment_size> - size of fragment in bytes or zero if auto
2234 <options> - optional parameters
2235 - disable the application tries to open a pcm device for
2236 this channel but does not want to use it.
2237 (Cause a bug or mmap needs)
2238 It's good for Quake etc...
2239 - direct don't use plugins
2240 - block force block mode (rvplayer)
2241 - non-block force non-block mode
2242 - whole-frag write only whole fragments (optimization affecting
2243 playback only)
2244 - no-silence do not fill silence ahead to avoid clicks
Takashi Iwai10f69f92005-09-08 13:48:34 +02002245 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
2246 instead of filled blocks
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247
2248 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
2249 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
2250 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
2251
2252
Takashi Iwaib6a96912005-05-30 18:27:03 +02002253Early Buffer Allocation
2254=======================
2255
2256Some drivers (e.g. hdsp) require the large contiguous buffers, and
2257sometimes it's too late to find such spaces when the driver module is
2258actually loaded due to memory fragmentation. You can pre-allocate the
2259PCM buffers by loading snd-page-alloc module and write commands to its
2260proc file in prior, for example, in the early boot stage like
2261/etc/init.d/*.local scripts.
2262
2263Reading the proc file /proc/drivers/snd-page-alloc shows the current
2264usage of page allocation. In writing, you can send the following
2265commands to the snd-page-alloc driver:
2266
2267 - add VENDOR DEVICE MASK SIZE BUFFERS
2268
2269 VENDOR and DEVICE are PCI vendor and device IDs. They take
2270 integer numbers (0x prefix is needed for the hex).
2271 MASK is the PCI DMA mask. Pass 0 if not restricted.
2272 SIZE is the size of each buffer to allocate. You can pass
2273 k and m suffix for KB and MB. The max number is 16MB.
2274 BUFFERS is the number of buffers to allocate. It must be greater
2275 than 0. The max number is 4.
2276
2277 - erase
2278
2279 This will erase the all pre-allocated buffers which are not in
2280 use.
2281
2282
Takashi Iwai62430082005-09-05 17:12:29 +02002283Links and Addresses
2284===================
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285
2286 ALSA project homepage
2287 http://www.alsa-project.org
2288
Takashi Iwai30bc4482008-12-09 08:23:45 +01002289 Kernel Bugzilla
2290 http://bugzilla.kernel.org/
Takashi Iwai62430082005-09-05 17:12:29 +02002291
2292 ALSA Developers ML
Rene Herman45051792007-03-21 12:05:06 +01002293 mailto:alsa-devel@alsa-project.org
Takashi Iwai30bc4482008-12-09 08:23:45 +01002294
2295 alsa-info.sh script
2296 http://www.alsa-project.org/alsa-info.sh