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