/*-
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (c) 2001 Takanori Watanabe <takawata@jp.freebsd.org>
 * Copyright (c) 2001-2012 Mitsuru IWASAKI <iwasaki@jp.freebsd.org>
 * Copyright (c) 2003 Peter Wemm
 * Copyright (c) 2008-2012 Jung-uk Kim <jkim@FreeBSD.org>
 * 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 AND CONTRIBUTORS ``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.
 */

#include <sys/cdefs.h>
#include "opt_apic.h"

#include <sys/param.h>
#include <sys/bus.h>
#include <sys/eventhandler.h>
#include <sys/kernel.h>
#include <sys/malloc.h>
#include <sys/memrange.h>
#include <sys/smp.h>
#include <sys/systm.h>
#include <sys/cons.h>

#include <vm/vm.h>
#include <vm/pmap.h>

#include <machine/clock.h>
#include <machine/cpu.h>
#include <machine/intr_machdep.h>
#include <machine/md_var.h>
#include <x86/mca.h>
#include <machine/pcb.h>
#include <machine/specialreg.h>
#include <x86/ucode.h>

#ifdef DEV_APIC
#include <x86/apicreg.h>
#include <x86/apicvar.h>
#endif
#ifdef SMP
#include <machine/smp.h>
#include <machine/vmparam.h>
#endif

#include <contrib/dev/acpica/include/acpi.h>

#include <dev/acpica/acpivar.h>

#include "acpi_wakecode.h"
#include "acpi_wakedata.h"

/* Make sure the code is less than a page and leave room for the stack. */
CTASSERT(sizeof(wakecode) < PAGE_SIZE - 1024);

extern int              acpi_resume_beep;
extern int              acpi_reset_video;
extern int              acpi_susp_bounce;

#ifdef SMP
extern struct susppcb   **susppcbs;
static cpuset_t         suspcpus;
#else
static struct susppcb   **susppcbs;
#endif

static void             acpi_stop_beep(void *, enum power_stype);

#ifdef SMP
static int              acpi_wakeup_ap(struct acpi_softc *, int);
static void             acpi_wakeup_cpus(struct acpi_softc *);
#endif

#define ACPI_WAKEPAGES  1

#define WAKECODE_FIXUP(offset, type, val)       do {    \
        type    *addr;                                  \
        addr = (type *)(sc->acpi_wakeaddr + (offset));  \
        *addr = val;                                    \
} while (0)

static void
acpi_stop_beep(void *arg, enum power_stype stype)
{

        if (acpi_resume_beep != 0)
                timer_spkr_release();
}

#ifdef SMP
static int
acpi_wakeup_ap(struct acpi_softc *sc, int cpu)
{
        struct pcb *pcb;
        int             vector = (sc->acpi_wakephys >> 12) & 0xff;
        int             apic_id = cpu_apic_ids[cpu];
        int             ms;

        pcb = &susppcbs[cpu]->sp_pcb;
        WAKECODE_FIXUP(wakeup_pcb, struct pcb *, pcb);
        WAKECODE_FIXUP(wakeup_gdt, uint16_t, pcb->pcb_gdt.rd_limit);
        WAKECODE_FIXUP(wakeup_gdt + 2, uint64_t, pcb->pcb_gdt.rd_base);

        ipi_startup(apic_id, vector);

        /* Wait up to 5 seconds for it to resume. */
        for (ms = 0; ms < 5000; ms++) {
                if (!CPU_ISSET(cpu, &suspended_cpus))
                        return (1);     /* return SUCCESS */
                DELAY(1000);
        }
        return (0);             /* return FAILURE */
}

#define WARMBOOT_TARGET         0
#define WARMBOOT_OFF            (PMAP_MAP_LOW + 0x0467)
#define WARMBOOT_SEG            (PMAP_MAP_LOW + 0x0469)

#define CMOS_REG                (0x70)
#define CMOS_DATA               (0x71)
#define BIOS_RESET              (0x0f)
#define BIOS_WARM               (0x0a)

