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"
36 #define AO_USB_DESC_STRING 3
38 struct ao_sym ao_symbols[] = {
40 { 0, AO_BOOT_APPLICATION_BASE + 0x100, "ao_romconfig_version", 1 },
41 #define AO_ROMCONFIG_VERSION (ao_symbols[0].addr)
43 { 0, AO_BOOT_APPLICATION_BASE + 0x102, "ao_romconfig_check", 1 },
44 #define AO_ROMCONFIG_CHECK (ao_symbols[1].addr)
46 { 0, AO_BOOT_APPLICATION_BASE + 0x104, "ao_serial_number", 1 },
47 #define AO_SERIAL_NUMBER (ao_symbols[2].addr)
49 { 0, AO_BOOT_APPLICATION_BASE + 0x108, "ao_radio_cal", 0 },
50 #define AO_RADIO_CAL (ao_symbols[3].addr)
52 { 0, AO_BOOT_APPLICATION_BASE + 0x10c, "ao_usb_descriptors", 0 },
53 #define AO_USB_DESCRIPTORS (ao_symbols[4].addr)
57 #define NUM_REQUIRED_SYMBOLS 3
59 int ao_num_symbols = NUM_SYMBOLS;
60 int ao_num_required_symbols = NUM_REQUIRED_SYMBOLS;
63 * Edit the to-be-written memory block
66 rewrite(struct ao_hex_image *load, unsigned address, uint8_t *data, int length)
70 if (address < load->address || load->address + load->length < address + length)
73 printf("rewrite %04x:", address);
74 for (i = 0; i < length; i++)
75 printf (" %02x", load->data[address - load->address + i]);
77 for (i = 0; i < length; i++)
78 printf (" %02x", data[i]);
80 memcpy(load->data + address - load->address, data, length);
84 * Read a 16-bit value from the USB target
88 get_uint16_cc(struct cc_usb *cc, uint32_t addr)
90 struct ao_hex_image *hex = ao_self_read(cc, addr, 2);
96 data = hex->data + addr - hex->address;
97 v = data[0] | (data[1] << 8);
103 get_uint32_cc(struct cc_usb *cc, uint32_t addr)
105 struct ao_hex_image *hex = ao_self_read(cc, addr, 4);
111 data = hex->data + addr - hex->address;
112 v = data[0] | (data[1] << 8) | (data[2] << 16) | (data[3] << 24);
118 * Read a 16-bit value from the target device with arbitrary
122 get_uint16_sl(stlink_t *sl, uint32_t addr)
124 const uint8_t *data = sl->q_buf;
125 uint32_t actual_addr;
132 actual_addr = addr & ~3;
134 stlink_read_mem32(sl, actual_addr, 8);
140 result = data[off] | (data[off + 1] << 8);
145 get_uint16(stlink_t *sl, struct cc_usb *cc, uint32_t addr)
149 result = get_uint16_cc(cc, addr);
151 result = get_uint16_sl(sl, addr);
152 printf ("read 0x%08x = 0x%04x\n", addr, result);
157 * Read a 32-bit value from the target device with arbitrary
161 get_uint32_sl(stlink_t *sl, uint32_t addr)
163 const uint8_t *data = sl->q_buf;
164 uint32_t actual_addr;
170 printf ("read 0x%x\n", addr);
172 actual_addr = addr & ~3;
174 stlink_read_mem32(sl, actual_addr, 8);
180 result = data[off] | (data[off + 1] << 8) | (data[off+2] << 16) | (data[off+3] << 24);
185 * Read a 32-bit value from the target device with arbitrary
189 get_uint32(stlink_t *sl, struct cc_usb *cc, uint32_t addr)
194 result = get_uint32_cc(cc, addr);
196 result = get_uint32_sl(sl, addr);
197 printf ("read 0x%08x = 0x%08x\n", addr, result);
202 * Check to see if the target device has been
203 * flashed with a similar firmware image before
205 * This is done by looking for the same romconfig version,
206 * which should be at the same location as the linker script
207 * places this at 0x100 from the start of the rom section
210 check_flashed(stlink_t *sl, struct cc_usb *cc)
212 uint16_t romconfig_version = get_uint16(sl, cc, AO_ROMCONFIG_VERSION);
213 uint16_t romconfig_check = get_uint16(sl, cc, AO_ROMCONFIG_CHECK);
215 if (romconfig_version != (uint16_t) ~romconfig_check) {
216 fprintf (stderr, "Device has not been flashed before\n");
223 * Find the symbols needed to correctly load the program
227 find_symbols(struct ao_sym *file_symbols, int num_file_symbols,
228 struct ao_sym *symbols, int num_symbols)
232 for (f = 0; f < num_file_symbols; f++) {
233 for (s = 0; s < num_symbols; s++) {
234 if (strcmp(symbols[s].name, file_symbols[f].name) == 0) {
235 symbols[s].addr = file_symbols[f].addr;
236 symbols[s].found = true;
240 for (s = 0; s < num_symbols; s++)
241 if (!symbols[s].found && symbols[s].required)
246 static const struct option options[] = {
247 { .name = "stlink", .has_arg = 0, .val = 'S' },
248 { .name = "tty", .has_arg = 1, .val = 'T' },
249 { .name = "device", .has_arg = 1, .val = 'D' },
250 { .name = "cal", .has_arg = 1, .val = 'c' },
251 { .name = "serial", .has_arg = 1, .val = 's' },
252 { .name = "verbose", .has_arg = 0, .val = 'v' },
256 static void usage(char *program)
258 fprintf(stderr, "usage: %s [--stlink] [--verbose] [--device=<device>] [-tty=<tty>] [--cal=<radio-cal>] [--serial=<serial>] file.{elf,ihx}\n", program);
263 done(stlink_t *sl, struct cc_usb *cc, int code)
266 /* cc_usb_printf(cc, "a\n"); */
272 stlink_exit_debug_mode(sl);
279 ends_with(char *whole, char *suffix)
281 int whole_len = strlen(whole);
282 int suffix_len = strlen(suffix);
284 if (suffix_len > whole_len)
286 return strcmp(whole + whole_len - suffix_len, suffix) == 0;
290 main (int argc, char **argv)
296 unsigned int serial = 0;
309 struct ao_hex_image *load;
311 struct cc_usb *cc = NULL;
316 struct ao_sym *file_symbols;
317 int num_file_symbols;
319 while ((c = getopt_long(argc, argv, "T:D:c:s:Sv", options, NULL)) != -1) {
328 cal = strtoul(optarg, &cal_end, 10);
329 if (cal_end == optarg || *cal_end != '\0')
333 serial = strtoul(optarg, &serial_end, 10);
334 if (serial_end == optarg || *serial_end != '\0')
349 ao_self_verbose = verbose;
352 ccdbg_add_debug(CC_DEBUG_BITBANG);
354 filename = argv[optind];
355 if (filename == NULL)
358 if (ends_with (filename, ".elf")) {
359 load = ao_load_elf(filename, &file_symbols, &num_file_symbols);
360 } else if (ends_with (filename, ".ihx")) {
361 load = ao_hex_load(filename, &file_symbols, &num_file_symbols);
365 if (!find_symbols(file_symbols, num_file_symbols, ao_symbols, ao_num_symbols))
366 fprintf(stderr, "Cannot find required symbols\n");
369 /* Connect to the programming dongle
372 for (tries = 0; tries < 3; tries++) {
374 sl = stlink_v1_open(50);
376 sl = stlink_open_usb(50);
380 fprintf (stderr, "No STLink devices present\n");
384 if (sl->chip_id != 0)
391 fprintf (stderr, "Debugger connection failed\n");
395 /* Verify that the loaded image fits entirely within device flash
397 if (load->address < sl->flash_base ||
398 sl->flash_base + sl->flash_size < load->address + load->length) {
399 fprintf (stderr, "\%s\": Invalid memory range 0x%08x - 0x%08x\n", filename,
400 load->address, load->address + load->length);
404 /* Enter debugging mode
406 if (stlink_current_mode(sl) == STLINK_DEV_DFU_MODE)
407 stlink_exit_dfu_mode(sl);
409 if (stlink_current_mode(sl) != STLINK_DEV_DEBUG_MODE)
410 stlink_enter_swd_mode(sl);
415 for (tries = 0; tries < 3; tries++) {
416 char *this_tty = tty;
418 this_tty = cc_usbdevs_find_by_arg(device, "AltosFlash");
420 this_tty = cc_usbdevs_find_by_arg(device, "MegaMetrum");
422 this_tty = getenv("ALTOS_TTY");
424 this_tty="/dev/ttyACM0";
426 cc = cc_usb_open(this_tty);
430 cc_usb_printf(cc, "v\n");
434 cc_usb_getline(cc, line, sizeof(line));
435 if (!strncmp(line, "altos-loader", 12))
437 if (!strncmp(line, "software-version", 16))
442 printf ("rebooting to loader\n");
443 cc_usb_printf(cc, "X\n");
449 fprintf(stderr, "Cannot switch to boot loader\n");
457 ao_self_block_read(cc, AO_BOOT_APPLICATION_BASE, check);
466 ao_self_block_write(cc, AO_BOOT_APPLICATION_BASE, block);
467 ao_self_block_read(cc, AO_BOOT_APPLICATION_BASE, block);
468 if (memcmp(block, check, 256) != 0) {
469 fprintf (stderr, "read differed\n");
477 /* Go fetch existing config values
480 was_flashed = check_flashed(sl, cc);
484 fprintf (stderr, "Must provide serial number\n");
487 serial = get_uint16(sl, cc, AO_SERIAL_NUMBER);
488 if (!serial || serial == 0xffff) {
489 fprintf (stderr, "Invalid existing serial %d\n", serial);
494 if (!cal && AO_RADIO_CAL && was_flashed) {
495 cal = get_uint32(sl, cc, AO_RADIO_CAL);
496 if (!cal || cal == 0xffffffff) {
497 fprintf (stderr, "Invalid existing rf cal %d\n", cal);
502 /* Write the config values into the flash image
505 serial_int[0] = serial & 0xff;
506 serial_int[1] = (serial >> 8) & 0xff;
508 if (!rewrite(load, AO_SERIAL_NUMBER, serial_int, sizeof (serial_int))) {
509 fprintf(stderr, "Cannot rewrite serial integer at %08x\n",
514 if (AO_USB_DESCRIPTORS) {
515 uint32_t usb_descriptors = AO_USB_DESCRIPTORS - load->address;
518 while (load->data[usb_descriptors] != 0 && usb_descriptors < load->length) {
519 if (load->data[usb_descriptors+1] == AO_USB_DESC_STRING) {
524 usb_descriptors += load->data[usb_descriptors];
526 if (usb_descriptors >= load->length || load->data[usb_descriptors] == 0 ) {
527 fprintf(stderr, "Cannot rewrite serial string at %08x\n", AO_USB_DESCRIPTORS);
531 serial_ucs2_len = load->data[usb_descriptors] - 2;
532 serial_ucs2 = malloc(serial_ucs2_len);
534 fprintf(stderr, "Malloc(%d) failed\n", serial_ucs2_len);
538 for (i = serial_ucs2_len / 2; i; i--) {
539 serial_ucs2[i * 2 - 1] = 0;
540 serial_ucs2[i * 2 - 2] = (s % 10) + '0';
543 if (!rewrite(load, usb_descriptors + 2 + load->address, serial_ucs2, serial_ucs2_len)) {
544 fprintf (stderr, "Cannot rewrite USB descriptor at %08x\n", AO_USB_DESCRIPTORS);
549 if (cal && AO_RADIO_CAL) {
550 cal_int[0] = cal & 0xff;
551 cal_int[1] = (cal >> 8) & 0xff;
552 cal_int[2] = (cal >> 16) & 0xff;
553 cal_int[3] = (cal >> 24) & 0xff;
555 if (!rewrite(load, AO_RADIO_CAL, cal_int, sizeof (cal_int))) {
556 fprintf(stderr, "Cannot rewrite radio calibration at %08x\n", AO_RADIO_CAL);
561 /* And flash the resulting image to the device
564 success = ao_self_write(cc, load);
566 success = (stlink_write_flash(sl, load->address, load->data, load->length) >= 0);
569 fprintf (stderr, "\"%s\": Write failed\n", filename);