xref: /src/sys/arch/atari/stand/tostools/loadbsd/loadbsd.c

/*	$NetBSD: loadbsd.c,v 1.16 2001/09/27 14:29:22 leo Exp $	*/

/*
 * Copyright (c) 1995 L. Weppelman
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by Leo Weppelman.
 * 4. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * NetBSD loader for the Atari-TT.
 */

#include "exec_elf.h"
#include <a_out.h>
#include <fcntl.h>
#include <stdio.h>
#include <osbind.h>
#include <stdarg.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include "libtos.h"
#include "loader.h"

#ifdef COMPRESSED_READ
#define	open	copen
#define	read	cread
#define	lseek	clseek
#define	close	cclose
#endif /* COMPRESSED_READ */

char	*Progname;		/* How are we called		*/
int	d_flag  = 0;		/* Output debugging output?	*/
int	h_flag  = 0;		/* show help			*/
int	N_flag  = 0;		/* No symbols?			*/
int	s_flag  = 0;		/* St-ram only			*/
int	t_flag  = 0;		/* Just test, do not execute	*/
int	v_flag  = 0;		/* show version			*/

const char version[] = "$Revision: 1.16 $";

/*
 * Default name of kernel to boot, large enough to patch
 */
char	kname[80] = "n:/netbsd";

static struct kparamb kparam;

void help  PROTO((void));
void usage PROTO((void));
int  aout_load PROTO((int));
int  elf_load PROTO((int));
void get_sys_info PROTO((void));
void start_kernel PROTO((void));

#define ELFMAGIC	((ELFMAG0 << 24) | (ELFMAG1 << 16) | \
				(ELFMAG2 << 8) | ELFMAG3)
int
main(argc, argv)
int	argc;
char	**argv;
{
	/*
	 * Option parsing
	 */
	extern	int	optind;
	extern	char	*optarg;
	int		ch;
	int		fd;

	init_toslib(argv[0]);
	Progname = argv[0];

	kparam.boothowto = RB_SINGLE;

	while ((ch = getopt(argc, argv, "abdDhNstVwo:S:T:")) != -1) {
		switch (ch) {
		case 'a':
			kparam.boothowto &= ~(RB_SINGLE);
			kparam.boothowto |= RB_AUTOBOOT;
			break;
		case 'b':
			kparam.boothowto |= RB_ASKNAME;
			break;
		case 'd':
			kparam.boothowto |= RB_KDB;
			break;
		case 'D':
			d_flag = 1;
			break;
		case 'h':
			h_flag = 1;
			break;
		case 'N':
			N_flag = 1;
			break;
		case 'o':
			redirect_output(optarg);
			break;
		case 's':
			s_flag = 1;
			break;
		case 'S':
			kparam.stmem_size = atoi(optarg);
			break;
		case 't':
			t_flag = 1;
			break;
		case 'T':
			kparam.ttmem_size = atoi(optarg);
			break;
		case 'V':
			v_flag = 1;
			break;
		case 'w':
			set_wait_for_key();
			break;
		default:
			usage();
		}
	}
	argc -= optind;
	argv += optind;
	if (argc == 1)
		strcpy(kname, argv[0]);

	if (h_flag)
		help();
	if (v_flag)
		eprintf("%s\r\n", version);

	/*
	 * Get system info to pass to NetBSD
	 */
	get_sys_info();

	/*
	 * Find the kernel to boot and read it's exec-header
	 */
	if ((fd = open(kname, O_RDONLY)) < 0)
		fatal(-1, "Cannot open kernel '%s'", kname);
	if (elf_load(fd) == 0)
		if (aout_load(fd) == 0)
			fatal(-1, "Not an ELF or NMAGIC file '%s'", kname);
	close(fd);

	if (d_flag) {
	    eprintf("\r\nKernel info:\r\n");
	    eprintf("Kernel loadaddr\t: 0x%08x\r\n", kparam.kp);
	    eprintf("Kernel size\t: %10d bytes\r\n", kparam.ksize);
	    eprintf("Kernel entry\t: 0x%08x\r\n", kparam.entry);
	    eprintf("Kernel esym\t: 0x%08x\r\n", kparam.esym_loc);
	}

	if (!t_flag)
		start_kernel();
		/* NOT REACHED */

	eprintf("Kernel '%s' was loaded OK\r\n", kname);
	xexit(0);
	return 0;
}

