logger: fix column and header alignments

tools/logger/convert.c

@@ -279,18 +279,37 @@ static double to_usecs(uint64_t time)
 	return (double)time / global_config->clock;
 }
 
+/** Justified timestamp width for printf format string */
+static unsigned int timestamp_width(unsigned int precision)
+{
+	/* 64bits yields less than 20 digits precision. As reported by
+	 * gcc 9.3, this avoids a very long precision causing snprintf()
+	 * to truncate time_fmt
+	 */
+	assert(precision >= 0 && precision < 20);
+	/*
+	 * 12 digits for units is enough for 1M seconds = 11 days which
+	 * should be enough for most test runs.
+	 *
+	 * Add 1 for the comma when there is one.
+	 */
+	return 12 + (precision > 0 ? 1 : 0) + precision;
+}
+
 static inline void print_table_header(void)
 {
 	FILE *out_fd = global_config->out_fd;
 	int hide_location = global_config->hide_location;
-	int time_precision = global_config->time_precision;
 	char time_fmt[32];
 
-	if (time_precision >= 0) {
-		snprintf(time_fmt, sizeof(time_fmt), "%%%ds %%%ds ",
-			 time_precision + 12, time_precision + 12);
-		fprintf(out_fd, time_fmt, "TIMESTAMP", "DELTA");
+	if (global_config->time_precision >= 0) {
+		const unsigned int ts_width =
+			timestamp_width(global_config->time_precision);
+		snprintf(time_fmt, sizeof(time_fmt), "%%-%ds(us)%%%ds  ",
+			 ts_width, ts_width);
+		fprintf(out_fd, time_fmt, " TIMESTAMP", "DELTA");
 	}
+
 	fprintf(out_fd, "%2s %-18s ", "C#", "COMPONENT");
 	if (!hide_location)
 		fprintf(out_fd, "%-29s ", "LOCATION");
@@ -442,16 +461,13 @@ static void print_entry_params(const struct log_entry_header *dma_log,
 				format_file_name(entry->file_name, raw_output),
 				entry->header.line_idx);
 	} else {
-		/* timestamp */
-		/* 64bits yields less than 20 digits precision. As
-		 * reported by gcc 9.3, this avoids a very long
-		 * precision causing snprintf() to truncate time_fmt
-		 */
-		if (time_precision >= 0 && time_precision < 20) {
+		if (time_precision >= 0) {
+			const unsigned int ts_width = timestamp_width(time_precision);
+
 			snprintf(time_fmt, sizeof(time_fmt),
 				 "%%s[%%%d.%df] (%%%d.%df)%%s ",
-				 time_precision + 10, time_precision,
-				 time_precision + 10, time_precision);
+				 ts_width, time_precision, ts_width, time_precision);
+
 			fprintf(out_fd, time_fmt,
 				use_colors ? KGRN : "",
 				to_usecs(dma_log->timestamp - timestamp_origin), dt,
@@ -628,7 +644,8 @@ static int fetch_entry(const struct log_entry_header *dma_log, uint64_t *last_ti
 				goto out;
 			}
 			if (ret != size)
-				log_err("Partial read of %u bytes of %lu.\n", ret, size);
+				log_err("Partial read of %u bytes of %lu, reading more\n",
+					ret, size);
 		}
 	}
 

tools/logger/logger.c

@@ -31,10 +31,13 @@ static const char *debugfs[] = {
 	"hda", "pp", "dsp",
 };
 
+/** See PLATFORM_DEFAULT_CLOCK in the firmware code. */
+static const float DEFAULT_CLOCK_MHZ = 19.2;
+
 static void usage(void)
 {
 	fprintf(stdout, "Usage %s <option(s)> <file(s)>\n", APP_NAME);
-	fprintf(stdout, "%s:\t \t\t\tDisplay mailbox contents\n", APP_NAME);
+	fprintf(stdout, "%s:\t \t\t\tDisplay mailbox or DMA trace contents\n", APP_NAME);
 	fprintf(stdout, "%s:\t -i infile -o outfile\tDump infile contents "
 		"to outfile\n", APP_NAME);
 	fprintf(stdout, "%s:\t -l *.ldc_file\t\t*.ldc files generated by smex\n",
@@ -44,11 +47,12 @@ static void usage(void)
 		"with ver_file file\n", APP_NAME);
 	fprintf(stdout, "%s:\t -n\t\t\tDisable checking firmware version\n",
 		APP_NAME);
-	fprintf(stdout, "%s:\t -c clock\t\tSet timestamp clock in MHz\n",
-		APP_NAME);
+	fprintf(stdout, "%s:\t -c clock\t\tSet timestamp clock in MHz, %.2f MHz by default\n",
+		APP_NAME, DEFAULT_CLOCK_MHZ);
 	fprintf(stdout, "%s:\t -s state_name\t\tTake a snapshot of state\n",
 		APP_NAME);
-	fprintf(stdout, "%s:\t -t\t\t\tDisplay trace data\n", APP_NAME);
+	fprintf(stdout, "%s:\t -t\t\t\tDMA 'trace' stream instead of 'etrace' error mailbox\n",
+		APP_NAME);
 	fprintf(stdout, "%s:\t -u baud\t\tInput data from a UART\n", APP_NAME);
 	fprintf(stdout, "%s:\t -r\t\t\tLess formatted output for "
 		"chained log processors\n",
@@ -175,7 +179,7 @@ int main(int argc, char *argv[])
 	int opt, ret = 0;
 
 	config.trace = 0;
-	config.clock = 19.2;
+	config.clock = DEFAULT_CLOCK_MHZ;
 	config.in_file = NULL;
 	config.out_file = NULL;
 	config.out_fd = NULL;