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.
28 #include "stlink-common.h"
33 #include "ao-stmload.h"
35 #define AO_USB_DESC_STRING 3
37 struct sym ao_symbols[] = {
39 { 0, AO_BOOT_APPLICATION_BASE + 0x100, "ao_romconfig_version", 1 },
40 #define AO_ROMCONFIG_VERSION (ao_symbols[0].addr)
42 { 0, AO_BOOT_APPLICATION_BASE + 0x102, "ao_romconfig_check", 1 },
43 #define AO_ROMCONFIG_CHECK (ao_symbols[1].addr)
45 { 0, AO_BOOT_APPLICATION_BASE + 0x104, "ao_serial_number", 1 },
46 #define AO_SERIAL_NUMBER (ao_symbols[2].addr)
48 { 0, AO_BOOT_APPLICATION_BASE + 0x108, "ao_radio_cal", 0 },
49 #define AO_RADIO_CAL (ao_symbols[3].addr)
51 { 0, AO_BOOT_APPLICATION_BASE + 0x10c, "ao_usb_descriptors", 0 },
52 #define AO_USB_DESCRIPTORS (ao_symbols[4].addr)
56 #define NUM_REQUIRED_SYMBOLS 3
58 int ao_num_symbols = NUM_SYMBOLS;
59 int ao_num_required_symbols = NUM_REQUIRED_SYMBOLS;
62 * Edit the to-be-written memory block
65 rewrite(struct hex_image *load, unsigned address, uint8_t *data, int length)
69 if (address < load->address || load->address + load->length < address + length)
72 printf("rewrite %04x:", address);
73 for (i = 0; i < length; i++)
74 printf (" %02x", load->data[address - load->address + i]);
76 for (i = 0; i < length; i++)
77 printf (" %02x", data[i]);
79 memcpy(load->data + address - load->address, data, length);
83 * Read a 16-bit value from the USB target
87 get_uint16_cc(struct cc_usb *cc, uint32_t addr)
89 struct hex_image *hex = ao_self_read(cc, addr, 2);
95 data = hex->data + addr - hex->address;
96 v = data[0] | (data[1] << 8);
102 get_uint32_cc(struct cc_usb *cc, uint32_t addr)
104 struct hex_image *hex = ao_self_read(cc, addr, 4);
110 data = hex->data + addr - hex->address;
111 v = data[0] | (data[1] << 8) | (data[2] << 16) | (data[3] << 24);
117 * Read a 16-bit value from the target device with arbitrary
121 get_uint16_sl(stlink_t *sl, uint32_t addr)
123 const uint8_t *data = sl->q_buf;
124 uint32_t actual_addr;
131 actual_addr = addr & ~3;
133 stlink_read_mem32(sl, actual_addr, 8);
139 result = data[off] | (data[off + 1] << 8);
144 get_uint16(stlink_t *sl, struct cc_usb *cc, uint32_t addr)
148 result = get_uint16_cc(cc, addr);
150 result = get_uint16_sl(sl, addr);
151 printf ("read 0x%08x = 0x%04x\n", addr, result);
156 * Read a 32-bit value from the target device with arbitrary
160 get_uint32_sl(stlink_t *sl, uint32_t addr)
162 const uint8_t *data = sl->q_buf;
163 uint32_t actual_addr;
169 printf ("read 0x%x\n", addr);
171 actual_addr = addr & ~3;
173 stlink_read_mem32(sl, actual_addr, 8);
179 result = data[off] | (data[off + 1] << 8) | (data[off+2] << 16) | (data[off+3] << 24);
184 * Read a 32-bit value from the target device with arbitrary
188 get_uint32(stlink_t *sl, struct cc_usb *cc, uint32_t addr)
193 result = get_uint32_cc(cc, addr);
195 result = get_uint32_sl(sl, addr);
196 printf ("read 0x%08x = 0x%08x\n", addr, result);
201 * Check to see if the target device has been
202 * flashed with a similar firmware image before
204 * This is done by looking for the same romconfig version,
205 * which should be at the same location as the linker script
206 * places this at 0x100 from the start of the rom section
209 check_flashed(stlink_t *sl, struct cc_usb *cc)
211 uint16_t romconfig_version = get_uint16(sl, cc, AO_ROMCONFIG_VERSION);
212 uint16_t romconfig_check = get_uint16(sl, cc, AO_ROMCONFIG_CHECK);
214 if (romconfig_version != (uint16_t) ~romconfig_check) {
215 fprintf (stderr, "Device has not been flashed before\n");
221 static const struct option options[] = {
222 { .name = "stlink", .has_arg = 0, .val = 'S' },
223 { .name = "tty", .has_arg = 1, .val = 'T' },
224 { .name = "device", .has_arg = 1, .val = 'D' },
225 { .name = "cal", .has_arg = 1, .val = 'c' },
226 { .name = "serial", .has_arg = 1, .val = 's' },
227 { .name = "verbose", .has_arg = 0, .val = 'v' },
231 static void usage(char *program)
233 fprintf(stderr, "usage: %s [--stlink] [--verbose] [--device=<device>] [-tty=<tty>] [--cal=<radio-cal>] [--serial=<serial>] file.{elf,ihx}\n", program);
238 done(stlink_t *sl, struct cc_usb *cc, int code)
241 /* cc_usb_printf(cc, "a\n"); */
247 stlink_exit_debug_mode(sl);
254 ends_with(char *whole, char *suffix)
256 int whole_len = strlen(whole);
257 int suffix_len = strlen(suffix);
259 if (suffix_len > whole_len)
261 return strcmp(whole + whole_len - suffix_len, suffix) == 0;
265 main (int argc, char **argv)
271 unsigned int serial = 0;
284 struct hex_image *load;
286 struct cc_usb *cc = NULL;
292 while ((c = getopt_long(argc, argv, "T:D:c:s:Sv", options, NULL)) != -1) {
301 cal = strtoul(optarg, &cal_end, 10);
302 if (cal_end == optarg || *cal_end != '\0')
306 serial = strtoul(optarg, &serial_end, 10);
307 if (serial_end == optarg || *serial_end != '\0')
322 ao_self_verbose = verbose;
325 ccdbg_add_debug(CC_DEBUG_BITBANG);
327 filename = argv[optind];
328 if (filename == NULL)
331 if (ends_with (filename, ".elf")) {
332 load = ao_load_elf(filename);
333 } else if (ends_with (filename, ".ihx")) {
335 load = ccdbg_hex_load(filename);
336 for (i = 0; i < ao_num_symbols; i++)
337 ao_symbols[i].addr = ao_symbols[i].default_addr;
342 /* Connect to the programming dongle
345 for (tries = 0; tries < 3; tries++) {
347 sl = stlink_v1_open(50);
349 sl = stlink_open_usb(50);
353 fprintf (stderr, "No STLink devices present\n");
357 if (sl->chip_id != 0)
364 fprintf (stderr, "Debugger connection failed\n");
368 /* Verify that the loaded image fits entirely within device flash
370 if (load->address < sl->flash_base ||
371 sl->flash_base + sl->flash_size < load->address + load->length) {
372 fprintf (stderr, "\%s\": Invalid memory range 0x%08x - 0x%08x\n", filename,
373 load->address, load->address + load->length);
377 /* Enter debugging mode
379 if (stlink_current_mode(sl) == STLINK_DEV_DFU_MODE)
380 stlink_exit_dfu_mode(sl);
382 if (stlink_current_mode(sl) != STLINK_DEV_DEBUG_MODE)
383 stlink_enter_swd_mode(sl);
388 for (tries = 0; tries < 3; tries++) {
389 char *this_tty = tty;
391 this_tty = cc_usbdevs_find_by_arg(device, "AltosFlash");
393 this_tty = cc_usbdevs_find_by_arg(device, "MegaMetrum");
395 this_tty = getenv("ALTOS_TTY");
397 this_tty="/dev/ttyACM0";
399 cc = cc_usb_open(this_tty);
403 cc_usb_printf(cc, "v\n");
407 cc_usb_getline(cc, line, sizeof(line));
408 if (!strncmp(line, "altos-loader", 12))
410 if (!strncmp(line, "software-version", 16))
415 printf ("rebooting to loader\n");
416 cc_usb_printf(cc, "X\n");
422 fprintf(stderr, "Cannot switch to boot loader\n");
430 ao_self_block_read(cc, AO_BOOT_APPLICATION_BASE, check);
439 ao_self_block_write(cc, AO_BOOT_APPLICATION_BASE, block);
440 ao_self_block_read(cc, AO_BOOT_APPLICATION_BASE, block);
441 if (memcmp(block, check, 256) != 0) {
442 fprintf (stderr, "read differed\n");
450 /* Go fetch existing config values
453 was_flashed = check_flashed(sl, cc);
457 fprintf (stderr, "Must provide serial number\n");
460 serial = get_uint16(sl, cc, AO_SERIAL_NUMBER);
461 if (!serial || serial == 0xffff) {
462 fprintf (stderr, "Invalid existing serial %d\n", serial);
467 if (!cal && AO_RADIO_CAL && was_flashed) {
468 cal = get_uint32(sl, cc, AO_RADIO_CAL);
469 if (!cal || cal == 0xffffffff) {
470 fprintf (stderr, "Invalid existing rf cal %d\n", cal);
475 /* Write the config values into the flash image
478 serial_int[0] = serial & 0xff;
479 serial_int[1] = (serial >> 8) & 0xff;
481 if (!rewrite(load, AO_SERIAL_NUMBER, serial_int, sizeof (serial_int))) {
482 fprintf(stderr, "Cannot rewrite serial integer at %08x\n",
487 if (AO_USB_DESCRIPTORS) {
488 uint32_t usb_descriptors = AO_USB_DESCRIPTORS - load->address;
491 while (load->data[usb_descriptors] != 0 && usb_descriptors < load->length) {
492 if (load->data[usb_descriptors+1] == AO_USB_DESC_STRING) {
497 usb_descriptors += load->data[usb_descriptors];
499 if (usb_descriptors >= load->length || load->data[usb_descriptors] == 0 ) {
500 fprintf(stderr, "Cannot rewrite serial string at %08x\n", AO_USB_DESCRIPTORS);
504 serial_ucs2_len = load->data[usb_descriptors] - 2;
505 serial_ucs2 = malloc(serial_ucs2_len);
507 fprintf(stderr, "Malloc(%d) failed\n", serial_ucs2_len);
511 for (i = serial_ucs2_len / 2; i; i--) {
512 serial_ucs2[i * 2 - 1] = 0;
513 serial_ucs2[i * 2 - 2] = (s % 10) + '0';
516 if (!rewrite(load, usb_descriptors + 2 + load->address, serial_ucs2, serial_ucs2_len)) {
517 fprintf (stderr, "Cannot rewrite USB descriptor at %08x\n", AO_USB_DESCRIPTORS);
522 if (cal && AO_RADIO_CAL) {
523 cal_int[0] = cal & 0xff;
524 cal_int[1] = (cal >> 8) & 0xff;
525 cal_int[2] = (cal >> 16) & 0xff;
526 cal_int[3] = (cal >> 24) & 0xff;
528 if (!rewrite(load, AO_RADIO_CAL, cal_int, sizeof (cal_int))) {
529 fprintf(stderr, "Cannot rewrite radio calibration at %08x\n", AO_RADIO_CAL);
534 /* And flash the resulting image to the device
537 success = ao_self_write(cc, load);
539 success = (stlink_write_flash(sl, load->address, load->data, load->length) >= 0);
542 fprintf (stderr, "\"%s\": Write failed\n", filename);