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