Initial import from FreeBSD RELENG_4:
[dragonfly.git] / sys / i386 / isa / sound / README.FREEBSD
1 GUSPNP15 8/6//97
2 ftp://rah.star-gate.com/pub/guspnp.tar.gz
3
4 This sound driver is for FreeBSD 3.0-current .
5
6
7 Major enhancement we now support mapping the dma buffer to user
8 space for write operations only. This features is useful for 
9 games like xquake . So far the mmap features seems to work
10 with the GUS PnP Pro and with the SB16. 
11
12 For xquake you will need:
13
14 1. a few mods to the linux loadable module so just download it and
15  replace yours:
16 cd /sys/i386/
17 tar -xzf linux_ioctl.tar.gz
18 cd /usr/src/lkm/linux
19 make 
20 make install
21 modunload -i 0    (if you have the linux up and running)
22 linux
23 ftp://rah.star-gate.com/linux_ioctl.tar.gz
24
25 2. Install the linux lib 2.4 package:
26 pkg_add linux_lib-2.4.tgz
27
28 ftp://ftp.freebsd.org/pub/FreeBSD/packages-current/emulators/linux_lib-2.4.tgz
29
30 If you don't have xquake you can get it from:
31
32 3. ftp://ftp.freebsd.org/pub/idgames/idstuff/unsup/intel_linux_quake101.tgz
33
34
35 A simple test program mmap_test.c is provided in the sound driver directory.
36 So copy it to your home directory or favorite place and compile it.
37 cc -o mmap_test mmap_test.c
38
39 record a sample session:
40 cat /dev/dsp >smpl
41
42 now run mmap_test . You will hear a loud pop thats a test program
43 then the sample stream will loop .
44
45
46 Phew, now back to sound driver land 8)
47
48
49 This is a minor sound driver release for  the GUS PnP Pro , GUS MAX,
50 AudioTrix Pro , SB16 and SB16 PnP. There is also an experimental
51 AWE sub model.
52
53 Included Luigi's clean up work . Tnks!
54
55 Randall Hopper's SB16 speed setting fix . Tnks!
56
57 Fixed signal handling throught out the sound driver. The problem
58 first surfaced with the SB16 not generating an interrupt on the
59 last dma request and SB afficionados quickly pointed out the 
60 bug in the driver. I had to put back the auto dma feature for
61 xquake :(
62
63
64 NOTE YOU DON'T NEED THE PNP DRIVER FOR THE GUS PNP SINCE THE DRIVER
65 HAS BUILTIN PNP SUPPORT FOR THE GUS.
66
67 My P133 Bios supports PnP. To first figured out what my SB16 PnP
68 was being configured to I booted win95 and checked out what Win95
69 ended up with . Alternatively, if you want to you can also down
70 load Sujal Patel's PnP driver:
71
72  ftp://rah.start-gate.com/pub/FreeBSD-ISA_PnP_June8.tar.gz
73
74 follow the instructions on how to configure your PnP soundcard or 
75 ISA device.
76 Lugi also has  Sujal's PnP driver . 
77
78
79 ---
80
81         http://www.iet.unipi.it/~luigi/pnp.c
82         http://www.iet.unipi.it/~luigi/pnp.h
83
84                 the two main files. Follow Sujal Patel's instructions
85                 for installing pnp support.
86
87         http://www.iet.unipi.it/~luigi/pnpinfo.tgz
88 ---
89
90 This is my kernel configuration for my SB16 PnP:
91
92 controller      snd0
93 device sb0      at isa? port 0x220 irq 10 conflicts drq 3
94 device sbxvi0   at isa? port? irq? drq 5 conflicts
95 device opl0     at isa? port 0x388 conflicts
96 device sbmidi0  at isa? port 0x300 irq? conflicts
97
98 ----
99
100
101 The difference between a GUS PnP and a GUS PnP PRO is that the Pro
102 comes with 512kb. I went out an got a 1mb 60ns 30pin simm and installed
103 it on my GUS PnP. I own a GUS PnP and a GUS PnP PRO.
104
105
106 To unpack:
107 cd /
108 mv /sys/i386/isa/sound /sys/i386/isa/sound.old
109 cd /sys/i386/isa/
110 tar -xzf guspnp15.tar.gz 
111
112
113 cd /sys/i386/conf
114 Edit the kernel config file in /sys/i386/conf
115
116 IF YOU HAVE A GUS MAX or GUS add the option NOGUSPNP to the config file
117         OPTIONS NOGUSPNP
118   THEN follow the instructions for NONPNP CONFIGURATION
119
120
121 PNP CONFIGURATION
122 To configure your guspnp PRO if you have a motherboard which supports
123 PnP:
124
125         controller snd0
126         device gus0 at isa?
127
128 NONPNP CONFIGURATION
129 To configure your guspnp PRO if your motherboard does NOT support
130 PnP:
131
132 device gus0 at isa? port  0x220 irq 11 drq 1 flags 0x3
133
134
135 the gus pnp is fully software configurable and the above configuration
136 is setup for full duplex audio. The dma channel settings are:
137
138 drq 1           --- DMA channel for playback
139
140 flags 0x3       --- DMAN channel for recording
141
142 In the event that you have to configure a GUS PnP manually or a GUS MAX:
143
144      Available IRQs for the GUS are:
145      3, 5, 7, 9, 11, 12, 15
146
147      Available DMA channels for the GUS are:
148      1, 3, 5, 6, 7
149
150
151 config <kernel-file>
152 cd /sys/compile/<kernel-file>
153 make 
154 make install
155
156 THERE IS NO NEED TO BOOT TO DOS TO CONFIGURE YOUR GUS PNP. 
157 THE DRIVER HAS BUILTIN SUPPORT FOR PNP WHICH I GOT
158 FROM THE  GRAVIS DRIVER DEVELOPMENT KIT
159
160 Many thanks to  Brian Litzinger <brian@MediaCity.com> for
161 porting the sound driver 3.5 to 2.2-current. Well, thats a while
162 ago hence the reference to 2.2. 
163
164         Have fun,
165         Amancio