static void
acpi_wakeup_cpus(struct acpi_softc *sc)
{
        uint32_t        mpbioswarmvec;
        int             cpu;
        u_char          mpbiosreason;

        /* save the current value of the warm-start vector */
        mpbioswarmvec = *((uint32_t *)WARMBOOT_OFF);
        outb(CMOS_REG, BIOS_RESET);
        mpbiosreason = inb(CMOS_DATA);

        /* setup a vector to our boot code */
        *((volatile u_short *)WARMBOOT_OFF) = WARMBOOT_TARGET;
        *((volatile u_short *)WARMBOOT_SEG) = sc->acpi_wakephys >> 4;
        outb(CMOS_REG, BIOS_RESET);
        outb(CMOS_DATA, BIOS_WARM);     /* 'warm-start' */

        /* Wake up each AP. */
        for (cpu = 1; cpu < mp_ncpus; cpu++) {
                if (!CPU_ISSET(cpu, &suspcpus))
                        continue;
                if (acpi_wakeup_ap(sc, cpu) == 0) {
                        /* restore the warmstart vector */
                        *(uint32_t *)WARMBOOT_OFF = mpbioswarmvec;
                        panic("acpi_wakeup: failed to resume AP #%d (PHY #%d)",
                            cpu, cpu_apic_ids[cpu]);
                }
        }

        /*
         * Remove the identity mapping of low memory for all CPUs and sync
         * the TLB for the BSP.  The APs are now spinning in
         * cpususpend_handler() and we will release them soon.  Then each
         * will invalidate its TLB.
         */
        pmap_remap_lowptdi(false);

        /* restore the warmstart vector */
        *(uint32_t *)WARMBOOT_OFF = mpbioswarmvec;

        outb(CMOS_REG, BIOS_RESET);
        outb(CMOS_DATA, mpbiosreason);
}
#endif

int
acpi_sleep_machdep(struct acpi_softc *sc, int state)
{
        ACPI_STATUS     status;
        struct pcb      *pcb;

        if (sc->acpi_wakeaddr == 0ul)
                return (-1);    /* couldn't alloc wake memory */

#ifdef SMP
        suspcpus = all_cpus;
        CPU_CLR(PCPU_GET(cpuid), &suspcpus);
#endif

        if (acpi_resume_beep != 0)
                timer_spkr_acquire();

        AcpiSetFirmwareWakingVector(sc->acpi_wakephys, 0);

        intr_suspend();

        pcb = &susppcbs[0]->sp_pcb;
        if (savectx(pcb)) {
                npxsuspend(susppcbs[0]->sp_fpususpend);
#ifdef SMP
                if (!CPU_EMPTY(&suspcpus) && suspend_cpus(suspcpus) == 0) {
                        device_printf(sc->acpi_dev, "Failed to suspend APs\n");
                        return (0);     /* couldn't sleep */
                }
#endif

                WAKECODE_FIXUP(resume_beep, uint8_t, (acpi_resume_beep != 0));
                WAKECODE_FIXUP(reset_video, uint8_t, (acpi_reset_video != 0));

                if ((amd_feature & AMDID_NX) != 0)
                        WAKECODE_FIXUP(wakeup_efer, uint64_t, rdmsr(MSR_EFER));
                WAKECODE_FIXUP(wakeup_cr4, register_t, pcb->pcb_cr4);
                WAKECODE_FIXUP(wakeup_pcb, struct pcb *, pcb);
                WAKECODE_FIXUP(wakeup_gdt, uint16_t, pcb->pcb_gdt.rd_limit);
                WAKECODE_FIXUP(wakeup_gdt + 2, uint64_t, pcb->pcb_gdt.rd_base);

                /*
                 * Map some low memory with virt == phys for ACPI wakecode
                 * to use to jump to high memory after enabling paging. This
                 * is the same as for similar jump in locore, except the
                 * jump is a single instruction, and we know its address
                 * more precisely so only need a single PTD, and we have to
                 * be careful to use the kernel map (PTD[0] is for curthread
                 * which may be a user thread in deprecated APIs).
                 */
                pmap_remap_lowptdi(true);

                /* Call ACPICA to enter the desired sleep state */
                if (state == ACPI_STATE_S4 && acpi_should_do_s4bios(sc))
                        status = AcpiEnterSleepStateS4bios();
                else
                        status = AcpiEnterSleepState(state);
                if (ACPI_FAILURE(status)) {
                        device_printf(sc->acpi_dev,
                            "AcpiEnterSleepState failed - %s\n",
                            AcpiFormatException(status));
                        return (0);     /* couldn't sleep */
                }

                if (acpi_susp_bounce)
                        resumectx(pcb);

                for (;;)
                        ia32_pause();
        } else {
                /*
                 * Re-initialize console hardware as soon as possibe.
                 * No console output (e.g. printf) is allowed before
                 * this point.
                 */
                cnresume();
                npxresume(susppcbs[0]->sp_fpususpend);
        }

        return (1);     /* wakeup successfully */
}

