root/usr.sbin/iopctl/iopctl.c
/*      $NetBSD: iopctl.c,v 1.23 2025/12/27 16:51:56 nia Exp $  */

/*-
 * Copyright (c) 2000 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Andrew Doran.
 *
 * 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.
 */

#ifndef lint
#include <sys/cdefs.h>
__RCSID("$NetBSD: iopctl.c,v 1.23 2025/12/27 16:51:56 nia Exp $");
#endif /* not lint */

#include <sys/param.h>
#include <sys/ioctl.h>
#include <sys/uio.h>

#include <err.h>
#include <errno.h>
#include <endian.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <string.h>
#include <unistd.h>
#include <util.h>

#include <dev/i2o/i2o.h>
#include <dev/i2o/iopio.h>

static const char       *class2str(int);
static void     getparam(int, int, void *, int);
static int      gettid(char **);
static int      show(const char *, const char *, ...) __printflike(2, 3);
static void     i2ostrvis(const u_char *, int, char *, int);
static void     usage(void) __dead;

static void     reconfig(char **);
static void     showdevid(char **);
static void     showddmid(char **);
static void     showlct(char **);
static void     showstatus(char **);
static void     showtidmap(char **);

static struct {
        int     class;
        const char      *caption;
} const i2oclass[] = {
        { I2O_CLASS_EXECUTIVE, "executive" },
        { I2O_CLASS_DDM, "device driver module" },
        { I2O_CLASS_RANDOM_BLOCK_STORAGE, "random block storage" },
        { I2O_CLASS_SEQUENTIAL_STORAGE, "sequential storage" },
        { I2O_CLASS_LAN, "LAN port" },
        { I2O_CLASS_WAN, "WAN port" },
        { I2O_CLASS_FIBRE_CHANNEL_PORT, "fibrechannel port" },
        { I2O_CLASS_FIBRE_CHANNEL_PERIPHERAL, "fibrechannel peripheral" },
        { I2O_CLASS_SCSI_PERIPHERAL, "SCSI peripheral" },
        { I2O_CLASS_ATE_PORT, "ATE port" },
        { I2O_CLASS_ATE_PERIPHERAL, "ATE peripheral" },
        { I2O_CLASS_FLOPPY_CONTROLLER, "floppy controller" },
        { I2O_CLASS_FLOPPY_DEVICE, "floppy device" },
        { I2O_CLASS_BUS_ADAPTER_PORT, "bus adapter port" },
};

static struct {
        const char      *label;
        int     takesargs;
        void    (*func)(char **);
} const cmdtab[] = {
        { "reconfig", 0, reconfig },
        { "showddmid", 1, showddmid },
        { "showdevid", 1, showdevid },
        { "showlct", 0, showlct },
        { "showstatus", 0, showstatus },
        { "showtidmap", 0, showtidmap },
};

static int      fd;
static char     buf[32768];
static struct   i2o_status status;

int
main(int argc, char **argv)
{
        int ch;
        size_t i;
        const char *dv;
        struct iovec iov;

        dv = "/dev/iop0";
        
        while ((ch = getopt(argc, argv, "f:")) != -1) {
                switch (ch) {
                case 'f':
                        dv = optarg;
                        break;
                default:
                        usage();
                        /* NOTREACHED */
                }
        }

        if (argv[optind] == NULL)
                usage();

        if ((fd = open(dv, O_RDWR)) < 0)
                err(EXIT_FAILURE, "%s", dv);

        iov.iov_base = &status;
        iov.iov_len = sizeof(status);
        if (ioctl(fd, IOPIOCGSTATUS, &iov) < 0)
                err(EXIT_FAILURE, "IOPIOCGSTATUS");

        for (i = 0; i < sizeof(cmdtab) / sizeof(cmdtab[0]); i++)
                if (strcmp(argv[optind], cmdtab[i].label) == 0) {
                        if (cmdtab[i].takesargs == 0 &&
                            argv[optind + 1] != NULL)
                                usage();
                        (*cmdtab[i].func)(argv + optind + 1);
                        break;
                }

        if (i == sizeof(cmdtab) / sizeof(cmdtab[0]))
                errx(EXIT_FAILURE, "unknown command ``%s''", argv[optind]);

        close(fd);
        exit(EXIT_SUCCESS);
        /* NOTREACHED */
}

static void
usage(void)
{

        (void)fprintf(stderr, "usage: %s [-f dev] <command> [target]\n",
            getprogname());
        exit(EXIT_FAILURE);
        /* NOTREACHED */
}

static int
show(const char *hdr, const char *fmt, ...)
{
        int i;
        va_list va;
        
        for (i = printf("%s", hdr); i < 25; i++)
                putchar(' ');
        va_start(va, fmt);
        i += vprintf(fmt, va);
        va_end(va);
        putchar('\n');
        return (i);
}

static const char *
class2str(int class)
{
        size_t i;
        
        for (i = 0; i < sizeof(i2oclass) / sizeof(i2oclass[0]); i++)
                if (class == i2oclass[i].class)
                        return (i2oclass[i].caption);
                        
        return ("unknown");
}