int
aout_load(fd)
int				fd;
{
	long		textsz, stringsz;
	struct exec	ehdr;

	lseek(fd, (off_t)0, SEEK_SET);
	if (read(fd, (char *)&ehdr, sizeof(ehdr)) != sizeof(ehdr))
		return 0;

	if (N_MAGIC(ehdr) != NMAGIC)
		return 0;

	/*
	 * Extract various sizes from the kernel executable
	 */
	textsz          = (ehdr.a_text + __LDPGSZ - 1) & ~(__LDPGSZ - 1);
	kparam.esym_loc = 0;
	kparam.ksize    = textsz + ehdr.a_data + ehdr.a_bss;
	kparam.entry    = ehdr.a_entry;

	if (!N_flag && ehdr.a_syms) {
	  if (lseek(fd,ehdr.a_text+ehdr.a_data+ehdr.a_syms+sizeof(ehdr),0)
									<= 0)
		fatal(-1, "Cannot seek to string table in '%s'", kname);
	  if (read(fd, (char *)&stringsz, sizeof(long)) != sizeof(long))
		fatal(-1, "Cannot read string-table size");
	  if (lseek(fd, sizeof(ehdr), 0) <= 0)
		fatal(-1, "Cannot seek back to text start");
	  kparam.ksize += ehdr.a_syms + sizeof(long) + stringsz;
	}

	if ((kparam.kp = (u_char *)malloc(kparam.ksize)) == NULL)
		fatal(-1, "Cannot malloc kernel image space");

	/*
	 * Read text & data, clear bss
	 */
	if ((read(fd, (char *)kparam.kp, ehdr.a_text) != ehdr.a_text)
	    ||(read(fd,(char *)(kparam.kp+textsz),ehdr.a_data) != ehdr.a_data))
		fatal(-1, "Unable to read kernel image\n");
	memset(kparam.kp + textsz + ehdr.a_data, 0, ehdr.a_bss);

	/*
	 * Read symbol and string table
	 */
	if (!N_flag && ehdr.a_syms) {
	    long	*p;

	    p = (long *)(kparam.kp + textsz + ehdr.a_data + ehdr.a_bss);
	    *p++ = ehdr.a_syms;
	    if (read(fd, (char *)p, ehdr.a_syms) != ehdr.a_syms)
		fatal(-1, "Cannot read symbol table\n");
	    p = (long *)((char *)p + ehdr.a_syms);
	    if (read(fd, (char *)p, stringsz) != stringsz)
		fatal(-1, "Cannot read string table\n");
	    kparam.esym_loc = (long)((char *)p-(char *)kparam.kp +stringsz);
	}

	return 1;
}

