/*      $NetBSD: cpu.h,v 1.106.2.2 2023/12/19 12:28:01 martin Exp $      */

/*
 * Copyright (c) 1994 Ludd, University of Lule}, Sweden
 * 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.
 *
 * 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.
 */

#ifndef _VAX_CPU_H_
#define _VAX_CPU_H_

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

#define	CPU_PRINTFATALTRAPS	1
#define	CPU_CONSDEV		2
#define	CPU_BOOTED_DEVICE	3
#define	CPU_BOOTED_KERNEL	4

#ifdef _KERNEL

#include <sys/cdefs.h>
#include <sys/queue.h>
#include <sys/device_if.h>
#include <sys/cpu_data.h>

#include <machine/mtpr.h>
#include <machine/pcb.h>
#include <machine/uvax.h>
#include <machine/psl.h>

#define enablertclock()

/*
 * All cpu-dependent info is kept in this struct. Pointer to the
 * struct for the current cpu is set up in locore.c.
 */
struct cpu_info;

struct cpu_dep {
	void	(*cpu_steal_pages)(void); /* pmap init before mm is on */
	int	(*cpu_mchk)(void *);   /* Machine check handling */
	void	(*cpu_memerr)(void); /* Memory subsystem errors */
	    /* Autoconfiguration */
	void	(*cpu_conf)(void);
	int	(*cpu_gettime)(struct timeval *); /* Read cpu clock time */
	void	(*cpu_settime)(struct timeval *); /* Write system time to cpu */
	short	cpu_vups;		/* speed of cpu */
	short	cpu_scbsz;		/* (estimated) size of SCB */
	void	(*cpu_halt)(void);	/* Cpu dependent halt call */
	void	(*cpu_reboot)(int);	/* Cpu dependent reboot call */
	void	(*cpu_clrf)(void);	/* Clear cold/warm start flags */
	const char * const *cpu_devs;	/* mainbus devices */
	void	(*cpu_attach_cpu)(device_t);	/* print CPU info */
	int     cpu_flags;
	void	(*cpu_badaddr)(void);	/* cpu-specific badaddr() */
};

#if defined(MULTIPROCESSOR)
/*
 * All cpu-dependent calls for multicpu systems goes here.
 */
struct cpu_mp_dep {
	void	(*cpu_startslave)(struct cpu_info *);
	void	(*cpu_send_ipi)(struct cpu_info *);
	void	(*cpu_cnintr)(void);
};
/*
 * NOTE: This is not bit mask, this is bit _number_.
 */
#define	IPI_START_CNTX	1	/* Start console transmitter, proc out */
#define	IPI_SEND_CNCHAR	2	/* Write char to console, kernel printf */
#define	IPI_RUNNING	3	/* This CPU just started to run */
#define	IPI_TBIA	4	/* Flush the TLB */
#define	IPI_DDB		5	/* Jump into the DDB loop */
#define	IPI_XCALL	6	/* Helper for xcall(9) */
#define	IPI_GENERIC	7	/* Generic ipi(9) call */

#define	IPI_DEST_MASTER	-1	/* Destination is mastercpu */
#define	IPI_DEST_ALL	-2	/* Broadcast */

extern const struct cpu_mp_dep *mp_dep_call;
#endif /* defined(MULTIPROCESSOR) */
  
#define	CPU_RAISEIPL	1	/* Must raise IPL until intr is handled */ 

extern const struct cpu_dep *dep_call;
				/* Holds pointer to current CPU struct. */

struct clockframe {
        int     pc;
        int     ps;
};

struct cpu_info {
	/*
	 * Public members.
	 */
	struct cpu_data ci_data;	/* MI per-cpu data */
	device_t ci_dev;		/* device struct for this cpu */
	int ci_mtx_oldspl;		/* saved spl */
	int ci_mtx_count;		/* negative count of mutexes */
	int ci_cpuid;			/* h/w specific cpu id */
	int ci_want_resched;		/* Should change process */

	/*
	 * Private members.
	 */
#if defined(__HAVE_FAST_SOFTINTS)
	lwp_t *ci_softlwps[SOFTINT_COUNT];
#endif
	vaddr_t ci_istack;		/* Interrupt stack location */
	const char *ci_cpustr;
	int ci_slotid;			/* cpu slot */
	struct lwp *ci_onproc;		/* current user LWP / kthread */
#if defined(MULTIPROCESSOR)
	struct lwp *ci_curlwp;		/* current lwp (for other cpus) */
	volatile int ci_flags;		/* See below */
	long ci_ipimsgs;		/* Sent IPI bits */
	struct trapframe *ci_ddb_regs;	/* Used by DDB */
	SIMPLEQ_ENTRY(cpu_info) ci_next; /* next cpu_info */
#endif
	uintptr_t ci_cas_addr;		/* current address doing CAS in a RAS */
#if defined(GPROF) && defined(MULTIPROCESSOR)
	struct gmonparam *ci_gmon;	/* MI per-cpu GPROF */
#endif
};
#define	CI_MASTERCPU	1		/* Set if master CPU */
#define	CI_RUNNING	2		/* Set when a slave CPU is running */
#define	CI_STOPPED	4		/* Stopped (in debugger) */

