soft/rmbox/rmbox.c

/*
 * mbox dump to debug log convertor.
 *
 * Copyright (c) 2015, Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 */

#include <stdlib.h>
#include <stdio.h>
#include <unistd.h>
#include <stdint.h>
#include <errno.h>
#include <string.h>
#include <ctype.h>

#define KNRM  "\x1B[0m"
#define KRED  "\x1B[31m"

// TODO: include all this stuff

#define TRACE_CLASS_IRQ		(1 << 24)
#define TRACE_CLASS_IPC		(2 << 24)
#define TRACE_CLASS_PIPE	(3 << 24)
#define TRACE_CLASS_HOST	(4 << 24)
#define TRACE_CLASS_DAI		(5 << 24)
#define TRACE_CLASS_DMA		(6 << 24)
#define TRACE_CLASS_SSP		(7 << 24)
#define TRACE_CLASS_COMP	(8 << 24)
#define TRACE_CLASS_WAIT	(9 << 24)
#define TRACE_CLASS_LOCK	(10 << 24)
#define TRACE_CLASS_MEM		(11 << 24)
#define TRACE_CLASS_MIXER	(12 << 24)
#define TRACE_CLASS_BUFFER	(13 << 24)
#define TRACE_CLASS_VOLUME	(14 << 24)
#define TRACE_CLASS_SWITCH	(15 << 24)
#define TRACE_CLASS_MUX		(16 << 24)
#define TRACE_CLASS_SRC         (17 << 24)
#define TRACE_CLASS_TONE        (18 << 24)
#define TRACE_CLASS_EQ_FIR      (19 << 24)
#define TRACE_CLASS_EQ_IIR      (20 << 24)

#define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))


#define TRACE_BLOCK_SIZE	8

static inline char get_char(uint32_t val, int idx)
{
	char c = (val >> (idx * 8)) & 0xff;
	if (c < '0' || c > 'z')
		return '.';
	else
		return c;
}

static void usage(char *name)
{
	fprintf(stdout, "Usage %s <option(s)> <file(s)>\n", name);
	fprintf(stdout, "%s:\t \t\t\tDisplay mailbox contents\n", name);
	fprintf(stdout, "%s:\t -i infile -o outfile\tDump infile contents to outfile\n", name);
	fprintf(stdout, "%s:\t -c\t\t\tSet timestamp clock in MHz\n", name);
	fprintf(stdout, "%s:\t -s\t\t\tTake a snapshot of state\n", name);
	fprintf(stdout, "%s:\t -t\t\t\tDisplay trace data\n", name);
	exit(0);
}

static double to_usecs(uint64_t time, double clk)
{
	/* trace timestamp uses CPU system clock at default 25MHz ticks */
	// TODO: support variable clock rates
	return (double)time / clk;
}

