Merge branch 'origin'
[pandora-kernel.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   Module snd-ens1371
517   ------------------
518
519     Module for Ensoniq AudioPCI ES1371 PCI sound cards.
520                         * SoundBlaster PCI 64
521                         * SoundBlaster PCI 128
522                         * SoundBlaster Vibra PCI
523
524     joystick_port       - port # for joystick (0x200,0x208,0x210,0x218),
525                           0 = disable (default), 1 = auto-detect
526
527     This module supports multiple cards and autoprobe.
528     
529   Module snd-es968
530   ----------------
531
532     Module for sound cards based on ESS ES968 chip (PnP only).
533
534     port        - port # for ES968 (SB8) chip (PnP setup)
535     irq         - IRQ # for ES968 (SB8) chip (PnP setup)
536     dma1        - DMA # for ES968 (SB8) chip (PnP setup)
537     
538     This module supports multiple cards, PnP and autoprobe.
539     
540     The power-management is supported.
541
542   Module snd-es1688
543   -----------------
544
545     Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
546
547     port        - port # for ES-1688 chip (0x220,0x240,0x260)
548     mpu_port    - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
549     irq         - IRQ # for ES-1688 chip (5,7,9,10)
550     mpu_irq     - IRQ # for MPU-401 port (5,7,9,10)
551     dma8        - DMA # for ES-1688 chip (0,1,3)
552
553     This module supports multiple cards and autoprobe (without MPU-401 port).
554
555   Module snd-es18xx
556   -----------------
557
558     Module for ESS AudioDrive ES-18xx sound cards.
559
560     port        - port # for ES-18xx chip (0x220,0x240,0x260)
561     mpu_port    - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
562     fm_port     - port # for FM (optional, not used)
563     irq         - IRQ # for ES-18xx chip (5,7,9,10)
564     dma1        - first DMA # for ES-18xx chip (0,1,3)
565     dma2        - first DMA # for ES-18xx chip (0,1,3)
566     isapnp      - ISA PnP detection - 0 = disable, 1 = enable (default)
567
568     This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
569     port if native ISA PnP routines are not used).
570     When dma2 is equal with dma1, the driver works as half-duplex.
571
572     The power-management is supported.
573
574   Module snd-es1938
575   -----------------
576
577     Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
578
579     This module supports multiple cards and autoprobe.
580
581     The power-management is supported.
582
583   Module snd-es1968
584   -----------------
585
586     Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
587
588     total_bufsize       - total buffer size in kB (1-4096kB)
589     pcm_substreams_p    - playback channels (1-8, default=2)
590     pcm_substreams_c    - capture channels (1-8, default=0)
591     clock               - clock (0 = auto-detection)
592     use_pm              - support the power-management (0 = off, 1 = on,
593                           2 = auto (default))
594     enable_mpu          - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
595     joystick            - enable joystick (default off)       
596
597     This module supports multiple cards and autoprobe.
598
599     The power-management is supported.
600
601   Module snd-fm801
602   ----------------
603
604     Module for ForteMedia FM801 based PCI sound cards.
605
606     tea575x_tuner       - Enable TEA575x tuner
607                           - 1 = MediaForte 256-PCS
608                           - 2 = MediaForte 256-PCPR
609                           - 3 = MediaForte 64-PCR  
610                           - High 16-bits are video (radio) device number + 1
611                           - example: 0x10002 (MediaForte 256-PCPR, device 1)
612
613     This module supports multiple cards and autoprobe.
614     
615     The power-management is supported.
616
617   Module snd-gusclassic
618   ---------------------
619
620     Module for Gravis UltraSound Classic sound card.
621
622     port        - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
623     irq         - IRQ # for GF1 chip (3,5,9,11,12,15)
624     dma1        - DMA # for GF1 chip (1,3,5,6,7)
625     dma2        - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
626     joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
627     voices      - GF1 voices limit (14-32)
628     pcm_voices  - reserved PCM voices
629
630     This module supports multiple cards and autoprobe.
631
632   Module snd-gusextreme
633   ---------------------
634
635     Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
636
637     port        - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
638     gf1_port    - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
639     mpu_port    - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
640     irq         - IRQ # for ES-1688 chip (5,7,9,10)
641     gf1_irq     - IRQ # for GF1 chip (3,5,9,11,12,15)
642     mpu_irq     - IRQ # for MPU-401 port (5,7,9,10)
643     dma8        - DMA # for ES-1688 chip (0,1,3)
644     dma1        - DMA # for GF1 chip (1,3,5,6,7)
645     joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
646     voices      - GF1 voices limit (14-32)
647     pcm_voices  - reserved PCM voices
648
649     This module supports multiple cards and autoprobe (without MPU-401 port).
650
651   Module snd-gusmax
652   -----------------
653
654     Module for Gravis UltraSound MAX sound card.
655
656     port        - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
657     irq         - IRQ # for GF1 chip (3,5,9,11,12,15)
658     dma1        - DMA # for GF1 chip (1,3,5,6,7)
659     dma2        - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
660     joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
661     voices      - GF1 voices limit (14-32)
662     pcm_voices  - reserved PCM voices
663
664     This module supports multiple cards and autoprobe.
665     
666   Module snd-hda-intel
667   --------------------
668
669     Module for Intel HD Audio (ICH6, ICH6M, ICH7), ATI SB450,
670                VIA VT8251/VT8237A
671
672     model       - force the model name
673     position_fix - Fix DMA pointer (0 = auto, 1 = none, 2 = POSBUF, 3 = FIFO size)
674
675     This module supports one card and autoprobe.
676
677     Each codec may have a model table for different configurations.
678     If your machine isn't listed there, the default (usually minimal)
679     configuration is set up.  You can pass "model=<name>" option to
680     specify a certain model in such a case.  There are different
681     models depending on the codec chip.
682
683           Model name    Description
684           ----------    -----------
685         ALC880
686           3stack        3-jack in back and a headphone out
687           3stack-digout 3-jack in back, a HP out and a SPDIF out
688           5stack        5-jack in back, 2-jack in front
689           5stack-digout 5-jack in back, 2-jack in front, a SPDIF out
690           6stack        6-jack in back, 2-jack in front
691           6stack-digout 6-jack with a SPDIF out
692           w810          3-jack
693           z71v          3-jack (HP shared SPDIF)
694           asus          3-jack
695           uniwill       3-jack
696           F1734         2-jack
697           test          for testing/debugging purpose, almost all controls can be
698                         adjusted.  Appearing only when compiled with
699                         $CONFIG_SND_DEBUG=y
700
701         ALC260
702           hp            HP machines
703           fujitsu       Fujitsu S7020
704
705         CMI9880
706           minimal       3-jack in back
707           min_fp        3-jack in back, 2-jack in front
708           full          6-jack in back, 2-jack in front
709           full_dig      6-jack in back, 2-jack in front, SPDIF I/O
710           allout        5-jack in back, 2-jack in front, SPDIF out
711           auto          auto-config reading BIOS (default)
712
713     If the default configuration doesn't work and one of the above
714     matches with your device, report it together with the PCI
715     subsystem ID (output of "lspci -nv") to ALSA BTS or alsa-devel
716     ML (see the section "Links and Addresses").
717
718     Note 2: If you get click noises on output, try the module option
719             position_fix=1 or 2.  position_fix=1 will use the SD_LPIB
720             register value without FIFO size correction as the current
721             DMA pointer.  position_fix=2 will make the driver to use
722             the position buffer instead of reading SD_LPIB register.
723             (Usually SD_LPLIB register is more accurate than the
724             position buffer.)
725
726     The power-management is supported.
727
728   Module snd-hdsp
729   ---------------
730
731     Module for RME Hammerfall DSP audio interface(s)
732
733     This module supports multiple cards.
734
735     Note: The firmware data can be automatically loaded via hotplug
736           when CONFIG_FW_LOADER is set.  Otherwise, you need to load
737           the firmware via hdsploader utility included in alsa-tools
738           package.
739           The firmware data is found in alsa-firmware package.
740
741     Note: snd-page-alloc module does the job which snd-hammerfall-mem
742           module did formerly.  It will allocate the buffers in advance
743           when any HDSP cards are found.  To make the buffer
744           allocation sure, load snd-page-alloc module in the early
745           stage of boot sequence.  See "Early Buffer Allocation"
746           section.
747
748   Module snd-hdspm
749   ----------------
750
751     Module for RME HDSP MADI board.
752
753     precise_ptr         - Enable precise pointer, or disable.
754     line_outs_monitor   - Send playback streams to analog outs by default.
755     enable_monitor      - Enable Analog Out on Channel 63/64 by default.
756
757     See hdspm.txt for details.
758
759   Module snd-ice1712
760   ------------------
761
762     Module for Envy24 (ICE1712) based PCI sound cards.
763                         * MidiMan M Audio Delta 1010
764                         * MidiMan M Audio Delta 1010LT
765                         * MidiMan M Audio Delta DiO 2496
766                         * MidiMan M Audio Delta 66
767                         * MidiMan M Audio Delta 44
768                         * MidiMan M Audio Delta 410
769                         * MidiMan M Audio Audiophile 2496
770                         * TerraTec EWS 88MT
771                         * TerraTec EWS 88D
772                         * TerraTec EWX 24/96
773                         * TerraTec DMX 6Fire
774                         * TerraTec Phase 88
775                         * Hoontech SoundTrack DSP 24
776                         * Hoontech SoundTrack DSP 24 Value
777                         * Hoontech SoundTrack DSP 24 Media 7.1
778                         * Event Electronics, EZ8
779                         * Digigram VX442
780                         * Lionstracs, Mediastaton
781
782     model       - Use the given board model, one of the following:
783                   delta1010, dio2496, delta66, delta44, audiophile, delta410,
784                   delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
785                   dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
786                   phase88, mediastation
787     omni        - Omni I/O support for MidiMan M-Audio Delta44/66
788     cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transciever)
789                      in msec resolution, default value is 500 (0.5 sec)
790
791     This module supports multiple cards and autoprobe. Note: The consumer part
792     is not used with all Envy24 based cards (for example in the MidiMan Delta
793     serie).
794
795     Note: The supported board is detected by reading EEPROM or PCI
796           SSID (if EEPROM isn't available).  You can override the
797           model by passing "model" module option in case that the
798           driver isn't configured properly or you want to try another
799           type for testing.
800
801   Module snd-ice1724
802   ------------------
803
804     Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
805                         * MidiMan M Audio Revolution 7.1
806                         * AMP Ltd AUDIO2000
807                         * TerraTec Aureon 5.1 Sky
808                         * TerraTec Aureon 7.1 Space
809                         * TerraTec Aureon 7.1 Universe
810                         * TerraTec Phase 22
811                         * TerraTec Phase 28
812                         * AudioTrak Prodigy 7.1
813                         * AudioTrak Prodigy 192
814                         * Pontis MS300
815                         * Albatron K8X800 Pro II 
816                         * Chaintech ZNF3-150
817                         * Chaintech ZNF3-250
818                         * Chaintech 9CJS
819                         * Chaintech AV-710
820                         * Shuttle SN25P
821
822     model       - Use the given board model, one of the following:
823                   revo71, amp2000, prodigy71, prodigy192, aureon51,
824                   aureon71, universe, k8x800, phase22, phase28, ms300,
825                   av710
826
827     This module supports multiple cards and autoprobe.
828
829     Note: The supported board is detected by reading EEPROM or PCI
830           SSID (if EEPROM isn't available).  You can override the
831           model by passing "model" module option in case that the
832           driver isn't configured properly or you want to try another
833           type for testing.
834
835   Module snd-intel8x0
836   -------------------
837
838     Module for AC'97 motherboards from Intel and compatibles.
839                         * Intel i810/810E, i815, i820, i830, i84x, MX440
840                                 ICH5, ICH6, ICH7, ESB2
841                         * SiS 7012 (SiS 735)
842                         * NVidia NForce, NForce2, NForce3, MCP04, CK804
843                                  CK8, CK8S, MCP501
844                         * AMD AMD768, AMD8111
845                         * ALi m5455
846
847     ac97_clock    - AC'97 codec clock base (0 = auto-detect)
848     ac97_quirk    - AC'97 workaround for strange hardware
849                     See "AC97 Quirk Option" section below.
850     buggy_irq     - Enable workaround for buggy interrupts on some
851                     motherboards (default yes on nForce chips,
852                     otherwise off)
853     buggy_semaphore - Enable workaround for hardwares with buggy
854                     semaphores (e.g. on some ASUS laptops)
855                     (default off)
856
857     This module supports one chip and autoprobe.
858
859     Note: the latest driver supports auto-detection of chip clock.
860     if you still encounter too fast playback, specify the clock
861     explicitly via the module option "ac97_clock=41194".
862
863     Joystick/MIDI ports are not supported by this driver.  If your
864     motherboard has these devices, use the ns558 or snd-mpu401
865     modules, respectively.
866
867     The power-management is supported.
868     
869   Module snd-intel8x0m
870   --------------------
871
872     Module for Intel ICH (i8x0) chipset MC97 modems.
873                         * Intel i810/810E, i815, i820, i830, i84x, MX440
874                                 ICH5, ICH6, ICH7
875                         * SiS 7013 (SiS 735)
876                         * NVidia NForce, NForce2, NForce2s, NForce3
877                         * AMD AMD8111
878                         * ALi m5455
879
880     ac97_clock    - AC'97 codec clock base (0 = auto-detect)
881
882     This module supports one card and autoprobe.
883
884     Note: The default index value of this module is -2, i.e. the first
885           slot is excluded.
886
887     The power-management is supported.
888
889   Module snd-interwave
890   --------------------
891
892     Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
893     and other sound cards based on AMD InterWave (tm) chip.
894   
895     port        - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
896     irq         - IRQ # for InterWave chip (3,5,9,11,12,15)
897     dma1        - DMA # for InterWave chip (0,1,3,5,6,7)
898     dma2        - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
899     joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
900     midi        - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
901     pcm_voices  - reserved PCM voices for the synthesizer (default 2)
902     effect      - 1 = InterWave effects enable (default 0);
903                   requires 8 voices
904
905     This module supports multiple cards, autoprobe and ISA PnP.
906
907   Module snd-interwave-stb
908   ------------------------
909
910     Module for UltraSound 32-Pro (sound card from STB used by Compaq)
911     and other sound cards based on AMD InterWave (tm) chip with TEA6330T
912     circuit for extended control of bass, treble and master volume.
913   
914     port        - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
915     port_tc     - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
916     irq         - IRQ # for InterWave chip (3,5,9,11,12,15)
917     dma1        - DMA # for InterWave chip (0,1,3,5,6,7)
918     dma2        - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
919     joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
920     midi        - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
921     pcm_voices  - reserved PCM voices for the synthesizer (default 2)
922     effect      - 1 = InterWave effects enable (default 0);
923                   requires 8 voices
924
925     This module supports multiple cards, autoprobe and ISA PnP.
926
927   Module snd-korg1212
928   -------------------
929
930     Module for Korg 1212 IO PCI card
931
932     This module supports multiple cards.
933
934   Module snd-maestro3
935   -------------------
936
937     Module for Allegro/Maestro3 chips
938
939     external_amp     - enable external amp (enabled by default)
940     amp_gpio         - GPIO pin number for external amp (0-15) or
941                        -1 for default pin (8 for allegro, 1 for
942                        others) 
943
944     This module supports autoprobe and multiple chips.
945
946     Note: the binding of amplifier is dependent on hardware.
947     If there is no sound even though all channels are unmuted, try to
948     specify other gpio connection via amp_gpio option. 
949     For example, a Panasonic notebook might need "amp_gpio=0x0d"
950     option.
951
952     The power-management is supported.
953
954   Module snd-mixart
955   -----------------
956
957     Module for Digigram miXart8 sound cards.
958
959     This module supports multiple cards.
960     Note: One miXart8 board will be represented as 4 alsa cards.
961           See MIXART.txt for details.
962
963     When the driver is compiled as a module and the hotplug firmware
964     is supported, the firmware data is loaded via hotplug automatically.
965     Install the necessary firmware files in alsa-firmware package.
966     When no hotplug fw loader is available, you need to load the
967     firmware via mixartloader utility in alsa-tools package.
968
969   Module snd-mpu401
970   -----------------
971
972     Module for MPU-401 UART devices.
973
974     port        - port number or -1 (disable)
975     irq         - IRQ number or -1 (disable)
976     pnp         - PnP detection - 0 = disable, 1 = enable (default)
977
978     This module supports multiple devices and PnP.
979     
980   Module snd-mtpav
981   ----------------
982
983     Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
984     port).
985
986     port        - I/O port # for MTPAV (0x378,0x278, default=0x378)
987     irq         - IRQ # for MTPAV (7,5, default=7)
988     hwports     - number of supported hardware ports, default=8.
989     
990     Module supports only 1 card.  This module has no enable option.
991
992   Module snd-nm256
993   ----------------
994
995     Module for NeoMagic NM256AV/ZX chips
996
997     playback_bufsize - max playback frame size in kB (4-128kB)
998     capture_bufsize  - max capture frame size in kB (4-128kB)
999     force_ac97       - 0 or 1 (disabled by default)
1000     buffer_top       - specify buffer top address
1001     use_cache        - 0 or 1 (disabled by default)
1002     vaio_hack        - alias buffer_top=0x25a800
1003     reset_workaround - enable AC97 RESET workaround for some laptops
1004     reset_workaround2 - enable extended AC97 RESET workaround for some
1005                       other laptops
1006
1007     This module supports one chip and autoprobe.
1008
1009     The power-management is supported.
1010
1011     Note: on some notebooks the buffer address cannot be detected
1012     automatically, or causes hang-up during initialization.
1013     In such a case, specify the buffer top address explicity via
1014     buffer_top option.
1015     For example,
1016       Sony F250: buffer_top=0x25a800
1017       Sony F270: buffer_top=0x272800
1018     The driver supports only ac97 codec.  It's possible to force
1019     to initialize/use ac97 although it's not detected.  In such a
1020     case, use force_ac97=1 option - but *NO* guarantee whether it
1021     works!
1022
1023     Note: The NM256 chip can be linked internally with non-AC97
1024     codecs.  This driver supports only the AC97 codec, and won't work
1025     with machines with other (most likely CS423x or OPL3SAx) chips,
1026     even though the device is detected in lspci.  In such a case, try
1027     other drivers, e.g. snd-cs4232 or snd-opl3sa2.  Some has ISA-PnP
1028     but some doesn't have ISA PnP.  You'll need to specify isapnp=0
1029     and proper hardware parameters in the case without ISA PnP.
1030
1031     Note: some laptops need a workaround for AC97 RESET.  For the
1032     known hardware like Dell Latitude LS and Sony PCG-F305, this
1033     workaround is enabled automatically.  For other laptops with a
1034     hard freeze, you can try reset_workaround=1 option.
1035
1036     Note: Dell Latitude CSx laptops have another problem regarding
1037     AC97 RESET.  On these laptops, reset_workaround2 option is
1038     turned on as default.  This option is worth to try if the
1039     previous reset_workaround option doesn't help.
1040
1041     Note: This driver is really crappy.  It's a porting from the
1042     OSS driver, which is a result of black-magic reverse engineering.
1043     The detection of codec will fail if the driver is loaded *after*
1044     X-server as described above.  You might be able to force to load
1045     the module, but it may result in hang-up.   Hence, make sure that
1046     you load this module *before* X if you encounter this kind of
1047     problem.
1048
1049   Module snd-opl3sa2
1050   ------------------
1051
1052     Module for Yamaha OPL3-SA2/SA3 sound cards.
1053
1054     port        - control port # for OPL3-SA chip (0x370)
1055     sb_port     - SB port # for OPL3-SA chip (0x220,0x240)
1056     wss_port    - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1057     midi_port   - port # for MPU-401 UART (0x300,0x330), -1 = disable
1058     fm_port     - FM port # for OPL3-SA chip (0x388), -1 = disable
1059     irq         - IRQ # for OPL3-SA chip (5,7,9,10)
1060     dma1        - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1061     dma2        - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
1062     isapnp      - ISA PnP detection - 0 = disable, 1 = enable (default)
1063     
1064     This module supports multiple cards and ISA PnP.  It does not support
1065     autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1066     
1067     The power-management is supported.
1068
1069   Module snd-opti92x-ad1848
1070   -------------------------
1071
1072     Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1073     Module works with OAK Mozart cards as well.
1074     
1075     port      - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1076     mpu_port  - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1077     fm_port   - port # for OPL3 device (0x388)
1078     irq       - IRQ # for WSS chip (5,7,9,10,11)
1079     mpu_irq   - IRQ # for MPU-401 UART (5,7,9,10)
1080     dma1      - first DMA # for WSS chip (0,1,3)
1081
1082     This module supports only one card, autoprobe and PnP.
1083
1084   Module snd-opti92x-cs4231
1085   -------------------------
1086
1087     Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1088     
1089     port      - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1090     mpu_port  - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1091     fm_port   - port # for OPL3 device (0x388)
1092     irq       - IRQ # for WSS chip (5,7,9,10,11)
1093     mpu_irq   - IRQ # for MPU-401 UART (5,7,9,10)
1094     dma1      - first DMA # for WSS chip (0,1,3)
1095     dma2      - second DMA # for WSS chip (0,1,3)
1096
1097     This module supports only one card, autoprobe and PnP.
1098
1099   Module snd-opti93x
1100   ------------------
1101
1102     Module for sound cards based on OPTi 82c93x chips.
1103     
1104     port      - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1105     mpu_port  - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1106     fm_port   - port # for OPL3 device (0x388)
1107     irq       - IRQ # for WSS chip (5,7,9,10,11)
1108     mpu_irq   - IRQ # for MPU-401 UART (5,7,9,10)
1109     dma1      - first DMA # for WSS chip (0,1,3)
1110     dma2      - second DMA # for WSS chip (0,1,3)
1111
1112     This module supports only one card, autoprobe and PnP.
1113
1114   Module snd-pcxhr
1115   ----------------
1116
1117     Module for Digigram PCXHR boards
1118
1119     This module supports multiple cards.
1120
1121   Module snd-powermac (on ppc only)
1122   ---------------------------------
1123
1124     Module for PowerMac, iMac and iBook on-board soundchips
1125
1126     enable_beep     - enable beep using PCM (enabled as default)
1127
1128     Module supports autoprobe a chip.
1129
1130     Note: the driver may have problems regarding endianess.
1131
1132     The power-management is supported.
1133
1134   Module snd-pxa2xx-ac97 (on arm only)
1135   ------------------------------------
1136
1137     Module for AC97 driver for the Intel PXA2xx chip
1138
1139     For ARM architecture only.
1140
1141     The power-management is supported.
1142
1143   Module snd-rme32
1144   ----------------
1145
1146     Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32, 
1147     Prodif96 and Prodif Gold) sound cards.
1148
1149     This module supports multiple cards.
1150
1151   Module snd-rme96
1152   ----------------
1153
1154     Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1155
1156     This module supports multiple cards.
1157
1158   Module snd-rme9652
1159   ------------------
1160
1161     Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1162
1163     precise_ptr - Enable precise pointer (doesn't work reliably).
1164                   (default = 0)
1165
1166     This module supports multiple cards.
1167
1168     Note: snd-page-alloc module does the job which snd-hammerfall-mem
1169           module did formerly.  It will allocate the buffers in advance
1170           when any RME9652 cards are found.  To make the buffer
1171           allocation sure, load snd-page-alloc module in the early
1172           stage of boot sequence.  See "Early Buffer Allocation"
1173           section.
1174
1175   Module snd-sa11xx-uda1341 (on arm only)
1176   ---------------------------------------
1177
1178     Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1179
1180     Module supports only one card.
1181     Module has no enable and index options.
1182
1183     The power-management is supported.
1184
1185   Module snd-sb8
1186   --------------
1187
1188     Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1189                                          SoundBlaster 2.0,
1190                                          SoundBlaster Pro
1191
1192     port        - port # for SB DSP chip (0x220,0x240,0x260)
1193     irq         - IRQ # for SB DSP chip (5,7,9,10)
1194     dma8        - DMA # for SB DSP chip (1,3)
1195
1196     This module supports multiple cards and autoprobe.
1197     
1198     The power-management is supported.
1199
1200   Module snd-sb16 and snd-sbawe
1201   -----------------------------
1202
1203     Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1204                                           SoundBlaster AWE 32 (PnP),
1205                                           SoundBlaster AWE 64 PnP
1206
1207     port        - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1208     mpu_port    - port # for MPU-401 UART (0x300,0x330), -1 = disable
1209     awe_port    - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1210                    (snd-sbawe module only)
1211     irq         - IRQ # for SB DSP 4.x chip (5,7,9,10)
1212     dma8        - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1213     dma16       - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
1214     mic_agc     - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1215     csp         - ASP/CSP chip support - 0 = disable (default), 1 = enable
1216     isapnp      - ISA PnP detection - 0 = disable, 1 = enable (default)
1217     
1218     This module supports multiple cards, autoprobe and ISA PnP.
1219
1220     Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1221           disable 16bit DMA with dma16 = -1 module parameter.
1222           Also, all Sound Blaster 16 type cards can operate in 16-bit
1223           half duplex mode through 8-bit DMA channel by disabling their
1224           16-bit DMA channel.
1225     
1226     The power-management is supported.
1227
1228   Module snd-sgalaxy
1229   ------------------
1230
1231     Module for Aztech Sound Galaxy sound card.
1232
1233     sbport      - Port # for SB16 interface (0x220,0x240)
1234     wssport     - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1235     irq         - IRQ # (7,9,10,11)
1236     dma1        - DMA #
1237
1238     This module supports multiple cards.
1239
1240     The power-management is supported.
1241
1242   Module snd-sscape
1243   -----------------
1244
1245     Module for ENSONIQ SoundScape PnP cards.
1246
1247     port        - Port # (PnP setup)
1248     irq         - IRQ # (PnP setup)
1249     mpu_irq     - MPU-401 IRQ # (PnP setup)
1250     dma         - DMA # (PnP setup)
1251
1252     This module supports multiple cards.  ISA PnP must be enabled.
1253     You need sscape_ctl tool in alsa-tools package for loading
1254     the microcode.
1255
1256   Module snd-sun-amd7930 (on sparc only)
1257   --------------------------------------
1258
1259     Module for AMD7930 sound chips found on Sparcs.
1260
1261     This module supports multiple cards.
1262
1263   Module snd-sun-cs4231 (on sparc only)
1264   -------------------------------------
1265
1266     Module for CS4231 sound chips found on Sparcs.
1267
1268     This module supports multiple cards.
1269
1270   Module snd-sun-dbri (on sparc only)
1271   -----------------------------------
1272
1273     Module for DBRI sound chips found on Sparcs.
1274
1275     This module supports multiple cards.
1276
1277   Module snd-wavefront
1278   --------------------
1279
1280     Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1281
1282     cs4232_pcm_port - Port # for CS4232 PCM interface.
1283     cs4232_pcm_irq  - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1284     cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1285     cs4232_mpu_irq  - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
1286     use_cs4232_midi - Use CS4232 MPU-401 interface
1287                       (inaccessibly located inside your computer)
1288     ics2115_port    - Port # for ICS2115
1289     ics2115_irq     - IRQ # for ICS2115
1290     fm_port         - FM OPL-3 Port #
1291     dma1            - DMA1 # for CS4232 PCM interface.
1292     dma2            - DMA2 # for CS4232 PCM interface.
1293     isapnp          - ISA PnP detection - 0 = disable, 1 = enable (default)
1294
1295     This module supports multiple cards and ISA PnP.
1296
1297   Module snd-sonicvibes
1298   ---------------------
1299
1300     Module for S3 SonicVibes PCI sound cards.
1301                         * PINE Schubert 32 PCI
1302
1303     reverb    - Reverb Enable - 1 = enable, 0 = disable (default)
1304                   - SoundCard must have onboard SRAM for this.
1305     mge       - Mic Gain Enable - 1 = enable, 0 = disable (default)
1306     
1307     This module supports multiple cards and autoprobe.
1308
1309   Module snd-serial-u16550
1310   ------------------------
1311
1312     Module for UART16550A serial MIDI ports.
1313
1314     port        - port # for UART16550A chip
1315     irq         - IRQ # for UART16550A chip, -1 = poll mode
1316     speed       - speed in bauds (9600,19200,38400,57600,115200)
1317                   38400 = default
1318     base        - base for divisor in bauds (57600,115200,230400,460800)
1319                   115200 = default
1320     outs        - number of MIDI ports in a serial port (1-4)
1321                   1 = default
1322     adaptor     - Type of adaptor.
1323                   0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1324                   3 = MS-124W M/B, 4 = Generic
1325     
1326     This module supports multiple cards. This module does not support autoprobe
1327     thus the main port must be specified!!! Other options are optional.
1328
1329   Module snd-trident
1330   ------------------
1331
1332     Module for Trident 4DWave DX/NX sound cards.
1333                         * Best Union  Miss Melody 4DWave PCI
1334                         * HIS  4DWave PCI
1335                         * Warpspeed  ONSpeed 4DWave PCI
1336                         * AzTech  PCI 64-Q3D
1337                         * Addonics  SV 750
1338                         * CHIC  True Sound 4Dwave
1339                         * Shark  Predator4D-PCI
1340                         * Jaton  SonicWave 4D
1341
1342     pcm_channels   - max channels (voices) reserved for PCM
1343     wavetable_size - max wavetable size in kB (4-?kb)
1344
1345     This module supports multiple cards and autoprobe.
1346
1347     The power-management is supported.
1348
1349   Module snd-usb-audio
1350   --------------------
1351
1352     Module for USB audio and USB MIDI devices.
1353
1354     vid             - Vendor ID for the device (optional)
1355     pid             - Product ID for the device (optional)
1356
1357     This module supports multiple devices, autoprobe and hotplugging.
1358
1359   Module snd-usb-usx2y
1360   --------------------
1361
1362     Module for Tascam USB US-122, US-224 and US-428 devices.
1363
1364     This module supports multiple devices, autoprobe and hotplugging.
1365
1366     Note: you need to load the firmware via usx2yloader utility included
1367           in alsa-tools and alsa-firmware packages.
1368
1369   Module snd-via82xx
1370   ------------------
1371
1372     Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
1373     8233A, 8233C, 8235, 8237 (south) bridge.
1374
1375     mpu_port    - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1376                   [VIA686A/686B only]
1377     joystick    - Enable joystick (default off) [VIA686A/686B only]
1378     ac97_clock  - AC'97 codec clock base (default 48000Hz)
1379     dxs_support - support DXS channels,
1380                   0 = auto (default), 1 = enable, 2 = disable,
1381                   3 = 48k only, 4 = no VRA, 5 = enable any sample
1382                   rate and different sample rates on different
1383                   channels
1384                   [VIA8233/C, 8235, 8237 only]
1385     ac97_quirk  - AC'97 workaround for strange hardware
1386                   See "AC97 Quirk Option" section below.
1387
1388     This module supports one chip and autoprobe.
1389
1390     Note: on some SMP motherboards like MSI 694D the interrupts might
1391           not be generated properly.  In such a case, please try to
1392           set the SMP (or MPS) version on BIOS to 1.1 instead of
1393           default value 1.4.  Then the interrupt number will be
1394           assigned under 15. You might also upgrade your BIOS.
1395     
1396     Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
1397           channels as the first PCM.  On these channels, up to 4
1398           streams can be played at the same time, and the controller
1399           can perform sample rate conversion with separate rates for
1400           each channel.
1401           As default (dxs_support = 0), 48k fixed rate is chosen
1402           except for the known devices since the output is often
1403           noisy except for 48k on some mother boards due to the
1404           bug of BIOS.
1405           Please try once dxs_support=5 and if it works on other
1406           sample rates (e.g. 44.1kHz of mp3 playback), please let us
1407           know the PCI subsystem vendor/device id's (output of
1408           "lspci -nv").
1409           If dxs_support=5 does not work, try dxs_support=4; if it
1410           doesn't work too, try dxs_support=1.  (dxs_support=1 is
1411           usually for old motherboards.  The correct implemented
1412           board should work with 4 or 5.)  If it still doesn't
1413           work and the default setting is ok, dxs_support=3 is the
1414           right choice.  If the default setting doesn't work at all,
1415           try dxs_support=2 to disable the DXS channels.
1416           In any cases, please let us know the result and the
1417           subsystem vendor/device ids.  See "Links and Addresses"
1418           below.
1419
1420     Note: for the MPU401 on VIA823x, use snd-mpu401 driver
1421           additionally.  The mpu_port option is for VIA686 chips only.
1422
1423     The power-management is supported.
1424
1425   Module snd-via82xx-modem
1426   ------------------------
1427
1428     Module for VIA82xx AC97 modem
1429
1430     ac97_clock  - AC'97 codec clock base (default 48000Hz)
1431
1432     This module supports one card and autoprobe.
1433
1434     Note: The default index value of this module is -2, i.e. the first
1435           slot is excluded.
1436
1437     The power-management is supported.
1438
1439   Module snd-virmidi
1440   ------------------
1441
1442     Module for virtual rawmidi devices.
1443     This module creates virtual rawmidi devices which communicate
1444     to the corresponding ALSA sequencer ports.
1445
1446     midi_devs   - MIDI devices # (1-4, default=4)
1447     
1448     This module supports multiple cards.
1449
1450   Module snd-vx222
1451   ----------------
1452
1453     Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1454
1455     mic         - Enable Microphone on V222 Mic (NYI)
1456     ibl         - Capture IBL size. (default = 0, minimum size)
1457
1458     This module supports multiple cards.
1459
1460     When the driver is compiled as a module and the hotplug firmware
1461     is supported, the firmware data is loaded via hotplug automatically.
1462     Install the necessary firmware files in alsa-firmware package.
1463     When no hotplug fw loader is available, you need to load the
1464     firmware via vxloader utility in alsa-tools package.  To invoke
1465     vxloader automatically, add the following to /etc/modprobe.conf
1466
1467         install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1468
1469     (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1470      /etc/modules.conf, instead.)
1471     IBL size defines the interrupts period for PCM.  The smaller size
1472     gives smaller latency but leads to more CPU consumption, too.
1473     The size is usually aligned to 126.  As default (=0), the smallest
1474     size is chosen.  The possible IBL values can be found in
1475     /proc/asound/cardX/vx-status proc file.
1476
1477     The power-management is supported.
1478
1479   Module snd-vxpocket
1480   -------------------
1481
1482     Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
1483
1484     ibl      - Capture IBL size. (default = 0, minimum size)
1485
1486     This module supports multiple cards.  The module is compiled only when
1487     PCMCIA is supported on kernel.
1488
1489     With the older 2.6.x kernel, to activate the driver via the card
1490     manager, you'll need to set up /etc/pcmcia/vxpocket.conf.  See the
1491     sound/pcmcia/vx/vxpocket.c.  2.6.13 or later kernel requires no
1492     longer require a config file.
1493
1494     When the driver is compiled as a module and the hotplug firmware
1495     is supported, the firmware data is loaded via hotplug automatically.
1496     Install the necessary firmware files in alsa-firmware package.
1497     When no hotplug fw loader is available, you need to load the
1498     firmware via vxloader utility in alsa-tools package.
1499
1500     About capture IBL, see the description of snd-vx222 module.
1501
1502     Note: the driver is build only when CONFIG_ISA is set.
1503     
1504     Note2: snd-vxp440 driver is merged to snd-vxpocket driver since
1505            ALSA 1.0.10.
1506
1507     The power-management is supported.
1508
1509   Module snd-ymfpci
1510   -----------------
1511
1512     Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1513
1514     mpu_port      - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1515                     1 (auto-detect for YMF744/754 only)
1516     fm_port       - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1517                     1 (auto-detect for YMF744/754 only)
1518     joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1519                     1 (auto-detect)
1520     rear_switch   - enable shared rear/line-in switch (bool)
1521
1522     This module supports autoprobe and multiple chips.
1523
1524     The power-management is supported.
1525
1526   Module snd-pdaudiocf
1527   --------------------
1528
1529     Module for Sound Core PDAudioCF sound card.
1530
1531     Note: the driver is build only when CONFIG_ISA is set.
1532
1533     The power-management is supported.
1534
1535
1536 AC97 Quirk Option
1537 =================
1538
1539 The ac97_quirk option is used to enable/override the workaround for
1540 specific devices on drivers for on-board AC'97 controllers like
1541 snd-intel8x0.  Some hardware have swapped output pins between Master
1542 and Headphone, or Surround (thanks to confusion of AC'97
1543 specifications from version to version :-)
1544
1545 The driver provides the auto-detection of known problematic devices,
1546 but some might be unknown or wrongly detected.  In such a case, pass
1547 the proper value with this option.
1548
1549 The following strings are accepted:
1550     - default   Don't override the default setting
1551     - none      Disable the quirk
1552     - hp_only   Bind Master and Headphone controls as a single control
1553     - swap_hp   Swap headphone and master controls
1554     - swap_surround  Swap master and surround controls
1555     - ad_sharing  For AD1985, turn on OMS bit and use headphone
1556     - alc_jack  For ALC65x, turn on the jack sense mode
1557     - inv_eapd  Inverted EAPD implementation
1558     - mute_led  Bind EAPD bit for turning on/off mute LED
1559
1560 For backward compatibility, the corresponding integer value -1, 0,
1561 ... are  accepted, too.
1562
1563 For example, if "Master" volume control has no effect on your device
1564 but only "Headphone" does, pass ac97_quirk=hp_only module option.
1565
1566
1567 Configuring Non-ISAPNP Cards
1568 ============================
1569
1570 When the kernel is configured with ISA-PnP support, the modules
1571 supporting the isapnp cards will have module options "isapnp".
1572 If this option is set, *only* the ISA-PnP devices will be probed.
1573 For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
1574 together with the proper i/o and irq configuration.
1575
1576 When the kernel is configured without ISA-PnP support, isapnp option
1577 will be not built in.
1578
1579
1580 Module Autoloading Support
1581 ==========================
1582
1583 The ALSA drivers can be loaded automatically on demand by defining
1584 module aliases.  The string 'snd-card-%1' is requested for ALSA native
1585 devices where %i is sound card number from zero to seven.
1586
1587 To auto-load an ALSA driver for OSS services, define the string
1588 'sound-slot-%i' where %i means the slot number for OSS, which
1589 corresponds to the card index of ALSA.  Usually, define this
1590 as the same card module.
1591
1592 An example configuration for a single emu10k1 card is like below:
1593 ----- /etc/modprobe.conf
1594 alias snd-card-0 snd-emu10k1
1595 alias sound-slot-0 snd-emu10k1
1596 ----- /etc/modprobe.conf
1597
1598 The available number of auto-loaded sound cards depends on the module
1599 option "cards_limit" of snd module.  As default it's set to 1.
1600 To enable the auto-loading of multiple cards, specify the number of
1601 sound cards in that option.
1602
1603 When multiple cards are available, it'd better to specify the index
1604 number for each card via module option, too, so that the order of
1605 cards is kept consistent.
1606
1607 An example configuration for two sound cards is like below:
1608
1609 ----- /etc/modprobe.conf
1610 # ALSA portion
1611 options snd cards_limit=2
1612 alias snd-card-0 snd-interwave
1613 alias snd-card-1 snd-ens1371
1614 options snd-interwave index=0
1615 options snd-ens1371 index=1
1616 # OSS/Free portion
1617 alias sound-slot-0 snd-interwave
1618 alias sound-slot-1 snd-ens1371
1619 ----- /etc/moprobe.conf
1620
1621 In this example, the interwave card is always loaded as the first card
1622 (index 0) and ens1371 as the second (index 1).
1623
1624
1625 ALSA PCM devices to OSS devices mapping
1626 =======================================
1627
1628 /dev/snd/pcmC0D0[c|p]  -> /dev/audio0 (/dev/audio) -> minor 4
1629 /dev/snd/pcmC0D0[c|p]  -> /dev/dsp0 (/dev/dsp)     -> minor 3
1630 /dev/snd/pcmC0D1[c|p]  -> /dev/adsp0 (/dev/adsp)   -> minor 12
1631 /dev/snd/pcmC1D0[c|p]  -> /dev/audio1              -> minor 4+16 = 20
1632 /dev/snd/pcmC1D0[c|p]  -> /dev/dsp1                -> minor 3+16 = 19
1633 /dev/snd/pcmC1D1[c|p]  -> /dev/adsp1               -> minor 12+16 = 28
1634 /dev/snd/pcmC2D0[c|p]  -> /dev/audio2              -> minor 4+32 = 36
1635 /dev/snd/pcmC2D0[c|p]  -> /dev/dsp2                -> minor 3+32 = 39
1636 /dev/snd/pcmC2D1[c|p]  -> /dev/adsp2               -> minor 12+32 = 44
1637
1638 The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
1639 sound card number and second means device number.  The ALSA devices
1640 have either 'c' or 'p' suffix indicating the direction, capture and
1641 playback, respectively.
1642
1643 Please note that the device mapping above may be varied via the module
1644 options of snd-pcm-oss module.
1645
1646
1647 DEVFS support
1648 =============
1649
1650 The ALSA driver fully supports the devfs extension.
1651 You should add lines below to your devfsd.conf file:
1652
1653 LOOKUP snd MODLOAD ACTION snd
1654 REGISTER ^sound/.* PERMISSIONS root.audio 660
1655 REGISTER ^snd/.* PERMISSIONS root.audio 660
1656
1657 Warning: These lines assume that you have the audio group in your system.
1658          Otherwise replace audio word with another group name (root for
1659          example).
1660
1661
1662 Proc interfaces (/proc/asound)
1663 ==============================
1664
1665 /proc/asound/card#/pcm#[cp]/oss
1666 -------------------------------
1667   String "erase" - erase all additional informations about OSS applications
1668   String "<app_name> <fragments> <fragment_size> [<options>]"
1669
1670    <app_name> - name of application with (higher priority) or without path
1671    <fragments> - number of fragments or zero if auto
1672    <fragment_size> - size of fragment in bytes or zero if auto
1673    <options> - optional parameters
1674           - disable   the application tries to open a pcm device for
1675                       this channel but does not want to use it.
1676                       (Cause a bug or mmap needs)
1677                       It's good for Quake etc...
1678           - direct    don't use plugins
1679           - block     force block mode (rvplayer)
1680           - non-block force non-block mode
1681           - whole-frag  write only whole fragments (optimization affecting
1682                         playback only)
1683           - no-silence  do not fill silence ahead to avoid clicks
1684           - buggy-ptr   Returns the whitespace blocks in GETOPTR ioctl
1685                         instead of filled blocks
1686
1687   Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
1688            echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
1689            echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
1690
1691
1692 Early Buffer Allocation
1693 =======================
1694
1695 Some drivers (e.g. hdsp) require the large contiguous buffers, and
1696 sometimes it's too late to find such spaces when the driver module is
1697 actually loaded due to memory fragmentation.  You can pre-allocate the
1698 PCM buffers by loading snd-page-alloc module and write commands to its
1699 proc file in prior, for example, in the early boot stage like
1700 /etc/init.d/*.local scripts.
1701
1702 Reading the proc file /proc/drivers/snd-page-alloc shows the current
1703 usage of page allocation.  In writing, you can send the following
1704 commands to the snd-page-alloc driver:
1705
1706   - add VENDOR DEVICE MASK SIZE BUFFERS
1707
1708     VENDOR and DEVICE are PCI vendor and device IDs.  They take
1709     integer numbers (0x prefix is needed for the hex).
1710     MASK is the PCI DMA mask.  Pass 0 if not restricted.
1711     SIZE is the size of each buffer to allocate.  You can pass
1712     k and m suffix for KB and MB.  The max number is 16MB.
1713     BUFFERS is the number of buffers to allocate.  It must be greater
1714     than 0.  The max number is 4.
1715
1716   - erase
1717
1718     This will erase the all pre-allocated buffers which are not in
1719     use.
1720
1721
1722 Links and Addresses
1723 ===================
1724
1725   ALSA project homepage
1726        http://www.alsa-project.org
1727
1728   ALSA Bug Tracking System
1729        https://bugtrack.alsa-project.org/bugs/
1730
1731   ALSA Developers ML
1732        mailto:alsa-devel@lists.sourceforge.net