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