ao-tools: Add ao-dumpflash program

This program dumps the entire flash contents of an AltOS device to
allow for external analysis.

Signed-off-by: Keith Packard <keithp@keithp.com>

9 files changed, 268 insertions, 10 deletions

diff --git a/ao-tools/Makefile.am b/ao-tools/Makefile.am
index 871b8205..139eea3f 100644
--- a/ao-tools/Makefile.am
+++ b/ao-tools/Makefile.am
@@ -1 +1,3 @@
-SUBDIRS=lib ao-rawload ao-dbg ao-bitbang ao-eeprom ao-list ao-load ao-telem ao-stmload ao-send-telem ao-sky-flash
+SUBDIRS=lib ao-rawload ao-dbg ao-bitbang ao-eeprom ao-list \
+	ao-load ao-telem ao-stmload ao-send-telem ao-sky-flash \
+	ao-dumpflash
diff --git a/ao-tools/ao-dumpflash/.gitignore b/ao-tools/ao-dumpflash/.gitignore
new file mode 100644
index 00000000..bbce511a
--- /dev/null
+++ b/ao-tools/ao-dumpflash/.gitignore
@@ -0,0 +1 @@
+ao-dumpflash
diff --git a/ao-tools/ao-dumpflash/Makefile.am b/ao-tools/ao-dumpflash/Makefile.am
new file mode 100644
index 00000000..db99f5ae
--- /dev/null
+++ b/ao-tools/ao-dumpflash/Makefile.am
@@ -0,0 +1,12 @@
+bin_PROGRAMS=ao-dumpflash
+
+AM_CFLAGS=-I$(top_srcdir)/ao-tools/lib $(LIBUSB_CFLAGS)
+AO_DUMPLOG_LIBS=$(top_builddir)/ao-tools/lib/libao-tools.a
+
+ao_dumpflash_DEPENDENCIES = $(AO_DUMPLOG_LIBS)
+
+ao_dumpflash_LDADD=$(AO_DUMPLOG_LIBS) $(LIBUSB_LIBS)
+
+ao_dumpflash_SOURCES = ao-dumpflash.c
+
+man_MANS = ao-dumpflash.1
diff --git a/ao-tools/ao-dumpflash/ao-dumpflash.1 b/ao-tools/ao-dumpflash/ao-dumpflash.1
new file mode 100644
index 00000000..07a08ba8
--- /dev/null
+++ b/ao-tools/ao-dumpflash/ao-dumpflash.1
@@ -0,0 +1,71 @@
+.\"
+.\" Copyright © 2013 Keith Packard <keithp@keithp.com>
+.\"
+.\" This program is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that 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.
+.\"
+.\" You should have received a copy of the GNU General Public License along
+.\" with this program; if not, write to the Free Software Foundation, Inc.,
+.\" 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+.\"
+.\"
+.TH AO-DUMPFLASH 1 "ao-dumpflash" ""
+.SH NAME
+ao-dumpflash \- Fetch flash memory contents from AltOS device
+.SH SYNOPSIS
+.B "ao-dumpflash"
+[\--tty \fItty-device\fP]
+[\--device \fIaltos-device\fP]
+[\--output \fIoutput-file\fP]
+[\--remote\fP]
+[\--frequency \fIfrequency\fP]
+[\--call \fIcallsign\fP]
+.SH OPTIONS
+.TP
+\-T tty-device | --tty tty-device
+This selects which tty device ao-dumpflash uses to communicate with
+the target device.
+.TP
+\-D AltOS-device | --device AltOS-device
+Search for a connected device. This requires an argument of one of the
+following forms:
+.IP
+TeleMetrum:2
+.br
+TeleMetrum
+.br
+2
+.IP
+Leaving out the product name will cause the tool to select a suitable
+product, leaving out the serial number will cause the tool to match
+one of the available devices.
+.TP
+\-o output-file | --output output-file
+Write flash contents to the specified file rather than stdout.
+.TP
+\-R | --remote
+This uses the command radio link to download the flash from TeleMetrum
+through a TeleDongle.
+.TP
+\-F frequency | --frequency frequency
+Specifies the radio frequency to use for remote communications in
+kHz. Default is 434550.
+.TP
+\-C callsign | --call callsign
+Specifies the callsign to use for remote communications. Default is N0CALL.
+.SH DESCRIPTION
+.I ao-dumpflash
+downloads the entire flash memory contents from a connected AltOS device and writes
+it to either stdout or the specified output file.
+.SH USAGE
+.I ao-dumpflash
+connects to the specified target device and dumps the flash.
+.SH AUTHOR
+Keith Packard
diff --git a/ao-tools/ao-dumpflash/ao-dumpflash.c b/ao-tools/ao-dumpflash/ao-dumpflash.c
new file mode 100644
index 00000000..3cd21e66
--- /dev/null
+++ b/ao-tools/ao-dumpflash/ao-dumpflash.c
@@ -0,0 +1,175 @@
+/*
+ * Copyright © 2009 Keith Packard <keithp@keithp.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that 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.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <unistd.h>
+#include <getopt.h>
+#include <string.h>
+#include "cc-usb.h"
+#include "cc.h"
+
+#define NUM_BLOCK	512
+
+static const struct option options[] = {
+	{ .name = "tty", .has_arg = 1, .val = 'T' },
+	{ .name = "device", .has_arg = 1, .val = 'D' },
+	{ .name = "remote", .has_arg = 0, .val = 'R' },
+	{ .name = "frequency", .has_arg = 1, .val = 'F' },
+	{ .name = "call", .has_arg = 1, .val = 'C' },
+	{ .name = "output", .has_arg = 1, .val = 'o' },
+	{ 0, 0, 0, 0},
+};
+
+static void usage(char *program)
+{
+	fprintf(stderr, "usage: %s [--tty <tty-name>] [--device <device-name>] [--remote] [--frequency <radio-frequency>] [--call <radio-callsign>]\n", program);
+	exit(1);
+}
+
+int
+main (int argc, char **argv)
+{
+	struct cc_usb	*cc;
+	char		*tty = NULL;
+	char		*device = NULL;
+	int		c;
+	char		line[8192];
+	FILE		*out;
+	char		*filename;
+	int		serial_number = 0;
+	int		freq = 434550;
+	char		*call = "N0CALL";
+	int		flight = 0;
+	char		cmd;
+	int		block;
+	int		addr;
+	int		received_addr;
+	int		data[8];
+	int		done;
+	int		i;
+	int		column;
+	int		remote = 0;
+	int		any_valid;
+	int		invalid;
+	int		storage_size = 0;
+	char		*out_name;
+
+	while ((c = getopt_long(argc, argv, "T:D:F:C:o:R", options, NULL)) != -1) {
+		switch (c) {
+		case 'T':
+			tty = optarg;
+			break;
+		case 'D':
+			device = optarg;
+			break;
+		case 'R':
+			remote = 1;
+			break;
+		case 'F':
+			freq = atoi(optarg);
+			break;
+		case 'C':
+			call = optarg;
+			break;
+		case 'o':
+			out_name = optarg;
+			break;
+		default:
+			usage(argv[0]);
+			break;
+		}
+	}
+	if (!tty) {
+		if (remote)
+			tty = cc_usbdevs_find_by_arg(device, "TeleDongle");
+		else
+			tty = cc_usbdevs_find_by_arg(device, "TeleMetrum");
+	}
+	if (!tty)
+		tty = getenv("ALTOS_TTY");
+	if (!tty)
+		tty="/dev/ttyACM0";
+
+	cc = cc_usb_open(tty);
+	if (!cc)
+		exit(1);
+	if (remote)
+		cc_usb_open_remote(cc, freq, call);
+
+	if (out_name) {
+		out = fopen(out_name, "w");
+		if (!out) {
+			perror(out_name);
+			cc_usb_close(cc);
+			exit(1);
+		}
+	} else
+		out = stdout;
+
+	/* send a 'version' command followed by a 'flash' command */
+	cc_usb_printf(cc, "f\nv\n");
+	for (;;) {
+		cc_usb_getline(cc, line, sizeof (line));
+		if (sscanf(line, "serial-number %u", &serial_number) == 1)
+			continue;
+		if (sscanf(line, "Storage size: %u", &storage_size) == 1)
+			continue;
+		if (!strncmp(line, "software-version", 16))
+			break;
+	}
+	if (!serial_number) {
+		fprintf(stderr, "no serial number found\n");
+		cc_usb_close(cc);
+		exit(1);
+	}
+	if (!storage_size) {
+		fprintf(stderr, "no storage size found\n");
+		cc_usb_close(cc);
+		exit(1);
+	}
+	printf ("Serial number: %d\n", serial_number);
+	printf ("Storage size:  %d\n", storage_size);
+	fprintf (stderr, "%7d of %7d", 0, storage_size/256);
+	for (block = 0; block < storage_size / 256; block++) {
+		cc_usb_printf(cc, "e %x\n", block);
+		fprintf (stderr, "\r%7d of %7d", block + 1, storage_size/256); fflush(stderr);
+		for (addr = 0; addr < 0x100;) {
+			cc_usb_getline(cc, line, sizeof (line));
+			if (sscanf(line, "00%x %x %x %x %x %x %x %x %x",
+					  &received_addr,
+					  &data[0], &data[1], &data[2], &data[3],
+					  &data[4], &data[5], &data[6], &data[7]) == 9)
+			{
+				if (received_addr != addr)
+					fprintf(stderr, "data out of sync at 0x%x\n",
+						block * 256 + received_addr);
+
+				fprintf (out, "%08x", block * 256 + addr);
+				for (i = 0; i < 8; i++)
+					fprintf (out, " %02x", data[i]);
+				fprintf (out, "\n");
+
+				addr += 8;
+			}
+		}
+	}
+	fprintf(stderr, "\n");
+	cc_usb_close(cc);
+	exit (0);
+}
diff --git a/ao-tools/lib/cc-usb.c b/ao-tools/lib/cc-usb.c
index 1580c6d9..9f07e662 100644
--- a/ao-tools/lib/cc-usb.c
+++ b/ao-tools/lib/cc-usb.c
@@ -375,11 +375,12 @@ cc_usb_reset(struct cc_usb *cc)
 }
 
 void