static void show_trace(uint64_t val, uint64_t addr, uint64_t *timestamp, double clk)
{
	const char *trace;
	uint32_t class;
	uint64_t delta = val - *timestamp;
	double fdelta = to_usecs(delta, clk);
	double us = 0.0f;

	/* timestamp or value ? */
	if ((addr % (TRACE_BLOCK_SIZE * 2)) == 0) {

		delta = val - *timestamp;
		fdelta = to_usecs(delta, clk);

		/* 64-bit timestamp */
		us = to_usecs(val, clk);

		/* empty data ? */
		if (val == 0) {
			*timestamp = 0;
			return;
		}

		/* detect wrap around */
		if (fdelta < 1000.0 * 1000.0 * 1000.0)
			printf("0x%lx [%6.6f]\tdelta [%6.6f]\t", addr,
				us / 1000000.0 , fdelta / 1000000.0);
		else
			printf("0x%lx [%6.6f]\tdelta [********]\t", addr,
				us / 1000000.0);

		*timestamp = val;
		return;
	} else if (*timestamp == 0)
		return;

	/* check for printable values - otherwise it's a value */
	if (!isprint((char)(val >> 16)) || !isprint((char)(val >> 8)) || !isprint((char)val)) {
		printf("value 0x%16.16lx\n", val);
		return;
	}

	class = val & 0xff000000;
	if (class == TRACE_CLASS_IRQ)
		trace = "irq";
	else if (class == TRACE_CLASS_IPC)
		trace = "ipc";
	else if (class == TRACE_CLASS_PIPE)
		trace = "pipe";
	else if (class == TRACE_CLASS_HOST)
		trace = "host";
	else if (class == TRACE_CLASS_DAI)
		trace = "dai";
	else if (class == TRACE_CLASS_DMA)
		trace = "dma";
	else if (class == TRACE_CLASS_SSP)
		trace = "ssp";
	else if (class == TRACE_CLASS_COMP)
		trace = "comp";
	else if (class == TRACE_CLASS_WAIT)
		trace = "wait";
	else if (class == TRACE_CLASS_LOCK)
		trace = "lock";
	else if (class == TRACE_CLASS_MEM)
		trace = "mem";
	else if (class == TRACE_CLASS_MIXER)
		trace = "mixer";
	else if (class == TRACE_CLASS_BUFFER)
		trace = "buffer";
	else if (class == TRACE_CLASS_VOLUME)
		trace = "volume";
	else if (class == TRACE_CLASS_SWITCH)
		trace = "switch";
	else if (class == TRACE_CLASS_MUX)
		trace = "mux";
	else if (class == TRACE_CLASS_SRC)
		trace = "src";
	else if (class == TRACE_CLASS_TONE)
		trace = "tone";
	else if (class == TRACE_CLASS_EQ_FIR)
		trace = "eq-fir";
	else if (class == TRACE_CLASS_EQ_IIR)
		trace = "eq-iir";
	else {
		printf("value 0x%8.8x\n", (uint32_t)val);
		return;
	}

	switch ((char)(val >> 16)) {
	case 'e':
	case 'E':
	case 'x':
	case 'X':
		printf("%s%s %c%c%c%s\n", KRED, trace,
		(char)(val >> 16), (char)(val >> 8), (char)val, KNRM);
		break;
	default:
		printf("%s %c%c%c\n", trace,
		(char)(val >> 16), (char)(val >> 8), (char)val);
		break;
	}
}

static int trace_read(const char *in_file, const char *out_file, double clk)
{
	int count, i;
	FILE *in_fd = NULL, *out_fd = NULL;
	char c, tmp[TRACE_BLOCK_SIZE] = {0};
	uint64_t addr = 0, val, timestamp = 0;

	in_fd = fopen(in_file, "r");
	if (in_fd == NULL) {
		fprintf(stderr, "error: unable to open %s for reading %d\n",
			in_file, errno);
		return -EIO;
	}

	if (out_file == NULL)
		goto trace;

	out_fd = fopen(out_file, "w");
	if (out_fd == NULL) {
		fprintf(stderr, "error: unable to open %s for writing %d\n",
			out_file, errno);
	}

trace:
	fprintf(stdout, "using %2.2fMHz timestamp clock\n", clk);

	while (1) {
		count = fread(&tmp[0], 1, TRACE_BLOCK_SIZE, in_fd);
		if (count != TRACE_BLOCK_SIZE)
			break;

		val = *((uint64_t*)tmp);

		for (i = 0; i < TRACE_BLOCK_SIZE / 2; i++) {
			c = tmp[i];
			tmp[i] = tmp[TRACE_BLOCK_SIZE - i - 1];
			tmp[TRACE_BLOCK_SIZE - i - 1] = c;
		}

		show_trace(val, addr, &timestamp, clk);

		if (out_fd) {
			count = fwrite(&tmp[0], 1, TRACE_BLOCK_SIZE, out_fd);
			if (count != TRACE_BLOCK_SIZE)
				break;
		}

		addr += TRACE_BLOCK_SIZE;
	}

	fclose(in_fd);
	if (out_fd)
		fclose(out_fd);

	return 0;
}

static void show_data(uint32_t val, uint32_t addr)
{
	printf("data: 0x%x = \t0x%8.8x \t(%8.8d) \t|%c%c%c%c|\n",
					(unsigned int)addr,
					val, val,
					get_char(val, 3), get_char(val, 2),
					get_char(val, 1), get_char(val, 0));
}


