share/man/man4/sio.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. Neither the name of the University nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\"     from: @(#)dca.4 5.2 (Berkeley) 3/27/91
  32 .\"     from: com.4,v 1.1 1993/08/06 11:19:07 cgd Exp
  33 .\" $FreeBSD: src/share/man/man4/sio.4,v 1.34.2.4 2002/12/18 13:31:17 keramida Exp $
  34 .\"
  35 .Dd October 10, 1995
  36 .Dt SIO 4
  37 .Os
  38 .Sh NAME
  39 .Nm sio
  40 .Nd "fast interrupt driven asynchronous serial communications interface"
  41 .Sh SYNOPSIS
  42 For standard ports:
  43 .Cd "device sio0 at isa? port IO_COM1 irq 4"
  44 .Cd "device sio1 at isa? port IO_COM2 irq 3"
  45 .Cd "device sio2 at isa? port IO_COM3 irq 5"
  46 .Cd "device sio3 at isa? port IO_COM4 irq 9"
  47 .Pp
  48 For AST compatible multiport cards with 4 ports:
  49 .Cd "options COM_MULTIPORT"
  50 .Cd "device sio4 at isa? port 0x2a0 flags 0x701"
  51 .Cd "device sio5 at isa? port 0x2a8 flags 0x701"
  52 .Cd "device sio6 at isa? port 0x2b0 flags 0x701"
  53 .Cd "device sio7 at isa? port 0x2b8 flags 0x701 irq 12"
  54 .Pp
  55 For Boca Board compatible multiport cards with 8 ports:
  56 .Cd "options COM_MULTIPORT"
  57 .Cd "device sio4 at isa? port 0x100 flags 0xb05"
  58 .Cd "..."
  59 .Cd "device sio11 at isa? port 0x138 flags 0xb05 irq 12"
  60 .Pp
  61 For Netmos Nm9845 multiport cards with 6 ports:
  62 .Cd "options COM_MULTIPORT"
  63 .Cd "device sio4 at isa? port 0xb000 flags 0x901"
  64 .Cd "device sio5 at isa? port 0xb400 flags 0x901"
  65 .Cd "device sio6 at isa? port 0xb800 flags 0x901"
  66 .Cd "device sio7 at isa? port 0xbc00 flags 0x901"
  67 .Cd "device sio8 at isa? port 0xc000 flags 0x901"
  68 .Cd "device sio9 at isa? port 0xac00 flags 0x901 irq 12"
  69 .Pp
  70 For Hayes ESP cards:
  71 .Cd "options COM_ESP"
  72 .Cd "..."
  73 .Pp
  74 Meaning of
  75 .Ar flags :
  76 .Bl -tag -offset indent -compact -width 0x000000
  77 .It 0x00001
  78 shared IRQs
  79 .It 0x00002
  80 disable FIFO
  81 .It 0x00004
  82 no AST/4 compatible IRQ control register
  83 .It 0x00008
  84 recover sooner from lost output interrupts
  85 .It 0x00010
  86 device is potential system console
  87 .It 0x00020
  88 device is forced to become system console
  89 .It 0x00040
  90 device is reserved for low-level IO (e. g. for remote kernel debugging)
  91 .It 0x00080
  92 use this port for remote kernel debugging
  93 .It 0x0 Ns Em ?? Ns 00
  94 minor number of master port
  95 .It 0x20000
  96 device is assumed to use a 16650A-type (extended FIFO) chip
  97 .El
  98 .Pp
  99 Minor numbering:
 100 .Bd -literal
 101 0b\fIOLIMMMMM\fR
 102   call\fBO\fRut
 103    \fBL\fRock
 104     \fBI\fRnitial
 105      \fBMMMMM\fRinor
 106 .Ed
 107 .Sh DESCRIPTION
 108 The
 109 .Nm
 110 driver provides support for NS8250-, NS16450-, NS16550 and NS16550A-based
 111 .Tn EIA
 112 .Tn RS-232C
 113 .Pf ( Tn CCITT
 114 .Tn V.24 )
 115 communications interfaces.  The NS8250 and NS16450 have single character
 116 buffers, the NS16550A has 16 character FIFO input and output buffers.
 117 .Pp
 118 Input and output for each line may set to one of following baud rates;
 119 50, 75, 110, 134.5, 150, 300, 600, 1200, 1800, 2400, 4800, 9600,
 120 19200, 38400, 57600, or 115200. Your hardware may limit your baud
 121 rate choices.
 122 .Pp
 123 The driver supports `multiport' cards.
 124 Multiport cards are those that have one or more groups of ports
 125 that share an Interrupt Request (IRQ) line per group.
 126 Shared IRQs on different cards are not supported.
 127 Frequently 4 ports share 1 IRQ; some 8 port cards have 2 groups of 4 ports,
 128 thus using 2 IRQs.
 129 Some cards allow the first 2 serial ports to have separate IRQs per port
 130 (as per DOS PC standard).
 131 .Pp
 132 Some cards have an IRQ control register for each group.
 133 Some cards require special initialization related to such registers.
 134 Only AST/4 compatible IRQ control registers are supported.
 135 Some cards have an IRQ status register for each group.
 136 The driver does not require or use such registers yet.
 137 To work, the control and status registers for a group, if any,
 138 must be mapped to the scratch register (register 7)
 139 of a port in the group.
 140 Such a port is called a
 141 .Em master
 142 port.
 143 .Pp
 144 The
 145 .Em flags
 146 keyword may be used on each
 147 .Em device sio
 148 line in the kernel configuration file
 149 to disable the FIFO on 16550A UARTs
 150 (see the synopsis).
 151 Disabling the FIFO should rarely be necessary.
 152 .Pp
 153 The
 154 .Em flags
 155 keyword
 156 .Em must
 157 be used for all ports that are part of an IRQ sharing group.
 158 One bit specifies IRQ sharing; another bit specifies whether the port does
 159 .Em not
 160 require AST/4 compatible initialization.
 161 The minor number of the device corresponding a master port
 162 for the group is encoded as a bitfield in the high byte.
 163 The same master port must be specified for all ports in a group.
 164 .Pp
 165 The
 166 .Em irq
 167 specification must be given for master ports
 168 and for ports that are not part of an IRQ sharing group,
 169 and not for other ports.
 170 .Pp
 171 In the synopsis,
 172 .Em flags 0x701
 173 means that the 8th port (sio7) is the master
 174 port, and that the port is on a multiport card with shared IRQs
 175 and an AST/4 compatible IRQ control register.
 176 .Pp
 177 .Em flags 0xb05
 178 means that the 12th port (sio11) is the master
 179 port, and that the port is on a multiport card with shared IRQs
 180 and no special IRQ control register.
 181 .Pp
 182 Which port is the master port depends on the card type.
 183 Consult the hardware documentation of your card.
 184 Since IRQ status registers are never used,
 185 and IRQ control registers are only used for AST/4 compatible cards,
 186 and some cards map the control/status registers to all ports in a group,
 187 any port in a group will sometimes do for the master port.
 188 Choose a port containing an IRQ status register for forwards compatibility,
 189 and the highest possible port for consistency.
 190 .Pp
 191 Serial ports controlled by the
 192 .Nm
 193 driver can be used for both `callin' and `callout'.
 194 For each port there is a callin device and a callout device.
 195 The minor number of the callout device is 128 higher
 196 than that of the corresponding callin port.
 197 The callin device is general purpose.
 198 Processes opening it normally wait for carrier
 199 and for the callout device to become inactive.
 200 The callout device is used to steal the port from
 201 processes waiting for carrier on the callin device.
 202 Processes opening it do not wait for carrier
 203 and put any processes waiting for carrier on the callin device into
 204 a deeper sleep so that they do not conflict with the callout session.
 205 The callout device is abused for handling programs that are supposed
 206 to work on general ports and need to open the port without waiting
 207 but are too stupid to do so.
 208 .Pp
 209 The
 210 .Nm
 211 driver also supports an initial-state and a lock-state control
 212 device for each of the callin and the callout "data" devices.
 213 The minor number of the initial-state device is 32 higher
 214 than that of the corresponding data device.
 215 The minor number of the lock-state device is 64 higher
 216 than that of the corresponding data device.
 217 The termios settings of a data device are copied
 218 from those of the corresponding initial-state device
 219 on first opens and are not inherited from previous opens.
 220 Use
 221 .Xr stty 1
 222 in the normal way on the initial-state devices to program
 223 initial termios states suitable for your setup.
 224 .Pp
 225 The lock termios state acts as flags to disable changing
 226 the termios state.  E.g., to lock a flag variable such as
 227 CRTSCTS, use
 228 .Em stty crtscts
 229 on the lock-state device.  Speeds and special characters
 230 may be locked by setting the corresponding value in the lock-state
 231 device to any nonzero value.
 232 .Pp
 233 Correct programs talking to correctly wired external devices
 234 work with almost arbitrary initial states and almost no locking,
 235 but other setups may benefit from changing some of the default
 236 initial state and locking the state.
 237 In particular, the initial states for non (POSIX) standard flags
 238 should be set to suit the devices attached and may need to be
 239 locked to prevent buggy programs from changing them.
 240 E.g., CRTSCTS should be locked on for devices that support
 241 RTS/CTS handshaking at all times and off for devices that don't
 242 support it at all.  CLOCAL should be locked on for devices
 243 that don't support carrier.  HUPCL may be locked off if you don't
 244 want to hang up for some reason.  In general, very bad things happen
 245 if something is locked to the wrong state, and things should not
 246 be locked for devices that support more than one setting.  The
 247 CLOCAL flag on callin ports should be locked off for logins
 248 to avoid certain security holes, but this needs to be done by
 249 getty if the callin port is used for anything else.
 250 .Sh FILES
 251 .Bl -tag -width /dev/ttyid? -compact
 252 .It Pa /dev/ttyd?
 253 for callin ports
 254 .It Pa /dev/ttyid?
 255 .It Pa /dev/ttyld?
 256 corresponding callin initial-state and lock-state devices
 257 .Pp
 258 .It Pa /dev/cuaa?
 259 for callout ports
 260 .It Pa /dev/cuaia?
 261 .It Pa /dev/cuala?
 262 corresponding callout initial-state and lock-state devices
 263 .El
 264 .Pp
 265 .Bl -tag -width /etc/rc.d/serial -compact
 266 .It Pa /etc/rc.d/serial
 267 examples of setting the initial-state and lock-state devices
 268 .El
 269 .Pp
 270 The device numbers are made from the set [0-9a-v] so that more than
 271 10 ports can be supported.
 272 .Sh DIAGNOSTICS
 273 .Bl -diag
 274 .It sio%d: silo overflow.
 275 Problem in the interrupt handler.
 276 .El
 277 .Bl -diag
 278 .It sio%d: interrupt-level buffer overflow.
 279 Problem in the bottom half of the driver.
 280 .El
 281 .Bl -diag
 282 .It sio%d: tty-level buffer overflow.
 283 Problem in the application.
 284 Input has arrived faster than the given module could process it
 285 and some has been lost.
 286 .El
 287 .\" .Bl -diag
 288 .\" .It sio%d: reduced fifo trigger level to %d.
 289 .\" Attempting to avoid further silo overflows.
 290 .\" .El
 291 .Sh SEE ALSO
 292 .Xr stty 1 ,
 293 .Xr termios 4 ,
 294 .Xr tty 4 ,
 295 .Xr comcontrol 8
 296 .Sh HISTORY
 297 The
 298 .Nm
 299 driver is derived from the
 300 .Tn HP9000/300
 301 .Xr dca 4
 302 driver and is currently under development.
 303 .Sh BUGS
 304 Data loss may occur at very high baud rates on slow systems,
 305 or with too many ports on any system,
 306 or on heavily loaded systems when crtscts cannot be used.
 307 The use of NS16550A's reduces system load and helps to avoid data loss.
 308 .Pp
 309 Stay away from plain NS16550's. These are early
 310 implementations of the chip with non-functional FIFO hardware.
 311 .Pp
 312 The constants which define the locations
 313 of the various serial ports are holdovers from
 314 .Tn DOS .
 315 As shown, hex addresses can be and for clarity probably should be used instead.
 316 .Pp
 317 Note that on the AST/4 the card's dipswitches should
 318 .Em not
 319 be set to use interrupt sharing.
 320 AST/4-like interrupt sharing is only used when
 321 .Em multiple
 322 AST/4 cards are installed in the same system.  The sio driver does not
 323 support more than 1 AST/4 on one IRQ.
 324 .Pp
 325 The examples in the synopsis are too vendor-specific.