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