root/usr.sbin/fwcontrol/fwcontrol.c
/*
 * Copyright (C) 2002
 *      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.
 *
 * $FreeBSD: src/usr.sbin/fwcontrol/fwcontrol.c,v 1.1.2.8 2003/05/01 06:26:35 simokawa Exp $
 */

#include <sys/param.h>
#include <sys/socket.h>
#include <sys/ioctl.h>
#include <sys/errno.h>
#include <bus/firewire/firewire.h>
#include <bus/firewire/iec13213.h>

#include <netinet/in.h>
#include <fcntl.h>
#include <stdio.h>
#include <err.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

extern int dvrecv(int, char *, char, int);
extern int dvsend(int, char *, char, int);

static void
usage(void)
{
        fprintf(stderr,
                "fwcontrol [-g gap_count] [-o node] [-b pri_req] [-c node]"
                        " [-r] [-t] [-d node] [-l file] [-R file] [-S file]\n"
                "\t-g: broadcast gap_count by phy_config packet\n"
                "\t-o: send link-on packet to the node\n"
                "\t-s: write RESET_START register on the node\n"
                "\t-b: set PRIORITY_BUDGET register on all supported nodes\n"
                "\t-c: read configuration ROM\n"
                "\t-r: bus reset\n"
                "\t-t: read topology map\n"
                "\t-d: hex dump of configuration ROM\n"
                "\t-l: load and parse hex dump file of configuration ROM\n"
                "\t-R: Receive DV stream\n"
                "\t-S: Send DV stream\n");
        exit(0);
}

static struct fw_devlstreq *
get_dev(int fd)
{
        struct fw_devlstreq *data;

        data = (struct fw_devlstreq *)malloc(sizeof(struct fw_devlstreq));
        if (data == NULL)
                err(1, "malloc");
        if( ioctl(fd, FW_GDEVLST, data) < 0) {
                        err(1, "ioctl");
        }
        return data;
}

static void
list_dev(int fd)
{
        struct fw_devlstreq *data;
        struct fw_devinfo *devinfo;
        int i;

        data = get_dev(fd);
        printf("%d devices (info_len=%d)\n", data->n, data->info_len);
        printf("node       EUI64       status\n");
        for (i = 0; i < data->info_len; i++) {
                devinfo = &data->dev[i];
                printf("%4d  %08x%08x %6d\n",
                        (devinfo->status || i == 0) ? devinfo->dst : -1,
                        devinfo->eui.hi,
                        devinfo->eui.lo,
                        devinfo->status
                );
        }
        free((void *)data);
}

static u_int32_t
read_write_quad(int fd, struct fw_eui64 eui, u_int32_t addr_lo, int readmode, u_int32_t data)
{
        struct fw_asyreq *asyreq;
        u_int32_t *qld, res;

        asyreq = (struct fw_asyreq *)malloc(sizeof(struct fw_asyreq_t) + 16);
        asyreq->req.len = 16;
#if 0
        asyreq->req.type = FWASREQNODE;
        asyreq->pkt.mode.rreqq.dst = FWLOCALBUS | node;
#else
        asyreq->req.type = FWASREQEUI;
        asyreq->req.dst.eui = eui;
#endif
        asyreq->pkt.mode.rreqq.tlrt = 0;
        if (readmode)
                asyreq->pkt.mode.rreqq.tcode = FWTCODE_RREQQ;
        else
                asyreq->pkt.mode.rreqq.tcode = FWTCODE_WREQQ;

        asyreq->pkt.mode.rreqq.dest_hi = 0xffff;
        asyreq->pkt.mode.rreqq.dest_lo = addr_lo;

        qld = (u_int32_t *)&asyreq->pkt;
        if (!readmode)
                asyreq->pkt.mode.wreqq.data = data;

        if (ioctl(fd, FW_ASYREQ, asyreq) < 0) {
                err(1, "ioctl");
        }
        res = qld[3];
        free(asyreq);
        if (readmode)
                return ntohl(res);
        else
                return 0;
}

