root/sound/firewire/bebob/bebob_proc.c
// SPDX-License-Identifier: GPL-2.0-only
/*
 * bebob_proc.c - a part of driver for BeBoB based devices
 *
 * Copyright (c) 2013-2014 Takashi Sakamoto
 */

#include "./bebob.h"

/* contents of information register */
struct hw_info {
        u64 manufacturer;
        u32 protocol_ver;
        u32 bld_ver;
        u32 guid[2];
        u32 model_id;
        u32 model_rev;
        u64 fw_date;
        u64 fw_time;
        u32 fw_id;
        u32 fw_ver;
        u32 base_addr;
        u32 max_size;
        u64 bld_date;
        u64 bld_time;
/* may not used in product
        u64 dbg_date;
        u64 dbg_time;
        u32 dbg_id;
        u32 dbg_version;
*/
} __packed;

static void
proc_read_hw_info(struct snd_info_entry *entry,
                  struct snd_info_buffer *buffer)
{
        struct snd_bebob *bebob = entry->private_data;
        struct hw_info *info;

        info = kzalloc_obj(struct hw_info);
        if (info == NULL)
                return;

        if (snd_bebob_read_block(bebob->unit, 0,
                                   info, sizeof(struct hw_info)) < 0)
                goto end;

        snd_iprintf(buffer, "Manufacturer:\t%.8s\n",
                    (char *)&info->manufacturer);
        snd_iprintf(buffer, "Protocol Ver:\t%d\n", info->protocol_ver);
        snd_iprintf(buffer, "Build Ver:\t%d\n", info->bld_ver);
        snd_iprintf(buffer, "GUID:\t\t0x%.8X%.8X\n",
                    info->guid[0], info->guid[1]);
        snd_iprintf(buffer, "Model ID:\t0x%02X\n", info->model_id);
        snd_iprintf(buffer, "Model Rev:\t%d\n", info->model_rev);
        snd_iprintf(buffer, "Firmware Date:\t%.8s\n", (char *)&info->fw_date);
        snd_iprintf(buffer, "Firmware Time:\t%.8s\n", (char *)&info->fw_time);
        snd_iprintf(buffer, "Firmware ID:\t0x%X\n", info->fw_id);
        snd_iprintf(buffer, "Firmware Ver:\t%d\n", info->fw_ver);
        snd_iprintf(buffer, "Base Addr:\t0x%X\n", info->base_addr);
        snd_iprintf(buffer, "Max Size:\t%d\n", info->max_size);
        snd_iprintf(buffer, "Loader Date:\t%.8s\n", (char *)&info->bld_date);
        snd_iprintf(buffer, "Loader Time:\t%.8s\n", (char *)&info->bld_time);

end:
        kfree(info);
}

static void
proc_read_meters(struct snd_info_entry *entry,
                 struct snd_info_buffer *buffer)
{
        struct snd_bebob *bebob = entry->private_data;
        const struct snd_bebob_meter_spec *spec = bebob->spec->meter;
        u32 *buf;
        unsigned int i, c, channels, size;

        if (spec == NULL)
                return;

        channels = spec->num * 2;
        size = channels * sizeof(u32);
        buf = kmalloc(size, GFP_KERNEL);
        if (buf == NULL)
                return;

        if (spec->get(bebob, buf, size) < 0)
                goto end;

        for (i = 0, c = 1; i < channels; i++) {
                snd_iprintf(buffer, "%s %d:\t%d\n",
                            spec->labels[i / 2], c++, buf[i]);
                if ((i + 1 < channels - 1) &&
                    (strcmp(spec->labels[i / 2],
                            spec->labels[(i + 1) / 2]) != 0))
                        c = 1;
        }
end:
        kfree(buf);
}

static void
proc_read_formation(struct snd_info_entry *entry,
                struct snd_info_buffer *buffer)
{
        struct snd_bebob *bebob = entry->private_data;
        struct snd_bebob_stream_formation *formation;
        unsigned int i;

        snd_iprintf(buffer, "Output Stream from device:\n");
        snd_iprintf(buffer, "\tRate\tPCM\tMIDI\n");
        formation = bebob->tx_stream_formations;
        for (i = 0; i < SND_BEBOB_STRM_FMT_ENTRIES; i++) {
                snd_iprintf(buffer,
                            "\t%d\t%d\t%d\n", snd_bebob_rate_table[i],
                            formation[i].pcm, formation[i].midi);
        }

        snd_iprintf(buffer, "Input Stream to device:\n");
        snd_iprintf(buffer, "\tRate\tPCM\tMIDI\n");
        formation = bebob->rx_stream_formations;
        for (i = 0; i < SND_BEBOB_STRM_FMT_ENTRIES; i++) {
                snd_iprintf(buffer,
                            "\t%d\t%d\t%d\n", snd_bebob_rate_table[i],
                            formation[i].pcm, formation[i].midi);
        }
}

static void
proc_read_clock(struct snd_info_entry *entry,
                struct snd_info_buffer *buffer)
{
        static const char *const clk_labels[] = {
                "Internal",
                "External",
                "SYT-Match",
        };
        struct snd_bebob *bebob = entry->private_data;
        const struct snd_bebob_rate_spec *rate_spec = bebob->spec->rate;
        const struct snd_bebob_clock_spec *clk_spec = bebob->spec->clock;
        enum snd_bebob_clock_type src;
        unsigned int rate;

        if (rate_spec->get(bebob, &rate) >= 0)
                snd_iprintf(buffer, "Sampling rate: %d\n", rate);

        if (snd_bebob_stream_get_clock_src(bebob, &src) >= 0) {
                if (clk_spec)
                        snd_iprintf(buffer, "Clock Source: %s\n",
                                    clk_labels[src]);
                else
                        snd_iprintf(buffer, "Clock Source: %s (MSU-dest: %d)\n",
                                    clk_labels[src], bebob->sync_input_plug);
        }
}

static void
add_node(struct snd_bebob *bebob, struct snd_info_entry *root, const char *name,
         void (*op)(struct snd_info_entry *e, struct snd_info_buffer *b))
{
        struct snd_info_entry *entry;

        entry = snd_info_create_card_entry(bebob->card, name, root);
        if (entry)
                snd_info_set_text_ops(entry, bebob, op);
}

void snd_bebob_proc_init(struct snd_bebob *bebob)
{
        struct snd_info_entry *root;

        /*
         * All nodes are automatically removed at snd_card_disconnect(),
         * by following to link list.
         */
        root = snd_info_create_card_entry(bebob->card, "firewire",
                                          bebob->card->proc_root);
        if (root == NULL)
                return;
        root->mode = S_IFDIR | 0555;

        add_node(bebob, root, "clock", proc_read_clock);
        add_node(bebob, root, "firmware", proc_read_hw_info);
        add_node(bebob, root, "formation", proc_read_formation);

        if (bebob->spec->meter != NULL)
                add_node(bebob, root, "meter", proc_read_meters);
}