/*      $NetBSD: fwcrom.c,v 1.18 2026/01/05 11:00:40 nia Exp $  */
/*-
 * Copyright (c) 2002-2003
 *      Hidetoshi Shimokawa. 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.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *
 *      This product includes software developed by Hidetoshi Shimokawa.
 *
 * 4. Neither the name of the author nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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>
__KERNEL_RCSID(0, "$NetBSD: fwcrom.c,v 1.18 2026/01/05 11:00:40 nia Exp $");

#include <sys/param.h>
#ifdef _KERNEL
#include <sys/device.h>
#include <sys/errno.h>
#include <sys/endian.h>
#include <sys/systm.h>
#else
#include <stdio.h>
#include <string.h>
#include <endian.h>
#endif
#include <dev/ieee1394/firewire.h>
#include <dev/ieee1394/iec13213.h>

#define MAX_ROM (1024 - sizeof(uint32_t) * 5)
#define CROM_END(cc) ((char *)(cc)->stack[0].dir + MAX_ROM - 1)

void
crom_init_context(struct crom_context *cc, uint32_t *p)
{
        struct csrhdr *hdr;

        hdr = (struct csrhdr *)p;
        if (hdr->info_len <= 1) {
                /* minimum or invalid ROM */
                cc->depth = -1;
                return;
        }
        p += 1 + hdr->info_len;

        /* check size of root directory */
        if (((struct csrdirectory *)p)->crc_len == 0) {
                cc->depth = -1;
                return;
        }
        cc->depth = 0;
        cc->stack[0].dir = (struct csrdirectory *)p;
        cc->stack[0].index = 0;
}

struct csrreg *
crom_get(struct crom_context *cc)
{
        struct crom_ptr *ptr;

        ptr = &cc->stack[cc->depth];
        return &ptr->dir->entry[ptr->index];
}

void
crom_next(struct crom_context *cc)
{
        struct crom_ptr *ptr;
        struct csrreg *reg;

        if (cc->depth < 0)
                return;
        reg = crom_get(cc);
        if ((reg->key & CSRTYPE_MASK) == CSRTYPE_D) {
                if (cc->depth >= CROM_MAX_DEPTH) {
                        printf("crom_next: too deep\n");
                        goto again;
                }
                cc->depth++;

                ptr = &cc->stack[cc->depth];
                ptr->dir = (struct csrdirectory *)(reg + reg->val);
                ptr->index = 0;
                goto check;
        }
again:
        ptr = &cc->stack[cc->depth];
        ptr->index++;
check:
        if (ptr->index < ptr->dir->crc_len &&
            (char *)crom_get(cc) <= CROM_END(cc))
                return;

        if (ptr->index < ptr->dir->crc_len)
                printf("crom_next: bound check failed\n");

        if (cc->depth > 0) {
                cc->depth--;
                goto again;
        }
        /* no more data */
        cc->depth = -1;
}


struct csrreg *
crom_search_key(struct crom_context *cc, uint8_t key)
{
        struct csrreg *reg;

        while (cc->depth >= 0) {
                reg = crom_get(cc);
                if (reg->key == key)
                        return reg;
                crom_next(cc);
        }
        return NULL;
}

int
crom_has_specver(uint32_t *p, uint32_t spec, uint32_t ver)
{
        struct csrreg *reg;
        struct crom_context c, *cc;
        int state = 0;

        cc = &c;
        crom_init_context(cc, p);
        while (cc->depth >= 0) {
                reg = crom_get(cc);
                if (state == 0) {
                        if (reg->key == CSRKEY_SPEC && reg->val == spec)
                                state = 1;
                        else
                                state = 0;
                } else {
                        if (reg->key == CSRKEY_VER && reg->val == ver)
                                return 1;
                        else
                                state = 0;
                }
                crom_next(cc);
        }
        return 0;
}

void
crom_parse_text(struct crom_context *cc, char *buf, int len)
{
        struct csrreg *reg;
        struct csrtext *textleaf;
        uint32_t *bp;
        int i, qlen;
        static const char nullstr[] = "(null)";

        if (cc->depth < 0)
                return;

        reg = crom_get(cc);
        switch (reg->key) {
        case CROM_TEXTLEAF:
        case CROM_TEXTLEAF2:
                break;
        default:
                if ((char *)(reg + reg->val) > CROM_END(cc)) {
                        strncpy(buf, nullstr, len);
                        return;
                }
                break;
        }
        textleaf = (struct csrtext *)(reg + reg->val);

        if ((char *)textleaf + textleaf->crc_len > CROM_END(cc)) {
                strncpy(buf, nullstr, len);
                return;
        }

        /* XXX should check spec and type */

        bp = (uint32_t *)buf;
        qlen = textleaf->crc_len - 2;
        if (len < qlen * 4)
                qlen = len/4;
        for (i = 0; i < qlen; i++)
                *bp++ = ntohl(textleaf->text[i]);
        /* make sure to terminate the string */
        if (len <= qlen * 4)
                buf[len - 1] = 0;
        else
                buf[qlen * 4] = 0;
}

