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