]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - Documentation/sound/alsa/ALSA-Configuration.txt
projects / mirror_ubuntu-bionic-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
[ALSA] Add PCXHR driver
[mirror_ubuntu-bionic-kernel.git] / Documentation / sound / alsa / ALSA-Configuration.txt
CommitLineData
1da177e4
LT		 1
2 Advanced Linux Sound Architecture - Driver
3 ==========================================
4 Configuration guide
5
6
7Kernel Configuration
8====================
9
10To enable ALSA support you need at least to build the kernel with
11primary sound card support (CONFIG_SOUND). Since ALSA can emulate OSS,
12you don't have to choose any of the OSS modules.
13
14Enable "OSS API emulation" (CONFIG_SND_OSSEMUL) and both OSS mixer and
15PCM supports if you want to run OSS applications with ALSA.
16
17If you want to support the WaveTable functionality on cards such as
18SB Live! then you need to enable "Sequencer support"
19(CONFIG_SND_SEQUENCER).
20
21To make ALSA debug messages more verbose, enable the "Verbose printk"
22and "Debug" options. To check for memory leaks, turn on "Debug memory"
23too. "Debug detection" will add checks for the detection of cards.
24
25Please note that all the ALSA ISA drivers support the Linux isapnp API
26(if the card supports ISA PnP). You don't need to configure the cards
27using isapnptools.
28
29
30Creating ALSA devices
31=====================
32
33This depends on your distribution, but normally you use the /dev/MAKEDEV
34script to create the necessary device nodes. On some systems you use a
35script named 'snddevices'.
36
37
38Module parameters
39=================
40
41The user can load modules with options. If the module supports more than
42one card and you have more than one card of the same type then you can
43specify multiple values for the option separated by commas.
44
45Prior to version 0.9.0rc4 options had a 'snd_' prefix. This was removed.
46
47 Module snd
48 ----------
49
50 The core ALSA module. It is used by all ALSA card drivers.
51 It takes the following options which have global effects.
52
53 major - major number for sound driver
54 - Default: 116
55 cards_limit
56 - limiting card index for auto-loading (1-8)
57 - Default: 1
58 - For auto-loading more than one card, specify this
59 option together with snd-card-X aliases.
60 device_mode
61 - permission mask for dynamic sound device filesystem
62 - This is available only when DEVFS is enabled
63 - Default: 0666
64 - E.g.: device_mode=0660
65
66
67 Module snd-pcm-oss
68 ------------------
69
70 The PCM OSS emulation module.
71 This module takes options which change the mapping of devices.
72
73 dsp_map - PCM device number maps assigned to the 1st OSS device.
74 - Default: 0
75 adsp_map - PCM device number maps assigned to the 2st OSS device.
76 - Default: 1
77 nonblock_open
6243008b 78 - Don't block opening busy PCM devices. Default: 1
1da177e4
LT		 79
80 For example, when dsp_map=2, /dev/dsp will be mapped to PCM #2 of
81 the card #0. Similarly, when adsp_map=0, /dev/adsp will be mapped
82 to PCM #0 of the card #0.
83 For changing the second or later card, specify the option with
84 commas, such like "dsp_map=0,1".
85
86 nonblock_open option is used to change the behavior of the PCM
87 regarding opening the device. When this option is non-zero,
88 opening a busy OSS PCM device won't be blocked but return
89 immediately with EAGAIN (just like O_NONBLOCK flag).
90
91 Module snd-rawmidi
92 ------------------
93
94 This module takes options which change the mapping of devices.
95 similar to those of the snd-pcm-oss module.
96
97 midi_map - MIDI device number maps assigned to the 1st OSS device.
98 - Default: 0
99 amidi_map - MIDI device number maps assigned to the 2st OSS device.
100 - Default: 1
101
102 Common parameters for top sound card modules
103 --------------------------------------------
104
105 Each of top level sound card module takes the following options.
106
107 index - index (slot #) of sound card
0ef797c5 108 - Values: 0 through 31 or negative
1da177e4
LT		 109 - If nonnegative, assign that index number
110 - if negative, interpret as a bitmask of permissible
111 indices; the first free permitted index is assigned
112 - Default: -1
113 id - card ID (identifier or name)
114 - Can be up to 15 characters long
115 - Default: the card type
116 - A directory by this name is created under /proc/asound/
117 containing information about the card
118 - This ID can be used instead of the index number in
119 identifying the card
120 enable - enable card
121 - Default: enabled, for PCI and ISA PnP cards
122
123 Module snd-ad1816a
124 ------------------
125
126 Module for sound cards based on Analog Devices AD1816A/AD1815 ISA chips.
127
128 port - port # for AD1816A chip (PnP setup)
129 mpu_port - port # for MPU-401 UART (PnP setup)
130 fm_port - port # for OPL3 (PnP setup)
131 irq - IRQ # for AD1816A chip (PnP setup)
132 mpu_irq - IRQ # for MPU-401 UART (PnP setup)
133 dma1 - first DMA # for AD1816A chip (PnP setup)
134 dma2 - second DMA # for AD1816A chip (PnP setup)
506d4c6a 135 clockfreq - Clock frequency for AD1816A chip (default = 0, 33000Hz)
1da177e4 136
0ef797c5 137 This module supports multiple cards, autoprobe and PnP.
1da177e4
LT		 138
139 Module snd-ad1848
140 -----------------
141
142 Module for sound cards based on AD1848/AD1847/CS4248 ISA chips.
143
144 port - port # for AD1848 chip
145 irq - IRQ # for AD1848 chip
146 dma1 - DMA # for AD1848 chip (0,1,3)
147
0ef797c5 148 This module supports multiple cards. It does not support autoprobe
1da177e4
LT		 149 thus main port must be specified!!! Other ports are optional.
150
a4efc230
TI		 151 The power-management is supported.
152
84010e6f
CL		 153 Module snd-ad1889
154 -----------------
155
156 Module for Analog Devices AD1889 chips.
157
158 ac97_quirk - AC'97 workaround for strange hardware
159 See the description of intel8x0 module for details.
160
0ef797c5 161 This module supports multiple cards.
84010e6f 162
1da177e4
LT		 163 Module snd-ali5451
164 ------------------
165
166 Module for ALi M5451 PCI chip.
167
168 pcm_channels - Number of hardware channels assigned for PCM
169 spdif - Support SPDIF I/O
170 - Default: disabled
171
8a3fb4d0 172 This module supports one chip and autoprobe.
1da177e4
LT		 173
174 The power-management is supported.
175
176 Module snd-als100
177 -----------------
178
179 Module for sound cards based on Avance Logic ALS100/ALS120 ISA chips.
180
181 port - port # for ALS100 (SB16) chip (PnP setup)
182 irq - IRQ # for ALS100 (SB16) chip (PnP setup)
183 dma8 - 8-bit DMA # for ALS100 (SB16) chip (PnP setup)
184 dma16 - 16-bit DMA # for ALS100 (SB16) chip (PnP setup)
185 mpu_port - port # for MPU-401 UART (PnP setup)
186 mpu_irq - IRQ # for MPU-401 (PnP setup)
187 fm_port - port # for OPL3 FM (PnP setup)
188
0ef797c5 189 This module supports multiple cards, autoprobe and PnP.
1da177e4 190
a4efc230
TI		 191 The power-management is supported.
192
1da177e4
LT		 193 Module snd-als4000
194 ------------------
195
196 Module for sound cards based on Avance Logic ALS4000 PCI chip.
197
198 joystick_port - port # for legacy joystick support.
199 0 = disabled (default), 1 = auto-detect
200
0ef797c5 201 This module supports multiple cards, autoprobe and PnP.
1da177e4 202
a4efc230
TI		 203 The power-management is supported.
204
1da177e4
LT		 205 Module snd-atiixp
206 -----------------
207
6243008b 208 Module for ATI IXP 150/200/250/400 AC97 controllers.
1da177e4 209
6243008b 210 ac97_clock - AC'97 clock (default = 48000)
1da177e4 211 ac97_quirk - AC'97 workaround for strange hardware
6243008b 212 See "AC97 Quirk Option" section below.
1da177e4
LT		 213 spdif_aclink - S/PDIF transfer over AC-link (default = 1)
214
b7fe4622 215 This module supports one card and autoprobe.
1da177e4 216
6243008b
TI		 217 ATI IXP has two different methods to control SPDIF output. One is
218 over AC-link and another is over the "direct" SPDIF output. The
219 implementation depends on the motherboard, and you'll need to
220 choose the correct one via spdif_aclink module option.
221
a4efc230
TI		 222 The power-management is supported.
223
1da177e4
LT		 224 Module snd-atiixp-modem
225 -----------------------
226
227 Module for ATI IXP 150/200/250 AC97 modem controllers.
228
b7fe4622 229 This module supports one card and autoprobe.
1da177e4
LT		 230
231 Note: The default index value of this module is -2, i.e. the first
232 slot is excluded.
233
a4efc230
TI		 234 The power-management is supported.
235
1da177e4
LT		 236 Module snd-au8810, snd-au8820, snd-au8830
237 -----------------------------------------
238
239 Module for Aureal Vortex, Vortex2 and Advantage device.
240
241 pcifix - Control PCI workarounds
242 0 = Disable all workarounds
243 1 = Force the PCI latency of the Aureal card to 0xff
244 2 = Force the Extend PCI#2 Internal Master for Efficient
245 Handling of Dummy Requests on the VIA KT133 AGP Bridge
246 3 = Force both settings
247 255 = Autodetect what is required (default)
248
249 This module supports all ADB PCM channels, ac97 mixer, SPDIF, hardware
250 EQ, mpu401, gameport. A3D and wavetable support are still in development.
251 Development and reverse engineering work is being coordinated at
252 http://savannah.nongnu.org/projects/openvortex/
253 SPDIF output has a copy of the AC97 codec output, unless you use the
254 "spdif" pcm device, which allows raw data passthru.
255 The hardware EQ hardware and SPDIF is only present in the Vortex2 and
256 Advantage.
257
6243008b 258 Note: Some ALSA mixer applications don't handle the SPDIF sample rate
1da177e4
LT		 259 control correctly. If you have problems regarding this, try
260 another ALSA compliant mixer (alsamixer works).
261
262 Module snd-azt2320
263 ------------------
264
265 Module for sound cards based on Aztech System AZT2320 ISA chip (PnP only).
266
267 port - port # for AZT2320 chip (PnP setup)
268 wss_port - port # for WSS (PnP setup)
269 mpu_port - port # for MPU-401 UART (PnP setup)
270 fm_port - FM port # for AZT2320 chip (PnP setup)
271 irq - IRQ # for AZT2320 (WSS) chip (PnP setup)
272 mpu_irq - IRQ # for MPU-401 UART (PnP setup)
273 dma1 - 1st DMA # for AZT2320 (WSS) chip (PnP setup)
274 dma2 - 2nd DMA # for AZT2320 (WSS) chip (PnP setup)
275
0ef797c5 276 This module supports multiple cards, PnP and autoprobe.
1da177e4 277
a4efc230
TI		 278 The power-management is supported.
279
1da177e4
LT		 280 Module snd-azt3328
281 ------------------
282
283 Module for sound cards based on Aztech AZF3328 PCI chip.
284
285 joystick - Enable joystick (default off)
286
0ef797c5 287 This module supports multiple cards.
1da177e4
LT		 288
289 Module snd-bt87x
290 ----------------
291
292 Module for video cards based on Bt87x chips.
293
294 digital_rate - Override the default digital rate (Hz)
295 load_all - Load the driver even if the card model isn't known
296
0ef797c5 297 This module supports multiple cards.
1da177e4
LT		 298
299 Note: The default index value of this module is -2, i.e. the first
300 slot is excluded.
301
302 Module snd-ca0106
303 -----------------
304
305 Module for Creative Audigy LS and SB Live 24bit
306
0ef797c5 307 This module supports multiple cards.
1da177e4
LT		 308
309
310 Module snd-cmi8330
311 ------------------
312
313 Module for sound cards based on C-Media CMI8330 ISA chips.
314
315 wssport - port # for CMI8330 chip (WSS)
316 wssirq - IRQ # for CMI8330 chip (WSS)
317 wssdma - first DMA # for CMI8330 chip (WSS)
318 sbport - port # for CMI8330 chip (SB16)
319 sbirq - IRQ # for CMI8330 chip (SB16)
320 sbdma8 - 8bit DMA # for CMI8330 chip (SB16)
321 sbdma16 - 16bit DMA # for CMI8330 chip (SB16)
322
0ef797c5 323 This module supports multiple cards and autoprobe.
1da177e4 324
a4efc230
TI		 325 The power-management is supported.
326
1da177e4
LT		 327 Module snd-cmipci
328 -----------------
329
330 Module for C-Media CMI8338 and 8738 PCI sound cards.
331
332 mpu_port - 0x300,0x310,0x320,0x330, 0 = disable (default)
333 fm_port - 0x388 (default), 0 = disable (default)
6243008b 334 soft_ac3 - Software-conversion of raw SPDIF packets (model 033 only)
1da177e4
LT		 335 (default = 1)
336 joystick_port - Joystick port address (0 = disable, 1 = auto-detect)
337
0ef797c5 338 This module supports autoprobe and multiple cards.
1da177e4 339
a4efc230
TI		 340 The power-management is supported.
341
1da177e4
LT		 342 Module snd-cs4231
343 -----------------
344
345 Module for sound cards based on CS4231 ISA chips.
346
347 port - port # for CS4231 chip
348 mpu_port - port # for MPU-401 UART (optional), -1 = disable
349 irq - IRQ # for CS4231 chip
350 mpu_irq - IRQ # for MPU-401 UART
351 dma1 - first DMA # for CS4231 chip
352 dma2 - second DMA # for CS4231 chip
353
0ef797c5 354 This module supports multiple cards. This module does not support autoprobe
1da177e4
LT		 355 thus main port must be specified!!! Other ports are optional.
356
357 The power-management is supported.
358
359 Module snd-cs4232
360 -----------------
361
362 Module for sound cards based on CS4232/CS4232A ISA chips.
363
364 port - port # for CS4232 chip (PnP setup - 0x534)
365 cport - control port # for CS4232 chip (PnP setup - 0x120,0x210,0xf00)
366 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
367 fm_port - FM port # for CS4232 chip (PnP setup - 0x388), -1 = disable
368 irq - IRQ # for CS4232 chip (5,7,9,11,12,15)
369 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
370 dma1 - first DMA # for CS4232 chip (0,1,3)
371 dma2 - second DMA # for Yamaha CS4232 chip (0,1,3), -1 = disable
372 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
373
0ef797c5 374 This module supports multiple cards. This module does not support autoprobe
1da177e4
LT		 375 thus main port must be specified!!! Other ports are optional.
376
377 The power-management is supported.
378
379 Module snd-cs4236
380 -----------------
381
382 Module for sound cards based on CS4235/CS4236/CS4236B/CS4237B/
383 CS4238B/CS4239 ISA chips.
384
385 port - port # for CS4236 chip (PnP setup - 0x534)
386 cport - control port # for CS4236 chip (PnP setup - 0x120,0x210,0xf00)
387 mpu_port - port # for MPU-401 UART (PnP setup - 0x300), -1 = disable
388 fm_port - FM port # for CS4236 chip (PnP setup - 0x388), -1 = disable
389 irq - IRQ # for CS4236 chip (5,7,9,11,12,15)
390 mpu_irq - IRQ # for MPU-401 UART (9,11,12,15)
391 dma1 - first DMA # for CS4236 chip (0,1,3)
392 dma2 - second DMA # for CS4236 chip (0,1,3), -1 = disable
393 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
394
0ef797c5 395 This module supports multiple cards. This module does not support autoprobe
1da177e4
LT		 396 (if ISA PnP is not used) thus main port and control port must be
397 specified!!! Other ports are optional.
398
399 The power-management is supported.
400
401 Module snd-cs4281
402 -----------------
403
404 Module for Cirrus Logic CS4281 soundchip.
405
406 dual_codec - Secondary codec ID (0 = disable, default)
407
0ef797c5 408 This module supports multiple cards.
1da177e4
LT		 409
410 The power-management is supported.
411
412 Module snd-cs46xx
413 -----------------
414
415 Module for PCI sound cards based on CS4610/CS4612/CS4614/CS4615/CS4622/
416 CS4624/CS4630/CS4280 PCI chips.
417
6243008b 418 external_amp - Force to enable external amplifier.
1da177e4
LT		 419 thinkpad - Force to enable Thinkpad's CLKRUN control.
420 mmap_valid - Support OSS mmap mode (default = 0).
421
0ef797c5 422 This module supports multiple cards and autoprobe.
1da177e4
LT		 423 Usually external amp and CLKRUN controls are detected automatically
424 from PCI sub vendor/device ids. If they don't work, give the options
425 above explicitly.
426
427 The power-management is supported.
428
3e873174
TI		 429 Module snd-cs5535audio
430 ----------------------
431
432 Module for multifunction CS5535 companion PCI device
433
0ef797c5 434 This module supports multiple cards.
3e873174 435
1da177e4
LT		 436 Module snd-dt019x
437 -----------------
438
439 Module for Diamond Technologies DT-019X / Avance Logic ALS-007 (PnP
440 only)
441
442 port - Port # (PnP setup)
443 mpu_port - Port # for MPU-401 (PnP setup)
444 fm_port - Port # for FM OPL-3 (PnP setup)
445 irq - IRQ # (PnP setup)
446 mpu_irq - IRQ # for MPU-401 (PnP setup)
447 dma8 - DMA # (PnP setup)
448
0ef797c5 449 This module supports multiple cards. This module is enabled only with
1da177e4
LT		 450 ISA PnP support.
451
a4efc230
TI		 452 The power-management is supported.
453
1da177e4
LT		 454 Module snd-dummy
455 ----------------
456
457 Module for the dummy sound card. This "card" doesn't do any output
458 or input, but you may use this module for any application which
459 requires a sound card (like RealPlayer).
460
a4efc230
TI		 461 The power-management is supported.
462
1da177e4
LT		 463 Module snd-emu10k1
464 ------------------
465
466 Module for EMU10K1/EMU10k2 based PCI sound cards.
467 * Sound Blaster Live!
468 * Sound Blaster PCI 512
469 * Emu APS (partially supported)
470 * Sound Blaster Audigy
471
472 extin - bitmap of available external inputs for FX8010 (see bellow)
473 extout - bitmap of available external outputs for FX8010 (see bellow)
474 seq_ports - allocated sequencer ports (4 by default)
475 max_synth_voices - limit of voices used for wavetable (64 by default)
476 max_buffer_size - specifies the maximum size of wavetable/pcm buffers
477 given in MB unit. Default value is 128.
478 enable_ir - enable IR
479
0ef797c5 480 This module supports multiple cards and autoprobe.
1da177e4
LT		 481
482 Input & Output configurations [extin/extout]
483 * Creative Card wo/Digital out [0x0003/0x1f03]
484 * Creative Card w/Digital out [0x0003/0x1f0f]
485 * Creative Card w/Digital CD in [0x000f/0x1f0f]
486 * Creative Card wo/Digital out + LiveDrive [0x3fc3/0x1fc3]
487 * Creative Card w/Digital out + LiveDrive [0x3fc3/0x1fcf]
488 * Creative Card w/Digital CD in + LiveDrive [0x3fcf/0x1fcf]
489 * Creative Card wo/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
490 * Creative Card w/Digital out + Digital I/O 2 [0x0fc3/0x1f0f]
491 * Creative Card w/Digital CD in + Digital I/O 2 [0x0fcf/0x1f0f]
492 * Creative Card 5.1/w Digital out + LiveDrive [0x3fc3/0x1fff]
493 * Creative Card 5.1 (c) 2003 [0x3fc3/0x7cff]
494 * Creative Card all ins and outs [0x3fff/0x7fff]
495
a4efc230
TI		 496 The power-management is supported.
497
1da177e4
LT		 498 Module snd-emu10k1x
499 -------------------
500
501 Module for Creative Emu10k1X (SB Live Dell OEM version)
502
0ef797c5 503 This module supports multiple cards.
1da177e4
LT		 504
505 Module snd-ens1370
506 ------------------
507
508 Module for Ensoniq AudioPCI ES1370 PCI sound cards.
509 * SoundBlaster PCI 64
510 * SoundBlaster PCI 128
511
512 joystick - Enable joystick (default off)
513
0ef797c5 514 This module supports multiple cards and autoprobe.
1da177e4
LT		 515
516 Module snd-ens1371
517 ------------------
518
519 Module for Ensoniq AudioPCI ES1371 PCI sound cards.
520 * SoundBlaster PCI 64
521 * SoundBlaster PCI 128
522 * SoundBlaster Vibra PCI
523
524 joystick_port - port # for joystick (0x200,0x208,0x210,0x218),
525 0 = disable (default), 1 = auto-detect
526
0ef797c5 527 This module supports multiple cards and autoprobe.
1da177e4
LT		 528
529 Module snd-es968
530 ----------------
531
532 Module for sound cards based on ESS ES968 chip (PnP only).
533
534 port - port # for ES968 (SB8) chip (PnP setup)
535 irq - IRQ # for ES968 (SB8) chip (PnP setup)
536 dma1 - DMA # for ES968 (SB8) chip (PnP setup)
537
0ef797c5 538 This module supports multiple cards, PnP and autoprobe.
1da177e4 539
a4efc230
TI		 540 The power-management is supported.
541
1da177e4
LT		 542 Module snd-es1688
543 -----------------
544
545 Module for ESS AudioDrive ES-1688 and ES-688 sound cards.
546
547 port - port # for ES-1688 chip (0x220,0x240,0x260)
548 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
549 irq - IRQ # for ES-1688 chip (5,7,9,10)
550 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
551 dma8 - DMA # for ES-1688 chip (0,1,3)
552
0ef797c5 553 This module supports multiple cards and autoprobe (without MPU-401 port).
1da177e4
LT		 554
555 Module snd-es18xx
556 -----------------
557
558 Module for ESS AudioDrive ES-18xx sound cards.
559
560 port - port # for ES-18xx chip (0x220,0x240,0x260)
561 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable (default)
562 fm_port - port # for FM (optional, not used)
563 irq - IRQ # for ES-18xx chip (5,7,9,10)
564 dma1 - first DMA # for ES-18xx chip (0,1,3)
565 dma2 - first DMA # for ES-18xx chip (0,1,3)
566 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
567
0ef797c5
CL		 568 This module supports multiple cards, ISA PnP and autoprobe (without MPU-401
569 port if native ISA PnP routines are not used).
1da177e4
LT		 570 When dma2 is equal with dma1, the driver works as half-duplex.
571
572 The power-management is supported.
573
574 Module snd-es1938
575 -----------------
576
577 Module for sound cards based on ESS Solo-1 (ES1938,ES1946) chips.
578
0ef797c5 579 This module supports multiple cards and autoprobe.
1da177e4 580
a4efc230
TI		 581 The power-management is supported.
582
1da177e4
LT		 583 Module snd-es1968
584 -----------------
585
586 Module for sound cards based on ESS Maestro-1/2/2E (ES1968/ES1978) chips.
587
588 total_bufsize - total buffer size in kB (1-4096kB)
589 pcm_substreams_p - playback channels (1-8, default=2)
590 pcm_substreams_c - capture channels (1-8, default=0)
591 clock - clock (0 = auto-detection)
592 use_pm - support the power-management (0 = off, 1 = on,
593 2 = auto (default))
594 enable_mpu - enable MPU401 (0 = off, 1 = on, 2 = auto (default))
595 joystick - enable joystick (default off)
596
0ef797c5 597 This module supports multiple cards and autoprobe.
1da177e4
LT		 598
599 The power-management is supported.
600
601 Module snd-fm801
602 ----------------
603
604 Module for ForteMedia FM801 based PCI sound cards.
605
606 tea575x_tuner - Enable TEA575x tuner
607 - 1 = MediaForte 256-PCS
608 - 2 = MediaForte 256-PCPR
609 - 3 = MediaForte 64-PCR
610 - High 16-bits are video (radio) device number + 1
611 - example: 0x10002 (MediaForte 256-PCPR, device 1)
612
0ef797c5 613 This module supports multiple cards and autoprobe.
1da177e4 614
a4efc230
TI		 615 The power-management is supported.
616
1da177e4
LT		 617 Module snd-gusclassic
618 ---------------------
619
620 Module for Gravis UltraSound Classic sound card.
621
622 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
623 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
624 dma1 - DMA # for GF1 chip (1,3,5,6,7)
625 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
626 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
627 voices - GF1 voices limit (14-32)
628 pcm_voices - reserved PCM voices
629
0ef797c5 630 This module supports multiple cards and autoprobe.
1da177e4
LT		 631
632 Module snd-gusextreme
633 ---------------------
634
635 Module for Gravis UltraSound Extreme (Synergy ViperMax) sound card.
636
637 port - port # for ES-1688 chip (0x220,0x230,0x240,0x250,0x260)
638 gf1_port - port # for GF1 chip (0x210,0x220,0x230,0x240,0x250,0x260,0x270)
639 mpu_port - port # for MPU-401 port (0x300,0x310,0x320,0x330), -1 = disable
640 irq - IRQ # for ES-1688 chip (5,7,9,10)
641 gf1_irq - IRQ # for GF1 chip (3,5,9,11,12,15)
642 mpu_irq - IRQ # for MPU-401 port (5,7,9,10)
643 dma8 - DMA # for ES-1688 chip (0,1,3)
644 dma1 - DMA # for GF1 chip (1,3,5,6,7)
645 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
646 voices - GF1 voices limit (14-32)
647 pcm_voices - reserved PCM voices
648
0ef797c5 649 This module supports multiple cards and autoprobe (without MPU-401 port).
1da177e4
LT		 650
651 Module snd-gusmax
652 -----------------
653
654 Module for Gravis UltraSound MAX sound card.
655
656 port - port # for GF1 chip (0x220,0x230,0x240,0x250,0x260)
657 irq - IRQ # for GF1 chip (3,5,9,11,12,15)
658 dma1 - DMA # for GF1 chip (1,3,5,6,7)
659 dma2 - DMA # for GF1 chip (1,3,5,6,7,-1=disable)
660 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
661 voices - GF1 voices limit (14-32)
662 pcm_voices - reserved PCM voices
663
0ef797c5 664 This module supports multiple cards and autoprobe.
1da177e4
LT		 665
666 Module snd-hda-intel
667 --------------------
668
fc20a562
TI		 669 Module for Intel HD Audio (ICH6, ICH6M, ICH7), ATI SB450,
670 VIA VT8251/VT8237A
1da177e4
LT		 671
672 model - force the model name
6243008b 673 position_fix - Fix DMA pointer (0 = auto, 1 = none, 2 = POSBUF, 3 = FIFO size)
1da177e4 674
b7fe4622 675 This module supports one card and autoprobe.
1da177e4
LT		 676
677 Each codec may have a model table for different configurations.
678 If your machine isn't listed there, the default (usually minimal)
679 configuration is set up. You can pass "model=<name>" option to
680 specify a certain model in such a case. There are different
681 models depending on the codec chip.
682
683 Model name Description
684 ---------- -----------
685 ALC880
686 3stack 3-jack in back and a headphone out
687 3stack-digout 3-jack in back, a HP out and a SPDIF out
688 5stack 5-jack in back, 2-jack in front
689 5stack-digout 5-jack in back, 2-jack in front, a SPDIF out
b6482d48
TI		 690 6stack 6-jack in back, 2-jack in front
691 6stack-digout 6-jack with a SPDIF out
1da177e4 692 w810 3-jack
dfc0ff62 693 z71v 3-jack (HP shared SPDIF)
e9edcee0
TI		 694 asus 3-jack
695 uniwill 3-jack
696 F1734 2-jack
b6482d48
TI		 697 test for testing/debugging purpose, almost all controls can be
698 adjusted. Appearing only when compiled with
699 $CONFIG_SND_DEBUG=y
1da177e4 700
21be3d16
TI		 701 ALC260
702 hp HP machines
703 fujitsu Fujitsu S7020
704
1da177e4
LT		 705 CMI9880
706 minimal 3-jack in back
707 min_fp 3-jack in back, 2-jack in front
708 full 6-jack in back, 2-jack in front
709 full_dig 6-jack in back, 2-jack in front, SPDIF I/O
710 allout 5-jack in back, 2-jack in front, SPDIF out
e9edcee0 711 auto auto-config reading BIOS (default)
1da177e4 712
6243008b
TI		 713 If the default configuration doesn't work and one of the above
714 matches with your device, report it together with the PCI
715 subsystem ID (output of "lspci -nv") to ALSA BTS or alsa-devel
716 ML (see the section "Links and Addresses").
717
c74db86b
TI		 718 Note 2: If you get click noises on output, try the module option
719 position_fix=1 or 2. position_fix=1 will use the SD_LPIB
720 register value without FIFO size correction as the current
721 DMA pointer. position_fix=2 will make the driver to use
722 the position buffer instead of reading SD_LPIB register.
723 (Usually SD_LPLIB register is more accurate than the
724 position buffer.)
725
a4efc230
TI		 726 The power-management is supported.
727
1da177e4
LT		 728 Module snd-hdsp
729 ---------------
730
731 Module for RME Hammerfall DSP audio interface(s)
732
0ef797c5 733 This module supports multiple cards.
1da177e4
LT		 734
735 Note: The firmware data can be automatically loaded via hotplug
736 when CONFIG_FW_LOADER is set. Otherwise, you need to load
737 the firmware via hdsploader utility included in alsa-tools
738 package.
739 The firmware data is found in alsa-firmware package.
740
741 Note: snd-page-alloc module does the job which snd-hammerfall-mem
742 module did formerly. It will allocate the buffers in advance
743 when any HDSP cards are found. To make the buffer
744 allocation sure, load snd-page-alloc module in the early
b6a96915
TI		 745 stage of boot sequence. See "Early Buffer Allocation"
746 section.
1da177e4 747
5470440a
TI		 748 Module snd-hdspm
749 ----------------
750
751 Module for RME HDSP MADI board.
752
753 precise_ptr - Enable precise pointer, or disable.
754 line_outs_monitor - Send playback streams to analog outs by default.
755 enable_monitor - Enable Analog Out on Channel 63/64 by default.
756
757 See hdspm.txt for details.
758
1da177e4
LT		 759 Module snd-ice1712
760 ------------------
761
762 Module for Envy24 (ICE1712) based PCI sound cards.
763 * MidiMan M Audio Delta 1010
764 * MidiMan M Audio Delta 1010LT
765 * MidiMan M Audio Delta DiO 2496
766 * MidiMan M Audio Delta 66
767 * MidiMan M Audio Delta 44
768 * MidiMan M Audio Delta 410
769 * MidiMan M Audio Audiophile 2496
770 * TerraTec EWS 88MT
771 * TerraTec EWS 88D
772 * TerraTec EWX 24/96
773 * TerraTec DMX 6Fire
c9bce91f 774 * TerraTec Phase 88
1da177e4
LT		 775 * Hoontech SoundTrack DSP 24
776 * Hoontech SoundTrack DSP 24 Value
777 * Hoontech SoundTrack DSP 24 Media 7.1
c9bce91f 778 * Event Electronics, EZ8
1da177e4 779 * Digigram VX442
c9bce91f 780 * Lionstracs, Mediastaton
1da177e4
LT		 781
782 model - Use the given board model, one of the following:
783 delta1010, dio2496, delta66, delta44, audiophile, delta410,
784 delta1010lt, vx442, ewx2496, ews88mt, ews88mt_new, ews88d,
c9bce91f
TI		 785 dmx6fire, dsp24, dsp24_value, dsp24_71, ez8,
786 phase88, mediastation
1da177e4
LT		 787 omni - Omni I/O support for MidiMan M-Audio Delta44/66
788 cs8427_timeout - reset timeout for the CS8427 chip (S/PDIF transciever)
789 in msec resolution, default value is 500 (0.5 sec)
790
0ef797c5 791 This module supports multiple cards and autoprobe. Note: The consumer part
1da177e4
LT		 792 is not used with all Envy24 based cards (for example in the MidiMan Delta
793 serie).
794
c9bce91f
TI		 795 Note: The supported board is detected by reading EEPROM or PCI
796 SSID (if EEPROM isn't available). You can override the
797 model by passing "model" module option in case that the
798 driver isn't configured properly or you want to try another
799 type for testing.
800
1da177e4
LT		 801 Module snd-ice1724
802 ------------------
803
c9bce91f 804 Module for Envy24HT (VT/ICE1724), Envy24PT (VT1720) based PCI sound cards.
1da177e4
LT		 805 * MidiMan M Audio Revolution 7.1
806 * AMP Ltd AUDIO2000
c9bce91f
TI		 807 * TerraTec Aureon 5.1 Sky
808 * TerraTec Aureon 7.1 Space
809 * TerraTec Aureon 7.1 Universe
810 * TerraTec Phase 22
811 * TerraTec Phase 28
812 * AudioTrak Prodigy 7.1
813 * AudioTrak Prodigy 192
814 * Pontis MS300
815 * Albatron K8X800 Pro II
816 * Chaintech ZNF3-150
817 * Chaintech ZNF3-250
818 * Chaintech 9CJS
8cfbbac6 819 * Chaintech AV-710
c9bce91f 820 * Shuttle SN25P
1da177e4
LT		 821
822 model - Use the given board model, one of the following:
c9bce91f 823 revo71, amp2000, prodigy71, prodigy192, aureon51,
8cfbbac6
TI		 824 aureon71, universe, k8x800, phase22, phase28, ms300,
825 av710
1da177e4 826
0ef797c5 827 This module supports multiple cards and autoprobe.
1da177e4 828
c9bce91f
TI		 829 Note: The supported board is detected by reading EEPROM or PCI
830 SSID (if EEPROM isn't available). You can override the
831 model by passing "model" module option in case that the
832 driver isn't configured properly or you want to try another
833 type for testing.
834
1da177e4
LT		 835 Module snd-intel8x0
836 -------------------
837
838 Module for AC'97 motherboards from Intel and compatibles.
839 * Intel i810/810E, i815, i820, i830, i84x, MX440
840 * SiS 7012 (SiS 735)
841 * NVidia NForce, NForce2
842 * AMD AMD768, AMD8111
843 * ALi m5455
844
845 ac97_clock - AC'97 codec clock base (0 = auto-detect)
846 ac97_quirk - AC'97 workaround for strange hardware
6243008b 847 See "AC97 Quirk Option" section below.
1da177e4 848 buggy_irq - Enable workaround for buggy interrupts on some
a06147d2
TI		 849 motherboards (default yes on nForce chips,
850 otherwise off)
851 buggy_semaphore - Enable workaround for hardwares with buggy
852 semaphores (e.g. on some ASUS laptops)
853 (default off)
1da177e4 854
b7fe4622 855 This module supports one chip and autoprobe.
1da177e4
LT		 856
857 Note: the latest driver supports auto-detection of chip clock.
858 if you still encounter too fast playback, specify the clock
859 explicitly via the module option "ac97_clock=41194".
860
861 Joystick/MIDI ports are not supported by this driver. If your
862 motherboard has these devices, use the ns558 or snd-mpu401
863 modules, respectively.
864
1da177e4
LT		 865 The power-management is supported.
866
867 Module snd-intel8x0m
868 --------------------
869
870 Module for Intel ICH (i8x0) chipset MC97 modems.
871
872 ac97_clock - AC'97 codec clock base (0 = auto-detect)
873
b7fe4622 874 This module supports one card and autoprobe.
1da177e4
LT		 875
876 Note: The default index value of this module is -2, i.e. the first
877 slot is excluded.
878
a4efc230
TI		 879 The power-management is supported.
880
1da177e4
LT		 881 Module snd-interwave
882 --------------------
883
884 Module for Gravis UltraSound PnP, Dynasonic 3-D/Pro, STB Sound Rage 32
885 and other sound cards based on AMD InterWave (tm) chip.
886
887 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
888 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
889 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
890 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
891 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
892 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
893 pcm_voices - reserved PCM voices for the synthesizer (default 2)
894 effect - 1 = InterWave effects enable (default 0);
895 requires 8 voices
896
0ef797c5 897 This module supports multiple cards, autoprobe and ISA PnP.
1da177e4
LT		 898
899 Module snd-interwave-stb
900 ------------------------
901
902 Module for UltraSound 32-Pro (sound card from STB used by Compaq)
903 and other sound cards based on AMD InterWave (tm) chip with TEA6330T
904 circuit for extended control of bass, treble and master volume.
905
906 port - port # for InterWave chip (0x210,0x220,0x230,0x240,0x250,0x260)
907 port_tc - tone control (i2c bus) port # for TEA6330T chip (0x350,0x360,0x370,0x380)
908 irq - IRQ # for InterWave chip (3,5,9,11,12,15)
909 dma1 - DMA # for InterWave chip (0,1,3,5,6,7)
910 dma2 - DMA # for InterWave chip (0,1,3,5,6,7,-1=disable)
911 joystick_dac - 0 to 31, (0.59V-4.52V or 0.389V-2.98V)
912 midi - 1 = MIDI UART enable, 0 = MIDI UART disable (default)
913 pcm_voices - reserved PCM voices for the synthesizer (default 2)
914 effect - 1 = InterWave effects enable (default 0);
915 requires 8 voices
916
0ef797c5 917 This module supports multiple cards, autoprobe and ISA PnP.
1da177e4
LT		 918
919 Module snd-korg1212
920 -------------------
921
922 Module for Korg 1212 IO PCI card
923
0ef797c5 924 This module supports multiple cards.
1da177e4
LT		 925
926 Module snd-maestro3
927 -------------------
928
929 Module for Allegro/Maestro3 chips
930
931 external_amp - enable external amp (enabled by default)
932 amp_gpio - GPIO pin number for external amp (0-15) or
933 -1 for default pin (8 for allegro, 1 for
934 others)
935
0ef797c5 936 This module supports autoprobe and multiple chips.
1da177e4
LT		 937
938 Note: the binding of amplifier is dependent on hardware.
939 If there is no sound even though all channels are unmuted, try to
940 specify other gpio connection via amp_gpio option.
941 For example, a Panasonic notebook might need "amp_gpio=0x0d"
942 option.
943
944 The power-management is supported.
945
946 Module snd-mixart
947 -----------------
948
949 Module for Digigram miXart8 sound cards.
950
0ef797c5 951 This module supports multiple cards.
1da177e4
LT		 952 Note: One miXart8 board will be represented as 4 alsa cards.
953 See MIXART.txt for details.
954
955 When the driver is compiled as a module and the hotplug firmware
956 is supported, the firmware data is loaded via hotplug automatically.
957 Install the necessary firmware files in alsa-firmware package.
958 When no hotplug fw loader is available, you need to load the
959 firmware via mixartloader utility in alsa-tools package.
960
961 Module snd-mpu401
962 -----------------
963
964 Module for MPU-401 UART devices.
965
966 port - port number or -1 (disable)
967 irq - IRQ number or -1 (disable)
968 pnp - PnP detection - 0 = disable, 1 = enable (default)
969
0ef797c5 970 This module supports multiple devices and PnP.
1da177e4
LT		 971
972 Module snd-mtpav
973 ----------------
974
975 Module for MOTU MidiTimePiece AV multiport MIDI (on the parallel
976 port).
977
978 port - I/O port # for MTPAV (0x378,0x278, default=0x378)
979 irq - IRQ # for MTPAV (7,5, default=7)
980 hwports - number of supported hardware ports, default=8.
981
982 Module supports only 1 card. This module has no enable option.
983
984 Module snd-nm256
985 ----------------
986
987 Module for NeoMagic NM256AV/ZX chips
988
989 playback_bufsize - max playback frame size in kB (4-128kB)
990 capture_bufsize - max capture frame size in kB (4-128kB)
991 force_ac97 - 0 or 1 (disabled by default)
992 buffer_top - specify buffer top address
993 use_cache - 0 or 1 (disabled by default)
994 vaio_hack - alias buffer_top=0x25a800
995 reset_workaround - enable AC97 RESET workaround for some laptops
d1f38cf9
TI		 996 reset_workaround2 - enable extended AC97 RESET workaround for some
997 other laptops
1da177e4 998
8a3fb4d0 999 This module supports one chip and autoprobe.
1da177e4
LT		 1000
1001 The power-management is supported.
1002
1003 Note: on some notebooks the buffer address cannot be detected
1004 automatically, or causes hang-up during initialization.
1005 In such a case, specify the buffer top address explicity via
1006 buffer_top option.
1007 For example,
1008 Sony F250: buffer_top=0x25a800
1009 Sony F270: buffer_top=0x272800
1010 The driver supports only ac97 codec. It's possible to force
1011 to initialize/use ac97 although it's not detected. In such a
1012 case, use force_ac97=1 option - but *NO* guarantee whether it
1013 works!
1014
1015 Note: The NM256 chip can be linked internally with non-AC97
1016 codecs. This driver supports only the AC97 codec, and won't work
1017 with machines with other (most likely CS423x or OPL3SAx) chips,
1018 even though the device is detected in lspci. In such a case, try
1019 other drivers, e.g. snd-cs4232 or snd-opl3sa2. Some has ISA-PnP
6243008b 1020 but some doesn't have ISA PnP. You'll need to specify isapnp=0
1da177e4
LT		 1021 and proper hardware parameters in the case without ISA PnP.
1022
1023 Note: some laptops need a workaround for AC97 RESET. For the
1024 known hardware like Dell Latitude LS and Sony PCG-F305, this
1025 workaround is enabled automatically. For other laptops with a
1026 hard freeze, you can try reset_workaround=1 option.
1027
d1f38cf9
TI		 1028 Note: Dell Latitude CSx laptops have another problem regarding
1029 AC97 RESET. On these laptops, reset_workaround2 option is
1030 turned on as default. This option is worth to try if the
1031 previous reset_workaround option doesn't help.
1032
1da177e4
LT		 1033 Note: This driver is really crappy. It's a porting from the
1034 OSS driver, which is a result of black-magic reverse engineering.
1035 The detection of codec will fail if the driver is loaded *after*
1036 X-server as described above. You might be able to force to load
1037 the module, but it may result in hang-up. Hence, make sure that
1038 you load this module *before* X if you encounter this kind of
1039 problem.
1040
1041 Module snd-opl3sa2
1042 ------------------
1043
1044 Module for Yamaha OPL3-SA2/SA3 sound cards.
1045
1046 port - control port # for OPL3-SA chip (0x370)
1047 sb_port - SB port # for OPL3-SA chip (0x220,0x240)
1048 wss_port - WSS port # for OPL3-SA chip (0x530,0xe80,0xf40,0x604)
1049 midi_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1050 fm_port - FM port # for OPL3-SA chip (0x388), -1 = disable
1051 irq - IRQ # for OPL3-SA chip (5,7,9,10)
1052 dma1 - first DMA # for Yamaha OPL3-SA chip (0,1,3)
1053 dma2 - second DMA # for Yamaha OPL3-SA chip (0,1,3), -1 = disable
1054 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1055
0ef797c5 1056 This module supports multiple cards and ISA PnP. It does not support
1da177e4
LT		 1057 autoprobe (if ISA PnP is not used) thus all ports must be specified!!!
1058
1059 The power-management is supported.
1060
1061 Module snd-opti92x-ad1848
1062 -------------------------
1063
1064 Module for sound cards based on OPTi 82c92x and Analog Devices AD1848 chips.
1065 Module works with OAK Mozart cards as well.
1066
1067 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1068 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1069 fm_port - port # for OPL3 device (0x388)
1070 irq - IRQ # for WSS chip (5,7,9,10,11)
1071 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1072 dma1 - first DMA # for WSS chip (0,1,3)
1073
1074 This module supports only one card, autoprobe and PnP.
1075
1076 Module snd-opti92x-cs4231
1077 -------------------------
1078
1079 Module for sound cards based on OPTi 82c92x and Crystal CS4231 chips.
1080
1081 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1082 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1083 fm_port - port # for OPL3 device (0x388)
1084 irq - IRQ # for WSS chip (5,7,9,10,11)
1085 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1086 dma1 - first DMA # for WSS chip (0,1,3)
1087 dma2 - second DMA # for WSS chip (0,1,3)
1088
1089 This module supports only one card, autoprobe and PnP.
1090
1091 Module snd-opti93x
1092 ------------------
1093
1094 Module for sound cards based on OPTi 82c93x chips.
1095
1096 port - port # for WSS chip (0x530,0xe80,0xf40,0x604)
1097 mpu_port - port # for MPU-401 UART (0x300,0x310,0x320,0x330)
1098 fm_port - port # for OPL3 device (0x388)
1099 irq - IRQ # for WSS chip (5,7,9,10,11)
1100 mpu_irq - IRQ # for MPU-401 UART (5,7,9,10)
1101 dma1 - first DMA # for WSS chip (0,1,3)
1102 dma2 - second DMA # for WSS chip (0,1,3)
1103
1104 This module supports only one card, autoprobe and PnP.
1105
e12229b4
MB		 1106 Module snd-pcxhr
1107 ----------------
1108
1109 Module for Digigram PCXHR boards
1110
1111 This module supports multiple cards.
1112
1da177e4
LT		 1113 Module snd-powermac (on ppc only)
1114 ---------------------------------
1115
1116 Module for PowerMac, iMac and iBook on-board soundchips
1117
1118 enable_beep - enable beep using PCM (enabled as default)
1119
1120 Module supports autoprobe a chip.
1121
1122 Note: the driver may have problems regarding endianess.
1123
1124 The power-management is supported.
1125
2c484df0
TI		 1126 Module snd-pxa2xx-ac97 (on arm only)
1127 ------------------------------------
1128
1129 Module for AC97 driver for the Intel PXA2xx chip
1130
1131 For ARM architecture only.
1132
a4efc230
TI		 1133 The power-management is supported.
1134
1da177e4
LT		 1135 Module snd-rme32
1136 ----------------
1137
1138 Module for RME Digi32, Digi32 Pro and Digi32/8 (Sek'd Prodif32,
1139 Prodif96 and Prodif Gold) sound cards.
1140
0ef797c5 1141 This module supports multiple cards.
1da177e4
LT		 1142
1143 Module snd-rme96
1144 ----------------
1145
1146 Module for RME Digi96, Digi96/8 and Digi96/8 PRO/PAD/PST sound cards.
1147
0ef797c5 1148 This module supports multiple cards.
1da177e4
LT		 1149
1150 Module snd-rme9652
1151 ------------------
1152
1153 Module for RME Digi9652 (Hammerfall, Hammerfall-Light) sound cards.
1154
1155 precise_ptr - Enable precise pointer (doesn't work reliably).
1156 (default = 0)
1157
0ef797c5 1158 This module supports multiple cards.
1da177e4
LT		 1159
1160 Note: snd-page-alloc module does the job which snd-hammerfall-mem
1161 module did formerly. It will allocate the buffers in advance
1162 when any RME9652 cards are found. To make the buffer
1163 allocation sure, load snd-page-alloc module in the early
b6a96915
TI		 1164 stage of boot sequence. See "Early Buffer Allocation"
1165 section.
1da177e4
LT		 1166
1167 Module snd-sa11xx-uda1341 (on arm only)
1168 ---------------------------------------
1169
1170 Module for Philips UDA1341TS on Compaq iPAQ H3600 sound card.
1171
1172 Module supports only one card.
1173 Module has no enable and index options.
1174
a4efc230
TI		 1175 The power-management is supported.
1176
1da177e4
LT		 1177 Module snd-sb8
1178 --------------
1179
1180 Module for 8-bit SoundBlaster cards: SoundBlaster 1.0,
1181 SoundBlaster 2.0,
1182 SoundBlaster Pro
1183
1184 port - port # for SB DSP chip (0x220,0x240,0x260)
1185 irq - IRQ # for SB DSP chip (5,7,9,10)
1186 dma8 - DMA # for SB DSP chip (1,3)
1187
0ef797c5 1188 This module supports multiple cards and autoprobe.
1da177e4 1189
a4efc230
TI		 1190 The power-management is supported.
1191
1da177e4
LT		 1192 Module snd-sb16 and snd-sbawe
1193 -----------------------------
1194
1195 Module for 16-bit SoundBlaster cards: SoundBlaster 16 (PnP),
1196 SoundBlaster AWE 32 (PnP),
1197 SoundBlaster AWE 64 PnP
1198
1199 port - port # for SB DSP 4.x chip (0x220,0x240,0x260)
1200 mpu_port - port # for MPU-401 UART (0x300,0x330), -1 = disable
1201 awe_port - base port # for EMU8000 synthesizer (0x620,0x640,0x660)
1202 (snd-sbawe module only)
1203 irq - IRQ # for SB DSP 4.x chip (5,7,9,10)
1204 dma8 - 8-bit DMA # for SB DSP 4.x chip (0,1,3)
1205 dma16 - 16-bit DMA # for SB DSP 4.x chip (5,6,7)
1206 mic_agc - Mic Auto-Gain-Control - 0 = disable, 1 = enable (default)
1207 csp - ASP/CSP chip support - 0 = disable (default), 1 = enable
1208 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1209
0ef797c5 1210 This module supports multiple cards, autoprobe and ISA PnP.
1da177e4
LT		 1211
1212 Note: To use Vibra16X cards in 16-bit half duplex mode, you must
1213 disable 16bit DMA with dma16 = -1 module parameter.
1214 Also, all Sound Blaster 16 type cards can operate in 16-bit
1215 half duplex mode through 8-bit DMA channel by disabling their
1216 16-bit DMA channel.
1217
a4efc230
TI		 1218 The power-management is supported.
1219
1da177e4
LT		 1220 Module snd-sgalaxy
1221 ------------------
1222
1223 Module for Aztech Sound Galaxy sound card.
1224
1225 sbport - Port # for SB16 interface (0x220,0x240)
1226 wssport - Port # for WSS interface (0x530,0xe80,0xf40,0x604)
1227 irq - IRQ # (7,9,10,11)
1228 dma1 - DMA #
1229
0ef797c5 1230 This module supports multiple cards.
1da177e4 1231
a4efc230
TI		 1232 The power-management is supported.
1233
1da177e4
LT		 1234 Module snd-sscape
1235 -----------------
1236
1237 Module for ENSONIQ SoundScape PnP cards.
1238
1239 port - Port # (PnP setup)
1240 irq - IRQ # (PnP setup)
1241 mpu_irq - MPU-401 IRQ # (PnP setup)
1242 dma - DMA # (PnP setup)
1243
0ef797c5 1244 This module supports multiple cards. ISA PnP must be enabled.
1da177e4
LT		 1245 You need sscape_ctl tool in alsa-tools package for loading
1246 the microcode.
1247
1248 Module snd-sun-amd7930 (on sparc only)
1249 --------------------------------------
1250
1251 Module for AMD7930 sound chips found on Sparcs.
1252
0ef797c5 1253 This module supports multiple cards.
1da177e4
LT		 1254
1255 Module snd-sun-cs4231 (on sparc only)
1256 -------------------------------------
1257
1258 Module for CS4231 sound chips found on Sparcs.
1259
0ef797c5 1260 This module supports multiple cards.
1da177e4 1261
1bd9debf
TI		 1262 Module snd-sun-dbri (on sparc only)
1263 -----------------------------------
1264
1265 Module for DBRI sound chips found on Sparcs.
1266
0ef797c5 1267 This module supports multiple cards.
1bd9debf 1268
1da177e4
LT		 1269 Module snd-wavefront
1270 --------------------
1271
1272 Module for Turtle Beach Maui, Tropez and Tropez+ sound cards.
1273
1274 cs4232_pcm_port - Port # for CS4232 PCM interface.
1275 cs4232_pcm_irq - IRQ # for CS4232 PCM interface (5,7,9,11,12,15).
1276 cs4232_mpu_port - Port # for CS4232 MPU-401 interface.
1277 cs4232_mpu_irq - IRQ # for CS4232 MPU-401 interface (9,11,12,15).
1278 use_cs4232_midi - Use CS4232 MPU-401 interface
1279 (inaccessibly located inside your computer)
1280 ics2115_port - Port # for ICS2115
1281 ics2115_irq - IRQ # for ICS2115
1282 fm_port - FM OPL-3 Port #
1283 dma1 - DMA1 # for CS4232 PCM interface.
1284 dma2 - DMA2 # for CS4232 PCM interface.
1285 isapnp - ISA PnP detection - 0 = disable, 1 = enable (default)
1286
0ef797c5 1287 This module supports multiple cards and ISA PnP.
1da177e4
LT		 1288
1289 Module snd-sonicvibes
1290 ---------------------
1291
1292 Module for S3 SonicVibes PCI sound cards.
1293 * PINE Schubert 32 PCI
1294
1295 reverb - Reverb Enable - 1 = enable, 0 = disable (default)
1296 - SoundCard must have onboard SRAM for this.
1297 mge - Mic Gain Enable - 1 = enable, 0 = disable (default)
1298
0ef797c5 1299 This module supports multiple cards and autoprobe.
1da177e4
LT		 1300
1301 Module snd-serial-u16550
1302 ------------------------
1303
1304 Module for UART16550A serial MIDI ports.
1305
1306 port - port # for UART16550A chip
1307 irq - IRQ # for UART16550A chip, -1 = poll mode
1308 speed - speed in bauds (9600,19200,38400,57600,115200)
1309 38400 = default
1310 base - base for divisor in bauds (57600,115200,230400,460800)
1311 115200 = default
1312 outs - number of MIDI ports in a serial port (1-4)
1313 1 = default
1314 adaptor - Type of adaptor.
1315 0 = Soundcanvas, 1 = MS-124T, 2 = MS-124W S/A,
1316 3 = MS-124W M/B, 4 = Generic
1317
0ef797c5 1318 This module supports multiple cards. This module does not support autoprobe
1da177e4
LT		 1319 thus the main port must be specified!!! Other options are optional.
1320
1321 Module snd-trident
1322 ------------------
1323
1324 Module for Trident 4DWave DX/NX sound cards.
1325 * Best Union Miss Melody 4DWave PCI
1326 * HIS 4DWave PCI
1327 * Warpspeed ONSpeed 4DWave PCI
1328 * AzTech PCI 64-Q3D
1329 * Addonics SV 750
1330 * CHIC True Sound 4Dwave
1331 * Shark Predator4D-PCI
1332 * Jaton SonicWave 4D
1333
1334 pcm_channels - max channels (voices) reserved for PCM
1335 wavetable_size - max wavetable size in kB (4-?kb)
1336
0ef797c5 1337 This module supports multiple cards and autoprobe.
1da177e4
LT		 1338
1339 The power-management is supported.
1340
1341 Module snd-usb-audio
1342 --------------------
1343
1344 Module for USB audio and USB MIDI devices.
1345
1346 vid - Vendor ID for the device (optional)
1347 pid - Product ID for the device (optional)
1348
0ef797c5 1349 This module supports multiple devices, autoprobe and hotplugging.
1da177e4
LT		 1350
1351 Module snd-usb-usx2y
1352 --------------------
1353
1354 Module for Tascam USB US-122, US-224 and US-428 devices.
1355
0ef797c5 1356 This module supports multiple devices, autoprobe and hotplugging.
1da177e4
LT		 1357
1358 Note: you need to load the firmware via usx2yloader utility included
1359 in alsa-tools and alsa-firmware packages.
1360
1361 Module snd-via82xx
1362 ------------------
1363
1364 Module for AC'97 motherboards based on VIA 82C686A/686B, 8233,
2d7eb7cb 1365 8233A, 8233C, 8235, 8237 (south) bridge.
1da177e4
LT		 1366
1367 mpu_port - 0x300,0x310,0x320,0x330, otherwise obtain BIOS setup
1368 [VIA686A/686B only]
1369 joystick - Enable joystick (default off) [VIA686A/686B only]
1370 ac97_clock - AC'97 codec clock base (default 48000Hz)
1371 dxs_support - support DXS channels,
2d7eb7cb
SV		 1372 0 = auto (default), 1 = enable, 2 = disable,
1373 3 = 48k only, 4 = no VRA, 5 = enable any sample
1374 rate and different sample rates on different
1375 channels
1376 [VIA8233/C, 8235, 8237 only]
1da177e4 1377 ac97_quirk - AC'97 workaround for strange hardware
6243008b 1378 See "AC97 Quirk Option" section below.
1da177e4 1379
b7fe4622 1380 This module supports one chip and autoprobe.
1da177e4
LT		 1381
1382 Note: on some SMP motherboards like MSI 694D the interrupts might
1383 not be generated properly. In such a case, please try to
1384 set the SMP (or MPS) version on BIOS to 1.1 instead of
1385 default value 1.4. Then the interrupt number will be
1386 assigned under 15. You might also upgrade your BIOS.
1387
2d7eb7cb 1388 Note: VIA8233/5/7 (not VIA8233A) can support DXS (direct sound)
1da177e4 1389 channels as the first PCM. On these channels, up to 4
2d7eb7cb
SV		 1390 streams can be played at the same time, and the controller
1391 can perform sample rate conversion with separate rates for
1392 each channel.
1da177e4
LT		 1393 As default (dxs_support = 0), 48k fixed rate is chosen
1394 except for the known devices since the output is often
1395 noisy except for 48k on some mother boards due to the
1396 bug of BIOS.
2d7eb7cb 1397 Please try once dxs_support=5 and if it works on other
1da177e4
LT		 1398 sample rates (e.g. 44.1kHz of mp3 playback), please let us
1399 know the PCI subsystem vendor/device id's (output of
1400 "lspci -nv").
cdc27f3a
TI		 1401 If dxs_support=5 does not work, try dxs_support=4; if it
1402 doesn't work too, try dxs_support=1. (dxs_support=1 is
6243008b 1403 usually for old motherboards. The correct implemented
cdc27f3a 1404 board should work with 4 or 5.) If it still doesn't
1da177e4
LT		 1405 work and the default setting is ok, dxs_support=3 is the
1406 right choice. If the default setting doesn't work at all,
1407 try dxs_support=2 to disable the DXS channels.
1408 In any cases, please let us know the result and the
6243008b
TI		 1409 subsystem vendor/device ids. See "Links and Addresses"
1410 below.
1da177e4
LT		 1411
1412 Note: for the MPU401 on VIA823x, use snd-mpu401 driver
6243008b 1413 additionally. The mpu_port option is for VIA686 chips only.
1da177e4 1414
a4efc230
TI		 1415 The power-management is supported.
1416
1da177e4
LT		 1417 Module snd-via82xx-modem
1418 ------------------------
1419
1420 Module for VIA82xx AC97 modem
1421
1422 ac97_clock - AC'97 codec clock base (default 48000Hz)
1423
b7fe4622 1424 This module supports one card and autoprobe.
1da177e4
LT		 1425
1426 Note: The default index value of this module is -2, i.e. the first
1427 slot is excluded.
1428
a4efc230
TI		 1429 The power-management is supported.
1430
1da177e4
LT		 1431 Module snd-virmidi
1432 ------------------
1433
1434 Module for virtual rawmidi devices.
1435 This module creates virtual rawmidi devices which communicate
1436 to the corresponding ALSA sequencer ports.
1437
0ef797c5 1438 midi_devs - MIDI devices # (1-4, default=4)
1da177e4 1439
0ef797c5 1440 This module supports multiple cards.
1da177e4
LT		 1441
1442 Module snd-vx222
1443 ----------------
1444
1445 Module for Digigram VX-Pocket VX222, V222 v2 and Mic cards.
1446
1447 mic - Enable Microphone on V222 Mic (NYI)
1448 ibl - Capture IBL size. (default = 0, minimum size)
1449
0ef797c5 1450 This module supports multiple cards.
1da177e4
LT		 1451
1452 When the driver is compiled as a module and the hotplug firmware
1453 is supported, the firmware data is loaded via hotplug automatically.
1454 Install the necessary firmware files in alsa-firmware package.
1455 When no hotplug fw loader is available, you need to load the
1456 firmware via vxloader utility in alsa-tools package. To invoke
1457 vxloader automatically, add the following to /etc/modprobe.conf
1458
1459 install snd-vx222 /sbin/modprobe --first-time -i snd-vx222 && /usr/bin/vxloader
1460
1461 (for 2.2/2.4 kernels, add "post-install /usr/bin/vxloader" to
1462 /etc/modules.conf, instead.)
1463 IBL size defines the interrupts period for PCM. The smaller size
1464 gives smaller latency but leads to more CPU consumption, too.
1465 The size is usually aligned to 126. As default (=0), the smallest
1466 size is chosen. The possible IBL values can be found in
1467 /proc/asound/cardX/vx-status proc file.
1468
a4efc230
TI		 1469 The power-management is supported.
1470
1da177e4
LT		 1471 Module snd-vxpocket
1472 -------------------
1473
6d00a312 1474 Module for Digigram VX-Pocket VX2 and 440 PCMCIA cards.
1da177e4
LT		 1475
1476 ibl - Capture IBL size. (default = 0, minimum size)
1477
0ef797c5 1478 This module supports multiple cards. The module is compiled only when
1da177e4
LT		 1479 PCMCIA is supported on kernel.
1480
6243008b
TI		 1481 With the older 2.6.x kernel, to activate the driver via the card
1482 manager, you'll need to set up /etc/pcmcia/vxpocket.conf. See the
1483 sound/pcmcia/vx/vxpocket.c. 2.6.13 or later kernel requires no
1484 longer require a config file.
1da177e4
LT		 1485
1486 When the driver is compiled as a module and the hotplug firmware
1487 is supported, the firmware data is loaded via hotplug automatically.
1488 Install the necessary firmware files in alsa-firmware package.
1489 When no hotplug fw loader is available, you need to load the
1490 firmware via vxloader utility in alsa-tools package.
1491
1492 About capture IBL, see the description of snd-vx222 module.
1493
1494 Note: the driver is build only when CONFIG_ISA is set.
1495
6243008b
TI		 1496 Note2: snd-vxp440 driver is merged to snd-vxpocket driver since
1497 ALSA 1.0.10.
1498
a4efc230
TI		 1499 The power-management is supported.
1500
1da177e4
LT		 1501 Module snd-ymfpci
1502 -----------------
1503
1504 Module for Yamaha PCI chips (YMF72x, YMF74x & YMF75x).
1505
1506 mpu_port - 0x300,0x330,0x332,0x334, 0 (disable) by default,
1507 1 (auto-detect for YMF744/754 only)
1508 fm_port - 0x388,0x398,0x3a0,0x3a8, 0 (disable) by default
1509 1 (auto-detect for YMF744/754 only)
1510 joystick_port - 0x201,0x202,0x204,0x205, 0 (disable) by default,
1511 1 (auto-detect)
1512 rear_switch - enable shared rear/line-in switch (bool)
1513
0ef797c5 1514 This module supports autoprobe and multiple chips.
1da177e4
LT		 1515
1516 The power-management is supported.
1517
1518 Module snd-pdaudiocf
1519 --------------------
1520
1521 Module for Sound Core PDAudioCF sound card.
1522
1523 Note: the driver is build only when CONFIG_ISA is set.
1524
a4efc230
TI		 1525 The power-management is supported.
1526
1da177e4 1527
6243008b
TI		 1528AC97 Quirk Option
1529=================
1530
1531The ac97_quirk option is used to enable/override the workaround for
1532specific devices on drivers for on-board AC'97 controllers like
1533snd-intel8x0. Some hardware have swapped output pins between Master
1534and Headphone, or Surround (thanks to confusion of AC'97
1535specifications from version to version :-)
1536
1537The driver provides the auto-detection of known problematic devices,
1538but some might be unknown or wrongly detected. In such a case, pass
1539the proper value with this option.
1540
1541The following strings are accepted:
1542 - default Don't override the default setting
10e4097f 1543 - none Disable the quirk
6243008b
TI		 1544 - hp_only Bind Master and Headphone controls as a single control
1545 - swap_hp Swap headphone and master controls
1546 - swap_surround Swap master and surround controls
1547 - ad_sharing For AD1985, turn on OMS bit and use headphone
1548 - alc_jack For ALC65x, turn on the jack sense mode
1549 - inv_eapd Inverted EAPD implementation
1550 - mute_led Bind EAPD bit for turning on/off mute LED
1551
1552For backward compatibility, the corresponding integer value -1, 0,
1553... are accepted, too.
1554
1555For example, if "Master" volume control has no effect on your device
1556but only "Headphone" does, pass ac97_quirk=hp_only module option.
1557
1558
1da177e4
LT		 1559Configuring Non-ISAPNP Cards
1560============================
1561
1562When the kernel is configured with ISA-PnP support, the modules
1563supporting the isapnp cards will have module options "isapnp".
1564If this option is set, *only* the ISA-PnP devices will be probed.
1565For probing the non ISA-PnP cards, you have to pass "isapnp=0" option
1566together with the proper i/o and irq configuration.
1567
1568When the kernel is configured without ISA-PnP support, isapnp option
1569will be not built in.
1570
1571
1572Module Autoloading Support
1573==========================
1574
1575The ALSA drivers can be loaded automatically on demand by defining
1576module aliases. The string 'snd-card-%1' is requested for ALSA native
1577devices where %i is sound card number from zero to seven.
1578
1579To auto-load an ALSA driver for OSS services, define the string
1580'sound-slot-%i' where %i means the slot number for OSS, which
1581corresponds to the card index of ALSA. Usually, define this
d533f671 1582as the same card module.
1da177e4
LT		 1583
1584An example configuration for a single emu10k1 card is like below:
1585----- /etc/modprobe.conf
1586alias snd-card-0 snd-emu10k1
1587alias sound-slot-0 snd-emu10k1
1588----- /etc/modprobe.conf
1589
1590The available number of auto-loaded sound cards depends on the module
1591option "cards_limit" of snd module. As default it's set to 1.
1592To enable the auto-loading of multiple cards, specify the number of
1593sound cards in that option.
1594
1595When multiple cards are available, it'd better to specify the index
1596number for each card via module option, too, so that the order of
1597cards is kept consistent.
1598
1599An example configuration for two sound cards is like below:
1600
1601----- /etc/modprobe.conf
1602# ALSA portion
1603options snd cards_limit=2
1604alias snd-card-0 snd-interwave
1605alias snd-card-1 snd-ens1371
1606options snd-interwave index=0
1607options snd-ens1371 index=1
1608# OSS/Free portion
1609alias sound-slot-0 snd-interwave
1610alias sound-slot-1 snd-ens1371
1611----- /etc/moprobe.conf
1612
1613In this example, the interwave card is always loaded as the first card
1614(index 0) and ens1371 as the second (index 1).
1615
1616
1617ALSA PCM devices to OSS devices mapping
1618=======================================
1619
1620/dev/snd/pcmC0D0[c|p] -> /dev/audio0 (/dev/audio) -> minor 4
1621/dev/snd/pcmC0D0[c|p] -> /dev/dsp0 (/dev/dsp) -> minor 3
1622/dev/snd/pcmC0D1[c|p] -> /dev/adsp0 (/dev/adsp) -> minor 12
1623/dev/snd/pcmC1D0[c|p] -> /dev/audio1 -> minor 4+16 = 20
1624/dev/snd/pcmC1D0[c|p] -> /dev/dsp1 -> minor 3+16 = 19
1625/dev/snd/pcmC1D1[c|p] -> /dev/adsp1 -> minor 12+16 = 28
1626/dev/snd/pcmC2D0[c|p] -> /dev/audio2 -> minor 4+32 = 36
1627/dev/snd/pcmC2D0[c|p] -> /dev/dsp2 -> minor 3+32 = 39
1628/dev/snd/pcmC2D1[c|p] -> /dev/adsp2 -> minor 12+32 = 44
1629
1630The first number from /dev/snd/pcmC{X}D{Y}[c|p] expression means
1631sound card number and second means device number. The ALSA devices
1632have either 'c' or 'p' suffix indicating the direction, capture and
1633playback, respectively.
1634
1635Please note that the device mapping above may be varied via the module
1636options of snd-pcm-oss module.
1637
1638
1639DEVFS support
1640=============
1641
1642The ALSA driver fully supports the devfs extension.
1643You should add lines below to your devfsd.conf file:
1644
1645LOOKUP snd MODLOAD ACTION snd
1646REGISTER ^sound/.* PERMISSIONS root.audio 660
1647REGISTER ^snd/.* PERMISSIONS root.audio 660
1648
1649Warning: These lines assume that you have the audio group in your system.
1650 Otherwise replace audio word with another group name (root for
1651 example).
1652
1653
1654Proc interfaces (/proc/asound)
1655==============================
1656
1657/proc/asound/card#/pcm#[cp]/oss
1658-------------------------------
1659 String "erase" - erase all additional informations about OSS applications
1660 String "<app_name> <fragments> <fragment_size> [<options>]"
1661
1662 <app_name> - name of application with (higher priority) or without path
1663 <fragments> - number of fragments or zero if auto
1664 <fragment_size> - size of fragment in bytes or zero if auto
1665 <options> - optional parameters
1666 - disable the application tries to open a pcm device for
1667 this channel but does not want to use it.
1668 (Cause a bug or mmap needs)
1669 It's good for Quake etc...
1670 - direct don't use plugins
1671 - block force block mode (rvplayer)
1672 - non-block force non-block mode
1673 - whole-frag write only whole fragments (optimization affecting
1674 playback only)
1675 - no-silence do not fill silence ahead to avoid clicks
10f69f9e
TI		 1676 - buggy-ptr Returns the whitespace blocks in GETOPTR ioctl
1677 instead of filled blocks
1da177e4
LT		 1678
1679 Example: echo "x11amp 128 16384" > /proc/asound/card0/pcm0p/oss
1680 echo "squake 0 0 disable" > /proc/asound/card0/pcm0c/oss
1681 echo "rvplayer 0 0 block" > /proc/asound/card0/pcm0p/oss
1682
1683
b6a96915
TI		 1684Early Buffer Allocation
1685=======================
1686
1687Some drivers (e.g. hdsp) require the large contiguous buffers, and
1688sometimes it's too late to find such spaces when the driver module is
1689actually loaded due to memory fragmentation. You can pre-allocate the
1690PCM buffers by loading snd-page-alloc module and write commands to its
1691proc file in prior, for example, in the early boot stage like
1692/etc/init.d/*.local scripts.
1693
1694Reading the proc file /proc/drivers/snd-page-alloc shows the current
1695usage of page allocation. In writing, you can send the following
1696commands to the snd-page-alloc driver:
1697
1698 - add VENDOR DEVICE MASK SIZE BUFFERS
1699
1700 VENDOR and DEVICE are PCI vendor and device IDs. They take
1701 integer numbers (0x prefix is needed for the hex).
1702 MASK is the PCI DMA mask. Pass 0 if not restricted.
1703 SIZE is the size of each buffer to allocate. You can pass
1704 k and m suffix for KB and MB. The max number is 16MB.
1705 BUFFERS is the number of buffers to allocate. It must be greater
1706 than 0. The max number is 4.
1707
1708 - erase
1709
1710 This will erase the all pre-allocated buffers which are not in
1711 use.
1712
1713
6243008b
TI		 1714Links and Addresses
1715===================
1da177e4
LT		 1716
1717 ALSA project homepage
1718 http://www.alsa-project.org
1719
6243008b
TI		 1720 ALSA Bug Tracking System
1721 https://bugtrack.alsa-project.org/bugs/
1722
1723 ALSA Developers ML
1724 mailto:alsa-devel@lists.sourceforge.net
ubuntu-bionic-kernel mirror