static void
getparam(int tid, int group, void *pbuf, int pbufsize)
{
        struct ioppt pt;
        struct i2o_util_params_op mb;
        struct i2o_reply *rf;
        struct {
                struct  i2o_param_op_list_header olh;
                struct  i2o_param_op_all_template oat;
        } __packed req;

        mb.msgflags = I2O_MSGFLAGS(i2o_util_params_op);
        mb.msgfunc = I2O_MSGFUNC(tid, I2O_UTIL_PARAMS_GET);
        mb.flags = 0;

        req.olh.count = htole16(1);
        req.olh.reserved = htole16(0);
        req.oat.operation = htole16(I2O_PARAMS_OP_FIELD_GET);
        req.oat.fieldcount = htole16(0xffff);
        req.oat.group = htole16(group);

        pt.pt_msg = &mb;
        pt.pt_msglen = sizeof(mb);
        pt.pt_reply = buf;
        pt.pt_replylen = sizeof(buf);
        pt.pt_timo = 10000;
        pt.pt_nbufs = 2;

        pt.pt_bufs[0].ptb_data = &req;
        pt.pt_bufs[0].ptb_datalen = sizeof(req);
        pt.pt_bufs[0].ptb_out = 1;

        pt.pt_bufs[1].ptb_data = pbuf;
        pt.pt_bufs[1].ptb_datalen = pbufsize;
        pt.pt_bufs[1].ptb_out = 0;

        if (ioctl(fd, IOPIOCPT, &pt) < 0)
                err(EXIT_FAILURE, "IOPIOCPT");

        rf = (struct i2o_reply *)buf;
        if ((rf->msgflags & I2O_MSGFLAGS_FAIL) != 0)
                errx(EXIT_FAILURE, "I2O_UTIL_PARAMS_GET failed (FAIL)");
        if (rf->reqstatus != 0)
                errx(EXIT_FAILURE, "I2O_UTIL_PARAMS_GET failed (%d)",
                    rf->reqstatus);
}       

static void
showlct(char **argv)
{
        struct iovec iov;
        struct i2o_lct *lct;
        struct i2o_lct_entry *ent;
        u_int32_t classid, usertid;
        int i, nent;
        char ident[sizeof(ent->identitytag) * 4 + 1];

        iov.iov_base = buf;
        iov.iov_len = sizeof(buf);

        if (ioctl(fd, IOPIOCGLCT, &iov) < 0)
                err(EXIT_FAILURE, "IOPIOCGLCT");

        lct = (struct i2o_lct *)buf;
        ent = lct->entry;
        nent = ((le16toh(lct->tablesize) << 2) -
            sizeof(struct i2o_lct) + sizeof(struct i2o_lct_entry)) /
            sizeof(struct i2o_lct_entry);

        show("flags", "0x%x", le16toh(lct->flags));
        show("iop flags", "0x%x", le32toh(lct->iopflags));
        show("lct change indicator", "%d", le32toh(lct->changeindicator));
        printf("\n");

        for (i = 0; i < nent; i++, ent++) {
                classid = le32toh(ent->classid);
                usertid = le32toh(ent->usertid);

                show("lct entry", "%d", i);
                show("entry size", "%d bytes", le16toh(ent->entrysize) << 2);
                show("local tid", "%d", le16toh(ent->localtid) & 4095);
                show("change indicator", "%d", le32toh(ent->changeindicator));
                show("flags", "%x", le32toh(ent->deviceflags));
                show("class id", "%x (%s)", classid & 4095, 
                    class2str(classid & 4095));
                show("version", "%x", (classid >> 12) & 15);
                show("organisation id", "%x", classid >> 16);
                show("subclass info", "%x", le32toh(ent->subclassinfo));
                show("user tid", "%d", usertid & 4095);
                show("parent tid", "%d", (usertid >> 12) & 4095);
                show("bios info", "%d", (usertid >> 24) & 255);
                i2ostrvis(ent->identitytag, sizeof(ent->identitytag), ident,
                    sizeof(ident));
                show("identity tag", "<%s>", ident);
                show("event caps", "%x", le32toh(ent->eventcaps));
                
                if (i != nent - 1)
                        printf("\n");
        }
}

static void
showstatus(char **argv)
{
        char ident[sizeof(status.productid) + 1];
        u_int32_t segnumber;

        i2ostrvis(status.productid, sizeof(status.productid),
            ident, sizeof(ident));

        segnumber = le32toh(status.segnumber);
        show("organization id", "%d", le16toh(status.orgid));
        show("iop id", "%d", le32toh(status.iopid) & 4095);
        show("host unit id", "%d", (le32toh(status.iopid) >> 16));
        show("segment number", "%d", segnumber & 4095);
        show("i2o version", "%d", (segnumber >> 12) & 15);
        show("iop state", "%d", (segnumber >> 16) & 255);
        show("messenger type", "%d", segnumber >> 24);
        show("inbound frame sz", "%d", le16toh(status.inboundmframesize));
        show("init code", "%d", status.initcode);
        show("max inbound queue depth", "%d",
            le32toh(status.maxinboundmframes));
        show("inbound queue depth", "%d",
            le32toh(status.currentinboundmframes));
        show("max outbound queue depth", "%d",
            le32toh(status.maxoutboundmframes));
        show("product id string", "<%s>", ident);
        show("expected lct size", "%d", le32toh(status.expectedlctsize));
        show("iop capabilities", "0x%08x", le32toh(status.iopcaps));
        show("desired priv mem sz", "0x%08x",
            le32toh(status.desiredprivmemsize));
        show("current priv mem sz", "0x%08x",
            le32toh(status.currentprivmemsize));
        show("current priv mem base", "0x%08x",
            le32toh(status.currentprivmembase));
        show("desired priv io sz", "0x%08x",
            le32toh(status.desiredpriviosize));
        show("current priv io sz", "0x%08x",
            le32toh(status.currentpriviosize));
        show("current priv io base", "0x%08x",
            le32toh(status.currentpriviobase));
}

