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