cy(4): Remove ISA support.
[dragonfly.git] / share / man / man4 / man4.i386 / cy.4
1 .\" Copyright (c) 1990, 1991 The Regents of the University of California.
2 .\" All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" the Systems Programming Group of the University of Utah Computer
6 .\" Science Department.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. All advertising materials mentioning features or use of this software
16 .\"    must display the following acknowledgement:
17 .\"     This product includes software developed by the University of
18 .\"     California, Berkeley and its contributors.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\"    may be used to endorse or promote products derived from this software
21 .\"    without specific prior written permission.
22 .\"
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .\" SUCH DAMAGE.
34 .\"
35 .\"     from: @(#)dca.4 5.2 (Berkeley) 3/27/91
36 .\"     from: com.4,v 1.1 1993/08/06 11:19:07 cgd Exp
37 .\"     from: sio.4,v 1.16 1995/06/26 06:05:30 bde Exp $
38 .\" $FreeBSD: src/share/man/man4/man4.i386/cy.4,v 1.13.2.2 2001/08/17 13:08:45 ru Exp $
39 .\"
40 .Dd June 14, 1999
41 .Dt CY 4 i386
42 .Os
43 .Sh NAME
44 .Nm cy
45 .Nd Cyclades Cyclom-Y serial driver
46 .Sh SYNOPSIS
47 .Cd "device cy"
48 .Pp
49 Minor numbering:
50 .Bd -literal
51 0b\fIMMMMMMMMMMMMMMMMxxxxxxxxOLIMMMMM\fR
52                           call\fBO\fRut
53                            \fBL\fRock
54                             \fBI\fRnitial
55   \fBMMMMMMMMMMMMMMMM           MMMMMM\fRinor
56 .Ed
57 .Sh DESCRIPTION
58 The
59 .Nm
60 driver provides support for Cirrus Logic CD1400-based
61 .Tn EIA
62 .Tn RS-232C
63 .Pf ( Tn CCITT
64 .Tn V.24 )
65 communications interfaces (ports) on Cyclades Cyclom-Y boards.
66 Each CD1400 provides 4 ports.
67 Cyclom-Y boards with various numbers of CD1400's are available.
68 This driver supports up to 8 CD1400's (32 ports) per board.
69 .Pp
70 Input and output for each line may set independently
71 to the following speeds:
72 50, 75, 110, 134.5, 150, 300, 600, 1200, 1800, 2400, 4800, 9600,
73 19200, 38400, 57600, or 115200 bps.
74 Other speeds of up to 150000 are supported by the termios interface
75 but not by the sgttyb compatibility interface.
76 The CD1400 is not fast enough to handle speeds above 115200 bps
77 effectively.
78 It can transmit on a single line at slightly more than 115200 bps,
79 but when 4 lines are active in both directions its limit is about
80 90000 bps on each line.
81 .\" XXX the following should be true for all serial drivers and
82 .\" should not be repeated in the man pages for all serial drivers.
83 .\" It was copied from sio.4.  The only change was s/sio/cy/g.
84 .Pp
85 Serial ports controlled by the
86 .Nm
87 driver can be used for both `callin' and `callout'.
88 For each port there is a callin device and a callout device.
89 The minor number of the callout device is 128 higher
90 than that of the corresponding callin port.
91 The callin device is general purpose.
92 Processes opening it normally wait for carrier
93 and for the callout device to become inactive.
94 The callout device is used to steal the port from
95 processes waiting for carrier on the callin device.
96 Processes opening it do not wait for carrier
97 and put any processes waiting for carrier on the callin device into
98 a deeper sleep so that they do not conflict with the callout session.
99 The callout device is abused for handling programs that are supposed
100 to work on general ports and need to open the port without waiting
101 but are too stupid to do so.
102 .Pp
103 The
104 .Nm
105 driver also supports an initial-state and a lock-state control
106 device for each of the callin and the callout "data" devices.
107 The minor number of the initial-state device is 32 higher
108 than that of the corresponding data device.
109 The minor number of the lock-state device is 64 higher
110 than that of the corresponding data device.
111 The termios settings of a data device are copied
112 from those of the corresponding initial-state device
113 on first opens and are not inherited from previous opens.
114 Use
115 .Xr stty 1
116 in the normal way on the initial-state devices to program
117 initial termios states suitable for your setup.
118 .Pp
119 The lock termios state acts as flags to disable changing
120 the termios state.  E.g., to lock a flag variable such as
121 CRTSCTS, use
122 .Em "stty crtscts"
123 on the lock-state device.  Speeds and special characters
124 may be locked by setting the corresponding value in the lock-state
125 device to any nonzero value.
126 .Pp
127 Correct programs talking to correctly wired external devices
128 work with almost arbitrary initial states and almost no locking,
129 but other setups may benefit from changing some of the default
130 initial state and locking the state.
131 In particular, the initial states for non (POSIX) standard flags
132 should be set to suit the devices attached and may need to be
133 locked to prevent buggy programs from changing them.
134 E.g., CRTSCTS should be locked on for devices that support
135 RTS/CTS handshaking at all times and off for devices that don't
136 support it at all.  CLOCAL should be locked on for devices
137 that don't support carrier.  HUPCL may be locked off if you don't
138 want to hang up for some reason.  In general, very bad things happen
139 if something is locked to the wrong state, and things should not
140 be locked for devices that support more than one setting.  The
141 CLOCAL flag on callin ports should be locked off for logins
142 to avoid certain security holes, but this needs to be done by
143 getty if the callin port is used for anything else.
144 .Sh FILES
145 .\" XXX more cloning: s/d/c/g and add a ? for the card number.
146 .Bl -tag -width /dev/ttyic?? -compact
147 .It Pa /dev/ttyc??
148 for callin ports
149 .It Pa /dev/ttyic??
150 .It Pa /dev/ttylc??
151 corresponding callin initial-state and lock-state devices
152 .Pp
153 .\" XXX more cloning: s/a/c/g.  No consistency :-(.
154 .It Pa /dev/cuac??
155 for callout ports
156 .It Pa /dev/cuaic??
157 .It Pa /dev/cualc??
158 corresponding callout initial-state and lock-state devices
159 .El
160 .Pp
161 .Bl -tag -width /etc/rc.d/serial -compact
162 .It Pa /etc/rc.d/serial
163 examples of setting the initial-state and lock-state devices
164 .El
165 .Pp
166 The first question mark in these device names is short for the
167 card number
168 (a decimal number between 0 and 65535 inclusive).
169 The second question mark is short for the port number
170 (a letter in the range [0-9a-v]).
171 .Sh DIAGNOSTICS
172 .Bl -diag
173 .\" XXX back to s/sio/cy/g.
174 .It cy%d: silo overflow.
175 Problem in the interrupt handler.
176 .El
177 .Bl -diag
178 .It cy%d: interrupt-level buffer overflow.
179 Problem in the bottom half of the driver.
180 .El
181 .Bl -diag
182 .It cy%d: tty-level buffer overflow.
183 Problem in the application.
184 Input has arrived faster than the given module could process it
185 and some has been lost.
186 .El
187 .\" .Bl -diag
188 .\" .It sio%d: reduced fifo trigger level to %d.
189 .\" Attempting to avoid further silo overflows.
190 .\" .El
191 .Sh SEE ALSO
192 .Xr stty 1 ,
193 .Xr termios 4 ,
194 .Xr tty 4 ,
195 .Xr comcontrol 8 ,
196 .Xr pstat 8
197 .Sh HISTORY
198 The
199 .Nm
200 driver is derived from the
201 .Nm sio
202 driver and the
203 .Nx
204 .Nm
205 driver and is
206 .Ud
207 .Sh BUGS
208 Serial consoles are not implemented.