share/man/man4/si.4

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