share/man/man4/digi.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.15 1994/12/06 20:14:30 bde Exp
  38 .\" $FreeBSD$
  39 .\"
  40 .Dd December 7, 2003
  41 .Dt DIGI 4
  42 .Os
  43 .Sh NAME
  44 .Nm digi
  45 .Nd DigiBoard intelligent serial cards driver
  46 .Sh SYNOPSIS
  47 .Cd "device digi"
  48 .Pp
  49 This man page was originally written for the dgb driver, and should
  50 likely be gone over with a fine tooth comb to reflect differences
  51 with the digi driver.
  52 .Pp
  53 When not defined the number is computed:
  54 .Pp
  55 .Bd -ragged -offset 4n
  56 default
  57 .Dv NDGBPORTS
  58 = number_of_described_DigiBoard_cards * 16
  59 .Ed
  60 .Pp
  61 If it is less than the actual number of ports
  62 the system will be able to use only the
  63 first
  64 .Dv NDGBPORTS
  65 ports.
  66 If it is greater then all ports will be usable
  67 but some memory will be wasted.
  68 .Pp
  69 Meaning of
  70 .Cm flags :
  71 .Bl -tag -width indent -compact
  72 .It 0x0001
  73 use alternate pinout (exchange DCD and DSR lines)
  74 .It 0x0002
  75 do not use 8K window mode of PC/Xe
  76 .El
  77 .Pp
  78 Device numbering:
  79 .Bd -literal -compact
  80 0b\fICC\fPmmmmmmmm\fIOLIPPPPP\fP
  81   \fBCC\fPard number
  82     \fRmmmmmmmm\fPajor number
  83             call\fBO\fPut
  84              \fBL\fPock
  85               \fBI\fPnitial
  86                \fBPPPPP\fPort number
  87 .Ed
  88 .Sh DESCRIPTION
  89 The
  90 .Nm
  91 driver provides support for DigiBoard PC/Xe and PC/Xi series intelligent
  92 serial multiport cards with asynchronous interfaces based on the
  93 .Tn EIA
  94 .Tn RS-232C
  95 .Pf ( Tn CCITT
  96 .Tn V.24 )
  97 standard.
  98 .Pp
  99 Input and output for each line may set to one of following baud rates;
 100 50, 75, 110, 134.5, 150, 300, 600, 1200, 1800, 2400, 4800, 9600,
 101 19200, 38400, 57600, or for newer versions of cards 115200.
 102 .Pp
 103 The driver does not use any interrupts, it is
 104 .Dq polling-based .
 105 This means that
 106 it uses clock interrupts instead of interrupts generated by DigiBoard cards and
 107 checks the state of cards 25 times per second.
 108 This is practical because the
 109 DigiBoard cards have large input and output buffers (more than 1Kbyte per
 110 port) and hardware that allows efficiently finding the port that needs
 111 attention.
 112 The only problem seen with this policy is slower
 113 SLIP and PPP response.
 114 .Pp
 115 Each line in the kernel configuration file describes one card, not one port
 116 as in the
 117 .Xr sio 4
 118 driver.
 119 .Pp
 120 The
 121 .Cm flags
 122 keyword may be used on each
 123 .Dq Li "device dgb"
 124 line in the kernel configuration file
 125 to change the pinout of the interface or to use new PC/Xe cards
 126 which can work with an 8K memory window in compatibility mode
 127 (with a 64K memory window).
 128 Note
 129 that using 8K memory window does not mean shorter input/output buffers, it means
 130 only that all buffers will be mapped to the same memory address and switched as
 131 needed.
 132 .Pp
 133 The
 134 .Cm port
 135 value must be the same
 136 as the
 137 port
 138 set on the card by jumpers.
 139 For PC/Xi cards the same rule is applicable to the
 140 .Cm iomem
 141 value.
 142 It must be the same as the memory address set on the card
 143 by jumpers.
 144 .\"Some documentation gives the address as a ``paragraph'' or ``segment'';
 145 .\"you can get the value of address by adding the digit "0" at end of
 146 .\"paragraph value, e.g., 0xfc000 -> 0xfc0000.
 147 For PC/Xe cards there is no need to use jumpers for this purpose.
 148 In fact there are no jumpers to do it.
 149 Just
 150 write the address you want as the
 151 .Cm iomem
 152 value in kernel config file and the card will be programmed
 153 to use this address.
 154 .Pp
 155 The same range of memory addresses may be used
 156 for all the DigiBoards installed
 157 (but not for any other card or real memory).
 158 DigiBoards
 159 with a large amount of memory (256K or 512K and perhaps
 160 even 128K) must be mapped
 161 to memory addresses outside of the first megabyte.
 162 If the computer
 163 has more than 15 megabytes of memory then there is no free address space
 164 outside of the first megabyte where such DigiBoards can be mapped.
 165 In this case you
 166 may need to reduce the amount of memory in the computer.
 167 But many machines provide a better solution.
 168 They have the ability to
 169 .Dq "turn off"
 170 the memory in the 16th megabyte (addresses 0xF00000 - 0xFFFFFF)
 171 using the
 172 BIOS setup.
 173 Then the DigiBoard's address space can be set to this
 174 .Dq hole .
 175 .\" XXX the following should be true for all serial drivers and
 176 .\" should not be repeated in the man pages for all serial drivers.
 177 .\" It was copied from sio.4.  The only changes were s/sio/dgb/g.
 178 .Pp
 179 Serial ports controlled by the
 180 .Nm
 181 driver can be used for both
 182 .Dq callin
 183 and
 184 .Dq callout .
 185 For each port there is a callin device and a callout device.
 186 The minor number of the callout device is 128 higher
 187 than that of the corresponding callin port.
 188 The callin device is general purpose.
 189 Processes opening it normally wait for carrier
 190 and for the callout device to become inactive.
 191 The callout device is used to steal the port from
 192 processes waiting for carrier on the callin device.
 193 Processes opening it do not wait for carrier
 194 and put any processes waiting for carrier on the callin device into
 195 a deeper sleep so that they do not conflict with the callout session.
 196 The callout device is abused for handling programs that are supposed
 197 to work on general ports and need to open the port without waiting
 198 but are too stupid to do so.
 199 .Pp
 200 The
 201 .Nm
 202 driver also supports an initial-state and a lock-state control
 203 device for each of the callin and the callout
 204 .Dq data
 205 devices.
 206 The minor number of the initial-state device is 32 higher
 207 than that of the corresponding data device.
 208 The minor number of the lock-state device is 64 higher
 209 than that of the corresponding data device.
 210 The termios settings of a data device are copied
 211 from those of the corresponding initial-state device
 212 on first opens and are not inherited from previous opens.
 213 Use
 214 .Xr stty 1
 215 in the normal way on the initial-state devices to program
 216 initial termios states suitable for your setup.
 217 .Pp
 218 The lock termios state acts as flags to disable changing
 219 the termios state.
 220 E.g., to lock a flag variable such as
 221 .Dv CRTSCTS ,
 222 use
 223 .Dq Li "stty crtscts"
 224 on the lock-state device.
 225 Speeds and special characters
 226 may be locked by setting the corresponding value in the lock-state
 227 device to any nonzero value.
 228 .Pp
 229 Correct programs talking to correctly wired external devices
 230 .\" XXX change next line in other man pages too, and rewrite this paragraph.
 231 work with almost arbitrary initial states and no locking,
 232 but other setups may benefit from changing some of the default
 233 initial state and locking the state.
 234 In particular, the initial states for non (POSIX) standard flags
 235 should be set to suit the devices attached and may need to be
 236 locked to prevent buggy programs from changing them.
 237 E.g.,
 238 .Dv CRTSCTS
 239 should be locked on for devices that support
 240 RTS/CTS handshaking at all times and off for devices that do not
 241 support it at all.
 242 .Dv CLOCAL
 243 should be locked on for devices
 244 that do not support carrier.
 245 .Dv HUPCL
 246 may be locked off if you do not
 247 want to hang up for some reason.
 248 In general, very bad things happen
 249 if something is locked to the wrong state, and things should not
 250 be locked for devices that support more than one setting.
 251 The
 252 .Dv CLOCAL
 253 flag on callin ports should be locked off for logins
 254 to avoid certain security holes, but this needs to be done by
 255 getty if the callin port is used for anything else.
 256 .Sh FILES
 257 .Bl -tag -width /dev/ttyiD?? -compact
 258 .It Pa /dev/ttyD??
 259 for callin ports
 260 .It Pa /dev/ttyiD??
 261 .It Pa /dev/ttylD??
 262 corresponding callin initial-state and lock-state devices
 263 .Pp
 264 .It Pa /dev/cuaD??
 265 for callout ports
 266 .It Pa /dev/cuaiD??
 267 .It Pa /dev/cualD??
 268 corresponding callout initial-state and lock-state devices
 269 .El
 270 .Pp
 271 .Bl -tag -width /etc/rc.serial -compact
 272 .It Pa /etc/rc.serial
 273 examples of setting the initial-state and lock-state devices
 274 .El
 275 .Pp
 276 The first question mark in these device names is short for the
 277 card number
 278 (a decimal number between 0 and 65535 inclusive).
 279 The second question mark is short for the port number
 280 (a letter in the range [0-9a-v]).
 281 .Sh DIAGNOSTICS
 282 You may enable extended diagnostics by defining DEBUG at the
 283 start of the source file
 284 .Pa dgb.c .
 285 .Bl -diag
 286 .It dgb\fIX\fP: warning: address \fIN\fP truncated to \fIM\fP
 287 The memory address for the PC/Xe's 8K window is misaligned (it should be
 288 on an 8K boundary) or outside of the first megabyte.
 289 .It dgb\fIX\fP: 1st reset failed
 290 Problems with accessing I/O port of the card, probably
 291 the wrong
 292 .Cm port
 293 value is specified in the kernel config file.
 294 .It dgb\fIX\fP: 2nd reset failed
 295 Problems with hardware.
 296 .It dgb\fIX\fP: \fIN\fP[st,nd,rd,th] memory test failed
 297 Problems with accessing the memory of the card, probably
 298 the wrong
 299 .Cm iomem
 300 value is specified in the kernel config file.
 301 .It dgb\fIX\fP: BIOS start failed
 302 Problems with starting the on-board BIOS.
 303 Probably the memory addresses of the
 304 DigiBoard overlap with some other device or with RAM.
 305 .It dgb\fIX\fP: BIOS download failed
 306 Problems with the on-board BIOS.
 307 Probably the memory addresses of the
 308 DigiBoard overlap with some other device or with RAM.
 309 .It dgb\fIX\fP: FEP code download failed
 310 Problems with downloading of the Front-End Processor's micro-OS.
 311 Probably the memory addresses of the
 312 DigiBoard overlap with some other device or with RAM.
 313 .It dgb\fIX\fP: FEP/OS start failed
 314 Problems with starting of the Front-End Processor's micro-OS.
 315 Probably the memory addresses of the
 316 DigiBoard overlap with some other device or with RAM.
 317 .It dgb\fIX\fP: too many ports
 318 This DigiBoard reports that it has more than 32 ports.
 319 Perhaps a hardware problem or
 320 the memory addresses of the
 321 DigiBoard overlap with some other device or with RAM.
 322 .It dgb\fIX\fP: only \fIN\fP ports are usable
 323 The
 324 .Dv NDGBPORTS
 325 parameter is too small and there is only enough space allocated
 326 for
 327 .Ar N
 328 ports on this card.
 329 .It dgb\fIX\fP: port \fIY\fP is broken
 330 The on-board diagnostic has reported that the specified port has hardware
 331 problems.
 332 .It dgb\fIX\fP: polling of disabled board stopped
 333 Internal problems in the polling logic of driver.
 334 .It dgb\fIX\fP: event queue's head or tail is wrong!
 335 Internal problems in the driver or hardware.
 336 .It dgb\fIX\fP: port \fIY\fP: got event on nonexisting port
 337 Some status changed on a port that is physically present but is
 338 unusable due to misconfiguration.
 339 .It dgb\fIX\fP: port \fIY\fP: event \fIN\fP mstat \fIM\fP lstat \fIK\fP
 340 The driver got a strange event from card.
 341 Probably this means that you have a
 342 newer card with an extended list of events or some other hardware problem.
 343 .It dgb\fIX\fP: port \fIY\fP: overrun
 344 Input buffer has filled up.
 345 Problems in polling logic of driver.
 346 .It dgb\fIX\fP: port \fIY\fP: FEP command on disabled port
 347 Internal problems in driver.
 348 .It dgb\fIX\fP: port \fIY\fP: timeout on FEP command
 349 Problems in hardware.
 350 .El
 351 .Sh SEE ALSO
 352 .Xr stty 1 ,
 353 .Xr termios 4 ,
 354 .Xr tty 4 ,
 355 .Xr comcontrol 8
 356 .\" XXX add next line to many other drivers.
 357 .Sh HISTORY
 358 The
 359 .Nm
 360 driver is derived from the
 361 .Xr sio 4
 362 driver and the DigiBoard driver from
 363 .Tn Linux
 364 and is
 365 .Ud
 366 .Sh BUGS
 367 The implementation of sending
 368 .Dv BREAK
 369 is broken.
 370 .Dv BREAK
 371 of fixed length of 1/4 s
 372 is sent anyway.
 373 .Pp
 374 There was a bug in implementation of
 375 .Xr select 2 .
 376 It is fixed now but not widely tested yet.
 377 .Pp
 378 There is no ditty command.
 379 Most of its functions (alternate pinout,
 380 speed up to 115200 baud, etc.) are implemented in the driver itself.
 381 Some
 382 other functions are missing.