share/man/man4/gus.4

   1 .\"     $NetBSD: gus.4,v 1.12 2005/06/22 04:30:08 kent Exp $
   2 .\"
   3 .\" Copyright (c) 1996 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by John T. Kohl.
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd June 22, 2005
  31 .Dt GUS 4
  32 .Os
  33 .Sh NAME
  34 .Nm gus
  35 .Nd
  36 Gravis UltraSound/UltraSound MAX audio device driver
  37 .Sh SYNOPSIS
  38 .Cd "gus0 at isa? port 0xPPP irq X drq Y drq2 Z"
  39 .Cd "audio* at audiobus?"
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 driver provides support for the Gravis UltraSound (GUS) and GUS MAX
  44 audio cards.  Both cards have on-board memory which is used for
  45 seamless playback of samples.  They can play back 8- or 16-bit samples
  46 at up to 44.1kHz.  They can record 8-bit samples at up to 44.1kHz.
  47 The UltraSound MAX is a full-duplex sound device, and if
  48 configured with two DRQ channels can be used for simultaneous playback
  49 and recording.  The I/O port base is jumper-selected, and may be chosen
  50 from 0x210-0x260 in steps of 0x10.  (The normal setting is 0x220.)  The
  51 GUS takes 16 ports at its base address and 8 ports at its base address +
  52 0x100.
  53 .Pp
  54 The IRQ is software programmed, so you may select any IRQ from the set
  55 {3,5,7,9,11,12,15}.  The DRQ lines are software programmed, and may be
  56 chosen from {1,3,5,6,7}.  The drq2 field in the configuration file line
  57 specifies a second DRQ line for recording.  If there is no drq2 field
  58 in the config file, the playback channel will be used for recording DMA
  59 and only half-duplex mode will be available.
  60 .Pp
  61 The Gravis UltraSound MAX has an additional CODEC onboard which is
  62 addressed with four ports at an offset of 0x10C from the base ports
  63 (0x31C-0x36C).
  64 .Sh SEE ALSO
  65 .Xr audio 4
  66 .Sh REFERENCES
  67 Gravis UltraSound Low-Level Toolkit, Revision 2.01, 20 May 1993,
  68 published by Advanced Gravis and Forte Technologies.
  69 .Sh HISTORY
  70 The
  71 .Nm gus
  72 device driver appeared in
  73 .Nx 1.1 .
  74 .Sh BUGS
  75 The full-duplex features of the GUS MAX have not been fully tested, and
  76 full-duplex on the original GUS may not be possible at all.
  77 .Pp
  78 Only two voices on the GF1 synthesizer chip are used by this driver (for
  79 left and right channels).
  80 .Pp
  81 Manipulating the mixer while audio samples are playing can lead to
  82 device driver confusion (and maybe even a system panic).
  83 .Pp
  84 Manipulating the mixer device seems to create pregnant system pauses,
  85 probably due to excessive interrupt masking.
  86 .Pp
  87 The joystick and MIDI port interfaces are not supported.