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