2 Advanced Linux Sound Architecture - Driver
3 ==========================================
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.
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.
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).
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.
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
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'.
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.
45 Prior to version 0.9.0rc4 options had a 'snd_' prefix. This was removed.
50 The core ALSA module. It is used by all ALSA card drivers.
51 It takes the following options which have global effects.
53 major - major number for sound driver
56 - limiting card index for auto-loading (1-8)
58 - For auto-loading more than one card, specify this
59 option together with snd-card-X aliases.
60 slots - Reserve the slot index for the given driver.
61 This option takes multiple strings.
62 See "Module Autoloading Support" section for details.
67 The PCM OSS emulation module.
68 This module takes options which change the mapping of devices.
70 dsp_map - PCM device number maps assigned to the 1st OSS device.
72 adsp_map - PCM device number maps assigned to the 2st OSS device.
75 - Don't block opening busy PCM devices. Default: 1
77 For example, when dsp_map=2, /dev/dsp will be mapped to PCM #2 of
78 the card #0. Similarly, when adsp_map=0, /dev/adsp will be mapped
79 to PCM #0 of the card #0.
80 For changing the second or later card, specify the option with
81 commas, such like "dsp_map=0,1".
83 nonblock_open option is used to change the behavior of the PCM
84 regarding opening the device. When this option is non-zero,
85 opening a busy OSS PCM device won't be blocked but return
86 immediately with EAGAIN (just like O_NONBLOCK flag).
91 This module takes options which change the mapping of devices.
92 similar to those of the snd-pcm-oss module.
94 midi_map - MIDI device number maps assigned to the 1st OSS device.
96 amidi_map - MIDI device number maps assigned to the 2st OSS device.
99 Common parameters for top sound card modules
100 --------------------------------------------
102 Each of top level sound card module takes the following options.
104 index - index (slot #) of sound card
105 - Values: 0 through 31 or negative
106 - If nonnegative, assign that index number
107 - if negative, interpret as a bitmask of permissible
108 indices; the first free permitted index is assigned
110 id - card ID (identifier or name)
111 - Can be up to 15 characters long
112 - Default: the card type
113 - A directory by this name is created under /proc/asound/
114 containing information about the card
115 - This ID can be used instead of the index number in
118 - Default: enabled, for PCI and ISA PnP cards
123 Module for AdLib FM cards.
125 port - port # for OPL chip
127 This module supports multiple cards. It does not support autoprobe, so
128 the port must be specified. For actual AdLib FM cards it will be 0x388.
129 Note that this card does not have PCM support and no mixer; only FM
132 Make sure you have "sbiload" from the alsa-tools package available and,
133 after loading the module, find out the assigned ALSA sequencer port
134 number through "sbiload -l". Example output:
136 Port Client name Port name
137 64:0 OPL2 FM synth OPL2 FM Port
139 Load the std.sb and drums.sb patches also supplied by sbiload:
141 sbiload -p 64:0 std.sb drums.sb
143 If you use this driver to drive an OPL3, you can use std.o3 and drums.o3
144 instead. To have the card produce sound, use aplaymidi from alsa-utils:
146 aplaymidi -p 64:0 foo.mid
151 Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips.
153 clockfreq - Clock frequency for AD1816A chip (default = 0, 33000Hz)
155 This module supports multiple cards, autoprobe and PnP.
160 Module for sound cards based on AD1848/AD1847/CS4248 ISA chips.
162 port - port # for AD1848 chip
163 irq - IRQ # for AD1848 chip
164 dma1 - DMA # for AD1848 chip (0,1,3)
166 This module supports multiple cards. It does not support autoprobe
167 thus main port must be specified!!! Other ports are optional.
169 The power-management is supported.
174 Module for Analog Devices AD1889 chips.
176 ac97_quirk - AC'97 workaround for strange hardware
177 See the description of intel8x0 module for details.
179 This module supports multiple cards.
184 Module for ALi M5451 PCI chip.
186 pcm_channels - Number of hardware channels assigned for PCM
187 spdif - Support SPDIF I/O
190 This module supports one chip and autoprobe.
192 The power-management is supported.
197 Module for sound cards based on Avance Logic ALS100/ALS120 ISA chips.
199 This module supports multiple cards, autoprobe and PnP.
201 The power-management is supported.
206 Module for Avance Logic ALS300 and ALS300+
208 This module supports multiple cards.
210 The power-management is supported.
215 Module for sound cards based on Avance Logic ALS4000 PCI chip.
217 joystick_port - port # for legacy joystick support.
218 0 = disabled (default), 1 = auto-detect
220 This module supports multiple cards, autoprobe and PnP.
222 The power-management is supported.
227 Module for ATI IXP 150/200/250/400 AC97 controllers.
229 ac97_clock - AC'97 clock (default = 48000)
230 ac97_quirk - AC'97 workaround for strange hardware
231 See "AC97 Quirk Option" section below.
232 ac97_codec - Workaround to specify which AC'97 codec
233 instead of probing. If this works for you
234 file a bug with your `lspci -vn` output.
236 -1 -- Default behavior.
237 0-2 -- Use the specified codec.
238 spdif_aclink - S/PDIF transfer over AC-link (default = 1)
240 This module supports one card and autoprobe.
242 ATI IXP has two different methods to control SPDIF output. One is
243 over AC-link and another is over the "direct" SPDIF output. The
244 implementation depends on the motherboard, and you'll need to
245 choose the correct one via spdif_aclink module option.
247 The power-management is supported.
249 Module snd-atiixp-modem
250 -----------------------
252 Module for ATI IXP 150/200/250 AC97 modem controllers.
254 This module supports one card and autoprobe.
256 Note: The default index value of this module is -2, i.e. the first
259 The power-management is supported.
261 Module snd-au8810, snd-au8820, snd-au8830
262 -----------------------------------------
264 Module for Aureal Vortex, Vortex2 and Advantage device.
266 pcifix - Control PCI workarounds
267 0 = Disable all workarounds
268 1 = Force the PCI latency of the Aureal card to 0xff
269 2 = Force the Extend PCI#2 Internal Master for Efficient
270 Handling of Dummy Requests on the VIA KT133 AGP Bridge
271 3 = Force both settings
272 255 = Autodetect what is required (default)
274 This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
275 EQ, mpu401, gameport. A3D and wavetable support are still in development.
276 Development and reverse engineering work is being coordinated at
277 http://savannah.nongnu.org/projects/openvortex/
278 SPDIF output has a copy of the AC97 codec output, unless you use the
279 "spdif" pcm device, which allows raw data passthru.
280 The hardware EQ hardware and SPDIF is only present in the Vortex2 and
283 Note: Some ALSA mixer applications don't handle the SPDIF sample rate
284 control correctly. If you have problems regarding this, try
285 another ALSA compliant mixer (alsamixer works).
290 Module for Audiowerk2 sound card
292 This module supports multiple cards.
297 Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
299 This module supports multiple cards, PnP and autoprobe.
301 The power-management is supported.
306 Module for sound cards based on Aztech AZF3328 PCI chip.
308 joystick - Enable joystick (default off)
310 This module supports multiple cards.
315 Module for video cards based on Bt87x chips.
317 digital_rate - Override the default digital rate (Hz)
318 load_all - Load the driver even if the card model isn't known
320 This module supports multiple cards.
322 Note: The default index value of this module is -2, i.e. the first
328 Module for Creative Audigy LS and SB Live 24bit
330 This module supports multiple cards.
336 Module for sound cards based on C-Media CMI8330 ISA chips.
338 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
340 with isapnp=0, the following options are available:
342 wssport - port # for CMI8330 chip (WSS)
343 wssirq - IRQ # for CMI8330 chip (WSS)
344 wssdma - first DMA # for CMI8330 chip (WSS)
345 sbport - port # for CMI8330 chip (SB16)
346 sbirq - IRQ # for CMI8330 chip (SB16)
347 sbdma8 - 8bit DMA # for CMI8330 chip (SB16)
348 sbdma16 - 16bit DMA # for CMI8330 chip (SB16)
349 fmport - (optional) OPL3 I/O port
350 mpuport - (optional) MPU401 I/O port
351 mpuirq - (optional) MPU401 irq #
353 This module supports multiple cards and autoprobe.
355 The power-management is supported.
360 Module for C-Media CMI8338/8738/8768/8770 PCI sound cards.
362 mpu_port - port address of MIDI interface (8338 only):
363 0x300,0x310,0x320,0x330 = legacy port,
364 0 = disable (default)
365 fm_port - port address of OPL-3 FM synthesizer (8x38 only):
367 1 = integrated PCI port (default on 8738),
369 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
371 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
373 This module supports autoprobe and multiple cards.
375 The power-management is supported.
380 Module for sound cards based on CS4231 ISA chips.
382 port - port # for CS4231 chip
383 mpu_port - port # for MPU-401 UART (optional), -1 = disable
384 irq - IRQ # for CS4231 chip
385 mpu_irq - IRQ # for MPU-401 UART
386 dma1 - first DMA # for CS4231 chip
387 dma2 - second DMA # for CS4231 chip
389 This module supports multiple cards. This module does not support autoprobe
390 thus main port must be specified!!! Other ports are optional.
392 The power-management is supported.
397 Module for sound cards based on CS4232/CS4232A,
398 CS4235/CS4236/CS4236B/CS4237B/
399 CS4238B/CS4239 ISA chips.
401 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
403 with isapnp=0, the following options are available:
405 port - port # for CS4236 chip (PnP setup - 0x534)
406 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
407 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
408 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
409 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
410 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
411 dma1 - first DMA # for CS4236 chip (0,1,3)
412 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
414 This module supports multiple cards. This module does not support autoprobe
415 (if ISA PnP is not used) thus main port and control port must be
416 specified!!! Other ports are optional.
418 The power-management is supported.
420 This module is aliased as snd-cs4232 since it provides the old
421 snd-cs4232 functionality, too.
426 Module for Cirrus Logic CS4281 soundchip.
428 dual_codec - Secondary codec ID (0 = disable, default)
430 This module supports multiple cards.
432 The power-management is supported.
437 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
438 CS4624/CS4630/CS4280 PCI chips.
440 external_amp - Force to enable external amplifier.
441 thinkpad - Force to enable Thinkpad's CLKRUN control.
442 mmap_valid - Support OSS mmap mode (default = 0).
444 This module supports multiple cards and autoprobe.
445 Usually external amp and CLKRUN controls are detected automatically
446 from PCI sub vendor/device ids. If they don't work, give the options
449 The power-management is supported.
454 Module for Cyrix/NatSemi Geode 5530 chip.
456 Module snd-cs5535audio
457 ----------------------
459 Module for multifunction CS5535 companion PCI device
461 The power-management is supported.
466 Module for Echoaudio Darla20
468 This module supports multiple cards.
469 The driver requires the firmware loader support on kernel.
474 Module for Echoaudio Darla24
476 This module supports multiple cards.
477 The driver requires the firmware loader support on kernel.
482 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
485 This module supports multiple cards. This module is enabled only with
488 The power-management is supported.
493 Module for the dummy sound card. This "card" doesn't do any output
494 or input, but you may use this module for any application which
495 requires a sound card (like RealPlayer).
497 The power-management is supported.
502 Module for Echoaudio 3G cards (Gina3G/Layla3G)
504 This module supports multiple cards.
505 The driver requires the firmware loader support on kernel.
510 Module for EMU10K1/EMU10k2 based PCI sound cards.
511 * Sound Blaster Live!
512 * Sound Blaster PCI 512
513 * Emu APS (partially supported)
514 * Sound Blaster Audigy
516 extin - bitmap of available external inputs for FX8010 (see bellow)
517 extout - bitmap of available external outputs for FX8010 (see bellow)
518 seq_ports - allocated sequencer ports (4 by default)
519 max_synth_voices - limit of voices used for wavetable (64 by default)
520 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
521 given in MB unit. Default value is 128.
522 enable_ir - enable IR
524 This module supports multiple cards and autoprobe.
526 Input & Output configurations [extin/extout]
527 * Creative Card wo/Digital out [0x0003/0x1f03]
528 * Creative Card w/Digital out [0x0003/0x1f0f]
529 * Creative Card w/Digital CD in [0x000f/0x1f0f]
530 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
531 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
532 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
533 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
534 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
535 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
536 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
537 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
538 * Creative Card all ins and outs [0x3fff/0x7fff]
540 The power-management is supported.
545 Module for Creative Emu10k1X (SB Live Dell OEM version)
547 This module supports multiple cards.
552 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
553 * SoundBlaster PCI 64
554 * SoundBlaster PCI 128
556 joystick - Enable joystick (default off)
558 This module supports multiple cards and autoprobe.
560 The power-management is supported.
565 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
566 * SoundBlaster PCI 64
567 * SoundBlaster PCI 128
568 * SoundBlaster Vibra PCI
570 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
571 0 = disable (default), 1 = auto-detect
573 This module supports multiple cards and autoprobe.
575 The power-management is supported.
580 Module for sound cards based on ESS ES968 chip (PnP only).
582 This module supports multiple cards, PnP and autoprobe.
584 The power-management is supported.
589 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
591 port - port # for ES-1688 chip (0x220,0x240,0x260)
592 fm_port - port # for OPL3 (option; share the same port as default)
593 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
594 irq - IRQ # for ES-1688 chip (5,7,9,10)
595 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
596 dma8 - DMA # for ES-1688 chip (0,1,3)
598 This module supports multiple cards and autoprobe (without MPU-401 port).
603 Module for ESS AudioDrive ES-18xx sound cards.
605 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
607 with isapnp=0, the following options are available:
609 port - port # for ES-18xx chip (0x220,0x240,0x260)
610 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
611 fm_port - port # for FM (optional, not used)
612 irq - IRQ # for ES-18xx chip (5,7,9,10)
613 dma1 - first DMA # for ES-18xx chip (0,1,3)
614 dma2 - first DMA # for ES-18xx chip (0,1,3)
616 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
617 port if native ISA PnP routines are not used).
618 When dma2 is equal with dma1, the driver works as half-duplex.
620 The power-management is supported.
625 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
627 This module supports multiple cards and autoprobe.
629 The power-management is supported.
634 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
636 total_bufsize - total buffer size in kB (1-4096kB)
637 pcm_substreams_p - playback channels (1-8, default=2)
638 pcm_substreams_c - capture channels (1-8, default=0)
639 clock - clock (0 = auto-detection)
640 use_pm - support the power-management (0 = off, 1 = on,
642 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
643 joystick - enable joystick (default off)
645 This module supports multiple cards and autoprobe.
647 The power-management is supported.
652 Module for ForteMedia FM801 based PCI sound cards.
654 tea575x_tuner - Enable TEA575x tuner
655 - 1 = MediaForte 256-PCS
656 - 2 = MediaForte 256-PCPR
657 - 3 = MediaForte 64-PCR
658 - High 16-bits are video (radio) device number + 1
659 - example: 0x10002 (MediaForte 256-PCPR, device 1)
661 This module supports multiple cards and autoprobe.
663 The power-management is supported.
668 Module for Echoaudio Gina20
670 This module supports multiple cards.
671 The driver requires the firmware loader support on kernel.
676 Module for Echoaudio Gina24
678 This module supports multiple cards.
679 The driver requires the firmware loader support on kernel.
681 Module snd-gusclassic
682 ---------------------
684 Module for Gravis UltraSound Classic sound card.
686 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
687 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
688 dma1 - DMA # for GF1 chip (1,3,5,6,7)
689 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
690 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
691 voices - GF1 voices limit (14-32)
692 pcm_voices - reserved PCM voices
694 This module supports multiple cards and autoprobe.
696 Module snd-gusextreme
697 ---------------------
699 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
701 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
702 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
703 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
704 irq - IRQ # for ES-1688 chip (5,7,9,10)
705 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
706 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
707 dma8 - DMA # for ES-1688 chip (0,1,3)
708 dma1 - DMA # for GF1 chip (1,3,5,6,7)
709 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
710 voices - GF1 voices limit (14-32)
711 pcm_voices - reserved PCM voices
713 This module supports multiple cards and autoprobe (without MPU-401 port).
718 Module for Gravis UltraSound MAX sound card.
720 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
721 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
722 dma1 - DMA # for GF1 chip (1,3,5,6,7)
723 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
724 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
725 voices - GF1 voices limit (14-32)
726 pcm_voices - reserved PCM voices
728 This module supports multiple cards and autoprobe.
733 Module for Intel HD Audio (ICH6, ICH6M, ESB2, ICH7, ICH8, ICH9, ICH10,
735 ATI SB450, SB600, R600, RS600, RS690, RS780, RV610, RV620,
736 RV630, RV635, RV670, RV770,
740 [Multiple options for each card instance]
741 model - force the model name
742 position_fix - Fix DMA pointer (0 = auto, 1 = use LPIB, 2 = POSBUF)
743 probe_mask - Bitmask to probe codecs (default = -1, meaning all slots)
744 probe_only - Only probing and no codec initialization (default=off);
745 Useful to check the initial codec status for debugging
746 bdl_pos_adj - Specifies the DMA IRQ timing delay in samples.
747 Passing -1 will make the driver to choose the appropriate
748 value based on the controller chip.
750 [Single (global) options]
751 single_cmd - Use single immediate commands to communicate with
752 codecs (for debugging only)
753 enable_msi - Enable Message Signaled Interrupt (MSI) (default = off)
754 power_save - Automatic power-saving timtout (in second, 0 =
756 power_save_controller - Reset HD-audio controller in power-saving mode
759 This module supports multiple cards and autoprobe.
761 See Documentation/sound/alsa/HD-Audio.txt for more details about
764 Each codec may have a model table for different configurations.
765 If your machine isn't listed there, the default (usually minimal)
766 configuration is set up. You can pass "model=<name>" option to
767 specify a certain model in such a case. There are different
768 models depending on the codec chip. The list of available models
769 is found in HD-Audio-Models.txt
771 The model name "genric" is treated as a special case. When this
772 model is given, the driver uses the generic codec parser without
773 "codec-patch". It's sometimes good for testing and debugging.
775 If the default configuration doesn't work and one of the above
776 matches with your device, report it together with alsa-info.sh
777 output (with --no-upload option) to kernel bugzilla or alsa-devel
778 ML (see the section "Links and Addresses").
780 power_save and power_save_controller options are for power-saving
781 mode. See powersave.txt for details.
783 Note 2: If you get click noises on output, try the module option
784 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
785 register value without FIFO size correction as the current
786 DMA pointer. position_fix=2 will make the driver to use
787 the position buffer instead of reading SD_LPIB register.
788 (Usually SD_LPIB register is more accurate than the
791 NB: If you get many "azx_get_response timeout" messages at
792 loading, it's likely a problem of interrupts (e.g. ACPI irq
793 routing). Try to boot with options like "pci=noacpi". Also, you
794 can try "single_cmd=1" module option. This will switch the
795 communication method between HDA controller and codecs to the
796 single immediate commands instead of CORB/RIRB. Basically, the
797 single command mode is provided only for BIOS, and you won't get
798 unsolicited events, too. But, at least, this works independently
799 from the irq. Remember this is a last resort, and should be
800 avoided as much as possible...
802 MORE NOTES ON "azx_get_response timeout" PROBLEMS:
803 On some hardwares, you may need to add a proper probe_mask option
804 to avoid the "azx_get_response timeout" problem above, instead.
805 This occurs when the access to non-existing or non-working codec slot
806 (likely a modem one) causes a stall of the communication via HD-audio
807 bus. You can see which codec slots are probed by enabling
808 CONFIG_SND_DEBUG_VERBOSE, or simply from the file name of the codec
809 proc files. Then limit the slots to probe by probe_mask option.
810 For example, probe_mask=1 means to probe only the first slot, and
811 probe_mask=4 means only the third slot.
813 The power-management is supported.
818 Module for RME Hammerfall DSP audio interface(s)
820 This module supports multiple cards.
822 Note: The firmware data can be automatically loaded via hotplug
823 when CONFIG_FW_LOADER is set. Otherwise, you need to load
824 the firmware via hdsploader utility included in alsa-tools
826 The firmware data is found in alsa-firmware package.
828 Note: snd-page-alloc module does the job which snd-hammerfall-mem
829 module did formerly. It will allocate the buffers in advance
830 when any HDSP cards are found. To make the buffer
831 allocation sure, load snd-page-alloc module in the early
832 stage of boot sequence. See "Early Buffer Allocation"
838 Module for RME HDSP MADI board.
840 precise_ptr - Enable precise pointer, or disable.
841 line_outs_monitor - Send playback streams to analog outs by default.
842 enable_monitor - Enable Analog Out on Channel 63/64 by default.
844 See hdspm.txt for details.
849 Module for the MediaTek/TempoTec HiFier Fantasia sound card.
851 This module supports autoprobe and multiple cards.
856 Module for Envy24 (ICE1712) based PCI sound cards.
857 * MidiMan M Audio Delta 1010
858 * MidiMan M Audio Delta 1010LT
859 * MidiMan M Audio Delta DiO 2496
860 * MidiMan M Audio Delta 66
861 * MidiMan M Audio Delta 44
862 * MidiMan M Audio Delta 410
863 * MidiMan M Audio Audiophile 2496
869 * Hoontech SoundTrack DSP 24
870 * Hoontech SoundTrack DSP 24 Value
871 * Hoontech SoundTrack DSP 24 Media 7.1
872 * Event Electronics, EZ8
874 * Lionstracs, Mediastaton
877 model - Use the given board model, one of the following:
878 delta1010, dio2496, delta66, delta44, audiophile, delta410,
879 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
880 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
881 phase88, mediastation
882 omni - Omni I/O support for MidiMan M-Audio Delta44/66
883 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transceiver)
884 in msec resolution, default value is 500 (0.5 sec)
886 This module supports multiple cards and autoprobe. Note: The consumer part
887 is not used with all Envy24 based cards (for example in the MidiMan Delta
890 Note: The supported board is detected by reading EEPROM or PCI
891 SSID (if EEPROM isn't available). You can override the
892 model by passing "model" module option in case that the
893 driver isn't configured properly or you want to try another
899 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
900 * MidiMan M Audio Revolution 5.1
901 * MidiMan M Audio Revolution 7.1
902 * MidiMan M Audio Audiophile 192
904 * TerraTec Aureon 5.1 Sky
905 * TerraTec Aureon 7.1 Space
906 * TerraTec Aureon 7.1 Universe
909 * AudioTrak Prodigy 7.1
910 * AudioTrak Prodigy 7.1 LT
911 * AudioTrak Prodigy 7.1 XT
912 * AudioTrak Prodigy 7.1 HIFI
913 * AudioTrak Prodigy 7.1 HD2
914 * AudioTrak Prodigy 192
916 * Albatron K8X800 Pro II
925 * Hercules Fortissimo IV
926 * EGO-SYS WaveTerminal 192M
928 model - Use the given board model, one of the following:
929 revo51, revo71, amp2000, prodigy71, prodigy71lt,
930 prodigy71xt, prodigy71hifi, prodigyhd2, prodigy192,
931 juli, aureon51, aureon71, universe, ap192, k8x800,
932 phase22, phase28, ms300, av710, se200pci, se90pci,
933 fortissimo4, sn25p, WT192M
935 This module supports multiple cards and autoprobe.
937 Note: The supported board is detected by reading EEPROM or PCI
938 SSID (if EEPROM isn't available). You can override the
939 model by passing "model" module option in case that the
940 driver isn't configured properly or you want to try another
946 Module for Echoaudio Indigo
948 This module supports multiple cards.
949 The driver requires the firmware loader support on kernel.
954 Module for Echoaudio Indigo DJ
956 This module supports multiple cards.
957 The driver requires the firmware loader support on kernel.
962 Module for Echoaudio Indigo IO
964 This module supports multiple cards.
965 The driver requires the firmware loader support on kernel.
970 Module for AC'97 motherboards from Intel and compatibles.
971 * Intel i810/810E, i815, i820, i830, i84x, MX440
972 ICH5, ICH6, ICH7, 6300ESB, ESB2
974 * NVidia NForce, NForce2, NForce3, MCP04, CK804
976 * AMD AMD768, AMD8111
979 ac97_clock - AC'97 codec clock base (0 = auto-detect)
980 ac97_quirk - AC'97 workaround for strange hardware
981 See "AC97 Quirk Option" section below.
982 buggy_irq - Enable workaround for buggy interrupts on some
983 motherboards (default yes on nForce chips,
985 buggy_semaphore - Enable workaround for hardwares with buggy
986 semaphores (e.g. on some ASUS laptops)
988 spdif_aclink - Use S/PDIF over AC-link instead of direct connection
989 from the controller chip
990 (0 = off, 1 = on, -1 = default)
992 This module supports one chip and autoprobe.
994 Note: the latest driver supports auto-detection of chip clock.
995 if you still encounter too fast playback, specify the clock
996 explicitly via the module option "ac97_clock=41194".
998 Joystick/MIDI ports are not supported by this driver. If your
999 motherboard has these devices, use the ns558 or snd-mpu401
1000 modules, respectively.
1002 The power-management is supported.
1004 Module snd-intel8x0m
1005 --------------------
1007 Module for Intel ICH (i8x0) chipset MC97 modems.
1008 * Intel i810/810E, i815, i820, i830, i84x, MX440
1010 * SiS 7013 (SiS 735)
1011 * NVidia NForce, NForce2, NForce2s, NForce3
1015 ac97_clock - AC'97 codec clock base (0 = auto-detect)
1017 This module supports one card and autoprobe.
1019 Note: The default index value of this module is -2, i.e. the first
1022 The power-management is supported.
1024 Module snd-interwave
1025 --------------------
1027 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
1028 and other sound cards based on AMD InterWave (tm) chip.
1030 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1031 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1032 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1033 effect - 1 = InterWave effects enable (default 0);
1035 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1037 with isapnp=0, the following options are available:
1039 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1040 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1041 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1042 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
1044 This module supports multiple cards, autoprobe and ISA PnP.
1046 Module snd-interwave-stb
1047 ------------------------
1049 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
1050 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
1051 circuit for extended control of bass, treble and master volume.
1053 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
1054 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
1055 pcm_voices - reserved PCM voices for the synthesizer (default 2)
1056 effect - 1 = InterWave effects enable (default 0);
1058 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1060 with isapnp=0, the following options are available:
1062 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
1063 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
1064 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
1065 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
1066 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
1068 This module supports multiple cards, autoprobe and ISA PnP.
1073 Module for Korg 1212 IO PCI card
1075 This module supports multiple cards.
1080 Module for Echoaudio Layla20
1082 This module supports multiple cards.
1083 The driver requires the firmware loader support on kernel.
1088 Module for Echoaudio Layla24
1090 This module supports multiple cards.
1091 The driver requires the firmware loader support on kernel.
1096 Module for Allegro/Maestro3 chips
1098 external_amp - enable external amp (enabled by default)
1099 amp_gpio - GPIO pin number for external amp (0-15) or
1100 -1 for default pin (8 for allegro, 1 for
1103 This module supports autoprobe and multiple chips.
1105 Note: the binding of amplifier is dependent on hardware.
1106 If there is no sound even though all channels are unmuted, try to
1107 specify other gpio connection via amp_gpio option.
1108 For example, a Panasonic notebook might need "amp_gpio=0x0d"
1111 The power-management is supported.
1116 Module for Echoaudio Mia
1118 This module supports multiple cards.
1119 The driver requires the firmware loader support on kernel.
1124 Module for Miro soundcards: miroSOUND PCM 1 pro,
1126 miroSOUND PCM 20 Radio.
1128 port - Port # (0x530,0x604,0xe80,0xf40)
1129 irq - IRQ # (5,7,9,10,11)
1130 dma1 - 1st dma # (0,1,3)
1131 dma2 - 2nd dma # (0,1)
1132 mpu_port - MPU-401 port # (0x300,0x310,0x320,0x330)
1133 mpu_irq - MPU-401 irq # (5,7,9,10)
1134 fm_port - FM Port # (0x388)
1135 wss - enable WSS mode
1136 ide - enable onboard ide support
1141 Module for Digigram miXart8 sound cards.
1143 This module supports multiple cards.
1144 Note: One miXart8 board will be represented as 4 alsa cards.
1145 See MIXART.txt for details.
1147 When the driver is compiled as a module and the hotplug firmware
1148 is supported, the firmware data is loaded via hotplug automatically.
1149 Install the necessary firmware files in alsa-firmware package.
1150 When no hotplug fw loader is available, you need to load the
1151 firmware via mixartloader utility in alsa-tools package.
1156 Module for Echoaudio Mona
1158 This module supports multiple cards.
1159 The driver requires the firmware loader support on kernel.
1164 Module for MPU-401 UART devices.
1166 port - port number or -1 (disable)
1167 irq - IRQ number or -1 (disable)
1168 pnp - PnP detection - 0 = disable, 1 = enable (default)
1170 This module supports multiple devices and PnP.
1175 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
1178 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
1179 irq - IRQ # for MTPAV (7,5, default=7)
1180 hwports - number of supported hardware ports, default=8.
1182 Module supports only 1 card. This module has no enable option.
1187 Module for Ego Systems (ESI) Miditerminal 4140
1189 This module supports multiple devices.
1190 Requires parport (CONFIG_PARPORT).
1195 Module for NeoMagic NM256AV/ZX chips
1197 playback_bufsize - max playback frame size in kB (4-128kB)
1198 capture_bufsize - max capture frame size in kB (4-128kB)
1199 force_ac97 - 0 or 1 (disabled by default)
1200 buffer_top - specify buffer top address
1201 use_cache - 0 or 1 (disabled by default)
1202 vaio_hack - alias buffer_top=0x25a800
1203 reset_workaround - enable AC97 RESET workaround for some laptops
1204 reset_workaround2 - enable extended AC97 RESET workaround for some
1207 This module supports one chip and autoprobe.
1209 The power-management is supported.
1211 Note: on some notebooks the buffer address cannot be detected
1212 automatically, or causes hang-up during initialization.
1213 In such a case, specify the buffer top address explicitly via
1214 the buffer_top option.
1216 Sony F250: buffer_top=0x25a800
1217 Sony F270: buffer_top=0x272800
1218 The driver supports only ac97 codec. It's possible to force
1219 to initialize/use ac97 although it's not detected. In such a
1220 case, use force_ac97=1 option - but *NO* guarantee whether it
1223 Note: The NM256 chip can be linked internally with non-AC97
1224 codecs. This driver supports only the AC97 codec, and won't work
1225 with machines with other (most likely CS423x or OPL3SAx) chips,
1226 even though the device is detected in lspci. In such a case, try
1227 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
1228 but some doesn't have ISA PnP. You'll need to specify isapnp=0
1229 and proper hardware parameters in the case without ISA PnP.
1231 Note: some laptops need a workaround for AC97 RESET. For the
1232 known hardware like Dell Latitude LS and Sony PCG-F305, this
1233 workaround is enabled automatically. For other laptops with a
1234 hard freeze, you can try reset_workaround=1 option.
1236 Note: Dell Latitude CSx laptops have another problem regarding
1237 AC97 RESET. On these laptops, reset_workaround2 option is
1238 turned on as default. This option is worth to try if the
1239 previous reset_workaround option doesn't help.
1241 Note: This driver is really crappy. It's a porting from the
1242 OSS driver, which is a result of black-magic reverse engineering.
1243 The detection of codec will fail if the driver is loaded *after*
1244 X-server as described above. You might be able to force to load
1245 the module, but it may result in hang-up. Hence, make sure that
1246 you load this module *before* X if you encounter this kind of
1252 Module for Yamaha OPL3-SA2/SA3 sound cards.
1254 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1256 with isapnp=0, the following options are available:
1258 port - control port # for OPL3-SA chip (0x370)
1259 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1260 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1261 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1262 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1263 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1264 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1265 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
1267 This module supports multiple cards and ISA PnP. It does not support
1268 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1270 The power-management is supported.
1272 Module snd-opti92x-ad1848
1273 -------------------------
1275 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1276 Module works with OAK Mozart cards as well.
1278 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1280 with isapnp=0, the following options are available:
1282 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1283 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1284 fm_port - port # for OPL3 device (0x388)
1285 irq - IRQ # for WSS chip (5,7,9,10,11)
1286 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1287 dma1 - first DMA # for WSS chip (0,1,3)
1289 This module supports only one card, autoprobe and PnP.
1291 Module snd-opti92x-cs4231
1292 -------------------------
1294 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1296 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1298 with isapnp=0, the following options are available:
1300 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1301 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1302 fm_port - port # for OPL3 device (0x388)
1303 irq - IRQ # for WSS chip (5,7,9,10,11)
1304 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1305 dma1 - first DMA # for WSS chip (0,1,3)
1306 dma2 - second DMA # for WSS chip (0,1,3)
1308 This module supports only one card, autoprobe and PnP.
1313 Module for sound cards based on OPTi 82c93x chips.
1315 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1317 with isapnp=0, the following options are available:
1319 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1320 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1321 fm_port - port # for OPL3 device (0x388)
1322 irq - IRQ # for WSS chip (5,7,9,10,11)
1323 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1324 dma1 - first DMA # for WSS chip (0,1,3)
1325 dma2 - second DMA # for WSS chip (0,1,3)
1327 This module supports only one card, autoprobe and PnP.
1332 Module for sound cards based on the C-Media CMI8788 chip:
1334 * AuzenTech X-Meridian
1336 * Club3D Theatron DTS
1337 * HT-Omega Claro (plus)
1338 * HT-Omega Claro halo (XT)
1339 * Razer Barracuda AC-1
1342 This module supports autoprobe and multiple cards.
1347 Module for internal PC-Speaker.
1349 nforce_wa - enable NForce chipset workaround. Expect bad sound.
1351 This module supports system beeps, some kind of PCM playback and
1352 even a few mixer controls.
1357 Module for Digigram PCXHR boards
1359 This module supports multiple cards.
1361 Module snd-portman2x4
1362 ---------------------
1364 Module for Midiman Portman 2x4 parallel port MIDI interface
1366 This module supports multiple cards.
1368 Module snd-powermac (on ppc only)
1369 ---------------------------------
1371 Module for PowerMac, iMac and iBook on-board soundchips
1373 enable_beep - enable beep using PCM (enabled as default)
1375 Module supports autoprobe a chip.
1377 Note: the driver may have problems regarding endianess.
1379 The power-management is supported.
1381 Module snd-pxa2xx-ac97 (on arm only)
1382 ------------------------------------
1384 Module for AC97 driver for the Intel PXA2xx chip
1386 For ARM architecture only.
1388 The power-management is supported.
1393 Module for Conexant Riptide chip
1395 joystick_port - Joystick port # (default: 0x200)
1396 mpu_port - MPU401 port # (default: 0x330)
1397 opl3_port - OPL3 port # (default: 0x388)
1399 This module supports multiple cards.
1400 The driver requires the firmware loader support on kernel.
1401 You need to install the firmware file "riptide.hex" to the standard
1402 firmware path (e.g. /lib/firmware).
1407 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1408 Prodif96 and Prodif Gold) sound cards.
1410 This module supports multiple cards.
1415 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1417 This module supports multiple cards.
1422 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1424 precise_ptr - Enable precise pointer (doesn't work reliably).
1427 This module supports multiple cards.
1429 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1430 module did formerly. It will allocate the buffers in advance
1431 when any RME9652 cards are found. To make the buffer
1432 allocation sure, load snd-page-alloc module in the early
1433 stage of boot sequence. See "Early Buffer Allocation"
1436 Module snd-sa11xx-uda1341 (on arm only)
1437 ---------------------------------------
1439 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1441 Module supports only one card.
1442 Module has no enable and index options.
1444 The power-management is supported.
1449 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1453 port - port # for SB DSP chip (0x220,0x240,0x260)
1454 irq - IRQ # for SB DSP chip (5,7,9,10)
1455 dma8 - DMA # for SB DSP chip (1,3)
1457 This module supports multiple cards and autoprobe.
1459 The power-management is supported.
1461 Module snd-sb16 and snd-sbawe
1462 -----------------------------
1464 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1465 SoundBlaster AWE 32 (PnP),
1466 SoundBlaster AWE 64 PnP
1468 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1469 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1470 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1472 with isapnp=0, the following options are available:
1474 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1475 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1476 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1477 (snd-sbawe module only)
1478 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1479 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1480 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
1482 This module supports multiple cards, autoprobe and ISA PnP.
1484 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1485 disable 16bit DMA with dma16 = -1 module parameter.
1486 Also, all Sound Blaster 16 type cards can operate in 16-bit
1487 half duplex mode through 8-bit DMA channel by disabling their
1490 The power-management is supported.
1495 Module for Gallant SC-6000 soundcard.
1497 port - Port # (0x220 or 0x240)
1498 mss_port - MSS Port # (0x530 or 0xe80)
1499 irq - IRQ # (5,7,9,10,11)
1500 mpu_irq - MPU-401 IRQ # (5,7,9,10) ,0 - no MPU-401 irq
1503 This module supports multiple cards.
1505 This card is also known as Audio Excel DSP 16 or Zoltrix AV302.
1510 Module for Aztech Sound Galaxy sound card.
1512 sbport - Port # for SB16 interface (0x220,0x240)
1513 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1514 irq - IRQ # (7,9,10,11)
1517 This module supports multiple cards.
1519 The power-management is supported.
1524 Module for ENSONIQ SoundScape PnP cards.
1526 port - Port # (PnP setup)
1527 wss_port - WSS Port # (PnP setup)
1528 irq - IRQ # (PnP setup)
1529 mpu_irq - MPU-401 IRQ # (PnP setup)
1530 dma - DMA # (PnP setup)
1531 dma2 - 2nd DMA # (PnP setup, -1 to disable)
1533 This module supports multiple cards. ISA PnP must be enabled.
1534 You need sscape_ctl tool in alsa-tools package for loading
1537 Module snd-sun-amd7930 (on sparc only)
1538 --------------------------------------
1540 Module for AMD7930 sound chips found on Sparcs.
1542 This module supports multiple cards.
1544 Module snd-sun-cs4231 (on sparc only)
1545 -------------------------------------
1547 Module for CS4231 sound chips found on Sparcs.
1549 This module supports multiple cards.
1551 Module snd-sun-dbri (on sparc only)
1552 -----------------------------------
1554 Module for DBRI sound chips found on Sparcs.
1556 This module supports multiple cards.
1558 Module snd-wavefront
1559 --------------------
1561 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1563 use_cs4232_midi - Use CS4232 MPU-401 interface
1564 (inaccessibly located inside your computer)
1565 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1567 with isapnp=0, the following options are available:
1569 cs4232_pcm_port - Port # for CS4232 PCM interface.
1570 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1571 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1572 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
1573 ics2115_port - Port # for ICS2115
1574 ics2115_irq - IRQ # for ICS2115
1575 fm_port - FM OPL-3 Port #
1576 dma1 - DMA1 # for CS4232 PCM interface.
1577 dma2 - DMA2 # for CS4232 PCM interface.
1579 The below are options for wavefront_synth features:
1580 wf_raw - Assume that we need to boot the OS (default:no)
1581 If yes, then during driver loading, the state of the board is
1582 ignored, and we reset the board and load the firmware anyway.
1583 fx_raw - Assume that the FX process needs help (default:yes)
1584 If false, we'll leave the FX processor in whatever state it is
1585 when the driver is loaded. The default is to download the
1586 microprogram and associated coefficients to set it up for
1587 "default" operation, whatever that means.
1588 debug_default - Debug parameters for card initialization
1589 wait_usecs - How long to wait without sleeping, usecs
1591 This magic number seems to give pretty optimal throughput
1592 based on my limited experimentation.
1593 If you want to play around with it and find a better value, be
1594 my guest. Remember, the idea is to get a number that causes us
1595 to just busy wait for as many WaveFront commands as possible,
1596 without coming up with a number so large that we hog the whole
1598 Specifically, with this number, out of about 134,000 status
1599 waits, only about 250 result in a sleep.
1600 sleep_interval - How long to sleep when waiting for reply
1602 sleep_tries - How many times to try sleeping during a wait
1604 ospath - Pathname to processed ICS2115 OS firmware
1605 (default:wavefront.os)
1606 The path name of the ISC2115 OS firmware. In the recent
1607 version, it's handled via firmware loader framework, so it
1608 must be installed in the proper path, typically,
1610 reset_time - How long to wait for a reset to take effect
1612 ramcheck_time - How many seconds to wait for the RAM test
1614 osrun_time - How many seconds to wait for the ICS2115 OS
1617 This module supports multiple cards and ISA PnP.
1619 Note: the firmware file "wavefront.os" was located in the earlier
1620 version in /etc. Now it's loaded via firmware loader, and
1621 must be in the proper firmware path, such as /lib/firmware.
1622 Copy (or symlink) the file appropriately if you get an error
1623 regarding firmware downloading after upgrading the kernel.
1625 Module snd-sonicvibes
1626 ---------------------
1628 Module for S3 SonicVibes PCI sound cards.
1629 * PINE Schubert 32 PCI
1631 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1632 - SoundCard must have onboard SRAM for this.
1633 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1635 This module supports multiple cards and autoprobe.
1637 Module snd-serial-u16550
1638 ------------------------
1640 Module for UART16550A serial MIDI ports.
1642 port - port # for UART16550A chip
1643 irq - IRQ # for UART16550A chip, -1 = poll mode
1644 speed - speed in bauds (9600,19200,38400,57600,115200)
1646 base - base for divisor in bauds (57600,115200,230400,460800)
1648 outs - number of MIDI ports in a serial port (1-4)
1650 adaptor - Type of adaptor.
1651 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1652 3 = MS-124W M/B, 4 = Generic
1654 This module supports multiple cards. This module does not support autoprobe
1655 thus the main port must be specified!!! Other options are optional.
1660 Module for Trident 4DWave DX/NX sound cards.
1661 * Best Union Miss Melody 4DWave PCI
1663 * Warpspeed ONSpeed 4DWave PCI
1666 * CHIC True Sound 4Dwave
1667 * Shark Predator4D-PCI
1668 * Jaton SonicWave 4D
1669 * SiS SI7018 PCI Audio
1670 * Hoontech SoundTrack Digital 4DWave NX
1672 pcm_channels - max channels (voices) reserved for PCM
1673 wavetable_size - max wavetable size in kB (4-?kb)
1675 This module supports multiple cards and autoprobe.
1677 The power-management is supported.
1679 Module snd-usb-audio
1680 --------------------
1682 Module for USB audio and USB MIDI devices.
1684 vid - Vendor ID for the device (optional)
1685 pid - Product ID for the device (optional)
1686 nrpacks - Max. number of packets per URB (default: 8)
1687 async_unlink - Use async unlink mode (default: yes)
1688 device_setup - Device specific magic number (optional)
1689 - Influence depends on the device
1691 ignore_ctl_error - Ignore any USB-controller regarding mixer
1692 interface (default: no)
1694 This module supports multiple devices, autoprobe and hotplugging.
1696 NB: nrpacks parameter can be modified dynamically via sysfs.
1697 Don't put the value over 20. Changing via sysfs has no sanity
1699 NB: async_unlink=0 would cause Oops. It remains just for
1700 debugging purpose (if any).
1701 NB: ignore_ctl_error=1 may help when you get an error at accessing
1702 the mixer element such as URB error -22. This happens on some
1703 buggy USB device or the controller.
1705 Module snd-usb-caiaq
1706 --------------------
1708 Module for caiaq UB audio interfaces,
1709 * Native Instruments RigKontrol2
1710 * Native Instruments Kore Controller
1711 * Native Instruments Audio Kontrol 1
1712 * Native Instruments Audio 8 DJ
1714 This module supports multiple devices, autoprobe and hotplugging.
1716 Module snd-usb-usx2y
1717 --------------------
1719 Module for Tascam USB US-122, US-224 and US-428 devices.
1721 This module supports multiple devices, autoprobe and hotplugging.
1723 Note: you need to load the firmware via usx2yloader utility included
1724 in alsa-tools and alsa-firmware packages.
1729 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
1730 8233A, 8233C, 8235, 8237 (south) bridge.
1732 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1734 joystick - Enable joystick (default off) [VIA686A/686B only]
1735 ac97_clock - AC'97 codec clock base (default 48000Hz)
1736 dxs_support - support DXS channels,
1737 0 = auto (default), 1 = enable, 2 = disable,
1738 3 = 48k only, 4 = no VRA, 5 = enable any sample
1739 rate and different sample rates on different
1741 [VIA8233/C, 8235, 8237 only]
1742 ac97_quirk - AC'97 workaround for strange hardware
1743 See "AC97 Quirk Option" section below.
1745 This module supports one chip and autoprobe.
1747 Note: on some SMP motherboards like MSI 694D the interrupts might
1748 not be generated properly. In such a case, please try to
1749 set the SMP (or MPS) version on BIOS to 1.1 instead of
1750 default value 1.4. Then the interrupt number will be
1751 assigned under 15. You might also upgrade your BIOS.
1753 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
1754 channels as the first PCM. On these channels, up to 4
1755 streams can be played at the same time, and the controller
1756 can perform sample rate conversion with separate rates for
1758 As default (dxs_support = 0), 48k fixed rate is chosen
1759 except for the known devices since the output is often
1760 noisy except for 48k on some mother boards due to the
1762 Please try once dxs_support=5 and if it works on other
1763 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1764 know the PCI subsystem vendor/device id's (output of
1766 If dxs_support=5 does not work, try dxs_support=4; if it
1767 doesn't work too, try dxs_support=1. (dxs_support=1 is
1768 usually for old motherboards. The correct implemented
1769 board should work with 4 or 5.) If it still doesn't
1770 work and the default setting is ok, dxs_support=3 is the
1771 right choice. If the default setting doesn't work at all,
1772 try dxs_support=2 to disable the DXS channels.
1773 In any cases, please let us know the result and the
1774 subsystem vendor/device ids. See "Links and Addresses"
1777 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
1778 additionally. The mpu_port option is for VIA686 chips only.
1780 The power-management is supported.
1782 Module snd-via82xx-modem
1783 ------------------------
1785 Module for VIA82xx AC97 modem
1787 ac97_clock - AC'97 codec clock base (default 48000Hz)
1789 This module supports one card and autoprobe.
1791 Note: The default index value of this module is -2, i.e. the first
1794 The power-management is supported.
1799 Module for virtual rawmidi devices.
1800 This module creates virtual rawmidi devices which communicate
1801 to the corresponding ALSA sequencer ports.
1803 midi_devs - MIDI devices # (1-4, default=4)
1805 This module supports multiple cards.
1810 Module for sound cards based on the Asus AV100/AV200 chips,
1811 i.e., Xonar D1, DX, D2, D2X and HDAV1.3 (Deluxe).
1813 This module supports autoprobe and multiple cards.
1818 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1820 mic - Enable Microphone on V222 Mic (NYI)
1821 ibl - Capture IBL size. (default = 0, minimum size)
1823 This module supports multiple cards.
1825 When the driver is compiled as a module and the hotplug firmware
1826 is supported, the firmware data is loaded via hotplug automatically.
1827 Install the necessary firmware files in alsa-firmware package.
1828 When no hotplug fw loader is available, you need to load the
1829 firmware via vxloader utility in alsa-tools package. To invoke
1830 vxloader automatically, add the following to /etc/modprobe.conf
1832 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1834 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1835 /etc/modules.conf, instead.)
1836 IBL size defines the interrupts period for PCM. The smaller size
1837 gives smaller latency but leads to more CPU consumption, too.
1838 The size is usually aligned to 126. As default (=0), the smallest
1839 size is chosen. The possible IBL values can be found in
1840 /proc/asound/cardX/vx-status proc file.
1842 The power-management is supported.
1847 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
1849 ibl - Capture IBL size. (default = 0, minimum size)
1851 This module supports multiple cards. The module is compiled only when
1852 PCMCIA is supported on kernel.
1854 With the older 2.6.x kernel, to activate the driver via the card
1855 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1856 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1857 longer require a config file.
1859 When the driver is compiled as a module and the hotplug firmware
1860 is supported, the firmware data is loaded via hotplug automatically.
1861 Install the necessary firmware files in alsa-firmware package.
1862 When no hotplug fw loader is available, you need to load the
1863 firmware via vxloader utility in alsa-tools package.
1865 About capture IBL, see the description of snd-vx222 module.
1867 Note: snd-vxp440 driver is merged to snd-vxpocket driver since
1870 The power-management is supported.
1875 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1877 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1878 1 (auto-detect for YMF744/754 only)
1879 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1880 1 (auto-detect for YMF744/754 only)
1881 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1883 rear_switch - enable shared rear/line-in switch (bool)
1885 This module supports autoprobe and multiple chips.
1887 The power-management is supported.
1889 Module snd-pdaudiocf
1890 --------------------
1892 Module for Sound Core PDAudioCF sound card.
1894 The power-management is supported.
1900 The ac97_quirk option is used to enable/override the workaround for
1901 specific devices on drivers for on-board AC'97 controllers like
1902 snd-intel8x0. Some hardware have swapped output pins between Master
1903 and Headphone, or Surround (thanks to confusion of AC'97
1904 specifications from version to version :-)
1906 The driver provides the auto-detection of known problematic devices,
1907 but some might be unknown or wrongly detected. In such a case, pass
1908 the proper value with this option.
1910 The following strings are accepted:
1911 - default Don't override the default setting
1912 - none Disable the quirk
1913 - hp_only Bind Master and Headphone controls as a single control
1914 - swap_hp Swap headphone and master controls
1915 - swap_surround Swap master and surround controls
1916 - ad_sharing For AD1985, turn on OMS bit and use headphone
1917 - alc_jack For ALC65x, turn on the jack sense mode
1918 - inv_eapd Inverted EAPD implementation
1919 - mute_led Bind EAPD bit for turning on/off mute LED
1921 For backward compatibility, the corresponding integer value -1, 0,
1922 ... are accepted, too.
1924 For example, if "Master" volume control has no effect on your device
1925 but only "Headphone" does, pass ac97_quirk=hp_only module option.
1928 Configuring Non-ISAPNP Cards
1929 ============================
1931 When the kernel is configured with ISA-PnP support, the modules
1932 supporting the isapnp cards will have module options "isapnp".
1933 If this option is set, *only* the ISA-PnP devices will be probed.
1934 For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
1935 together with the proper i/o and irq configuration.
1937 When the kernel is configured without ISA-PnP support, isapnp option
1938 will be not built in.
1941 Module Autoloading Support
1942 ==========================
1944 The ALSA drivers can be loaded automatically on demand by defining
1945 module aliases. The string 'snd-card-%1' is requested for ALSA native
1946 devices where %i is sound card number from zero to seven.
1948 To auto-load an ALSA driver for OSS services, define the string
1949 'sound-slot-%i' where %i means the slot number for OSS, which
1950 corresponds to the card index of ALSA. Usually, define this
1951 as the same card module.
1953 An example configuration for a single emu10k1 card is like below:
1954 ----- /etc/modprobe.conf
1955 alias snd-card-0 snd-emu10k1
1956 alias sound-slot-0 snd-emu10k1
1957 ----- /etc/modprobe.conf
1959 The available number of auto-loaded sound cards depends on the module
1960 option "cards_limit" of snd module. As default it's set to 1.
1961 To enable the auto-loading of multiple cards, specify the number of
1962 sound cards in that option.
1964 When multiple cards are available, it'd better to specify the index
1965 number for each card via module option, too, so that the order of
1966 cards is kept consistent.
1968 An example configuration for two sound cards is like below:
1970 ----- /etc/modprobe.conf
1972 options snd cards_limit=2
1973 alias snd-card-0 snd-interwave
1974 alias snd-card-1 snd-ens1371
1975 options snd-interwave index=0
1976 options snd-ens1371 index=1
1978 alias sound-slot-0 snd-interwave
1979 alias sound-slot-1 snd-ens1371
1980 ----- /etc/modprobe.conf
1982 In this example, the interwave card is always loaded as the first card
1983 (index 0) and ens1371 as the second (index 1).
1985 Alternative (and new) way to fixate the slot assignment is to use
1986 "slots" option of snd module. In the case above, specify like the
1989 options snd slots=snd-interwave,snd-ens1371
1991 Then, the first slot (#0) is reserved for snd-interwave driver, and
1992 the second (#1) for snd-ens1371. You can omit index option in each
1993 driver if slots option is used (although you can still have them at
1994 the same time as long as they don't conflict).
1996 The slots option is especially useful for avoiding the possible
1997 hot-plugging and the resultant slot conflict. For example, in the
1998 case above again, the first two slots are already reserved. If any
1999 other driver (e.g. snd-usb-audio) is loaded before snd-interwave or
2000 snd-ens1371, it will be assigned to the third or later slot.
2002 When a module name is given with '!', the slot will be given for any
2003 modules but that name. For example, "slots=!snd-pcsp" will reserve
2004 the first slot for any modules but snd-pcsp.
2007 ALSA PCM devices to OSS devices mapping
2008 =======================================
2010 /dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
2011 /dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
2012 /dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
2013 /dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
2014 /dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
2015 /dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
2016 /dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
2017 /dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
2018 /dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
2020 The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
2021 sound card number and second means device number. The ALSA devices
2022 have either 'c' or 'p' suffix indicating the direction, capture and
2023 playback, respectively.
2025 Please note that the device mapping above may be varied via the module
2026 options of snd-pcm-oss module.
2029 Proc interfaces (/proc/asound)
2030 ==============================
2032 /proc/asound/card#/pcm#[cp]/oss
2033 -------------------------------
2034 String "erase" - erase all additional informations about OSS applications
2035 String "<app_name> <fragments> <fragment_size> [<options>]"
2037 <app_name> - name of application with (higher priority) or without path
2038 <fragments> - number of fragments or zero if auto
2039 <fragment_size> - size of fragment in bytes or zero if auto
2040 <options> - optional parameters
2041 - disable the application tries to open a pcm device for
2042 this channel but does not want to use it.
2043 (Cause a bug or mmap needs)
2044 It's good for Quake etc...
2045 - direct don't use plugins
2046 - block force block mode (rvplayer)
2047 - non-block force non-block mode
2048 - whole-frag write only whole fragments (optimization affecting
2050 - no-silence do not fill silence ahead to avoid clicks
2051 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
2052 instead of filled blocks
2054 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
2055 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
2056 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
2059 Early Buffer Allocation
2060 =======================
2062 Some drivers (e.g. hdsp) require the large contiguous buffers, and
2063 sometimes it's too late to find such spaces when the driver module is
2064 actually loaded due to memory fragmentation. You can pre-allocate the
2065 PCM buffers by loading snd-page-alloc module and write commands to its
2066 proc file in prior, for example, in the early boot stage like
2067 /etc/init.d/*.local scripts.
2069 Reading the proc file /proc/drivers/snd-page-alloc shows the current
2070 usage of page allocation. In writing, you can send the following
2071 commands to the snd-page-alloc driver:
2073 - add VENDOR DEVICE MASK SIZE BUFFERS
2075 VENDOR and DEVICE are PCI vendor and device IDs. They take
2076 integer numbers (0x prefix is needed for the hex).
2077 MASK is the PCI DMA mask. Pass 0 if not restricted.
2078 SIZE is the size of each buffer to allocate. You can pass
2079 k and m suffix for KB and MB. The max number is 16MB.
2080 BUFFERS is the number of buffers to allocate. It must be greater
2081 than 0. The max number is 4.
2085 This will erase the all pre-allocated buffers which are not in
2092 ALSA project homepage
2093 http://www.alsa-project.org
2096 http://bugzilla.kernel.org/
2099 mailto:alsa-devel@alsa-project.org
2102 http://www.alsa-project.org/alsa-info.sh
projects / linux-2.6-block.git / blob