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