/*	$NetBSD: m68k.h,v 1.38 2026/04/28 03:29:09 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$
 *	from: @(#)cpu.h	8.4 (Berkeley) 1/5/94
 */

#ifndef _M68K_M68K_H_
#define	_M68K_M68K_H_

/*
 * Declarations for things exported by sources in this directory,
 * or required by sources in here and not declared elsewhere.
 *
 * These declarations generally do NOT belong in <machine/cpu.h>,
 * because that defines the interface between the common code and
 * the machine-dependent code, whereas this defines the interface
 * between the shared m68k code and the machine-dependent code.
 *
 * The MMU stuff is exported separately so it can be used just
 * where it is really needed.  Same for function codes, etc.
 */

#ifdef _KERNEL

#include <uvm/uvm_prot.h>	/* for vm_prot_t */

/*
 * All m68k ports must provide these globals.
 */
extern	int cputype;		/* CPU on this host */
extern	int mmutype;		/* MMU on this host */
#endif	/* _KERNEL */

/* values for cputype */
#define	CPU_68010	-1	/* 68010 */
#define	CPU_68020	0	/* 68020 */
#define	CPU_68030	1	/* 68030 */
#define	CPU_68040	2	/* 68040 */
#define	CPU_68060	3	/* 68060 */

/* values for ectype */
#define	EC_PHYS		-1	/* external physical address cache */
#define	EC_NONE		0	/* no external cache */
#define	EC_VIRT		1	/* external virtual address cache */

/* values for fputype */
#define	FPU_NONE	0	/* no FPU */
#define	FPU_68881	1	/* 68881 FPU */
#define	FPU_68882	2	/* 68882 FPU */
#define	FPU_68040	3	/* 68040 on-chip FPU */
#define	FPU_68060	4	/* 68060 on-chip FPU */
#define	FPU_UNKNOWN	5	/* placeholder; unknown FPU */

/*
 * values for mmutype (assigned for quick testing).  Assembly
 * code relies on this ordering, so do not change it!
 */
#define	MMU_UNKNOWN	-5	/* unknown MMU type */
#define	MMU_CUSTOM	-4	/* bespoke machine-specific MMU */
#define	MMU_68060	-3	/* 68060 on-chip MMU */
#define	MMU_68040	-2	/* 68040 on-chip MMU */
#define	MMU_68030	-1	/* 68030 on-chip subset of 68851 */
#define	MMU_HP		0	/* HP proprietary */
#define	MMU_68851	1	/* Motorola 68851 */
#define	MMU_SUN		2	/* Sun MMU */


#ifdef _KERNEL

/*
 * Delay divisor estimation for 68020/6830, 68040, and 68060,
 * based on CPU clock frequency.  This is based on a x1024
 * delay magnification factor.
 *
 * These provide a reasonable starting point; it is always
 * best to calibrate the delay_divisor against a known clock
 * source, if possible, a known-rate counter or a timer of
 * some sort where expiration can be checked reliably.  When
 * picking a default, it's safest to assume the fastest machine
 * you're likely to see, which may result in longer delays,
 * but is a safer bet if those delays are needed for minimum
 * hardware timings, etc.
 *
 * When calibrating the delay_divisor, it is best to start
 * assuming a slower CPU, which results in a larger delay
 * divisor and the delay loop completing more quickly.  The
 * calibration loop can then check to see if the reference
 * has reached the desired value.  If it has not, decrement
 * the delay_divisor, thus slowing down the delay loop, and
 * try again.  For this purpose, we provide a "weight" macro
 * that drags down the estimated lower CPU speed boundary
 * by (very) roughly 10%.
 *
 * Note that the delay_divisor_est*() macros are reciprocal; given
 * a calibrated delay_divisor value, you can use that to get the
 * rough CPU speed in MHz.
 */
#define	DELAY_MAGSHIFT		10
#define	DELAY_MAGFACTOR		(1 << DELAY_MAGSHIFT)
#define	DELAY_MAXVAL		(0xffffffffU >> DELAY_MAGSHIFT)
#define	delay_divisor_est(x)	((DELAY_MAGFACTOR * 8) / (x))
#define	delay_divisor_est40(x)	((DELAY_MAGFACTOR * 3) / (x))
#define	delay_divisor_est60(x)	((DELAY_MAGFACTOR * 1) / (x))
#define	delay_calibration_weight(x) ((x) - ((x) / 10))

extern int delay_divisor;

struct pcb;
struct trapframe;
struct fpframe;

/* copypage.s */
void	copypage040(void *fromaddr, void *toaddr);
void	copypage(void *fromaddr, void *toaddr);
void	zeropage(void *addr);

/* switch_subr.s */
void	lwp_trampoline(void);
void	m68881_save(struct fpframe *);
void	m68881_restore(struct fpframe *);
void	savectx(struct pcb *);

/* w16copy.s */
void	w16zero(void *, u_int);
void	w16copy(const void *, void *, u_int);

/* fpu.c */
extern	int fputype;		/* FPU on this host */
void	fpu_init(void);

/* m68k_machdep.c */
extern	int ectype;
extern	int ecsize;
extern	int cpuspeed_khz;
extern	int fpuspeed_khz;
void	machine_init_common(paddr_t);
void	machine_set_model(void);
#ifdef __HAVE_M68K_MACHINE_PRINT_MODEL
void	machine_print_model(void (*)(const char *, ...)
			    __printflike(1, 2));
#endif
void	cpu_startup_common(void);
#ifdef __HAVE_CPU_STARTUP_PRINT_MACHINE_MODEL
void	cpu_startup_print_machine_model(void (*)(const char *, ...)
					__printflike(1, 2));
#endif
#ifdef __HAVE_CPU_STARTUP_PRINT_TOTAL_MEMORY
void	cpu_startup_print_total_memory(void (*)(const char *, ...)
				       __printflike(1, 2));
#endif
int	cpu_reboot_poll_console(bool);
void	cpu_reboot_common(int, char *) __dead;
void	machine_powerdown_default(void);
void	machine_powerdown(void);
void	machine_halt_default(void);
void	machine_halt(void);
void	machine_reboot(int, char *);
void	bootsync(void);
int	mm_md_physacc_regular(paddr_t, vm_prot_t);

/* m68k_trap.c */
extern label_t *nofault;
bool	badaddr_read(volatile void *, size_t, void *);
bool	badaddr_write(volatile void *, size_t, uintmax_t);

#define	badaddr(a)		badaddr_read((a), 2, NULL)
#define	badbaddr(a)		badaddr_read((a), 1, NULL)
#define	badaddr_sz(a, s)	badaddr_read((a), (s), NULL)

/* regdump.c */
void	regdump(struct trapframe *, int);

/* sys_machdep.c */
int	cachectl1(u_long, vaddr_t, size_t, struct proc *);
int	dma_cachectl(void *, int);

/* vm_machdep.c */
int	kvtop(void *);
void	physaccess(void *, void *, int, int);
void	physunaccess(void *, int);

#endif /* _KERNEL */
#endif /* _M68K_M68K_H_ */