Merge git://git.kernel.org/pub/scm/linux/kernel/git/steve/linux-dm
[pandora-kernel.git] / Documentation / sound / oss / PAS16
1 Pro Audio Spectrum 16 for 2.3.99 and later
2 =========================================
3 by Thomas Molina (tmolina@home.com)
4 last modified 3 Mar 2001
5 Acknowledgement to Axel Boldt (boldt@math.ucsb.edu) for stuff taken
6 from Configure.help, Riccardo Facchetti for stuff from README.OSS,
7 and others whose names I could not find.
8
9 This documentation is relevant for the PAS16 driver (pas2_card.c and
10 friends) under kernel version 2.3.99 and later.  If you are
11 unfamiliar with configuring sound under Linux, please read the
12 Sound-HOWTO, Documentation/sound/oss/Introduction and other
13 relevant docs first.
14
15 The following information is relevant information from README.OSS
16 and legacy docs for the Pro Audio Spectrum 16 (PAS16):
17 ==================================================================
18
19 The pas2_card.c driver supports the following cards --
20 Pro Audio Spectrum 16 (PAS16) and compatibles:
21         Pro Audio Spectrum 16
22         Pro Audio Studio 16
23         Logitech Sound Man 16
24         NOTE! The original Pro Audio Spectrum as well as the PAS+ are not
25               and will not be supported by the driver.
26
27 The sound driver configuration dialog
28 -------------------------------------
29
30 Sound configuration starts by making some yes/no questions. Be careful
31 when answering to these questions since answering y to a question may
32 prevent some later ones from being asked. For example don't answer y to
33 the question about (PAS16) if you don't really have a PAS16.  Sound
34 configuration may also be made modular by answering m to configuration
35 options presented. 
36
37 Note also that all questions may not be asked. The configuration program
38 may disable some questions depending on the earlier choices. It may also
39 select some options automatically as well.
40
41   "ProAudioSpectrum 16 support",
42         - Answer 'y'_ONLY_ if you have a Pro Audio Spectrum _16_,
43           Pro Audio Studio 16 or Logitech SoundMan 16 (be sure that
44           you read the above list correctly). Don't answer 'y' if you
45           have some other card made by Media Vision or Logitech since they
46           are not PAS16 compatible.
47           NOTE! Since 3.5-beta10 you need to enable SB support (next question)
48           if you want to use the SB emulation of PAS16. It's also possible to
49           the emulation if you want to use a true SB card together with PAS16
50           (there is another question about this that is asked later).
51
52   "Generic OPL2/OPL3 FM synthesizer support",
53         - Answer 'y' if your card has a FM chip made by Yamaha (OPL2/OPL3/OPL4).
54           The PAS16 has an OPL3-compatible FM chip.
55
56 With PAS16 you can use two audio device files at the same time. /dev/dsp (and
57 /dev/audio) is connected to the 8/16 bit native codec and the /dev/dsp1 (and
58 /dev/audio1) is connected to the SB emulation (8 bit mono only).
59
60
61 The new stuff for 2.3.99 and later
62 ============================================================================
63 The following configuration options are relevant to configuring the PAS16:
64
65 Sound card support
66 CONFIG_SOUND
67   If you have a sound card in your computer, i.e. if it can say more
68   than an occasional beep, say Y. Be sure to have all the information
69   about your sound card and its configuration down (I/O port,
70   interrupt and DMA channel), because you will be asked for it.
71
72   You want to read the Sound-HOWTO, available from
73   http://www.tldp.org/docs.html#howto . General information
74   about the modular sound system is contained in the files
75   Documentation/sound/oss/Introduction. The file
76   Documentation/sound/oss/README.OSS contains some slightly outdated but
77   still useful information as well.
78
79 OSS sound modules
80 CONFIG_SOUND_OSS
81   OSS is the Open Sound System suite of sound card drivers. They make
82   sound programming easier since they provide a common API. Say Y or M
83   here (the module will be called sound.o) if you haven't found a
84   driver for your sound card above, then pick your driver from the
85   list below.
86
87 Persistent DMA buffers
88 CONFIG_SOUND_DMAP
89   Linux can often have problems allocating DMA buffers for ISA sound
90   cards on machines with more than 16MB of RAM. This is because ISA
91   DMA buffers must exist below the 16MB boundary and it is quite
92   possible that a large enough free block in this region cannot be
93   found after the machine has been running for a while. If you say Y
94   here the DMA buffers (64Kb) will be allocated at boot time and kept
95   until the shutdown. This option is only useful if you said Y to
96   "OSS sound modules", above. If you said M to "OSS sound modules"
97   then you can get the persistent DMA buffer functionality by passing
98   the command-line argument "dmabuf=1" to the sound.o module.
99
100   Say y here for PAS16.
101
102 ProAudioSpectrum 16 support
103 CONFIG_SOUND_PAS
104   Answer Y only if you have a Pro Audio Spectrum 16, ProAudio Studio
105   16 or Logitech SoundMan 16 sound card. Don't answer Y if you have
106   some other card made by Media Vision or Logitech since they are not
107   PAS16 compatible.  It is not necessary to enable the  separate
108   Sound Blaster support; it is included in the PAS driver.
109
110   If you compile the driver into the kernel, you have to add
111   "pas2=<io>,<irq>,<dma>,<dma2>,<sbio>,<sbirq>,<sbdma>,<sbdma2>
112   to the kernel command line.
113
114 FM Synthesizer (YM3812/OPL-3) support
115 CONFIG_SOUND_YM3812
116   Answer Y if your card has a FM chip made by Yamaha (OPL2/OPL3/OPL4).
117   Answering Y is usually a safe and recommended choice, however some
118   cards may have software (TSR) FM emulation. Enabling FM support with
119   these cards may cause trouble (I don't currently know of any such
120   cards, however).
121   Please read the file Documentation/sound/oss/OPL3 if your card has an
122   OPL3 chip.
123   If you compile the driver into the kernel, you have to add
124   "opl3=<io>" to the kernel command line.
125
126   If you compile your drivers into the kernel, you MUST configure 
127   OPL3 support as a module for PAS16 support to work properly.
128   You can then get OPL3 functionality by issuing the command:
129   insmod opl3
130   In addition, you must either add the following line to 
131   /etc/modprobe.conf:
132   options opl3 io=0x388
133   or else add the following line to /etc/lilo.conf:
134   opl3=0x388
135
136
137 EXAMPLES
138 ===================================================================
139 To use the PAS16 in my computer I have enabled the following sound
140 configuration options:
141
142 CONFIG_SOUND=y
143 CONFIG_SOUND_OSS=y
144 CONFIG_SOUND_TRACEINIT=y
145 CONFIG_SOUND_DMAP=y
146 CONFIG_SOUND_PAS=y
147 CONFIG_SOUND_SB=n
148 CONFIG_SOUND_YM3812=m
149
150 I have also included the following append line in /etc/lilo.conf:
151 append="pas2=0x388,10,3,-1,0x220,5,1,-1 sb=0x220,5,1,-1 opl3=0x388"
152
153 The io address of 0x388 is default configuration on the PAS16.  The
154 irq of 10 and dma of 3 may not match your installation.  The above 
155 configuration enables PAS16, 8-bit Soundblaster and OPL3
156 functionality.  If Soundblaster functionality is not desired, the
157 following line would be appropriate:
158 append="pas2=0x388,10,3,-1,0,-1,-1,-1 opl3=0x388"
159
160 If sound is built totally modular, the above options may be 
161 specified in /etc/modprobe.conf for pas2, sb and opl3
162 respectively.