static void
send_phy_config(int fd, int root_node, int gap_count)
{
        struct fw_asyreq *asyreq;

        asyreq = (struct fw_asyreq *)malloc(sizeof(struct fw_asyreq_t) + 12);
        asyreq->req.len = 12;
        asyreq->req.type = FWASREQNODE;
        asyreq->pkt.mode.ld[0] = 0;
        asyreq->pkt.mode.ld[1] = 0;
        asyreq->pkt.mode.common.tcode = FWTCODE_PHY;
        if (root_node >= 0)
                asyreq->pkt.mode.ld[1] |= (root_node & 0x3f) << 24 | 1 << 23;
        if (gap_count >= 0)
                asyreq->pkt.mode.ld[1] |= 1 << 22 | (gap_count & 0x3f) << 16;
        asyreq->pkt.mode.ld[2] = ~asyreq->pkt.mode.ld[1];

        printf("send phy_config root_node=%d gap_count=%d\n",
                                                root_node, gap_count);

        if (ioctl(fd, FW_ASYREQ, asyreq) < 0)
                err(1, "ioctl");
        free(asyreq);
}

static void
send_link_on(int fd, int node)
{
        struct fw_asyreq *asyreq;

        asyreq = (struct fw_asyreq *)malloc(sizeof(struct fw_asyreq_t) + 12);
        asyreq->req.len = 12;
        asyreq->req.type = FWASREQNODE;
        asyreq->pkt.mode.ld[1] = 0;
        asyreq->pkt.mode.ld[2] = 0;
        asyreq->pkt.mode.common.tcode = FWTCODE_PHY;
        asyreq->pkt.mode.ld[1] |= (1 << 30) | ((node & 0x3f) << 24);
        asyreq->pkt.mode.ld[2] = ~asyreq->pkt.mode.ld[1];

        if (ioctl(fd, FW_ASYREQ, asyreq) < 0)
                err(1, "ioctl");
        free(asyreq);
}

static void
reset_start(int fd, int node)
{
        struct fw_asyreq *asyreq;

        asyreq = (struct fw_asyreq *)malloc(sizeof(struct fw_asyreq_t) + 16);
        asyreq->req.len = 16;
        asyreq->req.type = FWASREQNODE;
        asyreq->pkt.mode.wreqq.dst = FWLOCALBUS | (node & 0x3f);
        asyreq->pkt.mode.wreqq.tlrt = 0;
        asyreq->pkt.mode.wreqq.tcode = FWTCODE_WREQQ;

        asyreq->pkt.mode.wreqq.dest_hi = 0xffff;
        asyreq->pkt.mode.wreqq.dest_lo = 0xf0000000 | RESET_START;

        asyreq->pkt.mode.wreqq.data = htonl(0x1);

        if (ioctl(fd, FW_ASYREQ, asyreq) < 0)
                err(1, "ioctl");
        free(asyreq);
}

static void
set_pri_req(int fd, u_int32_t pri_req)
{
        struct fw_devlstreq *data;
        struct fw_devinfo *devinfo;
        u_int32_t max, reg, old;
        int i;

        data = get_dev(fd);
#define BUGET_REG 0xf0000218
        for (i = 0; i < data->info_len; i++) {
                devinfo = &data->dev[i];
                if (!devinfo->status)
                        continue;
                reg = read_write_quad(fd, devinfo->eui, BUGET_REG, 1, 0);
                printf("%d %08x:%08x, %08x",
                        devinfo->dst, devinfo->eui.hi, devinfo->eui.lo, reg);
                if (reg > 0) {
                        old = (reg & 0x3f);
                        max = (reg & 0x3f00) >> 8;
                        if (pri_req > max)
                                pri_req =  max;
                        printf(" 0x%x -> 0x%x\n", old, pri_req);
                        read_write_quad(fd, devinfo->eui, BUGET_REG, 0, pri_req);
                } else {
                        printf("\n");
                }
        }
        free((void *)data);
}

