u-boot/common/cmd_iotrace.c
Simon Glass aa53233a15 Add an I/O tracing feature
When debugging drivers it is useful to see what I/O accesses were done
and in what order.

Even if the individual accesses are of little interest it can be useful to
verify that the access pattern is consistent each time an operation is
performed. In this case a checksum can be used to characterise the operation
of a driver. The checksum can be compared across different runs of the
operation to verify that the driver is working properly.

In particular, when performing major refactoring of the driver, where the
access pattern should not change, the checksum provides assurance that the
refactoring work has not broken the driver.

Add an I/O tracing feature and associated commands to provide this facility.
It works by sneaking into the io.h heder for an architecture and redirecting
I/O accesses through its tracing mechanism.

For now no commands are provided to examine the trace buffer. The format is
fairly simple, so 'md' is a reasonable substitute.

Note: The checksum feature is only useful for I/O regions where the contents
do not change outside of software control. Where this is not suitable you can
fall back to manually comparing the addresses. It might be useful to enhance
tracing to only checksum the accesses and not the data read/written.

Signed-off-by: Simon Glass <sjg@chromium.org>
2014-06-20 11:54:29 -06:00

73 lines
1.6 KiB
C

/*
* Copyright (c) 2014 Google, Inc
*
* SPDX-License-Identifier: GPL-2.0+
*/
#include <common.h>
#include <command.h>
#include <iotrace.h>
static void do_print_stats(void)
{
ulong start, size, offset, count;
printf("iotrace is %sabled\n", iotrace_get_enabled() ? "en" : "dis");
iotrace_get_buffer(&start, &size, &offset, &count);
printf("Start: %08lx\n", start);
printf("Size: %08lx\n", size);
printf("Offset: %08lx\n", offset);
printf("Output: %08lx\n", start + offset);
printf("Count: %08lx\n", count);
printf("CRC32: %08lx\n", (ulong)iotrace_get_checksum());
}
static int do_set_buffer(int argc, char * const argv[])
{
ulong addr = 0, size = 0;
if (argc == 2) {
addr = simple_strtoul(*argv++, NULL, 16);
size = simple_strtoul(*argv++, NULL, 16);
} else if (argc != 0) {
return CMD_RET_USAGE;
}
iotrace_set_buffer(addr, size);
return 0;
}
int do_iotrace(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
{
const char *cmd = argc < 2 ? NULL : argv[1];
if (!cmd)
return cmd_usage(cmdtp);
switch (*cmd) {
case 'b':
return do_set_buffer(argc - 2, argv + 2);
case 'p':
iotrace_set_enabled(0);
break;
case 'r':
iotrace_set_enabled(1);
break;
case 's':
do_print_stats();
break;
default:
return CMD_RET_USAGE;
}
return 0;
}
U_BOOT_CMD(
iotrace, 4, 1, do_iotrace,
"iotrace utility commands",
"stats - display iotrace stats\n"
"iotrace buffer <address> <size> - set iotrace buffer\n"
"iotrace pause - pause tracing\n"
"iotrace resume - resume tracing"
);