1==============================================================
2Advanced Linux Sound Architecture - Driver Configuration guide
3==============================================================
4
5
6Kernel Configuration
7====================
8
9To enable ALSA support you need at least to build the kernel with
10primary sound card support (``CONFIG_SOUND``).  Since ALSA can emulate
11OSS, you don't have to choose any of the OSS modules.
12
13Enable "OSS API emulation" (``CONFIG_SND_OSSEMUL``) and both OSS mixer
14and PCM supports if you want to run OSS applications with ALSA.
15
16If you want to support the WaveTable functionality on cards such as
17SB Live! then you need to enable "Sequencer support"
18(``CONFIG_SND_SEQUENCER``).
19
20To make ALSA debug messages more verbose, enable the "Verbose printk"
21and "Debug" options.  To check for memory leaks, turn on "Debug memory"
22too.  "Debug detection" will add checks for the detection of cards.
23
24Please note that all the ALSA ISA drivers support the Linux isapnp API
25(if the card supports ISA PnP).  You don't need to configure the cards
26using isapnptools.
27
28
29Module parameters
30=================
31
32The user can load modules with options. If the module supports more than
33one card and you have more than one card of the same type then you can
34specify multiple values for the option separated by commas.
35
36
37Module snd
38----------
39
40The core ALSA module.  It is used by all ALSA card drivers.
41It takes the following options which have global effects.
42
43major
44    major number for sound driver;
45    Default: 116
46cards_limit
47    limiting card index for auto-loading (1-8);
48    Default: 1;
49    For auto-loading more than one card, specify this option
50    together with snd-card-X aliases.
51slots
52    Reserve the slot index for the given driver;
53    This option takes multiple strings.
54    See `Module Autoloading Support`_ section for details.
55debug
56    Specifies the debug message level;
57    (0 = disable debug prints, 1 = normal debug messages,
58    2 = verbose debug messages);
59    This option appears only when ``CONFIG_SND_DEBUG=y``.
60    This option can be dynamically changed via sysfs
61    /sys/modules/snd/parameters/debug file.
62
63Module snd-pcm-oss
64------------------
65
66The PCM OSS emulation module.
67This module takes options which change the mapping of devices.
68
69dsp_map
70    PCM device number maps assigned to the 1st OSS device;
71    Default: 0
72adsp_map
73    PCM device number maps assigned to the 2st OSS device;
74    Default: 1
75nonblock_open
76    Don't block opening busy PCM devices;
77    Default: 1
78
79For example, when ``dsp_map=2``, /dev/dsp will be mapped to PCM #2 of
80the card #0.  Similarly, when ``adsp_map=0``, /dev/adsp will be mapped
81to PCM #0 of the card #0.
82For changing the second or later card, specify the option with
83commas, such like ``dsp_map=0,1``.
84
85``nonblock_open`` option is used to change the behavior of the PCM
86regarding opening the device.  When this option is non-zero,
87opening a busy OSS PCM device won't be blocked but return
88immediately with EAGAIN (just like O_NONBLOCK flag).
89
90Module snd-rawmidi
91------------------
92
93This module takes options which change the mapping of devices.
94similar to those of the snd-pcm-oss module.
95
96midi_map
97    MIDI device number maps assigned to the 1st OSS device;
98    Default: 0
99amidi_map
100    MIDI device number maps assigned to the 2st OSS device;
101    Default: 1
102
103Common parameters for top sound card modules
104--------------------------------------------
105
106Each of top level sound card module takes the following options.
107
108index
109    index (slot #) of sound card;
110    Values: 0 through 31 or negative;
111    If nonnegative, assign that index number;
112    if negative, interpret as a bitmask of permissible indices;
113    the first free permitted index is assigned;
114    Default: -1
115id
116    card ID (identifier or name);
117    Can be up to 15 characters long;
118    Default: the card type;
119    A directory by this name is created under /proc/asound/
120    containing information about the card;
121    This ID can be used instead of the index number in
122    identifying the card
123enable
124    enable card;
125    Default: enabled, for PCI and ISA PnP cards
126
127Module snd-adlib
128----------------
129
130Module for AdLib FM cards.
131
132port
133    port # for OPL chip
134
135This module supports multiple cards. It does not support autoprobe, so
136the port must be specified. For actual AdLib FM cards it will be 0x388.
137Note that this card does not have PCM support and no mixer; only FM
138synthesis.
139
140Make sure you have ``sbiload`` from the alsa-tools package available and,
141after loading the module, find out the assigned ALSA sequencer port
142number through ``sbiload -l``.
143
144Example output:
145::
146
147      Port     Client name                       Port name
148      64:0     OPL2 FM synth                     OPL2 FM Port
149
150Load the ``std.sb`` and ``drums.sb`` patches also supplied by ``sbiload``:
151::
152
153      sbiload -p 64:0 std.sb drums.sb
154
155If you use this driver to drive an OPL3, you can use ``std.o3`` and ``drums.o3``
156instead. To have the card produce sound, use ``aplaymidi`` from alsa-utils:
157::
158
159      aplaymidi -p 64:0 foo.mid
160
161Module snd-ad1816a
162------------------
163
164Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips.
165
166clockfreq
167    Clock frequency for AD1816A chip (default = 0, 33000Hz)
168
169This module supports multiple cards, autoprobe and PnP.
170
171Module snd-ad1848
172-----------------
173
174Module for sound cards based on AD1848/AD1847/CS4248 ISA chips.
175
176port
177    port # for AD1848 chip
178irq
179    IRQ # for AD1848  chip
180dma1
181    DMA # for AD1848 chip (0,1,3)
182
183This module supports multiple cards.  It does not support autoprobe
184thus main port must be specified!!! Other ports are optional.
185
186The power-management is supported.
187
188Module snd-ad1889
189-----------------
190
191Module for Analog Devices AD1889 chips.
192
193ac97_quirk
194    AC'97 workaround for strange hardware;
195    See the description of intel8x0 module for details.
196
197This module supports multiple cards.
198
199Module snd-ali5451
200------------------
201
202Module for ALi M5451 PCI chip.
203
204pcm_channels
205    Number of hardware channels assigned for PCM
206spdif
207    Support SPDIF I/O;
208    Default: disabled
209
210This module supports one chip and autoprobe.
211
212The power-management is supported.
213
214Module snd-als100
215-----------------
216
217Module for sound cards based on Avance Logic ALS100/ALS120 ISA chips.
218
219This module supports multiple cards, autoprobe and PnP.
220
221The power-management is supported.
222
223Module snd-als300
224-----------------
225
226Module for Avance Logic ALS300 and ALS300+
227
228This module supports multiple cards.
229
230The power-management is supported.
231
232Module snd-als4000
233------------------
234
235Module for sound cards based on Avance Logic ALS4000 PCI chip.
236
237joystick_port
238    port # for legacy joystick support;
239    0 = disabled (default), 1 = auto-detect
240
241This module supports multiple cards, autoprobe and PnP.
242
243The power-management is supported.
244
245Module snd-asihpi
246-----------------
247
248Module for AudioScience ASI soundcards
249
250enable_hpi_hwdep
251    enable HPI hwdep for AudioScience soundcard
252
253This module supports multiple cards.
254The driver requires the firmware loader support on kernel.
255
256Module snd-atiixp
257-----------------
258
259Module for ATI IXP 150/200/250/400 AC97 controllers.
260
261ac97_clock
262    AC'97 clock (default = 48000)
263ac97_quirk
264    AC'97 workaround for strange hardware;
265    See `AC97 Quirk Option`_ section below.
266ac97_codec
267    Workaround to specify which AC'97 codec instead of probing.
268    If this works for you file a bug with your `lspci -vn` output.
269    (-2 = Force probing, -1 = Default behavior, 0-2 = Use the
270    specified codec.)
271spdif_aclink
272    S/PDIF transfer over AC-link (default = 1)
273
274This module supports one card and autoprobe.
275
276ATI IXP has two different methods to control SPDIF output.  One is
277over AC-link and another is over the "direct" SPDIF output.  The
278implementation depends on the motherboard, and you'll need to
279choose the correct one via spdif_aclink module option.
280
281The power-management is supported.
282
283Module snd-atiixp-modem
284-----------------------
285
286Module for ATI IXP 150/200/250 AC97 modem controllers.
287
288This module supports one card and autoprobe.
289
290Note: The default index value of this module is -2, i.e. the first
291slot is excluded.
292
293The power-management is supported.
294
295Module snd-au8810, snd-au8820, snd-au8830
296-----------------------------------------
297
298Module for Aureal Vortex, Vortex2 and Advantage device.
299
300pcifix
301    Control PCI workarounds;
302    0 = Disable all workarounds,
303    1 = Force the PCI latency of the Aureal card to 0xff,
304    2 = Force the Extend PCI#2 Internal Master for Efficient
305    Handling of Dummy Requests on the VIA KT133 AGP Bridge,
306    3 = Force both settings,
307    255 = Autodetect what is required (default)
308
309This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
310EQ, mpu401, gameport. A3D and wavetable support are still in development.
311Development and reverse engineering work is being coordinated at
312http://savannah.nongnu.org/projects/openvortex/
313SPDIF output has a copy of the AC97 codec output, unless you use the
314``spdif`` pcm device, which allows raw data passthru.
315The hardware EQ hardware and SPDIF is only present in the Vortex2 and
316Advantage.
317
318Note: Some ALSA mixer applications don't handle the SPDIF sample rate
319control correctly. If you have problems regarding this, try
320another ALSA compliant mixer (alsamixer works).
321
322Module snd-azt1605
323------------------
324
325Module for Aztech Sound Galaxy soundcards based on the Aztech AZT1605
326chipset.
327
328port
329    port # for BASE (0x220,0x240,0x260,0x280)
330wss_port
331    port # for WSS (0x530,0x604,0xe80,0xf40)
332irq
333    IRQ # for WSS (7,9,10,11)
334dma1
335    DMA # for WSS playback (0,1,3)
336dma2
337    DMA # for WSS capture (0,1), -1 = disabled (default)
338mpu_port
339    port # for MPU-401 UART (0x300,0x330), -1 = disabled (default)
340mpu_irq
341    IRQ # for MPU-401 UART (3,5,7,9), -1 = disabled (default)
342fm_port
343    port # for OPL3 (0x388), -1 = disabled (default)
344
345This module supports multiple cards. It does not support autoprobe:
346``port``, ``wss_port``, ``irq`` and ``dma1`` have to be specified.
347The other values are optional.
348
349``port`` needs to match the BASE ADDRESS jumper on the card (0x220 or 0x240)
350or the value stored in the card's EEPROM for cards that have an EEPROM and
351their "CONFIG MODE" jumper set to "EEPROM SETTING". The other values can
352be chosen freely from the options enumerated above.
353
354If ``dma2`` is specified and different from ``dma1``, the card will operate in
355full-duplex mode. When ``dma1=3``, only ``dma2=0`` is valid and the only way to
356enable capture since only channels 0 and 1 are available for capture.
357
358Generic settings are ``port=0x220 wss_port=0x530 irq=10 dma1=1 dma2=0
359mpu_port=0x330 mpu_irq=9 fm_port=0x388``.
360
361Whatever IRQ and DMA channels you pick, be sure to reserve them for
362legacy ISA in your BIOS.
363
364Module snd-azt2316
365------------------
366
367Module for Aztech Sound Galaxy soundcards based on the Aztech AZT2316
368chipset.
369
370port
371    port # for BASE (0x220,0x240,0x260,0x280)
372wss_port
373    port # for WSS (0x530,0x604,0xe80,0xf40)
374irq
375    IRQ # for WSS (7,9,10,11)
376dma1
377    DMA # for WSS playback (0,1,3)
378dma2
379    DMA # for WSS capture (0,1), -1 = disabled (default)
380mpu_port
381    port # for MPU-401 UART (0x300,0x330), -1 = disabled (default)
382mpu_irq
383    IRQ # for MPU-401 UART (5,7,9,10), -1 = disabled (default)
384fm_port
385    port # for OPL3 (0x388), -1 = disabled (default)
386
387This module supports multiple cards. It does not support autoprobe:
388``port``, ``wss_port``, ``irq`` and ``dma1`` have to be specified.
389The other values are optional.
390
391``port`` needs to match the BASE ADDRESS jumper on the card (0x220 or 0x240)
392or the value stored in the card's EEPROM for cards that have an EEPROM and
393their "CONFIG MODE" jumper set to "EEPROM SETTING". The other values can
394be chosen freely from the options enumerated above.
395
396If ``dma2`` is specified and different from ``dma1``, the card will operate in
397full-duplex mode. When ``dma1=3``, only ``dma2=0`` is valid and the only way to
398enable capture since only channels 0 and 1 are available for capture.
399
400Generic settings are ``port=0x220 wss_port=0x530 irq=10 dma1=1 dma2=0
401mpu_port=0x330 mpu_irq=9 fm_port=0x388``.
402
403Whatever IRQ and DMA channels you pick, be sure to reserve them for
404legacy ISA in your BIOS.
405
406Module snd-aw2
407--------------
408
409Module for Audiowerk2 sound card
410
411This module supports multiple cards.
412
413Module snd-azt2320
414------------------
415
416Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
417
418This module supports multiple cards, PnP and autoprobe.
419
420The power-management is supported.
421
422Module snd-azt3328
423------------------
424
425Module for sound cards based on Aztech AZF3328 PCI chip.
426
427joystick
428    Enable joystick (default off)
429
430This module supports multiple cards.
431
432Module snd-bt87x
433----------------
434
435Module for video cards based on Bt87x chips.
436
437digital_rate
438    Override the default digital rate (Hz)
439load_all
440    Load the driver even if the card model isn't known
441
442This module supports multiple cards.
443
444Note: The default index value of this module is -2, i.e. the first
445slot is excluded.
446
447Module snd-ca0106
448-----------------
449
450Module for Creative Audigy LS and SB Live 24bit
451
452This module supports multiple cards.
453
454
455Module snd-cmi8330
456------------------
457
458Module for sound cards based on C-Media CMI8330 ISA chips.
459
460isapnp
461    ISA PnP detection - 0 = disable, 1 = enable (default)
462
463with ``isapnp=0``, the following options are available:
464
465wssport
466    port # for CMI8330 chip (WSS)
467wssirq
468    IRQ # for CMI8330 chip (WSS)
469wssdma
470    first DMA # for CMI8330 chip (WSS)
471sbport
472    port # for CMI8330 chip (SB16)
473sbirq
474    IRQ # for CMI8330 chip (SB16)
475sbdma8
476    8bit DMA # for CMI8330 chip (SB16)
477sbdma16
478    16bit DMA # for CMI8330 chip (SB16)
479fmport
480    (optional) OPL3 I/O port
481mpuport
482    (optional) MPU401 I/O port
483mpuirq
484    (optional) MPU401 irq #
485
486This module supports multiple cards and autoprobe.
487
488The power-management is supported.
489
490Module snd-cmipci
491-----------------
492
493Module for C-Media CMI8338/8738/8768/8770 PCI sound cards.
494
495mpu_port
496    port address of MIDI interface (8338 only):
497    0x300,0x310,0x320,0x330 = legacy port,
498    0 = disable (default)
499fm_port
500    port address of OPL-3 FM synthesizer (8x38 only):
501    0x388 = legacy port,
502    1 = integrated PCI port (default on 8738),
503    0 = disable
504soft_ac3
505    Software-conversion of raw SPDIF packets (model 033 only) (default = 1)
506joystick_port
507    Joystick port address (0 = disable, 1 = auto-detect)
508
509This module supports autoprobe and multiple cards.
510
511The power-management is supported.
512
513Module snd-cs4231
514-----------------
515
516Module for sound cards based on CS4231 ISA chips.
517
518port
519    port # for CS4231 chip
520mpu_port
521    port # for MPU-401 UART (optional), -1 = disable
522irq
523    IRQ # for CS4231 chip
524mpu_irq
525    IRQ # for MPU-401 UART
526dma1
527    first DMA # for CS4231 chip
528dma2
529    second DMA # for CS4231 chip
530
531This module supports multiple cards. This module does not support autoprobe
532thus main port must be specified!!! Other ports are optional.
533
534The power-management is supported.
535
536Module snd-cs4236
537-----------------
538
539Module for sound cards based on CS4232/CS4232A,
540CS4235/CS4236/CS4236B/CS4237B/CS4238B/CS4239 ISA chips.
541
542isapnp
543    ISA PnP detection - 0 = disable, 1 = enable (default)
544
545with ``isapnp=0``, the following options are available:
546
547port
548    port # for CS4236 chip (PnP setup - 0x534)
549cport
550    control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
551mpu_port
552    port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
553fm_port
554    FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
555irq
556    IRQ # for CS4236 chip (5,7,9,11,12,15)
557mpu_irq
558    IRQ # for MPU-401 UART (9,11,12,15)
559dma1
560    first DMA # for CS4236 chip (0,1,3)
561dma2
562    second DMA # for CS4236 chip (0,1,3), -1 = disable
563
564This module supports multiple cards. This module does not support autoprobe
565(if ISA PnP is not used) thus main port and control port must be
566specified!!! Other ports are optional.
567
568The power-management is supported.
569
570This module is aliased as snd-cs4232 since it provides the old
571snd-cs4232 functionality, too.
572
573Module snd-cs4281
574-----------------
575
576Module for Cirrus Logic CS4281 soundchip.
577
578dual_codec
579    Secondary codec ID (0 = disable, default)
580
581This module supports multiple cards.
582
583The power-management is supported.
584
585Module snd-cs46xx
586-----------------
587
588Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
589CS4624/CS4630/CS4280 PCI chips.
590
591external_amp
592    Force to enable external amplifier.
593thinkpad
594    Force to enable Thinkpad's CLKRUN control.
595mmap_valid
596    Support OSS mmap mode (default = 0).
597
598This module supports multiple cards and autoprobe.
599Usually external amp and CLKRUN controls are detected automatically
600from PCI sub vendor/device ids.  If they don't work, give the options
601above explicitly.
602
603The power-management is supported.
604
605Module snd-cs5530
606-----------------
607
608Module for Cyrix/NatSemi Geode 5530 chip.
609
610Module snd-cs5535audio
611----------------------
612
613Module for multifunction CS5535 companion PCI device
614
615The power-management is supported.
616
617Module snd-ctxfi
618----------------
619
620Module for Creative Sound Blaster X-Fi boards (20k1 / 20k2 chips)
621
622* Creative Sound Blaster X-Fi Titanium Fatal1ty Champion Series
623* Creative Sound Blaster X-Fi Titanium Fatal1ty Professional Series
624* Creative Sound Blaster X-Fi Titanium Professional Audio
625* Creative Sound Blaster X-Fi Titanium
626* Creative Sound Blaster X-Fi Elite Pro
627* Creative Sound Blaster X-Fi Platinum
628* Creative Sound Blaster X-Fi Fatal1ty
629* Creative Sound Blaster X-Fi XtremeGamer
630* Creative Sound Blaster X-Fi XtremeMusic
631
632reference_rate
633    reference sample rate, 44100 or 48000 (default)
634multiple
635    multiple to ref. sample rate, 1 or 2 (default)
636subsystem
637    override the PCI SSID for probing;
638    the value consists of SSVID << 16 | SSDID.
639    The default is zero, which means no override.
640
641This module supports multiple cards.
642
643Module snd-darla20
644------------------
645
646Module for Echoaudio Darla20
647
648This module supports multiple cards.
649The driver requires the firmware loader support on kernel.
650
651Module snd-darla24
652------------------
653
654Module for Echoaudio Darla24
655
656This module supports multiple cards.
657The driver requires the firmware loader support on kernel.
658
659Module snd-dt019x
660-----------------
661
662Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
663only)
664
665This module supports multiple cards.  This module is enabled only with
666ISA PnP support.
667
668The power-management is supported.
669
670Module snd-dummy
671----------------
672
673Module for the dummy sound card. This "card" doesn't do any output
674or input, but you may use this module for any application which
675requires a sound card (like RealPlayer).
676
677pcm_devs
678    Number of PCM devices assigned to each card (default = 1, up to 4)
679pcm_substreams
680    Number of PCM substreams assigned to each PCM (default = 8, up to 128)
681hrtimer
682    Use hrtimer (=1, default) or system timer (=0)
683fake_buffer
684    Fake buffer allocations (default = 1)
685
686When multiple PCM devices are created, snd-dummy gives different
687behavior to each PCM device:
688* 0 = interleaved with mmap support
689* 1 = non-interleaved with mmap support
690* 2 = interleaved without mmap
691* 3 = non-interleaved without mmap
692
693As default, snd-dummy drivers doesn't allocate the real buffers
694but either ignores read/write or mmap a single dummy page to all
695buffer pages, in order to save the resources.  If your apps need
696the read/ written buffer data to be consistent, pass fake_buffer=0
697option.
698
699The power-management is supported.
700
701Module snd-echo3g
702-----------------
703
704Module for Echoaudio 3G cards (Gina3G/Layla3G)
705
706This module supports multiple cards.
707The driver requires the firmware loader support on kernel.
708
709Module snd-emu10k1
710------------------
711
712Module for EMU10K1/EMU10k2 based PCI sound cards.
713
714* Sound Blaster Live!
715* Sound Blaster PCI 512
716* Emu APS (partially supported)
717* Sound Blaster Audigy
718
719extin
720    bitmap of available external inputs for FX8010 (see bellow)
721extout
722    bitmap of available external outputs for FX8010 (see bellow)
723seq_ports
724    allocated sequencer ports (4 by default)
725max_synth_voices
726    limit of voices used for wavetable (64 by default)
727max_buffer_size
728    specifies the maximum size of wavetable/pcm buffers given in MB
729    unit.  Default value is 128.
730enable_ir
731    enable IR
732
733This module supports multiple cards and autoprobe.
734
735Input & Output configurations 			[extin/extout]
736* Creative Card wo/Digital out			[0x0003/0x1f03]
737* Creative Card w/Digital out			[0x0003/0x1f0f]
738* Creative Card w/Digital CD in			[0x000f/0x1f0f]
739* Creative Card wo/Digital out + LiveDrive	[0x3fc3/0x1fc3]
740* Creative Card w/Digital out + LiveDrive	[0x3fc3/0x1fcf]
741* Creative Card w/Digital CD in + LiveDrive	[0x3fcf/0x1fcf]
742* Creative Card wo/Digital out + Digital I/O 2  [0x0fc3/0x1f0f]
743* Creative Card w/Digital out + Digital I/O 2	[0x0fc3/0x1f0f]
744* Creative Card w/Digital CD in + Digital I/O 2	[0x0fcf/0x1f0f]
745* Creative Card 5.1/w Digital out + LiveDrive	[0x3fc3/0x1fff]
746* Creative Card 5.1 (c) 2003			[0x3fc3/0x7cff]
747* Creative Card all ins and outs		[0x3fff/0x7fff]
748
749The power-management is supported.
750
751Module snd-emu10k1x
752-------------------
753
754Module for Creative Emu10k1X (SB Live Dell OEM version)
755
756This module supports multiple cards.
757
758Module snd-ens1370
759------------------
760
761Module for Ensoniq AudioPCI ES1370 PCI sound cards.
762
763* SoundBlaster PCI 64
764* SoundBlaster PCI 128
765
766joystick
767    Enable joystick (default off)
768
769This module supports multiple cards and autoprobe.
770
771The power-management is supported.
772
773Module snd-ens1371
774------------------
775
776Module for Ensoniq AudioPCI ES1371 PCI sound cards.
777
778* SoundBlaster PCI 64
779* SoundBlaster PCI 128
780* SoundBlaster Vibra PCI
781
782joystick_port
783    port # for joystick (0x200,0x208,0x210,0x218), 0 = disable
784    (default), 1 = auto-detect
785
786This module supports multiple cards and autoprobe.
787
788The power-management is supported.
789
790Module snd-es1688
791-----------------
792
793Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
794
795isapnp
796    ISA PnP detection - 0 = disable, 1 = enable (default)
797mpu_port
798    port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
799mpu_irq
800    IRQ # for MPU-401 port (5,7,9,10)
801fm_port
802    port # for OPL3 (option; share the same port as default)
803
804with ``isapnp=0``, the following additional options are available:
805
806port
807    port # for ES-1688 chip (0x220,0x240,0x260)
808irq
809    IRQ # for ES-1688 chip (5,7,9,10)
810dma8
811    DMA # for ES-1688 chip (0,1,3)
812
813This module supports multiple cards and autoprobe (without MPU-401 port)
814and PnP with the ES968 chip.
815
816Module snd-es18xx
817-----------------
818
819Module for ESS AudioDrive ES-18xx sound cards.
820
821isapnp
822    ISA PnP detection - 0 = disable, 1 = enable (default)
823
824with ``isapnp=0``, the following options are available:
825
826port
827    port # for ES-18xx chip (0x220,0x240,0x260)
828mpu_port
829    port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
830fm_port
831    port # for FM (optional, not used)
832irq
833    IRQ # for ES-18xx chip (5,7,9,10)
834dma1
835    first DMA # for ES-18xx chip (0,1,3)
836dma2
837    first DMA # for ES-18xx chip (0,1,3)
838
839This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
840port if native ISA PnP routines are not used).
841When ``dma2`` is equal with ``dma1``, the driver works as half-duplex.
842
843The power-management is supported.
844
845Module snd-es1938
846-----------------
847
848Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
849
850This module supports multiple cards and autoprobe.
851
852The power-management is supported.
853
854Module snd-es1968
855-----------------
856
857Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
858
859total_bufsize
860    total buffer size in kB (1-4096kB)
861pcm_substreams_p
862    playback channels (1-8, default=2)
863pcm_substreams_c
864    capture channels (1-8, default=0)
865clock
866    clock (0 = auto-detection)
867use_pm
868    support the power-management (0 = off, 1 = on, 2 = auto (default))
869enable_mpu
870    enable MPU401 (0 = off, 1 = on, 2 = auto (default))
871joystick
872    enable joystick (default off)
873
874This module supports multiple cards and autoprobe.
875
876The power-management is supported.
877
878Module snd-fm801
879----------------
880
881Module for ForteMedia FM801 based PCI sound cards.
882
883tea575x_tuner
884    Enable TEA575x tuner;
885    1 = MediaForte 256-PCS,
886    2 = MediaForte 256-PCPR,
887    3 = MediaForte 64-PCR
888    High 16-bits are video (radio) device number + 1;
889    example: 0x10002 (MediaForte 256-PCPR, device 1)
890
891This module supports multiple cards and autoprobe.
892
893The power-management is supported.
894
895Module snd-gina20
896-----------------
897
898Module for Echoaudio Gina20
899
900This module supports multiple cards.
901The driver requires the firmware loader support on kernel.
902
903Module snd-gina24
904-----------------
905
906Module for Echoaudio Gina24
907
908This module supports multiple cards.
909The driver requires the firmware loader support on kernel.
910
911Module snd-gusclassic
912---------------------
913
914Module for Gravis UltraSound Classic sound card.
915
916port
917    port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
918irq
919    IRQ # for GF1 chip (3,5,9,11,12,15)
920dma1
921    DMA # for GF1 chip (1,3,5,6,7)
922dma2
923    DMA # for GF1 chip (1,3,5,6,7,-1=disable)
924joystick_dac
925    0 to 31, (0.59V-4.52V or 0.389V-2.98V)
926voices
927    GF1 voices limit (14-32)
928pcm_voices
929    reserved PCM voices
930
931This module supports multiple cards and autoprobe.
932
933Module snd-gusextreme
934---------------------
935
936Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
937
938port
939    port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
940gf1_port
941    port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
942mpu_port
943    port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
944irq
945    IRQ # for ES-1688 chip (5,7,9,10)
946gf1_irq
947    IRQ # for GF1 chip (3,5,9,11,12,15)
948mpu_irq
949    IRQ # for MPU-401 port (5,7,9,10)
950dma8
951    DMA # for ES-1688 chip (0,1,3)
952dma1
953    DMA # for GF1 chip (1,3,5,6,7)
954joystick_dac
955    0 to 31, (0.59V-4.52V or 0.389V-2.98V)
956voices
957    GF1 voices limit (14-32)
958pcm_voices
959    reserved PCM voices
960
961This module supports multiple cards and autoprobe (without MPU-401 port).
962
963Module snd-gusmax
964-----------------
965
966Module for Gravis UltraSound MAX sound card.
967
968port
969    port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
970irq
971    IRQ # for GF1 chip (3,5,9,11,12,15)
972dma1
973    DMA # for GF1 chip (1,3,5,6,7)
974dma2
975    DMA # for GF1 chip (1,3,5,6,7,-1=disable)
976joystick_dac
977    0 to 31, (0.59V-4.52V or 0.389V-2.98V)
978voices
979    GF1 voices limit (14-32)
980pcm_voices
981    reserved PCM voices
982
983This module supports multiple cards and autoprobe.
984
985Module snd-hda-intel
986--------------------
987
988Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8, ICH9, ICH10,
989PCH, SCH), ATI SB450, SB600, R600, RS600, RS690, RS780, RV610, RV620,
990RV630, RV635, RV670, RV770, VIA VT8251/VT8237A, SIS966, ULI M5461
991
992[Multiple options for each card instance]
993
994model
995    force the model name
996position_fix
997    Fix DMA pointer;
998    -1 = system default: choose appropriate one per controller hardware,
999    0 = auto: falls back to LPIB when POSBUF doesn't work,
1000    1 = use LPIB,
1001    2 = POSBUF: use position buffer,
1002    3 = VIACOMBO: VIA-specific workaround for capture,
1003    4 = COMBO: use LPIB for playback, auto for capture stream
1004probe_mask
1005    Bitmask to probe codecs (default = -1, meaning all slots);
1006    When the bit 8 (0x100) is set, the lower 8 bits are used
1007    as the "fixed" codec slots; i.e. the driver probes the
1008    slots regardless what hardware reports back
1009probe_only
1010    Only probing and no codec initialization (default=off);
1011    Useful to check the initial codec status for debugging
1012bdl_pos_adj
1013    Specifies the DMA IRQ timing delay in samples.
1014    Passing -1 will make the driver to choose the appropriate
1015    value based on the controller chip.
1016patch
1017    Specifies the early "patch" files to modify the HD-audio setup
1018    before initializing the codecs.
1019    This option is available only when ``CONFIG_SND_HDA_PATCH_LOADER=y``
1020    is set.  See hd-audio/notes.rst for details.
1021beep_mode
1022    Selects the beep registration mode (0=off, 1=on);
1023    default value is set via ``CONFIG_SND_HDA_INPUT_BEEP_MODE`` kconfig.
1024
1025[Single (global) options]
1026
1027single_cmd
1028    Use single immediate commands to communicate with codecs
1029    (for debugging only)
1030enable_msi
1031    Enable Message Signaled Interrupt (MSI) (default = off)
1032power_save
1033    Automatic power-saving timeout (in second, 0 = disable)
1034power_save_controller
1035    Reset HD-audio controller in power-saving mode (default = on)
1036align_buffer_size
1037    Force rounding of buffer/period sizes to multiples of 128 bytes.
1038    This is more efficient in terms of memory access but isn't
1039    required by the HDA spec and prevents users from specifying
1040    exact period/buffer sizes. (default = on)
1041snoop
1042    Enable/disable snooping (default = on)
1043
1044This module supports multiple cards and autoprobe.
1045
1046See hd-audio/notes.rst for more details about HD-audio driver.
1047
1048Each codec may have a model table for different configurations.
1049If your machine isn't listed there, the default (usually minimal)
1050configuration is set up.  You can pass ``model=<name>`` option to
1051specify a certain model in such a case.  There are different
1052models depending on the codec chip.  The list of available models
1053is found in hd-audio/models.rst.
1054
1055The model name ``generic`` is treated as a special case.  When this
1056model is given, the driver uses the generic codec parser without
1057"codec-patch".  It's sometimes good for testing and debugging.
1058
1059If the default configuration doesn't work and one of the above
1060matches with your device, report it together with alsa-info.sh
1061output (with ``--no-upload`` option) to kernel bugzilla or alsa-devel
1062ML (see the section `Links and Addresses`_).
1063
1064``power_save`` and ``power_save_controller`` options are for power-saving
1065mode.  See powersave.txt for details.
1066
1067Note 2: If you get click noises on output, try the module option
1068``position_fix=1`` or ``2``.  ``position_fix=1`` will use the SD_LPIB
1069register value without FIFO size correction as the current
1070DMA pointer.  ``position_fix=2`` will make the driver to use
1071the position buffer instead of reading SD_LPIB register.
1072(Usually SD_LPIB register is more accurate than the
1073position buffer.)
1074
1075``position_fix=3`` is specific to VIA devices.  The position
1076of the capture stream is checked from both LPIB and POSBUF
1077values.  ``position_fix=4`` is a combination mode, using LPIB
1078for playback and POSBUF for capture.
1079
1080NB: If you get many ``azx_get_response timeout`` messages at
1081loading, it's likely a problem of interrupts (e.g. ACPI irq
1082routing).  Try to boot with options like ``pci=noacpi``.  Also, you
1083can try ``single_cmd=1`` module option.  This will switch the
1084communication method between HDA controller and codecs to the
1085single immediate commands instead of CORB/RIRB.  Basically, the
1086single command mode is provided only for BIOS, and you won't get
1087unsolicited events, too.  But, at least, this works independently
1088from the irq.  Remember this is a last resort, and should be
1089avoided as much as possible...
1090
1091MORE NOTES ON ``azx_get_response timeout`` PROBLEMS:
1092On some hardware, you may need to add a proper probe_mask option
1093to avoid the ``azx_get_response timeout`` problem above, instead.
1094This occurs when the access to non-existing or non-working codec slot
1095(likely a modem one) causes a stall of the communication via HD-audio
1096bus.  You can see which codec slots are probed by enabling
1097``CONFIG_SND_DEBUG_VERBOSE``, or simply from the file name of the codec
1098proc files.  Then limit the slots to probe by probe_mask option.
1099For example, ``probe_mask=1`` means to probe only the first slot, and
1100``probe_mask=4`` means only the third slot.
1101
1102The power-management is supported.
1103
1104Module snd-hdsp
1105---------------
1106
1107Module for RME Hammerfall DSP audio interface(s)
1108
1109This module supports multiple cards.
1110
1111Note: The firmware data can be automatically loaded via hotplug
1112when ``CONFIG_FW_LOADER`` is set.  Otherwise, you need to load
1113the firmware via hdsploader utility included in alsa-tools
1114package.
1115The firmware data is found in alsa-firmware package.
1116
1117Note: snd-page-alloc module does the job which snd-hammerfall-mem
1118module did formerly.  It will allocate the buffers in advance
1119when any HDSP cards are found.  To make the buffer
1120allocation sure, load snd-page-alloc module in the early
1121stage of boot sequence.  See `Early Buffer Allocation`_
1122section.
1123
1124Module snd-hdspm
1125----------------
1126
1127Module for RME HDSP MADI board.
1128
1129precise_ptr
1130    Enable precise pointer, or disable.
1131line_outs_monitor
1132    Send playback streams to analog outs by default.
1133enable_monitor
1134    Enable Analog Out on Channel 63/64 by default.
1135
1136See hdspm.txt for details.
1137
1138Module snd-ice1712
1139------------------
1140
1141Module for Envy24 (ICE1712) based PCI sound cards.
1142
1143* MidiMan M Audio Delta 1010
1144* MidiMan M Audio Delta 1010LT
1145* MidiMan M Audio Delta DiO 2496
1146* MidiMan M Audio Delta 66
1147* MidiMan M Audio Delta 44
1148* MidiMan M Audio Delta 410
1149* MidiMan M Audio Audiophile 2496
1150* TerraTec EWS 88MT
1151* TerraTec EWS 88D
1152* TerraTec EWX 24/96
1153* TerraTec DMX 6Fire
1154* TerraTec Phase 88
1155* Hoontech SoundTrack DSP 24
1156* Hoontech SoundTrack DSP 24 Value
1157* Hoontech SoundTrack DSP 24 Media 7.1
1158* Event Electronics, EZ8
1159* Digigram VX442
1160* Lionstracs, Mediastaton
1161* Terrasoniq TS 88
1162
1163model
1164    Use the given board model, one of the following:
1165    delta1010, dio2496, delta66, delta44, audiophile, delta410,
1166    delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
1167    dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
1168    phase88, mediastation
1169omni
1170    Omni I/O support for MidiMan M-Audio Delta44/66
1171cs8427_timeout
1172    reset timeout for the CS8427 chip (S/PDIF transceiver) in msec
1173    resolution, default value is 500 (0.5 sec)
1174
1175This module supports multiple cards and autoprobe.
1176Note: The consumer part is not used with all Envy24 based cards (for
1177example in the MidiMan Delta siree).
1178
1179Note: The supported board is detected by reading EEPROM or PCI
1180SSID (if EEPROM isn't available).  You can override the
1181model by passing ``model`` module option in case that the
1182driver isn't configured properly or you want to try another
1183type for testing.
1184
1185Module snd-ice1724
1186------------------
1187
1188Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
1189
1190* MidiMan M Audio Revolution 5.1
1191* MidiMan M Audio Revolution 7.1
1192* MidiMan M Audio Audiophile 192
1193* AMP Ltd AUDIO2000
1194* TerraTec Aureon 5.1 Sky
1195* TerraTec Aureon 7.1 Space
1196* TerraTec Aureon 7.1 Universe
1197* TerraTec Phase 22
1198* TerraTec Phase 28
1199* AudioTrak Prodigy 7.1
1200* AudioTrak Prodigy 7.1 LT
1201* AudioTrak Prodigy 7.1 XT
1202* AudioTrak Prodigy 7.1 HIFI
1203* AudioTrak Prodigy 7.1 HD2
1204* AudioTrak Prodigy 192
1205* Pontis MS300
1206* Albatron K8X800 Pro II
1207* Chaintech ZNF3-150
1208* Chaintech ZNF3-250
1209* Chaintech 9CJS
1210* Chaintech AV-710
1211* Shuttle SN25P
1212* Onkyo SE-90PCI
1213* Onkyo SE-200PCI
1214* ESI Juli@
1215* ESI Maya44
1216* Hercules Fortissimo IV
1217* EGO-SYS WaveTerminal 192M
1218
1219model
1220    Use the given board model, one of the following:
1221    revo51, revo71, amp2000, prodigy71, prodigy71lt,
1222    prodigy71xt, prodigy71hifi, prodigyhd2, prodigy192,
1223    juli, aureon51, aureon71, universe, ap192, k8x800,
1224    phase22, phase28, ms300, av710, se200pci, se90pci,
1225    fortissimo4, sn25p, WT192M, maya44
1226
1227This module supports multiple cards and autoprobe.
1228
1229Note: The supported board is detected by reading EEPROM or PCI
1230SSID (if EEPROM isn't available).  You can override the
1231model by passing ``model`` module option in case that the
1232driver isn't configured properly or you want to try another
1233type for testing.
1234
1235Module snd-indigo
1236-----------------
1237
1238Module for Echoaudio Indigo
1239
1240This module supports multiple cards.
1241The driver requires the firmware loader support on kernel.
1242
1243Module snd-indigodj
1244-------------------
1245
1246Module for Echoaudio Indigo DJ
1247
1248This module supports multiple cards.
1249The driver requires the firmware loader support on kernel.
1250
1251Module snd-indigoio
1252-------------------
1253
1254Module for Echoaudio Indigo IO
1255
1256This module supports multiple cards.
1257The driver requires the firmware loader support on kernel.
1258
1259Module snd-intel8x0
1260-------------------
1261
1262Module for AC'97 motherboards from Intel and compatibles.
1263
1264* Intel i810/810E, i815, i820, i830, i84x, MX440 ICH5, ICH6, ICH7,
1265  6300ESB, ESB2
1266* SiS 7012 (SiS 735)
1267* NVidia NForce, NForce2, NForce3, MCP04, CK804 CK8, CK8S, MCP501
1268* AMD AMD768, AMD8111
1269* ALi m5455
1270
1271ac97_clock
1272    AC'97 codec clock base (0 = auto-detect)
1273ac97_quirk
1274    AC'97 workaround for strange hardware;
1275    See `AC97 Quirk Option`_ section below.
1276buggy_irq
1277    Enable workaround for buggy interrupts on some motherboards
1278    (default yes on nForce chips, otherwise off)
1279buggy_semaphore
1280    Enable workaround for hardware with buggy semaphores (e.g. on some
1281    ASUS laptops) (default off)
1282spdif_aclink
1283    Use S/PDIF over AC-link instead of direct connection from the
1284    controller chip (0 = off, 1 = on, -1 = default)
1285
1286This module supports one chip and autoprobe.
1287
1288Note: the latest driver supports auto-detection of chip clock.
1289if you still encounter too fast playback, specify the clock
1290explicitly via the module option ``ac97_clock=41194``.
1291
1292Joystick/MIDI ports are not supported by this driver.  If your
1293motherboard has these devices, use the ns558 or snd-mpu401
1294modules, respectively.
1295
1296The power-management is supported.
1297
1298Module snd-intel8x0m
1299--------------------
1300
1301Module for Intel ICH (i8x0) chipset MC97 modems.
1302
1303* Intel i810/810E, i815, i820, i830, i84x, MX440 ICH5, ICH6, ICH7
1304* SiS 7013 (SiS 735)
1305* NVidia NForce, NForce2, NForce2s, NForce3
1306* AMD AMD8111
1307* ALi m5455
1308
1309ac97_clock
1310    AC'97 codec clock base (0 = auto-detect)
1311
1312This module supports one card and autoprobe.
1313
1314Note: The default index value of this module is -2, i.e. the first
1315slot is excluded.
1316
1317The power-management is supported.
1318
1319Module snd-interwave
1320--------------------
1321
1322Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1323and other sound cards based on AMD InterWave (tm) chip.
1324
1325joystick_dac
1326    0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1327midi
1328    1 = MIDI UART enable, 0 = MIDI UART disable (default)
1329pcm_voices
1330    reserved PCM voices for the synthesizer (default 2)
1331effect
1332    1 = InterWave effects enable (default 0); requires 8 voices
1333isapnp
1334    ISA PnP detection - 0 = disable, 1 = enable (default)
1335
1336with ``isapnp=0``, the following options are available:
1337
1338port
1339    port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1340irq
1341    IRQ # for InterWave chip (3,5,9,11,12,15)
1342dma1
1343    DMA # for InterWave chip (0,1,3,5,6,7)
1344dma2
1345    DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
1346
1347This module supports multiple cards, autoprobe and ISA PnP.
1348
1349Module snd-interwave-stb
1350------------------------
1351
1352Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1353and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1354circuit for extended control of bass, treble and master volume.
1355
1356joystick_dac
1357    0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1358midi
1359    1 = MIDI UART enable, 0 = MIDI UART disable (default)
1360pcm_voices
1361    reserved PCM voices for the synthesizer (default 2)
1362effect
1363    1 = InterWave effects enable (default 0); requires 8 voices
1364isapnp
1365    ISA PnP detection - 0 = disable, 1 = enable (default)
1366
1367with ``isapnp=0``, the following options are available:
1368
1369port
1370    port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1371port_tc
1372    tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1373irq
1374    IRQ # for InterWave chip (3,5,9,11,12,15)
1375dma1
1376    DMA # for InterWave chip (0,1,3,5,6,7)
1377dma2
1378    DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
1379
1380This module supports multiple cards, autoprobe and ISA PnP.
1381
1382Module snd-jazz16
1383-------------------
1384
1385Module for Media Vision Jazz16 chipset. The chipset consists of 3 chips:
1386MVD1216 + MVA416 + MVA514.
1387
1388port
1389    port # for SB DSP chip (0x210,0x220,0x230,0x240,0x250,0x260)
1390irq
1391    IRQ # for SB DSP chip (3,5,7,9,10,15)
1392dma8
1393    DMA # for SB DSP chip (1,3)
1394dma16
1395    DMA # for SB DSP chip (5,7)
1396mpu_port
1397    MPU-401 port # (0x300,0x310,0x320,0x330)
1398mpu_irq
1399    MPU-401 irq # (2,3,5,7)
1400
1401This module supports multiple cards.
1402
1403Module snd-korg1212
1404-------------------
1405
1406Module for Korg 1212 IO PCI card
1407
1408This module supports multiple cards.
1409
1410Module snd-layla20
1411------------------
1412
1413Module for Echoaudio Layla20
1414
1415This module supports multiple cards.
1416The driver requires the firmware loader support on kernel.
1417
1418Module snd-layla24
1419------------------
1420
1421Module for Echoaudio Layla24
1422
1423This module supports multiple cards.
1424The driver requires the firmware loader support on kernel.
1425
1426Module snd-lola
1427---------------
1428
1429Module for Digigram Lola PCI-e boards
1430
1431This module supports multiple cards.
1432
1433Module snd-lx6464es
1434-------------------
1435
1436Module for Digigram LX6464ES boards
1437
1438This module supports multiple cards.
1439
1440Module snd-maestro3
1441-------------------
1442
1443Module for Allegro/Maestro3 chips
1444
1445external_amp
1446    enable external amp (enabled by default)
1447amp_gpio
1448    GPIO pin number for external amp (0-15) or -1 for default pin (8
1449    for allegro, 1 for others)
1450
1451This module supports autoprobe and multiple chips.
1452
1453Note: the binding of amplifier is dependent on hardware.
1454If there is no sound even though all channels are unmuted, try to
1455specify other gpio connection via amp_gpio option.
1456For example, a Panasonic notebook might need ``amp_gpio=0x0d``
1457option.
1458
1459The power-management is supported.
1460
1461Module snd-mia
1462---------------
1463
1464Module for Echoaudio Mia
1465
1466This module supports multiple cards.
1467The driver requires the firmware loader support on kernel.
1468
1469Module snd-miro
1470---------------
1471
1472Module for Miro soundcards: miroSOUND PCM 1 pro, miroSOUND PCM 12,
1473miroSOUND PCM 20 Radio.
1474
1475port
1476    Port # (0x530,0x604,0xe80,0xf40)
1477irq
1478    IRQ # (5,7,9,10,11)
1479dma1
1480    1st dma # (0,1,3)
1481dma2
1482    2nd dma # (0,1)
1483mpu_port
1484    MPU-401 port # (0x300,0x310,0x320,0x330)
1485mpu_irq
1486    MPU-401 irq # (5,7,9,10)
1487fm_port
1488    FM Port # (0x388)
1489wss
1490    enable WSS mode
1491ide
1492    enable onboard ide support
1493
1494Module snd-mixart
1495-----------------
1496
1497Module for Digigram miXart8 sound cards.
1498
1499This module supports multiple cards.
1500Note: One miXart8 board will be represented as 4 alsa cards.
1501See MIXART.txt for details.
1502
1503When the driver is compiled as a module and the hotplug firmware
1504is supported, the firmware data is loaded via hotplug automatically.
1505Install the necessary firmware files in alsa-firmware package.
1506When no hotplug fw loader is available, you need to load the
1507firmware via mixartloader utility in alsa-tools package.
1508
1509Module snd-mona
1510---------------
1511
1512Module for Echoaudio Mona
1513
1514This module supports multiple cards.
1515The driver requires the firmware loader support on kernel.
1516
1517Module snd-mpu401
1518-----------------
1519
1520Module for MPU-401 UART devices.
1521
1522port
1523    port number or -1 (disable)
1524irq
1525    IRQ number or -1 (disable)
1526pnp
1527    PnP detection - 0 = disable, 1 = enable (default)
1528
1529This module supports multiple devices and PnP.
1530
1531Module snd-msnd-classic
1532-----------------------
1533
1534Module for Turtle Beach MultiSound Classic, Tahiti or Monterey
1535soundcards.
1536
1537io
1538    Port # for msnd-classic card
1539irq
1540    IRQ # for msnd-classic card
1541mem
1542    Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000, 0xe0000 or 0xe8000)
1543write_ndelay
1544    enable write ndelay (default = 1)
1545calibrate_signal
1546    calibrate signal (default = 0)
1547isapnp
1548    ISA PnP detection - 0 = disable, 1 = enable (default)
1549digital
1550    Digital daughterboard present (default = 0)
1551cfg
1552    Config port (0x250, 0x260 or 0x270) default = PnP
1553reset
1554    Reset all devices
1555mpu_io
1556    MPU401 I/O port
1557mpu_irq
1558    MPU401 irq#
1559ide_io0
1560    IDE port #0
1561ide_io1
1562    IDE port #1
1563ide_irq
1564    IDE irq#
1565joystick_io
1566    Joystick I/O port
1567
1568The driver requires firmware files ``turtlebeach/msndinit.bin`` and
1569``turtlebeach/msndperm.bin`` in the proper firmware directory.
1570
1571See Documentation/sound/oss/MultiSound for important information
1572about this driver.  Note that it has been discontinued, but the
1573Voyetra Turtle Beach knowledge base entry for it is still available
1574at
1575http://www.turtlebeach.com
1576
1577Module snd-msnd-pinnacle
1578------------------------
1579
1580Module for Turtle Beach MultiSound Pinnacle/Fiji soundcards.
1581
1582io
1583    Port # for pinnacle/fiji card
1584irq
1585    IRQ # for pinnalce/fiji card
1586mem
1587    Memory address (0xb0000, 0xc8000, 0xd0000, 0xd8000, 0xe0000 or 0xe8000)
1588write_ndelay
1589    enable write ndelay (default = 1)
1590calibrate_signal
1591    calibrate signal (default = 0)
1592isapnp
1593    ISA PnP detection - 0 = disable, 1 = enable (default)
1594
1595The driver requires firmware files ``turtlebeach/pndspini.bin`` and
1596``turtlebeach/pndsperm.bin`` in the proper firmware directory.
1597
1598Module snd-mtpav
1599----------------
1600
1601Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1602port).
1603
1604port
1605    I/O port # for MTPAV (0x378,0x278, default=0x378)
1606irq
1607    IRQ # for MTPAV (7,5, default=7)
1608hwports
1609    number of supported hardware ports, default=8.
1610
1611Module supports only 1 card.  This module has no enable option.
1612
1613Module snd-mts64
1614----------------
1615
1616Module for Ego Systems (ESI) Miditerminal 4140
1617
1618This module supports multiple devices.
1619Requires parport (``CONFIG_PARPORT``).
1620
1621Module snd-nm256
1622----------------
1623
1624Module for NeoMagic NM256AV/ZX chips
1625
1626playback_bufsize
1627    max playback frame size in kB (4-128kB)
1628capture_bufsize
1629    max capture frame size in kB (4-128kB)
1630force_ac97
1631    0 or 1 (disabled by default)
1632buffer_top
1633    specify buffer top address
1634use_cache
1635    0 or 1 (disabled by default)
1636vaio_hack
1637    alias buffer_top=0x25a800
1638reset_workaround
1639    enable AC97 RESET workaround for some laptops
1640reset_workaround2
1641    enable extended AC97 RESET workaround for some other laptops
1642
1643This module supports one chip and autoprobe.
1644
1645The power-management is supported.
1646
1647Note: on some notebooks the buffer address cannot be detected
1648automatically, or causes hang-up during initialization.
1649In such a case, specify the buffer top address explicitly via
1650the buffer_top option.
1651For example,
1652Sony F250: buffer_top=0x25a800
1653Sony F270: buffer_top=0x272800
1654The driver supports only ac97 codec.  It's possible to force
1655to initialize/use ac97 although it's not detected.  In such a
1656case, use ``force_ac97=1`` option - but *NO* guarantee whether it
1657works!
1658
1659Note: The NM256 chip can be linked internally with non-AC97
1660codecs.  This driver supports only the AC97 codec, and won't work
1661with machines with other (most likely CS423x or OPL3SAx) chips,
1662even though the device is detected in lspci.  In such a case, try
1663other drivers, e.g. snd-cs4232 or snd-opl3sa2.  Some has ISA-PnP
1664but some doesn't have ISA PnP.  You'll need to specify ``isapnp=0``
1665and proper hardware parameters in the case without ISA PnP.
1666
1667Note: some laptops need a workaround for AC97 RESET.  For the
1668known hardware like Dell Latitude LS and Sony PCG-F305, this
1669workaround is enabled automatically.  For other laptops with a
1670hard freeze, you can try ``reset_workaround=1`` option.
1671
1672Note: Dell Latitude CSx laptops have another problem regarding
1673AC97 RESET.  On these laptops, reset_workaround2 option is
1674turned on as default.  This option is worth to try if the
1675previous reset_workaround option doesn't help.
1676
1677Note: This driver is really crappy.  It's a porting from the
1678OSS driver, which is a result of black-magic reverse engineering.
1679The detection of codec will fail if the driver is loaded *after*
1680X-server as described above.  You might be able to force to load
1681the module, but it may result in hang-up.   Hence, make sure that
1682you load this module *before* X if you encounter this kind of
1683problem.
1684
1685Module snd-opl3sa2
1686------------------
1687
1688Module for Yamaha OPL3-SA2/SA3 sound cards.
1689
1690isapnp
1691    ISA PnP detection - 0 = disable, 1 = enable (default)
1692
1693with ``isapnp=0``, the following options are available:
1694
1695port
1696    control port # for OPL3-SA chip (0x370)
1697sb_port
1698    SB port # for OPL3-SA chip (0x220,0x240)
1699wss_port
1700    WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1701midi_port
1702    port # for MPU-401 UART (0x300,0x330), -1 = disable
1703fm_port
1704    FM port # for OPL3-SA chip (0x388), -1 = disable
1705irq
1706    IRQ # for OPL3-SA chip (5,7,9,10)
1707dma1
1708    first DMA # for Yamaha OPL3-SA chip (0,1,3)
1709dma2
1710    second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
1711
1712This module supports multiple cards and ISA PnP.  It does not support
1713autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1714
1715The power-management is supported.
1716
1717Module snd-opti92x-ad1848
1718-------------------------
1719
1720Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1721Module works with OAK Mozart cards as well.
1722
1723isapnp
1724    ISA PnP detection - 0 = disable, 1 = enable (default)
1725
1726with ``isapnp=0``, the following options are available:
1727
1728port
1729    port # for WSS chip (0x530,0xe80,0xf40,0x604)
1730mpu_port
1731    port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1732fm_port
1733    port # for OPL3 device (0x388)
1734irq
1735    IRQ # for WSS chip (5,7,9,10,11)
1736mpu_irq
1737    IRQ # for MPU-401 UART (5,7,9,10)
1738dma1
1739    first DMA # for WSS chip (0,1,3)
1740
1741This module supports only one card, autoprobe and PnP.
1742
1743Module snd-opti92x-cs4231
1744-------------------------
1745
1746Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1747
1748isapnp
1749    ISA PnP detection - 0 = disable, 1 = enable (default)
1750
1751with ``isapnp=0``, the following options are available:
1752
1753port
1754    port # for WSS chip (0x530,0xe80,0xf40,0x604)
1755mpu_port
1756    port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1757fm_port
1758    port # for OPL3 device (0x388)
1759irq
1760    IRQ # for WSS chip (5,7,9,10,11)
1761mpu_irq
1762    IRQ # for MPU-401 UART (5,7,9,10)
1763dma1
1764    first DMA # for WSS chip (0,1,3)
1765dma2
1766    second DMA # for WSS chip (0,1,3)
1767
1768This module supports only one card, autoprobe and PnP.
1769
1770Module snd-opti93x
1771------------------
1772
1773Module for sound cards based on OPTi 82c93x chips.
1774
1775isapnp
1776    ISA PnP detection - 0 = disable, 1 = enable (default)
1777
1778with ``isapnp=0``, the following options are available:
1779
1780port
1781    port # for WSS chip (0x530,0xe80,0xf40,0x604)
1782mpu_port
1783    port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1784fm_port
1785    port # for OPL3 device (0x388)
1786irq
1787    IRQ # for WSS chip (5,7,9,10,11)
1788mpu_irq
1789    IRQ # for MPU-401 UART (5,7,9,10)
1790dma1
1791    first DMA # for WSS chip (0,1,3)
1792dma2
1793    second DMA # for WSS chip (0,1,3)
1794
1795This module supports only one card, autoprobe and PnP.
1796
1797Module snd-oxygen
1798-----------------
1799
1800Module for sound cards based on the C-Media CMI8786/8787/8788 chip:
1801
1802* Asound A-8788
1803* Asus Xonar DG/DGX
1804* AuzenTech X-Meridian
1805* AuzenTech X-Meridian 2G
1806* Bgears b-Enspirer
1807* Club3D Theatron DTS
1808* HT-Omega Claro (plus)
1809* HT-Omega Claro halo (XT)
1810* Kuroutoshikou CMI8787-HG2PCI
1811* Razer Barracuda AC-1
1812* Sondigo Inferno
1813* TempoTec HiFier Fantasia
1814* TempoTec HiFier Serenade
1815
1816This module supports autoprobe and multiple cards.
1817
1818Module snd-pcsp
1819---------------
1820
1821Module for internal PC-Speaker.
1822
1823nopcm
1824    Disable PC-Speaker PCM sound. Only beeps remain.
1825nforce_wa
1826    enable NForce chipset workaround. Expect bad sound.
1827
1828This module supports system beeps, some kind of PCM playback and
1829even a few mixer controls.
1830
1831Module snd-pcxhr
1832----------------
1833
1834Module for Digigram PCXHR boards
1835
1836This module supports multiple cards.
1837
1838Module snd-portman2x4
1839---------------------
1840
1841Module for Midiman Portman 2x4 parallel port MIDI interface
1842
1843This module supports multiple cards.
1844
1845Module snd-powermac (on ppc only)
1846---------------------------------
1847
1848Module for PowerMac, iMac and iBook on-board soundchips
1849
1850enable_beep
1851    enable beep using PCM (enabled as default)
1852
1853Module supports autoprobe a chip.
1854
1855Note: the driver may have problems regarding endianness.
1856
1857The power-management is supported.
1858
1859Module snd-pxa2xx-ac97 (on arm only)
1860------------------------------------
1861
1862Module for AC97 driver for the Intel PXA2xx chip
1863
1864For ARM architecture only.
1865
1866The power-management is supported.
1867
1868Module snd-riptide
1869------------------
1870
1871Module for Conexant Riptide chip
1872
1873joystick_port
1874    Joystick port # (default: 0x200)
1875mpu_port
1876    MPU401 port # (default: 0x330)
1877opl3_port
1878    OPL3 port # (default: 0x388)
1879
1880This module supports multiple cards.
1881The driver requires the firmware loader support on kernel.
1882You need to install the firmware file ``riptide.hex`` to the standard
1883firmware path (e.g. /lib/firmware).
1884
1885Module snd-rme32
1886----------------
1887
1888Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1889Prodif96 and Prodif Gold) sound cards.
1890
1891This module supports multiple cards.
1892
1893Module snd-rme96
1894----------------
1895
1896Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1897
1898This module supports multiple cards.
1899
1900Module snd-rme9652
1901------------------
1902
1903Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1904
1905precise_ptr
1906    Enable precise pointer (doesn't work reliably). (default = 0)
1907
1908This module supports multiple cards.
1909
1910Note: snd-page-alloc module does the job which snd-hammerfall-mem
1911module did formerly.  It will allocate the buffers in advance
1912when any RME9652 cards are found.  To make the buffer
1913allocation sure, load snd-page-alloc module in the early
1914stage of boot sequence.  See `Early Buffer Allocation`_
1915section.
1916
1917Module snd-sa11xx-uda1341 (on arm only)
1918---------------------------------------
1919
1920Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1921
1922Module supports only one card.
1923Module has no enable and index options.
1924
1925The power-management is supported.
1926
1927Module snd-sb8
1928--------------
1929
1930Module for 8-bit SoundBlaster cards: SoundBlaster 1.0, SoundBlaster 2.0,
1931SoundBlaster Pro
1932
1933port
1934    port # for SB DSP chip (0x220,0x240,0x260)
1935irq
1936    IRQ # for SB DSP chip (5,7,9,10)
1937dma8
1938    DMA # for SB DSP chip (1,3)
1939
1940This module supports multiple cards and autoprobe.
1941
1942The power-management is supported.
1943
1944Module snd-sb16 and snd-sbawe
1945-----------------------------
1946
1947Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1948SoundBlaster AWE 32 (PnP), SoundBlaster AWE 64 PnP
1949
1950mic_agc
1951    Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1952csp
1953    ASP/CSP chip support - 0 = disable (default), 1 = enable
1954isapnp
1955    ISA PnP detection - 0 = disable, 1 = enable (default)
1956
1957with isapnp=0, the following options are available:
1958
1959port
1960    port # for SB DSP 4.x chip (0x220,0x240,0x260)
1961mpu_port
1962    port # for MPU-401 UART (0x300,0x330), -1 = disable
1963awe_port
1964    base port # for EMU8000 synthesizer (0x620,0x640,0x660) (snd-sbawe
1965    module only)
1966irq
1967    IRQ # for SB DSP 4.x chip (5,7,9,10)
1968dma8
1969    8-bit DMA # for SB DSP 4.x chip (0,1,3)
1970dma16
1971    16-bit DMA # for SB DSP 4.x chip (5,6,7)
1972
1973This module supports multiple cards, autoprobe and ISA PnP.
1974
1975Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1976disable 16bit DMA with dma16 = -1 module parameter.
1977Also, all Sound Blaster 16 type cards can operate in 16-bit
1978half duplex mode through 8-bit DMA channel by disabling their
197916-bit DMA channel.
1980
1981The power-management is supported.
1982
1983Module snd-sc6000
1984-----------------
1985
1986Module for Gallant SC-6000 soundcard and later models: SC-6600 and
1987SC-7000.
1988
1989port
1990    Port # (0x220 or 0x240)
1991mss_port
1992    MSS Port # (0x530 or 0xe80)
1993irq
1994    IRQ # (5,7,9,10,11)
1995mpu_irq
1996    MPU-401 IRQ # (5,7,9,10) ,0 - no MPU-401 irq
1997dma
1998    DMA # (1,3,0)
1999joystick
2000    Enable gameport - 0 = disable (default), 1 = enable
2001
2002This module supports multiple cards.
2003
2004This card is also known as Audio Excel DSP 16 or Zoltrix AV302.
2005
2006Module snd-sscape
2007-----------------
2008
2009Module for ENSONIQ SoundScape cards.
2010
2011port
2012    Port # (PnP setup)
2013wss_port
2014    WSS Port # (PnP setup)
2015irq
2016    IRQ # (PnP setup)
2017mpu_irq
2018    MPU-401 IRQ # (PnP setup)
2019dma
2020    DMA # (PnP setup)
2021dma2
2022    2nd DMA # (PnP setup, -1 to disable)
2023joystick
2024    Enable gameport - 0 = disable (default), 1 = enable
2025
2026This module supports multiple cards.
2027
2028The driver requires the firmware loader support on kernel.
2029
2030Module snd-sun-amd7930 (on sparc only)
2031--------------------------------------
2032
2033Module for AMD7930 sound chips found on Sparcs.
2034
2035This module supports multiple cards.
2036
2037Module snd-sun-cs4231 (on sparc only)
2038-------------------------------------
2039
2040Module for CS4231 sound chips found on Sparcs.
2041
2042This module supports multiple cards.
2043
2044Module snd-sun-dbri (on sparc only)
2045-----------------------------------
2046
2047Module for DBRI sound chips found on Sparcs.
2048
2049This module supports multiple cards.
2050
2051Module snd-wavefront
2052--------------------
2053
2054Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
2055
2056use_cs4232_midi
2057    Use CS4232 MPU-401 interface
2058    (inaccessibly located inside your computer)
2059isapnp
2060    ISA PnP detection - 0 = disable, 1 = enable (default)
2061
2062with isapnp=0, the following options are available:
2063
2064cs4232_pcm_port
2065    Port # for CS4232 PCM interface.
2066cs4232_pcm_irq
2067    IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
2068cs4232_mpu_port
2069    Port # for CS4232 MPU-401 interface.
2070cs4232_mpu_irq
2071    IRQ # for CS4232 MPU-401 interface (9,11,12,15).
2072ics2115_port
2073    Port # for ICS2115
2074ics2115_irq
2075    IRQ # for ICS2115
2076fm_port
2077    FM OPL-3 Port #
2078dma1
2079    DMA1 # for CS4232 PCM interface.
2080dma2
2081    DMA2 # for CS4232 PCM interface.
2082
2083The below are options for wavefront_synth features:
2084
2085wf_raw
2086    Assume that we need to boot the OS (default:no);
2087    If yes, then during driver loading, the state of the board is
2088    ignored, and we reset the board and load the firmware anyway.
2089fx_raw
2090    Assume that the FX process needs help (default:yes);
2091    If false, we'll leave the FX processor in whatever state it is
2092    when the driver is loaded.  The default is to download the
2093    microprogram and associated coefficients to set it up for
2094    "default" operation, whatever that means.
2095debug_default
2096    Debug parameters for card initialization
2097wait_usecs
2098    How long to wait without sleeping, usecs (default:150);
2099    This magic number seems to give pretty optimal throughput
2100    based on my limited experimentation.
2101    If you want to play around with it and find a better value, be
2102    my guest. Remember, the idea is to get a number that causes us
2103    to just busy wait for as many WaveFront commands as possible,
2104    without coming up with a number so large that we hog the whole
2105    CPU.
2106    Specifically, with this number, out of about 134,000 status
2107    waits, only about 250 result in a sleep.
2108sleep_interval
2109    How long to sleep when waiting for reply (default: 100)
2110sleep_tries
2111    How many times to try sleeping during a wait (default: 50)
2112ospath
2113    Pathname to processed ICS2115 OS firmware (default:wavefront.os);
2114    The path name of the ISC2115 OS firmware.  In the recent
2115    version, it's handled via firmware loader framework, so it
2116    must be installed in the proper path, typically,
2117    /lib/firmware.
2118reset_time
2119    How long to wait for a reset to take effect (default:2)
2120ramcheck_time
2121    How many seconds to wait for the RAM test (default:20)
2122osrun_time
2123    How many seconds to wait for the ICS2115 OS (default:10)
2124
2125This module supports multiple cards and ISA PnP.
2126
2127Note: the firmware file ``wavefront.os`` was located in the earlier
2128version in /etc.  Now it's loaded via firmware loader, and
2129must be in the proper firmware path, such as /lib/firmware.
2130Copy (or symlink) the file appropriately if you get an error
2131regarding firmware downloading after upgrading the kernel.
2132
2133Module snd-sonicvibes
2134---------------------
2135
2136Module for S3 SonicVibes PCI sound cards.
2137* PINE Schubert 32 PCI
2138
2139reverb
2140    Reverb Enable - 1 = enable, 0 = disable (default);
2141    SoundCard must have onboard SRAM for this.
2142mge
2143    Mic Gain Enable - 1 = enable, 0 = disable (default)
2144
2145This module supports multiple cards and autoprobe.
2146
2147Module snd-serial-u16550
2148------------------------
2149
2150Module for UART16550A serial MIDI ports.
2151
2152port
2153    port # for UART16550A chip
2154irq
2155    IRQ # for UART16550A chip, -1 = poll mode
2156speed
2157    speed in bauds (9600,19200,38400,57600,115200)
2158    38400 = default
2159base
2160    base for divisor in bauds (57600,115200,230400,460800)
2161    115200 = default
2162outs
2163    number of MIDI ports in a serial port (1-4)
2164    1 = default
2165adaptor
2166    Type of adaptor.
2167	0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
2168	3 = MS-124W M/B, 4 = Generic
2169
2170This module supports multiple cards. This module does not support autoprobe
2171thus the main port must be specified!!! Other options are optional.
2172
2173Module snd-trident
2174------------------
2175
2176Module for Trident 4DWave DX/NX sound cards.
2177* Best Union  Miss Melody 4DWave PCI
2178* HIS  4DWave PCI
2179* Warpspeed  ONSpeed 4DWave PCI
2180* AzTech  PCI 64-Q3D
2181* Addonics  SV 750
2182* CHIC  True Sound 4Dwave
2183* Shark  Predator4D-PCI
2184* Jaton  SonicWave 4D
2185* SiS SI7018 PCI Audio
2186* Hoontech SoundTrack Digital 4DWave NX
2187
2188pcm_channels
2189    max channels (voices) reserved for PCM
2190wavetable_size
2191    max wavetable size in kB (4-?kb)
2192
2193This module supports multiple cards and autoprobe.
2194
2195The power-management is supported.
2196
2197Module snd-ua101
2198----------------
2199
2200Module for the Edirol UA-101/UA-1000 audio/MIDI interfaces.
2201
2202This module supports multiple devices, autoprobe and hotplugging.
2203
2204Module snd-usb-audio
2205--------------------
2206
2207Module for USB audio and USB MIDI devices.
2208
2209vid
2210    Vendor ID for the device (optional)
2211pid
2212    Product ID for the device (optional)
2213nrpacks
2214    Max. number of packets per URB (default: 8)
2215device_setup
2216    Device specific magic number (optional);
2217    Influence depends on the device
2218    Default: 0x0000
2219ignore_ctl_error
2220    Ignore any USB-controller regarding mixer interface (default: no)
2221autoclock
2222    Enable auto-clock selection for UAC2 devices (default: yes)
2223quirk_alias
2224    Quirk alias list, pass strings like ``0123abcd:5678beef``, which
2225    applies the existing quirk for the device 5678:beef to a new
2226    device 0123:abcd.
2227
2228This module supports multiple devices, autoprobe and hotplugging.
2229
2230NB: ``nrpacks`` parameter can be modified dynamically via sysfs.
2231Don't put the value over 20.  Changing via sysfs has no sanity
2232check.
2233
2234NB: ``ignore_ctl_error=1`` may help when you get an error at accessing
2235the mixer element such as URB error -22.  This happens on some
2236buggy USB device or the controller.
2237
2238NB: quirk_alias option is provided only for testing / development.
2239If you want to have a proper support, contact to upstream for
2240adding the matching quirk in the driver code statically.
2241
2242Module snd-usb-caiaq
2243--------------------
2244
2245Module for caiaq UB audio interfaces,
2246
2247* Native Instruments RigKontrol2
2248* Native Instruments Kore Controller
2249* Native Instruments Audio Kontrol 1
2250* Native Instruments Audio 8 DJ
2251
2252This module supports multiple devices, autoprobe and hotplugging.
2253
2254Module snd-usb-usx2y
2255--------------------
2256
2257Module for Tascam USB US-122, US-224 and US-428 devices.
2258
2259This module supports multiple devices, autoprobe and hotplugging.
2260
2261Note: you need to load the firmware via ``usx2yloader`` utility included
2262in alsa-tools and alsa-firmware packages.
2263
2264Module snd-via82xx
2265------------------
2266
2267Module for AC'97 motherboards based on VIA 82C686A/686B, 8233, 8233A,
22688233C, 8235, 8237 (south) bridge.
2269
2270mpu_port
2271    0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
2272    [VIA686A/686B only]
2273joystick
2274    Enable joystick (default off) [VIA686A/686B only]
2275ac97_clock
2276    AC'97 codec clock base (default 48000Hz)
2277dxs_support
2278    support DXS channels, 0 = auto (default), 1 = enable, 2 = disable,
2279    3 = 48k only, 4 = no VRA, 5 = enable any sample rate and different
2280    sample rates on different channels [VIA8233/C, 8235, 8237 only]
2281ac97_quirk
2282    AC'97 workaround for strange hardware;
2283    See `AC97 Quirk Option`_ section below.
2284
2285This module supports one chip and autoprobe.
2286
2287Note: on some SMP motherboards like MSI 694D the interrupts might
2288not be generated properly.  In such a case, please try to
2289set the SMP (or MPS) version on BIOS to 1.1 instead of
2290default value 1.4.  Then the interrupt number will be
2291assigned under 15. You might also upgrade your BIOS.
2292
2293Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
2294channels as the first PCM.  On these channels, up to 4
2295streams can be played at the same time, and the controller
2296can perform sample rate conversion with separate rates for
2297each channel.
2298As default (``dxs_support = 0``), 48k fixed rate is chosen
2299except for the known devices since the output is often
2300noisy except for 48k on some mother boards due to the
2301bug of BIOS.
2302Please try once ``dxs_support=5`` and if it works on other
2303sample rates (e.g. 44.1kHz of mp3 playback), please let us
2304know the PCI subsystem vendor/device id's (output of
2305``lspci -nv``).
2306If ``dxs_support=5`` does not work, try ``dxs_support=4``; if it
2307doesn't work too, try dxs_support=1.  (dxs_support=1 is
2308usually for old motherboards.  The correct implemented
2309board should work with 4 or 5.)  If it still doesn't
2310work and the default setting is ok, ``dxs_support=3`` is the
2311right choice.  If the default setting doesn't work at all,
2312try ``dxs_support=2`` to disable the DXS channels.
2313In any cases, please let us know the result and the
2314subsystem vendor/device ids.  See `Links and Addresses`_
2315below.
2316
2317Note: for the MPU401 on VIA823x, use snd-mpu401 driver
2318additionally.  The mpu_port option is for VIA686 chips only.
2319
2320The power-management is supported.
2321
2322Module snd-via82xx-modem
2323------------------------
2324
2325Module for VIA82xx AC97 modem
2326
2327ac97_clock
2328    AC'97 codec clock base (default 48000Hz)
2329
2330This module supports one card and autoprobe.
2331
2332Note: The default index value of this module is -2, i.e. the first
2333slot is excluded.
2334
2335The power-management is supported.
2336
2337Module snd-virmidi
2338------------------
2339
2340Module for virtual rawmidi devices.
2341This module creates virtual rawmidi devices which communicate
2342to the corresponding ALSA sequencer ports.
2343
2344midi_devs
2345    MIDI devices # (1-4, default=4)
2346
2347This module supports multiple cards.
2348
2349Module snd-virtuoso
2350-------------------
2351
2352Module for sound cards based on the Asus AV66/AV100/AV200 chips,
2353i.e., Xonar D1, DX, D2, D2X, DS, DSX, Essence ST (Deluxe),
2354Essence STX (II), HDAV1.3 (Deluxe), and HDAV1.3 Slim.
2355
2356This module supports autoprobe and multiple cards.
2357
2358Module snd-vx222
2359----------------
2360
2361Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
2362
2363mic
2364    Enable Microphone on V222 Mic (NYI)
2365ibl
2366    Capture IBL size. (default = 0, minimum size)
2367
2368This module supports multiple cards.
2369
2370When the driver is compiled as a module and the hotplug firmware
2371is supported, the firmware data is loaded via hotplug automatically.
2372Install the necessary firmware files in alsa-firmware package.
2373When no hotplug fw loader is available, you need to load the
2374firmware via vxloader utility in alsa-tools package.  To invoke
2375vxloader automatically, add the following to /etc/modprobe.d/alsa.conf
2376
2377::
2378
2379  install snd-vx222 /sbin/modprobe --first-time -i snd-vx222\
2380    && /usr/bin/vxloader
2381
2382(for 2.2/2.4 kernels, add ``post-install /usr/bin/vxloader`` to
2383/etc/modules.conf, instead.)
2384IBL size defines the interrupts period for PCM.  The smaller size
2385gives smaller latency but leads to more CPU consumption, too.
2386The size is usually aligned to 126.  As default (=0), the smallest
2387size is chosen.  The possible IBL values can be found in
2388/proc/asound/cardX/vx-status proc file.
2389
2390The power-management is supported.
2391
2392Module snd-vxpocket
2393-------------------
2394
2395Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
2396
2397ibl
2398    Capture IBL size. (default = 0, minimum size)
2399
2400This module supports multiple cards.  The module is compiled only when
2401PCMCIA is supported on kernel.
2402
2403With the older 2.6.x kernel, to activate the driver via the card
2404manager, you'll need to set up /etc/pcmcia/vxpocket.conf.  See the
2405sound/pcmcia/vx/vxpocket.c.  2.6.13 or later kernel requires no
2406longer require a config file.
2407
2408When the driver is compiled as a module and the hotplug firmware
2409is supported, the firmware data is loaded via hotplug automatically.
2410Install the necessary firmware files in alsa-firmware package.
2411When no hotplug fw loader is available, you need to load the
2412firmware via vxloader utility in alsa-tools package.
2413
2414About capture IBL, see the description of snd-vx222 module.
2415
2416Note: snd-vxp440 driver is merged to snd-vxpocket driver since
2417ALSA 1.0.10.
2418
2419The power-management is supported.
2420
2421Module snd-ymfpci
2422-----------------
2423
2424Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
2425
2426mpu_port
2427    0x300,0x330,0x332,0x334, 0 (disable) by default,
2428    1 (auto-detect for YMF744/754 only)
2429fm_port
2430    0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
2431    1 (auto-detect for YMF744/754 only)
2432joystick_port
2433    0x201,0x202,0x204,0x205, 0 (disable) by default,
2434    1 (auto-detect)
2435rear_switch
2436    enable shared rear/line-in switch (bool)
2437
2438This module supports autoprobe and multiple chips.
2439
2440The power-management is supported.
2441
2442Module snd-pdaudiocf
2443--------------------
2444
2445Module for Sound Core PDAudioCF sound card.
2446
2447The power-management is supported.
2448
2449
2450AC97 Quirk Option
2451=================
2452
2453The ac97_quirk option is used to enable/override the workaround for
2454specific devices on drivers for on-board AC'97 controllers like
2455snd-intel8x0.  Some hardware have swapped output pins between Master
2456and Headphone, or Surround (thanks to confusion of AC'97
2457specifications from version to version :-)
2458
2459The driver provides the auto-detection of known problematic devices,
2460but some might be unknown or wrongly detected.  In such a case, pass
2461the proper value with this option.
2462
2463The following strings are accepted:
2464
2465default
2466    Don't override the default setting
2467none
2468    Disable the quirk
2469hp_only
2470    Bind Master and Headphone controls as a single control
2471swap_hp
2472    Swap headphone and master controls
2473swap_surround
2474    Swap master and surround controls
2475ad_sharing
2476    For AD1985, turn on OMS bit and use headphone
2477alc_jack
2478    For ALC65x, turn on the jack sense mode
2479inv_eapd
2480    Inverted EAPD implementation
2481mute_led
2482    Bind EAPD bit for turning on/off mute LED
2483
2484For backward compatibility, the corresponding integer value -1, 0, ...
2485are  accepted, too.
2486
2487For example, if ``Master`` volume control has no effect on your device
2488but only ``Headphone`` does, pass ac97_quirk=hp_only module option.
2489
2490
2491Configuring Non-ISAPNP Cards
2492============================
2493
2494When the kernel is configured with ISA-PnP support, the modules
2495supporting the isapnp cards will have module options ``isapnp``.
2496If this option is set, *only* the ISA-PnP devices will be probed.
2497For probing the non ISA-PnP cards, you have to pass ``isapnp=0`` option
2498together with the proper i/o and irq configuration.
2499
2500When the kernel is configured without ISA-PnP support, isapnp option
2501will be not built in.
2502
2503
2504Module Autoloading Support
2505==========================
2506
2507The ALSA drivers can be loaded automatically on demand by defining
2508module aliases.  The string ``snd-card-%1`` is requested for ALSA native
2509devices where ``%i`` is sound card number from zero to seven.
2510
2511To auto-load an ALSA driver for OSS services, define the string
2512``sound-slot-%i`` where ``%i`` means the slot number for OSS, which
2513corresponds to the card index of ALSA.  Usually, define this
2514as the same card module.
2515
2516An example configuration for a single emu10k1 card is like below:
2517::
2518
2519    ----- /etc/modprobe.d/alsa.conf
2520    alias snd-card-0 snd-emu10k1
2521    alias sound-slot-0 snd-emu10k1
2522    ----- /etc/modprobe.d/alsa.conf
2523
2524The available number of auto-loaded sound cards depends on the module
2525option ``cards_limit`` of snd module.  As default it's set to 1.
2526To enable the auto-loading of multiple cards, specify the number of
2527sound cards in that option.
2528
2529When multiple cards are available, it'd better to specify the index
2530number for each card via module option, too, so that the order of
2531cards is kept consistent.
2532
2533An example configuration for two sound cards is like below:
2534::
2535
2536    ----- /etc/modprobe.d/alsa.conf
2537    # ALSA portion
2538    options snd cards_limit=2
2539    alias snd-card-0 snd-interwave
2540    alias snd-card-1 snd-ens1371
2541    options snd-interwave index=0
2542    options snd-ens1371 index=1
2543    # OSS/Free portion
2544    alias sound-slot-0 snd-interwave
2545    alias sound-slot-1 snd-ens1371
2546    ----- /etc/modprobe.d/alsa.conf
2547
2548In this example, the interwave card is always loaded as the first card
2549(index 0) and ens1371 as the second (index 1).
2550
2551Alternative (and new) way to fixate the slot assignment is to use
2552``slots`` option of snd module.  In the case above, specify like the
2553following:
2554::
2555
2556    options snd slots=snd-interwave,snd-ens1371
2557
2558Then, the first slot (#0) is reserved for snd-interwave driver, and
2559the second (#1) for snd-ens1371.  You can omit index option in each
2560driver if slots option is used (although you can still have them at
2561the same time as long as they don't conflict).
2562
2563The slots option is especially useful for avoiding the possible
2564hot-plugging and the resultant slot conflict.  For example, in the
2565case above again, the first two slots are already reserved.  If any
2566other driver (e.g. snd-usb-audio) is loaded before snd-interwave or
2567snd-ens1371, it will be assigned to the third or later slot.
2568
2569When a module name is given with '!', the slot will be given for any
2570modules but that name.  For example, ``slots=!snd-pcsp`` will reserve
2571the first slot for any modules but snd-pcsp.
2572
2573
2574ALSA PCM devices to OSS devices mapping
2575=======================================
2576::
2577
2578    /dev/snd/pcmC0D0[c|p]  -> /dev/audio0 (/dev/audio) -> minor 4
2579    /dev/snd/pcmC0D0[c|p]  -> /dev/dsp0 (/dev/dsp)     -> minor 3
2580    /dev/snd/pcmC0D1[c|p]  -> /dev/adsp0 (/dev/adsp)   -> minor 12
2581    /dev/snd/pcmC1D0[c|p]  -> /dev/audio1              -> minor 4+16 = 20
2582    /dev/snd/pcmC1D0[c|p]  -> /dev/dsp1                -> minor 3+16 = 19
2583    /dev/snd/pcmC1D1[c|p]  -> /dev/adsp1               -> minor 12+16 = 28
2584    /dev/snd/pcmC2D0[c|p]  -> /dev/audio2              -> minor 4+32 = 36
2585    /dev/snd/pcmC2D0[c|p]  -> /dev/dsp2                -> minor 3+32 = 39
2586    /dev/snd/pcmC2D1[c|p]  -> /dev/adsp2               -> minor 12+32 = 44
2587
2588The first number from ``/dev/snd/pcmC{X}D{Y}[c|p]`` expression means
2589sound card number and second means device number.  The ALSA devices
2590have either ``c`` or ``p`` suffix indicating the direction, capture and
2591playback, respectively.
2592
2593Please note that the device mapping above may be varied via the module
2594options of snd-pcm-oss module.
2595
2596
2597Proc interfaces (/proc/asound)
2598==============================
2599
2600/proc/asound/card#/pcm#[cp]/oss
2601-------------------------------
2602erase
2603    erase all additional information about OSS applications
2604
2605<app_name> <fragments> <fragment_size> [<options>]
2606    <app_name>
2607	name of application with (higher priority) or without path
2608    <fragments>
2609	 number of fragments or zero if auto
2610    <fragment_size>
2611	 size of fragment in bytes or zero if auto
2612    <options>
2613	optional parameters
2614
2615	disable
2616	    the application tries to open a pcm device for
2617	    this channel but does not want to use it.
2618	    (Cause a bug or mmap needs)
2619	    It's good for Quake etc...
2620	direct
2621	    don't use plugins
2622	block
2623	     force block mode (rvplayer)
2624	non-block
2625	    force non-block mode
2626	whole-frag
2627	    write only whole fragments (optimization affecting
2628	    playback only)
2629	no-silence
2630	    do not fill silence ahead to avoid clicks
2631	buggy-ptr
2632	    Returns the whitespace blocks in GETOPTR ioctl
2633	    instead of filled blocks
2634
2635Example:
2636::
2637
2638    echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
2639    echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
2640    echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
2641
2642
2643Early Buffer Allocation
2644=======================
2645
2646Some drivers (e.g. hdsp) require the large contiguous buffers, and
2647sometimes it's too late to find such spaces when the driver module is
2648actually loaded due to memory fragmentation.  You can pre-allocate the
2649PCM buffers by loading snd-page-alloc module and write commands to its
2650proc file in prior, for example, in the early boot stage like
2651``/etc/init.d/*.local`` scripts.
2652
2653Reading the proc file /proc/drivers/snd-page-alloc shows the current
2654usage of page allocation.  In writing, you can send the following
2655commands to the snd-page-alloc driver:
2656
2657* add VENDOR DEVICE MASK SIZE BUFFERS
2658
2659VENDOR and DEVICE are PCI vendor and device IDs.  They take
2660integer numbers (0x prefix is needed for the hex).
2661MASK is the PCI DMA mask.  Pass 0 if not restricted.
2662SIZE is the size of each buffer to allocate.  You can pass
2663k and m suffix for KB and MB.  The max number is 16MB.
2664BUFFERS is the number of buffers to allocate.  It must be greater
2665than 0.  The max number is 4.
2666
2667* erase
2668
2669This will erase the all pre-allocated buffers which are not in
2670use.
2671
2672
2673Links and Addresses
2674===================
2675
2676ALSA project homepage
2677    http://www.alsa-project.org
2678Kernel Bugzilla
2679    http://bugzilla.kernel.org/
2680ALSA Developers ML
2681    mailto:alsa-devel@alsa-project.org
2682alsa-info.sh script
2683    http://www.alsa-project.org/alsa-info.sh
2684