1 /*****************************************************************************/
4 * stlload.c -- stallion intelligent multiport down loader.
6 * Copyright (c) 1994-1996 Greg Ungerer (gerg@stallion.oz.au).
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed by Greg Ungerer.
20 * 4. Neither the name of the author nor the names of any co-contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 /*****************************************************************************/
40 static const char rcsid[] =
51 #include <sys/ioctl.h>
53 #include <machine/cdk.h>
55 /*****************************************************************************/
57 char *version = "1.0.0";
58 const char defdevice[] = "/dev/staliomem%d";
59 char *image = BOOTDIR "/cdk.sys";
60 char *oldimage = BOOTDIR "/2681.sys";
69 * Define a local buffer for copying the image into the shared memory.
76 * Define the timeout length when waiting for slave to start up.
77 * The quantity is measured in seconds.
82 * Set up a default feature area structure.
84 cdkfeature_t feature = { 0, 0, ETYP_CDK, 0, 0, 0, 0, 0 };
87 * Have local copies of the board signatures ready.
92 /*****************************************************************************/
95 * Declare internal function prototypes here.
97 static void usage(void);
98 int ecpfindports(cdkecpsig_t *sigp);
99 int onbfindports(cdkonbsig_t *sigp);
102 /*****************************************************************************/
106 fprintf(stderr, "%s\n%s\n",
107 "usage: stlload [-vhVR] [-i image-file] [-c control-device] [-r rx-buf-size]",
108 " [-t tx-buf-size] [-B boot-banner] [-b unit-number]");
112 /*****************************************************************************/
115 * Given a boards signature determine how many ports it has. We need to
116 * know this to setup the slave feature arguments. This function is for
120 int ecpfindports(cdkecpsig_t *sigp)
126 for (bank = 0; (bank < 8); bank++) {
127 id = (unsigned int) sigp->panelid[bank];
130 if ((id & 0x07) != bank)
143 /*****************************************************************************/
146 * Given a boards signature determine how many ports it has. We need to
147 * know this to setup the slave feature arguments. This function is for
148 * ONboards and Brumbys.
151 int onbfindports(cdkonbsig_t *sigp)
158 for (i = 0; (i < 16); i++) {
159 if (((sigp->amask0 << i) & 0x8000) == 0)
168 /*****************************************************************************/
171 * Download an image to the slave board. There is a long sequence of
172 * things to do to get the slave running, but it is basically a simple
173 * process. Main things to do are: copy slave image into shared memory,
174 * start slave running and then read shared memory map.
179 unsigned char alivemarker;
182 int nrdevs, sigok, n;
185 printf("Opening shared memory device %s\n", memdevice);
186 if ((memfd = open(memdevice, O_RDWR)) < 0) {
187 warn("failed to open memory device %s", memdevice);
192 * Before starting the download must tell driver that we are about to
193 * stop its slave. This is only important if it is already running.
194 * Once we have told the driver its stopped then do a hardware reset
195 * on it, to get it into a known state.
198 printf("Stoping any current slave\n");
199 if (ioctl(memfd, STL_BSTOP, 0) < 0) {
200 warn("ioctl(STL_BSTOP)");
201 printf(" (Perhaps you're trying to download firmare to a PCI card that\n doesn't require this?)\n");
206 printf("Reseting the board\n");
207 if (ioctl(memfd, STL_BRESET, 0) < 0) {
208 warn("ioctl(STL_BRESET)");
215 * After reseting the board we need to send an interrupt to the older
216 * board types to get them to become active. Do that now.
219 printf("Interrupting board to activate shared memory\n");
220 if (ioctl(memfd, STL_BINTR, 0) < 0) {
221 warn("ioctl(STL_BINTR)");
227 printf("Opening slave image file %s\n", image);
228 if ((ifd = open(image, O_RDONLY)) < 0) {
229 warn("failed to open image file %s", image);
234 * At this point get the signature of the board from the shared memory.
235 * Do a double check that it is a board we know about. We will also need
236 * to calculate the number of ports on this board (to use later).
240 printf("Reading ROM signature from board\n");
242 if (lseek(memfd, CDK_SIGADDR, SEEK_SET) != CDK_SIGADDR) {
243 warn("lseek(%x) failed on memory file", CDK_FEATADDR);
246 if (read(memfd, &ecpsig, sizeof(cdkecpsig_t)) < 0) {
247 warn("read of ROM signature failed");
250 if (ecpsig.magic == ECP_MAGIC) {
251 nrdevs = ecpfindports(&ecpsig);
257 if (lseek(memfd, CDK_SIGADDR, SEEK_SET) != CDK_SIGADDR) {
258 warn("lseek(%x) failed on memory file", CDK_FEATADDR);
261 if (read(memfd, &onbsig, sizeof(cdkonbsig_t)) < 0) {
262 warn("read of ROM signature failed");
265 if ((onbsig.magic0 == ONB_MAGIC0) && (onbsig.magic1 == ONB_MAGIC1) &&
266 (onbsig.magic2 == ONB_MAGIC2) &&
267 (onbsig.magic3 == ONB_MAGIC3)) {
268 nrdevs = onbfindports(&onbsig);
275 warnx("unknown signature from board");
280 printf("Board signature reports %d ports\n", nrdevs);
283 * Start to copy the image file into shared memory. The first thing to
284 * do is copy the vector region in from shared memory address 0. We will
285 * then skip over the signature and feature area and start copying the
286 * actual image data and code from 4k upwards.
289 printf("Copying vector table into shared memory\n");
290 if ((n = read(ifd, buf, CDK_SIGADDR)) < 0) {
291 warn("read of image file failed");
294 if (lseek(memfd, 0, SEEK_SET) != 0) {
295 warn("lseek(%x) failed on memory file", CDK_FEATADDR);
298 if (write(memfd, buf, n) < 0) {
299 warn("write to memory device failed");
303 if (lseek(ifd, 0x1000, SEEK_SET) != 0x1000) {
304 warn("lseek(%x) failed on image file", CDK_FEATADDR);
307 if (lseek(memfd, 0x1000, SEEK_SET) != 0x1000) {
308 warn("lseek(%x) failed on memory device", CDK_FEATADDR);
313 * Copy buffer size chunks of data from the image file into shared memory.
316 if ((n = read(ifd, buf, BUFSIZE)) < 0) {
317 warn("read of image file failed");
320 if (write(memfd, buf, n) < 0) {
321 warn("write to memory device failed");
324 } while (n == BUFSIZE);
329 * We need to down load the start up parameters for the slave. This is
330 * done via the feature area of shared memory. Think of the feature area
331 * as a way of passing "command line" arguments to the slave.
332 * FIX: should do something here to load "brdspec" as well...
334 feature.nrdevs = nrdevs;
336 printf("Loading features into shared memory\n");
337 if (lseek(memfd, CDK_FEATADDR, SEEK_SET) != CDK_FEATADDR) {
338 warn("lseek(%x) failed on memory device", CDK_FEATADDR);
341 if (write(memfd, &feature, sizeof(cdkfeature_t)) < 0) {
342 warn("write to memory device failed");
347 * Wait for board alive marker to be set. The slave image will set the
348 * byte at address CDK_RDYADDR to 0x13 after it has successfully started.
349 * If this doesn't happen we timeout and fail.
352 printf("Setting alive marker to 0\n");
353 if (lseek(memfd, CDK_RDYADDR, SEEK_SET) != CDK_RDYADDR) {
354 warn("lseek(%x) failed on memory device", CDK_RDYADDR);
358 if (write(memfd, &alivemarker, 1) < 0) {
359 warn("write to memory device failed");
364 * At this point the entire image is loaded into shared memory. To start
365 * it executiong we poke the board with an interrupt.
368 printf("Interrupting board to start slave image\n");
369 if (ioctl(memfd, STL_BINTR, 0) < 0) {
370 warn("ioctl(STL_BINTR) failed");
374 strttime = time((time_t *) NULL);
376 printf("Waiting for slave alive marker, time=%x timeout=%d\n",
378 while (time((time_t *) NULL) < (strttime + TIMEOUT)) {
379 if (lseek(memfd, CDK_RDYADDR, SEEK_SET) != CDK_RDYADDR) {
380 warn("lseek(%x) failed on memory device", CDK_RDYADDR);
383 if (read(memfd, &alivemarker, 1) < 0){
384 warn("read of image file failed");
387 if (alivemarker == CDK_ALIVEMARKER)
391 if (alivemarker != CDK_ALIVEMARKER) {
392 warnx("slave image failed to start");
396 if (lseek(memfd, CDK_RDYADDR, SEEK_SET) != CDK_RDYADDR) {
397 warn("lseek(%x) failed on memory device", CDK_RDYADDR);
401 if (write(memfd, &alivemarker, 1) < 0) {
402 warn("write to memory device failed");
407 printf("Slave image started successfully\n");
410 * The last thing to do now is to get the driver started. Now that the
411 * slave is operational it must read in the memory map and gets its
412 * internal tables initialized.
415 printf("Driver initializing host shared memory interface\n");
416 if (ioctl(memfd, STL_BSTART, 0) < 0) {
417 warn("ioctl(STL_BSTART) failed");
425 /*****************************************************************************/
427 int main(int argc, char *argv[])
429 struct stat statinfo;
432 while ((c = getopt(argc, argv, "hvVRB:i:b:c:t:r:")) != -1) {
435 printf("stlload version %s\n", version);
439 feature.banner = atol(optarg);
454 brdnr = atoi(optarg);
460 feature.txrqsize = atol(optarg);
463 feature.rxrqsize = atol(optarg);
472 if (memdevice == (char *) NULL) {
473 if ((brdnr < 0) || (brdnr >= 8))
474 errx(1, "invalid board number %d specified", brdnr);
475 sprintf(devstr, defdevice, brdnr);
476 memdevice = &devstr[0];
478 printf("Using shared memory device %s\n", memdevice);
482 printf("Downloading image %s to board %d\n", image, brdnr);
485 * Check that the shared memory device exits and is a character device.
487 if (stat(memdevice, &statinfo) < 0)
488 errx(1, "memory device %s does not exist", memdevice);
489 if ((statinfo.st_mode & S_IFMT) != S_IFCHR)
490 errx(1, "memory device %s is not a char device", memdevice);
492 if (stat(image, &statinfo) < 0)
493 errx(1, "image file %s does not exist", image);
496 * All argument checking is now done. So lets get this show on the road.
503 /*****************************************************************************/