2 * Copyright © 2012 Keith Packard <keithp@keithp.com>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; version 2 of the License.
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
29 #include "stlink-common.h"
34 #include "ao-stmload.h"
35 #include "ao-selfload.h"
36 #include "ao-verbose.h"
38 #define AO_USB_DESC_STRING 3
40 struct ao_sym ao_symbols[] = {
42 { 0, AO_BOOT_APPLICATION_BASE + 0x100, "ao_romconfig_version", 1 },
43 #define AO_ROMCONFIG_VERSION (ao_symbols[0].addr)
45 { 0, AO_BOOT_APPLICATION_BASE + 0x102, "ao_romconfig_check", 1 },
46 #define AO_ROMCONFIG_CHECK (ao_symbols[1].addr)
48 { 0, AO_BOOT_APPLICATION_BASE + 0x104, "ao_serial_number", 1 },
49 #define AO_SERIAL_NUMBER (ao_symbols[2].addr)
51 { 0, AO_BOOT_APPLICATION_BASE + 0x108, "ao_radio_cal", 0 },
52 #define AO_RADIO_CAL (ao_symbols[3].addr)
54 { 0, AO_BOOT_APPLICATION_BASE + 0x10c, "ao_usb_descriptors", 0 },
55 #define AO_USB_DESCRIPTORS (ao_symbols[4].addr)
59 #define NUM_REQUIRED_SYMBOLS 3
61 int ao_num_symbols = NUM_SYMBOLS;
62 int ao_num_required_symbols = NUM_REQUIRED_SYMBOLS;
65 * Edit the to-be-written memory block
68 rewrite(struct ao_hex_image *load, unsigned address, uint8_t *data, int length)
72 if (address < load->address || load->address + load->length < address + length)
75 printf("rewrite %04x:", address);
76 for (i = 0; i < length; i++)
77 printf (" %02x", load->data[address - load->address + i]);
79 for (i = 0; i < length; i++)
80 printf (" %02x", data[i]);
82 memcpy(load->data + address - load->address, data, length);
86 * Read a 16-bit value from the USB target
90 get_uint16_cc(struct cc_usb *cc, uint32_t addr)
92 struct ao_hex_image *hex = ao_self_read(cc, addr, 2);
98 data = hex->data + addr - hex->address;
99 v = data[0] | (data[1] << 8);
105 get_uint32_cc(struct cc_usb *cc, uint32_t addr)
107 struct ao_hex_image *hex = ao_self_read(cc, addr, 4);
113 data = hex->data + addr - hex->address;
114 v = data[0] | (data[1] << 8) | (data[2] << 16) | (data[3] << 24);
120 * Read a 16-bit value from the target device with arbitrary
124 get_uint16_sl(stlink_t *sl, uint32_t addr)
126 const uint8_t *data = sl->q_buf;
127 uint32_t actual_addr;
134 actual_addr = addr & ~3;
136 stlink_read_mem32(sl, actual_addr, 8);
142 result = data[off] | (data[off + 1] << 8);
147 get_uint16(stlink_t *sl, struct cc_usb *cc, uint32_t addr)
151 result = get_uint16_cc(cc, addr);
153 result = get_uint16_sl(sl, addr);
154 printf ("read 0x%08x = 0x%04x\n", addr, result);
159 * Read a 32-bit value from the target device with arbitrary
163 get_uint32_sl(stlink_t *sl, uint32_t addr)
165 const uint8_t *data = sl->q_buf;
166 uint32_t actual_addr;
172 printf ("read 0x%x\n", addr);
174 actual_addr = addr & ~3;
176 stlink_read_mem32(sl, actual_addr, 8);
182 result = data[off] | (data[off + 1] << 8) | (data[off+2] << 16) | (data[off+3] << 24);
187 * Read a 32-bit value from the target device with arbitrary
191 get_uint32(stlink_t *sl, struct cc_usb *cc, uint32_t addr)
196 result = get_uint32_cc(cc, addr);
198 result = get_uint32_sl(sl, addr);
199 printf ("read 0x%08x = 0x%08x\n", addr, result);
204 * Check to see if the target device has been
205 * flashed with a similar firmware image before
207 * This is done by looking for the same romconfig version,
208 * which should be at the same location as the linker script
209 * places this at 0x100 from the start of the rom section
212 check_flashed(stlink_t *sl, struct cc_usb *cc)
214 uint16_t romconfig_version = get_uint16(sl, cc, AO_ROMCONFIG_VERSION);
215 uint16_t romconfig_check = get_uint16(sl, cc, AO_ROMCONFIG_CHECK);
217 if (romconfig_version != (uint16_t) ~romconfig_check) {
218 fprintf (stderr, "Device has not been flashed before\n");
225 * Find the symbols needed to correctly load the program
229 find_symbols(struct ao_sym *file_symbols, int num_file_symbols,
230 struct ao_sym *symbols, int num_symbols)
234 for (f = 0; f < num_file_symbols; f++) {
235 for (s = 0; s < num_symbols; s++) {
236 if (strcmp(symbols[s].name, file_symbols[f].name) == 0) {
237 symbols[s].addr = file_symbols[f].addr;
238 symbols[s].found = true;
242 for (s = 0; s < num_symbols; s++)
243 if (!symbols[s].found && symbols[s].required)
248 static const struct option options[] = {
249 { .name = "stlink", .has_arg = 0, .val = 'S' },
250 { .name = "tty", .has_arg = 1, .val = 'T' },
251 { .name = "device", .has_arg = 1, .val = 'D' },
252 { .name = "cal", .has_arg = 1, .val = 'c' },
253 { .name = "serial", .has_arg = 1, .val = 's' },
254 { .name = "verbose", .has_arg = 1, .val = 'v' },
258 static void usage(char *program)
260 fprintf(stderr, "usage: %s [--stlink] [--verbose=<verbose>] [--device=<device>] [-tty=<tty>] [--cal=<radio-cal>] [--serial=<serial>] file.{elf,ihx}\n", program);
265 done(stlink_t *sl, struct cc_usb *cc, int code)
268 /* cc_usb_printf(cc, "a\n"); */
274 stlink_exit_debug_mode(sl);
281 ends_with(char *whole, char *suffix)
283 int whole_len = strlen(whole);
284 int suffix_len = strlen(suffix);
286 if (suffix_len > whole_len)
288 return strcmp(whole + whole_len - suffix_len, suffix) == 0;
292 main (int argc, char **argv)
298 unsigned int serial = 0;
311 struct ao_hex_image *load;
313 struct cc_usb *cc = NULL;
318 struct ao_sym *file_symbols;
319 int num_file_symbols;
321 while ((c = getopt_long(argc, argv, "T:D:c:s:Sv:", options, NULL)) != -1) {
330 cal = strtoul(optarg, &cal_end, 10);
331 if (cal_end == optarg || *cal_end != '\0')
335 serial = strtoul(optarg, &serial_end, 10);
336 if (serial_end == optarg || *serial_end != '\0')
351 ao_verbose = verbose;
354 ccdbg_add_debug(CC_DEBUG_BITBANG);
356 filename = argv[optind];
357 if (filename == NULL)
360 if (ends_with (filename, ".elf")) {
361 load = ao_load_elf(filename, &file_symbols, &num_file_symbols);
362 } else if (ends_with (filename, ".ihx")) {
363 load = ao_hex_load(filename, &file_symbols, &num_file_symbols);
367 if (!find_symbols(file_symbols, num_file_symbols, ao_symbols, ao_num_symbols))
368 fprintf(stderr, "Cannot find required symbols\n");
371 /* Connect to the programming dongle
374 for (tries = 0; tries < 3; tries++) {
376 sl = stlink_v1_open(50);
378 sl = stlink_open_usb(50);
382 fprintf (stderr, "No STLink devices present\n");
386 if (sl->chip_id != 0)
393 fprintf (stderr, "Debugger connection failed\n");
397 /* Verify that the loaded image fits entirely within device flash
399 if (load->address < sl->flash_base ||
400 sl->flash_base + sl->flash_size < load->address + load->length) {
401 fprintf (stderr, "\%s\": Invalid memory range 0x%08x - 0x%08x\n", filename,
402 load->address, load->address + load->length);
406 /* Enter debugging mode
408 if (stlink_current_mode(sl) == STLINK_DEV_DFU_MODE)
409 stlink_exit_dfu_mode(sl);
411 if (stlink_current_mode(sl) != STLINK_DEV_DEBUG_MODE)
412 stlink_enter_swd_mode(sl);
417 for (tries = 0; tries < 3; tries++) {
418 char *this_tty = tty;
420 this_tty = cc_usbdevs_find_by_arg(device, "AltosFlash");
422 this_tty = cc_usbdevs_find_by_arg(device, "MegaMetrum");
424 this_tty = getenv("ALTOS_TTY");
426 this_tty="/dev/ttyACM0";
428 cc = cc_usb_open(this_tty);
432 cc_usb_printf(cc, "v\n");
436 cc_usb_getline(cc, line, sizeof(line));
437 if (!strncmp(line, "altos-loader", 12))
439 if (!strncmp(line, "software-version", 16))
444 printf ("rebooting to loader\n");
445 cc_usb_printf(cc, "X\n");
451 fprintf(stderr, "Cannot switch to boot loader\n");
459 ao_self_block_read(cc, AO_BOOT_APPLICATION_BASE, check);
468 ao_self_block_write(cc, AO_BOOT_APPLICATION_BASE, block);
469 ao_self_block_read(cc, AO_BOOT_APPLICATION_BASE, block);
470 if (memcmp(block, check, 256) != 0) {
471 fprintf (stderr, "read differed\n");
479 /* Go fetch existing config values
482 was_flashed = check_flashed(sl, cc);
486 fprintf (stderr, "Must provide serial number\n");
489 serial = get_uint16(sl, cc, AO_SERIAL_NUMBER);
490 if (!serial || serial == 0xffff) {
491 fprintf (stderr, "Invalid existing serial %d\n", serial);
496 if (!cal && AO_RADIO_CAL && was_flashed) {
497 cal = get_uint32(sl, cc, AO_RADIO_CAL);
498 if (!cal || cal == 0xffffffff) {
499 fprintf (stderr, "Invalid existing rf cal %d\n", cal);
504 /* Write the config values into the flash image
507 serial_int[0] = serial & 0xff;
508 serial_int[1] = (serial >> 8) & 0xff;
510 if (!rewrite(load, AO_SERIAL_NUMBER, serial_int, sizeof (serial_int))) {
511 fprintf(stderr, "Cannot rewrite serial integer at %08x\n",
516 if (AO_USB_DESCRIPTORS) {
517 uint32_t usb_descriptors = AO_USB_DESCRIPTORS - load->address;
520 while (load->data[usb_descriptors] != 0 && usb_descriptors < load->length) {
521 if (load->data[usb_descriptors+1] == AO_USB_DESC_STRING) {
526 usb_descriptors += load->data[usb_descriptors];
528 if (usb_descriptors >= load->length || load->data[usb_descriptors] == 0 ) {
529 fprintf(stderr, "Cannot rewrite serial string at %08x\n", AO_USB_DESCRIPTORS);
533 serial_ucs2_len = load->data[usb_descriptors] - 2;
534 serial_ucs2 = malloc(serial_ucs2_len);
536 fprintf(stderr, "Malloc(%d) failed\n", serial_ucs2_len);
540 for (i = serial_ucs2_len / 2; i; i--) {
541 serial_ucs2[i * 2 - 1] = 0;
542 serial_ucs2[i * 2 - 2] = (s % 10) + '0';
545 if (!rewrite(load, usb_descriptors + 2 + load->address, serial_ucs2, serial_ucs2_len)) {
546 fprintf (stderr, "Cannot rewrite USB descriptor at %08x\n", AO_USB_DESCRIPTORS);
551 if (cal && AO_RADIO_CAL) {
552 cal_int[0] = cal & 0xff;
553 cal_int[1] = (cal >> 8) & 0xff;
554 cal_int[2] = (cal >> 16) & 0xff;
555 cal_int[3] = (cal >> 24) & 0xff;
557 if (!rewrite(load, AO_RADIO_CAL, cal_int, sizeof (cal_int))) {
558 fprintf(stderr, "Cannot rewrite radio calibration at %08x\n", AO_RADIO_CAL);
563 /* And flash the resulting image to the device
566 success = ao_self_write(cc, load);
568 success = (stlink_write_flash(sl, load->address, load->data, load->length) >= 0);
571 fprintf (stderr, "\"%s\": Write failed\n", filename);