/*	$NetBSD: mon.h,v 1.5 2008/04/28 20:23:38 martin Exp $	*/

/*-
 * Copyright (c) 1996 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Adam Glass.
 *
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``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 FOUNDATION OR CONTRIBUTORS
 * 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.
 */

/*
 * This file derived from kernel/mach/sun3.md/machMon.h from the
 * sprite distribution.
 *
 * In particular, this file came out of the Walnut Creek cdrom collection
 * which contained no warnings about any possible copyright infringement.
 * It was also indentical to a file in the sprite kernel tar file found on
 * allspice.berkeley.edu.
 * It also written in the annoying sprite coding style.  I've made
 * efforts not to heavily edit their file, just ifdef parts out. -- glass
 */

#ifndef _MACHINE_MON_H
#define _MACHINE_MON_H

/*
 * machMon.h --
 *
 *     Structures, constants and defines for access to the sun monitor.
 *     These are translated from the sun monitor header file "sunromvec.h".
 *
 * NOTE: The file keyboard.h in the monitor directory has all sorts of useful
 *       keyboard stuff defined.  I haven't attempted to translate that file
 *       because I don't need it.  If anyone wants to use it, be my guest.
 *
 * Copyright (C) 1985 Regents of the University of California
 * All rights reserved.
 *
 *
 * Header: /sprite/src/kernel/mach/sun3.md/RCS/machMon.h,v 9.1
 *         90/10/03 13:52:34 mgbaker Exp SPRITE (Berkeley)
 */

/*
 * Structure set up by the boot command to pass arguments to the program that
 * is booted.
 */
struct bootparam {
	char		*argPtr[8];	/* String arguments */
	char		strings[100];	/* String table for string arguments */
	char		devName[2];	/* Device name */
	int		ctlrNum;	/* Controller number */
	int		unitNum;	/* Unit number */
	int		partNum;	/* Partition/file number */
	char		*fileName;	/* File name, points into strings */
	struct boottab	*bootDevice;	/* Defined in saio.h */
} __attribute__((packed));

/*
 * This structure defines a segment of physical memory. To support
 * sparse physical memory, the PROM constructs a linked list of
 * these at power-on-self-test time.
 */
struct physmemory {
	u_int address;
	u_int size;
	struct physmemory *next;
};

/*
 * Here is the structure of the vector table found at the front of the boot
 * rom.  The functions defined in here are explained below.
 *
 * NOTE: This struct has references to the structures keybuf and globram which
 *       I have not translated.  If anyone needs to use these they should
 *       translate these structs into Sprite format.
 */
struct sunromvec {
	char	*init_SP;		/* Initial SP for hardware */
	char	*init_PC;		/* Initial PC for hardware */
	int	*diagberr;		/* Bus err handler for diags */

	/*
	 * Monitor and hardware revision and identification
	 */

	struct bootparam **bootParam;	/* Info for bootstrapped pgm */
	u_int	*memorySize;		/* Usable memory in bytes */

	/*
	 * Single-character input and output
	 */

	u_char	(*getChar)(void);	/* Get char from input source */
	int	(*putChar)(int);	/* Put char to output sink */
	int	(*mayGet)(void);	/* Maybe get char, or -1 */
	int	(*mayPut)(int);	/* Maybe put char, or -1 */
	u_char	*echo;		/* Should getchar echo? */
	u_char	*inSource;	/* Input source selector */
	u_char	*outSink;	/* Output sink selector */
#define	PROMDEV_KBD	0		/* input from keyboard */
#define	PROMDEV_SCREEN	0		/* output to screen */
#define	PROMDEV_TTYA	1		/* in/out to ttya */
#define	PROMDEV_TTYB	2		/* in/out to ttyb */

	/*
	 * Keyboard input (scanned by monitor nmi routine)
	 */

	int	(*getKey)(void);	/* Get next key if one exists */
	int	(*initGetKey)(void *); /* Initialize get key */
	u_int	*translation;		/* Kbd translation selector
					   (see keyboard.h in sun
					    monitor code) */
	u_char	*keyBid;		/* Keyboard ID byte */
	int	*screen_x;		/* V2: Screen x pos (R/O) */
	int	*screen_y;		/* V2: Screen y pos (R/O) */
	struct keybuf	*keyBuf;	/* Up/down keycode buffer */

	/*
	 * Monitor revision level.
	 */

	char		*monId;

	/*
	 * Frame buffer output and terminal emulation
	 */

	int	(*fbWriteChar)(int); /* Write a character to FB */
	int	*fbAddr;		/* Address of frame buffer */
	char	**font;			/* Font table for FB */
	/* Quickly write string to FB */
	int	(*fbWriteStr)(char *, int);

	/*
	 * Reboot interface routine -- resets and reboots system.  No return.
	 */

	int	(*reBoot)(const char *);	/* e.g. reBoot("xy()vmunix") */

