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