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