/*      $NetBSD: bios32.c,v 1.7 2021/07/24 20:45:45 jmcneill Exp $      */

/*
 * Copyright (c) 1999 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
 * NASA Ames Research Center.
 *
 * 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
 */

/*
 * Copyright (c) 1999, by UCHIYAMA Yasushi
 * 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. The name of the developer may NOT be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * 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.
 */

/*
 * Copyright (c) 1997-2001 Michael Shalayeff
 * 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 OR HIS RELATIVES 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 MIND, 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.
 */

/*
 * Basic interface to BIOS32 services.
 */

#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: bios32.c,v 1.7 2021/07/24 20:45:45 jmcneill Exp $");

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/device.h>

#include <dev/isa/isareg.h>
#include <machine/isa_machdep.h>

#include <machine/segments.h>
#include <machine/bios32.h>
#include <dev/smbiosvar.h>
#include <x86/smbios_machdep.h>
#include <x86/efi.h>

#include <uvm/uvm.h>

#include "ipmi.h"
#include "opt_xen.h"

#define BIOS32_START    0xe0000
#define BIOS32_SIZE     0x20000
#define BIOS32_END      (BIOS32_START + BIOS32_SIZE - 0x10)

struct bios32_entry bios32_entry;

static void smbios2_map_kva(const uint8_t *);
static void smbios3_map_kva(const uint8_t *);

/*
 * Initialize the BIOS32 interface.
 */
void
bios32_init(void)
{
        uint8_t *p;
#ifdef i386
        paddr_t entry = 0;
        unsigned char cksum;
        int i;

        for (p = (uint8_t *)ISA_HOLE_VADDR(BIOS32_START);
             p < (uint8_t *)ISA_HOLE_VADDR(BIOS32_END);
             p += 16) {
                if (*(int *)p != BIOS32_MAKESIG('_', '3', '2', '_'))
                        continue;

                cksum = 0;
                for (i = 0; i < 16; i++)
                        cksum += *(unsigned char *)(p + i);
                if (cksum != 0)
                        continue;

                if (*(p + 9) != 1)
                        continue;

                entry = *(uint32_t *)(p + 4);

                aprint_debug("BIOS32 rev. %d found at 0x%lx\n",
                    *(p + 8), (u_long)entry);

                if (entry < BIOS32_START ||
                    entry >= BIOS32_END) {
                        aprint_error("BIOS32 entry point outside "
                            "allowable range\n");
                        entry = 0;
                }
                break;
        }

        if (entry != 0) {
                bios32_entry.offset = (void *)ISA_HOLE_VADDR(entry);
                bios32_entry.segment = GSEL(GCODE_SEL, SEL_KPL);
        }
#endif

        /* see if we have SMBIOS extensions */
#ifndef XENPV
        if (efi_probe()) {
                p = efi_getcfgtbl(&EFI_UUID_SMBIOS3);
                if (p != NULL && smbios3_check_header(p)) {
                        smbios3_map_kva(p);
                        return;
                }
                p = efi_getcfgtbl(&EFI_UUID_SMBIOS);
                if (p != NULL && smbios2_check_header(p)) {
                        smbios2_map_kva(p);
                        return;
                }
        }
#endif
        for (p = ISA_HOLE_VADDR(SMBIOS_START);
            p < (uint8_t *)ISA_HOLE_VADDR(SMBIOS_END); p+= 16) {
                if (smbios3_check_header(p)) {
                        smbios3_map_kva(p);
                        return;
                }
                if (smbios2_check_header(p)) {
                        smbios2_map_kva(p);
                        return;
                }
        }
}

/*
 * Call BIOS32 to locate the specified BIOS32 service, and fill
 * in the entry point information.
 */