uint16_t
crom_crc(uint32_t *ptr, int len)
{
        int i, shift;
        uint32_t data, sum, crc = 0;

        for (i = 0; i < len; i++) {
                data = ptr[i];
                for (shift = 28; shift >= 0; shift -= 4) {
                        sum = ((crc >> 12) ^ (data >> shift)) & 0xf;
                        crc = (crc << 4) ^ (sum << 12) ^ (sum << 5) ^ sum;
                }
                crc &= 0xffff;
        }
        return (uint16_t)crc;
}

#if !defined(_KERNEL) && !defined(_BOOT)
static void
crom_desc_specver(uint32_t spec, uint32_t ver, char *buf, int len)
{
        const char *s = NULL;

        if (spec == CSRVAL_ANSIT10 || spec == 0) {
                switch (ver) {
                case CSRVAL_T10SBP2:
                        s = "SBP-2";
                        break;
                default:
                        if (spec != 0)
                                s = "unknown ANSIT10";
                }
        }
        if (spec == CSRVAL_1394TA || spec == 0) {
                switch (ver) {
                case CSR_PROTAVC:
                        s = "AV/C";
                        break;
                case CSR_PROTCAL:
                        s = "CAL";
                        break;
                case CSR_PROTEHS:
                        s = "EHS";
                        break;
                case CSR_PROTHAVI:
                        s = "HAVi";
                        break;
                case CSR_PROTCAM104:
                        s = "1394 Cam 1.04";
                        break;
                case CSR_PROTCAM120:
                        s = "1394 Cam 1.20";
                        break;
                case CSR_PROTCAM130:
                        s = "1394 Cam 1.30";
                        break;
                case CSR_PROTDPP:
                        s = "1394 Direct print";
                        break;
                case CSR_PROTIICP:
                        s = "Industrial & Instrument";
                        break;
                default:
                        if (spec != 0)
                                s = "unknown 1394TA";
                }
        }
        if (s != NULL)
                snprintf(buf, len, "%s", s);
}

const char *
crom_desc(struct crom_context *cc, char *buf, size_t len)
{
        struct csrreg *reg;
        struct csrdirectory *dir;
        const char *desc;
        uint16_t crc;
        size_t l = 0;

        reg = crom_get(cc);
        switch (reg->key & CSRTYPE_MASK) {
        case CSRTYPE_I:
#if 0
                l += snprintf(buf + l, len - l, "0x%x", reg->val);
#else
                *buf = '\0';
#endif
                break;
        case CSRTYPE_C:
                l += snprintf(buf + l, len - l, "offset=0x%04x(%d)",
                    reg->val, reg->val);
                break;
        case CSRTYPE_L:
                /* XXX fall through */
        case CSRTYPE_D:
                dir = (struct csrdirectory *) (reg + reg->val);
                crc = crom_crc((uint32_t *)dir->entry, dir->crc_len);
                l += snprintf(buf + l, len - l, "len=%d crc=0x%04x ",
                    dir->crc_len, crc);

                if (l > len)
                        l = len;
                if (crc == dir->crc)
                        l += snprintf(buf + l, len - l, "(OK) ");
                else
                        l += snprintf(buf + l, len - l, "(NG, 0x%x) ",
                            dir->crc);
        }
        if (l > len)
                l = len;
        switch (reg->key) {
        case CSRKEY_VENDOR: /* 0x03 */
                desc = "module_vendor_ID";
                break;
        case CSRKEY_HW: /* 0x04 */
                desc = "hardware_version";
                break;
        case CSRKEY_NCAP: /* 0x0c */
                desc = "node_capabilities";
                break;
        case CSRKEY_SPEC: /* 0x12 */
                desc = "unit_spec_ID";
                break;
        case CSRKEY_VER: /* 0x13 */
                desc = "unit_sw_version";
                crom_desc_specver(0, reg->val, buf, len);
                break;
        case CSRKEY_DINFO: /* 0x14 */
                desc = "logical_unit_number";
                break;
        case CSRKEY_MODEL: /* 0x17 */
                desc = "model_ID";
                break;
        case CSRKEY_REV: /* 0x21 */
                desc = "revision_ID";
                break;
        case 0x38:
                desc = "command_set_spec_ID";
                break;
        case 0x39:
                desc = "command_set";
                break;
        case 0x3a:
                desc = "unit_characteristics";
                break;
        case 0x3b:
                desc = "command_set_revision";
                break;
        case 0x3c:
                desc = "firmware_revision";
                break;
        case 0x3d:
                desc = "reconnect_timeout";
                break;
        case 0x40:
                desc = "command_regs_base";
                break;
        case 0x54:
                desc = "management_agent";
                break;
        case CROM_TEXTLEAF: /* 0x81 */
        case CROM_TEXTLEAF2: /* 0x82 */
                desc = "text_leaf";
                crom_parse_text(cc, buf + l, len - l);
                break;
        case CROM_NODEID: /* 0x8d */
                desc = "node_unique_ID";
                break;
        case 0xd1:
                desc = "unit_directory";
                break;
        case 0xd4:
                desc = "logical_unit_directory";
                break;
        default:
                desc = "unknown";
        }
        return desc;
}
#endif

