/*      $NetBSD: locore.h,v 1.40 2025/10/07 10:38:30 skrll Exp $        */

/*
 * Copyright (c) 1994-1996 Mark Brinicombe.
 * Copyright (c) 1994 Brini.
 * All rights reserved.
 *
 * This code is derived from software written for Brini by Mark Brinicombe
 *
 * 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. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by Brini.
 * 4. The name of the company nor the name of the author may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY BRINI ``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 BRINI 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.
 *
 * RiscBSD kernel project
 *
 * cpu.h
 *
 * CPU specific symbols
 *
 * Created      : 18/09/94
 *
 * Based on kate/katelib/arm6.h
 */

#ifndef _ARM_LOCORE_H_
#define _ARM_LOCORE_H_

#ifdef __arm__

#ifdef _KERNEL_OPT
#include "opt_cpuoptions.h"
#include "opt_cputypes.h"
#include "opt_arm_debug.h"
#endif

#include <sys/pcu.h>

#include <arm/cpuconf.h>
#include <arm/armreg.h>

#include <machine/frame.h>

#ifdef _LOCORE

#if defined(_ARM_ARCH_6)
#define IRQ_DISABLE(rTMP)       cpsid   i
#define IRQ_ENABLE(rTMP)        cpsie   i

#define INTERRUPT_DISABLE(rTMP) cpsid   if
#define INTERRUPT_ENABLE(rTMP)  cpsie   if
#else
#define IRQ_DISABLE(rTMP)                               \
        mrs     rTMP, cpsr ;                            \
        orr     rTMP, rTMP, #(I32_bit) ;                \
        msr     cpsr_c, rTMP

#define IRQ_ENABLE(rTMP)                                \
        mrs     rTMP, cpsr ;                            \
        bic     rTMP, rTMP, #(I32_bit) ;                \
        msr     cpsr_c, rTMP

#define INTERRUPT_DISABLE(rTMP)                         \
        mrs     rTMP, cpsr ;                            \
        orr     rTMP, rTMP, #(I32_bit | F32_bit) ;      \
        msr     cpsr_c, rTMP

#define INTERRUPT_ENABLE(rTMP)                          \
        mrs     rTMP, cpsr ;                            \
        bic     rTMP, rTMP, #(I32_bit | F32_bit) ;      \
        msr     cpsr_c, rTMP
#endif

#if defined (TPIDRPRW_IS_CURCPU)
#define GET_CURCPU(rX)          mrc     p15, 0, rX, c13, c0, 4
#define GET_CURLWP(rX)          GET_CURCPU(rX); ldr rX, [rX, #CI_CURLWP]
#define GET_CURX(rCPU, rLWP)    GET_CURCPU(rCPU); ldr rLWP, [rCPU, #CI_CURLWP]
#elif defined (TPIDRPRW_IS_CURLWP)
#define GET_CURLWP(rX)          mrc     p15, 0, rX, c13, c0, 4
#if defined (MULTIPROCESSOR)
#define GET_CURCPU(rX)          GET_CURLWP(rX); ldr rX, [rX, #L_CPU]
#define GET_CURX(rCPU, rLWP)    GET_CURLWP(rLWP); ldr rCPU, [rLWP, #L_CPU]
#elif defined(_ARM_ARCH_7)
#define GET_CURCPU(rX)          movw rX, #:lower16:cpu_info_store; movt rX, #:upper16:cpu_info_store
#define GET_CURX(rCPU, rLWP)    GET_CURLWP(rLWP); GET_CURCPU(rCPU)
#else
#define GET_CURCPU(rX)          ldr rX, =_C_LABEL(cpu_info_store)
#define GET_CURX(rCPU, rLWP)    GET_CURLWP(rLWP); ldr rCPU, [rLWP, #L_CPU]
#endif
#elif !defined(MULTIPROCESSOR)
#define GET_CURCPU(rX)          ldr rX, =_C_LABEL(cpu_info_store)
#define GET_CURLWP(rX)          GET_CURCPU(rX); ldr rX, [rX, #CI_CURLWP]
#define GET_CURX(rCPU, rLWP)    GET_CURCPU(rCPU); ldr rLWP, [rCPU, #CI_CURLWP]
#endif
#define GET_CURPCB(rX)          GET_CURLWP(rX); ldr rX, [rX, #L_PCB]

#else /* !_LOCORE */

#include <arm/cpufunc.h>

#define IRQdisable __set_cpsr_c(I32_bit, I32_bit);
#define IRQenable __set_cpsr_c(I32_bit, 0);

/*
 * Validate a PC or PSR for a user process.  Used by various system calls
 * that take a context passed by the user and restore it.
 */

#ifdef __NO_FIQ
#define VALID_PSR(psr)                                          \
    (((psr) & PSR_MODE) == PSR_USR32_MODE && ((psr) & I32_bit) == 0)
#else
#define VALID_PSR(psr)                                          \
    (((psr) & PSR_MODE) == PSR_USR32_MODE && ((psr) & IF32_bits) == 0)
#endif

/*
 * Translation Table Base Register Share/Cache settings
 */