int
bios32_service(uint32_t service, bios32_entry_t e, bios32_entry_info_t ei)
{
#ifdef i386
        uint32_t eax, ebx, ecx, edx;
        paddr_t entry;

        if (bios32_entry.offset == 0)
                return 0;       /* BIOS32 not present */

        __asm volatile("lcall *(%%edi)"
                : "=a" (eax), "=b" (ebx), "=c" (ecx), "=d" (edx)
                : "0" (service), "1" (0), "D" (&bios32_entry));

        if ((eax & 0xff) != 0)
                return 0;       /* service not found */

        entry = ebx + edx;

        if (entry < BIOS32_START || entry >= BIOS32_END) {
                aprint_error("BIOS32: entry point for service %c%c%c%c is "
                    "outside allowable range\n",
                    service & 0xff,
                    (service >> 8) & 0xff,
                    (service >> 16) & 0xff,
                    (service >> 24) & 0xff);
                return 0;
        }

        e->offset = (void *)ISA_HOLE_VADDR(entry);
        e->segment = GSEL(GCODE_SEL, SEL_KPL);

        ei->bei_base = ebx;
        ei->bei_size = ecx;
        ei->bei_entry = entry;
#else
        (void)service;
        (void)e;
        (void)ei;
        panic("bios32_service not implemented on amd64");
#endif

        return 1;
}

static void
smbios2_map_kva(const uint8_t *p)
{
        const struct smbhdr *sh = (const struct smbhdr *)p;
        paddr_t pa, end;
        vaddr_t eva;

        pa = trunc_page(sh->addr);
        end = round_page(sh->addr + sh->size);
        eva = uvm_km_alloc(kernel_map, end - pa, 0, UVM_KMF_VAONLY);
        if (eva == 0)
                return;

        smbios_entry.hdrphys = vtophys((vaddr_t)p);
        smbios_entry.tabphys = sh->addr;
        smbios_entry.addr = (uint8_t *)(eva + (sh->addr & PGOFSET));
        smbios_entry.len = sh->size;
        smbios_entry.rev = 0;
        smbios_entry.mjr = sh->majrev;
        smbios_entry.min = sh->minrev;
        smbios_entry.doc = 0;
        smbios_entry.count = sh->count;

        for (; pa < end; pa+= NBPG, eva+= NBPG)
#ifdef XENPV
                pmap_kenter_ma(eva, pa, VM_PROT_READ, 0);
#else
                pmap_kenter_pa(eva, pa, VM_PROT_READ, 0);
#endif
        pmap_update(pmap_kernel());

        aprint_debug("SMBIOS rev. %d.%d @ 0x%lx (%d entries)\n",
            sh->majrev, sh->minrev, (u_long)sh->addr, sh->count);
}

static void
smbios3_map_kva(const uint8_t *p)
{
        const struct smb3hdr *sh = (const struct smb3hdr *)p;
        paddr_t pa, end;
        vaddr_t eva;

        pa = trunc_page(sh->addr);
        end = round_page(sh->addr + sh->size);
        eva = uvm_km_alloc(kernel_map, end - pa, 0, UVM_KMF_VAONLY);
        if (eva == 0)
                return;

        smbios_entry.hdrphys = vtophys((vaddr_t)p);
        smbios_entry.tabphys = sh->addr;
        smbios_entry.addr = (uint8_t *)(eva + ((vaddr_t)sh->addr & PGOFSET));
        smbios_entry.len = sh->size;
        smbios_entry.rev = sh->eprev;
        smbios_entry.mjr = sh->majrev;
        smbios_entry.min = sh->minrev;
        smbios_entry.doc = sh->docrev;
        smbios_entry.count = UINT16_MAX;

        for (; pa < end; pa += NBPG, eva += NBPG)
#ifdef XENPV
                pmap_kenter_ma(eva, pa, VM_PROT_READ, 0);
#else
                pmap_kenter_pa(eva, pa, VM_PROT_READ, 0);
#endif
        pmap_update(pmap_kernel());

        aprint_debug("SMBIOS rev. %d.%d.%d @ 0x%lx\n", sh->majrev,
            sh->minrev, sh->docrev, (u_long)sh->addr);
}