int
acpi_wakeup_machdep(struct acpi_softc *sc, int state, int sleep_result,
    int intr_enabled)
{

        if (sleep_result == -1)
                return (sleep_result);

        if (!intr_enabled) {
                /* Wakeup MD procedures in interrupt disabled context */
                if (sleep_result == 1) {
                        ucode_reload();
                        pmap_init_pat();
                        initializecpu();
                        PCPU_SET(switchtime, 0);
                        PCPU_SET(switchticks, ticks);
#ifdef DEV_APIC
                        lapic_xapic_mode();
#endif
#ifdef SMP
                        if (!CPU_EMPTY(&suspcpus))
                                acpi_wakeup_cpus(sc);
#endif
                }

#ifdef SMP
                if (!CPU_EMPTY(&suspcpus))
                        resume_cpus(suspcpus);
#endif
                mca_resume();
                intr_resume(/*suspend_cancelled*/false);

                AcpiSetFirmwareWakingVector(0, 0);
        } else {
                /* Wakeup MD procedures in interrupt enabled context */
                if (sleep_result == 1 && mem_range_softc.mr_op != NULL &&
                    mem_range_softc.mr_op->reinit != NULL)
                        mem_range_softc.mr_op->reinit(&mem_range_softc);
        }

        return (sleep_result);
}

static void *
acpi_alloc_wakeup_handler(void *wakepages[ACPI_WAKEPAGES])
{
        int             i;

        memset(wakepages, 0, ACPI_WAKEPAGES * sizeof(*wakepages));

        /*
         * Specify the region for our wakeup code.  We want it in the low 1 MB
         * region, excluding real mode IVT (0-0x3ff), BDA (0x400-0x4ff), EBDA
         * (less than 128KB, below 0xa0000, must be excluded by SMAP and DSDT),
         * and ROM area (0xa0000 and above).  The temporary page tables must be
         * page-aligned.
         */
        for (i = 0; i < ACPI_WAKEPAGES; i++) {
                wakepages[i] = contigmalloc(PAGE_SIZE, M_DEVBUF,
                    M_NOWAIT | M_EXEC, 0x500, 0xa0000, PAGE_SIZE, 0ul);
                if (wakepages[i] == NULL) {
                        printf("%s: can't alloc wake memory\n", __func__);
                        goto freepages;
                }
        }
        if (EVENTHANDLER_REGISTER(power_resume, acpi_stop_beep, NULL,
            EVENTHANDLER_PRI_LAST) == NULL) {
                printf("%s: can't register event handler\n", __func__);
                goto freepages;
        }
        susppcbs = malloc(mp_ncpus * sizeof(*susppcbs), M_DEVBUF, M_WAITOK);
        for (i = 0; i < mp_ncpus; i++) {
                susppcbs[i] = malloc(sizeof(**susppcbs), M_DEVBUF, M_WAITOK);
                susppcbs[i]->sp_fpususpend = alloc_fpusave(M_WAITOK);
        }

        return (wakepages);

freepages:
        for (i = 0; i < ACPI_WAKEPAGES; i++)
                free(wakepages[i], M_DEVBUF);
        return (NULL);
}

void
acpi_install_wakeup_handler(struct acpi_softc *sc)
{
        static void *wakeaddr;
        void *wakepages[ACPI_WAKEPAGES];

        if (wakeaddr != NULL)
                return;

        if (acpi_alloc_wakeup_handler(wakepages) == NULL)
                return;

        wakeaddr = wakepages[0];
        sc->acpi_wakeaddr = (vm_offset_t)wakeaddr;
        sc->acpi_wakephys = vtophys(wakeaddr);

        bcopy(wakecode, (void *)sc->acpi_wakeaddr, sizeof(wakecode));

        /* Patch GDT base address, ljmp targets. */
        WAKECODE_FIXUP((bootgdtdesc + 2), uint32_t,
            sc->acpi_wakephys + bootgdt);
        WAKECODE_FIXUP((wakeup_sw32 + 2), uint32_t,
            sc->acpi_wakephys + wakeup_32);

        /* Save pointers to some global data. */
        WAKECODE_FIXUP(wakeup_ret, void *, resumectx);
        WAKECODE_FIXUP(wakeup_cr3, register_t, pmap_get_kcr3());

        if (bootverbose)
                device_printf(sc->acpi_dev, "wakeup code va %#jx pa %#jx\n",
                    (uintmax_t)sc->acpi_wakeaddr, (uintmax_t)sc->acpi_wakephys);
}