-cc_usb_open_remote(struct cc_usb *cc, int channel)
+cc_usb_open_remote(struct cc_usb *cc, int freq, char *call)
 {
 	if (!cc->remote) {
-		printf ("channel %d\n", channel);
-		cc_usb_printf(cc, "\nc r %d\np\nE 0\n", channel);
+		fprintf (stderr, "freq %dkHz\n", freq);
+		fprintf (stderr, "call %s\n", call);
+		cc_usb_printf(cc, "\nc F %d\nc c %s\np\nE 0\n", freq, call);
 		do {
 			cc->in_count = cc->in_pos = 0;
 			_cc_usb_sync(cc, 100);
diff --git a/ao-tools/lib/cc-usb.h b/ao-tools/lib/cc-usb.h
index d3539281..e90e1195 100644
--- a/ao-tools/lib/cc-usb.h
+++ b/ao-tools/lib/cc-usb.h
@@ -63,7 +63,7 @@ void
 cc_usb_printf(struct cc_usb *cc, char *format, ...);
 
 void
-cc_usb_open_remote(struct cc_usb *cc, int channel);
+cc_usb_open_remote(struct cc_usb *cc, int freq, char *call);
 
 void
 cc_usb_close_remote(struct cc_usb *cc);
diff --git a/ao-tools/lib/ccdbg-flash.c b/ao-tools/lib/ccdbg-flash.c
index 3e672985..1b46870b 100644
--- a/ao-tools/lib/ccdbg-flash.c
+++ b/ao-tools/lib/ccdbg-flash.c
@@ -240,7 +240,6 @@ ccdbg_flash_lock(struct ccdbg *dbg, uint8_t lock)
 uint8_t
 ccdbg_flash_hex_image(struct ccdbg *dbg, struct hex_image *image)
 {
-	uint16_t offset;
 	uint16_t flash_prog;
 	uint16_t flash_len;
 	uint8_t	fwt;
@@ -249,7 +248,6 @@ ccdbg_flash_hex_image(struct ccdbg *dbg, struct hex_image *image)
 	uint16_t flash_words;
 	uint8_t flash_words_high, flash_words_low;
 	uint16_t ram_addr;
-	uint16_t pc;
 	uint8_t status;
 	uint16_t remain, this_time, start;
 	uint8_t verify[0x400];
@@ -284,8 +282,6 @@ ccdbg_flash_hex_image(struct ccdbg *dbg, struct hex_image *image)
 		if (this_time > 0x400)
 			this_time = 0x400;
 
-		offset = ram_addr - (image->address + start);
-
 		ccdbg_debug(CC_DEBUG_FLASH, "Upload %d bytes at 0x%04x\n", this_time, ram_addr);
 		ccdbg_write_memory(dbg, ram_addr, image->data + start, this_time);
 #if 0
@@ -319,7 +315,6 @@ ccdbg_flash_hex_image(struct ccdbg *dbg, struct hex_image *image)
 		ccdbg_write_uint8(dbg, flash_prog + FLASH_WORDS_LOW, flash_words_low);
 
 		ccdbg_set_pc(dbg, flash_prog);
-		pc = ccdbg_get_pc(dbg);
 		ccdbg_debug(CC_DEBUG_FLASH, "Flashing %d bytes at 0x%04x\n",
 			    this_time, flash_addr);
 		status = ccdbg_resume(dbg);
diff --git a/configure.ac b/configure.ac
index 448df6a4..9e5dcaa7 100644
--- a/configure.ac
+++ b/configure.ac
@@ -181,6 +181,7 @@ ao-tools/ao-telem/Makefile
 ao-tools/ao-stmload/Makefile
 ao-tools/ao-send-telem/Makefile
 ao-tools/ao-sky-flash/Makefile
+ao-tools/ao-dumpflash/Makefile
 ao-utils/Makefile
 src/Version
 ])