usr.sbin/stallion/stlload/stlload.8

   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/stlload/stlload.8,v 1.5.2.6 2003/03/11 22:31:33 trhodes Exp $
  32 .\"
  33 .Dd January 8, 1998
  34 .Dt STLLOAD 8 i386
  35 .Os
  36 .Sh NAME
  37 .Nm stlload
  38 .Nd "Stallion Technologies multiport serial board down loader"
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl vhVR
  42 .Op Fl i Ar image-file
  43 .Op Fl c Ar control-device
  44 .Op Fl r Ar rx-buf-size
  45 .Op Fl t Ar tx-buf-size
  46 .Op Fl B Ar boot-banner
  47 .Op Fl b Ar unit-number
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 utility
  52 is used to download the firmware code to Stallion Technologies intelligent
  53 multiport serial boards.
  54 A firmware download is only required for those boards that use the Stallion
  55 .Nm stli
  56 driver.
  57 This includes the EasyConnection 8/64, ONboard and Brumby families of boards.
  58 .Pp
  59 Different board types require different firmware images.
  60 If the wrong firmware is loaded into a board it will fail to operate.
  61 .Pp
  62 The Stallion EasyConnection 8/64 Host Adapter PCI cards DO NOT require
  63 firmware to be loaded.
  64 .Pp
  65 The download process is achieved through the Stallion
  66 .Nm stli
  67 driver control device,
  68 .Pa /dev/staliomem? .
  69 This device implements a file type device that can read and write into the
  70 boards shared memory region.
  71 It also implements a number of special
  72 .Em ioctls
  73 that reset and restart the board.
  74 .Pp
  75 The options are:
  76 .Bl -tag -width indent
  77 .It Fl v
  78 Verbose output generation.
  79 Trace is generated at each phase of the download and startup process.
  80 .It Fl h
  81 Output usage information.
  82 .It Fl V
  83 Output version information.
  84 .It Fl R
  85 Reset the board only.
  86 Does not proceed to download firmware to the board.
  87 .It Fl i Ar image-file
  88 Specify the firmware image file to download.
  89 The default firmware image is
  90 .Pa /usr/libdata/stallion/cdk.sys .
  91 .It Fl c Ar control-device
  92 Specify the board control device through which to download the firmware
  93 and start up the board.
  94 The default is
  95 .Pa /dev/staliomem0 .
  96 .It Fl r Ar rx-buf-size
  97 Specify the size of the boards shared memory Receive Data buffer.
  98 By default the buffer is dynamically sized to use the maximum
  99 available shared memory.
 100 .It Fl t Ar tx-buf-size
 101 Specify the size of the boards shared memory Transmit Data buffer.
 102 By default the buffer is dynamically sized to use the maximum
 103 available shared memory.
 104 .It Fl B Ar boot-banner
 105 Enable the slave debug trace flag during download.
 106 This enables debug trace output from the firmware code.
 107 This trace is output on port 0 of the board,
 108 and the port is set to 9600 baud, 8 data bits, no parity and 1 stop bit.
 109 .It Fl b Ar unit-number
 110 Specify the unit (board) number to be downloaded.  The default is to
 111 download board 0.
 112 .El
 113 .Pp
 114 The
 115 .Nm
 116 utility would typically be run from
 117 .Pa /etc/rc.d/serial .
 118 .Sh FILES
 119 .Bl -tag -width /usr/libdata/stallion/2681.sys
 120 .It Pa /usr/libdata/stallion/cdk.sys
 121 firmware code to EasyConnection 8/64 class boards
 122 .It Pa /usr/libdata/stallion/2681.sys
 123 firmware code to ONboard and Brumby class boards
 124 .It Pa /dev/staliomem?
 125 driver board control device
 126 .El
 127 .Sh SEE ALSO
 128 .Xr stl 4 ,
 129 .Xr stli 4 ,
 130 .Xr stlstats 8
 131 .Sh HISTORY
 132 This program was originally developed by
 133 .An Greg Ungerer Aq gerg@stallion.com .