/*      $OpenBSD: smbios.c,v 1.8 2022/10/29 20:35:50 kettenis Exp $     */
/*
 * Copyright (c) 2006 Gordon Willem Klok <gklok@cogeco.ca>
 * Copyright (c) 2019 Mark Kettenis <kettenis@openbsd.org>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

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

#include <machine/bus.h>
#include <machine/fdt.h>
#include <machine/smbiosvar.h>

#include <dev/ofw/fdt.h>

struct smbios_entry smbios_entry;

const char *smbios_uninfo[] = {
        "System",
        "Not ",
        "To be",
        "SYS-"
};

char smbios_bios_date[64];
char smbios_board_vendor[64];
char smbios_board_prod[64];
char smbios_board_serial[64];

void smbios_info(char *);
char *fixstring(char *);

struct smbios_softc {
        struct device   sc_dev;
        bus_space_tag_t sc_iot;
};

int     smbios_match(struct device *, void *, void *);
void    smbios_attach(struct device *, struct device *, void *);

const struct cfattach smbios_ca = {
        sizeof(struct device), smbios_match, smbios_attach
};

struct cfdriver smbios_cd = {
        NULL, "smbios", DV_DULL
};

int
smbios_match(struct device *parent, void *match, void *aux)
{
        struct fdt_attach_args *faa = aux;

        return (strcmp(faa->fa_name, "smbios") == 0);
}

void
smbios_attach(struct device *parent, struct device *self, void *aux)
{
        struct smbios_softc *sc = (struct smbios_softc *)self;
        struct fdt_attach_args *faa = aux;
        struct smbios_struct_bios *sb;
        struct smbtable bios;
        char scratch[64];
        char sig[5];
        char *sminfop;
        bus_addr_t addr;
        bus_size_t size;
        bus_space_handle_t ioh;

        sc->sc_iot = faa->fa_iot;
        if (bus_space_map(sc->sc_iot, faa->fa_reg[0].addr, sizeof(sig),
            BUS_SPACE_MAP_LINEAR | BUS_SPACE_MAP_PREFETCHABLE, &ioh)) {
                printf(": can't map SMBIOS entry point structure\n");
                return;
        }
        bus_space_read_region_1(sc->sc_iot, ioh, 0, sig, sizeof(sig));
        bus_space_unmap(sc->sc_iot, ioh, sizeof(sig));

        if (strncmp(sig, "_SM_", 4) == 0) {
                struct smbhdr *hdr;
                uint8_t *p, checksum = 0;
                int i;

                if (bus_space_map(sc->sc_iot, faa->fa_reg[0].addr, sizeof(*hdr),
                    BUS_SPACE_MAP_LINEAR | BUS_SPACE_MAP_PREFETCHABLE, &ioh)) {
                        printf(": can't map SMBIOS entry point structure\n");
                        return;
                }

                hdr = bus_space_vaddr(sc->sc_iot, ioh);
                if (hdr->len != sizeof(*hdr)) {
                        bus_space_unmap(sc->sc_iot, ioh, sizeof(*hdr));
                        printf("\n");
                        return;
                }
                for (i = 0, p = (uint8_t *)hdr; i < hdr->len; i++)
                        checksum += p[i];
                if (checksum != 0) {
                        bus_space_unmap(sc->sc_iot, ioh, sizeof(*hdr));
                        printf("\n");
                        return;
                }

                printf(": SMBIOS %d.%d", hdr->majrev, hdr->minrev);

                smbios_entry.len = hdr->size;
                smbios_entry.mjr = hdr->majrev;
                smbios_entry.min = hdr->minrev;
                smbios_entry.count = hdr->count;

                addr = hdr->addr;
                size = hdr->size;
                bus_space_unmap(sc->sc_iot, ioh, sizeof(*hdr));
        } else if (strncmp(sig, "_SM3_", 5) == 0) {
                struct smb3hdr *hdr;
                uint8_t *p, checksum = 0;
                int i;

                if (bus_space_map(sc->sc_iot, faa->fa_reg[0].addr, sizeof(*hdr),
                    BUS_SPACE_MAP_LINEAR | BUS_SPACE_MAP_PREFETCHABLE, &ioh)) {
                        printf(": can't map SMBIOS entry point structure\n");
                        return;
                }

                hdr = bus_space_vaddr(sc->sc_iot, ioh);
                if (hdr->len != sizeof(*hdr) || hdr->epr != 0x01) {
                        bus_space_unmap(sc->sc_iot, ioh, sizeof(*hdr));
                        printf("\n");
                        return;
                }
                for (i = 0, p = (uint8_t *)hdr; i < hdr->len; i++)
                        checksum += p[i];
                if (checksum != 0) {
                        bus_space_unmap(sc->sc_iot, ioh, sizeof(*hdr));
                        printf("\n");
                        return;
                }

                printf(": SMBIOS %d.%d.%d", hdr->majrev, hdr->minrev,
                    hdr->docrev);

                smbios_entry.len = hdr->size;
                smbios_entry.mjr = hdr->majrev;
                smbios_entry.min = hdr->minrev;
                smbios_entry.count = -1;

                addr = hdr->addr;
                size = hdr->size;
                bus_space_unmap(sc->sc_iot, ioh, sizeof(*hdr));
        } else {
                printf(": unsupported SMBIOS entry point\n");
                return;
        }

        if (bus_space_map(sc->sc_iot, addr, size,
            BUS_SPACE_MAP_LINEAR | BUS_SPACE_MAP_PREFETCHABLE, &ioh)) {
                printf(": can't map SMBIOS structure table\n");
                return;
        }
        smbios_entry.addr = bus_space_vaddr(sc->sc_iot, ioh);

        bios.cookie = 0;
        if (smbios_find_table(SMBIOS_TYPE_BIOS, &bios)) {
                sb = bios.tblhdr;
                printf("\n%s:", sc->sc_dev.dv_xname);
                if ((smbios_get_string(&bios, sb->vendor,
                    scratch, sizeof(scratch))) != NULL)
                        printf(" vendor %s",
                            fixstring(scratch));
                if ((smbios_get_string(&bios, sb->version,
                    scratch, sizeof(scratch))) != NULL)
                        printf(" version \"%s\"",
                            fixstring(scratch));
                if ((smbios_get_string(&bios, sb->release,
                    scratch, sizeof(scratch))) != NULL) {
                        sminfop = fixstring(scratch);
                        if (sminfop != NULL) {
                                strlcpy(smbios_bios_date,
                                    sminfop,
                                    sizeof(smbios_bios_date));
                                printf(" date %s", sminfop);
                        }
                }

                smbios_info(sc->sc_dev.dv_xname);
        }

        bus_space_unmap(sc->sc_iot, ioh, size);

        printf("\n");
        return;
}

/*
 * smbios_find_table() takes a caller supplied smbios struct type and
 * a pointer to a handle (struct smbtable) returning one if the structure
 * is successfully located and zero otherwise. Callers should take care
 * to initialize the cookie field of the smbtable structure to zero before
 * the first invocation of this function.
 * Multiple tables of the same type can be located by repeatedly calling
 * smbios_find_table with the same arguments.
 */
