sys/arch/pmax/include/dec_prom.h

   1 /*      $NetBSD: dec_prom.h,v 1.21 2009/03/14 14:46:04 dsl Exp $        */
   2
   3 /*
   4  * Copyright (c) 1992, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * Ralph Campbell.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  *      @(#)dec_prom.h  8.1 (Berkeley) 6/10/93
  35  *
  36  * machMon.h --
  37  *
  38  *      Structures, constants and defines for access to the pmax prom.
  39  *
  40  *      Copyright (C) 1989 Digital Equipment Corporation.
  41  *      Permission to use, copy, modify, and distribute this software and
  42  *      its documentation for any purpose and without fee is hereby granted,
  43  *      provided that the above copyright notice appears in all copies.
  44  *      Digital Equipment Corporation makes no representations about the
  45  *      suitability of this software for any purpose.  It is provided "as is"
  46  *      without express or implied warranty.
  47  *
  48  * from: Header: /sprite/src/kernel/mach/ds3100.md/RCS/machMon.h,
  49  *      v 9.3 90/02/20 14:34:07 shirriff Exp  SPRITE (Berkeley)
  50  */
  51
  52 #ifndef _PMAX_DEC_PROM_H_
  53 #define _PMAX_DEC_PROM_H_
  54
  55 /*
  56  * This file was created based on information from the document
  57  * "TURBOchannel Firmware Specification" (EK-TCAAD-FS-003)
  58  * by Digital Equipment Corporation.
  59  */
  60
  61 #ifndef _LOCORE
  62 #include <sys/types.h>
  63 #include <sys/cdefs.h>
  64
  65 /*
  66  * Programs loaded by the new PROMs pass the following arguments:
  67  *      a0      argc
  68  *      a1      argv
  69  *      a2      DEC_PROM_MAGIC
  70  *      a3      The callback vector defined below
  71  */
  72
  73 #define DEC_PROM_MAGIC  0x30464354
  74
  75 typedef struct memmap {
  76         int     pagesize;       /* system page size */
  77         u_char  bitmap[15360];  /* bit for each page indicating safe to use */
  78 } memmap;
  79
  80 typedef struct {
  81         int     revision;       /* hardware revision level */
  82         int     clk_period;     /* clock period in nano seconds */
  83         int     slot_size;      /* slot size in magabytes */
  84         int     io_timeout;     /* I/O timeout in cycles */
  85         int     dma_range;      /* DMA address range in megabytes */
  86         int     max_dma_burst;  /* maximum DMA burst length */
  87         int     parity;         /* true if system module supports T.C. parity */
  88         int     reserved[4];
  89 } tcinfo;
  90
  91 typedef int jmp_buf[12];
  92 typedef void (*psig_t)(int);
  93
  94 struct callback {
  95         void    *(*_memcpy)(void *, void *, int);               /* 00 */
  96         void    *(*_memset)(void *, int, int);                  /* 04 */
  97         char    *(*_strcat)(char *, char *);                    /* 08 */
  98         int     (*_strcmp)(char *, char *);                     /* 0c */
  99         char    *(*_strcpy)(char *, char *);                    /* 10 */
 100         int     (*_strlen)(char *);                             /* 14 */
 101         char    *(*_strncat)(char *, char *, int);              /* 18 */
 102         char    *(*_strncpy)(char *, char *, int);              /* 1c */
 103         int     (*_strncmp)(char *, char *, int);               /* 20 */
 104         int     (*_getchar)(void);                              /* 24 */
 105         char    *(*_gets)(char *);                              /* 28 */
 106         int     (*_puts)(char *);                               /* 2c */
 107         int     (*_printf)(const char *, ...);                  /* 30 */
 108         int     (*_sprintf)(char *, char *, ...);               /* 34 */
 109         int     (*_io_poll)(void);                              /* 38 */
 110         long    (*_strtol)(char *, char **, int);               /* 3c */
 111         psig_t  (*_signal)(int, psig_t);                        /* 40 */
 112         int     (*_raise)(int);                                 /* 44 */
 113         long    (*_time)(long *);                               /* 48 */
 114         int     (*_setjmp)(jmp_buf);                            /* 4c */
 115         void    (*_longjmp)(jmp_buf, int);                      /* 50 */
 116         int     (*_bootinit)(char *);                           /* 54 */
 117         int     (*_bootread)(int, void *, int);                 /* 58 */
 118         int     (*_bootwrite)(int, void *, int);                /* 5c */
 119         int     (*_setenv)(char *, char *);                     /* 60 */
 120         char    *(*_getenv)(const char *);                      /* 64 */
 121         int     (*_unsetenv)(char *);                           /* 68 */
 122         u_long  (*_slot_address)(int);                          /* 6c */
 123         void    (*_wbflush)(void);                              /* 70 */
 124         void    (*_msdelay)(int);                               /* 74 */
 125         void    (*_leds)(int);                                  /* 78 */
 126         void    (*_clear_cache)(char *, int);                   /* 7c */
 127         int     (*_getsysid)(void);                             /* 80 */
 128         int     (*_getbitmap)(memmap *);                        /* 84 */
 129         int     (*_disableintr)(int);                           /* 88 */
 130         int     (*_enableintr)(int);                            /* 8c */
 131         int     (*_testintr)(int);                              /* 90 */
 132         void    *_reserved_data;                                /* 94 */
 133         int     (*_console_init)(void);                         /* 98 */
 134         void    (*_halt)(int *, int);                           /* 9c */
 135         void    (*_showfault)(void);                            /* a0 */
 136         tcinfo  *(*_gettcinfo)(void);    /* XXX bogus proto */  /* a4 */
 137         int     (*_execute_cmd)(char *);                        /* a8 */
 138         void    (*_rex)(char);                                  /* ac */
 139         /* b0 to d4 reserved */
 140 };
 141
 142 extern const struct callback *callv;
 143 #ifdef _LP64
 144 extern struct callback callvec;
 145 #else
 146 extern const struct callback callvec;
 147 #endif
 148
 149 #if defined(_STANDALONE) && !defined(_NO_PROM_DEFINES)
 150 #define memcpy (*callv -> _memcpy)
 151 #define memset (*callv -> _memset)
 152 #define strcat (*callv -> _strcat)
 153 #define strcmp (*callv -> _strcmp)
 154 #define strcpy (*callv -> _strcpy)
 155 #define strlen (*callv -> _strlen)
 156 #define strncat (*callv -> _strncat)
 157 #define strncpy (*callv -> _strncpy)
 158 #define strncmp (*callv -> _strncmp)
 159 #define getchar (*callv -> _getchar)
 160 #define gets (*callv -> _gets)
 161 #define puts (*callv -> _puts)
 162 #define printf (*callv -> _printf)
 163 #define sprintf (*callv -> _sprintf)
 164 #define io_poll (*callv -> _io_poll)
 165 #define strtol (*callv -> _strtol)
 166 #define raise (*callv -> _raise)
 167 #define time (*callv -> _time)
 168 #define setjmp (*callv -> _setjmp)
 169 #define longjmp (*callv -> _longjmp)
 170 #define bootinit (*callv -> _bootinit)
 171 #define bootread (*callv -> _bootread)
 172 #define bootwrite (*callv -> _bootwrite)
 173 #define setenv (*callv -> _setenv)
 174 #define getenv (*callv -> _getenv)
 175 #define unsetenv (*callv -> _unsetenv)
 176 #define wbflush (*callv -> _wbflush)
 177 #define msdelay (*callv -> _msdelay)
 178 #define leds (*callv -> _leds)
 179 #define clear_cache (*callv -> _clear_cache)
 180 #define getsysid (*callv -> _getsysid)
 181 #define getbitmap (*callv -> _getbitmap)
 182 #define disableintr (*callv -> _disableintr)
 183 #define enableintr (*callv -> _enableintr)
 184 #define testintr (*callv -> _testintr)
 185 #define console_init (*callv -> _console_init)
 186 #define halt (*callv -> _halt)
 187 #define showfault (*callv -> _showfault)
 188 #define gettcinfo (*callv -> _gettcinfo)
 189 #define execute_cmd (*callv -> _execute_cmd)
 190 #define rex (*callv -> _rex)
 191
 192 #define bzero(dst, len) memset(dst, 0, len)
 193 /* XXX make sure that no calls to bcopy overlap! */
 194 #define bcopy(src, dst, len) memcpy(dst, src, len)
 195 #endif
 196
 197 /*
 198  * The prom routines use the following structure to hold strings.
 199  */
 200 typedef struct {
 201         char    *argPtr[16];    /* Pointers to the strings. */
 202         char    strings[256];   /* Buffer for the strings. */
 203         char    *end;           /* Pointer to end of used buf. */
 204         int     num;            /* Number of strings used. */
 205 } MachStringTable;
 206
 207 #endif /* _LOCORE */
 208
 209 /*
 210  * The prom has a jump table at the beginning of it to get to its
 211  * functions.
 212  */
 213 #define DEC_PROM_JUMP_TABLE_ADDR        0xBFC00000
 214
 215 /*
 216  * Each entry in the jump table is 8 bytes - 4 for the jump and 4 for a nop.
 217  */
 218 #define DEC_PROM_FUNC_ADDR(funcNum)     (DEC_PROM_JUMP_TABLE_ADDR+((funcNum)*8))
 219
 220 /*
 221  * The functions:
 222  *
 223  *      DEC_PROM_RESET          Run diags, check bootmode, reinit.
 224  *      DEC_PROM_EXEC           Load new program image.
 225  *      DEC_PROM_RESTART        Re-enter monitor command loop.
 226  *      DEC_PROM_REINIT         Re-init monitor, then cmd loop.
 227  *      DEC_PROM_REBOOT         Check bootmode, no config.
 228  *      DEC_PROM_AUTOBOOT       Autoboot the system.
 229  *
 230  * The following routines access PROM saio routines and may be used by
 231  * standalone programs that would like to use PROM I/O:
 232  *
 233  *      DEC_PROM_OPEN           Open a file.
 234  *      DEC_PROM_READ           Read from a file.
 235  *      DEC_PROM_WRITE          Write to a file.
 236  *      DEC_PROM_IOCTL          Iocontrol on a file.
 237  *      DEC_PROM_CLOSE          Close a file.
 238  *      DEC_PROM_LSEEK          Seek on a file.
 239  *      DEC_PROM_GETCHAR        Get character from console.
 240  *      DEC_PROM_PUTCHAR        Put character on console.
 241  *      DEC_PROM_SHOWCHAR       Show a char visibly.
 242  *      DEC_PROM_GETS           gets with editing.
 243  *      DEC_PROM_PUTS           Put string to console.
 244  *      DEC_PROM_PRINTF         Kernel style printf to console.
 245  *
 246  *  PROM protocol entry points:
 247  *
 248  *      DEC_PROM_INITPROTO      Initialize protocol.
 249  *      DEC_PROM_PROTOENABLE    Enable protocol mode.
 250  *      DEC_PROM_PROTODISABLE   Disable protocol mode.
 251  *      DEC_PROM_GETPKT         Get protocol packet.
 252  *      DEC_PROM_PUTPKT         Put protocol packet.
 253  *
 254  * The following are other prom routines:
 255  *      DEC_PROM_FLUSHCACHE     Flush entire cache ().
 256  *      DEC_PROM_CLEARCACHE     Clear I & D cache in range (addr, len).
 257  *      DEC_PROM_SAVEREGS       Save registers in a buffer.
 258  *      DEC_PROM_LOADREGS       Get register back from buffer.
 259  *      DEC_PROM_JUMPS8         Jump to address in s8.
 260  *      DEC_PROM_GETENV2        Gets a string from system environment.
 261  *      DEC_PROM_SETENV2        Sets a string in system environment.
 262  *      DEC_PROM_ATONUM         Converts ascii string to number.
 263  *      DEC_PROM_STRCMP         Compares strings (strcmp).
 264  *      DEC_PROM_STRLEN         Length of string (strlen).
 265  *      DEC_PROM_STRCPY         Copies string (strcpy).
 266  *      DEC_PROM_STRCAT         Appends string (strcat).
 267  *      DEC_PROM_GETCMD         Gets a command.
 268  *      DEC_PROM_GETNUMS        Gets numbers.
 269  *      DEC_PROM_ARGPARSE       Parses string to argc,argv.
 270  *      DEC_PROM_HELP           Help on prom commands.
 271  *      DEC_PROM_DUMP           Dumps memory.
 272  *      DEC_PROM_SETENV         Sets a string in system environment.
 273  *      DEC_PROM_UNSETENV       Unsets a string in system environment
 274  *      DEC_PROM_PRINTENV       Prints system environment
 275  *      DEC_PROM_JUMP2S8        Jumps to s8
 276  *      DEC_PROM_ENABLE         Performs prom enable command.
 277  *      DEC_PROM_DISABLE        Performs prom disable command.
 278  *      DEC_PROM_ZEROB          Zeros a system buffer.
 279  *      DEC_PROM_HALT           Handler for halt interrupt.
 280  *      DEC_PROM_STARTCVAX      58xx VAX Diagnostic Supervisor support.
 281  */
 282 #define DEC_PROM_RESET          DEC_PROM_FUNC_ADDR(0)
 283 #define DEC_PROM_EXEC           DEC_PROM_FUNC_ADDR(1)
 284 #define DEC_PROM_RESTART        DEC_PROM_FUNC_ADDR(2)
 285 #define DEC_PROM_REINIT         DEC_PROM_FUNC_ADDR(3)
 286 #define DEC_PROM_REBOOT         DEC_PROM_FUNC_ADDR(4)
 287 #define DEC_PROM_AUTOBOOT       DEC_PROM_FUNC_ADDR(5)
 288 #define DEC_PROM_OPEN           DEC_PROM_FUNC_ADDR(6)
 289 #define DEC_PROM_READ           DEC_PROM_FUNC_ADDR(7)
 290 #define DEC_PROM_WRITE          DEC_PROM_FUNC_ADDR(8)
 291 #define DEC_PROM_IOCTL          DEC_PROM_FUNC_ADDR(9)
 292 #define DEC_PROM_CLOSE          DEC_PROM_FUNC_ADDR(10)
 293 #define DEC_PROM_LSEEK          DEC_PROM_FUNC_ADDR(11)
 294 #define DEC_PROM_GETCHAR        DEC_PROM_FUNC_ADDR(12)
 295 #define DEC_PROM_PUTCHAR        DEC_PROM_FUNC_ADDR(13)
 296 #define DEC_PROM_SHOWCHAR       DEC_PROM_FUNC_ADDR(14)
 297 #define DEC_PROM_GETS           DEC_PROM_FUNC_ADDR(15)
 298 #define DEC_PROM_PUTS           DEC_PROM_FUNC_ADDR(16)
 299 #define DEC_PROM_PRINTF         DEC_PROM_FUNC_ADDR(17)
 300 #define DEC_PROM_INITPROTO      DEC_PROM_FUNC_ADDR(18)
 301 #define DEC_PROM_PROTOENABLE    DEC_PROM_FUNC_ADDR(19)
 302 #define DEC_PROM_PROTODISABLE   DEC_PROM_FUNC_ADDR(20)
 303 #define DEC_PROM_GETPKT         DEC_PROM_FUNC_ADDR(21)
 304 #define DEC_PROM_PUTPKT         DEC_PROM_FUNC_ADDR(22)
 305 #define DEC_PROM_FLUSHCACHE     DEC_PROM_FUNC_ADDR(28)
 306 #define DEC_PROM_CLEARCACHE     DEC_PROM_FUNC_ADDR(29)
 307 #define DEC_PROM_SAVEREGS       DEC_PROM_FUNC_ADDR(30)
 308 #define DEC_PROM_LOADREGS       DEC_PROM_FUNC_ADDR(31)
 309 #define DEC_PROM_JUMPS8         DEC_PROM_FUNC_ADDR(32)
 310 #define DEC_PROM_GETENV2        DEC_PROM_FUNC_ADDR(33)
 311 #define DEC_PROM_SETENV2        DEC_PROM_FUNC_ADDR(34)
 312 #define DEC_PROM_ATONUM         DEC_PROM_FUNC_ADDR(35)
 313 #define DEC_PROM_STRCMP         DEC_PROM_FUNC_ADDR(36)
 314 #define DEC_PROM_STRLEN         DEC_PROM_FUNC_ADDR(37)
 315 #define DEC_PROM_STRCPY         DEC_PROM_FUNC_ADDR(38)
 316 #define DEC_PROM_STRCAT         DEC_PROM_FUNC_ADDR(39)
 317 #define DEC_PROM_GETCMD         DEC_PROM_FUNC_ADDR(40)
 318 #define DEC_PROM_GETNUMS        DEC_PROM_FUNC_ADDR(41)
 319 #define DEC_PROM_ARGPARSE       DEC_PROM_FUNC_ADDR(42)
 320 #define DEC_PROM_HELP           DEC_PROM_FUNC_ADDR(43)
 321 #define DEC_PROM_DUMP           DEC_PROM_FUNC_ADDR(44)
 322 #define DEC_PROM_SETENV         DEC_PROM_FUNC_ADDR(45)
 323 #define DEC_PROM_UNSETENV       DEC_PROM_FUNC_ADDR(46)
 324 #define DEC_PROM_PRINTENV       DEC_PROM_FUNC_ADDR(47)
 325 #define DEC_PROM_JUMP2S8        DEC_PROM_FUNC_ADDR(48)
 326 #define DEC_PROM_ENABLE         DEC_PROM_FUNC_ADDR(49)
 327 #define DEC_PROM_DISABLE        DEC_PROM_FUNC_ADDR(50)
 328 #define DEC_PROM_ZEROB          DEC_PROM_FUNC_ADDR(51)
 329 #define DEC_PROM_HALT           DEC_PROM_FUNC_ADDR(54)
 330 #define DEC_PROM_STARTCVAX      DEC_PROM_FUNC_ADDR(97)
 331
 332 /*
 333  * The nonvolatile ram has a flag to indicate it is usable.
 334  */
 335 #define MACH_USE_NON_VOLATILE   ((char *)0xbd0000c0)
 336 #define MACH_NON_VOLATILE_FLAG  0x02
 337
 338 #define DEC_REX_MAGIC           0x30464354      /* REX Magic number */
 339
 340 #endif  /* !_PMAX_DEC_PROM_H_ */