#if defined(_KERNEL) || defined(_BOOT) || defined(TEST)

int
crom_add_quad(struct crom_chunk *chunk, uint32_t entry)
{
        int index;

        index = chunk->data.crc_len;
        if (index >= CROM_MAX_CHUNK_LEN - 1) {
                printf("too large chunk %d\n", index);
                return -1;
        }
        chunk->data.buf[index] = entry;
        chunk->data.crc_len++;
        return index;
}

int
crom_add_entry(struct crom_chunk *chunk, int key, int val)
{
        union {
                struct csrreg reg;
                uint32_t i;
        } foo;

        foo.reg.key = key;
        foo.reg.val = val;

        return crom_add_quad(chunk, foo.i);
}

int
crom_add_chunk(struct crom_src *src, struct crom_chunk *parent,
               struct crom_chunk *child, int key)
{
        int index;

        if (parent == NULL) {
                STAILQ_INSERT_TAIL(&src->chunk_list, child, link);
                return 0;
        }

        index = crom_add_entry(parent, key, 0);
        if (index < 0)
                return -1;
        child->ref_chunk = parent;
        child->ref_index = index;
        STAILQ_INSERT_TAIL(&src->chunk_list, child, link);
        return index;
}

#define MAX_TEXT (int)((CROM_MAX_CHUNK_LEN + 1) * 4 - sizeof(struct csrtext))
int
crom_add_simple_text(struct crom_src *src, struct crom_chunk *parent,
                     struct crom_chunk *chunk, const char *buf)
{
        struct csrtext *tl;
        uint32_t *p;
        int len, i;
        char t[MAX_TEXT];

        len = strlen(buf);
        if (len > MAX_TEXT) {
                printf("text(%d) trancated to %d.\n", len, MAX_TEXT);
                len = MAX_TEXT;
        }

        tl = (struct csrtext *) &chunk->data;
        tl->crc_len = howmany(sizeof(struct csrtext) + len, sizeof(uint32_t));
        tl->spec_id = 0;
        tl->spec_type = 0;
        tl->lang_id = 0;
        memset(t, 0, roundup2(len, sizeof(uint32_t)));
        memcpy(t, buf, len);
        p = (uint32_t *)t;
        for (i = 0; i < howmany(len, sizeof(uint32_t)); i++)
                tl->text[i] = ntohl(*p++);
        return crom_add_chunk(src, parent, chunk, CROM_TEXTLEAF);
}

static int
crom_copy(uint32_t *src, uint32_t *dst, int *offset, int len, int maxlen)
{

        if (*offset + len > maxlen) {
                printf("Config. ROM is too large for the buffer\n");
                return -1;
        }
        memcpy((char *)(dst + *offset), src, len * sizeof(uint32_t));
        *offset += len;
        return 0;
}

int
crom_load(struct crom_src *src, uint32_t *buf, int maxlen)
{
        struct crom_chunk *chunk, *parent;
        struct csrhdr *hdr;
#if defined(_KERNEL) || defined(_BOOT)
        uint32_t *ptr;
        int i;
#endif
        int count, offset;
        int len;

        offset = 0;
        /* Determine offset */
        STAILQ_FOREACH(chunk, &src->chunk_list, link) {
                chunk->offset = offset;
                /* Assume the offset of the parent is already known */
                parent = chunk->ref_chunk;
                if (parent != NULL) {
                        struct csrreg *reg;
                        const int ref_index = chunk->ref_index;

                        reg = (struct csrreg *)&parent->data.buf[ref_index];
                        reg->val =
                            offset - (parent->offset + 1 + chunk->ref_index);
                }
                offset += (1 + chunk->data.crc_len);
        }

        /* Calculate CRC and dump to the buffer */
        len = 1 + src->hdr.info_len;
        count = 0;
        if (crom_copy((uint32_t *)&src->hdr, buf, &count, len, maxlen) < 0)
                return -1;
        STAILQ_FOREACH(chunk, &src->chunk_list, link) {
                chunk->data.crc =
                    crom_crc(chunk->data.buf, chunk->data.crc_len);

                len = 1 + chunk->data.crc_len;
                if (crom_copy((uint32_t *)&chunk->data, buf, &count, len,
                                                                maxlen) < 0)
                        return -1;
        }
        hdr = (struct csrhdr *)buf;
        hdr->crc_len = count - 1;
        hdr->crc = crom_crc(&buf[1], hdr->crc_len);

#if defined(_KERNEL) || defined(_BOOT)
        /* byte swap */
        ptr = buf;
        for (i = 0; i < count; i++) {
                *ptr = htonl(*ptr);
                ptr++;
        }
#endif

        return count;
}
#endif

