Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net-2.6
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / Documentation / sound / alsa / ALSA-Configuration.txt
CommitLineData
1da177e4
LT
1
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.
304cd07f
TI
60 slots - Reserve the slot index for the given driver.
61 This option takes multiple strings.
62 See "Module Autoloading Support" section for details.
36ce99c1
TI
63 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.
1da177e4
LT
69
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
6243008b 81 - Don't block opening busy PCM devices. Default: 1
1da177e4
LT
82
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
0ef797c5 111 - Values: 0 through 31 or negative
1da177e4
LT
112 - 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
cf40a310
RH
126 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
1da177e4
LT
154 Module snd-ad1816a
155 ------------------
156
157 Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips.
158
506d4c6a 159 clockfreq - Clock frequency for AD1816A chip (default = 0, 33000Hz)
1da177e4 160
0ef797c5 161 This module supports multiple cards, autoprobe and PnP.
1da177e4
LT
162
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
0ef797c5 172 This module supports multiple cards. It does not support autoprobe
1da177e4
LT
173 thus main port must be specified!!! Other ports are optional.
174
a4efc230
TI
175 The power-management is supported.
176
84010e6f
CL
177 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
0ef797c5 185 This module supports multiple cards.
84010e6f 186
1da177e4
LT
187 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
8a3fb4d0 196 This module supports one chip and autoprobe.
1da177e4
LT
197
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
0ef797c5 205 This module supports multiple cards, autoprobe and PnP.
1da177e4 206
a4efc230
TI
207 The power-management is supported.
208
b3a70d5e
AW
209 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
1da177e4
LT
218 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
0ef797c5 226 This module supports multiple cards, autoprobe and PnP.
1da177e4 227
a4efc230
TI
228 The power-management is supported.
229
719f82d3
EB
230 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
1da177e4
LT
240 Module snd-atiixp
241 -----------------
242
6243008b 243 Module for ATI IXP 150/200/250/400 AC97 controllers.
1da177e4 244
6243008b 245 ac97_clock - AC'97 clock (default = 48000)
1da177e4 246 ac97_quirk - AC'97 workaround for strange hardware
6243008b 247 See "AC97 Quirk Option" section below.
14e1d357
DC
248 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.
1da177e4
LT
254 spdif_aclink - S/PDIF transfer over AC-link (default = 1)
255
b7fe4622 256 This module supports one card and autoprobe.
1da177e4 257
6243008b
TI
258 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
a4efc230
TI
263 The power-management is supported.
264
1da177e4
LT
265 Module snd-atiixp-modem
266 -----------------------
267
268 Module for ATI IXP 150/200/250 AC97 modem controllers.
269
b7fe4622 270 This module supports one card and autoprobe.
1da177e4
LT
271
272 Note: The default index value of this module is -2, i.e. the first
273 slot is excluded.
274
a4efc230
TI
275 The power-management is supported.
276
1da177e4
LT
277 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
6243008b 299 Note: Some ALSA mixer applications don't handle the SPDIF sample rate
1da177e4
LT
300 control correctly. If you have problems regarding this, try
301 another ALSA compliant mixer (alsamixer works).
302
9e235323
TI
303 Module snd-aw2
304 --------------
305
306 Module for Audiowerk2 sound card
307
308 This module supports multiple cards.
309
1da177e4
LT
310 Module snd-azt2320
311 ------------------
312
313 Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
314
0ef797c5 315 This module supports multiple cards, PnP and autoprobe.
1da177e4 316
a4efc230
TI
317 The power-management is supported.
318
1da177e4
LT
319 Module snd-azt3328
320 ------------------
321
322 Module for sound cards based on Aztech AZF3328 PCI chip.
323
324 joystick - Enable joystick (default off)
325
0ef797c5 326 This module supports multiple cards.
1da177e4
LT
327
328 Module snd-bt87x
329 ----------------
330
331 Module for video cards based on Bt87x chips.
332
333 digital_rate - Override the default digital rate (Hz)
334 load_all - Load the driver even if the card model isn't known
335
0ef797c5 336 This module supports multiple cards.
1da177e4
LT
337
338 Note: The default index value of this module is -2, i.e. the first
339 slot is excluded.
340
341 Module snd-ca0106
342 -----------------
343
344 Module for Creative Audigy LS and SB Live 24bit
345
0ef797c5 346 This module supports multiple cards.
1da177e4
LT
347
348
349 Module snd-cmi8330
350 ------------------
351
352 Module for sound cards based on C-Media CMI8330 ISA chips.
353
64e0e2d9
RH
354 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
355
356 with isapnp=0, the following options are available:
357
1da177e4
LT
358 wssport - port # for CMI8330 chip (WSS)
359 wssirq - IRQ # for CMI8330 chip (WSS)
360 wssdma - first DMA # for CMI8330 chip (WSS)
361 sbport - port # for CMI8330 chip (SB16)
362 sbirq - IRQ # for CMI8330 chip (SB16)
363 sbdma8 - 8bit DMA # for CMI8330 chip (SB16)
364 sbdma16 - 16bit DMA # for CMI8330 chip (SB16)
9e128fdd
TI
365 fmport - (optional) OPL3 I/O port
366 mpuport - (optional) MPU401 I/O port
367 mpuirq - (optional) MPU401 irq #
1da177e4 368
0ef797c5 369 This module supports multiple cards and autoprobe.
1da177e4 370
a4efc230
TI
371 The power-management is supported.
372
1da177e4
LT
373 Module snd-cmipci
374 -----------------
375
45c41b48 376 Module for C-Media CMI8338/8738/8768/8770 PCI sound cards.
1da177e4 377
c78c950d 378 mpu_port - port address of MIDI interface (8338 only):
45c41b48 379 0x300,0x310,0x320,0x330 = legacy port,
cab5c4c9 380 0 = disable (default)
45c41b48
CL
381 fm_port - port address of OPL-3 FM synthesizer (8x38 only):
382 0x388 = legacy port,
383 1 = integrated PCI port (default on 8738),
2f24d159 384 0 = disable
6243008b 385 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
1da177e4
LT
386 (default = 1)
387 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
388
0ef797c5 389 This module supports autoprobe and multiple cards.
1da177e4 390
a4efc230
TI
391 The power-management is supported.
392
1da177e4
LT
393 Module snd-cs4231
394 -----------------
395
396 Module for sound cards based on CS4231 ISA chips.
397
398 port - port # for CS4231 chip
399 mpu_port - port # for MPU-401 UART (optional), -1 = disable
400 irq - IRQ # for CS4231 chip
401 mpu_irq - IRQ # for MPU-401 UART
402 dma1 - first DMA # for CS4231 chip
403 dma2 - second DMA # for CS4231 chip
404
0ef797c5 405 This module supports multiple cards. This module does not support autoprobe
1da177e4
LT
406 thus main port must be specified!!! Other ports are optional.
407
408 The power-management is supported.
409
1da177e4
LT
410 Module snd-cs4236
411 -----------------
412
c844a5d3
TI
413 Module for sound cards based on CS4232/CS4232A,
414 CS4235/CS4236/CS4236B/CS4237B/
1da177e4
LT
415 CS4238B/CS4239 ISA chips.
416
64e0e2d9
RH
417 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
418
419 with isapnp=0, the following options are available:
420
1da177e4
LT
421 port - port # for CS4236 chip (PnP setup - 0x534)
422 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
423 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
424 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
425 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
426 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
427 dma1 - first DMA # for CS4236 chip (0,1,3)
428 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
1da177e4 429
0ef797c5 430 This module supports multiple cards. This module does not support autoprobe
1da177e4
LT
431 (if ISA PnP is not used) thus main port and control port must be
432 specified!!! Other ports are optional.
433
434 The power-management is supported.
435
c844a5d3
TI
436 This module is aliased as snd-cs4232 since it provides the old
437 snd-cs4232 functionality, too.
438
1da177e4
LT
439 Module snd-cs4281
440 -----------------
441
442 Module for Cirrus Logic CS4281 soundchip.
443
444 dual_codec - Secondary codec ID (0 = disable, default)
445
0ef797c5 446 This module supports multiple cards.
1da177e4
LT
447
448 The power-management is supported.
449
450 Module snd-cs46xx
451 -----------------
452
453 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
454 CS4624/CS4630/CS4280 PCI chips.
455
6243008b 456 external_amp - Force to enable external amplifier.
1da177e4
LT
457 thinkpad - Force to enable Thinkpad's CLKRUN control.
458 mmap_valid - Support OSS mmap mode (default = 0).
459
0ef797c5 460 This module supports multiple cards and autoprobe.
1da177e4
LT
461 Usually external amp and CLKRUN controls are detected automatically
462 from PCI sub vendor/device ids. If they don't work, give the options
463 above explicitly.
464
465 The power-management is supported.
621887ae
TI
466
467 Module snd-cs5530
468 _________________
469
470 Module for Cyrix/NatSemi Geode 5530 chip.
471
3e873174
TI
472 Module snd-cs5535audio
473 ----------------------
474
475 Module for multifunction CS5535 companion PCI device
476
c00bd74a 477 The power-management is supported.
3e873174 478
8cc72361
WYC
479 Module snd-ctxfi
480 ----------------
481
482 Module for Creative Sound Blaster X-Fi boards (20k1 / 20k2 chips)
483 * Creative Sound Blaster X-Fi Titanium Fatal1ty Champion Series
484 * Creative Sound Blaster X-Fi Titanium Fatal1ty Professional Series
485 * Creative Sound Blaster X-Fi Titanium Professional Audio
486 * Creative Sound Blaster X-Fi Titanium
487 * Creative Sound Blaster X-Fi Elite Pro
488 * Creative Sound Blaster X-Fi Platinum
489 * Creative Sound Blaster X-Fi Fatal1ty
490 * Creative Sound Blaster X-Fi XtremeGamer
491 * Creative Sound Blaster X-Fi XtremeMusic
492
493 reference_rate - reference sample rate, 44100 or 48000 (default)
494 multiple - multiple to ref. sample rate, 1 or 2 (default)
408bffd0
TI
495 subsystem - override the PCI SSID for probing; the value
496 consists of SSVID << 16 | SSDID. The default is
497 zero, which means no override.
8cc72361
WYC
498
499 This module supports multiple cards.
500
dd7b254d
GP
501 Module snd-darla20
502 ------------------
503
504 Module for Echoaudio Darla20
505
506 This module supports multiple cards.
507 The driver requires the firmware loader support on kernel.
508
509 Module snd-darla24
510 ------------------
511
512 Module for Echoaudio Darla24
513
514 This module supports multiple cards.
515 The driver requires the firmware loader support on kernel.
516
1da177e4
LT
517 Module snd-dt019x
518 -----------------
519
520 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
521 only)
522
0ef797c5 523 This module supports multiple cards. This module is enabled only with
1da177e4
LT
524 ISA PnP support.
525
a4efc230
TI
526 The power-management is supported.
527
1da177e4
LT
528 Module snd-dummy
529 ----------------
530
531 Module for the dummy sound card. This "card" doesn't do any output
532 or input, but you may use this module for any application which
533 requires a sound card (like RealPlayer).
534
30681bcf
TI
535 pcm_devs - Number of PCM devices assigned to each card
536 (default = 1, up to 4)
537 pcm_substreams - Number of PCM substreams assigned to each PCM
23aebca4 538 (default = 8, up to 128)
30681bcf 539 hrtimer - Use hrtimer (=1, default) or system timer (=0)
a68c4d11 540 fake_buffer - Fake buffer allocations (default = 1)
30681bcf
TI
541
542 When multiple PCM devices are created, snd-dummy gives different
543 behavior to each PCM device:
544 0 = interleaved with mmap support
545 1 = non-interleaved with mmap support
546 2 = interleaved without mmap
547 3 = non-interleaved without mmap
548
a68c4d11
TI
549 As default, snd-dummy drivers doesn't allocate the real buffers
550 but either ignores read/write or mmap a single dummy page to all
551 buffer pages, in order to save the resouces. If your apps need
552 the read/ written buffer data to be consistent, pass fake_buffer=0
553 option.
554
a4efc230
TI
555 The power-management is supported.
556
dd7b254d
GP
557 Module snd-echo3g
558 -----------------
559
560 Module for Echoaudio 3G cards (Gina3G/Layla3G)
561
562 This module supports multiple cards.
563 The driver requires the firmware loader support on kernel.
564
1da177e4
LT
565 Module snd-emu10k1
566 ------------------
567
568 Module for EMU10K1/EMU10k2 based PCI sound cards.
569 * Sound Blaster Live!
570 * Sound Blaster PCI 512
571 * Emu APS (partially supported)
572 * Sound Blaster Audigy
573
574 extin - bitmap of available external inputs for FX8010 (see bellow)
575 extout - bitmap of available external outputs for FX8010 (see bellow)
576 seq_ports - allocated sequencer ports (4 by default)
577 max_synth_voices - limit of voices used for wavetable (64 by default)
578 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
579 given in MB unit. Default value is 128.
580 enable_ir - enable IR
581
0ef797c5 582 This module supports multiple cards and autoprobe.
1da177e4
LT
583
584 Input & Output configurations [extin/extout]
585 * Creative Card wo/Digital out [0x0003/0x1f03]
586 * Creative Card w/Digital out [0x0003/0x1f0f]
587 * Creative Card w/Digital CD in [0x000f/0x1f0f]
588 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
589 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
590 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
591 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
592 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
593 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
594 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
595 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
596 * Creative Card all ins and outs [0x3fff/0x7fff]
597
a4efc230
TI
598 The power-management is supported.
599
1da177e4
LT
600 Module snd-emu10k1x
601 -------------------
602
603 Module for Creative Emu10k1X (SB Live Dell OEM version)
604
0ef797c5 605 This module supports multiple cards.
1da177e4
LT
606
607 Module snd-ens1370
608 ------------------
609
610 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
611 * SoundBlaster PCI 64
612 * SoundBlaster PCI 128
613
614 joystick - Enable joystick (default off)
615
0ef797c5 616 This module supports multiple cards and autoprobe.
1da177e4 617
d6ec894b
TI
618 The power-management is supported.
619
1da177e4
LT
620 Module snd-ens1371
621 ------------------
622
623 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
624 * SoundBlaster PCI 64
625 * SoundBlaster PCI 128
626 * SoundBlaster Vibra PCI
627
628 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
629 0 = disable (default), 1 = auto-detect
630
0ef797c5 631 This module supports multiple cards and autoprobe.
1da177e4 632
d6ec894b
TI
633 The power-management is supported.
634
1da177e4
LT
635 Module snd-es1688
636 -----------------
637
638 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
639
a20971b2 640 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1da177e4 641 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
1da177e4 642 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
a20971b2
KH
643 fm_port - port # for OPL3 (option; share the same port as default)
644
645 with isapnp=0, the following additional options are available:
646 port - port # for ES-1688 chip (0x220,0x240,0x260)
647 irq - IRQ # for ES-1688 chip (5,7,9,10)
1da177e4
LT
648 dma8 - DMA # for ES-1688 chip (0,1,3)
649
a20971b2
KH
650 This module supports multiple cards and autoprobe (without MPU-401 port)
651 and PnP with the ES968 chip.
1da177e4
LT
652
653 Module snd-es18xx
654 -----------------
655
656 Module for ESS AudioDrive ES-18xx sound cards.
657
64e0e2d9
RH
658 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
659
660 with isapnp=0, the following options are available:
661
1da177e4
LT
662 port - port # for ES-18xx chip (0x220,0x240,0x260)
663 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
664 fm_port - port # for FM (optional, not used)
665 irq - IRQ # for ES-18xx chip (5,7,9,10)
666 dma1 - first DMA # for ES-18xx chip (0,1,3)
667 dma2 - first DMA # for ES-18xx chip (0,1,3)
1da177e4 668
0ef797c5
CL
669 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
670 port if native ISA PnP routines are not used).
1da177e4
LT
671 When dma2 is equal with dma1, the driver works as half-duplex.
672
673 The power-management is supported.
674
675 Module snd-es1938
676 -----------------
677
678 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
679
0ef797c5 680 This module supports multiple cards and autoprobe.
1da177e4 681
a4efc230
TI
682 The power-management is supported.
683
1da177e4
LT
684 Module snd-es1968
685 -----------------
686
687 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
688
689 total_bufsize - total buffer size in kB (1-4096kB)
690 pcm_substreams_p - playback channels (1-8, default=2)
691 pcm_substreams_c - capture channels (1-8, default=0)
692 clock - clock (0 = auto-detection)
693 use_pm - support the power-management (0 = off, 1 = on,
694 2 = auto (default))
695 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
696 joystick - enable joystick (default off)
697
0ef797c5 698 This module supports multiple cards and autoprobe.
1da177e4
LT
699
700 The power-management is supported.
701
702 Module snd-fm801
703 ----------------
704
705 Module for ForteMedia FM801 based PCI sound cards.
706
707 tea575x_tuner - Enable TEA575x tuner
708 - 1 = MediaForte 256-PCS
709 - 2 = MediaForte 256-PCPR
710 - 3 = MediaForte 64-PCR
711 - High 16-bits are video (radio) device number + 1
712 - example: 0x10002 (MediaForte 256-PCPR, device 1)
713
0ef797c5 714 This module supports multiple cards and autoprobe.
1da177e4 715
a4efc230
TI
716 The power-management is supported.
717
dd7b254d
GP
718 Module snd-gina20
719 -----------------
720
721 Module for Echoaudio Gina20
722
723 This module supports multiple cards.
724 The driver requires the firmware loader support on kernel.
725
726 Module snd-gina24
727 -----------------
728
729 Module for Echoaudio Gina24
730
731 This module supports multiple cards.
732 The driver requires the firmware loader support on kernel.
733
1da177e4
LT
734 Module snd-gusclassic
735 ---------------------
736
737 Module for Gravis UltraSound Classic sound card.
738
739 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
740 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
741 dma1 - DMA # for GF1 chip (1,3,5,6,7)
742 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
743 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
744 voices - GF1 voices limit (14-32)
745 pcm_voices - reserved PCM voices
746
0ef797c5 747 This module supports multiple cards and autoprobe.
1da177e4
LT
748
749 Module snd-gusextreme
750 ---------------------
751
752 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
753
754 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
755 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
756 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
757 irq - IRQ # for ES-1688 chip (5,7,9,10)
758 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
759 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
760 dma8 - DMA # for ES-1688 chip (0,1,3)
761 dma1 - DMA # for GF1 chip (1,3,5,6,7)
762 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
763 voices - GF1 voices limit (14-32)
764 pcm_voices - reserved PCM voices
765
0ef797c5 766 This module supports multiple cards and autoprobe (without MPU-401 port).
1da177e4
LT
767
768 Module snd-gusmax
769 -----------------
770
771 Module for Gravis UltraSound MAX sound card.
772
773 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
774 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
775 dma1 - DMA # for GF1 chip (1,3,5,6,7)
776 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
777 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
778 voices - GF1 voices limit (14-32)
779 pcm_voices - reserved PCM voices
780
0ef797c5 781 This module supports multiple cards and autoprobe.
1da177e4
LT
782
783 Module snd-hda-intel
784 --------------------
785
6ef10905
AB
786 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8, ICH9, ICH10,
787 PCH, SCH),
788 ATI SB450, SB600, R600, RS600, RS690, RS780, RV610, RV620,
789 RV630, RV635, RV670, RV770,
9b87819b
TI
790 VIA VT8251/VT8237A,
791 SIS966, ULI M5461
1da177e4 792
5aba4f8e 793 [Multiple options for each card instance]
1da177e4 794 model - force the model name
d2e1c973 795 position_fix - Fix DMA pointer (0 = auto, 1 = use LPIB, 2 = POSBUF)
95904743 796 probe_mask - Bitmask to probe codecs (default = -1, meaning all slots)
ae374d66
TI
797 When the bit 8 (0x100) is set, the lower 8 bits are used
798 as the "fixed" codec slots; i.e. the driver probes the
799 slots regardless what hardware reports back
d4d9cd03
TI
800 probe_only - Only probing and no codec initialization (default=off);
801 Useful to check the initial codec status for debugging
8c53b96f
TI
802 bdl_pos_adj - Specifies the DMA IRQ timing delay in samples.
803 Passing -1 will make the driver to choose the appropriate
804 value based on the controller chip.
1e7b8c87
TI
805 patch - Specifies the early "patch" files to modify the HD-audio
806 setup before initializing the codecs. This option is
807 available only when CONFIG_SND_HDA_PATCH_LOADER=y is set.
808 See HD-Audio.txt for details.
d019361a
TI
809 beep_mode - Selects the beep registration mode (0=off, 1=on, 2=
810 dynamic registration via mute switch on/off); the default
811 value is set via CONFIG_SND_HDA_INPUT_BEEP_MODE kconfig.
5aba4f8e
TI
812
813 [Single (global) options]
27346166
TI
814 single_cmd - Use single immediate commands to communicate with
815 codecs (for debugging only)
134a11f0 816 enable_msi - Enable Message Signaled Interrupt (MSI) (default = off)
19f59460 817 power_save - Automatic power-saving timeout (in second, 0 =
3723e2d2 818 disable)
dee1b66c
TI
819 power_save_controller - Reset HD-audio controller in power-saving mode
820 (default = on)
1da177e4 821
5aba4f8e
TI
822 This module supports multiple cards and autoprobe.
823
cae51176
TI
824 See Documentation/sound/alsa/HD-Audio.txt for more details about
825 HD-audio driver.
826
1da177e4
LT
827 Each codec may have a model table for different configurations.
828 If your machine isn't listed there, the default (usually minimal)
829 configuration is set up. You can pass "model=<name>" option to
830 specify a certain model in such a case. There are different
cae51176
TI
831 models depending on the codec chip. The list of available models
832 is found in HD-Audio-Models.txt
db064e50 833
6d7b1d7d
TI
834 The model name "genric" is treated as a special case. When this
835 model is given, the driver uses the generic codec parser without
836 "codec-patch". It's sometimes good for testing and debugging.
837
6243008b 838 If the default configuration doesn't work and one of the above
30bc4481
TI
839 matches with your device, report it together with alsa-info.sh
840 output (with --no-upload option) to kernel bugzilla or alsa-devel
6243008b
TI
841 ML (see the section "Links and Addresses").
842
3723e2d2
TI
843 power_save and power_save_controller options are for power-saving
844 mode. See powersave.txt for details.
dee1b66c 845
c74db86b
TI
846 Note 2: If you get click noises on output, try the module option
847 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
848 register value without FIFO size correction as the current
849 DMA pointer. position_fix=2 will make the driver to use
850 the position buffer instead of reading SD_LPIB register.
90f31e38 851 (Usually SD_LPIB register is more accurate than the
c74db86b
TI
852 position buffer.)
853
27346166
TI
854 NB: If you get many "azx_get_response timeout" messages at
855 loading, it's likely a problem of interrupts (e.g. ACPI irq
856 routing). Try to boot with options like "pci=noacpi". Also, you
857 can try "single_cmd=1" module option. This will switch the
858 communication method between HDA controller and codecs to the
859 single immediate commands instead of CORB/RIRB. Basically, the
860 single command mode is provided only for BIOS, and you won't get
861 unsolicited events, too. But, at least, this works independently
862 from the irq. Remember this is a last resort, and should be
863 avoided as much as possible...
864
95904743
TI
865 MORE NOTES ON "azx_get_response timeout" PROBLEMS:
866 On some hardwares, you may need to add a proper probe_mask option
867 to avoid the "azx_get_response timeout" problem above, instead.
868 This occurs when the access to non-existing or non-working codec slot
869 (likely a modem one) causes a stall of the communication via HD-audio
870 bus. You can see which codec slots are probed by enabling
62cf872a 871 CONFIG_SND_DEBUG_VERBOSE, or simply from the file name of the codec
95904743
TI
872 proc files. Then limit the slots to probe by probe_mask option.
873 For example, probe_mask=1 means to probe only the first slot, and
874 probe_mask=4 means only the third slot.
875
a4efc230
TI
876 The power-management is supported.
877
1da177e4
LT
878 Module snd-hdsp
879 ---------------
880
881 Module for RME Hammerfall DSP audio interface(s)
882
0ef797c5 883 This module supports multiple cards.
1da177e4
LT
884
885 Note: The firmware data can be automatically loaded via hotplug
886 when CONFIG_FW_LOADER is set. Otherwise, you need to load
887 the firmware via hdsploader utility included in alsa-tools
888 package.
889 The firmware data is found in alsa-firmware package.
890
891 Note: snd-page-alloc module does the job which snd-hammerfall-mem
892 module did formerly. It will allocate the buffers in advance
893 when any HDSP cards are found. To make the buffer
894 allocation sure, load snd-page-alloc module in the early
b6a96915
TI
895 stage of boot sequence. See "Early Buffer Allocation"
896 section.
1da177e4 897
5470440a
TI
898 Module snd-hdspm
899 ----------------
900
901 Module for RME HDSP MADI board.
902
903 precise_ptr - Enable precise pointer, or disable.
904 line_outs_monitor - Send playback streams to analog outs by default.
905 enable_monitor - Enable Analog Out on Channel 63/64 by default.
906
907 See hdspm.txt for details.
908
c626026d
CL
909 Module snd-hifier
910 -----------------
911
912 Module for the MediaTek/TempoTec HiFier Fantasia sound card.
913
914 This module supports autoprobe and multiple cards.
915
1da177e4
LT
916 Module snd-ice1712
917 ------------------
918
919 Module for Envy24 (ICE1712) based PCI sound cards.
920 * MidiMan M Audio Delta 1010
921 * MidiMan M Audio Delta 1010LT
922 * MidiMan M Audio Delta DiO 2496
923 * MidiMan M Audio Delta 66
924 * MidiMan M Audio Delta 44
925 * MidiMan M Audio Delta 410
926 * MidiMan M Audio Audiophile 2496
927 * TerraTec EWS 88MT
928 * TerraTec EWS 88D
929 * TerraTec EWX 24/96
930 * TerraTec DMX 6Fire
c9bce91f 931 * TerraTec Phase 88
1da177e4
LT
932 * Hoontech SoundTrack DSP 24
933 * Hoontech SoundTrack DSP 24 Value
934 * Hoontech SoundTrack DSP 24 Media 7.1
c9bce91f 935 * Event Electronics, EZ8
1da177e4 936 * Digigram VX442
c9bce91f 937 * Lionstracs, Mediastaton
6ef10905 938 * Terrasoniq TS 88
1da177e4
LT
939
940 model - Use the given board model, one of the following:
941 delta1010, dio2496, delta66, delta44, audiophile, delta410,
942 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
c9bce91f
TI
943 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
944 phase88, mediastation
1da177e4 945 omni - Omni I/O support for MidiMan M-Audio Delta44/66
fa00e7e1 946 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transceiver)
1da177e4
LT
947 in msec resolution, default value is 500 (0.5 sec)
948
0ef797c5 949 This module supports multiple cards and autoprobe. Note: The consumer part
1da177e4
LT
950 is not used with all Envy24 based cards (for example in the MidiMan Delta
951 serie).
952
c9bce91f
TI
953 Note: The supported board is detected by reading EEPROM or PCI
954 SSID (if EEPROM isn't available). You can override the
955 model by passing "model" module option in case that the
956 driver isn't configured properly or you want to try another
957 type for testing.
958
1da177e4
LT
959 Module snd-ice1724
960 ------------------
961
c9bce91f 962 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
7a6c8ff1 963 * MidiMan M Audio Revolution 5.1
1da177e4 964 * MidiMan M Audio Revolution 7.1
56255060 965 * MidiMan M Audio Audiophile 192
1da177e4 966 * AMP Ltd AUDIO2000
c9bce91f
TI
967 * TerraTec Aureon 5.1 Sky
968 * TerraTec Aureon 7.1 Space
969 * TerraTec Aureon 7.1 Universe
970 * TerraTec Phase 22
971 * TerraTec Phase 28
972 * AudioTrak Prodigy 7.1
6ef10905
AB
973 * AudioTrak Prodigy 7.1 LT
974 * AudioTrak Prodigy 7.1 XT
975 * AudioTrak Prodigy 7.1 HIFI
976 * AudioTrak Prodigy 7.1 HD2
c9bce91f
TI
977 * AudioTrak Prodigy 192
978 * Pontis MS300
979 * Albatron K8X800 Pro II
980 * Chaintech ZNF3-150
981 * Chaintech ZNF3-250
982 * Chaintech 9CJS
8cfbbac6 983 * Chaintech AV-710
c9bce91f 984 * Shuttle SN25P
f31639b8
SO
985 * Onkyo SE-90PCI
986 * Onkyo SE-200PCI
6ef10905 987 * ESI Juli@
72cbfd45 988 * ESI Maya44
6ef10905
AB
989 * Hercules Fortissimo IV
990 * EGO-SYS WaveTerminal 192M
1da177e4
LT
991
992 model - Use the given board model, one of the following:
7a6c8ff1 993 revo51, revo71, amp2000, prodigy71, prodigy71lt,
6ef10905
AB
994 prodigy71xt, prodigy71hifi, prodigyhd2, prodigy192,
995 juli, aureon51, aureon71, universe, ap192, k8x800,
996 phase22, phase28, ms300, av710, se200pci, se90pci,
72cbfd45 997 fortissimo4, sn25p, WT192M, maya44
1da177e4 998
0ef797c5 999 This module supports multiple cards and autoprobe.
1da177e4 1000
c9bce91f
TI
1001 Note: The supported board is detected by reading EEPROM or PCI
1002 SSID (if EEPROM isn't available). You can override the
1003 model by passing "model" module option in case that the
1004 driver isn't configured properly or you want to try another
1005 type for testing.
1006
dd7b254d
GP
1007 Module snd-indigo
1008 -----------------
1009
1010 Module for Echoaudio Indigo
1011
1012 This module supports multiple cards.
1013 The driver requires the firmware loader support on kernel.
1014
1015 Module snd-indigodj
1016 -------------------
1017
1018 Module for Echoaudio Indigo DJ
1019
1020 This module supports multiple cards.
1021 The driver requires the firmware loader support on kernel.
1022
1023 Module snd-indigoio
1024 -------------------
1025
1026 Module for Echoaudio Indigo IO
1027
1028 This module supports multiple cards.
1029 The driver requires the firmware loader support on kernel.
1030
1da177e4
LT
1031 Module snd-intel8x0
1032 -------------------
1033
1034 Module for AC'97 motherboards from Intel and compatibles.
1035 * Intel i810/810E, i815, i820, i830, i84x, MX440
6ef10905 1036 ICH5, ICH6, ICH7, 6300ESB, ESB2
1da177e4 1037 * SiS 7012 (SiS 735)
89ac9c25
TI
1038 * NVidia NForce, NForce2, NForce3, MCP04, CK804
1039 CK8, CK8S, MCP501
1da177e4
LT
1040 * AMD AMD768, AMD8111
1041 * ALi m5455
1042
1043 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1044 ac97_quirk - AC'97 workaround for strange hardware
6243008b 1045 See "AC97 Quirk Option" section below.
1da177e4 1046 buggy_irq - Enable workaround for buggy interrupts on some
a06147d2
TI
1047 motherboards (default yes on nForce chips,
1048 otherwise off)
1049 buggy_semaphore - Enable workaround for hardwares with buggy
1050 semaphores (e.g. on some ASUS laptops)
1051 (default off)
6c5cfd9d
TI
1052 spdif_aclink - Use S/PDIF over AC-link instead of direct connection
1053 from the controller chip
1054 (0 = off, 1 = on, -1 = default)
1da177e4 1055
b7fe4622 1056 This module supports one chip and autoprobe.
1da177e4
LT
1057
1058 Note: the latest driver supports auto-detection of chip clock.
1059 if you still encounter too fast playback, specify the clock
1060 explicitly via the module option "ac97_clock=41194".
1061
1062 Joystick/MIDI ports are not supported by this driver. If your
1063 motherboard has these devices, use the ns558 or snd-mpu401
1064 modules, respectively.
1065
1da177e4
LT
1066 The power-management is supported.
1067
1068 Module snd-intel8x0m
1069 --------------------
1070
1071 Module for Intel ICH (i8x0) chipset MC97 modems.
89ac9c25
TI
1072 * Intel i810/810E, i815, i820, i830, i84x, MX440
1073 ICH5, ICH6, ICH7
1074 * SiS 7013 (SiS 735)
1075 * NVidia NForce, NForce2, NForce2s, NForce3
1076 * AMD AMD8111
1077 * ALi m5455
1da177e4
LT
1078
1079 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1080
b7fe4622 1081 This module supports one card and autoprobe.
1da177e4
LT
1082
1083 Note: The default index value of this module is -2, i.e. the first
1084 slot is excluded.
1085
a4efc230
TI
1086 The power-management is supported.
1087
1da177e4
LT
1088 Module snd-interwave
1089 --------------------
1090
1091 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1092 and other sound cards based on AMD InterWave (tm) chip.
1093
1da177e4
LT
1094 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1095 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1096 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1097 effect - 1 = InterWave effects enable (default 0);
1098 requires 8 voices
64e0e2d9
RH
1099 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1100
1101 with isapnp=0, the following options are available:
1102
1103 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1104 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1105 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1106 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
1da177e4 1107
0ef797c5 1108 This module supports multiple cards, autoprobe and ISA PnP.
1da177e4
LT
1109
1110 Module snd-interwave-stb
1111 ------------------------
1112
1113 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1114 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1115 circuit for extended control of bass, treble and master volume.
1116
1da177e4
LT
1117 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1118 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1119 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1120 effect - 1 = InterWave effects enable (default 0);
1121 requires 8 voices
64e0e2d9
RH
1122 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1123
1124 with isapnp=0, the following options are available:
1125
1126 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1127 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1128 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1129 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1130 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
1da177e4 1131
0ef797c5 1132 This module supports multiple cards, autoprobe and ISA PnP.
1da177e4 1133
44eba3e8
KH
1134 Module snd-jazz16
1135 -------------------
1136
1137 Module for Media Vision Jazz16 chipset. The chipset consists of 3 chips:
1138 MVD1216 + MVA416 + MVA514.
1139
1140 port - port # for SB DSP chip (0x210,0x220,0x230,0x240,0x250,0x260)
1141 irq - IRQ # for SB DSP chip (3,5,7,9,10,15)
1142 dma8 - DMA # for SB DSP chip (1,3)
1143 dma16 - DMA # for SB DSP chip (5,7)
1144 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1145 mpu_irq - MPU-401 irq # (2,3,5,7)
1146
1147 This module supports multiple cards.
1148
1da177e4
LT
1149 Module snd-korg1212
1150 -------------------
1151
1152 Module for Korg 1212 IO PCI card
1153
0ef797c5 1154 This module supports multiple cards.
1da177e4 1155
dd7b254d
GP
1156 Module snd-layla20
1157 ------------------
1158
1159 Module for Echoaudio Layla20
1160
1161 This module supports multiple cards.
1162 The driver requires the firmware loader support on kernel.
1163
1164 Module snd-layla24
1165 ------------------
1166
1167 Module for Echoaudio Layla24
1168
1169 This module supports multiple cards.
1170 The driver requires the firmware loader support on kernel.
1171
8338c300
TI
1172 Module snd-lx6464es
1173 -------------------
1174
1175 Module for Digigram LX6464ES boards
1176
1177 This module supports multiple cards.
1178
1da177e4
LT
1179 Module snd-maestro3
1180 -------------------
1181
1182 Module for Allegro/Maestro3 chips
1183
1184 external_amp - enable external amp (enabled by default)
1185 amp_gpio - GPIO pin number for external amp (0-15) or
1186 -1 for default pin (8 for allegro, 1 for
1187 others)
1188
0ef797c5 1189 This module supports autoprobe and multiple chips.
1da177e4
LT
1190
1191 Note: the binding of amplifier is dependent on hardware.
1192 If there is no sound even though all channels are unmuted, try to
1193 specify other gpio connection via amp_gpio option.
1194 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1195 option.
1196
1197 The power-management is supported.
1198
dd7b254d
GP
1199 Module snd-mia
1200 ---------------
1201
1202 Module for Echoaudio Mia
1203
1204 This module supports multiple cards.
1205 The driver requires the firmware loader support on kernel.
1206
1841f613
ML
1207 Module snd-miro
1208 ---------------
1209
1210 Module for Miro soundcards: miroSOUND PCM 1 pro,
1211 miroSOUND PCM 12,
1212 miroSOUND PCM 20 Radio.
1213
1214 port - Port # (0x530,0x604,0xe80,0xf40)
1215 irq - IRQ # (5,7,9,10,11)
1216 dma1 - 1st dma # (0,1,3)
1217 dma2 - 2nd dma # (0,1)
1218 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1219 mpu_irq - MPU-401 irq # (5,7,9,10)
1220 fm_port - FM Port # (0x388)
1221 wss - enable WSS mode
1222 ide - enable onboard ide support
1223
1da177e4
LT
1224 Module snd-mixart
1225 -----------------
1226
1227 Module for Digigram miXart8 sound cards.
1228
0ef797c5 1229 This module supports multiple cards.
1da177e4
LT
1230 Note: One miXart8 board will be represented as 4 alsa cards.
1231 See MIXART.txt for details.
1232
1233 When the driver is compiled as a module and the hotplug firmware
1234 is supported, the firmware data is loaded via hotplug automatically.
1235 Install the necessary firmware files in alsa-firmware package.
1236 When no hotplug fw loader is available, you need to load the
1237 firmware via mixartloader utility in alsa-tools package.
1238
dd7b254d
GP
1239 Module snd-mona
1240 ---------------
1241
1242 Module for Echoaudio Mona
1243
1244 This module supports multiple cards.
1245 The driver requires the firmware loader support on kernel.
1246
1da177e4
LT
1247 Module snd-mpu401
1248 -----------------
1249
1250 Module for MPU-401 UART devices.
1251
1252 port - port number or -1 (disable)
1253 irq - IRQ number or -1 (disable)
1254 pnp - PnP detection - 0 = disable, 1 = enable (default)
1255
0ef797c5 1256 This module supports multiple devices and PnP.
1da177e4 1257
c96330b0
TI
1258 Module snd-msnd-classic
1259 -----------------------
1260
1261 Module for Turtle Beach MultiSound Classic, Tahiti or Monterey
1262 soundcards.
1263
1264 io - Port # for msnd-classic card
1265 irq - IRQ # for msnd-classic card
1266 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1267 0xe0000 or 0xe8000)
1268 write_ndelay - enable write ndelay (default = 1)
1269 calibrate_signal - calibrate signal (default = 0)
1270 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1271 digital - Digital daughterboard present (default = 0)
1272 cfg - Config port (0x250, 0x260 or 0x270) default = PnP
1273 reset - Reset all devices
1274 mpu_io - MPU401 I/O port
1275 mpu_irq - MPU401 irq#
1276 ide_io0 - IDE port #0
1277 ide_io1 - IDE port #1
1278 ide_irq - IDE irq#
1279 joystick_io - Joystick I/O port
1280
1281 The driver requires firmware files "turtlebeach/msndinit.bin" and
1282 "turtlebeach/msndperm.bin" in the proper firmware directory.
1283
1284 See Documentation/sound/oss/MultiSound for important information
1285 about this driver. Note that it has been discontinued, but the
1286 Voyetra Turtle Beach knowledge base entry for it is still available
1287 at
0ea6e611 1288 http://www.turtlebeach.com
c96330b0
TI
1289
1290 Module snd-msnd-pinnacle
1291 ------------------------
1292
1293 Module for Turtle Beach MultiSound Pinnacle/Fiji soundcards.
1294
1295 io - Port # for pinnacle/fiji card
1296 irq - IRQ # for pinnalce/fiji card
1297 mem - Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000,
1298 0xe0000 or 0xe8000)
1299 write_ndelay - enable write ndelay (default = 1)
1300 calibrate_signal - calibrate signal (default = 0)
1301 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1302
1303 The driver requires firmware files "turtlebeach/pndspini.bin" and
1304 "turtlebeach/pndsperm.bin" in the proper firmware directory.
1305
1da177e4
LT
1306 Module snd-mtpav
1307 ----------------
1308
1309 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1310 port).
1311
1312 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1313 irq - IRQ # for MTPAV (7,5, default=7)
1314 hwports - number of supported hardware ports, default=8.
1315
1316 Module supports only 1 card. This module has no enable option.
1317
68ab801e
MK
1318 Module snd-mts64
1319 ----------------
1320
1321 Module for Ego Systems (ESI) Miditerminal 4140
1322
1323 This module supports multiple devices.
1324 Requires parport (CONFIG_PARPORT).
1325
1da177e4
LT
1326 Module snd-nm256
1327 ----------------
1328
1329 Module for NeoMagic NM256AV/ZX chips
1330
1331 playback_bufsize - max playback frame size in kB (4-128kB)
1332 capture_bufsize - max capture frame size in kB (4-128kB)
1333 force_ac97 - 0 or 1 (disabled by default)
1334 buffer_top - specify buffer top address
1335 use_cache - 0 or 1 (disabled by default)
1336 vaio_hack - alias buffer_top=0x25a800
1337 reset_workaround - enable AC97 RESET workaround for some laptops
d1f38cf9
TI
1338 reset_workaround2 - enable extended AC97 RESET workaround for some
1339 other laptops
1da177e4 1340
8a3fb4d0 1341 This module supports one chip and autoprobe.
1da177e4
LT
1342
1343 The power-management is supported.
1344
1345 Note: on some notebooks the buffer address cannot be detected
1346 automatically, or causes hang-up during initialization.
fff9289b
ML
1347 In such a case, specify the buffer top address explicitly via
1348 the buffer_top option.
1da177e4
LT
1349 For example,
1350 Sony F250: buffer_top=0x25a800
1351 Sony F270: buffer_top=0x272800
1352 The driver supports only ac97 codec. It's possible to force
1353 to initialize/use ac97 although it's not detected. In such a
1354 case, use force_ac97=1 option - but *NO* guarantee whether it
1355 works!
1356
1357 Note: The NM256 chip can be linked internally with non-AC97
1358 codecs. This driver supports only the AC97 codec, and won't work
1359 with machines with other (most likely CS423x or OPL3SAx) chips,
1360 even though the device is detected in lspci. In such a case, try
1361 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
6243008b 1362 but some doesn't have ISA PnP. You'll need to specify isapnp=0
1da177e4
LT
1363 and proper hardware parameters in the case without ISA PnP.
1364
1365 Note: some laptops need a workaround for AC97 RESET. For the
1366 known hardware like Dell Latitude LS and Sony PCG-F305, this
1367 workaround is enabled automatically. For other laptops with a
1368 hard freeze, you can try reset_workaround=1 option.
1369
d1f38cf9
TI
1370 Note: Dell Latitude CSx laptops have another problem regarding
1371 AC97 RESET. On these laptops, reset_workaround2 option is
1372 turned on as default. This option is worth to try if the
1373 previous reset_workaround option doesn't help.
1374
1da177e4
LT
1375 Note: This driver is really crappy. It's a porting from the
1376 OSS driver, which is a result of black-magic reverse engineering.
1377 The detection of codec will fail if the driver is loaded *after*
1378 X-server as described above. You might be able to force to load
1379 the module, but it may result in hang-up. Hence, make sure that
1380 you load this module *before* X if you encounter this kind of
1381 problem.
1382
1383 Module snd-opl3sa2
1384 ------------------
1385
1386 Module for Yamaha OPL3-SA2/SA3 sound cards.
1387
64e0e2d9
RH
1388 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1389
1390 with isapnp=0, the following options are available:
1391
1da177e4
LT
1392 port - control port # for OPL3-SA chip (0x370)
1393 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1394 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1395 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1396 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1397 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1398 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1399 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
1da177e4 1400
0ef797c5 1401 This module supports multiple cards and ISA PnP. It does not support
1da177e4
LT
1402 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1403
1404 The power-management is supported.
1405
1406 Module snd-opti92x-ad1848
1407 -------------------------
1408
1409 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1410 Module works with OAK Mozart cards as well.
1411
64e0e2d9
RH
1412 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1413
1414 with isapnp=0, the following options are available:
1415
1da177e4
LT
1416 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1417 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1418 fm_port - port # for OPL3 device (0x388)
1419 irq - IRQ # for WSS chip (5,7,9,10,11)
1420 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1421 dma1 - first DMA # for WSS chip (0,1,3)
1422
1423 This module supports only one card, autoprobe and PnP.
1424
1425 Module snd-opti92x-cs4231
1426 -------------------------
1427
1428 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1429
64e0e2d9
RH
1430 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1431
1432 with isapnp=0, the following options are available:
1433
1da177e4
LT
1434 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1435 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1436 fm_port - port # for OPL3 device (0x388)
1437 irq - IRQ # for WSS chip (5,7,9,10,11)
1438 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1439 dma1 - first DMA # for WSS chip (0,1,3)
1440 dma2 - second DMA # for WSS chip (0,1,3)
1441
1442 This module supports only one card, autoprobe and PnP.
1443
1444 Module snd-opti93x
1445 ------------------
1446
1447 Module for sound cards based on OPTi 82c93x chips.
1448
64e0e2d9
RH
1449 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1450
1451 with isapnp=0, the following options are available:
1452
1da177e4
LT
1453 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1454 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1455 fm_port - port # for OPL3 device (0x388)
1456 irq - IRQ # for WSS chip (5,7,9,10,11)
1457 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1458 dma1 - first DMA # for WSS chip (0,1,3)
1459 dma2 - second DMA # for WSS chip (0,1,3)
1460
1461 This module supports only one card, autoprobe and PnP.
1462
48a8a26d
CL
1463 Module snd-oxygen
1464 -----------------
1465
1466 Module for sound cards based on the C-Media CMI8788 chip:
1467 * Asound A-8788
1468 * AuzenTech X-Meridian
1469 * Bgears b-Enspirer
1470 * Club3D Theatron DTS
de04b102
CL
1471 * HT-Omega Claro (plus)
1472 * HT-Omega Claro halo (XT)
48a8a26d
CL
1473 * Razer Barracuda AC-1
1474 * Sondigo Inferno
48a8a26d
CL
1475
1476 This module supports autoprobe and multiple cards.
1477
d08cd58d
SS
1478 Module snd-pcsp
1479 -----------------
1480
1481 Module for internal PC-Speaker.
1482
bcc2c6b7 1483 nopcm - Disable PC-Speaker PCM sound. Only beeps remain.
d08cd58d
SS
1484 nforce_wa - enable NForce chipset workaround. Expect bad sound.
1485
1486 This module supports system beeps, some kind of PCM playback and
1487 even a few mixer controls.
1488
e12229b4
MB
1489 Module snd-pcxhr
1490 ----------------
1491
1492 Module for Digigram PCXHR boards
1493
1494 This module supports multiple cards.
1495
757e119b
MK
1496 Module snd-portman2x4
1497 ---------------------
1498
1499 Module for Midiman Portman 2x4 parallel port MIDI interface
1500
1501 This module supports multiple cards.
1502
1da177e4
LT
1503 Module snd-powermac (on ppc only)
1504 ---------------------------------
1505
1506 Module for PowerMac, iMac and iBook on-board soundchips
1507
1508 enable_beep - enable beep using PCM (enabled as default)
1509
1510 Module supports autoprobe a chip.
1511
1512 Note: the driver may have problems regarding endianess.
1513
1514 The power-management is supported.
1515
2c484df0
TI
1516 Module snd-pxa2xx-ac97 (on arm only)
1517 ------------------------------------
1518
1519 Module for AC97 driver for the Intel PXA2xx chip
1520
1521 For ARM architecture only.
1522
a4efc230
TI
1523 The power-management is supported.
1524
109a9638
PG
1525 Module snd-riptide
1526 ------------------
1527
1528 Module for Conexant Riptide chip
1529
1530 joystick_port - Joystick port # (default: 0x200)
1531 mpu_port - MPU401 port # (default: 0x330)
1532 opl3_port - OPL3 port # (default: 0x388)
1533
1534 This module supports multiple cards.
1535 The driver requires the firmware loader support on kernel.
1536 You need to install the firmware file "riptide.hex" to the standard
1537 firmware path (e.g. /lib/firmware).
1538
1da177e4
LT
1539 Module snd-rme32
1540 ----------------
1541
1542 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1543 Prodif96 and Prodif Gold) sound cards.
1544
0ef797c5 1545 This module supports multiple cards.
1da177e4
LT
1546
1547 Module snd-rme96
1548 ----------------
1549
1550 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1551
0ef797c5 1552 This module supports multiple cards.
1da177e4
LT
1553
1554 Module snd-rme9652
1555 ------------------
1556
1557 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1558
1559 precise_ptr - Enable precise pointer (doesn't work reliably).
1560 (default = 0)
1561
0ef797c5 1562 This module supports multiple cards.
1da177e4
LT
1563
1564 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1565 module did formerly. It will allocate the buffers in advance
1566 when any RME9652 cards are found. To make the buffer
1567 allocation sure, load snd-page-alloc module in the early
b6a96915
TI
1568 stage of boot sequence. See "Early Buffer Allocation"
1569 section.
1da177e4
LT
1570
1571 Module snd-sa11xx-uda1341 (on arm only)
1572 ---------------------------------------
1573
1574 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1575
1576 Module supports only one card.
1577 Module has no enable and index options.
1578
a4efc230
TI
1579 The power-management is supported.
1580
1da177e4
LT
1581 Module snd-sb8
1582 --------------
1583
1584 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1585 SoundBlaster 2.0,
1586 SoundBlaster Pro
1587
1588 port - port # for SB DSP chip (0x220,0x240,0x260)
1589 irq - IRQ # for SB DSP chip (5,7,9,10)
1590 dma8 - DMA # for SB DSP chip (1,3)
1591
0ef797c5 1592 This module supports multiple cards and autoprobe.
1da177e4 1593
a4efc230
TI
1594 The power-management is supported.
1595
1da177e4
LT
1596 Module snd-sb16 and snd-sbawe
1597 -----------------------------
1598
1599 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1600 SoundBlaster AWE 32 (PnP),
1601 SoundBlaster AWE 64 PnP
1602
64e0e2d9
RH
1603 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1604 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1605 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1606
1607 with isapnp=0, the following options are available:
1608
1da177e4
LT
1609 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1610 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1611 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1612 (snd-sbawe module only)
1613 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1614 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1615 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
1da177e4 1616
0ef797c5 1617 This module supports multiple cards, autoprobe and ISA PnP.
1da177e4
LT
1618
1619 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1620 disable 16bit DMA with dma16 = -1 module parameter.
1621 Also, all Sound Blaster 16 type cards can operate in 16-bit
1622 half duplex mode through 8-bit DMA channel by disabling their
1623 16-bit DMA channel.
1624
a4efc230
TI
1625 The power-management is supported.
1626
074a6e9f
TI
1627 Module snd-sc6000
1628 -----------------
1629
b0ec3a30
KH
1630 Module for Gallant SC-6000 soundcard and later models: SC-6600
1631 and SC-7000.
074a6e9f
TI
1632
1633 port - Port # (0x220 or 0x240)
1634 mss_port - MSS Port # (0x530 or 0xe80)
1635 irq - IRQ # (5,7,9,10,11)
7b758d2f 1636 mpu_irq - MPU-401 IRQ # (5,7,9,10) ,0 - no MPU-401 irq
074a6e9f 1637 dma - DMA # (1,3,0)
b0ec3a30 1638 joystick - Enable gameport - 0 = disable (default), 1 = enable
074a6e9f
TI
1639
1640 This module supports multiple cards.
1641
1642 This card is also known as Audio Excel DSP 16 or Zoltrix AV302.
1643
1da177e4
LT
1644 Module snd-sgalaxy
1645 ------------------
1646
1647 Module for Aztech Sound Galaxy sound card.
1648
1649 sbport - Port # for SB16 interface (0x220,0x240)
1650 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1651 irq - IRQ # (7,9,10,11)
1652 dma1 - DMA #
1653
0ef797c5 1654 This module supports multiple cards.
1da177e4 1655
a4efc230
TI
1656 The power-management is supported.
1657
1da177e4
LT
1658 Module snd-sscape
1659 -----------------
1660
acd47100 1661 Module for ENSONIQ SoundScape cards.
1da177e4
LT
1662
1663 port - Port # (PnP setup)
adf1295b 1664 wss_port - WSS Port # (PnP setup)
1da177e4
LT
1665 irq - IRQ # (PnP setup)
1666 mpu_irq - MPU-401 IRQ # (PnP setup)
1667 dma - DMA # (PnP setup)
adf1295b 1668 dma2 - 2nd DMA # (PnP setup, -1 to disable)
1cb0fdeb 1669 joystick - Enable gameport - 0 = disable (default), 1 = enable
1da177e4 1670
acd47100 1671 This module supports multiple cards.
1da177e4 1672
acd47100 1673 The driver requires the firmware loader support on kernel.
1da177e4
LT
1674
1675 Module snd-sun-amd7930 (on sparc only)
1676 --------------------------------------
1677
1678 Module for AMD7930 sound chips found on Sparcs.
1679
0ef797c5 1680 This module supports multiple cards.
1da177e4
LT
1681
1682 Module snd-sun-cs4231 (on sparc only)
1683 -------------------------------------
1684
1685 Module for CS4231 sound chips found on Sparcs.
1686
0ef797c5 1687 This module supports multiple cards.
1da177e4 1688
1bd9debf
TI
1689 Module snd-sun-dbri (on sparc only)
1690 -----------------------------------
1691
1692 Module for DBRI sound chips found on Sparcs.
1693
0ef797c5 1694 This module supports multiple cards.
1bd9debf 1695
1da177e4
LT
1696 Module snd-wavefront
1697 --------------------
1698
1699 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1700
64e0e2d9
RH
1701 use_cs4232_midi - Use CS4232 MPU-401 interface
1702 (inaccessibly located inside your computer)
1703 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1704
1705 with isapnp=0, the following options are available:
1706
1da177e4
LT
1707 cs4232_pcm_port - Port # for CS4232 PCM interface.
1708 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1709 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1710 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
1da177e4
LT
1711 ics2115_port - Port # for ICS2115
1712 ics2115_irq - IRQ # for ICS2115
1713 fm_port - FM OPL-3 Port #
1714 dma1 - DMA1 # for CS4232 PCM interface.
1715 dma2 - DMA2 # for CS4232 PCM interface.
1da177e4 1716
c2b1239a
TI
1717 The below are options for wavefront_synth features:
1718 wf_raw - Assume that we need to boot the OS (default:no)
1719 If yes, then during driver loading, the state of the board is
1720 ignored, and we reset the board and load the firmware anyway.
1721 fx_raw - Assume that the FX process needs help (default:yes)
1722 If false, we'll leave the FX processor in whatever state it is
1723 when the driver is loaded. The default is to download the
1724 microprogram and associated coefficients to set it up for
1725 "default" operation, whatever that means.
1726 debug_default - Debug parameters for card initialization
1727 wait_usecs - How long to wait without sleeping, usecs
1728 (default:150)
1729 This magic number seems to give pretty optimal throughput
1730 based on my limited experimentation.
1731 If you want to play around with it and find a better value, be
1732 my guest. Remember, the idea is to get a number that causes us
1733 to just busy wait for as many WaveFront commands as possible,
1734 without coming up with a number so large that we hog the whole
1735 CPU.
1736 Specifically, with this number, out of about 134,000 status
1737 waits, only about 250 result in a sleep.
1738 sleep_interval - How long to sleep when waiting for reply
1739 (default: 100)
1740 sleep_tries - How many times to try sleeping during a wait
1741 (default: 50)
1742 ospath - Pathname to processed ICS2115 OS firmware
1743 (default:wavefront.os)
1744 The path name of the ISC2115 OS firmware. In the recent
1745 version, it's handled via firmware loader framework, so it
1746 must be installed in the proper path, typically,
1747 /lib/firmware.
1748 reset_time - How long to wait for a reset to take effect
1749 (default:2)
1750 ramcheck_time - How many seconds to wait for the RAM test
1751 (default:20)
1752 osrun_time - How many seconds to wait for the ICS2115 OS
1753 (default:10)
1754
0ef797c5 1755 This module supports multiple cards and ISA PnP.
1da177e4 1756
c2b1239a
TI
1757 Note: the firmware file "wavefront.os" was located in the earlier
1758 version in /etc. Now it's loaded via firmware loader, and
1759 must be in the proper firmware path, such as /lib/firmware.
1760 Copy (or symlink) the file appropriately if you get an error
1761 regarding firmware downloading after upgrading the kernel.
1762
1da177e4
LT
1763 Module snd-sonicvibes
1764 ---------------------
1765
1766 Module for S3 SonicVibes PCI sound cards.
1767 * PINE Schubert 32 PCI
1768
1769 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1770 - SoundCard must have onboard SRAM for this.
1771 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1772
0ef797c5 1773 This module supports multiple cards and autoprobe.
1da177e4
LT
1774
1775 Module snd-serial-u16550
1776 ------------------------
1777
1778 Module for UART16550A serial MIDI ports.
1779
1780 port - port # for UART16550A chip
1781 irq - IRQ # for UART16550A chip, -1 = poll mode
1782 speed - speed in bauds (9600,19200,38400,57600,115200)
1783 38400 = default
1784 base - base for divisor in bauds (57600,115200,230400,460800)
1785 115200 = default
1786 outs - number of MIDI ports in a serial port (1-4)
1787 1 = default
1788 adaptor - Type of adaptor.
1789 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1790 3 = MS-124W M/B, 4 = Generic
1791
0ef797c5 1792 This module supports multiple cards. This module does not support autoprobe
1da177e4
LT
1793 thus the main port must be specified!!! Other options are optional.
1794
1795 Module snd-trident
1796 ------------------
1797
1798 Module for Trident 4DWave DX/NX sound cards.
1799 * Best Union Miss Melody 4DWave PCI
1800 * HIS 4DWave PCI
1801 * Warpspeed ONSpeed 4DWave PCI
1802 * AzTech PCI 64-Q3D
1803 * Addonics SV 750
1804 * CHIC True Sound 4Dwave
1805 * Shark Predator4D-PCI
1806 * Jaton SonicWave 4D
6ef10905
AB
1807 * SiS SI7018 PCI Audio
1808 * Hoontech SoundTrack Digital 4DWave NX
1da177e4
LT
1809
1810 pcm_channels - max channels (voices) reserved for PCM
1811 wavetable_size - max wavetable size in kB (4-?kb)
1812
0ef797c5 1813 This module supports multiple cards and autoprobe.
1da177e4
LT
1814
1815 The power-management is supported.
1816
63978ab3
CL
1817 Module snd-ua101
1818 ----------------
1819
e584bc3c 1820 Module for the Edirol UA-101/UA-1000 audio/MIDI interfaces.
63978ab3
CL
1821
1822 This module supports multiple devices, autoprobe and hotplugging.
1823
1da177e4
LT
1824 Module snd-usb-audio
1825 --------------------
1826
1827 Module for USB audio and USB MIDI devices.
1828
1829 vid - Vendor ID for the device (optional)
1830 pid - Product ID for the device (optional)
8a8f2662
TI
1831 nrpacks - Max. number of packets per URB (default: 8)
1832 async_unlink - Use async unlink mode (default: yes)
e311334e
TLM
1833 device_setup - Device specific magic number (optional)
1834 - Influence depends on the device
1835 - Default: 0x0000
7a9b8063
TI
1836 ignore_ctl_error - Ignore any USB-controller regarding mixer
1837 interface (default: no)
1da177e4 1838
0ef797c5 1839 This module supports multiple devices, autoprobe and hotplugging.
1da177e4 1840
8a8f2662
TI
1841 NB: nrpacks parameter can be modified dynamically via sysfs.
1842 Don't put the value over 20. Changing via sysfs has no sanity
1843 check.
1844 NB: async_unlink=0 would cause Oops. It remains just for
1845 debugging purpose (if any).
7a9b8063
TI
1846 NB: ignore_ctl_error=1 may help when you get an error at accessing
1847 the mixer element such as URB error -22. This happens on some
1848 buggy USB device or the controller.
8a8f2662 1849
523f1dce
DM
1850 Module snd-usb-caiaq
1851 --------------------
1852
1853 Module for caiaq UB audio interfaces,
1854 * Native Instruments RigKontrol2
1855 * Native Instruments Kore Controller
1856 * Native Instruments Audio Kontrol 1
1857 * Native Instruments Audio 8 DJ
1858
1859 This module supports multiple devices, autoprobe and hotplugging.
1860
1da177e4
LT
1861 Module snd-usb-usx2y
1862 --------------------
1863
1864 Module for Tascam USB US-122, US-224 and US-428 devices.
1865
0ef797c5 1866 This module supports multiple devices, autoprobe and hotplugging.
1da177e4
LT
1867
1868 Note: you need to load the firmware via usx2yloader utility included
1869 in alsa-tools and alsa-firmware packages.
1870
1871 Module snd-via82xx
1872 ------------------
1873
1874 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
2d7eb7cb 1875 8233A, 8233C, 8235, 8237 (south) bridge.
1da177e4
LT
1876
1877 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1878 [VIA686A/686B only]
1879 joystick - Enable joystick (default off) [VIA686A/686B only]
1880 ac97_clock - AC'97 codec clock base (default 48000Hz)
1881 dxs_support - support DXS channels,
2d7eb7cb
SV
1882 0 = auto (default), 1 = enable, 2 = disable,
1883 3 = 48k only, 4 = no VRA, 5 = enable any sample
1884 rate and different sample rates on different
1885 channels
1886 [VIA8233/C, 8235, 8237 only]
1da177e4 1887 ac97_quirk - AC'97 workaround for strange hardware
6243008b 1888 See "AC97 Quirk Option" section below.
1da177e4 1889
b7fe4622 1890 This module supports one chip and autoprobe.
1da177e4
LT
1891
1892 Note: on some SMP motherboards like MSI 694D the interrupts might
1893 not be generated properly. In such a case, please try to
1894 set the SMP (or MPS) version on BIOS to 1.1 instead of
1895 default value 1.4. Then the interrupt number will be
1896 assigned under 15. You might also upgrade your BIOS.
1897
2d7eb7cb 1898 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
1da177e4 1899 channels as the first PCM. On these channels, up to 4
2d7eb7cb
SV
1900 streams can be played at the same time, and the controller
1901 can perform sample rate conversion with separate rates for
1902 each channel.
1da177e4
LT
1903 As default (dxs_support = 0), 48k fixed rate is chosen
1904 except for the known devices since the output is often
1905 noisy except for 48k on some mother boards due to the
1906 bug of BIOS.
2d7eb7cb 1907 Please try once dxs_support=5 and if it works on other
1da177e4
LT
1908 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1909 know the PCI subsystem vendor/device id's (output of
1910 "lspci -nv").
cdc27f3a
TI
1911 If dxs_support=5 does not work, try dxs_support=4; if it
1912 doesn't work too, try dxs_support=1. (dxs_support=1 is
6243008b 1913 usually for old motherboards. The correct implemented
cdc27f3a 1914 board should work with 4 or 5.) If it still doesn't
1da177e4
LT
1915 work and the default setting is ok, dxs_support=3 is the
1916 right choice. If the default setting doesn't work at all,
1917 try dxs_support=2 to disable the DXS channels.
1918 In any cases, please let us know the result and the
6243008b
TI
1919 subsystem vendor/device ids. See "Links and Addresses"
1920 below.
1da177e4
LT
1921
1922 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
6243008b 1923 additionally. The mpu_port option is for VIA686 chips only.
1da177e4 1924
a4efc230
TI
1925 The power-management is supported.
1926
1da177e4
LT
1927 Module snd-via82xx-modem
1928 ------------------------
1929
1930 Module for VIA82xx AC97 modem
1931
1932 ac97_clock - AC'97 codec clock base (default 48000Hz)
1933
b7fe4622 1934 This module supports one card and autoprobe.
1da177e4
LT
1935
1936 Note: The default index value of this module is -2, i.e. the first
1937 slot is excluded.
1938
a4efc230
TI
1939 The power-management is supported.
1940
1da177e4
LT
1941 Module snd-virmidi
1942 ------------------
1943
1944 Module for virtual rawmidi devices.
1945 This module creates virtual rawmidi devices which communicate
1946 to the corresponding ALSA sequencer ports.
1947
0ef797c5 1948 midi_devs - MIDI devices # (1-4, default=4)
1da177e4 1949
0ef797c5 1950 This module supports multiple cards.
1da177e4 1951
48a8a26d
CL
1952 Module snd-virtuoso
1953 -------------------
1954
5430c72b 1955 Module for sound cards based on the Asus AV100/AV200 chips,
d1db38c0 1956 i.e., Xonar D1, DX, D2, D2X, DS, HDAV1.3 (Deluxe), Essence ST
04f9890d 1957 (Deluxe) and Essence STX.
48a8a26d
CL
1958
1959 This module supports autoprobe and multiple cards.
1960
1da177e4
LT
1961 Module snd-vx222
1962 ----------------
1963
1964 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1965
1966 mic - Enable Microphone on V222 Mic (NYI)
1967 ibl - Capture IBL size. (default = 0, minimum size)
1968
0ef797c5 1969 This module supports multiple cards.
1da177e4
LT
1970
1971 When the driver is compiled as a module and the hotplug firmware
1972 is supported, the firmware data is loaded via hotplug automatically.
1973 Install the necessary firmware files in alsa-firmware package.
1974 When no hotplug fw loader is available, you need to load the
1975 firmware via vxloader utility in alsa-tools package. To invoke
1976 vxloader automatically, add the following to /etc/modprobe.conf
1977
1978 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1979
1980 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1981 /etc/modules.conf, instead.)
1982 IBL size defines the interrupts period for PCM. The smaller size
1983 gives smaller latency but leads to more CPU consumption, too.
1984 The size is usually aligned to 126. As default (=0), the smallest
1985 size is chosen. The possible IBL values can be found in
1986 /proc/asound/cardX/vx-status proc file.
1987
a4efc230
TI
1988 The power-management is supported.
1989
1da177e4
LT
1990 Module snd-vxpocket
1991 -------------------
1992
6d00a312 1993 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
1da177e4
LT
1994
1995 ibl - Capture IBL size. (default = 0, minimum size)
1996
0ef797c5 1997 This module supports multiple cards. The module is compiled only when
1da177e4
LT
1998 PCMCIA is supported on kernel.
1999
6243008b
TI
2000 With the older 2.6.x kernel, to activate the driver via the card
2001 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
2002 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
2003 longer require a config file.
1da177e4
LT
2004
2005 When the driver is compiled as a module and the hotplug firmware
2006 is supported, the firmware data is loaded via hotplug automatically.
2007 Install the necessary firmware files in alsa-firmware package.
2008 When no hotplug fw loader is available, you need to load the
2009 firmware via vxloader utility in alsa-tools package.
2010
2011 About capture IBL, see the description of snd-vx222 module.
2012
ed7cbe3e 2013 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
6243008b
TI
2014 ALSA 1.0.10.
2015
a4efc230
TI
2016 The power-management is supported.
2017
1da177e4
LT
2018 Module snd-ymfpci
2019 -----------------
2020
2021 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
2022
2023 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
2024 1 (auto-detect for YMF744/754 only)
2025 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
2026 1 (auto-detect for YMF744/754 only)
2027 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
2028 1 (auto-detect)
2029 rear_switch - enable shared rear/line-in switch (bool)
2030
0ef797c5 2031 This module supports autoprobe and multiple chips.
1da177e4
LT
2032
2033 The power-management is supported.
2034
2035 Module snd-pdaudiocf
2036 --------------------
2037
2038 Module for Sound Core PDAudioCF sound card.
2039
a4efc230
TI
2040 The power-management is supported.
2041
1da177e4 2042
6243008b
TI
2043AC97 Quirk Option
2044=================
2045
2046The ac97_quirk option is used to enable/override the workaround for
2047specific devices on drivers for on-board AC'97 controllers like
2048snd-intel8x0. Some hardware have swapped output pins between Master
2049and Headphone, or Surround (thanks to confusion of AC'97
2050specifications from version to version :-)
2051
2052The driver provides the auto-detection of known problematic devices,
2053but some might be unknown or wrongly detected. In such a case, pass
2054the proper value with this option.
2055
2056The following strings are accepted:
2057 - default Don't override the default setting
10e4097f 2058 - none Disable the quirk
6243008b
TI
2059 - hp_only Bind Master and Headphone controls as a single control
2060 - swap_hp Swap headphone and master controls
2061 - swap_surround Swap master and surround controls
2062 - ad_sharing For AD1985, turn on OMS bit and use headphone
2063 - alc_jack For ALC65x, turn on the jack sense mode
2064 - inv_eapd Inverted EAPD implementation
2065 - mute_led Bind EAPD bit for turning on/off mute LED
2066
2067For backward compatibility, the corresponding integer value -1, 0,
2068... are accepted, too.
2069
2070For example, if "Master" volume control has no effect on your device
2071but only "Headphone" does, pass ac97_quirk=hp_only module option.
2072
2073
1da177e4
LT
2074Configuring Non-ISAPNP Cards
2075============================
2076
2077When the kernel is configured with ISA-PnP support, the modules
2078supporting the isapnp cards will have module options "isapnp".
2079If this option is set, *only* the ISA-PnP devices will be probed.
2080For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
2081together with the proper i/o and irq configuration.
2082
2083When the kernel is configured without ISA-PnP support, isapnp option
2084will be not built in.
2085
2086
2087Module Autoloading Support
2088==========================
2089
2090The ALSA drivers can be loaded automatically on demand by defining
2091module aliases. The string 'snd-card-%1' is requested for ALSA native
2092devices where %i is sound card number from zero to seven.
2093
2094To auto-load an ALSA driver for OSS services, define the string
2095'sound-slot-%i' where %i means the slot number for OSS, which
2096corresponds to the card index of ALSA. Usually, define this
d533f671 2097as the same card module.
1da177e4
LT
2098
2099An example configuration for a single emu10k1 card is like below:
2100----- /etc/modprobe.conf
2101alias snd-card-0 snd-emu10k1
2102alias sound-slot-0 snd-emu10k1
2103----- /etc/modprobe.conf
2104
2105The available number of auto-loaded sound cards depends on the module
2106option "cards_limit" of snd module. As default it's set to 1.
2107To enable the auto-loading of multiple cards, specify the number of
2108sound cards in that option.
2109
2110When multiple cards are available, it'd better to specify the index
2111number for each card via module option, too, so that the order of
2112cards is kept consistent.
2113
2114An example configuration for two sound cards is like below:
2115
2116----- /etc/modprobe.conf
2117# ALSA portion
2118options snd cards_limit=2
2119alias snd-card-0 snd-interwave
2120alias snd-card-1 snd-ens1371
2121options snd-interwave index=0
2122options snd-ens1371 index=1
2123# OSS/Free portion
2124alias sound-slot-0 snd-interwave
2125alias sound-slot-1 snd-ens1371
2fe0ae78 2126----- /etc/modprobe.conf
1da177e4
LT
2127
2128In this example, the interwave card is always loaded as the first card
2129(index 0) and ens1371 as the second (index 1).
2130
304cd07f
TI
2131Alternative (and new) way to fixate the slot assignment is to use
2132"slots" option of snd module. In the case above, specify like the
2133following:
2134
2135options snd slots=snd-interwave,snd-ens1371
2136
2137Then, the first slot (#0) is reserved for snd-interwave driver, and
2138the second (#1) for snd-ens1371. You can omit index option in each
2139driver if slots option is used (although you can still have them at
2140the same time as long as they don't conflict).
2141
2142The slots option is especially useful for avoiding the possible
2143hot-plugging and the resultant slot conflict. For example, in the
2144case above again, the first two slots are already reserved. If any
2145other driver (e.g. snd-usb-audio) is loaded before snd-interwave or
2146snd-ens1371, it will be assigned to the third or later slot.
2147
a93bbaa7
TI
2148When a module name is given with '!', the slot will be given for any
2149modules but that name. For example, "slots=!snd-pcsp" will reserve
2150the first slot for any modules but snd-pcsp.
2151
1da177e4
LT
2152
2153ALSA PCM devices to OSS devices mapping
2154=======================================
2155
2156/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
2157/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
2158/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
2159/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
2160/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
2161/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
2162/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
2163/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
2164/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
2165
2166The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
2167sound card number and second means device number. The ALSA devices
2168have either 'c' or 'p' suffix indicating the direction, capture and
2169playback, respectively.
2170
2171Please note that the device mapping above may be varied via the module
2172options of snd-pcm-oss module.
2173
2174
1da177e4
LT
2175Proc interfaces (/proc/asound)
2176==============================
2177
2178/proc/asound/card#/pcm#[cp]/oss
2179-------------------------------
2180 String "erase" - erase all additional informations about OSS applications
2181 String "<app_name> <fragments> <fragment_size> [<options>]"
2182
2183 <app_name> - name of application with (higher priority) or without path
2184 <fragments> - number of fragments or zero if auto
2185 <fragment_size> - size of fragment in bytes or zero if auto
2186 <options> - optional parameters
2187 - disable the application tries to open a pcm device for
2188 this channel but does not want to use it.
2189 (Cause a bug or mmap needs)
2190 It's good for Quake etc...
2191 - direct don't use plugins
2192 - block force block mode (rvplayer)
2193 - non-block force non-block mode
2194 - whole-frag write only whole fragments (optimization affecting
2195 playback only)
2196 - no-silence do not fill silence ahead to avoid clicks
10f69f9e
TI
2197 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
2198 instead of filled blocks
1da177e4
LT
2199
2200 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
2201 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
2202 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
2203
2204
b6a96915
TI
2205Early Buffer Allocation
2206=======================
2207
2208Some drivers (e.g. hdsp) require the large contiguous buffers, and
2209sometimes it's too late to find such spaces when the driver module is
2210actually loaded due to memory fragmentation. You can pre-allocate the
2211PCM buffers by loading snd-page-alloc module and write commands to its
2212proc file in prior, for example, in the early boot stage like
2213/etc/init.d/*.local scripts.
2214
2215Reading the proc file /proc/drivers/snd-page-alloc shows the current
2216usage of page allocation. In writing, you can send the following
2217commands to the snd-page-alloc driver:
2218
2219 - add VENDOR DEVICE MASK SIZE BUFFERS
2220
2221 VENDOR and DEVICE are PCI vendor and device IDs. They take
2222 integer numbers (0x prefix is needed for the hex).
2223 MASK is the PCI DMA mask. Pass 0 if not restricted.
2224 SIZE is the size of each buffer to allocate. You can pass
2225 k and m suffix for KB and MB. The max number is 16MB.
2226 BUFFERS is the number of buffers to allocate. It must be greater
2227 than 0. The max number is 4.
2228
2229 - erase
2230
2231 This will erase the all pre-allocated buffers which are not in
2232 use.
2233
2234
6243008b
TI
2235Links and Addresses
2236===================
1da177e4
LT
2237
2238 ALSA project homepage
2239 http://www.alsa-project.org
2240
30bc4481
TI
2241 Kernel Bugzilla
2242 http://bugzilla.kernel.org/
6243008b
TI
2243
2244 ALSA Developers ML
4505179c 2245 mailto:alsa-devel@alsa-project.org
30bc4481
TI
2246
2247 alsa-info.sh script
2248 http://www.alsa-project.org/alsa-info.sh