1.\" $NetBSD: cy.4,v 1.3 1997/02/23 22:20:27 jonathan Exp $ 2.\" 3.\" Copyright (c) 1993 Andrew Herbert. 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. The name Andrew Herbert may not be used to endorse or promote products 15.\" derived from this software without specific prior written permission. 16.\" 17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27.\" 28.Dd 5 October, 1993 29.Dt CY 4 30.Sh NAME 31.Nm cy 32.Nd 33Cyclades Cyclom-{4, 8, 16}Y asynchronous comms board device driver 34.Sh SYNOPSIS 35.\".Cd "cy0 at isa? tty irq 10 iomem 0xdc000 iosiz 8192 vector cyintr" 36.Cd "cy0 at isa? iomem 0xd4000 irq 12" 37.Cd "cy* at pci? dev ? function ?" 38.Sh DESCRIPTION 39This driver provides an interface to Cyclades Cyclom-4Y, Cyclom-8Y and 40Cyclom-16Y asynchronous multiport serial boards. These boards are based 41around Cirrus Logic CD1400 communication controllers. 42.Pp 43The device minor numbers for this driver are encoded as follows: 44.Pp 45.Bd -literal 46 c c x x u u u u - bits in the minor device number 47 48 bits meaning 49 ---- ------- 50 uuuu physical serial line (i.e. unit) to use 51 0-7 on a cyclom-8Y, 0-15 on a cyclom-16Y 52 53 xx unused 54 55 cc carrier control mode 56 00 complete hardware carrier control of the tty. 57 DCD must be high for the open(2) to complete. 58 01 reserved 59 10 carrier ignored until a high->low transition 60 11 carrier completed ignored 61.Ed 62.Sh DIAGNOSTICS 63.Bl -diag 64.It "cy%d: tty input queue overflow" 65Incoming characters have been discarded due to a buffer overflow. This is 66caused by the process in control of the device not read(2)ing characters 67fast enough. 68.It "cy%d: receive fifo overrun" 69Incoming characters have been discarded due to a CD1400 channel overrun. This 70is caused by interrupts not being serviced sufficiently quickly to prevent 71the 12 byte receive FIFO on a serial channel from overflowing. Reducing 72the value of the \fIRxFifoThreshold\fR #define from 8 to something smaller may 73help slow machines avoid this problem. The driver must have been compiled 74with the \fILogOverruns\fR option defined (the default) in order for this 75condition to be logged. 76.Sh SEE ALSO 77.Xr com 4 , 78.Xr termios 4 , 79.Xr tty 4 80.Sh AUTHORS 81The driver was written by Andrew Herbert <andrew@werple.apana.org.au>, and 82is still under development (from time to time :-). 83.Sh HISTORY 84Some ideas for the architecture of this driver's two-layer processing model 85were derived from the fas 2.10 driver by Uwe Doering 86<gemini@geminix.in-berlin.de> and the high-performance com driver by Bruce 87Evans <bde@kralizec.zeta.org.au>. 88.Pp 89This work was made possible through the donation of a Cyclom-8Y board by the 90manufacturer, Cyclades Corporation. However, neither Cyclades nor the author 91make any warranties regarding this software, nor guarantees of support. 92.Sh BUGS 93There is currently no BREAK handling - breaks are ignored. 94There is no support for bad-character reporting, except via PARMRK. 95The Cyclom-[48]Y boards do not listen to the RTS signal for receiver flow 96control. 97FIFO overruns are only logged when the termios IGNPAR setting is enabled. 98