[ALSA] hda-codec - Add Thinkpad X60/T60/Z60 support
[pandora-kernel.git] / Documentation / sound / alsa / ALSA-Configuration.txt
1
2                 Advanced Linux Sound Architecture - Driver
3                 ==========================================
4                             Configuration guide
5
6
7 Kernel Configuration
8 ====================
9
10 To enable ALSA support you need at least to build the kernel with
11 primary sound card support (CONFIG_SOUND).  Since ALSA can emulate OSS,
12 you don't have to choose any of the OSS modules.
13
14 Enable "OSS API emulation" (CONFIG_SND_OSSEMUL) and both OSS mixer and
15 PCM supports if you want to run OSS applications with ALSA.
16
17 If you want to support the WaveTable functionality on cards such as
18 SB Live! then you need to enable "Sequencer support"
19 (CONFIG_SND_SEQUENCER).
20
21 To make ALSA debug messages more verbose, enable the "Verbose printk"
22 and "Debug" options.  To check for memory leaks, turn on "Debug memory"
23 too.  "Debug detection" will add checks for the detection of cards.
24
25 Please note that all the ALSA ISA drivers support the Linux isapnp API
26 (if the card supports ISA PnP).  You don't need to configure the cards
27 using isapnptools.
28
29
30 Creating ALSA devices
31 =====================
32
33 This depends on your distribution, but normally you use the /dev/MAKEDEV
34 script to create the necessary device nodes.  On some systems you use a
35 script named 'snddevices'.
36
37
38 Module parameters
39 =================
40
41 The user can load modules with options. If the module supports more than
42 one card and you have more than one card of the same type then you can
43 specify multiple values for the option separated by commas.
44
45 Prior to version 0.9.0rc4 options had a 'snd_' prefix. This was removed.
46
47   Module snd
48   ----------
49
50     The core ALSA module.  It is used by all ALSA card drivers.
51     It takes the following options which have global effects.
52
53     major       - major number for sound driver
54                 - Default: 116
55     cards_limit
56                 - limiting card index for auto-loading (1-8)
57                 - Default: 1
58                 - For auto-loading more than one card, specify this
59                   option together with snd-card-X aliases.
60     device_mode
61                 - permission mask for dynamic sound device filesystem
62                 - This is available only when DEVFS is enabled
63                 - Default: 0666
64                 - E.g.: device_mode=0660
65
66   
67   Module snd-pcm-oss
68   ------------------
69
70     The PCM OSS emulation module.
71     This module takes options which change the mapping of devices.
72
73     dsp_map     - PCM device number maps assigned to the 1st OSS device.
74                 - Default: 0
75     adsp_map    - PCM device number maps assigned to the 2st OSS device.
76                 - Default: 1
77     nonblock_open
78                 - Don't block opening busy PCM devices.  Default: 1
79
80     For example, when dsp_map=2, /dev/dsp will be mapped to PCM #2 of
81     the card #0.  Similarly, when adsp_map=0, /dev/adsp will be mapped
82     to PCM #0 of the card #0.
83     For changing the second or later card, specify the option with
84     commas, such like "dsp_map=0,1".
85
86     nonblock_open option is used to change the behavior of the PCM
87     regarding opening the device.  When this option is non-zero,
88     opening a busy OSS PCM device won't be blocked but return
89     immediately with EAGAIN (just like O_NONBLOCK flag).
90     
91   Module snd-rawmidi
92   ------------------
93
94     This module takes options which change the mapping of devices.
95     similar to those of the snd-pcm-oss module.
96
97     midi_map    - MIDI device number maps assigned to the 1st OSS device.
98                 - Default: 0
99     amidi_map   - MIDI device number maps assigned to the 2st OSS device.
100                 - Default: 1
101
102   Common parameters for top sound card modules
103   --------------------------------------------
104
105     Each of top level sound card module takes the following options.
106
107     index       - index (slot #) of sound card
108                 - Values: 0 through 31 or negative
109                 - If nonnegative, assign that index number
110                 - if negative, interpret as a bitmask of permissible
111                   indices; the first free permitted index is assigned
112                 - Default: -1
113     id          - card ID (identifier or name)
114                 - Can be up to 15 characters long
115                 - Default: the card type
116                 - A directory by this name is created under /proc/asound/
117                   containing information about the card
118                 - This ID can be used instead of the index number in
119                   identifying the card
120     enable      - enable card
121                 - Default: enabled, for PCI and ISA PnP cards
122
123   Module snd-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           thinkpad      Lenovo Thinkpad T60/X60/Z60
782
783         AD1986A
784           6stack        6-jack, separate surrounds (default)
785           3stack        3-stack, shared surrounds
786           laptop        2-channel only (FSC V2060, Samsung M50)
787           laptop-eapd   2-channel with EAPD (Samsung R65, ASUS A6J)
788
789         AD1988
790           6stack        6-jack
791           6stack-dig    ditto with SPDIF
792           3stack        3-jack
793           3stack-dig    ditto with SPDIF
794           laptop        3-jack with hp-jack automute
795           laptop-dig    ditto with SPDIF
796           auto          auto-confgi reading BIOS (default)
797
798         STAC7661(?)
799           vaio          Setup for VAIO FE550G/SZ110
800
801     If the default configuration doesn't work and one of the above
802     matches with your device, report it together with the PCI
803     subsystem ID (output of "lspci -nv") to ALSA BTS or alsa-devel
804     ML (see the section "Links and Addresses").
805
806     Note 2: If you get click noises on output, try the module option
807             position_fix=1 or 2.  position_fix=1 will use the SD_LPIB
808             register value without FIFO size correction as the current
809             DMA pointer.  position_fix=2 will make the driver to use
810             the position buffer instead of reading SD_LPIB register.
811             (Usually SD_LPLIB register is more accurate than the
812             position buffer.)
813
814     NB: If you get many "azx_get_response timeout" messages at
815     loading, it's likely a problem of interrupts (e.g. ACPI irq
816     routing).  Try to boot with options like "pci=noacpi".  Also, you
817     can try "single_cmd=1" module option.  This will switch the
818     communication method between HDA controller and codecs to the
819     single immediate commands instead of CORB/RIRB.  Basically, the
820     single command mode is provided only for BIOS, and you won't get
821     unsolicited events, too.  But, at least, this works independently
822     from the irq.  Remember this is a last resort, and should be
823     avoided as much as possible...
824     
825     The power-management is supported.
826
827   Module snd-hdsp
828   ---------------
829
830     Module for RME Hammerfall DSP audio interface(s)
831
832     This module supports multiple cards.
833
834     Note: The firmware data can be automatically loaded via hotplug
835           when CONFIG_FW_LOADER is set.  Otherwise, you need to load
836           the firmware via hdsploader utility included in alsa-tools
837           package.
838           The firmware data is found in alsa-firmware package.
839
840     Note: snd-page-alloc module does the job which snd-hammerfall-mem
841           module did formerly.  It will allocate the buffers in advance
842           when any HDSP cards are found.  To make the buffer
843           allocation sure, load snd-page-alloc module in the early
844           stage of boot sequence.  See "Early Buffer Allocation"
845           section.
846
847   Module snd-hdspm
848   ----------------
849
850     Module for RME HDSP MADI board.
851
852     precise_ptr         - Enable precise pointer, or disable.
853     line_outs_monitor   - Send playback streams to analog outs by default.
854     enable_monitor      - Enable Analog Out on Channel 63/64 by default.
855
856     See hdspm.txt for details.
857
858   Module snd-ice1712
859   ------------------
860
861     Module for Envy24 (ICE1712) based PCI sound cards.
862                         * MidiMan M Audio Delta 1010
863                         * MidiMan M Audio Delta 1010LT
864                         * MidiMan M Audio Delta DiO 2496
865                         * MidiMan M Audio Delta 66
866                         * MidiMan M Audio Delta 44
867                         * MidiMan M Audio Delta 410
868                         * MidiMan M Audio Audiophile 2496
869                         * TerraTec EWS 88MT
870                         * TerraTec EWS 88D
871                         * TerraTec EWX 24/96
872                         * TerraTec DMX 6Fire
873                         * TerraTec Phase 88
874                         * Hoontech SoundTrack DSP 24
875                         * Hoontech SoundTrack DSP 24 Value
876                         * Hoontech SoundTrack DSP 24 Media 7.1
877                         * Event Electronics, EZ8
878                         * Digigram VX442
879                         * Lionstracs, Mediastaton
880
881     model       - Use the given board model, one of the following:
882                   delta1010, dio2496, delta66, delta44, audiophile, delta410,
883                   delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
884                   dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
885                   phase88, mediastation
886     omni        - Omni I/O support for MidiMan M-Audio Delta44/66
887     cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transciever)
888                      in msec resolution, default value is 500 (0.5 sec)
889
890     This module supports multiple cards and autoprobe. Note: The consumer part
891     is not used with all Envy24 based cards (for example in the MidiMan Delta
892     serie).
893
894     Note: The supported board is detected by reading EEPROM or PCI
895           SSID (if EEPROM isn't available).  You can override the
896           model by passing "model" module option in case that the
897           driver isn't configured properly or you want to try another
898           type for testing.
899
900   Module snd-ice1724
901   ------------------
902
903     Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
904                         * MidiMan M Audio Revolution 5.1
905                         * MidiMan M Audio Revolution 7.1
906                         * AMP Ltd AUDIO2000
907                         * TerraTec Aureon 5.1 Sky
908                         * TerraTec Aureon 7.1 Space
909                         * TerraTec Aureon 7.1 Universe
910                         * TerraTec Phase 22
911                         * TerraTec Phase 28
912                         * AudioTrak Prodigy 7.1
913                         * AudioTrak Prodigy 7.1LT
914                         * AudioTrak Prodigy 192
915                         * Pontis MS300
916                         * Albatron K8X800 Pro II 
917                         * Chaintech ZNF3-150
918                         * Chaintech ZNF3-250
919                         * Chaintech 9CJS
920                         * Chaintech AV-710
921                         * Shuttle SN25P
922
923     model       - Use the given board model, one of the following:
924                   revo51, revo71, amp2000, prodigy71, prodigy71lt,
925                   prodigy192, aureon51, aureon71, universe,
926                   k8x800, phase22, phase28, ms300, av710
927
928     This module supports multiple cards and autoprobe.
929
930     Note: The supported board is detected by reading EEPROM or PCI
931           SSID (if EEPROM isn't available).  You can override the
932           model by passing "model" module option in case that the
933           driver isn't configured properly or you want to try another
934           type for testing.
935
936   Module snd-intel8x0
937   -------------------
938
939     Module for AC'97 motherboards from Intel and compatibles.
940                         * Intel i810/810E, i815, i820, i830, i84x, MX440
941                                 ICH5, ICH6, ICH7, ESB2
942                         * SiS 7012 (SiS 735)
943                         * NVidia NForce, NForce2, NForce3, MCP04, CK804
944                                  CK8, CK8S, MCP501
945                         * AMD AMD768, AMD8111
946                         * ALi m5455
947
948     ac97_clock    - AC'97 codec clock base (0 = auto-detect)
949     ac97_quirk    - AC'97 workaround for strange hardware
950                     See "AC97 Quirk Option" section below.
951     buggy_irq     - Enable workaround for buggy interrupts on some
952                     motherboards (default yes on nForce chips,
953                     otherwise off)
954     buggy_semaphore - Enable workaround for hardwares with buggy
955                     semaphores (e.g. on some ASUS laptops)
956                     (default off)
957
958     This module supports one chip and autoprobe.
959
960     Note: the latest driver supports auto-detection of chip clock.
961     if you still encounter too fast playback, specify the clock
962     explicitly via the module option "ac97_clock=41194".
963
964     Joystick/MIDI ports are not supported by this driver.  If your
965     motherboard has these devices, use the ns558 or snd-mpu401
966     modules, respectively.
967
968     The power-management is supported.
969     
970   Module snd-intel8x0m
971   --------------------
972
973     Module for Intel ICH (i8x0) chipset MC97 modems.
974                         * Intel i810/810E, i815, i820, i830, i84x, MX440
975                                 ICH5, ICH6, ICH7
976                         * SiS 7013 (SiS 735)
977                         * NVidia NForce, NForce2, NForce2s, NForce3
978                         * AMD AMD8111
979                         * ALi m5455
980
981     ac97_clock    - AC'97 codec clock base (0 = auto-detect)
982
983     This module supports one card and autoprobe.
984
985     Note: The default index value of this module is -2, i.e. the first
986           slot is excluded.
987
988     The power-management is supported.
989
990   Module snd-interwave
991   --------------------
992
993     Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
994     and other sound cards based on AMD InterWave (tm) chip.
995   
996     port        - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
997     irq         - IRQ # for InterWave chip (3,5,9,11,12,15)
998     dma1        - DMA # for InterWave chip (0,1,3,5,6,7)
999     dma2        - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
1000     joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1001     midi        - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1002     pcm_voices  - reserved PCM voices for the synthesizer (default 2)
1003     effect      - 1 = InterWave effects enable (default 0);
1004                   requires 8 voices
1005
1006     This module supports multiple cards, autoprobe and ISA PnP.
1007
1008   Module snd-interwave-stb
1009   ------------------------
1010
1011     Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1012     and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1013     circuit for extended control of bass, treble and master volume.
1014   
1015     port        - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1016     port_tc     - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1017     irq         - IRQ # for InterWave chip (3,5,9,11,12,15)
1018     dma1        - DMA # for InterWave chip (0,1,3,5,6,7)
1019     dma2        - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
1020     joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1021     midi        - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1022     pcm_voices  - reserved PCM voices for the synthesizer (default 2)
1023     effect      - 1 = InterWave effects enable (default 0);
1024                   requires 8 voices
1025
1026     This module supports multiple cards, autoprobe and ISA PnP.
1027
1028   Module snd-korg1212
1029   -------------------
1030
1031     Module for Korg 1212 IO PCI card
1032
1033     This module supports multiple cards.
1034
1035   Module snd-maestro3
1036   -------------------
1037
1038     Module for Allegro/Maestro3 chips
1039
1040     external_amp     - enable external amp (enabled by default)
1041     amp_gpio         - GPIO pin number for external amp (0-15) or
1042                        -1 for default pin (8 for allegro, 1 for
1043                        others) 
1044
1045     This module supports autoprobe and multiple chips.
1046
1047     Note: the binding of amplifier is dependent on hardware.
1048     If there is no sound even though all channels are unmuted, try to
1049     specify other gpio connection via amp_gpio option. 
1050     For example, a Panasonic notebook might need "amp_gpio=0x0d"
1051     option.
1052
1053     The power-management is supported.
1054
1055   Module snd-miro
1056   ---------------
1057
1058     Module for Miro soundcards: miroSOUND PCM 1 pro, 
1059                                 miroSOUND PCM 12,
1060                                 miroSOUND PCM 20 Radio.
1061
1062     port        - Port # (0x530,0x604,0xe80,0xf40)
1063     irq         - IRQ # (5,7,9,10,11)
1064     dma1        - 1st dma # (0,1,3)
1065     dma2        - 2nd dma # (0,1)
1066     mpu_port    - MPU-401 port # (0x300,0x310,0x320,0x330)
1067     mpu_irq     - MPU-401 irq # (5,7,9,10)
1068     fm_port     - FM Port # (0x388)
1069     wss         - enable WSS mode
1070     ide         - enable onboard ide support
1071
1072   Module snd-mixart
1073   -----------------
1074
1075     Module for Digigram miXart8 sound cards.
1076
1077     This module supports multiple cards.
1078     Note: One miXart8 board will be represented as 4 alsa cards.
1079           See MIXART.txt for details.
1080
1081     When the driver is compiled as a module and the hotplug firmware
1082     is supported, the firmware data is loaded via hotplug automatically.
1083     Install the necessary firmware files in alsa-firmware package.
1084     When no hotplug fw loader is available, you need to load the
1085     firmware via mixartloader utility in alsa-tools package.
1086
1087   Module snd-mpu401
1088   -----------------
1089
1090     Module for MPU-401 UART devices.
1091
1092     port        - port number or -1 (disable)
1093     irq         - IRQ number or -1 (disable)
1094     pnp         - PnP detection - 0 = disable, 1 = enable (default)
1095
1096     This module supports multiple devices and PnP.
1097     
1098   Module snd-mtpav
1099   ----------------
1100
1101     Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1102     port).
1103
1104     port        - I/O port # for MTPAV (0x378,0x278, default=0x378)
1105     irq         - IRQ # for MTPAV (7,5, default=7)
1106     hwports     - number of supported hardware ports, default=8.
1107     
1108     Module supports only 1 card.  This module has no enable option.
1109
1110   Module snd-nm256
1111   ----------------
1112
1113     Module for NeoMagic NM256AV/ZX chips
1114
1115     playback_bufsize - max playback frame size in kB (4-128kB)
1116     capture_bufsize  - max capture frame size in kB (4-128kB)
1117     force_ac97       - 0 or 1 (disabled by default)
1118     buffer_top       - specify buffer top address
1119     use_cache        - 0 or 1 (disabled by default)
1120     vaio_hack        - alias buffer_top=0x25a800
1121     reset_workaround - enable AC97 RESET workaround for some laptops
1122     reset_workaround2 - enable extended AC97 RESET workaround for some
1123                       other laptops
1124
1125     This module supports one chip and autoprobe.
1126
1127     The power-management is supported.
1128
1129     Note: on some notebooks the buffer address cannot be detected
1130     automatically, or causes hang-up during initialization.
1131     In such a case, specify the buffer top address explicity via
1132     buffer_top option.
1133     For example,
1134       Sony F250: buffer_top=0x25a800
1135       Sony F270: buffer_top=0x272800
1136     The driver supports only ac97 codec.  It's possible to force
1137     to initialize/use ac97 although it's not detected.  In such a
1138     case, use force_ac97=1 option - but *NO* guarantee whether it
1139     works!
1140
1141     Note: The NM256 chip can be linked internally with non-AC97
1142     codecs.  This driver supports only the AC97 codec, and won't work
1143     with machines with other (most likely CS423x or OPL3SAx) chips,
1144     even though the device is detected in lspci.  In such a case, try
1145     other drivers, e.g. snd-cs4232 or snd-opl3sa2.  Some has ISA-PnP
1146     but some doesn't have ISA PnP.  You'll need to specify isapnp=0
1147     and proper hardware parameters in the case without ISA PnP.
1148
1149     Note: some laptops need a workaround for AC97 RESET.  For the
1150     known hardware like Dell Latitude LS and Sony PCG-F305, this
1151     workaround is enabled automatically.  For other laptops with a
1152     hard freeze, you can try reset_workaround=1 option.
1153
1154     Note: Dell Latitude CSx laptops have another problem regarding
1155     AC97 RESET.  On these laptops, reset_workaround2 option is
1156     turned on as default.  This option is worth to try if the
1157     previous reset_workaround option doesn't help.
1158
1159     Note: This driver is really crappy.  It's a porting from the
1160     OSS driver, which is a result of black-magic reverse engineering.
1161     The detection of codec will fail if the driver is loaded *after*
1162     X-server as described above.  You might be able to force to load
1163     the module, but it may result in hang-up.   Hence, make sure that
1164     you load this module *before* X if you encounter this kind of
1165     problem.
1166
1167   Module snd-opl3sa2
1168   ------------------
1169
1170     Module for Yamaha OPL3-SA2/SA3 sound cards.
1171
1172     port        - control port # for OPL3-SA chip (0x370)
1173     sb_port     - SB port # for OPL3-SA chip (0x220,0x240)
1174     wss_port    - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1175     midi_port   - port # for MPU-401 UART (0x300,0x330), -1 = disable
1176     fm_port     - FM port # for OPL3-SA chip (0x388), -1 = disable
1177     irq         - IRQ # for OPL3-SA chip (5,7,9,10)
1178     dma1        - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1179     dma2        - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
1180     isapnp      - ISA PnP detection - 0 = disable, 1 = enable (default)
1181     
1182     This module supports multiple cards and ISA PnP.  It does not support
1183     autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1184     
1185     The power-management is supported.
1186
1187   Module snd-opti92x-ad1848
1188   -------------------------
1189
1190     Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1191     Module works with OAK Mozart cards as well.
1192     
1193     port      - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1194     mpu_port  - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1195     fm_port   - port # for OPL3 device (0x388)
1196     irq       - IRQ # for WSS chip (5,7,9,10,11)
1197     mpu_irq   - IRQ # for MPU-401 UART (5,7,9,10)
1198     dma1      - first DMA # for WSS chip (0,1,3)
1199
1200     This module supports only one card, autoprobe and PnP.
1201
1202   Module snd-opti92x-cs4231
1203   -------------------------
1204
1205     Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1206     
1207     port      - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1208     mpu_port  - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1209     fm_port   - port # for OPL3 device (0x388)
1210     irq       - IRQ # for WSS chip (5,7,9,10,11)
1211     mpu_irq   - IRQ # for MPU-401 UART (5,7,9,10)
1212     dma1      - first DMA # for WSS chip (0,1,3)
1213     dma2      - second DMA # for WSS chip (0,1,3)
1214
1215     This module supports only one card, autoprobe and PnP.
1216
1217   Module snd-opti93x
1218   ------------------
1219
1220     Module for sound cards based on OPTi 82c93x chips.
1221     
1222     port      - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1223     mpu_port  - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1224     fm_port   - port # for OPL3 device (0x388)
1225     irq       - IRQ # for WSS chip (5,7,9,10,11)
1226     mpu_irq   - IRQ # for MPU-401 UART (5,7,9,10)
1227     dma1      - first DMA # for WSS chip (0,1,3)
1228     dma2      - second DMA # for WSS chip (0,1,3)
1229
1230     This module supports only one card, autoprobe and PnP.
1231
1232   Module snd-pcxhr
1233   ----------------
1234
1235     Module for Digigram PCXHR boards
1236
1237     This module supports multiple cards.
1238
1239   Module snd-powermac (on ppc only)
1240   ---------------------------------
1241
1242     Module for PowerMac, iMac and iBook on-board soundchips
1243
1244     enable_beep     - enable beep using PCM (enabled as default)
1245
1246     Module supports autoprobe a chip.
1247
1248     Note: the driver may have problems regarding endianess.
1249
1250     The power-management is supported.
1251
1252   Module snd-pxa2xx-ac97 (on arm only)
1253   ------------------------------------
1254
1255     Module for AC97 driver for the Intel PXA2xx chip
1256
1257     For ARM architecture only.
1258
1259     The power-management is supported.
1260
1261   Module snd-riptide
1262   ------------------
1263
1264     Module for Conexant Riptide chip
1265
1266       joystick_port     - Joystick port # (default: 0x200)
1267       mpu_port          - MPU401 port # (default: 0x330)
1268       opl3_port         - OPL3 port # (default: 0x388)
1269
1270     This module supports multiple cards.
1271     The driver requires the firmware loader support on kernel.
1272     You need to install the firmware file "riptide.hex" to the standard
1273     firmware path (e.g. /lib/firmware).
1274
1275   Module snd-rme32
1276   ----------------
1277
1278     Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32, 
1279     Prodif96 and Prodif Gold) sound cards.
1280
1281     This module supports multiple cards.
1282
1283   Module snd-rme96
1284   ----------------
1285
1286     Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1287
1288     This module supports multiple cards.
1289
1290   Module snd-rme9652
1291   ------------------
1292
1293     Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1294
1295     precise_ptr - Enable precise pointer (doesn't work reliably).
1296                   (default = 0)
1297
1298     This module supports multiple cards.
1299
1300     Note: snd-page-alloc module does the job which snd-hammerfall-mem
1301           module did formerly.  It will allocate the buffers in advance
1302           when any RME9652 cards are found.  To make the buffer
1303           allocation sure, load snd-page-alloc module in the early
1304           stage of boot sequence.  See "Early Buffer Allocation"
1305           section.
1306
1307   Module snd-sa11xx-uda1341 (on arm only)
1308   ---------------------------------------
1309
1310     Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1311
1312     Module supports only one card.
1313     Module has no enable and index options.
1314
1315     The power-management is supported.
1316
1317   Module snd-sb8
1318   --------------
1319
1320     Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1321                                          SoundBlaster 2.0,
1322                                          SoundBlaster Pro
1323
1324     port        - port # for SB DSP chip (0x220,0x240,0x260)
1325     irq         - IRQ # for SB DSP chip (5,7,9,10)
1326     dma8        - DMA # for SB DSP chip (1,3)
1327
1328     This module supports multiple cards and autoprobe.
1329     
1330     The power-management is supported.
1331
1332   Module snd-sb16 and snd-sbawe
1333   -----------------------------
1334
1335     Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1336                                           SoundBlaster AWE 32 (PnP),
1337                                           SoundBlaster AWE 64 PnP
1338
1339     port        - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1340     mpu_port    - port # for MPU-401 UART (0x300,0x330), -1 = disable
1341     awe_port    - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1342                    (snd-sbawe module only)
1343     irq         - IRQ # for SB DSP 4.x chip (5,7,9,10)
1344     dma8        - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1345     dma16       - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
1346     mic_agc     - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1347     csp         - ASP/CSP chip support - 0 = disable (default), 1 = enable
1348     isapnp      - ISA PnP detection - 0 = disable, 1 = enable (default)
1349     
1350     This module supports multiple cards, autoprobe and ISA PnP.
1351
1352     Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1353           disable 16bit DMA with dma16 = -1 module parameter.
1354           Also, all Sound Blaster 16 type cards can operate in 16-bit
1355           half duplex mode through 8-bit DMA channel by disabling their
1356           16-bit DMA channel.
1357     
1358     The power-management is supported.
1359
1360   Module snd-sgalaxy
1361   ------------------
1362
1363     Module for Aztech Sound Galaxy sound card.
1364
1365     sbport      - Port # for SB16 interface (0x220,0x240)
1366     wssport     - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1367     irq         - IRQ # (7,9,10,11)
1368     dma1        - DMA #
1369
1370     This module supports multiple cards.
1371
1372     The power-management is supported.
1373
1374   Module snd-sscape
1375   -----------------
1376
1377     Module for ENSONIQ SoundScape PnP cards.
1378
1379     port        - Port # (PnP setup)
1380     irq         - IRQ # (PnP setup)
1381     mpu_irq     - MPU-401 IRQ # (PnP setup)
1382     dma         - DMA # (PnP setup)
1383
1384     This module supports multiple cards.  ISA PnP must be enabled.
1385     You need sscape_ctl tool in alsa-tools package for loading
1386     the microcode.
1387
1388   Module snd-sun-amd7930 (on sparc only)
1389   --------------------------------------
1390
1391     Module for AMD7930 sound chips found on Sparcs.
1392
1393     This module supports multiple cards.
1394
1395   Module snd-sun-cs4231 (on sparc only)
1396   -------------------------------------
1397
1398     Module for CS4231 sound chips found on Sparcs.
1399
1400     This module supports multiple cards.
1401
1402   Module snd-sun-dbri (on sparc only)
1403   -----------------------------------
1404
1405     Module for DBRI sound chips found on Sparcs.
1406
1407     This module supports multiple cards.
1408
1409   Module snd-wavefront
1410   --------------------
1411
1412     Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1413
1414     cs4232_pcm_port - Port # for CS4232 PCM interface.
1415     cs4232_pcm_irq  - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1416     cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1417     cs4232_mpu_irq  - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
1418     use_cs4232_midi - Use CS4232 MPU-401 interface
1419                       (inaccessibly located inside your computer)
1420     ics2115_port    - Port # for ICS2115
1421     ics2115_irq     - IRQ # for ICS2115
1422     fm_port         - FM OPL-3 Port #
1423     dma1            - DMA1 # for CS4232 PCM interface.
1424     dma2            - DMA2 # for CS4232 PCM interface.
1425     isapnp          - ISA PnP detection - 0 = disable, 1 = enable (default)
1426
1427     This module supports multiple cards and ISA PnP.
1428
1429   Module snd-sonicvibes
1430   ---------------------
1431
1432     Module for S3 SonicVibes PCI sound cards.
1433                         * PINE Schubert 32 PCI
1434
1435     reverb    - Reverb Enable - 1 = enable, 0 = disable (default)
1436                   - SoundCard must have onboard SRAM for this.
1437     mge       - Mic Gain Enable - 1 = enable, 0 = disable (default)
1438     
1439     This module supports multiple cards and autoprobe.
1440
1441   Module snd-serial-u16550
1442   ------------------------
1443
1444     Module for UART16550A serial MIDI ports.
1445
1446     port        - port # for UART16550A chip
1447     irq         - IRQ # for UART16550A chip, -1 = poll mode
1448     speed       - speed in bauds (9600,19200,38400,57600,115200)
1449                   38400 = default
1450     base        - base for divisor in bauds (57600,115200,230400,460800)
1451                   115200 = default
1452     outs        - number of MIDI ports in a serial port (1-4)
1453                   1 = default
1454     adaptor     - Type of adaptor.
1455                   0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1456                   3 = MS-124W M/B, 4 = Generic
1457     
1458     This module supports multiple cards. This module does not support autoprobe
1459     thus the main port must be specified!!! Other options are optional.
1460
1461   Module snd-trident
1462   ------------------
1463
1464     Module for Trident 4DWave DX/NX sound cards.
1465                         * Best Union  Miss Melody 4DWave PCI
1466                         * HIS  4DWave PCI
1467                         * Warpspeed  ONSpeed 4DWave PCI
1468                         * AzTech  PCI 64-Q3D
1469                         * Addonics  SV 750
1470                         * CHIC  True Sound 4Dwave
1471                         * Shark  Predator4D-PCI
1472                         * Jaton  SonicWave 4D
1473
1474     pcm_channels   - max channels (voices) reserved for PCM
1475     wavetable_size - max wavetable size in kB (4-?kb)
1476
1477     This module supports multiple cards and autoprobe.
1478
1479     The power-management is supported.
1480
1481   Module snd-usb-audio
1482   --------------------
1483
1484     Module for USB audio and USB MIDI devices.
1485
1486     vid             - Vendor ID for the device (optional)
1487     pid             - Product ID for the device (optional)
1488     device_setup    - Device specific magic number (optional)
1489                     - Influence depends on the device
1490                     - Default: 0x0000 
1491
1492     This module supports multiple devices, autoprobe and hotplugging.
1493
1494   Module snd-usb-usx2y
1495   --------------------
1496
1497     Module for Tascam USB US-122, US-224 and US-428 devices.
1498
1499     This module supports multiple devices, autoprobe and hotplugging.
1500
1501     Note: you need to load the firmware via usx2yloader utility included
1502           in alsa-tools and alsa-firmware packages.
1503
1504   Module snd-via82xx
1505   ------------------
1506
1507     Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
1508     8233A, 8233C, 8235, 8237 (south) bridge.
1509
1510     mpu_port    - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1511                   [VIA686A/686B only]
1512     joystick    - Enable joystick (default off) [VIA686A/686B only]
1513     ac97_clock  - AC'97 codec clock base (default 48000Hz)
1514     dxs_support - support DXS channels,
1515                   0 = auto (default), 1 = enable, 2 = disable,
1516                   3 = 48k only, 4 = no VRA, 5 = enable any sample
1517                   rate and different sample rates on different
1518                   channels
1519                   [VIA8233/C, 8235, 8237 only]
1520     ac97_quirk  - AC'97 workaround for strange hardware
1521                   See "AC97 Quirk Option" section below.
1522
1523     This module supports one chip and autoprobe.
1524
1525     Note: on some SMP motherboards like MSI 694D the interrupts might
1526           not be generated properly.  In such a case, please try to
1527           set the SMP (or MPS) version on BIOS to 1.1 instead of
1528           default value 1.4.  Then the interrupt number will be
1529           assigned under 15. You might also upgrade your BIOS.
1530     
1531     Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
1532           channels as the first PCM.  On these channels, up to 4
1533           streams can be played at the same time, and the controller
1534           can perform sample rate conversion with separate rates for
1535           each channel.
1536           As default (dxs_support = 0), 48k fixed rate is chosen
1537           except for the known devices since the output is often
1538           noisy except for 48k on some mother boards due to the
1539           bug of BIOS.
1540           Please try once dxs_support=5 and if it works on other
1541           sample rates (e.g. 44.1kHz of mp3 playback), please let us
1542           know the PCI subsystem vendor/device id's (output of
1543           "lspci -nv").
1544           If dxs_support=5 does not work, try dxs_support=4; if it
1545           doesn't work too, try dxs_support=1.  (dxs_support=1 is
1546           usually for old motherboards.  The correct implemented
1547           board should work with 4 or 5.)  If it still doesn't
1548           work and the default setting is ok, dxs_support=3 is the
1549           right choice.  If the default setting doesn't work at all,
1550           try dxs_support=2 to disable the DXS channels.
1551           In any cases, please let us know the result and the
1552           subsystem vendor/device ids.  See "Links and Addresses"
1553           below.
1554
1555     Note: for the MPU401 on VIA823x, use snd-mpu401 driver
1556           additionally.  The mpu_port option is for VIA686 chips only.
1557
1558     The power-management is supported.
1559
1560   Module snd-via82xx-modem
1561   ------------------------
1562
1563     Module for VIA82xx AC97 modem
1564
1565     ac97_clock  - AC'97 codec clock base (default 48000Hz)
1566
1567     This module supports one card and autoprobe.
1568
1569     Note: The default index value of this module is -2, i.e. the first
1570           slot is excluded.
1571
1572     The power-management is supported.
1573
1574   Module snd-virmidi
1575   ------------------
1576
1577     Module for virtual rawmidi devices.
1578     This module creates virtual rawmidi devices which communicate
1579     to the corresponding ALSA sequencer ports.
1580
1581     midi_devs   - MIDI devices # (1-4, default=4)
1582     
1583     This module supports multiple cards.
1584
1585   Module snd-vx222
1586   ----------------
1587
1588     Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1589
1590     mic         - Enable Microphone on V222 Mic (NYI)
1591     ibl         - Capture IBL size. (default = 0, minimum size)
1592
1593     This module supports multiple cards.
1594
1595     When the driver is compiled as a module and the hotplug firmware
1596     is supported, the firmware data is loaded via hotplug automatically.
1597     Install the necessary firmware files in alsa-firmware package.
1598     When no hotplug fw loader is available, you need to load the
1599     firmware via vxloader utility in alsa-tools package.  To invoke
1600     vxloader automatically, add the following to /etc/modprobe.conf
1601
1602         install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1603
1604     (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1605      /etc/modules.conf, instead.)
1606     IBL size defines the interrupts period for PCM.  The smaller size
1607     gives smaller latency but leads to more CPU consumption, too.
1608     The size is usually aligned to 126.  As default (=0), the smallest
1609     size is chosen.  The possible IBL values can be found in
1610     /proc/asound/cardX/vx-status proc file.
1611
1612     The power-management is supported.
1613
1614   Module snd-vxpocket
1615   -------------------
1616
1617     Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
1618
1619     ibl      - Capture IBL size. (default = 0, minimum size)
1620
1621     This module supports multiple cards.  The module is compiled only when
1622     PCMCIA is supported on kernel.
1623
1624     With the older 2.6.x kernel, to activate the driver via the card
1625     manager, you'll need to set up /etc/pcmcia/vxpocket.conf.  See the
1626     sound/pcmcia/vx/vxpocket.c.  2.6.13 or later kernel requires no
1627     longer require a config file.
1628
1629     When the driver is compiled as a module and the hotplug firmware
1630     is supported, the firmware data is loaded via hotplug automatically.
1631     Install the necessary firmware files in alsa-firmware package.
1632     When no hotplug fw loader is available, you need to load the
1633     firmware via vxloader utility in alsa-tools package.
1634
1635     About capture IBL, see the description of snd-vx222 module.
1636
1637     Note: the driver is build only when CONFIG_ISA is set.
1638     
1639     Note2: snd-vxp440 driver is merged to snd-vxpocket driver since
1640            ALSA 1.0.10.
1641
1642     The power-management is supported.
1643
1644   Module snd-ymfpci
1645   -----------------
1646
1647     Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1648
1649     mpu_port      - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1650                     1 (auto-detect for YMF744/754 only)
1651     fm_port       - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1652                     1 (auto-detect for YMF744/754 only)
1653     joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1654                     1 (auto-detect)
1655     rear_switch   - enable shared rear/line-in switch (bool)
1656
1657     This module supports autoprobe and multiple chips.
1658
1659     The power-management is supported.
1660
1661   Module snd-pdaudiocf
1662   --------------------
1663
1664     Module for Sound Core PDAudioCF sound card.
1665
1666     Note: the driver is build only when CONFIG_ISA is set.
1667
1668     The power-management is supported.
1669
1670
1671 AC97 Quirk Option
1672 =================
1673
1674 The ac97_quirk option is used to enable/override the workaround for
1675 specific devices on drivers for on-board AC'97 controllers like
1676 snd-intel8x0.  Some hardware have swapped output pins between Master
1677 and Headphone, or Surround (thanks to confusion of AC'97
1678 specifications from version to version :-)
1679
1680 The driver provides the auto-detection of known problematic devices,
1681 but some might be unknown or wrongly detected.  In such a case, pass
1682 the proper value with this option.
1683
1684 The following strings are accepted:
1685     - default   Don't override the default setting
1686     - none      Disable the quirk
1687     - hp_only   Bind Master and Headphone controls as a single control
1688     - swap_hp   Swap headphone and master controls
1689     - swap_surround  Swap master and surround controls
1690     - ad_sharing  For AD1985, turn on OMS bit and use headphone
1691     - alc_jack  For ALC65x, turn on the jack sense mode
1692     - inv_eapd  Inverted EAPD implementation
1693     - mute_led  Bind EAPD bit for turning on/off mute LED
1694
1695 For backward compatibility, the corresponding integer value -1, 0,
1696 ... are  accepted, too.
1697
1698 For example, if "Master" volume control has no effect on your device
1699 but only "Headphone" does, pass ac97_quirk=hp_only module option.
1700
1701
1702 Configuring Non-ISAPNP Cards
1703 ============================
1704
1705 When the kernel is configured with ISA-PnP support, the modules
1706 supporting the isapnp cards will have module options "isapnp".
1707 If this option is set, *only* the ISA-PnP devices will be probed.
1708 For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
1709 together with the proper i/o and irq configuration.
1710
1711 When the kernel is configured without ISA-PnP support, isapnp option
1712 will be not built in.
1713
1714
1715 Module Autoloading Support
1716 ==========================
1717
1718 The ALSA drivers can be loaded automatically on demand by defining
1719 module aliases.  The string 'snd-card-%1' is requested for ALSA native
1720 devices where %i is sound card number from zero to seven.
1721
1722 To auto-load an ALSA driver for OSS services, define the string
1723 'sound-slot-%i' where %i means the slot number for OSS, which
1724 corresponds to the card index of ALSA.  Usually, define this
1725 as the same card module.
1726
1727 An example configuration for a single emu10k1 card is like below:
1728 ----- /etc/modprobe.conf
1729 alias snd-card-0 snd-emu10k1
1730 alias sound-slot-0 snd-emu10k1
1731 ----- /etc/modprobe.conf
1732
1733 The available number of auto-loaded sound cards depends on the module
1734 option "cards_limit" of snd module.  As default it's set to 1.
1735 To enable the auto-loading of multiple cards, specify the number of
1736 sound cards in that option.
1737
1738 When multiple cards are available, it'd better to specify the index
1739 number for each card via module option, too, so that the order of
1740 cards is kept consistent.
1741
1742 An example configuration for two sound cards is like below:
1743
1744 ----- /etc/modprobe.conf
1745 # ALSA portion
1746 options snd cards_limit=2
1747 alias snd-card-0 snd-interwave
1748 alias snd-card-1 snd-ens1371
1749 options snd-interwave index=0
1750 options snd-ens1371 index=1
1751 # OSS/Free portion
1752 alias sound-slot-0 snd-interwave
1753 alias sound-slot-1 snd-ens1371
1754 ----- /etc/moprobe.conf
1755
1756 In this example, the interwave card is always loaded as the first card
1757 (index 0) and ens1371 as the second (index 1).
1758
1759
1760 ALSA PCM devices to OSS devices mapping
1761 =======================================
1762
1763 /dev/snd/pcmC0D0[c|p]  -> /dev/audio0 (/dev/audio) -> minor 4
1764 /dev/snd/pcmC0D0[c|p]  -> /dev/dsp0 (/dev/dsp)     -> minor 3
1765 /dev/snd/pcmC0D1[c|p]  -> /dev/adsp0 (/dev/adsp)   -> minor 12
1766 /dev/snd/pcmC1D0[c|p]  -> /dev/audio1              -> minor 4+16 = 20
1767 /dev/snd/pcmC1D0[c|p]  -> /dev/dsp1                -> minor 3+16 = 19
1768 /dev/snd/pcmC1D1[c|p]  -> /dev/adsp1               -> minor 12+16 = 28
1769 /dev/snd/pcmC2D0[c|p]  -> /dev/audio2              -> minor 4+32 = 36
1770 /dev/snd/pcmC2D0[c|p]  -> /dev/dsp2                -> minor 3+32 = 39
1771 /dev/snd/pcmC2D1[c|p]  -> /dev/adsp2               -> minor 12+32 = 44
1772
1773 The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
1774 sound card number and second means device number.  The ALSA devices
1775 have either 'c' or 'p' suffix indicating the direction, capture and
1776 playback, respectively.
1777
1778 Please note that the device mapping above may be varied via the module
1779 options of snd-pcm-oss module.
1780
1781
1782 DEVFS support
1783 =============
1784
1785 The ALSA driver fully supports the devfs extension.
1786 You should add lines below to your devfsd.conf file:
1787
1788 LOOKUP snd MODLOAD ACTION snd
1789 REGISTER ^sound/.* PERMISSIONS root.audio 660
1790 REGISTER ^snd/.* PERMISSIONS root.audio 660
1791
1792 Warning: These lines assume that you have the audio group in your system.
1793          Otherwise replace audio word with another group name (root for
1794          example).
1795
1796
1797 Proc interfaces (/proc/asound)
1798 ==============================
1799
1800 /proc/asound/card#/pcm#[cp]/oss
1801 -------------------------------
1802   String "erase" - erase all additional informations about OSS applications
1803   String "<app_name> <fragments> <fragment_size> [<options>]"
1804
1805    <app_name> - name of application with (higher priority) or without path
1806    <fragments> - number of fragments or zero if auto
1807    <fragment_size> - size of fragment in bytes or zero if auto
1808    <options> - optional parameters
1809           - disable   the application tries to open a pcm device for
1810                       this channel but does not want to use it.
1811                       (Cause a bug or mmap needs)
1812                       It's good for Quake etc...
1813           - direct    don't use plugins
1814           - block     force block mode (rvplayer)
1815           - non-block force non-block mode
1816           - whole-frag  write only whole fragments (optimization affecting
1817                         playback only)
1818           - no-silence  do not fill silence ahead to avoid clicks
1819           - buggy-ptr   Returns the whitespace blocks in GETOPTR ioctl
1820                         instead of filled blocks
1821
1822   Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
1823            echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
1824            echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
1825
1826
1827 Early Buffer Allocation
1828 =======================
1829
1830 Some drivers (e.g. hdsp) require the large contiguous buffers, and
1831 sometimes it's too late to find such spaces when the driver module is
1832 actually loaded due to memory fragmentation.  You can pre-allocate the
1833 PCM buffers by loading snd-page-alloc module and write commands to its
1834 proc file in prior, for example, in the early boot stage like
1835 /etc/init.d/*.local scripts.
1836
1837 Reading the proc file /proc/drivers/snd-page-alloc shows the current
1838 usage of page allocation.  In writing, you can send the following
1839 commands to the snd-page-alloc driver:
1840
1841   - add VENDOR DEVICE MASK SIZE BUFFERS
1842
1843     VENDOR and DEVICE are PCI vendor and device IDs.  They take
1844     integer numbers (0x prefix is needed for the hex).
1845     MASK is the PCI DMA mask.  Pass 0 if not restricted.
1846     SIZE is the size of each buffer to allocate.  You can pass
1847     k and m suffix for KB and MB.  The max number is 16MB.
1848     BUFFERS is the number of buffers to allocate.  It must be greater
1849     than 0.  The max number is 4.
1850
1851   - erase
1852
1853     This will erase the all pre-allocated buffers which are not in
1854     use.
1855
1856
1857 Links and Addresses
1858 ===================
1859
1860   ALSA project homepage
1861        http://www.alsa-project.org
1862
1863   ALSA Bug Tracking System
1864        https://bugtrack.alsa-project.org/bugs/
1865
1866   ALSA Developers ML
1867        mailto:alsa-devel@lists.sourceforge.net