static void
showddmid(char **argv)
{
        struct {
                struct  i2o_param_op_results pr;
                struct  i2o_param_read_results prr;
                struct  i2o_param_ddm_identity di;
                char padding[128];
        } __packed p;
        char ident[128];
        uint32_t serial[3];

        getparam(gettid(argv), I2O_PARAM_DDM_IDENTITY, &p, sizeof(p));

        show("ddm tid", "%d", le16toh(p.di.ddmtid) & 4095);
        i2ostrvis(p.di.name, sizeof(p.di.name), ident, sizeof(ident));
        show("module name", "%s", ident);
        i2ostrvis(p.di.revlevel, sizeof(p.di.revlevel), ident, sizeof(ident));
        show("module revision", "%s", ident);
        show("serial # format", "%d", p.di.snformat);
        __CTASSERT(sizeof(serial) == sizeof(p.di.serialnumber));
        memcpy(serial, &p.di.serialnumber, sizeof(serial));
        show("serial #", "%08x%08x%08x", serial[0], serial[1], serial[2]);
}

static void
showdevid(char **argv)
{
        struct {
                struct  i2o_param_op_results pr;
                struct  i2o_param_read_results prr;
                struct  i2o_param_device_identity di;
                char padding[128];
        } __packed p;
        char ident[128];

        getparam(gettid(argv), I2O_PARAM_DEVICE_IDENTITY, &p, sizeof(p));

        show("class id", "%d (%s)", le32toh(p.di.classid) & 4095,
            class2str(le32toh(p.di.classid) & 4095));
        show("owner tid", "%d", le32toh(p.di.ownertid) & 4095);
        show("parent tid", "%d", le32toh(p.di.parenttid) & 4095);

        i2ostrvis(p.di.vendorinfo, sizeof(p.di.vendorinfo), ident,
            sizeof(ident));
        show("vendor", "<%s>", ident);

        i2ostrvis(p.di.productinfo, sizeof(p.di.productinfo), ident,
            sizeof(ident));
        show("product", "<%s>", ident);

        i2ostrvis(p.di.description, sizeof(p.di.description), ident,
            sizeof(ident));
        show("description", "<%s>", ident);

        i2ostrvis(p.di.revlevel, sizeof(p.di.revlevel), ident, sizeof(ident));
        show("revision level", "<%s>", ident);
}

static void
reconfig(char **argv)
{

        if (ioctl(fd, IOPIOCRECONFIG))
                err(EXIT_FAILURE, "IOPIOCRECONFIG");
}

static void
showtidmap(char **argv)
{
        struct iovec iov;
        struct iop_tidmap *it;
        int nent;

        iov.iov_base = buf;
        iov.iov_len = sizeof(buf);

        if (ioctl(fd, IOPIOCGTIDMAP, &iov) < 0)
                err(EXIT_FAILURE, "IOPIOCGTIDMAP");

        nent = iov.iov_len / sizeof(*it);
        it = (struct iop_tidmap *)buf;

        for (; nent-- != 0; it++)
                if ((it->it_flags & IT_CONFIGURED) != 0)
                        printf("%s\ttid %d\n", it->it_dvname, it->it_tid);
}

static void
i2ostrvis(const u_char *src, int slen, char *dst, int dlen)
{
        int hc, lc, i, nit;

        dlen--;
        lc = 0;
        hc = 0;
        i = 0;

        /*
         * DPT use NUL as a space, whereas AMI use it as a terminator.  The
         * spec has nothing to say about it.  Since AMI fields are usually
         * filled with junk after the terminator, ...
         */
        nit = (le16toh(status.orgid) != I2O_ORG_DPT);

        while (slen-- != 0 && dlen-- != 0) {
                if (nit && *src == '\0')
                        break;
                else if (*src <= 0x20 || *src >= 0x7f) {
                        if (hc)
                                dst[i++] = ' ';
                } else {
                        hc = 1;
                        dst[i++] = *src;
                        lc = i;
                }
                src++;
        }
        
        dst[lc] = '\0';
}

static int
gettid(char **argv)
{
        char *argp;
        int tid;

        if (argv[1] != NULL)
                usage();

        tid = (int)strtol(argv[0], &argp, 0);
        if (*argp != '\0')
                usage();

        return (tid);
}