	/*
	 * Line input and parsing
	 */

	u_char	*lineBuf;	/* The line input buffer */
	u_char	**linePtr;	/* Cur pointer into linebuf */
	int		*lineSize;	/* length of line in linebuf */
	int	(*getLine)(int);	/* Get line from user */
	u_char	(*getNextChar)(void); /* Get next char from linebuf */
	u_char	(*peekNextChar)(void);	/* Peek at next char */
	int		*fbThere;		/* =1 if frame buffer there */
	int		(*getNum)(void);	/* Grab hex num from line */

	/*
	 * Print formatted output to current output sink
	 */

	int	(*printf)(const char *, ...);	/* Like kernel printf */
	int	(*printHex)(int, int);	/* Format N digits in hex */

	/*
	 * Led stuff
	 */

	u_char	*leds;			/* RAM copy of LED register */
	int	(*setLeds)(int);	/* Sets LED's and RAM copy */

	/*
	 * Non-maskable interrupt  (nmi) information
	 */

	int	(*nmiAddr)(void *);	/* Addr for level 7 vector */
	int	(*abortEntry)(void *); /* Entry for keyboard abort */
	int	*nmiClock;		/* Counts up in msec */

	/*
	 * Frame buffer type: see <sun/fbio.h>
	 */

	int		*fbType;

	/*
	 * Assorted other things
	 */

	u_int	romvecVersion;		/* Version # of Romvec */
	struct globram  *globRam;	/* monitor global variables */
	void	*kbdZscc;		/* Addr of keyboard in use */

	int	*keyrInit;		/* ms before kbd repeat */
	u_char	*keyrTick; 		/* ms between repetitions */
	u_int	*memoryAvail;		/* V1: Main mem usable size */
	long	*resetAddr;		/* where to jump on a reset */
	long	*resetMap;		/* pgmap entry for resetaddr */
					/* Really struct pgmapent *  */
	int	(*exitToMon)(void); /* Exit from user program */
	u_char	**memorybitmap;		/* V1: &{0 or &bits} */

	/****************************************************************
	 * Note: from here on, things vary per-architecture!
	 ****************************************************************/
	union {
		void *un_pad[8]; /* this determines the size */
		struct {
			/* Set seg in all contexts (ctx, va, sme) */
			void	(*un3_setcxsegmap)(int, int, int);
			/* V2: Handler for 'v' cmd */
			void	(**un3_vector_cmd)(int, char *);
		} un3;
		struct {
			/* V2: Handler for 'v' cmd */
			void	(**un3x_vector_cmd)(int, char *);
			/* Address of low memory PTEs (maps at least 4MB) */
			int	**un3x_lomemptaddr;
			/*
			 * Address of debug/mon PTEs which map the 2MB space
			 * starting at MON_KDB_BASE, ending at MONEND.
			 */
			int	**un3x_monptaddr;
			/*
			 * Address of dvma PTEs.  This is a VA that maps the I/O MMU
			 * page table, but only the last part, which corresponds to
			 * the CPU virtual space at MON_DVMA_BASE (see below).
			 */
			int	**un3x_dvmaptaddr;
			/*
			 * Physical Address of the debug/mon PTEs found at the
			 * virtual address given by *romVectorPtr->monptaddr;
			 */
			int	**un3x_monptphysaddr;
			/*
			 * Address of shadow copy of DVMA PTEs.  This is a VA that
			 * maps the PTEs used by the CPU to map the same physical
			 * pages as the I/O MMU into the CPU virtual space starting
			 * at MON_DVMA_BASE, length MON_DVMA_SIZE (see below).
			 */
			int	**un3x_shadowpteaddr;
			/* Ptr to memory list for 3/80 */
			struct physmemory *un3x_physmemory;
		} un3x;
	} mon_un;
} __attribute__((packed));

/*
 * Functions defined in the vector:
 *
 *
 * getChar -- Return the next character from the input source
 *
 *     u_char getChar()
 *
 * putChar -- Write the given character to the output source.
 *
 *     void putChar(ch)
 *	   char ch;	
 *
 * mayGet -- Maybe get a character from the current input source.  Return -1
 *           if don't return a character.
 *
 * 	int mayGet()
 *	
 * mayPut -- Maybe put a character to the current output source.   Return -1
 *           if no character output.
 *
 *	int  mayPut(ch)
 *	    char ch;
 *
 * getKey -- Returns a key code (if up/down codes being returned),
 * 	     a byte of ASCII (if that's requested),
 * 	     NOKEY (if no key has been hit).
 *
 *	int getKey()
 *	
 * initGetKey --  Initialize things for get key.
 *
 *	void initGetKey()
 *
 * fbWriteChar -- Write a character to the frame buffer
 *
 *	void fwritechar(ch)
 *	    u_char ch;
 *
 * fbWriteStr -- Write a string to the frame buffer.
 *
 *   	void fwritestr(addr,len)
 *  	    u_char *addr;	/ * String to be written * /
 *  	    short len;		/ * Length of string * /
 *
 * getLine -- read the next input line into a global buffer
 *
 *	getline(echop)
 *          int echop;	/ * 1 if should echo input, 0 if not * /
 *
 * getNextChar -- return the next character from the global line buffer.
 *
 *	u_char getNextChar()
 *
 * peekNextChar -- look at the next character in the global line buffer.
 *
 *	u_char peekNextChar()
 *
 * getNum -- Grab hex num from the global line buffer.
 *
 *	int getNum()
 *
 * printf -- Scaled down version of C library printf.  Only %d, %x, %s, and %c
 * 	     are recognized.
 *
 * printhex -- prints rightmost <digs> hex digits of <val>
 *
 *      printhex(val, digs)
 *          int val;
 *     	    int digs;
 *
 * abortEntry -- Entry for keyboard abort.
 *
 *     abortEntry()
 */

