usr.sbin/stallion/bootcode/stl.4

   1 .\" Copyright (c) 1996-1998 Greg Ungerer (gerg@stallion.oz.au).
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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.
  18 .\"
  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
  29 .\" SUCH DAMAGE.
  30 .\"
  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 $
  33 .\"
  34 .Dd August 6, 2009
  35 .Os
  36 .Dt STL 4 i386
  37 .Sh NAME
  38 .Nm stl ,
  39 .Nm stli
  40 .Nd "drivers for Stallion Technologies multiport serial controllers"
  41 .Sh SYNOPSIS
  42 .Cd "device stl"
  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 .Sh DESCRIPTION
  46 This is a kernel driver for Stallion Technologies multiport serial boards.
  47 There are two drivers, each supporting a different class of boards.
  48 The
  49 .Nm
  50 driver supports the EasyIO,
  51 EasyConnection 8/32 and
  52 EasyConnection 8/64-PCI boards,
  53 while the
  54 .Nm stli
  55 driver supports all other types, including
  56 ONboard, Brumby and EasyConnection 8/64 (ISA).
  57 .Sh CONFIGURATION
  58 Each non-PCI board installed in the system needs a configuration entry in the
  59 kernel configuration file.
  60 Slightly different options and parameters are required for each of the
  61 different board types.
  62 Depending on the type of board one of the
  63 .Nm
  64 or
  65 .Nm stli
  66 drivers will be used.  The
  67 .Nm
  68 and
  69 .Nm stli
  70 drivers can support up to 8 boards.
  71 .Pp
  72 Configuration of the hardware - DIP switches, jumpers, etc - varies
  73 from board to board.
  74 Consult documentation supplied with the board for hardware
  75 configuration details.
  76 Alternatively the board documentation is available on Stallion
  77 Technologies WWW site at
  78 .Pa http://www.stallion.com .
  79 .Pp
  80 The EasyIO, EasyConnection 8/32 and EasyConnection 8/64-PCI
  81 families of boards use the
  82 .Nm
  83 driver.
  84 ISA board configuration entries for the
  85 .Nm
  86 driver take the general form of:
  87 .Pp
  88 .Cd "device stlX at isa? port <io-addr> irq <irq>"
  89 .Pp
  90 .Ar X
  91 is the unit number assigned to the board.
  92 Any unique value between 0 and 7 is valid.
  93 .Pp
  94 The I/O address used by the board is specified by
  95 .Ar <io-addr> .
  96 Each of the EasyIO and EasyConnection 8/32-AT boards can use
  97 an I/O address in the range from 0 to 0x400.
  98 .Pp
  99 All EasyIO and EasyConnection 8/32 boards require an interrupt,
 100 and this interrupt is specified by
 101 .Ar <irq> .
 102 Legal IRQ values for the ISA boards are 3, 4, 5, 7, 10, 11, 12 and 15.
 103 Interrupts are software programmed on all boards except the EasyIO-8M.
 104 .Pp
 105 The EasyConnection 8/32-AT board uses a secondary I/O address region,
 106 and this is fixed at address 0x280 in the driver code.
 107 All EasyConnection 8/32-AT boards may share the same secondary address
 108 region.
 109 .Pp
 110 All EasyIO and EasyConnection PCI boards are detected
 111 automatically by the drivers on boot up.
 112 No configuration information is required in advance for these
 113 board types.
 114 During boot up the
 115 .Nm
 116 driver will issue messages to indicate that a Stallion
 117 PCI board was found, and some information about it.
 118 If no ISA card is being configured, an entry like
 119 .Pp
 120 .Cd "device stl"
 121 .Pp
 122 will include the driver for PCI cards only.
 123 .Pp
 124 Following are some examples of configuration entries for each of the ISA
 125 boards supported by the
 126 .Nm
 127 driver.
 128 Each example also describes some important details about each of the
 129 board types.
 130 .Pp
 131 Each EasyIO board requires 8 bytes of I/O address space and 1 IRQ line.
 132 A configuration entry for an EasyIO board would look like:
 133 .Pp
 134 .Cd "device stl0 at isa? port 0x2a8 irq 15"
 135 .Pp
 136 This entry specifies an EasyIO board at I/O address 0x2a8 using IRQ 15.
 137 The I/O and IRQ values can be modified as required.
 138 .Pp
 139 Each EasyConnection 8/32-AT board requires 2 sets of I/O addresses
 140 and 1 IRQ line.
 141 The primary I/O address range is 2 bytes in size, and must be unique
 142 to each EasyConnection 8/32-AT board in the system.
 143 The secondary I/O address range is 32 bytes in size, but can be shared
 144 by multiple EasyConnection 8/32-AT boards.
 145 This secondary I/O address is set at 0x280 in the driver code.
 146 A configuration entry would look like:
 147 .Pp
 148 .Cd "device stl0 at isa? port 0x2a0 irq 10"
 149 .Pp
 150 This specifies an EasyConnection 8/32-AT with primary I/O address 0x2a0,
 151 secondary I/O address of 0x280 and IRQ 10.
 152 .Pp
 153 The ONboard, Brumby and EasyConnection 8/64
 154 families of boards use the
 155 .Nm stli
 156 driver.  The
 157 .Nm stli
 158 driver supports the ISA members of these families.
 159 .Pp
 160 ISA board configuration entries for the
 161 .Nm stli
 162 driver take the general form of:
 163 .Pp
 164 .Cd "device stliX at isa? port <io-addr> iomem <mem-addr> iosiz <size> flags <type>"
 165 .Pp
 166 .Ar X
 167 is the unit number assigned to the board.
 168 Any unique value between 0 and 7 is valid.
 169 .Pp
 170 The I/O address used by the board is specified by
 171 .Ar <io-addr> .
 172 Each of the different supported board types has restrictions on valid
 173 I/O addresses and also the amount of I/O space required varies between
 174 the boards.
 175 .Pp
 176 All boards using the
 177 .Nm stli
 178 driver require a shared memory region to operate.
 179 Depending on the board type the region required varies in size
 180 from 4 kbytes to 64 kbytes.  The size of the board region is specified
 181 by field
 182 .Ar <size>
 183 of the configuration entry, and the address of the region is specified by
 184 .Ar <mem-addr> .
 185 .Pp
 186 The flags field specifies the particular board type that this entry
 187 applies to.
 188 Not all board types are distinguishable by the driver at runtime,
 189 so this field is required by the driver.
 190 Valid board types are:
 191 .Bd -literal -offset indent
 192 BOARD NAME                      TYPE    I/O SIZE
 193
 194 Brumby                            2     0x4000
 195 ONboard                           4     0x10000
 196 ONboard/E                         7     0x10000
 197 EasyConnection 8/64-AT           23     0x1000
 198 .Ed
 199 .Pp
 200 Following are some examples of configuration entries for each of the
 201 boards supported by the
 202 .Nm stli
 203 driver. Each example also describes some important details about
 204 each of the board types.
 205 .Pp
 206 The EasyConnection 8/64-AT board requires 4 bytes of I/O address space and
 207 4 kbytes of memory space.
 208 A configuration entry would look like:
 209 .Pp
 210 .Cd "device stli0 at isa? port 0x2a0 iomem 0xcc000 iosiz 0x1000 flags 23"
 211 .Pp
 212 The flags field of this entry specifies that this is an
 213 EasyConnection 8/64-AT board.
 214 It is set to I/O address 0x2a0 and memory address 0xcc000.
 215 The
 216 .Ar iosiz
 217 parameter specifies a memory region size
 218 of 4 kbytes.
 219 .Pp
 220 Each ONboard ISA board requires 16 bytes of I/O space and a 64 kbyte
 221 section of memory address space.
 222 Valid ONboard I/O addresses are in the range 0x200 to 0x300.
 223 A configuration entry for an ONboard ISA would look like:
 224 .Pp
 225 .Cd "device stli0 at isa? port 0x240 iomem 0xd0000 iosiz 0x10000 flags 4"
 226 .Pp
 227 This entry specifies an ONboard ISA by setting flags to 4.
 228 It uses I/O address 0x240 and a memory region of 64 kbytes at memory
 229 address 0xd0000.
 230 .Pp
 231 Each Brumby board requires 16 bytes of I/O address space and a 4 kbyte
 232 region of shared memory space.
 233 The valid Brumby I/O addresses are in the range 0x300 to 0x400.
 234 The shared memory region of the Brumby must be in the 0xc0000 to
 235 0xdc000 region of the memory address space.
 236 A configuration entry for a Brumby would be like:
 237 .Pp
 238 .Cd "device stli0 at isa? port 0x360 iomem 0xc8000 iosiz 0x4000 flags 2"
 239 .Pp
 240 This specifies a Brumby board at I/O address 0x360 using a shared memory
 241 region at address 0xc8000.
 242 .Sh NOTES
 243 Each driver has a separate major number allocated,
 244 so even though the port device names are the same for each driver,
 245 the major number of the device node is different.
 246 .Pp
 247 The intelligent board types (ONboard, Brumby and
 248 EasyConnection 8/64 (ISA))
 249 require a firmware download before the ports will be operational.
 250 This is achieved by using the
 251 .Nm stlload
 252 command.
 253 See its manual page for details on usage.
 254 .Sh FILES
 255 .Bl -tag -width "/dev/staliomem?" -compact
 256 .It Pa /dev/ttyE?
 257 stl standard callin devices
 258 .It Pa /dev/ttyiE?
 259 stl initial-state callin devices
 260 .It Pa /dev/ttylE?
 261 stl lock-state callin devices
 262 .It Pa /dev/cuaE?
 263 stl standard callout devices
 264 .It Pa /dev/cuaiE?
 265 stl initial-state callout devices
 266 .It Pa /dev/cualE?
 267 stl lock-state callout devices
 268 .It Pa /dev/ttyF?
 269 stli standard callin devices
 270 .It Pa /dev/ttyiF?
 271 stli initial-state callin devices
 272 .It Pa /dev/ttylF?
 273 stli lock-state callin devices
 274 .It Pa /dev/cuaF?
 275 stli standard callout devices
 276 .It Pa /dev/cuaiF?
 277 stli initial-state callout devices
 278 .It Pa /dev/cualF?
 279 stli lock-state callout devices
 280 .It Pa /dev/staliomem?
 281 board control device
 282 .El
 283 .Pp
 284 Note that the port numbers start at 0 for port 0 of board 0.
 285 Each board has 64 port slots allocated for it.
 286 So the second boards ports start at 64 and go through 127.
 287 .Sh SEE ALSO
 288 .Xr stty 1 ,
 289 .Xr termios 4 ,
 290 .Xr tty 4 ,
 291 .Xr comcontrol 8 ,
 292 .Xr stlload 8 ,
 293 .Xr stlstats 8 ,
 294 .Xr stlstty 8
 295 .Sh HISTORY
 296 This driver was originally developed by Greg Ungerer (gerg@stallion.com).
 297 .Sh BUGS
 298 The /dev/staliomem? device name is shared between both the
 299 .Nm
 300 and
 301 .Nm stli
 302 drivers.  This may cause confusion if both drivers are present in the
 303 system at the same time.
 304 .Pp
 305 Device names use integer suffixes, rather than the 0-9 a-z sequence
 306 that other drivers use.
 307 .Pp
 308 There will be many unused ttyE device names in a system with more than
 309 one card.