share/man/man4/si.4

   1 .\" $FreeBSD: src/share/man/man4/si.4,v 1.20.2.5 2001/08/17 13:08:39 ru Exp $
   2 .\" $DragonFly: src/share/man/man4/si.4,v 1.3 2004/03/11 12:28:55 hmp Exp $
   3 .Dd September 16, 1995
   4 .Os
   5 .Dt SI 4
   6 .Sh NAME
   7 .Nm si
   8 .Nd "driver for Specialix International SI/XIO or SX intelligent serial card"
   9 .Sh SYNOPSIS
  10 .Cd "device si"
  11 .Cd "device si0 at isa? irq 12 iomem 0xd0000"
  12 .Sh DESCRIPTION
  13 The Specialix SI/XIO and SX hardware makes up an 8 to 32 port RS-232 serial
  14 multiplexor.
  15 .Pp
  16 The first instance of the device lines above is for EISA and PCI host cards,
  17 the second is for ISA host cards.
  18 .Pp
  19 The system uses two components:  A "Host adapter", which is plugged into
  20 an ISA, EISA or PCI slot and provides intelligence and buffering/processing
  21 capabilities, as well as an external bus in the form of a 37 pin cable.
  22 .Pp
  23 On this cable, "modules" are connected.  The "SI" module comes in a 4 and 8
  24 port version.  The "XIO" and "SX" modules come only in
  25 8 port versions.
  26 .Pp
  27 The host adapter polls and transfers data between the modules and the rest
  28 of the machine.
  29 The Host adapter provides a 256 byte transmit and 256 byte
  30 receive FIFO for each of the 32 ports that it can maintain.
  31 .Pp
  32 The XIO modules can operate each of their 8 ports at 115,200 baud.
  33 The SI version can run at 57,600 baud.
  34 The SX modules can operate each of their
  35 8 ports at up to 921,600 baud.
  36 .Pp
  37 SX modules are only supported when connected to an SX host card.
  38 SI or
  39 XIO modules are supported on any host card.
  40 .Pp
  41 The host adapter uses a shared memory block in the traditional ISA bus
  42 "hole" between 0xA0000 and 0xEFFFF.  The adapter can be configured outside
  43 range, but requires the memory range to be explicitly non-cached.  The
  44 driver does not yet support this mode of operation.
  45 .Pp
  46 SX ISA Host cards have an 8/16 bit mode switch or jumper on them.
  47 This switch
  48 or jumper MUST be set for 8 bit mode.
  49 .Pp
  50 The ISA adapters can use Irq's 11, 12 or 15 (and 9 and 10 in the case of
  51 SX host cards).
  52 .Pp
  53 The si device driver may have some of its configuration settings changed
  54 at run-time with the
  55 .Xr sicontrol 8
  56 utility.
  57 .Pp
  58 The si device driver also responds to the
  59 .Xr comcontrol 8
  60 utility for configuring drain-on-close timeouts.
  61 .Pp
  62 The driver also defines 3 sysctl variables that can be manipulated:
  63 machdep.si_debug sets the debug level for the whole driver.
  64 It depends
  65 on the driver being compiled with SI_DEBUG. machdep.si_pollrate
  66 sets how often per second the driver polls for lost interrupts.
  67 machdep.si_realpoll sets whether or not the card will treat the
  68 poll intervals as if they were interrupts.
  69 .Pp
  70 An open on a /dev device node controlled by the si driver obeys the same
  71 semantics as the
  72 .Xr sio 4
  73 driver.  It fully supports the usual semantics of the cua ports, and the
  74 "initial termios" and "locked termios" settings.  In summary, an open on a
  75 tty port will block until DCD is raised, unless O_NONBLOCK is specified.
  76 CLOCAL is honored.  An open on a cua port will always succeed, but DCD
  77 transitions will be honored after DCD rises for the first time.
  78 .Pp
  79 Up to four SI/XIO host cards may be controlled by the si driver.
  80 Due to the lack of available interrupts, only 3 ISA SI/XIO host cards can be
  81 used at once.
  82 .Pp
  83 The lowest 5 bits of the minor device number are used to select the port
  84 number on the module cluster.
  85 The next 2 bits select which of 4 host adapter
  86 cards.  This allows a maximum of 128 ports on this driver.
  87 .Pp
  88 Bit 7 is used to differentiate a tty/dialin port (bit 7=0) and a
  89 cua/callout port (bit 7=1).
  90 .Pp
  91 Bit 8 through 15 (on
  92 .Dx )
  93 are unavailable as they are a shadow of the
  94 major device number.
  95 .Pp
  96 If bit 16 is a 1, the device node is referring to the "initial state" device.
  97 This "initial state" is used to prime the
  98 .Xr termios 4
  99 settings of the device when it is initially opened.
 100 If bit 17 is a 1, the device node is referring to the "locked state" device.
 101 The "locked state" is used to prevent the
 102 .Xr termios 4
 103 settings from being changed.
 104 .Pp
 105 To manipulate the initial/locked settings, the
 106 .Xr stty 1
 107 command is useful.  When setting the "locked" variables, enabling the mode
 108 on the lock device will lock the termios mode, while disabling the mode will
 109 unlock it.
 110 .Sh FILES
 111 .Bl -tag -width /dev/si_control -compact
 112 .It Pa /dev/si_control
 113 global driver control file for
 114 .Xr sicontrol 8
 115 .It Pa /dev/ttyA*
 116 terminal/dialin ports
 117 .It Pa /dev/cuaA*
 118 dialout ports
 119 .It Pa /dev/ttyiA*
 120 initial termios state devices
 121 .It Pa /dev/ttylA*
 122 locked termios state devices
 123 .It Pa /dev/cuaiA*
 124 initial termios state devices for dialout ports
 125 .It Pa /dev/cualA*
 126 locked termios state devices for dialout ports
 127 .El
 128 .Sh SEE ALSO
 129 .Xr stty 1 ,
 130 .Xr sio 4 ,
 131 .Xr termios 4 ,
 132 .Xr tty 4 ,
 133 .Xr comcontrol 8 ,
 134 .Xr sicontrol 8
 135 .Sh HISTORY
 136 This driver is loosely based on driver code originating at Specialix, which
 137 was ported to run on BSDI by
 138 .An Andy Rutter Aq andy@specialix.co.uk .
 139 The System V driver source is/was available by ftp from
 140 .Sy ftp.specialix.co.uk .
 141 .Pp
 142 This driver is not supported by Specialix International.
 143 .Sh AUTHORS
 144 .An -nosplit
 145 .An Peter Wemm Aq peter@netplex.com.au
 146 obtained the code from
 147 .An Andy Rutter
 148 and ported it to
 149 .Fx
 150 and threw the man page together.
 151 .An Bruce Evans Aq bde@zeta.org.au
 152 provided a large amount of assistance during porting.
 153 .An Nick Sayer Aq nick@specialix.com
 154 wrote the EISA, PCI and SX portions.
 155 .Sh BUGS
 156 The interrupt tuning rate is not believed to be optimal at this time for
 157 maximum efficiency.
 158 .Pp
 159 Polled mode (a feature of standard Specialix drivers) is not implemented,
 160 but it can be approximated by turning on machdep.si_realpoll.  The poll
 161 frequency is set by machdep.si_pollrate (in units of 1/100th of a second).
 162 .Pp
 163 The driver does not yet support baud rates higher than 115,200 on SX
 164 modules.
 165 .Pp
 166 Operation outside the traditional ISA "hole" is not yet supported, although it
 167 should work if the test is removed from the probe routine.
 168 .Pp
 169 Multiple host cards are supported although combinations of hosts on
 170 different bus types have not been tested - device numbering is known to
 171 be a problem and may lead to unexpected results.