/*      $NetBSD: arm32_machdep.c,v 1.44 2004/03/24 15:34:47 atatat Exp $        */

/*-
 * SPDX-License-Identifier: BSD-4-Clause
 *
 * Copyright (c) 2004 Olivier Houchard
 * Copyright (c) 1994-1998 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 Mark Brinicombe
 *      for the NetBSD Project.
 * 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 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 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.
 *
 * Machine dependent functions for kernel setup
 *
 * Created      : 17/09/94
 * Updated      : 18/04/01 updated for new wscons
 */

#include "opt_ddb.h"
#include "opt_kstack_pages.h"
#include "opt_platform.h"
#include "opt_sched.h"

#include <sys/param.h>
#include <sys/buf.h>
#include <sys/bus.h>
#include <sys/cons.h>
#include <sys/cpu.h>
#include <sys/devmap.h>
#include <sys/efi.h>
#include <sys/efi_map.h>
#include <sys/imgact.h>
#include <sys/kdb.h>
#include <sys/kernel.h>
#include <sys/ktr.h>
#include <sys/linker.h>
#include <sys/msgbuf.h>
#include <sys/physmem.h>
#include <sys/reboot.h>
#include <sys/rwlock.h>
#include <sys/sched.h>
#include <sys/syscallsubr.h>
#include <sys/sysent.h>
#include <sys/sysproto.h>
#include <sys/vmmeter.h>

#include <vm/vm_object.h>
#include <vm/vm_page.h>
#include <vm/vm_pager.h>

#include <machine/asm.h>
#include <machine/debug_monitor.h>
#include <machine/machdep.h>
#include <machine/metadata.h>
#include <machine/pcb.h>
#include <machine/platform.h>
#include <machine/sysarch.h>
#include <machine/undefined.h>
#include <machine/vfp.h>
#include <machine/vmparam.h>

#ifdef FDT
#include <dev/fdt/fdt_common.h>
#include <machine/ofw_machdep.h>
#endif

#ifdef DEBUG
#define debugf(fmt, args...) printf(fmt, ##args)
#else
#define debugf(fmt, args...)
#endif

#if defined(COMPAT_FREEBSD4) || defined(COMPAT_FREEBSD5) || \
    defined(COMPAT_FREEBSD6) || defined(COMPAT_FREEBSD7) || \
    defined(COMPAT_FREEBSD9)
#error FreeBSD/arm doesn't provide compatibility with releases prior to 10
#endif


#if __ARM_ARCH < 7
#error FreeBSD requires ARMv7 or later
#endif

struct pcpu __pcpu[MAXCPU];
struct pcpu *pcpup = &__pcpu[0];

static struct trapframe proc0_tf;
uint32_t cpu_reset_address = 0;
int cold = 1;
vm_offset_t vector_page;

/* The address at which the kernel was loaded.  Set early in initarm(). */
vm_paddr_t arm_physmem_kernaddr;

#ifdef FDT
vm_paddr_t pmap_pa;
vm_offset_t systempage;
vm_offset_t irqstack;
vm_offset_t undstack;
vm_offset_t abtstack;
#endif /* FDT */

#ifdef PLATFORM
static delay_func *delay_impl;
static void *delay_arg;
#endif

#if defined(SOCDEV_PA)
#if !defined(SOCDEV_VA)
#error SOCDEV_PA defined, but not SOCDEV_VA
#endif
uintptr_t socdev_va = SOCDEV_VA;
#endif


struct kva_md_info kmi;
/*
 * arm32_vector_init:
 *
 *      Initialize the vector page, and select whether or not to
 *      relocate the vectors.
 *
 *      NOTE: We expect the vector page to be mapped at its expected
 *      destination.
 */

extern unsigned int page0[], page0_data[];
void
arm_vector_init(vm_offset_t va, int which)
{
        unsigned int *vectors = (int *) va;
        unsigned int *vectors_data = vectors + (page0_data - page0);
        int vec;

        /*
         * Loop through the vectors we're taking over, and copy the
         * vector's insn and data word.
         */
        for (vec = 0; vec < ARM_NVEC; vec++) {
                if ((which & (1 << vec)) == 0) {
                        /* Don't want to take over this vector. */
                        continue;
                }
                vectors[vec] = page0[vec];
                vectors_data[vec] = page0_data[vec];
        }

        /* Now sync the vectors. */
        icache_sync(va, (ARM_NVEC * 2) * sizeof(u_int));

        vector_page = va;
}