/*
 * Functions and defines to access the monitor.
 */

#define mon_printf (romVectorPtr->printf)
#define mon_putchar (romVectorPtr->putChar)
#define mon_may_getchar (romVectorPtr->mayGet)
#define mon_exit_to_mon (romVectorPtr->exitToMon)
#define mon_reboot (romVectorPtr->reBoot)

/*
 * Sun2 specific stuff...
 */

/*
 * MONSTART and MONEND denote the range used by the monitor.
 * PROM_BASE is the virtual address of the PROM.
 */
#define SUN2_MONSTART		0x00E00000
#define SUN2_PROM_BASE		0x00EF0000
#define SUN2_MONEND		0x00F00000

/*
 * Sun3 specific stuff...
 */

#ifdef	_SUN3_
#define setcxsegmap 	mon_un.un3.un3_setcxsegmap
#define vector_cmd  	mon_un.un3.un3_vector_cmd
#define	romVectorPtr	((struct sunromvec *) SUN3_PROM_BASE)
#endif	/* SUN3 */

/*
 * MONSTART and MONEND denote the range used by the monitor.
 * PROM_BASE is the virtual address of the PROM.
 */
#define SUN3_MONSTART		0x0FE00000
#define SUN3_PROM_BASE		0x0FEF0000
#define SUN3_MONEND		0x0FF00000

/*
 * These describe the monitor's short segment (one it can reach using
 * short PC-relative addressing) which it uses to map its data page.
 * MONSHORTPAGE is the page; MONSHORTSEG is the containing segment.
 * Its mapping must not be removed or the PROM monitor will fail.
 * MONSHORTPAGE is also where the "ie" puts its SCP.
 */
#define SUN3_MONSHORTPAGE	0x0FFFE000
#define SUN3_MONSHORTSEG	0x0FFE0000

/*
 * Sun3X specific stuff...
 */

#ifdef	_SUN3X_
#define vector_cmd  	mon_un.un3x.un3x_vector_cmd
#define lomemptaddr 	mon_un.un3x.un3x_lomemptaddr
#define monptaddr   	mon_un.un3x.un3x_monptaddr
#define dvmaptaddr  	mon_un.un3x.un3x_dvmaptaddr
#define monptphysaddr	mon_un.un3x.un3x_monptphysaddr
#define shadowpteaddr	mon_un.un3x.un3x_shadowpteaddr
#define v_physmemory	mon_un.un3x.un3x_physmemory
#define	romVectorPtr	((struct sunromvec *) SUN3X_PROM_BASE)
#endif	/* SUN3X */

/*
 * We don't have a separate kernel debugger like sun kadb,
 * but this range is setup by the monitor for such a thing.
 * We might as well preserve the mappings anyway.
 */
#define SUN3X_MON_KDB_BASE	0xFEE00000
#define	SUN3X_MON_KDB_SIZE	  0x100000

/*
 * MONSTART and MONEND define the range used by the monitor.
 * MONDATA is its data page (do not touch!)
 * PROM_BASE is where the boot PROM lives.
 */
#define SUN3X_MONSTART    	0xFEF00000
#define SUN3X_MONDATA     	0xFEF72000
#define SUN3X_PROM_BASE   	0xFEFE0000
#define SUN3X_MONEND      	0xFF000000

/*
 * These define the CPU virtual address range mapped by the
 * PROM for use as DVMA space.  The physical pages mapped in
 * this range are also mapped by the I/O MMU.  Note that the
 * last page is reserved for the PROM (really for the "ie").
 */
#define SUN3X_MON_DVMA_BASE	0xFFF00000
#define SUN3X_MON_DVMA_SIZE	  0x100000	/* 1MB */

#ifdef	_STANDALONE
/* The libsa code uses a pointer... */
extern struct sunromvec *_romvec;
#undef	romVectorPtr
#define	romVectorPtr	_romvec
#endif	/* _STANDALONE */

#endif	/* _MACHINE_MON_H */