int
smbios_find_table(uint8_t type, struct smbtable *st)
{
        uint8_t *va, *end;
        struct smbtblhdr *hdr;
        int ret = 0, tcount = 1;

        va = smbios_entry.addr;
        end = va + smbios_entry.len;

        /*
         * The cookie field of the smtable structure is used to locate
         * multiple instances of a table of an arbitrary type. Following the
         * successful location of a table, the type is encoded as bits 0:7 of
         * the cookie value, the offset in terms of the number of structures
         * preceding that referenced by the handle is encoded in bits 15:31.
         */
        if ((st->cookie & 0xfff) == type && st->cookie >> 16) {
                if ((uint8_t *)st->hdr >= va && (uint8_t *)st->hdr < end) {
                        hdr = st->hdr;
                        if (hdr->type == type) {
                                va = (uint8_t *)hdr + hdr->size;
                                for (; va + 1 < end; va++)
                                        if (*va == 0 && *(va + 1) == 0)
                                                break;
                                va += 2;
                                tcount = st->cookie >> 16;
                        }
                }
        }
        for (; va + sizeof(struct smbtblhdr) < end &&
            tcount <= smbios_entry.count; tcount++) {
                hdr = (struct smbtblhdr *)va;
                if (hdr->type == type) {
                        ret = 1;
                        st->hdr = hdr;
                        st->tblhdr = va + sizeof(struct smbtblhdr);
                        st->cookie = (tcount + 1) << 16 | type;
                        break;
                }
                if (hdr->type == SMBIOS_TYPE_EOT)
                        break;
                va += hdr->size;
                for (; va + 1 < end; va++)
                        if (*va == 0 && *(va + 1) == 0)
                                break;
                va += 2;
        }
        return ret;
}