static void
parse_bus_info_block(u_int32_t *p, int info_len)
{
        int i;

        for (i = 0; i < info_len; i++) {
                printf("bus_info%d: 0x%08x\n", i, *p++);
        }
}

static int
get_crom(int fd, int node, void *crom_buf, int len)
{
        struct fw_crom_buf buf;
        int i, error;
        struct fw_devlstreq *data;

        data = get_dev(fd);

        for (i = 0; i < data->info_len; i++) {
                if (data->dev[i].dst == node && data->dev[i].eui.lo != 0)
                        break;
        }
        if (i == data->info_len)
                errx(1, "no such node %d.", node);
        else if (i == 0)
                errx(1, "node %d is myself.", node);
        else
                buf.eui = data->dev[i].eui;
        free((void *)data);

        buf.len = len;
        buf.ptr = crom_buf;
        if ((error = ioctl(fd, FW_GCROM, &buf)) < 0) {
                err(1, "ioctl");
        }

        return error;
}

static void
show_crom(u_int32_t *crom_buf)
{
        int i;
        struct crom_context cc;
        const char *desc;
        char info[256];
        static const char *key_types = "ICLD";
        struct csrreg *reg;
        struct csrdirectory *dir;
        struct csrhdr *hdr;
        u_int16_t crc;

        printf("first quad: 0x%08x ", *crom_buf);
        hdr = (struct csrhdr *)crom_buf;
        if (hdr->info_len == 1) {
                /* minimum ROM */
                reg = (struct csrreg *)hdr;
                printf("verndor ID: 0x%06x\n",  reg->val);
                return;
        }
        printf("info_len=%d crc_len=%d crc=0x%04x",
                hdr->info_len, hdr->crc_len, hdr->crc);
        crc = crom_crc(crom_buf+1, hdr->crc_len);
        if (crc == hdr->crc)
                printf("(OK)\n");
        else
                printf("(NG)\n");
        parse_bus_info_block(crom_buf+1, hdr->info_len);

        crom_init_context(&cc, crom_buf);
        dir = cc.stack[0].dir;
        printf("root_directory: len=0x%04x(%d) crc=0x%04x",
                        dir->crc_len, dir->crc_len, dir->crc);
        crc = crom_crc((u_int32_t *)&dir->entry[0], dir->crc_len);
        if (crc == dir->crc)
                printf("(OK)\n");
        else
                printf("(NG)\n");
        if (dir->crc_len < 1)
                return;
        while (cc.depth >= 0) {
                desc = crom_desc(&cc, info, sizeof(info));
                reg = crom_get(&cc);
                for (i = 0; i < cc.depth; i++)
                        printf("\t");
                printf("%02x(%c:%02x) %06x %s: %s\n",
                        reg->key,
                        key_types[(reg->key & CSRTYPE_MASK)>>6],
                        reg->key & CSRKEY_MASK, reg->val,
                        desc, info);
                crom_next(&cc);
        }
}

#define DUMP_FORMAT     "%08x %08x %08x %08x %08x %08x %08x %08x\n"

static void
dump_crom(u_int32_t *p)
{
        int len=1024, i;

        for (i = 0; i < len/(4*8); i ++) {
                printf(DUMP_FORMAT,
                        p[0], p[1], p[2], p[3], p[4], p[5], p[6], p[7]);
                p += 8;
        }
}

static void
load_crom(char *filename, u_int32_t *p)
{
        FILE *file;
        int len=1024, i;

        if ((file = fopen(filename, "r")) == NULL)
                err(1, "load_crom");
        for (i = 0; i < len/(4*8); i ++) {
                fscanf(file, DUMP_FORMAT,
                        p, p+1, p+2, p+3, p+4, p+5, p+6, p+7);
                p += 8;
        }
}

