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