Subject: kern/1731: no man pages for sb or GUS drivers
To: None <gnats-bugs@gnats.netbsd.org>
From: John Kohl <jtk@kolvir.arlington.ma.us>
List: netbsd-bugs
Date: 11/05/1995 21:09:08
>Number:         1731
>Category:       kern
>Synopsis:       no man pages for sb or GUS drivers
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    kern-bug-people (Kernel Bug People)
>State:          open
>Class:          change-request
>Submitter-Id:   net
>Arrival-Date:   Sun Nov  5 21:35:01 1995
>Last-Modified:
>Originator:     John Kohl
>Organization:
NetBSD Kernel Hackers `R` Us
>Release:        NetBSD-current, 1995/11/02
>Environment:
	
System: NetBSD pattern 1.1_ALPHA NetBSD 1.1_ALPHA (PATTERN) #195: Sun Oct 22 13:31:09 EDT 1995 jtk@pattern:/u1/NetBSD-current/src/sys/arch/i386/compile/PATTERN i386


>Description:
	There are no man pages for the sb or gus audio drivers
>How-To-Repeat:
	try to read them
>Fix:
===================================================================
RCS file: RCS/Makefile,v
retrieving revision 1.16
diff -r1.16 share/man/man4/man4.i386/Makefile
5,7c5,7
< MAN+=	com.4 cy.4 ed.4 ep.4 lms.4 lpt.4 mcd.4 mem.4 mms.4 ncr.4 npx.4 pms.4 
< MAN+=	rtfps.4 sea.4 speaker.4 uha.4 wd.4
< MAN+=	eg.4 el.4 ie.4 le.4 wt.4 apm.4
---
> MAN+=	com.4 cy.4 ed.4 ep.4 gus.4 lms.4 lpt.4 mcd.4 mem.4 mms.4 ncr.4 npx.4
> MAN+=	pms.4 rtfps.4 sb.4 sea.4 speaker.4 uha.4 wd.4
> MAN+=	eg.4 el.4 ie.4 le.4 wt.4
*** /dev/null	Sun Nov  5 02:03:32 1995
--- share/man/man4/man4.i386/sb.4	Sun Nov  5 21:05:34 1995
***************
*** 0 ****
--- 1,63 ----
+ .\" Copyright (c) 1995 John T. Kohl
+ .\" All rights reserved.
+ .\"
+ .\" Redistribution and use in source and binary forms, with or without
+ .\" modification, are permitted provided that the following conditions
+ .\" are met:
+ .\" 1. Redistributions of source code must retain the above copyright
+ .\"    notice, this list of conditions and the following disclaimer.
+ .\" 2. Redistributions in binary form must reproduce the above copyright
+ .\"    notice, this list of conditions and the following disclaimer in the
+ .\"    documentation and/or other materials provided with the distribution.
+ .\" 3. The name of the author may not be used to endorse or promote products
+ .\"    derived from this software without specific prior written permission.
+ .\"
+ .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR
+ .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ .\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+ .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ .\" POSSIBILITY OF SUCH DAMAGE.
+ .\"	
+ .\"	$Id: sb.4,v 1.1 1995/11/06 02:05:34 jtk Exp $
+ .\"
+ .Dd November 4, 1995
+ .Dt SB 4 i386
+ .Os 
+ .Sh NAME
+ .Nm sb
+ .Nd
+ SoundBlaster family (and compatibles) audio device driver
+ .Sh SYNOPSIS
+ .Cd "sb0 at isa? port 0xPPP irq X drq Y"
+ .Sh DESCRIPTION
+ The
+ .Nm sb
+ driver provides support for the SoundBlaster, SoundBlaster Pro,
+ SoundBlaster 16, and hardware register-level compatible audio cards.
+ .Pp
+ The SoundBlaster series are half-duplex cards, capable of 8- and 16-bit
+ audio sample recording and playback at rates up to 44.1kHz (depending on
+ the particular model).
+ .Pp
+ The base I/O port address is usually jumper-selected to either 0x220 or
+ 0x240 (newer cards may provide software configuration, but this driver
+ does not directly support them--you must configure the card for its I/O
+ addresses with other software).  The SoundBlaster takes 16 I/O ports.
+ For the SoundBlaster and SoundBlaster Pro, the IRQ and DRQ channels are
+ jumper-selected.  For the SoundBlaster 16, the IRQ and DRQ channels are
+ set by this driver to the values specified in the config file.  The IRQ
+ must be selected from the set {5,7,9,10}.
+ .Pp
+ .Sh BUGS
+ The driver has not been extensively tested on original SoundBlaster,
+ SoundBlaster 16, or newer cards.
+ .Pp
+ The FM synthesizer, joystick and MIDI port interfaces are not supported.
+ .Sh SEE ALSO
+ .Xr audio 4
*** /dev/null	Sun Nov  5 02:03:32 1995
--- share/man/man4/man4.i386/gus.4	Sun Nov  5 21:05:43 1995
***************
*** 0 ****
--- 1,84 ----
+ .\" Copyright (c) 1995 John T. Kohl
+ .\" All rights reserved.
+ .\"
+ .\" Redistribution and use in source and binary forms, with or without
+ .\" modification, are permitted provided that the following conditions
+ .\" are met:
+ .\" 1. Redistributions of source code must retain the above copyright
+ .\"    notice, this list of conditions and the following disclaimer.
+ .\" 2. Redistributions in binary form must reproduce the above copyright
+ .\"    notice, this list of conditions and the following disclaimer in the
+ .\"    documentation and/or other materials provided with the distribution.
+ .\" 3. The name of the author may not be used to endorse or promote products
+ .\"    derived from this software without specific prior written permission.
+ .\"
+ .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR
+ .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ .\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+ .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ .\" POSSIBILITY OF SUCH DAMAGE.
+ .\"	
+ .\"	$Id: gus.4,v 1.2 1995/11/06 02:05:43 jtk Exp $
+ .\"
+ .Dd November 4, 1995
+ .Dt GUS 4 i386
+ .Os 
+ .Sh NAME
+ .Nm gus
+ .Nd
+ Gravis UltraSound/UltraSound MAX device driver
+ .Sh SYNOPSIS
+ .Cd "gus0 at isa? port 0xPPP irq X drq Y flags Z"
+ .Sh DESCRIPTION
+ The
+ .Nm gus
+ driver provides support for the Gravis UltraSound (GUS) and GUS MAX
+ audio cards.  Both cards have on-board memory which is used for
+ seamless playback of samples.  They can play back 8- or 16-bit samples
+ at up to 44.1kHz.  They can record 8-bit samples at up to 44.1kHz.
+ The UltraSound MAX is a full-duplex sound device, and if
+ configured with two DRQ channels can be used for simultaneous playback
+ and recording.  The I/O port base is jumper-selected, and may be chosen
+ from 0x210-0x260 in steps of 0x10.  (The normal setting is 0x220.)  The
+ GUS takes 16 ports at its base address and 8 ports at its base address +
+ 0x100.
+ .Pp
+ The IRQ is software programmed, so you may select any IRQ from the set
+ {3,5,7,9,11,12,15}.  The DRQ lines are software programmed, and may be
+ chosen from {1,3,5,6,7}.  The flags field in the configuration file line
+ specifies a second DRQ line for recording.  If there is no flags field
+ in the config file, the playback channel will be used for recording DMA
+ and only half-duplex mode will be available.
+ .Pp
+ The Gravis UltraSound MAX has an additional CODEC onboard which is
+ addressed with four ports at an offset of 0x10C from the base ports
+ (0x31C-0x36C).
+ .Sh BUGS
+ The full-duplex features of the GUS MAX have not been fully tested, and
+ full-duplex on the original GUS may not be possible at all.
+ .Pp
+ Only two voices on the GF1 synthesizer chip are used by this driver (for
+ left and right channels).
+ .Pp
+ Manipulating the mixer while audio samples are playing can lead to
+ device driver confusion (and maybe even a system panic).
+ .Pp
+ Manipulating the mixer device seems to create pregnant system pauses,
+ probably due to excessive interrupt masking.
+ .Pp
+ The joystick and MIDI port interfaces are not supported.
+ .Sh SEE ALSO
+ .Xr audio 4
+ .Sh REFERENCES
+ Gravis UltraSound Low-Level Toolkit, Revision 2.01, 20 May 1993,
+ published by Advanced Gravis and Forte Technologies.
+ .Sh HISTORY
+ The
+ .Nm gus
+ device driver appeared in NetBSD 1.1.
>Audit-Trail:
>Unformatted: