/*      $NetBSD: sa11x0_hpc_machdep.c,v 1.23 2023/08/03 08:16:31 mrg Exp $      */

/*
 * 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 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.
 */

/*
 * Machine dependent functions for kernel setup.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: sa11x0_hpc_machdep.c,v 1.23 2023/08/03 08:16:31 mrg Exp $");

#include "opt_ddb.h"
#include "opt_dram_pages.h"
#include "opt_modular.h"
#include "ksyms.h"

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/reboot.h>
#include <sys/proc.h>
#include <sys/msgbuf.h>
#include <sys/exec.h>
#include <sys/ksyms.h>
#include <sys/conf.h>   /* XXX for consinit related hacks */
#include <sys/device.h>
#include <sys/termios.h>
#include <sys/bus.h>
#include <sys/cpu.h>
#include <sys/intr.h>

#if NKSYMS || defined(DDB) || defined(MODULAR)
#include <machine/db_machdep.h>
#include <ddb/db_sym.h>
#include <ddb/db_extern.h>
#include <sys/exec_elf.h>
#endif

#include <uvm/uvm.h>

#include <arm/arm32/machdep.h>
#include <arm/sa11x0/sa11x0_reg.h>
#include <arm/locore.h>
#include <arm/undefined.h>

#include <machine/bootconfig.h>
#include <machine/bootinfo.h>
#include <machine/io.h>
#include <machine/platid.h>
#include <machine/platid_mask.h>
#include <machine/rtc.h>
#include <machine/signal.h>

#include <dev/cons.h>
#include <dev/hpc/apm/apmvar.h>
#include <dev/hpc/bicons.h>

/* Kernel text starts 256K in from the bottom of the kernel address space. */
#define KERNEL_TEXT_BASE        (KERNEL_BASE + 0x00040000)
#define KERNEL_VM_BASE          (KERNEL_BASE + 0x00C00000)
#define KERNEL_VM_SIZE          0x05000000

extern BootConfig bootconfig;           /* Boot config storage */

extern paddr_t physical_start;
extern paddr_t physical_freestart;
extern paddr_t physical_freeend;
extern paddr_t physical_end;

extern paddr_t msgbufphys;

extern int end;

#define KERNEL_PT_VMEM          0       /* Page table for mapping video memory */
#define KERNEL_PT_SYS           1       /* Page table for mapping proc0 zero page */
#define KERNEL_PT_IO            2       /* Page table for mapping IO */
#define KERNEL_PT_KERNEL        3       /* Page table for mapping kernel */
#define KERNEL_PT_KERNEL_NUM    4
#define KERNEL_PT_VMDATA        (KERNEL_PT_KERNEL + KERNEL_PT_KERNEL_NUM)
                                        /* Page tables for mapping kernel VM */
#define KERNEL_PT_VMDATA_NUM    4       /* start with 16MB of KVM */
#define NUM_KERNEL_PTS          (KERNEL_PT_VMDATA + KERNEL_PT_VMDATA_NUM)

pv_addr_t kernel_pt_table[NUM_KERNEL_PTS];

#define CPU_SA110_CACHE_CLEAN_SIZE (0x4000 * 2)
extern unsigned int sa1_cache_clean_addr;
extern unsigned int sa1_cache_clean_size;
static vaddr_t sa1_cc_base;

/* Non-buffered non-cacheable memory needed to enter idle mode */
extern vaddr_t sa11x0_idle_mem;

/* Prototypes */
void data_abort_handler(trapframe_t *);
void prefetch_abort_handler(trapframe_t *);
void undefinedinstruction_bounce(trapframe_t *);
u_int cpu_get_control(void);

vaddr_t init_sa11x0(int, char **, struct bootinfo *);

#ifdef BOOT_DUMP
void    dumppages(char *, int);
#endif

#ifdef DEBUG_BEFOREMMU
static void fakecninit(void);
#endif

/* Mode dependent sleep function holder */
extern void (*__sleep_func)(void *);
extern void *__sleep_ctx;

/* Number of DRAM pages which are installed */
/* Units are 4K pages, so 8192 is 32 MB of memory */
#ifndef DRAM_PAGES
#define DRAM_PAGES      8192
#endif

/*
 * Static device mappings. These peripheral registers are mapped at
 * fixed virtual addresses very early in initarm() so that we can use
 * them while booting the kernel and stay at the same address
 * throughout whole kernel's life time.
 */
static const struct pmap_devmap sa11x0_devmap[] = {
        /* Physical/virtual address for UART #3. */
        DEVMAP_ENTRY(
                SACOM3_VBASE,
                SACOM3_BASE,
                0x24
        ),
        DEVMAP_ENTRY_END
};

/*
 * It should be responsible for setting up everything that must be
 * in place when main is called.
 * This includes:
 *   Initializing the physical console so characters can be printed.
 *   Setting up page tables for the kernel.
 */
vaddr_t
init_sa11x0(int argc, char **argv, struct bootinfo *bi)
{
        u_int kerneldatasize, symbolsize;
        u_int l1pagetable;
        vaddr_t freemempos;
        vsize_t pt_size;
        int loop;
#if NKSYMS || defined(DDB) || defined(MODULAR)
        Elf_Shdr *sh;
#endif

#ifdef DEBUG_BEFOREMMU
        /*
         * At this point, we cannot call real consinit().
         * Just call a faked up version of consinit(), which does the thing
         * with MMU disabled.
         */
        fakecninit();
#endif

        /*
         * XXX for now, overwrite bootconfig to hardcoded values.
         * XXX kill bootconfig and directly call uvm_physload
         */
        bootconfig.dram[0].address = 0xc0000000;
        bootconfig.dram[0].pages = DRAM_PAGES;
        bootconfig.dramblocks = 1;

        kerneldatasize = (uint32_t)&end - (uint32_t)KERNEL_TEXT_BASE;
        symbolsize = 0;
#if NKSYMS || defined(DDB) || defined(MODULAR)
        if (!memcmp(&end, "\177ELF", 4)) {
/*
 * XXXGCC12.
 * This accesses beyond what "int end" technically supplies.
 */
#pragma GCC push_options
#pragma GCC diagnostic ignored "-Warray-bounds"
                sh = (Elf_Shdr *)((char *)&end + ((Elf_Ehdr *)&end)->e_shoff);
#pragma GCC pop_options
                loop = ((Elf_Ehdr *)&end)->e_shnum;
                for (; loop; loop--, sh++)
                        if (sh->sh_offset > 0 &&
                            (sh->sh_offset + sh->sh_size) > symbolsize)
                                symbolsize = sh->sh_offset + sh->sh_size;
        }
#endif

        printf("kernsize=0x%x\n", kerneldatasize);
        kerneldatasize += symbolsize;
        kerneldatasize = ((kerneldatasize - 1) & ~(PAGE_SIZE * 4 - 1)) +
            PAGE_SIZE * 8;

        /*
         * hpcboot has loaded me with MMU disabled.
         * So create kernel page tables and enable MMU.
         */

        /*
         * Set up the variables that define the availability of physical
         * memory.
         */
        physical_start = bootconfig.dram[0].address;
        physical_freestart = physical_start
            + (KERNEL_TEXT_BASE - KERNEL_BASE) + kerneldatasize;
        physical_end = bootconfig.dram[bootconfig.dramblocks - 1].address
            + bootconfig.dram[bootconfig.dramblocks - 1].pages * PAGE_SIZE;
        physical_freeend = physical_end;

        for (loop = 0; loop < bootconfig.dramblocks; ++loop)
                physmem += bootconfig.dram[loop].pages;

        /* XXX handle UMA framebuffer memory */

        /* Use the first 256kB to allocate things */
        freemempos = KERNEL_BASE;
        memset((void *)KERNEL_BASE, 0, KERNEL_TEXT_BASE - KERNEL_BASE);

        /*
         * Right. We have the bottom meg of memory mapped to 0x00000000
         * so was can get at it. The kernel will occupy the start of it.
         * After the kernel/args we allocate some of the fixed page tables
         * we need to get the system going.
         * We allocate one page directory and NUM_KERNEL_PTS page tables
         * and store the physical addresses in the kernel_pt_table array.
         * Must remember that neither the page L1 or L2 page tables are the
         * same size as a page !
         *
         * Ok, the next bit of physical allocate may look complex but it is
         * simple really. I have done it like this so that no memory gets
         * wasted during the allocate of various pages and tables that are
         * all different sizes.
         * The start address will be page aligned.
         * We allocate the kernel page directory on the first free 16KB
         * boundary we find.
         * We allocate the kernel page tables on the first 1KB boundary we
         * find.  We allocate at least 9 PT's (12 currently).  This means
         * that in the process we KNOW that we will encounter at least one
         * 16KB boundary.
         *
         * Eventually if the top end of the memory gets used for process L1
         * page tables the kernel L1 page table may be moved up there.
         */

#ifdef VERBOSE_INIT_ARM
        printf("Allocating page tables\n");
#endif

        /* Define a macro to simplify memory allocation */
#define valloc_pages(var, np)                                           \
    do {                                                                \
        alloc_pages((var).pv_pa, (np));                                 \
        (var).pv_va = KERNEL_BASE + (var).pv_pa - physical_start;       \
    } while (0)
#define alloc_pages(var, np)                                            \
    do {                                                                \
        (var) = freemempos;                                             \
        freemempos += (np) * PAGE_SIZE;                                 \
        if (freemempos > KERNEL_TEXT_BASE)                              \
                panic("%s: out of memory", __func__);                   \
    } while (0)

        valloc_pages(kernel_l1pt, L1_TABLE_SIZE / PAGE_SIZE);
        for (loop = 0; loop < NUM_KERNEL_PTS; ++loop) {
                alloc_pages(kernel_pt_table[loop].pv_pa,
                    L2_TABLE_SIZE / PAGE_SIZE);
                kernel_pt_table[loop].pv_va = kernel_pt_table[loop].pv_pa;
        }

        /* This should never be able to happen but better confirm that. */
        if (!kernel_l1pt.pv_pa || (kernel_l1pt.pv_pa & (L1_TABLE_SIZE-1)) != 0)
                panic("initarm: Failed to align the kernel page directory");

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

        pt_size = round_page(freemempos) - physical_start;

        /* Allocate stacks for all modes */
        valloc_pages(irqstack, IRQ_STACK_SIZE);
        valloc_pages(abtstack, ABT_STACK_SIZE);
        valloc_pages(undstack, UND_STACK_SIZE);
        valloc_pages(kernelstack, UPAGES);

#ifdef VERBOSE_INIT_ARM
        printf("IRQ stack: p0x%08lx v0x%08lx\n", irqstack.pv_pa,
            irqstack.pv_va);
        printf("ABT stack: p0x%08lx v0x%08lx\n", abtstack.pv_pa,
            abtstack.pv_va);
        printf("UND stack: p0x%08lx v0x%08lx\n", undstack.pv_pa,
            undstack.pv_va);
        printf("SVC stack: p0x%08lx v0x%08lx\n", kernelstack.pv_pa,
            kernelstack.pv_va);
#endif

        alloc_pages(msgbufphys, round_page(MSGBUFSIZE) / PAGE_SIZE);

        /*
         * XXX Actually, we only need virtual space and don't need
         * XXX physical memory for sa110_cc_base and sa11x0_idle_mem.
         */
        /*
         * XXX totally stuffed hack to work round problems introduced
         * in recent versions of the pmap code. Due to the calls used there
         * we cannot allocate virtual memory during bootstrap.
         */
        for (;;) {
                alloc_pages(sa1_cc_base, 1);
                if (!(sa1_cc_base & (CPU_SA110_CACHE_CLEAN_SIZE - 1)))
                        break;
        }
        alloc_pages(sa1_cache_clean_addr, CPU_SA110_CACHE_CLEAN_SIZE / PAGE_SIZE - 1);

        sa1_cache_clean_addr = sa1_cc_base;
        sa1_cache_clean_size = CPU_SA110_CACHE_CLEAN_SIZE / 2;

        alloc_pages(sa11x0_idle_mem, 1);

        /*
         * Ok, we have allocated physical pages for the primary kernel
         * page tables.
         */

#ifdef VERBOSE_INIT_ARM
        printf("Creating L1 page table\n");
#endif

        /*
         * Now we start construction of the L1 page table.
         * We start by mapping the L2 page tables into the L1.
         * This means that we can replace L1 mappings later on if necessary.
         */
        l1pagetable = kernel_l1pt.pv_pa;

        /* Map the L2 pages tables in the L1 page table */
        pmap_link_l2pt(l1pagetable, 0x00000000,
            &kernel_pt_table[KERNEL_PT_SYS]);
#define SAIPIO_BASE             0xd0000000              /* XXX XXX */
        pmap_link_l2pt(l1pagetable, SAIPIO_BASE,
            &kernel_pt_table[KERNEL_PT_IO]);
        for (loop = 0; loop < KERNEL_PT_KERNEL_NUM; ++loop)
                pmap_link_l2pt(l1pagetable, KERNEL_BASE + loop * 0x00400000,
                    &kernel_pt_table[KERNEL_PT_KERNEL + loop]);
        for (loop = 0; loop < KERNEL_PT_VMDATA_NUM; ++loop)
                pmap_link_l2pt(l1pagetable, KERNEL_VM_BASE + loop * 0x00400000,
                    &kernel_pt_table[KERNEL_PT_VMDATA + loop]);

        /* update the top of the kernel VM */
        pmap_curmaxkvaddr =
            KERNEL_VM_BASE + (KERNEL_PT_VMDATA_NUM * 0x00400000);

#ifdef VERBOSE_INIT_ARM
        printf("Mapping kernel\n");
#endif

        /* Now we fill in the L2 pagetable for the kernel code/data */

        /*
         * XXX there is no ELF header to find RO region.
         * XXX What should we do?
         */
#if 0
        if (N_GETMAGIC(kernexec[0]) == ZMAGIC) {
                logical = pmap_map_chunk(l1pagetable, KERNEL_TEXT_BASE,
                    physical_start, kernexec->a_text,
                    VM_PROT_READ, PTE_CACHE);
                logical += pmap_map_chunk(l1pagetable,
                    KERNEL_TEXT_BASE + logical, physical_start + logical,
                    kerneldatasize - kernexec->a_text,
                    VM_PROT_READ|VM_PROT_WRITE, PTE_CACHE);
        } else
#endif
                pmap_map_chunk(l1pagetable, KERNEL_TEXT_BASE,
                    KERNEL_TEXT_BASE - KERNEL_BASE + physical_start,
                    kerneldatasize, VM_PROT_READ|VM_PROT_WRITE, PTE_CACHE);

#ifdef VERBOSE_INIT_ARM
        printf("Constructing L2 page tables\n");
#endif

        /* Map the stack pages */
        pmap_map_chunk(l1pagetable, irqstack.pv_va, irqstack.pv_pa,
            IRQ_STACK_SIZE * PAGE_SIZE, VM_PROT_READ|VM_PROT_WRITE, PTE_CACHE);
        pmap_map_chunk(l1pagetable, abtstack.pv_va, abtstack.pv_pa,
            ABT_STACK_SIZE * PAGE_SIZE, VM_PROT_READ|VM_PROT_WRITE, PTE_CACHE);
        pmap_map_chunk(l1pagetable, undstack.pv_va, undstack.pv_pa,
            UND_STACK_SIZE * PAGE_SIZE, VM_PROT_READ|VM_PROT_WRITE, PTE_CACHE);
        pmap_map_chunk(l1pagetable, kernelstack.pv_va, kernelstack.pv_pa,
            UPAGES * PAGE_SIZE, VM_PROT_READ|VM_PROT_WRITE, PTE_CACHE);

        pmap_map_chunk(l1pagetable, kernel_l1pt.pv_va, kernel_l1pt.pv_pa,
            L1_TABLE_SIZE, VM_PROT_READ|VM_PROT_WRITE, PTE_PAGETABLE);

        /* Map page tables */
        pmap_map_chunk(l1pagetable, KERNEL_BASE, physical_start, pt_size,
            VM_PROT_READ|VM_PROT_WRITE, PTE_PAGETABLE);

        /* Map a page for entering idle mode */
        pmap_map_entry(l1pagetable, sa11x0_idle_mem, sa11x0_idle_mem,
            VM_PROT_READ|VM_PROT_WRITE, PTE_NOCACHE);

        /* Map the vector page. */
        pmap_map_entry(l1pagetable, vector_page, systempage.pv_pa,
            VM_PROT_READ|VM_PROT_WRITE, PTE_CACHE);

        /* Map the statically mapped devices. */
        pmap_devmap_bootstrap(l1pagetable, sa11x0_devmap);

        pmap_map_chunk(l1pagetable, sa1_cache_clean_addr, 0xe0000000,
            CPU_SA110_CACHE_CLEAN_SIZE, VM_PROT_READ|VM_PROT_WRITE, PTE_CACHE);

        /*
         * Now we have the real page tables in place so we can switch to them.
         * Once this is done we will be running with the REAL kernel page
         * tables.
         */

#ifdef VERBOSE_INIT_ARM
        printf("done.\n");
#endif

        /*
         * 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.
         */
#ifdef VERBOSE_INIT_ARM
        printf("init subsystems: stacks ");
#endif

        set_stackptr(PSR_IRQ32_MODE,
            irqstack.pv_va + IRQ_STACK_SIZE * PAGE_SIZE);
        set_stackptr(PSR_ABT32_MODE,
            abtstack.pv_va + ABT_STACK_SIZE * PAGE_SIZE);
        set_stackptr(PSR_UND32_MODE,
            undstack.pv_va + UND_STACK_SIZE * PAGE_SIZE);
#ifdef VERBOSE_INIT_ARM
        printf("kstack V%08lx P%08lx\n", kernelstack.pv_va,
            kernelstack.pv_pa);
#endif /* VERBOSE_INIT_ARM */

        /*
         * Well we should set a data abort handler.
         * Once things get going this will change as we will need a proper
         * handler. Until then we will use a handler that just panics but
         * tells us why.
         * Initialization of the vectors will just panic on a data abort.
         * This just fills in a slightly better one.
         */
#ifdef VERBOSE_INIT_ARM
        printf("vectors ");
#endif
        data_abort_handler_address = (u_int)data_abort_handler;
        prefetch_abort_handler_address = (u_int)prefetch_abort_handler;
        undefined_handler_address = (u_int)undefinedinstruction_bounce;
#ifdef DEBUG
        printf("%08x %08x %08x\n", data_abort_handler_address,
            prefetch_abort_handler_address, undefined_handler_address);
#endif

        /* Initialize the undefined instruction handlers */
#ifdef VERBOSE_INIT_ARM
        printf("undefined\n");
#endif
        undefined_init();

        /* Set the page table address. */
#ifdef VERBOSE_INIT_ARM
        printf("switching to new L1 page table  @%#lx...\n", kernel_l1pt.pv_pa);
#endif
        cpu_domains((DOMAIN_CLIENT << (PMAP_DOMAIN_KERNEL*2)) | DOMAIN_CLIENT);
        cpu_setttb(kernel_l1pt.pv_pa, true);
        cpu_tlb_flushID();
        cpu_domains(DOMAIN_CLIENT << (PMAP_DOMAIN_KERNEL*2));

        /*
         * Moved from cpu_startup() as data_abort_handler() references
         * this during uvm init.
         */
        uvm_lwp_setuarea(&lwp0, kernelstack.pv_va);

#ifdef BOOT_DUMP
        dumppages((char *)0xc0000000, 16 * PAGE_SIZE);
        dumppages((char *)0xb0100000, 64); /* XXX */
#endif
        /* Enable MMU, I-cache, D-cache, write buffer. */
        cpufunc_control(0x337f, 0x107d);

        arm32_vector_init(ARM_VECTORS_LOW, ARM_VEC_ALL);

        consinit();

#ifdef VERBOSE_INIT_ARM
        printf("bootstrap done.\n");
#endif

#ifdef VERBOSE_INIT_ARM
        printf("freemempos=%08lx\n", freemempos);
        printf("MMU enabled. control=%08x\n", cpu_get_control());
#endif

        /* Load memory into UVM. */
        uvm_md_init();
        for (loop = 0; loop < bootconfig.dramblocks; loop++) {
                paddr_t dblk_start = (paddr_t)bootconfig.dram[loop].address;
                paddr_t dblk_end = dblk_start
                        + (bootconfig.dram[loop].pages * PAGE_SIZE);

                if (dblk_start < physical_freestart)
                        dblk_start = physical_freestart;
                if (dblk_end > physical_freeend)
                        dblk_end = physical_freeend;

                uvm_page_physload(atop(dblk_start), atop(dblk_end),
                    atop(dblk_start), atop(dblk_end), VM_FREELIST_DEFAULT);
        }

        /* Boot strap pmap telling it where managed kernel virtual memory is */
        pmap_bootstrap(KERNEL_VM_BASE, KERNEL_VM_BASE + KERNEL_VM_SIZE);

#ifdef BOOT_DUMP
        dumppages((char *)kernel_l1pt.pv_va, 16);
#endif

#ifdef DDB
        db_machine_init();
#endif
#if NKSYMS || defined(DDB) || defined(MODULAR)
        ksyms_addsyms_elf(symbolsize, ((int *)&end), ((char *)&end) + symbolsize);
#endif

        printf("kernsize=0x%x", kerneldatasize);
        printf(" (including 0x%x symbols)\n", symbolsize);

#ifdef DDB
        if (boothowto & RB_KDB)
                Debugger();
#endif /* DDB */

        /* We return the new stack pointer address */
        return kernelstack.pv_va + USPACE_SVC_STACK_TOP;
}

void
consinit(void)
{
        static int consinit_called = 0;

        if (consinit_called != 0)
                return;

        consinit_called = 1;
        if (bootinfo->bi_cnuse == BI_CNUSE_SERIAL) {
                cninit();
        }
}

#ifdef DEBUG_BEFOREMMU
cons_decl(sacom);

static void
fakecninit(void)
{
        static struct consdev fakecntab = cons_init(sacom);
        cn_tab = &fakecntab;

        (*cn_tab->cn_init)(0);
        cn_tab->cn_pri = CN_REMOTE;
}
#endif