char *
smbios_get_string(struct smbtable *st, uint8_t indx, char *dest, size_t len)
{
        uint8_t *va, *end;
        char *ret = NULL;
        int i;

        va = (uint8_t *)st->hdr + st->hdr->size;
        end = smbios_entry.addr + smbios_entry.len;
        for (i = 1; va < end && i < indx && *va; i++)
                while (*va++)
                        ;
        if (i == indx) {
                if (va + len < end) {
                        ret = dest;
                        memcpy(ret, va, len);
                        ret[len - 1] = '\0';
                }
        }

        return ret;
}

char *
fixstring(char *s)
{
        char *p, *e;
        int i;

        for (i = 0; i < nitems(smbios_uninfo); i++)
                if ((strncasecmp(s, smbios_uninfo[i],
                    strlen(smbios_uninfo[i]))) == 0)
                        return NULL;
        /*
         * Remove leading and trailing whitespace
         */
        for (p = s; *p == ' '; p++)
                ;
        /*
         * Special case entire string is whitespace
         */
        if (p == s + strlen(s))
                return NULL;
        for (e = s + strlen(s) - 1; e > s && *e == ' '; e--)
                ;
        if (p > s || e < s + strlen(s) - 1) {
                memmove(s, p, e - p + 1);
                s[e - p + 1] = '\0';
        }

        return s;
}