int
elf_load(fd)
int				fd;
{
	int		i,j;
	Elf32_Ehdr	ehdr;
	Elf32_Phdr	*phdrs;
	Elf32_Word	symsize, symstart;
	long		kernsize;

	lseek(fd, (off_t)0, SEEK_SET);
	if (read(fd, (char *)&ehdr, sizeof(ehdr)) != sizeof(ehdr))
		return 0;

	if (*((u_int *)ehdr.e_ident) != ELFMAGIC)
		return 0;

	/*
	 * calculate highest used address
	 */
	i = ehdr.e_phnum * sizeof(Elf32_Phdr);
	if ((phdrs = (Elf32_Phdr *)malloc(i)) == NULL)
		fatal(-1, "Cannot malloc Elf phdr storage space");
	if (read(fd, phdrs, i) != i)
		fatal(-1, "Cannot read Elf32_Phdrs");

	kernsize = 0;
	for (i = 0; i < ehdr.e_phnum; i++) {
		Elf32_Word sum;

		sum = phdrs[i].p_vaddr + phdrs[i].p_memsz;
		if ((phdrs[i].p_flags & (PF_W|PF_X)) && (sum > kernsize))
			kernsize = sum;
	}

	/*
	 * look for symbols and calculate the size
	 * XXX: This increases the load time by a factor 2 for gzipped
	 *      images!
	 */
	symsize  = 0;
	symstart = 0;
	if (!N_flag) {
	    i = ehdr.e_shnum + 1;
	    if (lseek(fd, (off_t)ehdr.e_shoff, SEEK_SET) != ehdr.e_shoff)
		fatal(-1, "Cannot seek to e_shoff location");
	    while (--i) {
	      Elf32_Shdr shdr;

	      if (read(fd, &shdr, sizeof(shdr)) != sizeof(shdr))
		fatal(-1, "Cannot read Elf32_shdr");
	      if ((shdr.sh_type == SHT_SYMTAB) || (shdr.sh_type == SHT_STRTAB))
		symsize += shdr.sh_size;
	    }
	}

	if (symsize) {
	  symstart = kernsize;
	  kernsize += symsize + sizeof(ehdr) + ehdr.e_shnum*sizeof(Elf32_Shdr);
	}

	/*
	 * Extract various sizes from the kernel executable
	 */
	kparam.esym_loc = symsize ? kernsize : 0;
	kparam.ksize    = kernsize;
	kparam.entry    = ehdr.e_entry;

	if ((kparam.kp = (u_char *)malloc(kparam.ksize)) == NULL)
		fatal(-1, "Cannot malloc kernel image space");

	/*
	 * Read text & data, clear bss
	 */
	for (i = 0; i < ehdr.e_phnum; i++) {
	    u_char	*p;
	    Elf32_Phdr	*php = &phdrs[i];

	    if (php->p_flags & (PF_W|PF_X)) {
		if (lseek(fd, (off_t)php->p_offset, SEEK_SET) != php->p_offset)
		    fatal(-1, "Seek error while reading text segment\n");
		p = (u_char *)(kparam.kp) + php->p_vaddr;
		if (read(fd, p, php->p_filesz) != php->p_filesz)
		    fatal(-1, "Read error in text segment\n");
		if (php->p_memsz > php->p_filesz)
		    memset(p + php->p_filesz, 0, php->p_memsz - php->p_filesz);
	    }
	}

	/*
	 * Read symbols and strings
	 */
	if (symsize) {
	    u_char	*p, *symtab;
	    int		nhdrs;
	    Elf32_Shdr	*shp;

	    symtab = kparam.kp + symstart;

	    p = symtab + sizeof(ehdr);
	    nhdrs = ehdr.e_shnum;
	    if (lseek(fd, (off_t)ehdr.e_shoff, SEEK_SET) != ehdr.e_shoff)
		fatal(-1, "Error seeking to section headers");
	    if (read(fd, p, nhdrs * sizeof(*shp)) != nhdrs * sizeof(*shp))
		fatal(-1, "Error reading section headers");
	    shp = (Elf32_Shdr*)p;
	    p  += nhdrs * sizeof(*shp);
	    for (i = 0; i < nhdrs; i++) {
		if (shp[i].sh_type == SHT_SYMTAB) {
		    if (shp[i].sh_offset == 0)
			continue;
		    /* Got the symbol table. */
		    if (lseek(fd, (off_t)shp[i].sh_offset, SEEK_SET) !=
							shp[i].sh_offset)
		    	fatal(-1, "Error seeking to symbols");
		    if (read(fd, p, shp[i].sh_size) != shp[i].sh_size)
			fatal(-1, "Error reading symbols");
		    shp[i].sh_offset = p - symtab;
		    /* Find the string table to go with it. */
		    j = shp[i].sh_link;
		    if (shp[j].sh_offset == 0)
			continue;
		    p += shp[i].sh_size;
		    if (lseek(fd, (off_t)shp[j].sh_offset, SEEK_SET) !=
				    			shp[j].sh_offset)
		    	fatal(-1, "Error seeking to string table");
		    if (read(fd, p, shp[j].sh_size) != shp[j].sh_size)
			fatal(-1, "Error reading strings");
		    shp[j].sh_offset = p - symtab;
		    /* There should only be one symbol table. */
		    break;
		}
	    }
	    ehdr.e_shoff = sizeof(ehdr);
	    bcopy(&ehdr, symtab, sizeof(ehdr));
	}
	return 1;
}

/*
 * Extract memory and cpu/fpu info from system.
 */