extern int cpu_printfataltraps;

#define	curcpu()		(curlwp->l_cpu + 0)
#define	curlwp			((struct lwp *)mfpr(PR_SSP))
#define	cpu_number()		(curcpu()->ci_cpuid)
#define	cpu_need_resched(ci, l, flags)		\
	do {							\
		struct pcb *pcb = lwp_getpcb(curlwp);		\
		__USE(flags);					\
		pcb->P0LR = (pcb->P0LR & ~AST_MASK) | AST_ON;	\
		mtpr(AST_OK,PR_ASTLVL);				\
	} while (/*CONSTCOND*/ 0)
#define	cpu_proc_fork(x, y)	do { } while (/*CONSCOND*/0)

/*
 * This allows SIMH to recognize the kernel wants to sleep.
 */
static inline void
cpu_idle(void)
{
	int ipl = mfpr(PR_IPL);
	mtpr(1, PR_IPL);
	mtpr(ipl, PR_IPL);
}

static inline bool
cpu_intr_p(void)
{
	register_t psl;
	__asm("movpsl %0" : "=g"(psl));
	return (psl & PSL_IS) != 0;
}
#if defined(MULTIPROCESSOR)
#define	CPU_IS_PRIMARY(ci)	((ci)->ci_flags & CI_MASTERCPU)

#define	CPU_INFO_ITERATOR	int __unused
#define	CPU_INFO_FOREACH(cii, ci)	ci = SIMPLEQ_FIRST(&cpus); \
					ci != NULL; \
					ci = SIMPLEQ_NEXT(ci, ci_next)

extern SIMPLEQ_HEAD(cpu_info_qh, cpu_info) cpus;
extern char vax_mp_tramp;
#endif

/*
 * Notify the current process (p) that it has a signal pending,
 * process as soon as possible.
 */

#define cpu_signotify(l)					\
	do {							\
		struct pcb *pcb = lwp_getpcb(l);		\
		pcb->P0LR = (pcb->P0LR & ~AST_MASK) | AST_ON;	\
		mtpr(AST_OK,PR_ASTLVL);				\
	} while (/*CONSTCOND*/ 0)


/*
 * Give a profiling tick to the current process when the user profiling
 * buffer pages are invalid.  On the hp300, request an ast to send us
 * through trap, marking the proc as needing a profiling tick.
 */
#define cpu_need_proftick(l) 					\
	do {							\
		struct pcb *pcb = lwp_getpcb(l);		\
		(l)->l_pflag |= LP_OWEUPC;			\
		pcb->P0LR = (pcb->P0LR & ~AST_MASK) | AST_ON;	\
		mtpr(AST_OK,PR_ASTLVL);				\
	} while (/*CONSTCOND*/ 0)

/*
 * This defines the I/O device register space size in pages.
 */
#define	IOSPSZ	((64*1024) / VAX_NBPG)	/* 64k == 128 pages */

#define	LWP_PC(l)	cpu_lwp_pc(l)

struct buf;
struct pte;

#include <sys/lwp.h>

/* Some low-level prototypes */
#if defined(MULTIPROCESSOR)
void	cpu_slavesetup(device_t, int);
void	cpu_boot_secondary_processors(void);
void	cpu_send_ipi(int, int);
void	cpu_handle_ipi(void);
#endif
vaddr_t	cpu_lwp_pc(struct lwp *);
int	badaddr(volatile void *, int);
void	dumpsys(void);
void	swapconf(void);
void	disk_printtype(int, int);
void	disk_reallymapin(struct buf *, struct pte *, int, int);
vaddr_t	vax_map_physmem(paddr_t, size_t);
void	vax_unmap_physmem(vaddr_t, size_t);
void	ioaccess(vaddr_t, paddr_t, size_t);
void	iounaccess(vaddr_t, size_t);
void	findcpu(void);
#ifdef DDB
int	kdbrint(int);
#endif
#endif /* _KERNEL */
#ifdef _STANDALONE
void	findcpu(void);
#endif
#endif /* _VAX_CPU_H_ */
