/*      $NetBSD: machdep.h,v 1.19 2024/02/07 04:20:26 msaitoh Exp $     */

/*
 * Copyright (c) 2017 Ryo Shimizu
 * 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 _AARCH64_MACHDEP_H_
#define _AARCH64_MACHDEP_H_

#include <sys/proc.h>
#include <sys/lwp.h>
#include <sys/siginfo.h>

// initarm_common
#include <machine/bootconfig.h>

struct boot_physmem;

static inline paddr_t
aarch64_kern_vtophys(vaddr_t va)
{
        extern u_long kern_vtopdiff;

        return va - kern_vtopdiff;
}

static inline vaddr_t
aarch64_kern_phystov(paddr_t pa)
{
        extern u_long kern_vtopdiff;

        return pa + kern_vtopdiff;
}

#define KERN_VTOPHYS(va)        aarch64_kern_vtophys(va)
#define KERN_PHYSTOV(pa)        aarch64_kern_phystov(pa)

extern paddr_t physical_start;
extern paddr_t physical_end;
extern vaddr_t module_start;
extern vaddr_t module_end;

extern void (*cpu_reset_address0)(void);
extern void (*cpu_reset_address)(void);
extern void (*cpu_powerdown_address)(void);

extern char *booted_kernel;

/*
 * note that we use void * as all the platforms have different ideas on what
 * the structure is
 */
vaddr_t initarm(void *);

vaddr_t initarm_common(vaddr_t, vsize_t, const struct boot_physmem *, size_t);
void cpu_kernel_vm_init(paddr_t, psize_t);
void uartputc(int);

void parse_mi_bootargs(char *);
void dumpsys(void);

void cpu_startup_hook(void);
void cpu_startup_default(void);

struct trapframe;

/* fault.c */
void data_abort_handler(struct trapframe *, uint32_t);

/* trap.c */
void lwp_trampoline(void);
void configure_cpu_traps(void);
void cpu_dosoftints(void);
void cpu_switchto_softint(struct lwp *, int);
void dosoftints(void);
int fetch_arm_insn(uint64_t, uint64_t, uint32_t *);
void trap_doast(struct trapframe *);

void trap_el1t_sync(struct trapframe *);
void trap_el1t_irq(struct trapframe *);
void trap_el1t_fiq(struct trapframe *);
void trap_el1t_error(struct trapframe *);
void trap_el1h_sync(struct trapframe *);
void trap_el1h_fiq(struct trapframe *);
void trap_el1h_error(struct trapframe *);
void trap_el0_sync(struct trapframe *);
void trap_el0_fiq(struct trapframe *);
void trap_el0_error(struct trapframe *);
void trap_el0_32sync(struct trapframe *);
void trap_el0_32fiq(struct trapframe *);
void trap_el0_32error(struct trapframe *);
void cpu_irq(struct trapframe *);
void cpu_fiq(struct trapframe *);

/* cpu_onfault */
int cpu_set_onfault(struct faultbuf *) __returns_twice;
void cpu_jump_onfault(struct trapframe *, const struct faultbuf *, int);

#if defined(_KERNEL)
static inline void
cpu_unset_onfault(void)
{
        curlwp->l_md.md_onfault = NULL;
}

static inline void
cpu_enable_onfault(struct faultbuf *fb)
{
        curlwp->l_md.md_onfault = fb;
}

static inline struct faultbuf *
cpu_disable_onfault(void)
{
        struct faultbuf * const fb = curlwp->l_md.md_onfault;
        if (fb != NULL)
                curlwp->l_md.md_onfault = NULL;
        return fb;
}
#endif

/* exec_machdep.c */
void aarch64_setregs_ptrauth(struct lwp *, bool);

/* fpu.c */
void fpu_attach(struct cpu_info *);
struct fpreg;
void load_fpregs(const struct fpreg *);
void save_fpregs(struct fpreg *);

#ifdef TRAP_SIGDEBUG
#define do_trapsignal(l, signo, code, addr, trap) \
    do_trapsignal1(__func__, __LINE__, tf, l, signo, code, addr, trap)
#else
#define do_trapsignal(l, signo, code, addr, trap) \
    do_trapsignal1(l, signo, code, addr, trap)
#endif

void do_trapsignal1(
#ifdef TRAP_SIGDEBUG
    const char *func, size_t line, struct trapframe *tf,
#endif
    struct lwp *l, int signo, int code, void *addr, int trap);

const char *eclass_trapname(uint32_t);

#include <sys/pcu.h>

extern const pcu_ops_t pcu_fpu_ops;

static inline bool
fpu_used_p(lwp_t *l)
{
        return pcu_valid_p(&pcu_fpu_ops, l);
}

static inline void
fpu_save(lwp_t *l)
{
        pcu_save(&pcu_fpu_ops, l);
}

static inline void
fpu_load(lwp_t *l)
{
        pcu_load(&pcu_fpu_ops);
}

static inline void
fpu_discard(lwp_t *l, bool usesw)
{
        pcu_discard(&pcu_fpu_ops, l, usesw);
}

#endif /* _AARCH64_MACHDEP_H_ */