Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / sys / dev / sound / isa / i386 / sound.doc
1 $FreeBSD: src/sys/i386/isa/sound/sound.doc,v 1.12 1999/08/28 00:45:20 peter Exp $
2 $DragonFly: src/sys/dev/sound/isa/i386/Attic/sound.doc,v 1.2 2003/06/17 04:28:38 dillon Exp $
3
4 Instructions on using audio on a FreeBSD 2.1 (or 2.0-current) system.
5 See also /sys/i386/conf/LINT.
6
7 To enable sound driver support, the controller sound code must be included
8 in your config file:
9
10 # SB = SoundBlaster;  PAS = ProAudioSpectrum;  GUS = Gravis UltraSound
11 # Controls all sound devices
12 controller      snd0
13
14 Uncomment one or more of these device entries, depending on what type of
15 sound card you have:
16
17 # ProAudioSpectrum PCM and Midi - for PAS
18 #device pas0     at isa? port 0x388 irq 10 drq 6
19
20 # SoundBlaster DSP driver - for SB, SB Pro, SB16, PAS(emulating SB)
21 #device sb0      at isa? port 0x220 irq 7 drq 1
22
23 # SoundBlaster 16 DSP driver - for SB16 - requires sb0 device
24 #device sbxvi0   at isa? drq 5
25
26 # SoundBlaster 16 MIDI - for SB16 - requires sb0 device
27 #device sbmidi0  at isa? port 0x300
28
29 # Gravis UltraSound - for GUS, GUS16, GUSMAX
30 # For cards that use 2 DMA Channels:
31 #     drq = Write DMA Channel, flags = Read DMA Channel
32 #device gus0 at isa? port 0x220 irq 11 drq 1 flags 0x3
33
34 # Gravis UltraSound 16 bit option - for GUS16 - requires gus0
35 #device gusxvi0 at isa? port 0x530 irq 7 drq 3
36
37 # MS Sound System (AD1848 Based Boards)
38 #device mss0 at isa? port 0x530 irq 10 drq 1
39
40 # Yamaha OPL-2/OPL-3 FM - for SB, SB Pro, SB16, PAS
41 #device opl0     at isa? port 0x388
42
43 # MPU-401 - for MPU-401 standalone card
44 #device mpu0     at isa? port 0x330 irq 6 drq 0
45
46 # 6850 UART Midi
47 #device uart0 at isa? port 0x330 irq 5
48
49 You may add one or more of the following depending on what you do and don't
50 want compiled into your kernel.  Note:  Excluding things with EXCLUDE_... 
51 is NOT recommended unless you really know what you're doing.
52
53 #options        EXCLUDE_AUDIO                   # NO digital audio support
54 #options        EXCLUDE_SEQUENCER               # NO sequencer support
55 #options        EXCLUDE_MIDI                    # NO MIDI support whatsoever
56 #options        EXCLUDE_SBPRO                   # EXCLUDE SB Pro support
57 #options        EXCLUDE_SB_EMULATION            # NO PAS SB emulation support
58 #options        EXCLUDE_GUS_IODETECT            # NO GUS io detection
59 #options        EXCLUDE_PRO_MIDI                # NO PAS MIDI support
60
61 Other Options:
62
63 #options        SYMPHONY_PAS
64         Adds some code to make pas work with Symphony chipsets.  Only use
65         this if your pas doesn't work and you have a Symphony chipset.
66
67 #options        BROKEN_BUS_CLOCK
68         Some systems with the OPTI chipset and a PAS will require you to
69         use this option.  Symptoms are that you will hear a lot of clicking and
70         popping sounds, like a geiger counter, coming out of the PAS even when
71         it is not playing anything.
72
73 #options        MOZART_PORT
74         Adds support for Mozart (OAK OTI-601). (Part of the MSS driver)
75
76 #options        OPTI_MAD16_PORT
77         Adds support for the OPTI MAD16 Chip. (Part of the MSS driver)
78         If your soundcard has a chip labeled "OPTi 82C929" then try this.
79
80 #options        __SGNXPRO__
81         Adds support for the SG NX Pro mixer. (Part of the SB driver)
82
83 #options        JAZZ16
84         Adds support for the MV Jazz16 (ProSonic etc). (Part of the SB Driver)
85
86 #options        SM_WAVE
87         Adds support for the SoundMan Wave (Part of the SB Driver)
88         Note:  You will need to do some work to get this to work.
89                See i386/isa/sound/configure.c
90
91 #options        SM_GAMES
92         Adds support for the Logitech SoundMan Games (Part of the SB Driver)
93
94 #options        PAS_JOYSTICK_ENABLE
95         Enables the gameport on the ProAudio Spectrum
96
97 NOTE:  The MPU-401 driver may or may not work, and is unfortunately
98 unverifiable since no one I know has one.  If you can test this,
99 please let me know!  Also note that you will have to change these
100 settings if your soundcard is set for a non-standard address or IRQ.
101 Please check your documentation (or verify with any provided DOS utilities
102 that may have come with your card) and set the IRQ or address fields
103 accordingly.
104
105
106 Also:  You can configure more then one card on a single DMA using 
107 the conflicts keyword in your configuration file.  This is useful for boards
108 with more then one type of emulation.
109
110
111 Probing problems:  Since the SB16 uses the same IRQ and addresses for
112 the different drivers, some of the snd drivers will not be probed because
113 the kernel thinks there is a conflict.  This can be worked-around by
114 using the "conflicts" keyword on the sb16's device line.
115
116
117 For further information, contact multimedia@freebsd.org
118
119                 - Jordan Hubbard (jkh@freefall.cdrom.com)
120                 - Steven Wallace (swallace@freefall.cdrom.com)
121                 - Sujal Patel (smpatel@wam.umd.edu)