#ifdef TEST
int
main(void)
{
        struct crom_src src;
        struct crom_chunk root, unit[3], text[7];
        uint32_t buf[256], *p;
        int i;
        extern const char ostype[];

        memset(&src, 0, sizeof(src));
        memset(&root, 0, sizeof(root));
        memset(unit, 0, sizeof(unit));
        memset(text, 0, sizeof(text));
        memset(buf, 0, sizeof(buf));

        /* BUS info sample */
        src.hdr.info_len = 4;
        src.businfo.bus_name = CSR_BUS_NAME_IEEE1394;
        src.businfo.eui64.hi = 0x11223344;
        src.businfo.eui64.lo = 0x55667788;
        src.businfo.link_spd = FWSPD_S400;
        src.businfo.generation = 0;
        src.businfo.max_rom = MAXROM_4;
        src.businfo.max_rec = 10;
        src.businfo.cyc_clk_acc = 100;
        src.businfo.pmc = 0;
        src.businfo.bmc = 1;
        src.businfo.isc = 1;
        src.businfo.cmc = 1;
        src.businfo.irmc = 1;
        STAILQ_INIT(&src.chunk_list);

        /* Root directory */
        crom_add_chunk(&src, NULL, &root, 0);
        crom_add_entry(&root, CSRKEY_NCAP, 0x123456);
        /* private company_id */
        crom_add_entry(&root, CSRKEY_VENDOR, 0xacde48);

        crom_add_simple_text(&src, &root, &text[0], ostype);
        crom_add_entry(&root, CSRKEY_HW, __NetBSD_Version__);
        crom_add_simple_text(&src, &root, &text[1], OS_VER_STR);

        /* SBP unit directory */
        crom_add_chunk(&src, &root, &unit[0], CROM_UDIR);
        crom_add_entry(&unit[0], CSRKEY_SPEC, CSRVAL_ANSIT10);
        crom_add_entry(&unit[0], CSRKEY_VER, CSRVAL_T10SBP2);
        crom_add_entry(&unit[0], CSRKEY_COM_SPEC, CSRVAL_ANSIT10);
        crom_add_entry(&unit[0], CSRKEY_COM_SET, CSRVAL_SCSI);
        /* management_agent */
        crom_add_entry(&unit[0], CROM_MGM, 0x1000);
        crom_add_entry(&unit[0], CSRKEY_UNIT_CH, (10<<8) | 8);
        /* Device type and LUN */
        crom_add_entry(&unit[0], CROM_LUN, 0);
        crom_add_entry(&unit[0], CSRKEY_MODEL, 1);
        crom_add_simple_text(&src, &unit[0], &text[2], "scsi_target");

        /* RFC2734 IPv4 over IEEE1394 */
        crom_add_chunk(&src, &root, &unit[1], CROM_UDIR);
        crom_add_entry(&unit[1], CSRKEY_SPEC, CSRVAL_IETF);
        crom_add_simple_text(&src, &unit[1], &text[3], "IANA");
        crom_add_entry(&unit[1], CSRKEY_VER, 1);
        crom_add_simple_text(&src, &unit[1], &text[4], "IPv4");

        /* RFC3146 IPv6 over IEEE1394 */
        crom_add_chunk(&src, &root, &unit[2], CROM_UDIR);
        crom_add_entry(&unit[2], CSRKEY_SPEC, CSRVAL_IETF);
        crom_add_simple_text(&src, &unit[2], &text[5], "IANA");
        crom_add_entry(&unit[2], CSRKEY_VER, 2);
        crom_add_simple_text(&src, &unit[2], &text[6], "IPv6");

        crom_load(&src, buf, 256);
        p = buf;
#define DUMP_FORMAT     "%08x %08x %08x %08x %08x %08x %08x %08x\n"
        for (i = 0; i < 256 / 8; i++) {
                printf(DUMP_FORMAT,
                    p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7]);
                p += 8;
        }
        return 0;
}
#endif