1 .\" Copyright (c) 1996-1998 Greg Ungerer (gerg@stallion.oz.au).
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by Greg Ungerer.
15 .\" 4. Neither the name of the author nor the names of any co-contributors
16 .\" may be used to endorse or promote products derived from this software
17 .\" without specific prior written permission.
19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .\" $FreeBSD: src/usr.sbin/stallion/bootcode/stl.4,v 1.8.2.5 2001/12/14 16:41:52 ru Exp $
32 .\" $DragonFly: src/usr.sbin/stallion/bootcode/stl.4,v 1.9 2007/11/21 19:12:41 swildner Exp $
40 .Nd "drivers for Stallion Technologies multiport serial controllers"
43 .Cd "device stl0 at isa? port <addr> irq <irq>"
44 .Cd "device stli0 at isa? port <io-addr> iomem <mem-addr> iosiz <size> flags <type> "
45 .Cd "device stli0 at eisa? port <io-addr> iomem <mem-addr> iosiz <size> flags <type> "
47 This is a kernel driver for Stallion Technologies multiport serial boards.
48 There are two drivers, each supporting a different class of boards.
51 driver supports the EasyIO,
52 EasyConnection 8/32 and
53 EasyConnection 8/64-PCI boards,
56 driver supports all other types, including
57 ONboard, Brumby and EasyConnection 8/64 (ISA and EISA).
59 Each non-PCI board installed in the system needs a configuration entry in the
60 kernel configuration file.
61 Slightly different options and parameters are required for each of the
62 different board types.
63 Depending on the type of board one of the
67 drivers will be used. The
71 drivers can support up to 8 boards.
73 Configuration of the hardware - DIP switches, jumpers, etc - varies
75 Consult documentation supplied with the board for hardware
76 configuration details.
77 Alternatively the board documentation is available on Stallion
78 Technologies WWW site at
79 .Pa http://www.stallion.com .
81 The EasyIO, EasyConnection 8/32 and EasyConnection 8/64-PCI
82 families of boards use the
85 ISA board configuration entries for the
87 driver take the general form of:
89 .Cd "device stlX at isa? port <io-addr> irq <irq>"
92 is the unit number assigned to the board.
93 Any unique value between 0 and 7 is valid.
95 The I/O address used by the board is specified by
97 Each of the EasyIO and EasyConnection 8/32-AT boards can use
98 an I/O address in the range from 0 to 0x400.
100 All EasyIO and EasyConnection 8/32 boards require an interrupt,
101 and this interrupt is specified by
103 Legal IRQ values for the ISA boards are 3, 4, 5, 7, 10, 11, 12 and 15.
104 Interrupts are software programmed on all boards except the EasyIO-8M.
106 The EasyConnection 8/32-AT board uses a secondary I/O address region,
107 and this is fixed at address 0x280 in the driver code.
108 All EasyConnection 8/32-AT boards may share the same secondary address
111 All EasyIO and EasyConnection PCI boards are detected
112 automatically by the drivers on boot up.
113 No configuration information is required in advance for these
117 driver will issue messages to indicate that a Stallion
118 PCI board was found, and some information about it.
119 If no ISA card is being configured, an entry like
123 will include the driver for PCI cards only.
125 Following are some examples of configuration entries for each of the ISA
126 boards supported by the
129 Each example also describes some important details about each of the
132 Each EasyIO board requires 8 bytes of I/O address space and 1 IRQ line.
133 A configuration entry for an EasyIO board would look like:
135 .Cd "device stl0 at isa? port 0x2a8 irq 15"
137 This entry specifies an EasyIO board at I/O address 0x2a8 using IRQ 15.
138 The I/O and IRQ values can be modified as required.
140 Each EasyConnection 8/32-AT board requires 2 sets of I/O addresses
142 The primary I/O address range is 2 bytes in size, and must be unique
143 to each EasyConnection 8/32-AT board in the system.
144 The secondary I/O address range is 32 bytes in size, but can be shared
145 by multiple EasyConnection 8/32-AT boards.
146 This secondary I/O address is set at 0x280 in the driver code.
147 A configuration entry would look like:
149 .Cd "device stl0 at isa? port 0x2a0 irq 10"
151 This specifies an EasyConnection 8/32-AT with primary I/O address 0x2a0,
152 secondary I/O address of 0x280 and IRQ 10.
154 The ONboard, Brumby and EasyConnection 8/64
155 families of boards use the
159 driver supports the ISA and EISA members of these families.
161 ISA board configuration entries for the
163 driver take the general form of:
165 .Cd "device stliX at isa? port <io-addr> iomem <mem-addr> iosiz <size> flags <type>"
168 is the unit number assigned to the board.
169 Any unique value between 0 and 7 is valid.
171 The I/O address used by the board is specified by
173 Each of the different supported board types has restrictions on valid
174 I/O addresses and also the amount of I/O space required varies between
179 driver require a shared memory region to operate.
180 Depending on the board type the region required varies in size
181 from 4 kbytes to 64 kbytes. The size of the board region is specified
184 of the configuration entry, and the address of the region is specified by
187 The flags field specifies the particular board type that this entry
189 Not all board types are distinguishable by the driver at runtime,
190 so this field is required by the driver.
191 Valid board types are:
192 .Bd -literal -offset indent
193 BOARD NAME TYPE I/O SIZE
198 EasyConnection 8/64-AT 23 0x1000
199 EasyConnection 8/64-EISA 24 0x10000
202 Following are some examples of configuration entries for each of the
203 boards supported by the
205 driver. Each example also describes some important details about
206 each of the board types.
208 The EasyConnection 8/64-AT board requires 4 bytes of I/O address space and
209 4 kbytes of memory space.
210 A configuration entry would look like:
212 .Cd "device stli0 at isa? port 0x2a0 iomem 0xcc000 iosiz 0x1000 flags 23"
214 The flags field of this entry specifies that this is an
215 EasyConnection 8/64-AT board.
216 It is set to I/O address 0x2a0 and memory address 0xcc000.
219 parameter specifies a memory region size
222 The EasyConnection 8/64-EISA board requires a 64 kbyte region of
224 This region can be anywhere in the 32 bit memory address space.
225 A configuration entry would be like:
227 .Cd "device stli0 at eisa? port 0x2000 iomem 0x80000000 iosiz 0x10000 flags 24"
229 The flags field is used to specify that this is an EasyConnection 8/64-EISA
231 The I/O (port) address resource is derived from the EISA slot that
233 Each EISA slot is allocated a section of the I/O address space by the
234 hardware of the system.
235 That address being 0xX000 where X is the slot number.
236 The example board is at memory address 0x80000000 which is 2 Gbyte.
239 parameter specifies the size of the memory region,
240 in this case 64 kbytes.
242 Each ONboard ISA board requires 16 bytes of I/O space and a 64 kbyte
243 section of memory address space.
244 Valid ONboard I/O addresses are in the range 0x200 to 0x300.
245 A configuration entry for an ONboard ISA would look like:
247 .Cd "device stli0 at isa? port 0x240 iomem 0xd0000 iosiz 0x10000 flags 4"
249 This entry specifies an ONboard ISA by setting flags to 4.
250 It uses I/O address 0x240 and a memory region of 64 kbytes at memory
253 Each ONboard/E board requires a 64 kbyte memory region, and this
254 can be anywhere in the 32 bit address space (that is from 0 to 4 Gbyte).
255 A configuration entry would look like:
257 .Cd "device stli0 at eisa? port 0x3000 iomem 0xc0000000 iosiz 0x10000 flags 7"
259 The specifies an ONboard/E in slot 3 using a shared memory address
260 of 0xc0000000 (3 Gbyte).
262 Each Brumby board requires 16 bytes of I/O address space and a 4 kbyte
263 region of shared memory space.
264 The valid Brumby I/O addresses are in the range 0x300 to 0x400.
265 The shared memory region of the Brumby must be in the 0xc0000 to
266 0xdc000 region of the memory address space.
267 A configuration entry for a Brumby would be like:
269 .Cd "device stli0 at isa? port 0x360 iomem 0xc8000 iosiz 0x4000 flags 2"
271 This specifies a Brumby board at I/O address 0x360 using a shared memory
272 region at address 0xc8000.
274 Each driver has a separate major number allocated,
275 so even though the port device names are the same for each driver,
276 the major number of the device node is different.
278 The intelligent board types (ONboard, Brumby and
279 EasyConnection 8/64 (ISA and EISA))
280 require a firmware download before the ports will be operational.
281 This is achieved by using the
284 See its manual page for details on usage.
286 .Bl -tag -width "/dev/staliomem?" -compact
288 stl standard callin devices
290 stl initial-state callin devices
292 stl lock-state callin devices
294 stl standard callout devices
296 stl initial-state callout devices
298 stl lock-state callout devices
300 stli standard callin devices
302 stli initial-state callin devices
304 stli lock-state callin devices
306 stli standard callout devices
308 stli initial-state callout devices
310 stli lock-state callout devices
311 .It Pa /dev/staliomem?
315 Note that the port numbers start at 0 for port 0 of board 0.
316 Each board has 64 port slots allocated for it.
317 So the second boards ports start at 64 and go through 127.
327 This driver was originally developed by Greg Ungerer (gerg@stallion.com).
329 The /dev/staliomem? device name is shared between both the
333 drivers. This may cause confusion if both drivers are present in the
334 system at the same time.
336 Device names use integer suffixes, rather than the 0-9 a-z sequence
337 that other drivers use.
339 There will be many unused ttyE device names in a system with more than