void
get_sys_info()
{
	long	stck;
	long	*jar;
	OSH	*oshdr;

	kparam.bootflags = 0;

	stck = Super(0);

	/*
	 * Some GEMDOS versions use a different year-base in the RTC.
	 */
	oshdr = *ADDR_OSHEAD;
	oshdr = oshdr->os_beg;
	if ((oshdr->os_version > 0x0300) && (oshdr->os_version < 0x0306))
		kparam.bootflags |= ATARI_CLKBROKEN;

	if (kparam.stmem_size <= 0)
		kparam.stmem_size  = *ADDR_PHYSTOP;

	if (kparam.ttmem_size)
		kparam.ttmem_start  = TTRAM_BASE;
	else {
		if (!s_flag && (*ADDR_CHKRAMTOP == RAM_TOP_MAGIC)) {
			kparam.ttmem_size  = *ADDR_RAMTOP;
			if (kparam.ttmem_size > TTRAM_BASE) {
				kparam.ttmem_size  -= TTRAM_BASE;
				kparam.ttmem_start  = TTRAM_BASE;
			}
			else kparam.ttmem_size = 0;
		}
	}

	/*
	 * Scan cookiejar for cpu types
	 */
	jar = *ADDR_P_COOKIE;
	if (jar != NULL) {
		do {
		    if (jar[0] == 0x5f435055) { /* _CPU	*/
			switch (jar[1]) {
				case 0:
					kparam.bootflags |= ATARI_68000;
					break;
				case 10:
					kparam.bootflags |= ATARI_68010;
					break;
				case 20:
					kparam.bootflags |= ATARI_68020;
					break;
				case 30:
					kparam.bootflags |= ATARI_68030;
					break;
				case 40:
					kparam.bootflags |= ATARI_68040;
					break;
				case 60:
					kparam.bootflags |= ATARI_68060;
					break;
				default:
					fatal(-1, "Unknown CPU-type");
			}
		    }
		    if (jar[0] == 0x42504658) { /* BPFX	*/
			unsigned long	*p;

			p = (unsigned long*)jar[1];

			kparam.ttmem_start = p[1];
			kparam.ttmem_size  = p[2];
		    }
		    if (jar[0] == 0x5f435432) { /* _CT2	*/
			/*
			 * The CT2 board has a different physical base address!
			 */
			kparam.ttmem_start = CTRAM_BASE;
		    }
		    jar = &jar[2];
		} while (jar[-2]);
	}
	if (!(kparam.bootflags & ATARI_ANYCPU))
		fatal(-1, "Cannot determine CPU-type");

	(void)Super(stck);

	if (d_flag) {
	    eprintf("Machine info:\r\n");
	    eprintf("ST-RAM size\t: %10d bytes\r\n",kparam.stmem_size);
	    eprintf("TT-RAM size\t: %10d bytes\r\n",kparam.ttmem_size);
	    eprintf("TT-RAM start\t: 0x%08x\r\n", kparam.ttmem_start);
	    eprintf("Cpu-type\t: 0x%08x\r\n", kparam.bootflags);
	}
}

void
help()
{
	eprintf("\r
NetBSD loader for the Atari-TT\r
\r
Usage: %s [-abdhstVD] [-S <stram-size>] [-T <ttram-size>] [kernel]\r
\r
Description of options:\r
\r
\t-a  Boot up to multi-user mode.\r
\t-b  Ask for root device to use.\r
\t-d  Enter kernel debugger.\r
\t-D  printout debug information while loading\r
\t-h  What you're getting right now.\r
`t-N  No symbols must be loaded.\r
\t-o  Write output to both <output file> and stdout.\r
\t-s  Use only ST-compatible RAM\r
\t-S  Set amount of ST-compatible RAM\r
\t-T  Set amount of TT-compatible RAM\r
\t-t  Test the loader. It will do everything except executing the\r
\t    loaded kernel.\r
\t-V  Print loader version.\r
\t-w  Wait for a keypress before exiting.\r
", Progname);
	xexit(0);
}

void
usage()
{
	eprintf("Usage: %s [-abdhstVD] [-S <stram-size>] "
		"[-T <ttram-size>] [kernel]\r\n", Progname);
	xexit(1);
}

void
start_kernel()
{
	long	stck;

	stck = Super(0);
	bsd_startup(&kparam);
	/* NOT REACHED */

	(void)Super(stck);
}