static const char *debugfs[] = {
	"dmac0", "dmac1", "ssp0", "ssp1",
	"ssp2", "iram", "dram", "shim",
	"mbox", "etrace",
};

static int snapshot(const char *name)
{
	const char *path = "/sys/kernel/debug/sof";
	uint32_t val, addr;
	char pinname[64], poutname[64], buffer[128];
	FILE *in_fd, *out_fd;
	int i, count;

	if (name == NULL) {
		fprintf(stderr, "error: need snapshot name\n");
		return -EINVAL;
	}

	for (i = 0; i < ARRAY_SIZE(debugfs); i++) {

		sprintf(pinname, "%s/%s", path, debugfs[i]);
		sprintf(poutname, "%s.%s.txt", name, debugfs[i]);

		/* open debugfs for reading */
		in_fd = fopen(pinname, "r");
		if (in_fd == NULL) {
			fprintf(stderr, "error: unable to open %s for reading %d\n",
				pinname, errno);
			continue;
		}

		/* open outfile for reading */
		out_fd = fopen(poutname, "w");
		if (out_fd == NULL) {
			fprintf(stderr, "error: unable to open %s for writing %d\n",
				poutname, errno);
			fclose(in_fd);
			continue;
		}

		fprintf(stdout, "processing %s...\n", pinname);
		addr = 0;

		while (1) {
			count = fread(&val, 1, 4, in_fd);
			if (count != 4)
				break;

			sprintf(buffer, "0x%6.6x: 0x%8.8x\n", addr, val);

			count = fwrite(buffer, 1, strlen(buffer), out_fd);

			addr += 4;
		}

		fclose(in_fd);
		fclose(out_fd);
	}

	return 0;
}

int main(int argc, char *argv[])
{
	int opt, count, trace = 0;
	const char * out_file = NULL, *in_file = NULL;
	FILE *in_fd = NULL, *out_fd = NULL;
	char c, tmp[8] = {0};
	uint64_t addr = 0, val, timestamp = 0, align = 4, i;
	double clk = 19.2;

	while ((opt = getopt(argc, argv, "ho:i:s:m:c:t")) != -1) {
		switch (opt) {
		case 'o':
			out_file = optarg;
			break;
		case 'i':
			in_file = optarg;
			break;
		case 't':
			trace = 1;
			break;
		case 'c':
			clk = atof(optarg);
			break;
		case 's':
			return snapshot(optarg);
		case 'h':
		default: /* '?' */
			usage(argv[0]);
		}
	}

	/* trace requested ? */
	if (trace)
		return trace_read("/sys/kernel/debug/sof/trace",
			out_file, clk);

	/* default option with no infile is to dump errors/debug data */
	if (in_file == NULL) {
		fprintf(stdout, "\nError log:\n");
		return trace_read("/sys/kernel/debug/sof/etrace",
			out_file, clk);
	}

	/* open infile for reading */
	in_fd = fopen(in_file, "r");
	if (in_fd == NULL) {
		fprintf(stderr, "error: unable to open %s for reading %d\n",
			in_file, errno);
		return -EIO;
	}

	/* open outfile for writing */
	if (out_file == NULL)
		goto convert;

	out_fd = fopen(out_file, "w");
	if (out_fd == NULL) {
		fprintf(stderr, "error: unable to open %s for writing %d\n",
			out_file, errno);
		fclose(in_fd);
		return -EIO;
	}

	/* start to converting mailbox */
convert:
	fprintf(stdout, "using %2.2fMHz timestamp clock\n", clk);

	while (1) {
		count = fread(&tmp[0], 1, align, in_fd);
		if (count != align)
			break;

		val = *((uint64_t*)tmp);

		for (i = 0; i < align / 2; i++) {
			c = tmp[i];
			tmp[i] = tmp[align - i - 1];
			tmp[align - i - 1] = c;
		}

		show_data(val, addr);

		if (out_fd) {
			count = fwrite(&tmp[0], 1, align, out_fd);
			if (count != align)
				break;
		}

		addr += align;
	}

	/* close files */
	fclose(in_fd);
	if (out_fd)
		fclose(out_fd);

	return 0;
}