magma serial driver; plunky@skate.demon.co.uk

2 files changed, 114 insertions, 3 deletions

diff --git a/share/man/man4/man4.sparc/Makefile b/share/man/man4/man4.sparc/Makefile
index b20efb20ceb..19ad8e58970 100644
--- a/share/man/man4/man4.sparc/Makefile
+++ b/share/man/man4/man4.sparc/Makefile
@@ -1,10 +1,10 @@
 # 	from: @(#)Makefile	8.2 (Berkeley) 2/16/94
-#	$Id: Makefile,v 1.5 1998/03/19 21:18:12 johns Exp $
+#	$Id: Makefile,v 1.6 1998/05/20 19:29:11 deraadt Exp $
 
-MAN=	intro.4  
+MAN=	intro.4
 MAN+=	bwtwo.4 cgtwo.4 cgthree.4 cgfour.4 cgsix.4 cgeight.4 cgfourteen.4
 MAN+=	esp.4 fd.4 ie.4 kbd.4 le.4 mem.4 ms.4 openprom.4 si.4 sw.4 tcx.4
-MAN+=	xd.4 xy.4 zs.4  
+MAN+=	xd.4 xy.4 zs.4 magma.4
 MLINKS=	mem.4 kmem.4
 MANSUBDIR=/sparc
 
diff --git a/share/man/man4/man4.sparc/magma.4 b/share/man/man4/man4.sparc/magma.4
new file mode 100644
index 00000000000..18aee73c5d7
--- /dev/null
+++ b/share/man/man4/man4.sparc/magma.4
@@ -0,0 +1,111 @@
+.\"
+.\" 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 21 April, 1998
+.Dt MAGMA 4 sparc
+.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[0-3][0-a]
+Serial ports
+.It /dev/bpp[0-3][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.