#define TTBR_UPATTR     (TTBR_S | TTBR_RGN_WBNWA | TTBR_C)
#define TTBR_MPATTR     (TTBR_S | TTBR_RGN_WBNWA /* | TTBR_NOS */ | TTBR_IRGN_WBNWA)

/* The address of the vector page. */
extern vaddr_t vector_page;
void    arm32_vector_init(vaddr_t, int);

#define ARM_VEC_RESET                   (1 << 0)
#define ARM_VEC_UNDEFINED               (1 << 1)
#define ARM_VEC_SWI                     (1 << 2)
#define ARM_VEC_PREFETCH_ABORT          (1 << 3)
#define ARM_VEC_DATA_ABORT              (1 << 4)
#define ARM_VEC_ADDRESS_EXCEPTION       (1 << 5)
#define ARM_VEC_IRQ                     (1 << 6)
#define ARM_VEC_FIQ                     (1 << 7)

#define ARM_NVEC                        8
#define ARM_VEC_ALL                     0xffffffff

/*
 * cpu device glue (belongs in cpuvar.h)
 */
void    cpu_attach(device_t, cpuid_t);

/* 1 == use cpu_sleep(), 0 == don't */
extern int cpu_do_powersave;
extern int cpu_printfataltraps;
extern int cpu_fpu_present;
extern int cpu_hwdiv_present;
extern int cpu_neon_present;
extern int cpu_simd_present;
extern int cpu_simdex_present;
extern int cpu_umull_present;
extern int cpu_synchprim_present;

extern int cpu_instruction_set_attributes[6];
extern int cpu_memory_model_features[4];
extern int cpu_processor_features[2];
extern int cpu_media_and_vfp_features[2];

extern bool arm_has_tlbiasid_p;
extern bool arm_has_mpext_p;

#if !defined(CPU_ARMV7)
#define CPU_IS_ARMV7_P()                false
#elif defined(CPU_ARMV6) || defined(CPU_PRE_ARMV6)
extern bool cpu_armv7_p;
#define CPU_IS_ARMV7_P()                (cpu_armv7_p)
#else
#define CPU_IS_ARMV7_P()                true
#endif
#if !defined(CPU_ARMV6)
#define CPU_IS_ARMV6_P()                false
#elif defined(CPU_ARMV7) || defined(CPU_PRE_ARMV6)
extern bool cpu_armv6_p;
#define CPU_IS_ARMV6_P()                (cpu_armv6_p)
#else
#define CPU_IS_ARMV6_P()                true
#endif

/*
 * Used by the fault code to read the current instruction.
 */
static inline uint32_t
read_insn(vaddr_t va, bool user_p)
{
        uint32_t insn;
        if (user_p) {
                __asm __volatile("ldrt %0, [%1]" : "=&r"(insn) : "r"(va));
        } else {
                insn = *(const uint32_t *)va;
        }
#ifdef _ARM_ARCH_BE8
        insn = bswap32(insn);
#endif
        return insn;
}

/*
 * Used by the fault code to read the current thumb instruction.
 */
static inline uint32_t
read_thumb_insn(vaddr_t va, bool user_p)
{
        va &= ~1;
        uint32_t insn;
        if (user_p) {
#if defined(__thumb__) && defined(_ARM_ARCH_T2)
                __asm __volatile("ldrht %0, [%1, #0]" : "=&r"(insn) : "r"(va));
#elif defined(_ARM_ARCH_7)
                __asm __volatile("ldrht %0, [%1], #0" : "=&r"(insn) : "r"(va));
#else
                __asm __volatile("ldrt %0, [%1]" : "=&r"(insn) : "r"(va & ~3));
#ifdef __ARMEB__
                insn = (uint16_t) (insn >> (((va ^ 2) & 2) << 3));
#else
                insn = (uint16_t) (insn >> ((va & 2) << 3));
#endif
#endif
        } else {
                insn = *(const uint16_t *)va;
        }
#ifdef _ARM_ARCH_BE8
        insn = bswap16(insn);
#endif
        return insn;
}

/*
 * Random cruft
 */

struct lwp;

/* cpu.c */
void    identify_arm_cpu(device_t, struct cpu_info *);

/* cpuswitch.S */
struct pcb;
void    savectx(struct pcb *);

/* ast.c */
void    userret(struct lwp *);

/* *_machdep.c */
void    bootsync(void);

/* fault.c */
int     badaddr_read(void *, size_t, void *);

/* syscall.c */
void    swi_handler(trapframe_t *);

/* vfp_init.c */
void    vfp_detect(struct cpu_info *);
void    vfp_attach(struct cpu_info *);
void    vfp_discardcontext(lwp_t *, bool);
void    vfp_savecontext(lwp_t *);
void    vfp_kernel_acquire(void);
void    vfp_kernel_release(void);
bool    vfp_used_p(const lwp_t *);
extern const pcu_ops_t arm_vfp_ops;

#endif  /* !_LOCORE */

#elif defined(__aarch64__)

#include <aarch64/locore.h>

#endif /* __arm__/__aarch64__ */

#endif /* !_ARM_LOCORE_H_ */