share/man/man4/si.4

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