void
smbios_info(char *str)
{
        char *sminfop, sminfo[64];
        struct smbtable stbl, btbl;
        struct smbios_sys *sys;
        struct smbios_board *board;
        int i, infolen, uuidf, havebb;
        char *p;

        if (smbios_entry.mjr < 2)
                return;
        /*
         * According to the spec the system table among others is required,
         * if it is not we do not bother with this smbios implementation.
         */
        stbl.cookie = btbl.cookie = 0;
        if (!smbios_find_table(SMBIOS_TYPE_SYSTEM, &stbl))
                return;
        havebb = smbios_find_table(SMBIOS_TYPE_BASEBOARD, &btbl);

        sys = (struct smbios_sys *)stbl.tblhdr;
        if (havebb) {
                board = (struct smbios_board *)btbl.tblhdr;

                sminfop = NULL;
                if ((p = smbios_get_string(&btbl, board->vendor,
                    sminfo, sizeof(sminfo))) != NULL)
                        sminfop = fixstring(p);
                if (sminfop)
                        strlcpy(smbios_board_vendor, sminfop,
                            sizeof(smbios_board_vendor));

                sminfop = NULL;
                if ((p = smbios_get_string(&btbl, board->product,
                    sminfo, sizeof(sminfo))) != NULL)
                        sminfop = fixstring(p);
                if (sminfop)
                        strlcpy(smbios_board_prod, sminfop,
                            sizeof(smbios_board_prod));

                sminfop = NULL;
                if ((p = smbios_get_string(&btbl, board->serial,
                    sminfo, sizeof(sminfo))) != NULL)
                        sminfop = fixstring(p);
                if (sminfop)
                        strlcpy(smbios_board_serial, sminfop,
                            sizeof(smbios_board_serial));
        }
        /*
         * Some smbios implementations have no system vendor or
         * product strings, some have very uninformative data which is
         * harder to work around and we must rely upon various
         * heuristics to detect this. In both cases we attempt to fall
         * back on the base board information in the perhaps naive
         * belief that motherboard vendors will supply this
         * information.
         */
        sminfop = NULL;
        if ((p = smbios_get_string(&stbl, sys->vendor, sminfo,
            sizeof(sminfo))) != NULL)
                sminfop = fixstring(p);
        if (sminfop == NULL) {
                if (havebb) {
                        if ((p = smbios_get_string(&btbl, board->vendor,
                            sminfo, sizeof(sminfo))) != NULL)
                                sminfop = fixstring(p);
                }
        }
        if (sminfop) {
                infolen = strlen(sminfop) + 1;
                hw_vendor = malloc(infolen, M_DEVBUF, M_NOWAIT);
                if (hw_vendor)
                        strlcpy(hw_vendor, sminfop, infolen);
                sminfop = NULL;
        }
        if ((p = smbios_get_string(&stbl, sys->product, sminfo,
            sizeof(sminfo))) != NULL)
                sminfop = fixstring(p);
        if (sminfop == NULL) {
                if (havebb) {
                        if ((p = smbios_get_string(&btbl, board->product,
                            sminfo, sizeof(sminfo))) != NULL)
                                sminfop = fixstring(p);
                }
        }
        if (sminfop) {
                infolen = strlen(sminfop) + 1;
                hw_prod = malloc(infolen, M_DEVBUF, M_NOWAIT);
                if (hw_prod)
                        strlcpy(hw_prod, sminfop, infolen);
                sminfop = NULL;
        }
        if (hw_vendor != NULL && hw_prod != NULL)
                printf("\n%s: %s %s", str, hw_vendor, hw_prod);
        if ((p = smbios_get_string(&stbl, sys->version, sminfo,
            sizeof(sminfo))) != NULL)
                sminfop = fixstring(p);
        if (sminfop) {
                infolen = strlen(sminfop) + 1;
                hw_ver = malloc(infolen, M_DEVBUF, M_NOWAIT);
                if (hw_ver)
                        strlcpy(hw_ver, sminfop, infolen);
                sminfop = NULL;
        }
        if ((p = smbios_get_string(&stbl, sys->serial, sminfo,
            sizeof(sminfo))) != NULL)
                sminfop = fixstring(p);
        if (sminfop) {
                infolen = strlen(sminfop) + 1;
                for (i = 0; i < infolen - 1; i++)
                        enqueue_randomness(sminfop[i]);
                hw_serial = malloc(infolen, M_DEVBUF, M_NOWAIT);
                if (hw_serial)
                        strlcpy(hw_serial, sminfop, infolen);
        }
        if (smbios_entry.mjr > 2 || (smbios_entry.mjr == 2 &&
            smbios_entry.min >= 1)) {
                /*
                 * If the uuid value is all 0xff the uuid is present but not
                 * set, if its all 0 then the uuid isn't present at all.
                 */
                uuidf = SMBIOS_UUID_NPRESENT|SMBIOS_UUID_NSET;
                for (i = 0; i < sizeof(sys->uuid); i++) {
                        if (sys->uuid[i] != 0xff)
                                uuidf &= ~SMBIOS_UUID_NSET;
                        if (sys->uuid[i] != 0)
                                uuidf &= ~SMBIOS_UUID_NPRESENT;
                }

                if (uuidf & SMBIOS_UUID_NPRESENT)
                        hw_uuid = NULL;
                else if (uuidf & SMBIOS_UUID_NSET)
                        hw_uuid = "Not Set";
                else {
                        for (i = 0; i < sizeof(sys->uuid); i++)
                                enqueue_randomness(sys->uuid[i]);
                        hw_uuid = malloc(SMBIOS_UUID_REPLEN, M_DEVBUF,
                            M_NOWAIT);
                        if (hw_uuid) {
                                snprintf(hw_uuid, SMBIOS_UUID_REPLEN,
                                    SMBIOS_UUID_REP,
                                    sys->uuid[0], sys->uuid[1], sys->uuid[2],
                                    sys->uuid[3], sys->uuid[4], sys->uuid[5],
                                    sys->uuid[6], sys->uuid[7], sys->uuid[8],
                                    sys->uuid[9], sys->uuid[10], sys->uuid[11],
                                    sys->uuid[12], sys->uuid[13], sys->uuid[14],
                                    sys->uuid[15]);
                        }
                }
        }
}