NetBSD/share/man/man4/opl.4

.\" $NetBSD: opl.4,v 1.17 2001/11/04 06:46:47 itohy Exp $
.\"
.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Lennart Augustsson.
.\"
.\" 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. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"        This product includes software developed by the NetBSD
.\"        Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\"    contributors may be used to endorse or promote products derived
.\"    from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``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 FOUNDATION OR CONTRIBUTORS
.\" 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.
.\"
.Dd August 18, 1998
.Dt OPL 4
.Os
.Sh NAME
.Nm opl
.Nd Yamaha OPL2 and OPL3 FM MIDI synthesizer driver
.Sh SYNOPSIS
.Cd "opl*  at cmpci? flags 1"
.Cd "opl*  at esl?"
.Cd "opl*  at eso?"
.Cd "opl*  at ess?"
.Cd "opl*  at fms?"
.Cd "opl0  at isa? port 0x388"
.Cd "opl*  at sb?"
.Cd "opl*  at sv?"
.Cd "opl*  at wss?"
.Cd "opl*  at yds?"
.Cd "opl*  at ym?"
.Cd "midi* at opl?"
.Sh DESCRIPTION
The
.Nm
driver provides support for the Yamaha OPL2 (YM3812) and OPL3
(YMF262) chips.  The chips are FM synthesizers and are capable
of producing a wide range of (mostly awful) sounds.
.Pp
Access to the device is through the MIDI driver.
.Pp
The
.Nm
driver usually attaches to a sound card, but it can also sit
directly on the ISA bus.
.Pp
If
.Dq flags 1
is specified, the
.Nm
driver handles left and right channels of OPL3 swapped.
Use this flag if your device has such problem.
.Sh SEE ALSO
.Xr cmpci 4 ,
.Xr esl 4 ,
.Xr eso 4 ,
.Xr ess 4 ,
.Xr fms 4 ,
.Xr isa 4 ,
.Xr midi 4 ,
.Xr sb 4 ,
.Xr sv 4 ,
.Xr wss 4 ,
.Xr yds 4 ,
.Xr ym 4
.Sh HISTORY
The
.Nm
device driver appeared in
.Nx 1.4 .
.Sh BUGS
The OPL3 chip is operated in OPL2 mode despite being more capable.
Document "opl at cmpci" and "flags 1". 2001-11-04 09:46:47 +03:00			`.\" $NetBSD: opl.4,v 1.17 2001/11/04 06:46:47 itohy Exp $`
Make copyright conform. 1999-04-14 00:40:44 +04:00			`.\"`
			`.\" Copyright (c) 1999 The NetBSD Foundation, Inc.`
Add OPL man page. 1998-08-18 12:16:56 +04:00			`.\" All rights reserved.`
			`.\"`
Make copyright conform. 1999-04-14 00:40:44 +04:00			`.\" This code is derived from software contributed to The NetBSD Foundation`
			`.\" by Lennart Augustsson.`
			`.\"`
Add OPL man page. 1998-08-18 12:16:56 +04:00			`.\" 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. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the NetBSD`
			`.\" Foundation, Inc. and its contributors.`
			`.\" 4. Neither the name of The NetBSD Foundation nor the names of its`
			`.\" contributors may be used to endorse or promote products derived`
			`.\" from this software without specific prior written permission.`
			`.\"`
			`.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS`
			.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
			`.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR`
Make copyright conform. 1999-04-14 00:40:44 +04:00			`.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS`
Add OPL man page. 1998-08-18 12:16:56 +04:00			`.\" 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.`
			`.\"`
			`.Dd August 18, 1998`
			`.Dt OPL 4`
More and more of .Os cleanups. .Os is defined in the tmac.doc-common file, so we shouldn't override it with versions in the manpages. Many more to come. 1999-03-16 04:19:14 +03:00			`.Os`
Add OPL man page. 1998-08-18 12:16:56 +04:00			`.Sh NAME`
			`.Nm opl`
