]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - Documentation/sound/alsa/ALSA-Configuration.txt
[ALSA] hda-codec - Add missing Mic Boost controls for ALC262
[mirror_ubuntu-zesty-kernel.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.
1da177e4
LT
60
61
62 Module snd-pcm-oss
63 ------------------
64
65 The PCM OSS emulation module.
66 This module takes options which change the mapping of devices.
67
68 dsp_map - PCM device number maps assigned to the 1st OSS device.
69 - Default: 0
70 adsp_map - PCM device number maps assigned to the 2st OSS device.
71 - Default: 1
72 nonblock_open
6243008b 73 - Don't block opening busy PCM devices. Default: 1
1da177e4
LT
74
75 For example, when dsp_map=2, /dev/dsp will be mapped to PCM #2 of
76 the card #0. Similarly, when adsp_map=0, /dev/adsp will be mapped
77 to PCM #0 of the card #0.
78 For changing the second or later card, specify the option with
79 commas, such like "dsp_map=0,1".
80
81 nonblock_open option is used to change the behavior of the PCM
82 regarding opening the device. When this option is non-zero,
83 opening a busy OSS PCM device won't be blocked but return
84 immediately with EAGAIN (just like O_NONBLOCK flag).
85
86 Module snd-rawmidi
87 ------------------
88
89 This module takes options which change the mapping of devices.
90 similar to those of the snd-pcm-oss module.
91
92 midi_map - MIDI device number maps assigned to the 1st OSS device.
93 - Default: 0
94 amidi_map - MIDI device number maps assigned to the 2st OSS device.
95 - Default: 1
96
97 Common parameters for top sound card modules
98 --------------------------------------------
99
100 Each of top level sound card module takes the following options.
101
102 index - index (slot #) of sound card
0ef797c5 103 - Values: 0 through 31 or negative
1da177e4
LT
104 - If nonnegative, assign that index number
105 - if negative, interpret as a bitmask of permissible
106 indices; the first free permitted index is assigned
107 - Default: -1
108 id - card ID (identifier or name)
109 - Can be up to 15 characters long
110 - Default: the card type
111 - A directory by this name is created under /proc/asound/
112 containing information about the card
113 - This ID can be used instead of the index number in
114 identifying the card
115 enable - enable card
116 - Default: enabled, for PCI and ISA PnP cards
117
cf40a310
RH
118 Module snd-adlib
119 ----------------
120
121 Module for AdLib FM cards.
122
123 port - port # for OPL chip
124
125 This module supports multiple cards. It does not support autoprobe, so
126 the port must be specified. For actual AdLib FM cards it will be 0x388.
127 Note that this card does not have PCM support and no mixer; only FM
128 synthesis.
129
130 Make sure you have "sbiload" from the alsa-tools package available and,
131 after loading the module, find out the assigned ALSA sequencer port
132 number through "sbiload -l". Example output:
133
134 Port Client name Port name
135 64:0 OPL2 FM synth OPL2 FM Port
136
137 Load the std.sb and drums.sb patches also supplied by sbiload:
138
139 sbiload -p 64:0 std.sb drums.sb
140
141 If you use this driver to drive an OPL3, you can use std.o3 and drums.o3
142 instead. To have the card produce sound, use aplaymidi from alsa-utils:
143
144 aplaymidi -p 64:0 foo.mid
145
1da177e4
LT
146 Module snd-ad1816a
147 ------------------
148
149 Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips.
150
151 port - port # for AD1816A chip (PnP setup)
152 mpu_port - port # for MPU-401 UART (PnP setup)
153 fm_port - port # for OPL3 (PnP setup)
154 irq - IRQ # for AD1816A chip (PnP setup)
155 mpu_irq - IRQ # for MPU-401 UART (PnP setup)
156 dma1 - first DMA # for AD1816A chip (PnP setup)
157 dma2 - second DMA # for AD1816A chip (PnP setup)
506d4c6a 158 clockfreq - Clock frequency for AD1816A chip (default = 0, 33000Hz)
1da177e4 159
0ef797c5 160 This module supports multiple cards, autoprobe and PnP.
1da177e4
LT
161
162 Module snd-ad1848
163 -----------------
164
165 Module for sound cards based on AD1848/AD1847/CS4248 ISA chips.
166
167 port - port # for AD1848 chip
168 irq - IRQ # for AD1848 chip
169 dma1 - DMA # for AD1848 chip (0,1,3)
170
0ef797c5 171 This module supports multiple cards. It does not support autoprobe
1da177e4
LT
172 thus main port must be specified!!! Other ports are optional.
173
a4efc230
TI
174 The power-management is supported.
175
84010e6f
CL
176 Module snd-ad1889
177 -----------------
178
179 Module for Analog Devices AD1889 chips.
180
181 ac97_quirk - AC'97 workaround for strange hardware
182 See the description of intel8x0 module for details.
183
0ef797c5 184 This module supports multiple cards.
84010e6f 185
1da177e4
LT
186 Module snd-ali5451
187 ------------------
188
189 Module for ALi M5451 PCI chip.
190
191 pcm_channels - Number of hardware channels assigned for PCM
192 spdif - Support SPDIF I/O
193 - Default: disabled
194
8a3fb4d0 195 This module supports one chip and autoprobe.
1da177e4
LT
196
197 The power-management is supported.
198
199 Module snd-als100
200 -----------------
201
202 Module for sound cards based on Avance Logic ALS100/ALS120 ISA chips.
203
204 port - port # for ALS100 (SB16) chip (PnP setup)
205 irq - IRQ # for ALS100 (SB16) chip (PnP setup)
206 dma8 - 8-bit DMA # for ALS100 (SB16) chip (PnP setup)
207 dma16 - 16-bit DMA # for ALS100 (SB16) chip (PnP setup)
208 mpu_port - port # for MPU-401 UART (PnP setup)
209 mpu_irq - IRQ # for MPU-401 (PnP setup)
210 fm_port - port # for OPL3 FM (PnP setup)
211
0ef797c5 212 This module supports multiple cards, autoprobe and PnP.
1da177e4 213
a4efc230
TI
214 The power-management is supported.
215
b3a70d5e
AW
216 Module snd-als300
217 -----------------
218
219 Module for Avance Logic ALS300 and ALS300+
220
221 This module supports multiple cards.
222
223 The power-management is supported.
224
1da177e4
LT
225 Module snd-als4000
226 ------------------
227
228 Module for sound cards based on Avance Logic ALS4000 PCI chip.
229
230 joystick_port - port # for legacy joystick support.
231 0 = disabled (default), 1 = auto-detect
232
0ef797c5 233 This module supports multiple cards, autoprobe and PnP.
1da177e4 234
a4efc230
TI
235 The power-management is supported.
236
1da177e4
LT
237 Module snd-atiixp
238 -----------------
239
6243008b 240 Module for ATI IXP 150/200/250/400 AC97 controllers.
1da177e4 241
6243008b 242 ac97_clock - AC'97 clock (default = 48000)
1da177e4 243 ac97_quirk - AC'97 workaround for strange hardware
6243008b 244 See "AC97 Quirk Option" section below.
14e1d357
DC
245 ac97_codec - Workaround to specify which AC'97 codec
246 instead of probing. If this works for you
247 file a bug with your `lspci -vn` output.
248 -2 -- Force probing.
249 -1 -- Default behavior.
250 0-2 -- Use the specified codec.
1da177e4
LT
251 spdif_aclink - S/PDIF transfer over AC-link (default = 1)
252
b7fe4622 253 This module supports one card and autoprobe.
1da177e4 254
6243008b
TI
255 ATI IXP has two different methods to control SPDIF output. One is
256 over AC-link and another is over the "direct" SPDIF output. The
257 implementation depends on the motherboard, and you'll need to
258 choose the correct one via spdif_aclink module option.
259
a4efc230
TI
260 The power-management is supported.
261
1da177e4
LT
262 Module snd-atiixp-modem
263 -----------------------
264
265 Module for ATI IXP 150/200/250 AC97 modem controllers.
266
b7fe4622 267 This module supports one card and autoprobe.
1da177e4
LT
268
269 Note: The default index value of this module is -2, i.e. the first
270 slot is excluded.
271
a4efc230
TI
272 The power-management is supported.
273
1da177e4
LT
274 Module snd-au8810, snd-au8820, snd-au8830
275 -----------------------------------------
276
277 Module for Aureal Vortex, Vortex2 and Advantage device.
278
279 pcifix - Control PCI workarounds
280 0 = Disable all workarounds
281 1 = Force the PCI latency of the Aureal card to 0xff
282 2 = Force the Extend PCI#2 Internal Master for Efficient
283 Handling of Dummy Requests on the VIA KT133 AGP Bridge
284 3 = Force both settings
285 255 = Autodetect what is required (default)
286
287 This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
288 EQ, mpu401, gameport. A3D and wavetable support are still in development.
289 Development and reverse engineering work is being coordinated at
290 http://savannah.nongnu.org/projects/openvortex/
291 SPDIF output has a copy of the AC97 codec output, unless you use the
292 "spdif" pcm device, which allows raw data passthru.
293 The hardware EQ hardware and SPDIF is only present in the Vortex2 and
294 Advantage.
295
6243008b 296 Note: Some ALSA mixer applications don't handle the SPDIF sample rate
1da177e4
LT
297 control correctly. If you have problems regarding this, try
298 another ALSA compliant mixer (alsamixer works).
299
300 Module snd-azt2320
301 ------------------
302
303 Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
304
305 port - port # for AZT2320 chip (PnP setup)
306 wss_port - port # for WSS (PnP setup)
307 mpu_port - port # for MPU-401 UART (PnP setup)
308 fm_port - FM port # for AZT2320 chip (PnP setup)
309 irq - IRQ # for AZT2320 (WSS) chip (PnP setup)
310 mpu_irq - IRQ # for MPU-401 UART (PnP setup)
311 dma1 - 1st DMA # for AZT2320 (WSS) chip (PnP setup)
312 dma2 - 2nd DMA # for AZT2320 (WSS) chip (PnP setup)
313
0ef797c5 314 This module supports multiple cards, PnP and autoprobe.
1da177e4 315
a4efc230
TI
316 The power-management is supported.
317
1da177e4
LT
318 Module snd-azt3328
319 ------------------
320
321 Module for sound cards based on Aztech AZF3328 PCI chip.
322
323 joystick - Enable joystick (default off)
324
0ef797c5 325 This module supports multiple cards.
1da177e4
LT
326
327 Module snd-bt87x
328 ----------------
329
330 Module for video cards based on Bt87x chips.
331
332 digital_rate - Override the default digital rate (Hz)
333 load_all - Load the driver even if the card model isn't known
334
0ef797c5 335 This module supports multiple cards.
1da177e4
LT
336
337 Note: The default index value of this module is -2, i.e. the first
338 slot is excluded.
339
340 Module snd-ca0106
341 -----------------
342
343 Module for Creative Audigy LS and SB Live 24bit
344
0ef797c5 345 This module supports multiple cards.
1da177e4
LT
346
347
348 Module snd-cmi8330
349 ------------------
350
351 Module for sound cards based on C-Media CMI8330 ISA chips.
352
353 wssport - port # for CMI8330 chip (WSS)
354 wssirq - IRQ # for CMI8330 chip (WSS)
355 wssdma - first DMA # for CMI8330 chip (WSS)
356 sbport - port # for CMI8330 chip (SB16)
357 sbirq - IRQ # for CMI8330 chip (SB16)
358 sbdma8 - 8bit DMA # for CMI8330 chip (SB16)
359 sbdma16 - 16bit DMA # for CMI8330 chip (SB16)
360
0ef797c5 361 This module supports multiple cards and autoprobe.
1da177e4 362
a4efc230
TI
363 The power-management is supported.
364
1da177e4
LT
365 Module snd-cmipci
366 -----------------
367
368 Module for C-Media CMI8338 and 8738 PCI sound cards.
369
cab5c4c9
TI
370 mpu_port - 0x300,0x310,0x320,0x330 = legacy port,
371 1 = integrated PCI port,
372 0 = disable (default)
1da177e4 373 fm_port - 0x388 (default), 0 = disable (default)
6243008b 374 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
1da177e4
LT
375 (default = 1)
376 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
377
0ef797c5 378 This module supports autoprobe and multiple cards.
1da177e4 379
a4efc230
TI
380 The power-management is supported.
381
1da177e4
LT
382 Module snd-cs4231
383 -----------------
384
385 Module for sound cards based on CS4231 ISA chips.
386
387 port - port # for CS4231 chip
388 mpu_port - port # for MPU-401 UART (optional), -1 = disable
389 irq - IRQ # for CS4231 chip
390 mpu_irq - IRQ # for MPU-401 UART
391 dma1 - first DMA # for CS4231 chip
392 dma2 - second DMA # for CS4231 chip
393
0ef797c5 394 This module supports multiple cards. This module does not support autoprobe
1da177e4
LT
395 thus main port must be specified!!! Other ports are optional.
396
397 The power-management is supported.
398
399 Module snd-cs4232
400 -----------------
401
402 Module for sound cards based on CS4232/CS4232A ISA chips.
403
404 port - port # for CS4232 chip (PnP setup - 0x534)
405 cport - control port # for CS4232 chip (PnP setup - 0x120,0x210,0xf00)
406 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
407 fm_port - FM port # for CS4232 chip (PnP setup - 0x388), -1 = disable
408 irq - IRQ # for CS4232 chip (5,7,9,11,12,15)
409 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
410 dma1 - first DMA # for CS4232 chip (0,1,3)
411 dma2 - second DMA # for Yamaha CS4232 chip (0,1,3), -1 = disable
412 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
413
0ef797c5 414 This module supports multiple cards. This module does not support autoprobe
1da177e4
LT
415 thus main port must be specified!!! Other ports are optional.
416
417 The power-management is supported.
418
419 Module snd-cs4236
420 -----------------
421
422 Module for sound cards based on CS4235/CS4236/CS4236B/CS4237B/
423 CS4238B/CS4239 ISA chips.
424
425 port - port # for CS4236 chip (PnP setup - 0x534)
426 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
427 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
428 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
429 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
430 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
431 dma1 - first DMA # for CS4236 chip (0,1,3)
432 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
433 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
434
0ef797c5 435 This module supports multiple cards. This module does not support autoprobe
1da177e4
LT
436 (if ISA PnP is not used) thus main port and control port must be
437 specified!!! Other ports are optional.
438
439 The power-management is supported.
440
441 Module snd-cs4281
442 -----------------
443
444 Module for Cirrus Logic CS4281 soundchip.
445
446 dual_codec - Secondary codec ID (0 = disable, default)
447
0ef797c5 448 This module supports multiple cards.
1da177e4
LT
449
450 The power-management is supported.
451
452 Module snd-cs46xx
453 -----------------
454
455 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
456 CS4624/CS4630/CS4280 PCI chips.
457
6243008b 458 external_amp - Force to enable external amplifier.
1da177e4
LT
459 thinkpad - Force to enable Thinkpad's CLKRUN control.
460 mmap_valid - Support OSS mmap mode (default = 0).
461
0ef797c5 462 This module supports multiple cards and autoprobe.
1da177e4
LT
463 Usually external amp and CLKRUN controls are detected automatically
464 from PCI sub vendor/device ids. If they don't work, give the options
465 above explicitly.
466
467 The power-management is supported.
468
3e873174
TI
469 Module snd-cs5535audio
470 ----------------------
471
472 Module for multifunction CS5535 companion PCI device
473
c00bd74a 474 The power-management is supported.
3e873174 475
dd7b254d
GP
476 Module snd-darla20
477 ------------------
478
479 Module for Echoaudio Darla20
480
481 This module supports multiple cards.
482 The driver requires the firmware loader support on kernel.
483
484 Module snd-darla24
485 ------------------
486
487 Module for Echoaudio Darla24
488
489 This module supports multiple cards.
490 The driver requires the firmware loader support on kernel.
491
1da177e4
LT
492 Module snd-dt019x
493 -----------------
494
495 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
496 only)
497
498 port - Port # (PnP setup)
499 mpu_port - Port # for MPU-401 (PnP setup)
500 fm_port - Port # for FM OPL-3 (PnP setup)
501 irq - IRQ # (PnP setup)
502 mpu_irq - IRQ # for MPU-401 (PnP setup)
503 dma8 - DMA # (PnP setup)
504
0ef797c5 505 This module supports multiple cards. This module is enabled only with
1da177e4
LT
506 ISA PnP support.
507
a4efc230
TI
508 The power-management is supported.
509
1da177e4
LT
510 Module snd-dummy
511 ----------------
512
513 Module for the dummy sound card. This "card" doesn't do any output
514 or input, but you may use this module for any application which
515 requires a sound card (like RealPlayer).
516
a4efc230
TI
517 The power-management is supported.
518
dd7b254d
GP
519 Module snd-echo3g
520 -----------------
521
522 Module for Echoaudio 3G cards (Gina3G/Layla3G)
523
524 This module supports multiple cards.
525 The driver requires the firmware loader support on kernel.
526
1da177e4
LT
527 Module snd-emu10k1
528 ------------------
529
530 Module for EMU10K1/EMU10k2 based PCI sound cards.
531 * Sound Blaster Live!
532 * Sound Blaster PCI 512
533 * Emu APS (partially supported)
534 * Sound Blaster Audigy
535
536 extin - bitmap of available external inputs for FX8010 (see bellow)
537 extout - bitmap of available external outputs for FX8010 (see bellow)
538 seq_ports - allocated sequencer ports (4 by default)
539 max_synth_voices - limit of voices used for wavetable (64 by default)
540 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
541 given in MB unit. Default value is 128.
542 enable_ir - enable IR
543
0ef797c5 544 This module supports multiple cards and autoprobe.
1da177e4
LT
545
546 Input & Output configurations [extin/extout]
547 * Creative Card wo/Digital out [0x0003/0x1f03]
548 * Creative Card w/Digital out [0x0003/0x1f0f]
549 * Creative Card w/Digital CD in [0x000f/0x1f0f]
550 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
551 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
552 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
553 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
554 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
555 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
556 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
557 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
558 * Creative Card all ins and outs [0x3fff/0x7fff]
559
a4efc230
TI
560 The power-management is supported.
561
1da177e4
LT
562 Module snd-emu10k1x
563 -------------------
564
565 Module for Creative Emu10k1X (SB Live Dell OEM version)
566
0ef797c5 567 This module supports multiple cards.
1da177e4
LT
568
569 Module snd-ens1370
570 ------------------
571
572 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
573 * SoundBlaster PCI 64
574 * SoundBlaster PCI 128
575
576 joystick - Enable joystick (default off)
577
0ef797c5 578 This module supports multiple cards and autoprobe.
1da177e4 579
d6ec894b
TI
580 The power-management is supported.
581
1da177e4
LT
582 Module snd-ens1371
583 ------------------
584
585 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
586 * SoundBlaster PCI 64
587 * SoundBlaster PCI 128
588 * SoundBlaster Vibra PCI
589
590 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
591 0 = disable (default), 1 = auto-detect
592
0ef797c5 593 This module supports multiple cards and autoprobe.
1da177e4 594
d6ec894b
TI
595 The power-management is supported.
596
1da177e4
LT
597 Module snd-es968
598 ----------------
599
600 Module for sound cards based on ESS ES968 chip (PnP only).
601
602 port - port # for ES968 (SB8) chip (PnP setup)
603 irq - IRQ # for ES968 (SB8) chip (PnP setup)
604 dma1 - DMA # for ES968 (SB8) chip (PnP setup)
605
0ef797c5 606 This module supports multiple cards, PnP and autoprobe.
1da177e4 607
a4efc230
TI
608 The power-management is supported.
609
1da177e4
LT
610 Module snd-es1688
611 -----------------
612
613 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
614
615 port - port # for ES-1688 chip (0x220,0x240,0x260)
616 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
617 irq - IRQ # for ES-1688 chip (5,7,9,10)
618 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
619 dma8 - DMA # for ES-1688 chip (0,1,3)
620
0ef797c5 621 This module supports multiple cards and autoprobe (without MPU-401 port).
1da177e4
LT
622
623 Module snd-es18xx
624 -----------------
625
626 Module for ESS AudioDrive ES-18xx sound cards.
627
628 port - port # for ES-18xx chip (0x220,0x240,0x260)
629 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
630 fm_port - port # for FM (optional, not used)
631 irq - IRQ # for ES-18xx chip (5,7,9,10)
632 dma1 - first DMA # for ES-18xx chip (0,1,3)
633 dma2 - first DMA # for ES-18xx chip (0,1,3)
634 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
635
0ef797c5
CL
636 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
637 port if native ISA PnP routines are not used).
1da177e4
LT
638 When dma2 is equal with dma1, the driver works as half-duplex.
639
640 The power-management is supported.
641
642 Module snd-es1938
643 -----------------
644
645 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
646
0ef797c5 647 This module supports multiple cards and autoprobe.
1da177e4 648
a4efc230
TI
649 The power-management is supported.
650
1da177e4
LT
651 Module snd-es1968
652 -----------------
653
654 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
655
656 total_bufsize - total buffer size in kB (1-4096kB)
657 pcm_substreams_p - playback channels (1-8, default=2)
658 pcm_substreams_c - capture channels (1-8, default=0)
659 clock - clock (0 = auto-detection)
660 use_pm - support the power-management (0 = off, 1 = on,
661 2 = auto (default))
662 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
663 joystick - enable joystick (default off)
664
0ef797c5 665 This module supports multiple cards and autoprobe.
1da177e4
LT
666
667 The power-management is supported.
668
669 Module snd-fm801
670 ----------------
671
672 Module for ForteMedia FM801 based PCI sound cards.
673
674 tea575x_tuner - Enable TEA575x tuner
675 - 1 = MediaForte 256-PCS
676 - 2 = MediaForte 256-PCPR
677 - 3 = MediaForte 64-PCR
678 - High 16-bits are video (radio) device number + 1
679 - example: 0x10002 (MediaForte 256-PCPR, device 1)
680
0ef797c5 681 This module supports multiple cards and autoprobe.
1da177e4 682
a4efc230
TI
683 The power-management is supported.
684
dd7b254d
GP
685 Module snd-gina20
686 -----------------
687
688 Module for Echoaudio Gina20
689
690 This module supports multiple cards.
691 The driver requires the firmware loader support on kernel.
692
693 Module snd-gina24
694 -----------------
695
696 Module for Echoaudio Gina24
697
698 This module supports multiple cards.
699 The driver requires the firmware loader support on kernel.
700
1da177e4
LT
701 Module snd-gusclassic
702 ---------------------
703
704 Module for Gravis UltraSound Classic sound card.
705
706 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
707 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
708 dma1 - DMA # for GF1 chip (1,3,5,6,7)
709 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
710 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
711 voices - GF1 voices limit (14-32)
712 pcm_voices - reserved PCM voices
713
0ef797c5 714 This module supports multiple cards and autoprobe.
1da177e4
LT
715
716 Module snd-gusextreme
717 ---------------------
718
719 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
720
721 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
722 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
723 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
724 irq - IRQ # for ES-1688 chip (5,7,9,10)
725 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
726 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
727 dma8 - DMA # for ES-1688 chip (0,1,3)
728 dma1 - DMA # for GF1 chip (1,3,5,6,7)
729 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
730 voices - GF1 voices limit (14-32)
731 pcm_voices - reserved PCM voices
732
0ef797c5 733 This module supports multiple cards and autoprobe (without MPU-401 port).
1da177e4
LT
734
735 Module snd-gusmax
736 -----------------
737
738 Module for Gravis UltraSound MAX sound card.
739
740 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
741 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
742 dma1 - DMA # for GF1 chip (1,3,5,6,7)
743 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
744 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
745 voices - GF1 voices limit (14-32)
746 pcm_voices - reserved PCM voices
747
0ef797c5 748 This module supports multiple cards and autoprobe.
1da177e4
LT
749
750 Module snd-hda-intel
751 --------------------
752
9b87819b
TI
753 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8),
754 ATI SB450, SB600, RS600,
755 VIA VT8251/VT8237A,
756 SIS966, ULI M5461
1da177e4
LT
757
758 model - force the model name
6243008b 759 position_fix - Fix DMA pointer (0 = auto, 1 = none, 2 = POSBUF, 3 = FIFO size)
27346166
TI
760 single_cmd - Use single immediate commands to communicate with
761 codecs (for debugging only)
134a11f0 762 enable_msi - Enable Message Signaled Interrupt (MSI) (default = off)
1da177e4 763
b7fe4622 764 This module supports one card and autoprobe.
1da177e4
LT
765
766 Each codec may have a model table for different configurations.
767 If your machine isn't listed there, the default (usually minimal)
768 configuration is set up. You can pass "model=<name>" option to
769 specify a certain model in such a case. There are different
770 models depending on the codec chip.
771
772 Model name Description
773 ---------- -----------
774 ALC880
775 3stack 3-jack in back and a headphone out
776 3stack-digout 3-jack in back, a HP out and a SPDIF out
777 5stack 5-jack in back, 2-jack in front
778 5stack-digout 5-jack in back, 2-jack in front, a SPDIF out
b6482d48
TI
779 6stack 6-jack in back, 2-jack in front
780 6stack-digout 6-jack with a SPDIF out
1da177e4 781 w810 3-jack
dfc0ff62 782 z71v 3-jack (HP shared SPDIF)
4b146cb0
TI
783 asus 3-jack (ASUS Mobo)
784 asus-w1v ASUS W1V
785 asus-dig ASUS with SPDIF out
786 asus-dig2 ASUS with SPDIF out (using GPIO2)
e9edcee0 787 uniwill 3-jack
2cf9f0fc 788 fujitsu Fujitsu Laptops (Pi1536)
e9edcee0 789 F1734 2-jack
ae6b813a 790 lg LG laptop (m1 express dual)
cd417d4f 791 lg-lw LG LW20/LW25 laptop
4b146cb0 792 tcl TCL S700
5a053d01 793 clevo Clevo laptops (m520G, m665n)
b6482d48
TI
794 test for testing/debugging purpose, almost all controls can be
795 adjusted. Appearing only when compiled with
796 $CONFIG_SND_DEBUG=y
ed345f8f 797 auto auto-config reading BIOS (default)
1da177e4 798
21be3d16
TI
799 ALC260
800 hp HP machines
4b146cb0 801 hp-3013 HP machines (3013-variant)
21be3d16 802 fujitsu Fujitsu S7020
ed345f8f
TI
803 acer Acer TravelMate
804 basic fixed pin assignment (old default model)
805 auto auto-config reading BIOS (default)
806
807 ALC262
808 fujitsu Fujitsu Laptop
6d177ba7 809 hp-bpc HP xw4400/6400/8400/9400 laptops
cd7509a4 810 hp-bpc-d7000 HP BPC D7000
304dcaac 811 benq Benq ED8
d1f67547 812 hippo Hippo (ATI) with jack detection, Sony UX-90s
ccc656ce 813 hippo_1 Hippo (Benq) with jack detection
ed345f8f
TI
814 basic fixed pin assignment w/o SPDIF
815 auto auto-config reading BIOS (default)
816
9c7f852e 817 ALC882/885
ed345f8f 818 3stack-dig 3-jack with SPDIF I/O
518f6a61 819 6stack-dig 6-jack digital with SPDIF I/O
4b146cb0 820 arima Arima W820Di1
518f6a61 821 macpro MacPro support
ed345f8f
TI
822 auto auto-config reading BIOS (default)
823
9c7f852e
TI
824 ALC883/888
825 3stack-dig 3-jack with SPDIF I/O
826 6stack-dig 6-jack digital with SPDIF I/O
4b146cb0
TI
827 3stack-6ch 3-jack 6-channel
828 3stack-6ch-dig 3-jack 6-channel with SPDIF I/O
829 6stack-dig-demo 6-jack digital for Intel demo board
bab282b9 830 acer Acer laptops (Travelmate 3012WTMi, Aspire 5600, etc)
c07584c8 831 medion Medion Laptops
ccc656ce
KY
832 targa-dig Targa/MSI
833 targa-2ch-dig Targs/MSI with 2-channel
b373bdeb 834 laptop-eapd 3-jack with SPDIF I/O and EAPD (Clevo M540JE, M550JE)
9c7f852e
TI
835 auto auto-config reading BIOS (default)
836
837 ALC861/660
ed345f8f
TI
838 3stack 3-jack
839 3stack-dig 3-jack with SPDIF I/O
840 6stack-dig 6-jack with SPDIF I/O
4b146cb0 841 3stack-660 3-jack (for ALC660)
22309c3e 842 uniwill-m31 Uniwill M31 laptop
a53d1aec 843 toshiba Toshiba laptop support
7cdbff94 844 asus Asus laptop support
56bb0cab 845 asus-laptop ASUS F2/F3 laptops
ed345f8f 846 auto auto-config reading BIOS (default)
21be3d16 847
f32610ed
JS
848 ALC861VD/660VD
849 3stack 3-jack
850 3stack-dig 3-jack with SPDIF OUT
851 6stack-dig 6-jack with SPDIF OUT
852 3stack-660 3-jack (for ALC660VD)
853 auto auto-config reading BIOS (default)
854
1da177e4
LT
855 CMI9880
856 minimal 3-jack in back
857 min_fp 3-jack in back, 2-jack in front
858 full 6-jack in back, 2-jack in front
859 full_dig 6-jack in back, 2-jack in front, SPDIF I/O
860 allout 5-jack in back, 2-jack in front, SPDIF out
e9edcee0 861 auto auto-config reading BIOS (default)
1da177e4 862
9230d214
TI
863 AD1981
864 basic 3-jack (default)
865 hp HP nx6320
01686c5f 866 thinkpad Lenovo Thinkpad T60/X60/Z60
9230d214
TI
867
868 AD1986A
869 6stack 6-jack, separate surrounds (default)
870 3stack 3-stack, shared surrounds
871 laptop 2-channel only (FSC V2060, Samsung M50)
825aa972 872 laptop-eapd 2-channel with EAPD (Samsung R65, ASUS A6J)
f36090fe 873 ultra 2-channel with EAPD (Samsung Ultra tablet PC)
9230d214
TI
874
875 AD1988
876 6stack 6-jack
877 6stack-dig ditto with SPDIF
878 3stack 3-jack
879 3stack-dig ditto with SPDIF
880 laptop 3-jack with hp-jack automute
881 laptop-dig ditto with SPDIF
99ccc560 882 auto auto-config reading BIOS (default)
c9b443d4
TD
883
884 Conexant 5045
885 laptop Laptop config
886 test for testing/debugging purpose, almost all controls
887 can be adjusted. Appearing only when compiled with
888 $CONFIG_SND_DEBUG=y
889
890 Conexant 5047
891 laptop Basic Laptop config
892 laptop-hp Laptop config for some HP models (subdevice 30A5)
893 laptop-eapd Laptop config with EAPD support
894 test for testing/debugging purpose, almost all controls
895 can be adjusted. Appearing only when compiled with
896 $CONFIG_SND_DEBUG=y
9230d214 897
93ed1503
TD
898 STAC9200/9205/9220/9221/9254
899 ref Reference board
900 3stack D945 3stack
901 5stack D945 5stack + SPDIF
902
8e21c34c
TD
903 STAC9202/9250/9251
904 ref Reference board, base config
905 m2-2 Some Gateway MX series laptops
906 m6 Some Gateway NX series laptops
907
93ed1503
TD
908 STAC9227/9228/9229/927x
909 ref Reference board
910 3stack D965 3stack
911 5stack D965 5stack + SPDIF
912
6d859065
GM
913 STAC9872
914 vaio Setup for VAIO FE550G/SZ110
915 vaio-ar Setup for VAIO AR
db064e50 916
6243008b
TI
917 If the default configuration doesn't work and one of the above
918 matches with your device, report it together with the PCI
919 subsystem ID (output of "lspci -nv") to ALSA BTS or alsa-devel
920 ML (see the section "Links and Addresses").
921
c74db86b
TI
922 Note 2: If you get click noises on output, try the module option
923 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
924 register value without FIFO size correction as the current
925 DMA pointer. position_fix=2 will make the driver to use
926 the position buffer instead of reading SD_LPIB register.
927 (Usually SD_LPLIB register is more accurate than the
928 position buffer.)
929
27346166
TI
930 NB: If you get many "azx_get_response timeout" messages at
931 loading, it's likely a problem of interrupts (e.g. ACPI irq
932 routing). Try to boot with options like "pci=noacpi". Also, you
933 can try "single_cmd=1" module option. This will switch the
934 communication method between HDA controller and codecs to the
935 single immediate commands instead of CORB/RIRB. Basically, the
936 single command mode is provided only for BIOS, and you won't get
937 unsolicited events, too. But, at least, this works independently
938 from the irq. Remember this is a last resort, and should be
939 avoided as much as possible...
940
a4efc230
TI
941 The power-management is supported.
942
1da177e4
LT
943 Module snd-hdsp
944 ---------------
945
946 Module for RME Hammerfall DSP audio interface(s)
947
0ef797c5 948 This module supports multiple cards.
1da177e4
LT
949
950 Note: The firmware data can be automatically loaded via hotplug
951 when CONFIG_FW_LOADER is set. Otherwise, you need to load
952 the firmware via hdsploader utility included in alsa-tools
953 package.
954 The firmware data is found in alsa-firmware package.
955
956 Note: snd-page-alloc module does the job which snd-hammerfall-mem
957 module did formerly. It will allocate the buffers in advance
958 when any HDSP cards are found. To make the buffer
959 allocation sure, load snd-page-alloc module in the early
b6a96915
TI
960 stage of boot sequence. See "Early Buffer Allocation"
961 section.
1da177e4 962
5470440a
TI
963 Module snd-hdspm
964 ----------------
965
966 Module for RME HDSP MADI board.
967
968 precise_ptr - Enable precise pointer, or disable.
969 line_outs_monitor - Send playback streams to analog outs by default.
970 enable_monitor - Enable Analog Out on Channel 63/64 by default.
971
972 See hdspm.txt for details.
973
1da177e4
LT
974 Module snd-ice1712
975 ------------------
976
977 Module for Envy24 (ICE1712) based PCI sound cards.
978 * MidiMan M Audio Delta 1010
979 * MidiMan M Audio Delta 1010LT
980 * MidiMan M Audio Delta DiO 2496
981 * MidiMan M Audio Delta 66
982 * MidiMan M Audio Delta 44
983 * MidiMan M Audio Delta 410
984 * MidiMan M Audio Audiophile 2496
985 * TerraTec EWS 88MT
986 * TerraTec EWS 88D
987 * TerraTec EWX 24/96
988 * TerraTec DMX 6Fire
c9bce91f 989 * TerraTec Phase 88
1da177e4
LT
990 * Hoontech SoundTrack DSP 24
991 * Hoontech SoundTrack DSP 24 Value
992 * Hoontech SoundTrack DSP 24 Media 7.1
c9bce91f 993 * Event Electronics, EZ8
1da177e4 994 * Digigram VX442
c9bce91f 995 * Lionstracs, Mediastaton
1da177e4
LT
996
997 model - Use the given board model, one of the following:
998 delta1010, dio2496, delta66, delta44, audiophile, delta410,
999 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
c9bce91f
TI
1000 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
1001 phase88, mediastation
1da177e4 1002 omni - Omni I/O support for MidiMan M-Audio Delta44/66
fa00e7e1 1003 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transceiver)
1da177e4
LT
1004 in msec resolution, default value is 500 (0.5 sec)
1005
0ef797c5 1006 This module supports multiple cards and autoprobe. Note: The consumer part
1da177e4
LT
1007 is not used with all Envy24 based cards (for example in the MidiMan Delta
1008 serie).
1009
c9bce91f
TI
1010 Note: The supported board is detected by reading EEPROM or PCI
1011 SSID (if EEPROM isn't available). You can override the
1012 model by passing "model" module option in case that the
1013 driver isn't configured properly or you want to try another
1014 type for testing.
1015
1da177e4
LT
1016 Module snd-ice1724
1017 ------------------
1018
c9bce91f 1019 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
7a6c8ff1 1020 * MidiMan M Audio Revolution 5.1
1da177e4 1021 * MidiMan M Audio Revolution 7.1
56255060 1022 * MidiMan M Audio Audiophile 192
1da177e4 1023 * AMP Ltd AUDIO2000
c9bce91f
TI
1024 * TerraTec Aureon 5.1 Sky
1025 * TerraTec Aureon 7.1 Space
1026 * TerraTec Aureon 7.1 Universe
1027 * TerraTec Phase 22
1028 * TerraTec Phase 28
1029 * AudioTrak Prodigy 7.1
7a6c8ff1 1030 * AudioTrak Prodigy 7.1LT
c9bce91f
TI
1031 * AudioTrak Prodigy 192
1032 * Pontis MS300
1033 * Albatron K8X800 Pro II
1034 * Chaintech ZNF3-150
1035 * Chaintech ZNF3-250
1036 * Chaintech 9CJS
8cfbbac6 1037 * Chaintech AV-710
c9bce91f 1038 * Shuttle SN25P
1da177e4
LT
1039
1040 model - Use the given board model, one of the following:
7a6c8ff1 1041 revo51, revo71, amp2000, prodigy71, prodigy71lt,
56255060 1042 prodigy192, aureon51, aureon71, universe, ap192,
7a6c8ff1 1043 k8x800, phase22, phase28, ms300, av710
1da177e4 1044
0ef797c5 1045 This module supports multiple cards and autoprobe.
1da177e4 1046
c9bce91f
TI
1047 Note: The supported board is detected by reading EEPROM or PCI
1048 SSID (if EEPROM isn't available). You can override the
1049 model by passing "model" module option in case that the
1050 driver isn't configured properly or you want to try another
1051 type for testing.
1052
dd7b254d
GP
1053 Module snd-indigo
1054 -----------------
1055
1056 Module for Echoaudio Indigo
1057
1058 This module supports multiple cards.
1059 The driver requires the firmware loader support on kernel.
1060
1061 Module snd-indigodj
1062 -------------------
1063
1064 Module for Echoaudio Indigo DJ
1065
1066 This module supports multiple cards.
1067 The driver requires the firmware loader support on kernel.
1068
1069 Module snd-indigoio
1070 -------------------
1071
1072 Module for Echoaudio Indigo IO
1073
1074 This module supports multiple cards.
1075 The driver requires the firmware loader support on kernel.
1076
1da177e4
LT
1077 Module snd-intel8x0
1078 -------------------
1079
1080 Module for AC'97 motherboards from Intel and compatibles.
1081 * Intel i810/810E, i815, i820, i830, i84x, MX440
89ac9c25 1082 ICH5, ICH6, ICH7, ESB2
1da177e4 1083 * SiS 7012 (SiS 735)
89ac9c25
TI
1084 * NVidia NForce, NForce2, NForce3, MCP04, CK804
1085 CK8, CK8S, MCP501
1da177e4
LT
1086 * AMD AMD768, AMD8111
1087 * ALi m5455
1088
1089 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1090 ac97_quirk - AC'97 workaround for strange hardware
6243008b 1091 See "AC97 Quirk Option" section below.
1da177e4 1092 buggy_irq - Enable workaround for buggy interrupts on some
a06147d2
TI
1093 motherboards (default yes on nForce chips,
1094 otherwise off)
1095 buggy_semaphore - Enable workaround for hardwares with buggy
1096 semaphores (e.g. on some ASUS laptops)
1097 (default off)
6c5cfd9d
TI
1098 spdif_aclink - Use S/PDIF over AC-link instead of direct connection
1099 from the controller chip
1100 (0 = off, 1 = on, -1 = default)
1da177e4 1101
b7fe4622 1102 This module supports one chip and autoprobe.
1da177e4
LT
1103
1104 Note: the latest driver supports auto-detection of chip clock.
1105 if you still encounter too fast playback, specify the clock
1106 explicitly via the module option "ac97_clock=41194".
1107
1108 Joystick/MIDI ports are not supported by this driver. If your
1109 motherboard has these devices, use the ns558 or snd-mpu401
1110 modules, respectively.
1111
1da177e4
LT
1112 The power-management is supported.
1113
1114 Module snd-intel8x0m
1115 --------------------
1116
1117 Module for Intel ICH (i8x0) chipset MC97 modems.
89ac9c25
TI
1118 * Intel i810/810E, i815, i820, i830, i84x, MX440
1119 ICH5, ICH6, ICH7
1120 * SiS 7013 (SiS 735)
1121 * NVidia NForce, NForce2, NForce2s, NForce3
1122 * AMD AMD8111
1123 * ALi m5455
1da177e4
LT
1124
1125 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1126
b7fe4622 1127 This module supports one card and autoprobe.
1da177e4
LT
1128
1129 Note: The default index value of this module is -2, i.e. the first
1130 slot is excluded.
1131
a4efc230
TI
1132 The power-management is supported.
1133
1da177e4
LT
1134 Module snd-interwave
1135 --------------------
1136
1137 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1138 and other sound cards based on AMD InterWave (tm) chip.
1139
1140 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1141 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1142 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1143 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
1144 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1145 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1146 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1147 effect - 1 = InterWave effects enable (default 0);
1148 requires 8 voices
1149
0ef797c5 1150 This module supports multiple cards, autoprobe and ISA PnP.
1da177e4
LT
1151
1152 Module snd-interwave-stb
1153 ------------------------
1154
1155 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1156 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1157 circuit for extended control of bass, treble and master volume.
1158
1159 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1160 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1161 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1162 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1163 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
1164 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1165 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1166 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1167 effect - 1 = InterWave effects enable (default 0);
1168 requires 8 voices
1169
0ef797c5 1170 This module supports multiple cards, autoprobe and ISA PnP.
1da177e4
LT
1171
1172 Module snd-korg1212
1173 -------------------
1174
1175 Module for Korg 1212 IO PCI card
1176
0ef797c5 1177 This module supports multiple cards.
1da177e4 1178
dd7b254d
GP
1179 Module snd-layla20
1180 ------------------
1181
1182 Module for Echoaudio Layla20
1183
1184 This module supports multiple cards.
1185 The driver requires the firmware loader support on kernel.
1186
1187 Module snd-layla24
1188 ------------------
1189
1190 Module for Echoaudio Layla24
1191
1192 This module supports multiple cards.
1193 The driver requires the firmware loader support on kernel.
1194
1da177e4
LT
1195 Module snd-maestro3
1196 -------------------
1197
1198 Module for Allegro/Maestro3 chips
1199
1200 external_amp - enable external amp (enabled by default)
1201 amp_gpio - GPIO pin number for external amp (0-15) or
1202 -1 for default pin (8 for allegro, 1 for
1203 others)
1204
0ef797c5 1205 This module supports autoprobe and multiple chips.
1da177e4
LT
1206
1207 Note: the binding of amplifier is dependent on hardware.
1208 If there is no sound even though all channels are unmuted, try to
1209 specify other gpio connection via amp_gpio option.
1210 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1211 option.
1212
1213 The power-management is supported.
1214
dd7b254d
GP
1215 Module snd-mia
1216 ---------------
1217
1218 Module for Echoaudio Mia
1219
1220 This module supports multiple cards.
1221 The driver requires the firmware loader support on kernel.
1222
1841f613
ML
1223 Module snd-miro
1224 ---------------
1225
1226 Module for Miro soundcards: miroSOUND PCM 1 pro,
1227 miroSOUND PCM 12,
1228 miroSOUND PCM 20 Radio.
1229
1230 port - Port # (0x530,0x604,0xe80,0xf40)
1231 irq - IRQ # (5,7,9,10,11)
1232 dma1 - 1st dma # (0,1,3)
1233 dma2 - 2nd dma # (0,1)
1234 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1235 mpu_irq - MPU-401 irq # (5,7,9,10)
1236 fm_port - FM Port # (0x388)
1237 wss - enable WSS mode
1238 ide - enable onboard ide support
1239
1da177e4
LT
1240 Module snd-mixart
1241 -----------------
1242
1243 Module for Digigram miXart8 sound cards.
1244
0ef797c5 1245 This module supports multiple cards.
1da177e4
LT
1246 Note: One miXart8 board will be represented as 4 alsa cards.
1247 See MIXART.txt for details.
1248
1249 When the driver is compiled as a module and the hotplug firmware
1250 is supported, the firmware data is loaded via hotplug automatically.
1251 Install the necessary firmware files in alsa-firmware package.
1252 When no hotplug fw loader is available, you need to load the
1253 firmware via mixartloader utility in alsa-tools package.
1254
dd7b254d
GP
1255 Module snd-mona
1256 ---------------
1257
1258 Module for Echoaudio Mona
1259
1260 This module supports multiple cards.
1261 The driver requires the firmware loader support on kernel.
1262
1da177e4
LT
1263 Module snd-mpu401
1264 -----------------
1265
1266 Module for MPU-401 UART devices.
1267
1268 port - port number or -1 (disable)
1269 irq - IRQ number or -1 (disable)
1270 pnp - PnP detection - 0 = disable, 1 = enable (default)
1271
0ef797c5 1272 This module supports multiple devices and PnP.
1da177e4
LT
1273
1274 Module snd-mtpav
1275 ----------------
1276
1277 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1278 port).
1279
1280 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1281 irq - IRQ # for MTPAV (7,5, default=7)
1282 hwports - number of supported hardware ports, default=8.
1283
1284 Module supports only 1 card. This module has no enable option.
1285
68ab801e
MK
1286 Module snd-mts64
1287 ----------------
1288
1289 Module for Ego Systems (ESI) Miditerminal 4140
1290
1291 This module supports multiple devices.
1292 Requires parport (CONFIG_PARPORT).
1293
1da177e4
LT
1294 Module snd-nm256
1295 ----------------
1296
1297 Module for NeoMagic NM256AV/ZX chips
1298
1299 playback_bufsize - max playback frame size in kB (4-128kB)
1300 capture_bufsize - max capture frame size in kB (4-128kB)
1301 force_ac97 - 0 or 1 (disabled by default)
1302 buffer_top - specify buffer top address
1303 use_cache - 0 or 1 (disabled by default)
1304 vaio_hack - alias buffer_top=0x25a800
1305 reset_workaround - enable AC97 RESET workaround for some laptops
d1f38cf9
TI
1306 reset_workaround2 - enable extended AC97 RESET workaround for some
1307 other laptops
1da177e4 1308
8a3fb4d0 1309 This module supports one chip and autoprobe.
1da177e4
LT
1310
1311 The power-management is supported.
1312
1313 Note: on some notebooks the buffer address cannot be detected
1314 automatically, or causes hang-up during initialization.
fff9289b
ML
1315 In such a case, specify the buffer top address explicitly via
1316 the buffer_top option.
1da177e4
LT
1317 For example,
1318 Sony F250: buffer_top=0x25a800
1319 Sony F270: buffer_top=0x272800
1320 The driver supports only ac97 codec. It's possible to force
1321 to initialize/use ac97 although it's not detected. In such a
1322 case, use force_ac97=1 option - but *NO* guarantee whether it
1323 works!
1324
1325 Note: The NM256 chip can be linked internally with non-AC97
1326 codecs. This driver supports only the AC97 codec, and won't work
1327 with machines with other (most likely CS423x or OPL3SAx) chips,
1328 even though the device is detected in lspci. In such a case, try
1329 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
6243008b 1330 but some doesn't have ISA PnP. You'll need to specify isapnp=0
1da177e4
LT
1331 and proper hardware parameters in the case without ISA PnP.
1332
1333 Note: some laptops need a workaround for AC97 RESET. For the
1334 known hardware like Dell Latitude LS and Sony PCG-F305, this
1335 workaround is enabled automatically. For other laptops with a
1336 hard freeze, you can try reset_workaround=1 option.
1337
d1f38cf9
TI
1338 Note: Dell Latitude CSx laptops have another problem regarding
1339 AC97 RESET. On these laptops, reset_workaround2 option is
1340 turned on as default. This option is worth to try if the
1341 previous reset_workaround option doesn't help.
1342
1da177e4
LT
1343 Note: This driver is really crappy. It's a porting from the
1344 OSS driver, which is a result of black-magic reverse engineering.
1345 The detection of codec will fail if the driver is loaded *after*
1346 X-server as described above. You might be able to force to load
1347 the module, but it may result in hang-up. Hence, make sure that
1348 you load this module *before* X if you encounter this kind of
1349 problem.
1350
1351 Module snd-opl3sa2
1352 ------------------
1353
1354 Module for Yamaha OPL3-SA2/SA3 sound cards.
1355
1356 port - control port # for OPL3-SA chip (0x370)
1357 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1358 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1359 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1360 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1361 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1362 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1363 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
1364 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1365
0ef797c5 1366 This module supports multiple cards and ISA PnP. It does not support
1da177e4
LT
1367 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1368
1369 The power-management is supported.
1370
1371 Module snd-opti92x-ad1848
1372 -------------------------
1373
1374 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1375 Module works with OAK Mozart cards as well.
1376
1377 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1378 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1379 fm_port - port # for OPL3 device (0x388)
1380 irq - IRQ # for WSS chip (5,7,9,10,11)
1381 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1382 dma1 - first DMA # for WSS chip (0,1,3)
1383
1384 This module supports only one card, autoprobe and PnP.
1385
1386 Module snd-opti92x-cs4231
1387 -------------------------
1388
1389 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1390
1391 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1392 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1393 fm_port - port # for OPL3 device (0x388)
1394 irq - IRQ # for WSS chip (5,7,9,10,11)
1395 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1396 dma1 - first DMA # for WSS chip (0,1,3)
1397 dma2 - second DMA # for WSS chip (0,1,3)
1398
1399 This module supports only one card, autoprobe and PnP.
1400
1401 Module snd-opti93x
1402 ------------------
1403
1404 Module for sound cards based on OPTi 82c93x chips.
1405
1406 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1407 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1408 fm_port - port # for OPL3 device (0x388)
1409 irq - IRQ # for WSS chip (5,7,9,10,11)
1410 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1411 dma1 - first DMA # for WSS chip (0,1,3)
1412 dma2 - second DMA # for WSS chip (0,1,3)
1413
1414 This module supports only one card, autoprobe and PnP.
1415
e12229b4
MB
1416 Module snd-pcxhr
1417 ----------------
1418
1419 Module for Digigram PCXHR boards
1420
1421 This module supports multiple cards.
1422
757e119b
MK
1423 Module snd-portman2x4
1424 ---------------------
1425
1426 Module for Midiman Portman 2x4 parallel port MIDI interface
1427
1428 This module supports multiple cards.
1429
1da177e4
LT
1430 Module snd-powermac (on ppc only)
1431 ---------------------------------
1432
1433 Module for PowerMac, iMac and iBook on-board soundchips
1434
1435 enable_beep - enable beep using PCM (enabled as default)
1436
1437 Module supports autoprobe a chip.
1438
1439 Note: the driver may have problems regarding endianess.
1440
1441 The power-management is supported.
1442
2c484df0
TI
1443 Module snd-pxa2xx-ac97 (on arm only)
1444 ------------------------------------
1445
1446 Module for AC97 driver for the Intel PXA2xx chip
1447
1448 For ARM architecture only.
1449
a4efc230
TI
1450 The power-management is supported.
1451
109a9638
PG
1452 Module snd-riptide
1453 ------------------
1454
1455 Module for Conexant Riptide chip
1456
1457 joystick_port - Joystick port # (default: 0x200)
1458 mpu_port - MPU401 port # (default: 0x330)
1459 opl3_port - OPL3 port # (default: 0x388)
1460
1461 This module supports multiple cards.
1462 The driver requires the firmware loader support on kernel.
1463 You need to install the firmware file "riptide.hex" to the standard
1464 firmware path (e.g. /lib/firmware).
1465
1da177e4
LT
1466 Module snd-rme32
1467 ----------------
1468
1469 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1470 Prodif96 and Prodif Gold) sound cards.
1471
0ef797c5 1472 This module supports multiple cards.
1da177e4
LT
1473
1474 Module snd-rme96
1475 ----------------
1476
1477 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1478
0ef797c5 1479 This module supports multiple cards.
1da177e4
LT
1480
1481 Module snd-rme9652
1482 ------------------
1483
1484 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1485
1486 precise_ptr - Enable precise pointer (doesn't work reliably).
1487 (default = 0)
1488
0ef797c5 1489 This module supports multiple cards.
1da177e4
LT
1490
1491 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1492 module did formerly. It will allocate the buffers in advance
1493 when any RME9652 cards are found. To make the buffer
1494 allocation sure, load snd-page-alloc module in the early
b6a96915
TI
1495 stage of boot sequence. See "Early Buffer Allocation"
1496 section.
1da177e4
LT
1497
1498 Module snd-sa11xx-uda1341 (on arm only)
1499 ---------------------------------------
1500
1501 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1502
1503 Module supports only one card.
1504 Module has no enable and index options.
1505
a4efc230
TI
1506 The power-management is supported.
1507
1da177e4
LT
1508 Module snd-sb8
1509 --------------
1510
1511 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1512 SoundBlaster 2.0,
1513 SoundBlaster Pro
1514
1515 port - port # for SB DSP chip (0x220,0x240,0x260)
1516 irq - IRQ # for SB DSP chip (5,7,9,10)
1517 dma8 - DMA # for SB DSP chip (1,3)
1518
0ef797c5 1519 This module supports multiple cards and autoprobe.
1da177e4 1520
a4efc230
TI
1521 The power-management is supported.
1522
1da177e4
LT
1523 Module snd-sb16 and snd-sbawe
1524 -----------------------------
1525
1526 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1527 SoundBlaster AWE 32 (PnP),
1528 SoundBlaster AWE 64 PnP
1529
1530 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1531 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1532 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1533 (snd-sbawe module only)
1534 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1535 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1536 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
1537 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1538 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1539 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1540
0ef797c5 1541 This module supports multiple cards, autoprobe and ISA PnP.
1da177e4
LT
1542
1543 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1544 disable 16bit DMA with dma16 = -1 module parameter.
1545 Also, all Sound Blaster 16 type cards can operate in 16-bit
1546 half duplex mode through 8-bit DMA channel by disabling their
1547 16-bit DMA channel.
1548
a4efc230
TI
1549 The power-management is supported.
1550
1da177e4
LT
1551 Module snd-sgalaxy
1552 ------------------
1553
1554 Module for Aztech Sound Galaxy sound card.
1555
1556 sbport - Port # for SB16 interface (0x220,0x240)
1557 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1558 irq - IRQ # (7,9,10,11)
1559 dma1 - DMA #
1560
0ef797c5 1561 This module supports multiple cards.
1da177e4 1562
a4efc230
TI
1563 The power-management is supported.
1564
1da177e4
LT
1565 Module snd-sscape
1566 -----------------
1567
1568 Module for ENSONIQ SoundScape PnP cards.
1569
1570 port - Port # (PnP setup)
1571 irq - IRQ # (PnP setup)
1572 mpu_irq - MPU-401 IRQ # (PnP setup)
1573 dma - DMA # (PnP setup)
1574
0ef797c5 1575 This module supports multiple cards. ISA PnP must be enabled.
1da177e4
LT
1576 You need sscape_ctl tool in alsa-tools package for loading
1577 the microcode.
1578
1579 Module snd-sun-amd7930 (on sparc only)
1580 --------------------------------------
1581
1582 Module for AMD7930 sound chips found on Sparcs.
1583
0ef797c5 1584 This module supports multiple cards.
1da177e4
LT
1585
1586 Module snd-sun-cs4231 (on sparc only)
1587 -------------------------------------
1588
1589 Module for CS4231 sound chips found on Sparcs.
1590
0ef797c5 1591 This module supports multiple cards.
1da177e4 1592
1bd9debf
TI
1593 Module snd-sun-dbri (on sparc only)
1594 -----------------------------------
1595
1596 Module for DBRI sound chips found on Sparcs.
1597
0ef797c5 1598 This module supports multiple cards.
1bd9debf 1599
1da177e4
LT
1600 Module snd-wavefront
1601 --------------------
1602
1603 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1604
1605 cs4232_pcm_port - Port # for CS4232 PCM interface.
1606 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1607 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1608 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
1609 use_cs4232_midi - Use CS4232 MPU-401 interface
1610 (inaccessibly located inside your computer)
1611 ics2115_port - Port # for ICS2115
1612 ics2115_irq - IRQ # for ICS2115
1613 fm_port - FM OPL-3 Port #
1614 dma1 - DMA1 # for CS4232 PCM interface.
1615 dma2 - DMA2 # for CS4232 PCM interface.
1616 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1617
0ef797c5 1618 This module supports multiple cards and ISA PnP.
1da177e4
LT
1619
1620 Module snd-sonicvibes
1621 ---------------------
1622
1623 Module for S3 SonicVibes PCI sound cards.
1624 * PINE Schubert 32 PCI
1625
1626 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1627 - SoundCard must have onboard SRAM for this.
1628 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1629
0ef797c5 1630 This module supports multiple cards and autoprobe.
1da177e4
LT
1631
1632 Module snd-serial-u16550
1633 ------------------------
1634
1635 Module for UART16550A serial MIDI ports.
1636
1637 port - port # for UART16550A chip
1638 irq - IRQ # for UART16550A chip, -1 = poll mode
1639 speed - speed in bauds (9600,19200,38400,57600,115200)
1640 38400 = default
1641 base - base for divisor in bauds (57600,115200,230400,460800)
1642 115200 = default
1643 outs - number of MIDI ports in a serial port (1-4)
1644 1 = default
1645 adaptor - Type of adaptor.
1646 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1647 3 = MS-124W M/B, 4 = Generic
1648
0ef797c5 1649 This module supports multiple cards. This module does not support autoprobe
1da177e4
LT
1650 thus the main port must be specified!!! Other options are optional.
1651
1652 Module snd-trident
1653 ------------------
1654
1655 Module for Trident 4DWave DX/NX sound cards.
1656 * Best Union Miss Melody 4DWave PCI
1657 * HIS 4DWave PCI
1658 * Warpspeed ONSpeed 4DWave PCI
1659 * AzTech PCI 64-Q3D
1660 * Addonics SV 750
1661 * CHIC True Sound 4Dwave
1662 * Shark Predator4D-PCI
1663 * Jaton SonicWave 4D
1664
1665 pcm_channels - max channels (voices) reserved for PCM
1666 wavetable_size - max wavetable size in kB (4-?kb)
1667
0ef797c5 1668 This module supports multiple cards and autoprobe.
1da177e4
LT
1669
1670 The power-management is supported.
1671
1672 Module snd-usb-audio
1673 --------------------
1674
1675 Module for USB audio and USB MIDI devices.
1676
1677 vid - Vendor ID for the device (optional)
1678 pid - Product ID for the device (optional)
e311334e
TLM
1679 device_setup - Device specific magic number (optional)
1680 - Influence depends on the device
1681 - Default: 0x0000
1da177e4 1682
0ef797c5 1683 This module supports multiple devices, autoprobe and hotplugging.
1da177e4
LT
1684
1685 Module snd-usb-usx2y
1686 --------------------
1687
1688 Module for Tascam USB US-122, US-224 and US-428 devices.
1689
0ef797c5 1690 This module supports multiple devices, autoprobe and hotplugging.
1da177e4
LT
1691
1692 Note: you need to load the firmware via usx2yloader utility included
1693 in alsa-tools and alsa-firmware packages.
1694
1695 Module snd-via82xx
1696 ------------------
1697
1698 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
2d7eb7cb 1699 8233A, 8233C, 8235, 8237 (south) bridge.
1da177e4
LT
1700
1701 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1702 [VIA686A/686B only]
1703 joystick - Enable joystick (default off) [VIA686A/686B only]
1704 ac97_clock - AC'97 codec clock base (default 48000Hz)
1705 dxs_support - support DXS channels,
2d7eb7cb
SV
1706 0 = auto (default), 1 = enable, 2 = disable,
1707 3 = 48k only, 4 = no VRA, 5 = enable any sample
1708 rate and different sample rates on different
1709 channels
1710 [VIA8233/C, 8235, 8237 only]
1da177e4 1711 ac97_quirk - AC'97 workaround for strange hardware
6243008b 1712 See "AC97 Quirk Option" section below.
1da177e4 1713
b7fe4622 1714 This module supports one chip and autoprobe.
1da177e4
LT
1715
1716 Note: on some SMP motherboards like MSI 694D the interrupts might
1717 not be generated properly. In such a case, please try to
1718 set the SMP (or MPS) version on BIOS to 1.1 instead of
1719 default value 1.4. Then the interrupt number will be
1720 assigned under 15. You might also upgrade your BIOS.
1721
2d7eb7cb 1722 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
1da177e4 1723 channels as the first PCM. On these channels, up to 4
2d7eb7cb
SV
1724 streams can be played at the same time, and the controller
1725 can perform sample rate conversion with separate rates for
1726 each channel.
1da177e4
LT
1727 As default (dxs_support = 0), 48k fixed rate is chosen
1728 except for the known devices since the output is often
1729 noisy except for 48k on some mother boards due to the
1730 bug of BIOS.
2d7eb7cb 1731 Please try once dxs_support=5 and if it works on other
1da177e4
LT
1732 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1733 know the PCI subsystem vendor/device id's (output of
1734 "lspci -nv").
cdc27f3a
TI
1735 If dxs_support=5 does not work, try dxs_support=4; if it
1736 doesn't work too, try dxs_support=1. (dxs_support=1 is
6243008b 1737 usually for old motherboards. The correct implemented
cdc27f3a 1738 board should work with 4 or 5.) If it still doesn't
1da177e4
LT
1739 work and the default setting is ok, dxs_support=3 is the
1740 right choice. If the default setting doesn't work at all,
1741 try dxs_support=2 to disable the DXS channels.
1742 In any cases, please let us know the result and the
6243008b
TI
1743 subsystem vendor/device ids. See "Links and Addresses"
1744 below.
1da177e4
LT
1745
1746 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
6243008b 1747 additionally. The mpu_port option is for VIA686 chips only.
1da177e4 1748
a4efc230
TI
1749 The power-management is supported.
1750
1da177e4
LT
1751 Module snd-via82xx-modem
1752 ------------------------
1753
1754 Module for VIA82xx AC97 modem
1755
1756 ac97_clock - AC'97 codec clock base (default 48000Hz)
1757
b7fe4622 1758 This module supports one card and autoprobe.
1da177e4
LT
1759
1760 Note: The default index value of this module is -2, i.e. the first
1761 slot is excluded.
1762
a4efc230
TI
1763 The power-management is supported.
1764
1da177e4
LT
1765 Module snd-virmidi
1766 ------------------
1767
1768 Module for virtual rawmidi devices.
1769 This module creates virtual rawmidi devices which communicate
1770 to the corresponding ALSA sequencer ports.
1771
0ef797c5 1772 midi_devs - MIDI devices # (1-4, default=4)
1da177e4 1773
0ef797c5 1774 This module supports multiple cards.
1da177e4
LT
1775
1776 Module snd-vx222
1777 ----------------
1778
1779 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1780
1781 mic - Enable Microphone on V222 Mic (NYI)
1782 ibl - Capture IBL size. (default = 0, minimum size)
1783
0ef797c5 1784 This module supports multiple cards.
1da177e4
LT
1785
1786 When the driver is compiled as a module and the hotplug firmware
1787 is supported, the firmware data is loaded via hotplug automatically.
1788 Install the necessary firmware files in alsa-firmware package.
1789 When no hotplug fw loader is available, you need to load the
1790 firmware via vxloader utility in alsa-tools package. To invoke
1791 vxloader automatically, add the following to /etc/modprobe.conf
1792
1793 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1794
1795 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1796 /etc/modules.conf, instead.)
1797 IBL size defines the interrupts period for PCM. The smaller size
1798 gives smaller latency but leads to more CPU consumption, too.
1799 The size is usually aligned to 126. As default (=0), the smallest
1800 size is chosen. The possible IBL values can be found in
1801 /proc/asound/cardX/vx-status proc file.
1802
a4efc230
TI
1803 The power-management is supported.
1804
1da177e4
LT
1805 Module snd-vxpocket
1806 -------------------
1807
6d00a312 1808 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
1da177e4
LT
1809
1810 ibl - Capture IBL size. (default = 0, minimum size)
1811
0ef797c5 1812 This module supports multiple cards. The module is compiled only when
1da177e4
LT
1813 PCMCIA is supported on kernel.
1814
6243008b
TI
1815 With the older 2.6.x kernel, to activate the driver via the card
1816 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1817 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1818 longer require a config file.
1da177e4
LT
1819
1820 When the driver is compiled as a module and the hotplug firmware
1821 is supported, the firmware data is loaded via hotplug automatically.
1822 Install the necessary firmware files in alsa-firmware package.
1823 When no hotplug fw loader is available, you need to load the
1824 firmware via vxloader utility in alsa-tools package.
1825
1826 About capture IBL, see the description of snd-vx222 module.
1827
ed7cbe3e 1828 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
6243008b
TI
1829 ALSA 1.0.10.
1830
a4efc230
TI
1831 The power-management is supported.
1832
1da177e4
LT
1833 Module snd-ymfpci
1834 -----------------
1835
1836 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1837
1838 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1839 1 (auto-detect for YMF744/754 only)
1840 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1841 1 (auto-detect for YMF744/754 only)
1842 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1843 1 (auto-detect)
1844 rear_switch - enable shared rear/line-in switch (bool)
1845
0ef797c5 1846 This module supports autoprobe and multiple chips.
1da177e4
LT
1847
1848 The power-management is supported.
1849
1850 Module snd-pdaudiocf
1851 --------------------
1852
1853 Module for Sound Core PDAudioCF sound card.
1854
a4efc230
TI
1855 The power-management is supported.
1856
1da177e4 1857
6243008b
TI
1858AC97 Quirk Option
1859=================
1860
1861The ac97_quirk option is used to enable/override the workaround for
1862specific devices on drivers for on-board AC'97 controllers like
1863snd-intel8x0. Some hardware have swapped output pins between Master
1864and Headphone, or Surround (thanks to confusion of AC'97
1865specifications from version to version :-)
1866
1867The driver provides the auto-detection of known problematic devices,
1868but some might be unknown or wrongly detected. In such a case, pass
1869the proper value with this option.
1870
1871The following strings are accepted:
1872 - default Don't override the default setting
10e4097f 1873 - none Disable the quirk
6243008b
TI
1874 - hp_only Bind Master and Headphone controls as a single control
1875 - swap_hp Swap headphone and master controls
1876 - swap_surround Swap master and surround controls
1877 - ad_sharing For AD1985, turn on OMS bit and use headphone
1878 - alc_jack For ALC65x, turn on the jack sense mode
1879 - inv_eapd Inverted EAPD implementation
1880 - mute_led Bind EAPD bit for turning on/off mute LED
1881
1882For backward compatibility, the corresponding integer value -1, 0,
1883... are accepted, too.
1884
1885For example, if "Master" volume control has no effect on your device
1886but only "Headphone" does, pass ac97_quirk=hp_only module option.
1887
1888
1da177e4
LT
1889Configuring Non-ISAPNP Cards
1890============================
1891
1892When the kernel is configured with ISA-PnP support, the modules
1893supporting the isapnp cards will have module options "isapnp".
1894If this option is set, *only* the ISA-PnP devices will be probed.
1895For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
1896together with the proper i/o and irq configuration.
1897
1898When the kernel is configured without ISA-PnP support, isapnp option
1899will be not built in.
1900
1901
1902Module Autoloading Support
1903==========================
1904
1905The ALSA drivers can be loaded automatically on demand by defining
1906module aliases. The string 'snd-card-%1' is requested for ALSA native
1907devices where %i is sound card number from zero to seven.
1908
1909To auto-load an ALSA driver for OSS services, define the string
1910'sound-slot-%i' where %i means the slot number for OSS, which
1911corresponds to the card index of ALSA. Usually, define this
d533f671 1912as the same card module.
1da177e4
LT
1913
1914An example configuration for a single emu10k1 card is like below:
1915----- /etc/modprobe.conf
1916alias snd-card-0 snd-emu10k1
1917alias sound-slot-0 snd-emu10k1
1918----- /etc/modprobe.conf
1919
1920The available number of auto-loaded sound cards depends on the module
1921option "cards_limit" of snd module. As default it's set to 1.
1922To enable the auto-loading of multiple cards, specify the number of
1923sound cards in that option.
1924
1925When multiple cards are available, it'd better to specify the index
1926number for each card via module option, too, so that the order of
1927cards is kept consistent.
1928
1929An example configuration for two sound cards is like below:
1930
1931----- /etc/modprobe.conf
1932# ALSA portion
1933options snd cards_limit=2
1934alias snd-card-0 snd-interwave
1935alias snd-card-1 snd-ens1371
1936options snd-interwave index=0
1937options snd-ens1371 index=1
1938# OSS/Free portion
1939alias sound-slot-0 snd-interwave
1940alias sound-slot-1 snd-ens1371
2fe0ae78 1941----- /etc/modprobe.conf
1da177e4
LT
1942
1943In this example, the interwave card is always loaded as the first card
1944(index 0) and ens1371 as the second (index 1).
1945
1946
1947ALSA PCM devices to OSS devices mapping
1948=======================================
1949
1950/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
1951/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
1952/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
1953/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
1954/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
1955/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
1956/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
1957/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
1958/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
1959
1960The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
1961sound card number and second means device number. The ALSA devices
1962have either 'c' or 'p' suffix indicating the direction, capture and
1963playback, respectively.
1964
1965Please note that the device mapping above may be varied via the module
1966options of snd-pcm-oss module.
1967
1968
1da177e4
LT
1969Proc interfaces (/proc/asound)
1970==============================
1971
1972/proc/asound/card#/pcm#[cp]/oss
1973-------------------------------
1974 String "erase" - erase all additional informations about OSS applications
1975 String "<app_name> <fragments> <fragment_size> [<options>]"
1976
1977 <app_name> - name of application with (higher priority) or without path
1978 <fragments> - number of fragments or zero if auto
1979 <fragment_size> - size of fragment in bytes or zero if auto
1980 <options> - optional parameters
1981 - disable the application tries to open a pcm device for
1982 this channel but does not want to use it.
1983 (Cause a bug or mmap needs)
1984 It's good for Quake etc...
1985 - direct don't use plugins
1986 - block force block mode (rvplayer)
1987 - non-block force non-block mode
1988 - whole-frag write only whole fragments (optimization affecting
1989 playback only)
1990 - no-silence do not fill silence ahead to avoid clicks
10f69f9e
TI
1991 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
1992 instead of filled blocks
1da177e4
LT
1993
1994 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
1995 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
1996 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
1997
1998
b6a96915
TI
1999Early Buffer Allocation
2000=======================
2001
2002Some drivers (e.g. hdsp) require the large contiguous buffers, and
2003sometimes it's too late to find such spaces when the driver module is
2004actually loaded due to memory fragmentation. You can pre-allocate the
2005PCM buffers by loading snd-page-alloc module and write commands to its
2006proc file in prior, for example, in the early boot stage like
2007/etc/init.d/*.local scripts.
2008
2009Reading the proc file /proc/drivers/snd-page-alloc shows the current
2010usage of page allocation. In writing, you can send the following
2011commands to the snd-page-alloc driver:
2012
2013 - add VENDOR DEVICE MASK SIZE BUFFERS
2014
2015 VENDOR and DEVICE are PCI vendor and device IDs. They take
2016 integer numbers (0x prefix is needed for the hex).
2017 MASK is the PCI DMA mask. Pass 0 if not restricted.
2018 SIZE is the size of each buffer to allocate. You can pass
2019 k and m suffix for KB and MB. The max number is 16MB.
2020 BUFFERS is the number of buffers to allocate. It must be greater
2021 than 0. The max number is 4.
2022
2023 - erase
2024
2025 This will erase the all pre-allocated buffers which are not in
2026 use.
2027
2028
6243008b
TI
2029Links and Addresses
2030===================
1da177e4
LT
2031
2032 ALSA project homepage
2033 http://www.alsa-project.org
2034
6243008b
TI
2035 ALSA Bug Tracking System
2036 https://bugtrack.alsa-project.org/bugs/
2037
2038 ALSA Developers ML
2039 mailto:alsa-devel@lists.sourceforge.net