/*      $NetBSD: cpu.h,v 1.78 2024/01/20 00:15:31 thorpej Exp $ */

/*
* Copyright (c) 1988 University of Utah.
* Copyright (c) 1982, 1990, 1993
*      The Regents of the University of California.  All rights reserved.
*
* This code is derived from software contributed to Berkeley by
* the Systems Programming Group of the University of Utah Computer
* Science Department.
*
* 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. Neither the name of the University nor the names of its contributors
*    may be used to endorse or promote products derived from this software
*    without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
*
* from: Utah $Hdr: cpu.h 1.16 91/03/25$
*
*      @(#)cpu.h       8.4 (Berkeley) 1/5/94
*/

#ifndef _HP300_CPU_H_
#define _HP300_CPU_H_

#if defined(_KERNEL_OPT)
#include "opt_lockdebug.h"
#endif

/*
* Get common m68k CPU definitions.
*/
#include <m68k/cpu.h>

#if defined(_KERNEL)
/*
* Exported definitions unique to hp300/68k cpu support.
*/
#include <machine/hp300spu.h>

/*
* The rest of this should probably be moved to <machine/hp300spu.h>,
* although some of it could probably be put into generic 68k headers.
*/

extern  uint8_t *intiobase, *intiolimit, *extiobase;

/* locore.s functions */
void    doboot(void) __attribute__((__noreturn__));
void    ecacheon(void);
void    ecacheoff(void);

/* clock.c functions */
void    hp300_calibrate_delay(void);

/* machdep.c functions */
int     badaddr(void *);
int     badbaddr(void *);

/* what is this supposed to do? i.e. how is it different than startrtclock? */
#define enablertclock()

#endif /* _KERNEL */

/* physical memory sections */
#define ROMBASE         (0x00000000)
#define INTIOBASE       (0x00400000)
#define INTIOTOP        (0x00600000)
#define EXTIOBASE       (0x00600000)
#define EXTIOTOP        (0x20000000)
#define MAXADDR         ((paddr_t)(0 - NBPG))

/*
* Internal IO space:
*
* Ranges from 0x400000 to 0x600000 (IIOMAPSIZE).
*
* Internal IO space is mapped in the kernel from ``intiobase'' to
* ``intiolimit'' (defined in locore.s).  Since it is always mapped,
* conversion between physical and kernel virtual addresses is easy.
*/
#define ISIIOVA(va) \
       ((uint8_t *)(va) >= intiobase && (uint8_t *)(va) < intiolimit)
#define IIOV(pa)        ((paddr_t)(pa)-INTIOBASE+(vaddr_t)intiobase)
#define IIOP(va)        ((vaddr_t)(va)-(vaddr_t)intiobase+INTIOBASE)
#define IIOPOFF(pa)     ((paddr_t)(pa)-INTIOBASE)
#define IIOMAPSIZE      btoc(INTIOTOP-INTIOBASE)        /* 2mb */

/*
* External IO space:
*
* DIO ranges from select codes 0-63 at physical addresses given by:
*      0x600000 + (sc - 32) * 0x10000
* DIO cards are addressed in the range 0-31 [0x600000-0x800000) for
* their control space and the remaining areas, [0x200000-0x400000) and
* [0x800000-0x1000000), are for additional space required by a card;
* e.g. a display framebuffer.
*
* DIO-II ranges from select codes 132-255 at physical addresses given by:
*      0x1000000 + (sc - 132) * 0x400000
* The address range of DIO-II space is thus [0x1000000-0x20000000).
*
* DIO/DIO-II space is too large to map in its entirety, instead devices
* are mapped into kernel virtual address space allocated from a range
* of EIOMAPSIZE pages (vmparam.h) starting at ``extiobase''.
*/
#define DIOBASE         (0x600000)
#define DIOTOP          (0x1000000)
#define DIOCSIZE        (0x10000)
#define DIOIIBASE       (0x01000000)
#define DIOIITOP        (0x20000000)
#define DIOIICSIZE      (0x00400000)

/*
* HP MMU
*/
#define MMUBASE         IIOPOFF(0x5F4000)
#define MMUSSTP         0x0
#define MMUUSTP         0x4
#define MMUTBINVAL      0x8
#define MMUSTAT         0xC
#define MMUCMD          MMUSTAT

#define MMU_UMEN        0x0001  /* enable user mapping */
#define MMU_SMEN        0x0002  /* enable supervisor mapping */
#define MMU_CEN         0x0004  /* enable data cache */
#define MMU_BERR        0x0008  /* bus error */
#define MMU_IEN         0x0020  /* enable instruction cache */
#define MMU_FPE         0x0040  /* enable 68881 FP coprocessor */
#define MMU_WPF         0x2000  /* write protect fault */
#define MMU_PF          0x4000  /* page fault */
#define MMU_PTF         0x8000  /* page table fault */

#define MMU_FAULT       (MMU_PTF|MMU_PF|MMU_WPF|MMU_BERR)
#define MMU_ENAB        (MMU_UMEN|MMU_SMEN|MMU_IEN|MMU_FPE)

#if defined(CACHE_HAVE_PAC) || defined(CACHE_HAVE_VAC)
#define M68K_CACHEOPS_MACHDEP
#endif

#ifdef CACHE_HAVE_PAC
#define M68K_CACHEOPS_MACHDEP_PCIA
#endif

#ifdef CACHE_HAVE_VAC
#define M68K_CACHEOPS_MACHDEP_DCIA
#define M68K_CACHEOPS_MACHDEP_DCIS
#define M68K_CACHEOPS_MACHDEP_DCIU
#define M68K_CACHEOPS_MACHDEP_TBIA
#define M68K_CACHEOPS_MACHDEP_TBIS
#define M68K_CACHEOPS_MACHDEP_TBIAS
#define M68K_CACHEOPS_MACHDEP_TBIAU
#endif

#endif /* _HP300_CPU_H_ */