Linux-2.6.12-rc2
[linux-2.6.git] / Documentation / sound / oss / OPL3-SA
1 OPL3-SA1 sound driver (opl3sa.o)
2
3 ---
4 Note: This howto only describes how to setup the OPL3-SA1 chip; this info
5 does not apply to the SA2, SA3, or SA4. 
6 ---
7
8 The Yamaha OPL3-SA1 sound chip is usually found built into motherboards, and
9 it's a decent little chip offering a WSS mode, a SB Pro emulation mode, MPU401
10 and OPL3 FM Synth capabilities.
11
12 You can enable inclusion of the driver via CONFIG_SOUND_OPL3SA1=m, or
13 CONFIG_SOUND_OPL3SA1=y through 'make config/xconfig/menuconfig'.
14
15 You'll need to know all of the relevant info (irq, dma, and io port) for the
16 chip's WSS mode, since that is the mode the kernel sound driver uses, and of
17 course you'll also need to know about where the MPU401 and OPL3 ports and
18 IRQs are if you want to use those.
19
20 Here's the skinny on how to load it as a module:
21
22         modprobe opl3sa io=0x530 irq=11 dma=0 dma2=1 mpu_io=0x330 mpu_irq=5
23
24 Module options in detail:
25
26         io:     This is the WSS's port base.
27         irq:    This is the WSS's IRQ.
28         dma:    This is the WSS's DMA line. In my BIOS setup screen this was
29                 listed as "WSS Play DMA"
30         dma2:   This is the WSS's secondary DMA line. My BIOS calls it the
31                 "WSS capture DMA"
32         
33         mpu_io: This is the MPU401's port base.
34         mpu_irq: This is the MPU401's IRQ.
35
36 If you'd like to use the OPL3 FM Synthesizer, make sure you enable
37 CONFIG_SOUND_YM3812 (in 'make config'). That'll build the opl3.o module.
38
39 Then a simple 'insmod opl3 io=0x388', and you now have FM Synth.
40
41 You can also use the SoftOSS software synthesizer instead of the builtin OPL3.
42 Here's how:
43
44 Say 'y' or 'm' to "SoftOSS software wave table engine" in make config.
45
46 If you said yes, the software synth is available once you boot your new
47 kernel.
48
49 If you chose to build it as a module, just insmod the resulting softoss2.o
50
51 Questions? Comments?
52 <stiker@northlink.com>