share/man/man4/si.4

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