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