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