static void
cpu_startup(void *dummy)
{
        struct pcb *pcb = thread0.td_pcb;
        const unsigned int mbyte = 1024 * 1024;

        identify_arm_cpu();

        vm_ksubmap_init(&kmi);

        /*
         * Display the RAM layout.
         */
        printf("real memory  = %ju (%ju MB)\n",
            (uintmax_t)arm32_ptob(realmem),
            (uintmax_t)arm32_ptob(realmem) / mbyte);
        printf("avail memory = %ju (%ju MB)\n",
            (uintmax_t)arm32_ptob(vm_free_count()),
            (uintmax_t)arm32_ptob(vm_free_count()) / mbyte);
        if (bootverbose) {
                physmem_print_tables();
                devmap_print_table();
        }

        bufinit();
        vm_pager_bufferinit();
        pcb->pcb_regs.sf_sp = (u_int)thread0.td_kstack +
            USPACE_SVC_STACK_TOP;
        pmap_set_pcb_pagedir(kernel_pmap, pcb);
}

SYSINIT(cpu, SI_SUB_CPU, SI_ORDER_FIRST, cpu_startup, NULL);

/*
 * Flush the D-cache for non-DMA I/O so that the I-cache can
 * be made coherent later.
 */
void
cpu_flush_dcache(void *ptr, size_t len)
{

        dcache_wb_poc((vm_offset_t)ptr, (vm_paddr_t)vtophys(ptr), len);
}

/* Get current clock frequency for the given cpu id. */
int
cpu_est_clockrate(int cpu_id, uint64_t *rate)
{
        struct pcpu *pc;

        pc = pcpu_find(cpu_id);
        if (pc == NULL || rate == NULL)
                return (EINVAL);

        if (pc->pc_clock == 0)
                return (EOPNOTSUPP);

        *rate = pc->pc_clock;

        return (0);
}

void
cpu_idle(int busy)
{

        CTR2(KTR_SPARE2, "cpu_idle(%d) at %d", busy, curcpu);
        spinlock_enter();
        if (!busy)
                cpu_idleclock();
        if (!sched_runnable())
                cpu_sleep(0);
        if (!busy)
                cpu_activeclock();
        spinlock_exit();
        CTR2(KTR_SPARE2, "cpu_idle(%d) at %d done", busy, curcpu);
}

int
cpu_idle_wakeup(int cpu)
{

        return (0);
}

void
cpu_initclocks(void)
{

#ifdef SMP
        if (PCPU_GET(cpuid) == 0)
                cpu_initclocks_bsp();
        else
                cpu_initclocks_ap();
#else
        cpu_initclocks_bsp();
#endif
}

#ifdef PLATFORM
void
arm_set_delay(delay_func *impl, void *arg)
{

        KASSERT(impl != NULL, ("No DELAY implementation"));
        delay_impl = impl;
        delay_arg = arg;
}

void
DELAY(int usec)
{

        TSENTER();
        delay_impl(usec, delay_arg);
        TSEXIT();
}
#endif

void
cpu_pcpu_init(struct pcpu *pcpu, int cpuid, size_t size)
{

        pcpu->pc_mpidr = 0xffffffff;
}

void
spinlock_enter(void)
{
        struct thread *td;
        register_t cspr;

        td = curthread;
        if (td->td_md.md_spinlock_count == 0) {
                cspr = disable_interrupts(PSR_I);
                td->td_md.md_spinlock_count = 1;
                td->td_md.md_saved_cspr = cspr;
                critical_enter();
        } else
                td->td_md.md_spinlock_count++;
}

void
spinlock_exit(void)
{
        struct thread *td;
        register_t cspr;

        td = curthread;
        cspr = td->td_md.md_saved_cspr;
        td->td_md.md_spinlock_count--;
        if (td->td_md.md_spinlock_count == 0) {
                critical_exit();
                restore_interrupts(cspr);
        }
}