static void
show_topology_map(int fd)
{
        struct fw_topology_map *tmap;
        union fw_self_id sid;
        int i;
        static const char *port_status[] = {" ", "-", "P", "C"};
        static const char *pwr_class[] = {" 0W", "15W", "30W", "45W",
                                        "-1W", "-2W", "-5W", "-9W"};
        static const char *speed[] = {"S100", "S200", "S400", "S800"};
        tmap = malloc(sizeof(struct fw_topology_map));
        if (tmap == NULL)
                return;
        if (ioctl(fd, FW_GTPMAP, tmap) < 0) {
                err(1, "ioctl");
        }
        printf("crc_len: %d generation:%d node_count:%d sid_count:%d\n",
                tmap->crc_len, tmap->generation,
                tmap->node_count, tmap->self_id_count);
        printf("id link gap_cnt speed delay cIRM power port0 port1 port2"
                " ini more\n");
        for (i = 0; i < tmap->crc_len - 2; i++) {
                sid = tmap->self_id[i];
                if (sid.p0.sequel) {
                        printf("%02d sequel packet\n", sid.p0.phy_id);
                        continue;
                }
                printf("%02d   %2d      %2d  %4s     %d    %d   %3s"
                                "     %s     %s     %s   %d    %d\n",
                        sid.p0.phy_id,
                        sid.p0.link_active,
                        sid.p0.gap_count,
                        speed[sid.p0.phy_speed],
                        sid.p0.phy_delay,
                        sid.p0.contender,
                        pwr_class[sid.p0.power_class],
                        port_status[sid.p0.port0],
                        port_status[sid.p0.port1],
                        port_status[sid.p0.port2],
                        sid.p0.initiated_reset,
                        sid.p0.more_packets
                );
        }
        free(tmap);
}

int
main(int argc, char **argv)
{
        char devicename[256];
        u_int32_t crom_buf[1024/4];
        int fd, i, tmp, ch, len=1024;

        for (i = 0; i < 4; i++) {
                snprintf(devicename, sizeof(devicename), "/dev/fw%d", i);
                if ((fd = open(devicename, O_RDWR)) >= 0)
                        break;
        }
        if (fd < 0)
                err(1, "open");

        if (argc < 2) {
                list_dev(fd);
        }

        while ((ch = getopt(argc, argv, "g:o:s:b:rtc:d:l:R:S:")) != -1)
                switch(ch) {
                case 'g':
                        tmp = strtol(optarg, NULL, 0);
                        send_phy_config(fd, -1, tmp);
                        break;
                case 'o':
                        tmp = strtol(optarg, NULL, 0);
                        send_link_on(fd, tmp);
                        break;
                case 's':
                        tmp = strtol(optarg, NULL, 0);
                        reset_start(fd, tmp);
                        break;
                case 'b':
                        tmp = strtol(optarg, NULL, 0);
                        set_pri_req(fd, tmp);
                        break;
                case 'r':
                        if(ioctl(fd, FW_IBUSRST, &tmp) < 0)
                                err(1, "ioctl");
                        break;
                case 't':
                        show_topology_map(fd);
                        break;
                case 'c':
                        tmp = strtol(optarg, NULL, 0);
                        get_crom(fd, tmp, crom_buf, len);
                        show_crom(crom_buf);
                        break;
                case 'd':
                        tmp = strtol(optarg, NULL, 0);
                        get_crom(fd, tmp, crom_buf, len);
                        dump_crom(crom_buf);
                        break;
                case 'l':
                        load_crom(optarg, crom_buf);
                        show_crom(crom_buf);
                        break;
#define TAG     (1<<6)
#define CHANNEL 63
                case 'R':
                        dvrecv(fd, optarg, TAG | CHANNEL, -1);
                        break;
                case 'S':
                        dvsend(fd, optarg, TAG | CHANNEL, -1);
                        break;
                default:
                        usage();
                }
        return 0;
}