diff options
-rw-r--r-- | share/man/man4/man4.sparc64/Makefile | 5 | ||||
-rw-r--r-- | share/man/man4/man4.sparc64/magma.4 | 116 |
2 files changed, 119 insertions, 2 deletions
diff --git a/share/man/man4/man4.sparc64/Makefile b/share/man/man4/man4.sparc64/Makefile index dc0a18ea0c4..ea1f91a5455 100644 --- a/share/man/man4/man4.sparc64/Makefile +++ b/share/man/man4/man4.sparc64/Makefile @@ -1,8 +1,9 @@ -# $OpenBSD: Makefile,v 1.10 2001/12/04 21:47:48 jason Exp $ +# $OpenBSD: Makefile,v 1.11 2002/01/12 21:48:48 jason Exp $ # TODO: auxio.4 beeper.4 clock.4 ebus.4 pcons.4 psycho.4 sbus.4 timer.4 MAN= audioce.4 audiocs.4 autoconf.4 be.4 cgsix.4 cgthree.4 esp.4 gem.4 \ - hme.4 intro.4 le.4 mem.4 openprom.4 pcons.4 qe.4 qec.4 sab.4 zs.4 + hme.4 intro.4 le.4 magma.4 mem.4 openprom.4 pcons.4 qe.4 qec.4 \ + sab.4 zs.4 MLINKS= mem.4 kmem.4 \ sab.4 sabtty.4 MANSUBDIR=sparc64 diff --git a/share/man/man4/man4.sparc64/magma.4 b/share/man/man4/man4.sparc64/magma.4 new file mode 100644 index 00000000000..2f91d6b557e --- /dev/null +++ b/share/man/man4/man4.sparc64/magma.4 @@ -0,0 +1,116 @@ +.\" $OpenBSD: magma.4,v 1.1 2002/01/12 21:48:48 jason Exp $ +.\" +.\" +.\" Copyright (c) 1998 Iain Hibbert +.\" 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. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by Iain Hibbert +.\" 4. 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. +.\" +.Dd January 12, 2002 +.Dt MAGMA 4 sparc64 +.Os +.Sh NAME +.Nm magma +.Nd Magma Sp Serial/Parallel board device driver +.Sh SYNOPSIS +.Cd "magma? at sbus? slot ? offset ?" +.Cd "mtty? at magma?" +.Cd "mbpp? at magma?" +.Sh DESCRIPTION +This driver provides an interface to Magma LC2+1Sp, 2+1Sp, 4+1Sp, 8+2Sp, +4Sp, 8Sp, 12Sp, 16Sp, 1P and 2P boards. +These boards are based around the Cirrus Logic CD1400 serial/parallel +communications engine and the Cirrus Logic CD1190 parallel communications +engine. +.Pp +The device minor numbers for this driver are encoded as follows: +.Pp +.Bd -literal + +---+---+---+---+---+---+---+---+ + | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 | + +---+---+---+---+---+---+---+---+ + | | | | | | | | + | | | | +---+---+---+---> port number + | | | | + | | | +-------------------> dialout (on tty ports) + | | | + | | +-----------------------> unused + | | + +---+---------------------------> card number +.Ed +.Pp +Up to four cards are supported in the system. +.Pp +All tty ports have full automatic hardware (RTS/CTS) flow control available +and a 12 byte FIFO on the chip in each direction so errors should be minimal. +.Sh DIAGNOSTICS +.Bl -diag +.It "mtty%d%x: ring buffer overflow" +Incoming characters have been discarded due to a buffer overflow. +This is caused by the process in control of the device not reading characters +fast enough. +If need be you can make the ring buffer bigger by changing the +\fIMAGMA_RBUF_SIZE\fR #define to something bigger, but it should be a multiple +of two. +.It "mtty%d%x: fifo overflow" +Incoming characters have been discarded due to a CD1400 channel overrun. +This is caused by interrupts not being serviced sufficiently quickly to prevent +the 12 byte receive FIFO on a serial channel from overflowing. +Reducing the value of either the \fIMTTY_RX_FIFO_THRESHOLD\fR or +\fIMTTY_RX_DTR_THRESHOLD\fR #define's to something smaller may help slow +machines avoid this problem. +.El +.Sh FILES +.Bl -tag -width /dev/bpp[0-3][0-1] -compact +.It /dev/tty[mno][0-f] +Serial ports +.It /dev/bpp[mno][0-1] +Parallel ports +.El +.Sh SEE ALSO +.Xr read 2 , +.Xr termios 4 , +.Xr tty 4 +.Sh AUTHORS +The driver was written by Iain Hibbert <plunky@skate.demon.co.uk> +.Sh HISTORY +The driver was loosely based upon the +.Xr cy 4 +Cyclades Cyclom device driver written +by Andrew Herbert and Timo Rossi. +.Sh TODO +CD1190 parallel support +.Pp +bpp input +.Pp +Dialout (cua) devices are not yet supported. +.Pp +mdmbuf is unsupported +.Pp +automatic XON/XOFF handshaking could be implemented fairly easily. +.Pp +it would be good if the tty port waited for the FIFO to empty before allowing +a close, so that I could turn off the channel interrupts at that time. +It can be done. |