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