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