/*
 * Construct a PCB from a trapframe. This is called from kdb_trap() where
 * we want to start a backtrace from the function that caused us to enter
 * the debugger. We have the context in the trapframe, but base the trace
 * on the PCB. The PCB doesn't have to be perfect, as long as it contains
 * enough for a backtrace.
 */
void
makectx(struct trapframe *tf, struct pcb *pcb)
{
        pcb->pcb_regs.sf_r4 = tf->tf_r4;
        pcb->pcb_regs.sf_r5 = tf->tf_r5;
        pcb->pcb_regs.sf_r6 = tf->tf_r6;
        pcb->pcb_regs.sf_r7 = tf->tf_r7;
        pcb->pcb_regs.sf_r8 = tf->tf_r8;
        pcb->pcb_regs.sf_r9 = tf->tf_r9;
        pcb->pcb_regs.sf_r10 = tf->tf_r10;
        pcb->pcb_regs.sf_r11 = tf->tf_r11;
        pcb->pcb_regs.sf_r12 = tf->tf_r12;
        pcb->pcb_regs.sf_pc = tf->tf_pc;
        pcb->pcb_regs.sf_lr = tf->tf_usr_lr;
        pcb->pcb_regs.sf_sp = tf->tf_usr_sp;
}

void
pcpu0_init(void)
{
        set_curthread(&thread0);
        pcpu_init(pcpup, 0, sizeof(struct pcpu));
        pcpup->pc_mpidr = cp15_mpidr_get() & 0xFFFFFF;
        PCPU_SET(curthread, &thread0);
}

/*
 * Initialize proc0
 */
static void
init_proc0(vm_offset_t kstack)
{
        proc_linkup0(&proc0, &thread0);
        thread0.td_kstack = kstack;
        thread0.td_kstack_pages = kstack_pages;
        thread0.td_pcb = (struct pcb *)(thread0.td_kstack +
            thread0.td_kstack_pages * PAGE_SIZE) - 1;
        thread0.td_pcb->pcb_flags = 0;
        thread0.td_pcb->pcb_fpflags = 0;
        thread0.td_pcb->pcb_vfpcpu = -1;
        thread0.td_pcb->pcb_vfpstate.fpscr = VFPSCR_DN;
        thread0.td_pcb->pcb_vfpsaved = &thread0.td_pcb->pcb_vfpstate;
        thread0.td_frame = &proc0_tf;
        pcpup->pc_curpcb = thread0.td_pcb;
}

void
set_stackptrs(int cpu)
{

        set_stackptr(PSR_IRQ32_MODE,
            irqstack + ((IRQ_STACK_SIZE * PAGE_SIZE) * (cpu + 1)));
        set_stackptr(PSR_ABT32_MODE,
            abtstack + ((ABT_STACK_SIZE * PAGE_SIZE) * (cpu + 1)));
        set_stackptr(PSR_UND32_MODE,
            undstack + ((UND_STACK_SIZE * PAGE_SIZE) * (cpu + 1)));
}

static void
arm_kdb_init(void)
{

        kdb_init();
#ifdef KDB
        if (boothowto & RB_KDB)
                kdb_enter(KDB_WHY_BOOTFLAGS, "Boot flags requested debugger");
#endif
}

#ifdef FDT
static void
fdt_physmem_hardware_region_cb(const struct mem_region *mr, void *arg __unused)
{
        physmem_hardware_region(mr->mr_start, mr->mr_size);
}

static void
fdt_physmem_exclude_region_cb(const struct mem_region *mr, void *arg __unused)
{
        physmem_exclude_region(mr->mr_start, mr->mr_size,
            EXFLAG_NODUMP | EXFLAG_NOALLOC);
}

