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.4 2006/02/10 19:01:10 swildner Exp $
  33 .\"
  34 .Dd January 8, 1998
  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 .Cd "device stli0 at eisa? port <io-addr> iomem <mem-addr> iosiz <size> flags <type> "
  46 .Sh DESCRIPTION
  47 This is a kernel driver for Stallion Technologies multiport serial boards.
  48 There are two drivers, each supporting a different class of boards.
  49 The
  50 .Nm
  51 driver supports the EasyIO,
  52 EasyConnection 8/32 and
  53 EasyConnection 8/64-PCI boards,
  54 while the
  55 .Nm stli
  56 driver supports all other types, including
  57 ONboard, Brumby and EasyConnection 8/64 (ISA and EISA).
  58 .Sh CONFIGURATION
  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
  64 .Nm
  65 or
  66 .Nm stli
  67 drivers will be used.  The
  68 .Nm
  69 and
  70 .Nm stli
  71 drivers can support up to 8 boards.
  72 .Pp
  73 Configuration of the hardware - DIP switches, jumpers, etc - varies
  74 from board to board.
  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 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 and EISA 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 EasyConnection 8/64-EISA         24     0x10000
 199 .Ed
 200 .Pp
 201 Following are some examples of configuration entries for each of the
 202 boards supported by the
 203 .Nm stli
 204 driver. Each example also describes some important details about
 205 each of the board types.
 206 .Pp
 207 The EasyConnection 8/64-AT board requires 4 bytes of I/O address space and
 208 4 kbytes of memory space.
 209 A configuration entry would look like:
 210 .Pp
 211 .Cd "device stli0 at isa? port 0x2a0 iomem 0xcc000 iosiz 0x1000 flags 23"
 212 .Pp
 213 The flags field of this entry specifies that this is an
 214 EasyConnection 8/64-AT board.
 215 It is set to I/O address 0x2a0 and memory address 0xcc000.
 216 The
 217 .Ar iosiz
 218 parameter specifies a memory region size
 219 of 4 kbytes.
 220 .Pp
 221 The EasyConnection 8/64-EISA board requires a 64 kbyte region of
 222 memory space.
 223 This region can be anywhere in the 32 bit memory address space.
 224 A configuration entry would be like:
 225 .Pp
 226 .Cd "device stli0 at eisa? port 0x2000 iomem 0x80000000 iosiz 0x10000 flags 24"
 227 .Pp
 228 The flags field is used to specify that this is an EasyConnection 8/64-EISA
 229 board.
 230 The I/O (port) address resource is derived from the EISA slot that
 231 the board is in.
 232 Each EISA slot is allocated a section of the I/O address space by the
 233 hardware of the system.
 234 That address being 0xX000 where X is the slot number.
 235 The example board is at memory address 0x80000000 which is 2 Gbyte.
 236 The
 237 .Ar iosiz
 238 parameter specifies the size of the memory region,
 239 in this case 64 kbytes.
 240 .Pp
 241 Each ONboard ISA board requires 16 bytes of I/O space and a 64 kbyte
 242 section of memory address space.
 243 Valid ONboard I/O addresses are in the range 0x200 to 0x300.
 244 A configuration entry for an ONboard ISA would look like:
 245 .Pp
 246 .Cd "device stli0 at isa? port 0x240 iomem 0xd0000 iosiz 0x10000 flags 4"
 247 .Pp
 248 This entry specifies an ONboard ISA by setting flags to 4.
 249 It uses I/O address 0x240 and a memory region of 64 kbytes at memory
 250 address 0xd0000.
 251 .Pp
 252 Each ONboard/E board requires a 64 kbyte memory region, and this
 253 can be anywhere in the 32 bit address space (that is from 0 to 4 Gbyte).
 254 A configuration entry would look like:
 255 .Pp
 256 .Cd "device stli0 at eisa? port 0x3000 iomem 0xc0000000 iosiz 0x10000 flags 7"
 257 .Pp
 258 The specifies an ONboard/E in slot 3 using a shared memory address
 259 of 0xc0000000 (3 Gbyte).
 260 .Pp
 261 Each Brumby board requires 16 bytes of I/O address space and a 4 kbyte
 262 region of shared memory space.
 263 The valid Brumby I/O addresses are in the range 0x300 to 0x400.
 264 The shared memory region of the Brumby must be in the 0xc0000 to
 265 0xdc000 region of the memory address space.
 266 A configuration entry for a Brumby would be like:
 267 .Pp
 268 .Cd "device stli0 at isa? port 0x360 iomem 0xc8000 iosiz 0x4000 flags 2"
 269 .Pp
 270 This specifies a Brumby board at I/O address 0x360 using a shared memory
 271 region at address 0xc8000.
 272 .Sh NOTES
 273 When building the device nodes for the ports be sure to use the correct
 274 driver name,
 275 .Nm
 276 or
 277 .Nm stli .
 278 Each driver has a separate major number allocated,
 279 so even though the port device names are the same for each driver,
 280 the major number of the device node is different.
 281 Use the
 282 .Xr MAKEDEV 8
 283 script to create the devices.
 284 Use the ttyE and cue tag for the
 285 .Nm
 286 driver, and
 287 the ttyEi and cuei tags for the
 288 .Nm stli
 289 driver.
 290 .Pp
 291 The intelligent board types (ONboard, Brumby and
 292 EasyConnection 8/64 (ISA and EISA))
 293 require a firmware download before the ports will be operational.
 294 This is achieved by using the
 295 .Nm stlload
 296 command.
 297 See its manual page for details on usage.
 298 .Sh FILES
 299 .Bl -tag -width "/dev/staliomem?" -compact
 300 .It Pa /dev/ttyE?
 301 stl standard callin devices
 302 .It Pa /dev/ttyiE?
 303 stl initial-state callin devices
 304 .It Pa /dev/ttylE?
 305 stl lock-state callin devices
 306 .It Pa /dev/cuaE?
 307 stl standard callout devices
 308 .It Pa /dev/cuaiE?
 309 stl initial-state callout devices
 310 .It Pa /dev/cualE?
 311 stl lock-state callout devices
 312 .It Pa /dev/ttyF?
 313 stli standard callin devices
 314 .It Pa /dev/ttyiF?
 315 stli initial-state callin devices
 316 .It Pa /dev/ttylF?
 317 stli lock-state callin devices
 318 .It Pa /dev/cuaF?
 319 stli standard callout devices
 320 .It Pa /dev/cuaiF?
 321 stli initial-state callout devices
 322 .It Pa /dev/cualF?
 323 stli lock-state callout devices
 324 .It Pa /dev/staliomem?
 325 board control device
 326 .El
 327 .Pp
 328 Note that the port numbers start at 0 for port 0 of board 0.
 329 Each board has 64 port slots allocated for it.
 330 So the second boards ports start at 64 and go through 127.
 331 Use the
 332 .Xr MAKEDEV 8
 333 script to create the devices.
 334 Use the
 335 .Ar ttyEx
 336 and
 337 .Ar cuaEx
 338 tag for the
 339 .Nm
 340 driver, and
 341 the
 342 .Ar ttyFx
 343 and
 344 .Ar cuaFx
 345 tags for the
 346 .Nm stli
 347 driver, where
 348 .Ar x
 349 is the board number.
 350 By default,
 351 .Xr MAKEDEV 8
 352 only creates 8 devices per board (to keep the directory size
 353 reasonable).
 354 To create the remaining devices for EasyConnection 8/32 and
 355 EasyConnection 8/64 cards, see the comments in the
 356 .Xr MAKEDEV
 357 script.
 358 .Sh BUGS
 359 The /dev/staliomem? device name is shared between both the
 360 .Nm
 361 and
 362 .Nm stli
 363 drivers.  This may cause confusion if both drivers are present in the
 364 system at the same time.
 365 .Pp
 366 Device names use integer suffixes, rather than the 0-9 a-z sequence
 367 that other drivers use.
 368 .Pp
 369 There will be many unused ttyE device names in a system with more than
 370 one card.
 371 .Sh SEE ALSO
 372 .Xr tty 4 ,
 373 .Xr termios 4 ,
 374 .Xr stty 1 ,
 375 .Xr comcontrol 8 ,
 376 .Xr stlload 8 ,
 377 .Xr stlstats 8 ,
 378 .Xr stlstty 8 ,
 379 .Xr MAKEDEV 8
 380 .Sh HISTORY
 381 This driver was originally developed by Greg Ungerer (gerg@stallion.com).