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