void *
initarm(struct arm_boot_params *abp)
{
        vm_paddr_t lastaddr;
        vm_offset_t dtbp, kernelstack, dpcpu;
        char *env;
        int err_devmap;
        phandle_t root;
        char dts_version[255];
#ifdef EFI
        struct efi_map_header *efihdr;
#endif

        /* get last allocated physical address */
        arm_physmem_kernaddr = abp->abp_physaddr;
        lastaddr = parse_boot_param(abp) - KERNVIRTADDR + arm_physmem_kernaddr;

        set_cpufuncs();
        cpuinfo_init();
        sched_instance_select();
        link_elf_ireloc();

        /*
         * Find the dtb passed in by the boot loader.
         */
        dtbp = MD_FETCH(preload_kmdp, MODINFOMD_DTBP, vm_offset_t);
#if defined(FDT_DTB_STATIC)
        /*
         * In case the device tree blob was not retrieved (from metadata) try
         * to use the statically embedded one.
         */
        if (dtbp == (vm_offset_t)NULL)
                dtbp = (vm_offset_t)&fdt_static_dtb;
#endif

        if (OF_install(OFW_FDT, 0) == FALSE)
                panic("Cannot install FDT");

        if (OF_init((void *)dtbp) != 0)
                panic("OF_init failed with the found device tree");

#if defined(LINUX_BOOT_ABI)
        arm_parse_fdt_bootargs();
#endif

#ifdef EFI
        efihdr = (struct efi_map_header *)preload_search_info(preload_kmdp,
            MODINFO_METADATA | MODINFOMD_EFI_MAP);
        if (efihdr != NULL) {
                efi_map_add_entries(efihdr);
                efi_map_exclude_entries(efihdr);
        } else
#endif
        {
                /* Grab physical memory regions information from device tree. */
                if (fdt_foreach_mem_region(fdt_physmem_hardware_region_cb,
                    NULL) != 0)
                        panic("Cannot get physical memory regions");

                /* Grab reserved memory regions information from device tree. */
                fdt_foreach_reserved_region(fdt_physmem_exclude_region_cb,
                    NULL);
        }

        /*
         * Set TEX remapping registers.
         * Setup kernel page tables and switch to kernel L1 page table.
         */
        pmap_set_tex();
        pmap_bootstrap_prepare(lastaddr);

        /*
         * If EARLY_PRINTF support is enabled, we need to re-establish the
         * mapping after pmap_bootstrap_prepare() switches to new page tables.
         * Note that we can only do the remapping if the VA is outside the
         * kernel, now that we have real virtual (not VA=PA) mappings in effect.
         * Early printf does not work between the time pmap_set_tex() does
         * cp15_prrr_set() and this code remaps the VA.
         */
#if defined(EARLY_PRINTF) && defined(SOCDEV_PA) && defined(SOCDEV_VA) && SOCDEV_VA < KERNBASE
        pmap_preboot_map_attr(SOCDEV_PA, SOCDEV_VA, 1024 * 1024, 
            VM_PROT_READ | VM_PROT_WRITE, VM_MEMATTR_DEVICE);
#endif

        /*
         * Now that proper page tables are installed, call cpu_setup() to enable
         * instruction and data caches and other chip-specific features.
         */
        cpu_setup();

        /* Platform-specific initialisation */
        platform_probe_and_attach();
        pcpu0_init();

        /* Do basic tuning, hz etc */
        init_param1();

        /*
         * Allocate a page for the system page mapped to 0xffff0000
         * This page will just contain the system vectors and can be
         * shared by all processes.
         */
        systempage = pmap_preboot_get_pages(1);

        /* Map the vector page. */
        pmap_preboot_map_pages(systempage, ARM_VECTORS_HIGH,  1);
        if (virtual_end >= ARM_VECTORS_HIGH)
                virtual_end = ARM_VECTORS_HIGH - 1;

        /* Allocate dynamic per-cpu area. */
        dpcpu = pmap_preboot_get_vpages(DPCPU_SIZE / PAGE_SIZE);
        dpcpu_init((void *)dpcpu, 0);

        /* Allocate stacks for all modes */
        irqstack    = pmap_preboot_get_vpages(IRQ_STACK_SIZE * MAXCPU);
        abtstack    = pmap_preboot_get_vpages(ABT_STACK_SIZE * MAXCPU);
        undstack    = pmap_preboot_get_vpages(UND_STACK_SIZE * MAXCPU );
        kernelstack = pmap_preboot_get_vpages(kstack_pages);

        /* Allocate message buffer. */
        msgbufp = (void *)pmap_preboot_get_vpages(
            round_page(msgbufsize) / PAGE_SIZE);

        /*
         * Pages were allocated during the secondary bootstrap for the
         * stacks for different CPU modes.
         * We must now set the r13 registers in the different CPU modes to
         * point to these stacks.
         * Since the ARM stacks use STMFD etc. we must set r13 to the top end
         * of the stack memory.
         */
        set_stackptrs(0);
        mutex_init();

        /* Establish static device mappings. */
        err_devmap = platform_devmap_init();
        devmap_bootstrap();
        vm_max_kernel_address = platform_lastaddr();

        /*
         * Only after the SOC registers block is mapped we can perform device
         * tree fixups, as they may attempt to read parameters from hardware.
         */
        OF_interpret("perform-fixup", 0);
        platform_gpio_init();
        cninit();

        /*
         * If we made a mapping for EARLY_PRINTF after pmap_bootstrap_prepare(),
         * undo it now that the normal console printf works.
         */
#if defined(EARLY_PRINTF) && defined(SOCDEV_PA) && defined(SOCDEV_VA) && SOCDEV_VA < KERNBASE
        pmap_kremove(SOCDEV_VA);
#endif

        debugf("initarm: console initialized\n");
        debugf(" arg1 kmdp = 0x%08x\n", (uint32_t)preload_kmdp);
        debugf(" boothowto = 0x%08x\n", boothowto);
        debugf(" dtbp = 0x%08x\n", (uint32_t)dtbp);
        debugf(" lastaddr1: 0x%08x\n", lastaddr);
        arm_print_kenv();

        env = kern_getenv("kernelname");
        if (env != NULL)
                strlcpy(kernelname, env, sizeof(kernelname));

        if (err_devmap != 0)
                printf("WARNING: could not fully configure devmap, error=%d\n",
                    err_devmap);

        platform_late_init();

        root = OF_finddevice("/");
        if (OF_getprop(root, "freebsd,dts-version", dts_version, sizeof(dts_version)) > 0) {
                if (strcmp(LINUX_DTS_VERSION, dts_version) != 0)
                        printf("WARNING: DTB version is %s while kernel expects %s, "
                            "please update the DTB in the ESP\n",
                            dts_version,
                            LINUX_DTS_VERSION);
        } else {
                printf("WARNING: Cannot find freebsd,dts-version property, "
                    "cannot check DTB compliance\n");
        }

        /*
         * We must now clean the cache again....
         * Cleaning may be done by reading new data to displace any
         * dirty data in the cache. This will have happened in cpu_setttb()
         * but since we are boot strapping the addresses used for the read
         * may have just been remapped and thus the cache could be out
         * of sync. A re-clean after the switch will cure this.
         * After booting there are no gross relocations of the kernel thus
         * this problem will not occur after initarm().
         */
        /* Set stack for exception handlers */
        undefined_init();
        init_proc0(kernelstack);
        arm_vector_init(ARM_VECTORS_HIGH, ARM_VEC_ALL);
        enable_interrupts(PSR_A);
        pmap_bootstrap(0);

        /* Exclude the kernel (and all the things we allocated which immediately
         * follow the kernel) from the VM allocation pool but not from crash
         * dumps.  virtual_avail is a global variable which tracks the kva we've
         * "allocated" while setting up pmaps.
         *
         * Prepare the list of physical memory available to the vm subsystem.
         */
        physmem_exclude_region(abp->abp_physaddr,
                pmap_preboot_get_pages(0) - abp->abp_physaddr, EXFLAG_NOALLOC);
        physmem_init_kernel_globals();

        init_param2(physmem);
        /* Init message buffer. */
        msgbufinit(msgbufp, msgbufsize);
        dbg_monitor_init();
        arm_kdb_init();
        /* Apply possible BP hardening. */
        cpuinfo_init_bp_hardening();

#ifdef EFI
        if (boothowto & RB_VERBOSE) {
                if (efihdr != NULL)
                        efi_map_print_entries(efihdr);
        }
#endif

        return (STACKALIGN(thread0.td_pcb));

}
#endif /* FDT */