Monkeys Ignite Dangerous Items. 2000-07-24 15:55:52 +04:00			`.Nd Yamaha OPL2 and OPL3 FM MIDI synthesizer driver`
Add OPL man page. 1998-08-18 12:16:56 +04:00			`.Sh SYNOPSIS`
Document "opl at cmpci" and "flags 1". 2001-11-04 09:46:47 +03:00			`.Cd "opl* at cmpci? flags 1"`
Xref esl(4). 2001-09-29 23:39:51 +04:00			`.Cd "opl* at esl?"`
Note the eso attachment. 1999-08-22 16:49:57 +04:00			`.Cd "opl* at eso?"`
Add OPL and xref. 1998-08-26 16:30:51 +04:00			`.Cd "opl* at ess?"`
Update the opl and midi attachments. 1999-11-15 21:50:32 +03:00			`.Cd "opl* at fms?"`
Minor clarification. 1998-09-08 15:59:48 +04:00			`.Cd "opl0 at isa? port 0x388"`
Add OPL man page. 1998-08-18 12:16:56 +04:00			`.Cd "opl* at sb?"`
Xref between sv(4) and opl(4). 2000-02-14 03:04:20 +03:00			`.Cd "opl* at sv?"`
Add OPL and xref. 1998-08-26 16:30:51 +04:00			`.Cd "opl* at wss?"`
Manual page for Yamaha YMF724/740/744/754 PCI audio driver. 2001-03-30 18:34:27 +04:00			`.Cd "opl* at yds?"`
Update the opl and midi attachments. 1999-11-15 21:50:32 +03:00			`.Cd "opl* at ym?"`
Add OPL man page. 1998-08-18 12:16:56 +04:00			`.Cd "midi* at opl?"`
			`.Sh DESCRIPTION`
			`The`
			`.Nm`
			`driver provides support for the Yamaha OPL2 (YM3812) and OPL3`
Fix typos. 1999-11-16 03:28:02 +03:00			`(YMF262) chips. The chips are FM synthesizers and are capable`
Add OPL man page. 1998-08-18 12:16:56 +04:00			`of producing a wide range of (mostly awful) sounds.`
			`.Pp`
			`Access to the device is through the MIDI driver.`
Minor clarification. 1998-09-08 15:59:48 +04:00			`.Pp`
			`The`
			`.Nm`
			`driver usually attaches to a sound card, but it can also sit`
			`directly on the ISA bus.`
Document "opl at cmpci" and "flags 1". 2001-11-04 09:46:47 +03:00			`.Pp`
			`If`
			`.Dq flags 1`
			`is specified, the`
			`.Nm`
			`driver handles left and right channels of OPL3 swapped.`
			`Use this flag if your device has such problem.`
Add OPL man page. 1998-08-18 12:16:56 +04:00			`.Sh SEE ALSO`
Document "opl at cmpci" and "flags 1". 2001-11-04 09:46:47 +03:00			`.Xr cmpci 4 ,`
Xref esl(4). 2001-09-29 23:39:51 +04:00			`.Xr esl 4 ,`
Note the eso attachment. 1999-08-22 16:49:57 +04:00			`.Xr eso 4 ,`
Add OPL and xref. 1998-08-26 16:30:51 +04:00			`.Xr ess 4 ,`
Update xrefs. 1999-11-15 21:55:27 +03:00			`.Xr fms 4 ,`
Add OPL and xref. 1998-08-26 16:30:51 +04:00			`.Xr isa 4 ,`
Add OPL man page. 1998-08-18 12:16:56 +04:00			`.Xr midi 4 ,`
Add OPL and xref. 1998-08-26 16:30:51 +04:00			`.Xr sb 4 ,`
Xref between sv(4) and opl(4). 2000-02-14 03:04:20 +03:00			`.Xr sv 4 ,`
Update xrefs. 1999-11-15 21:55:27 +03:00			`.Xr wss 4 ,`
Manual page for Yamaha YMF724/740/744/754 PCI audio driver. 2001-03-30 18:34:27 +04:00			`.Xr yds 4 ,`
Update xrefs. 1999-11-15 21:55:27 +03:00			`.Xr ym 4`
Add OPL man page. 1998-08-18 12:16:56 +04:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`device driver appeared in`
			`.Nx 1.4 .`
Sort SEE ALSO, sort sections, some markup improvements, some more common section headers. 2001-09-22 05:44:54 +04:00			`.Sh BUGS`
			`The OPL3 chip is operated in OPL2 mode despite being more capable.`