Transform 'u8' to 'uint8_t' in src/flash
[openocd.git] / src / flash / flash.c
blob2df0989e3a3233da861f91ecec621b126767b9cd
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2008 by Spencer Oliver *
9 * spen@spen-soft.co.uk *
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
20 * *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
26 #ifdef HAVE_CONFIG_H
27 #include "config.h"
28 #endif
30 #include "flash.h"
31 #include "image.h"
32 #include "time_support.h"
34 /* command handlers */
35 static int handle_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
36 static int handle_flash_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
37 static int handle_flash_probe_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
38 static int handle_flash_erase_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
39 static int handle_flash_erase_address_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
40 static int handle_flash_protect_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
41 static int handle_flash_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
42 static int handle_flash_write_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
43 static int handle_flash_write_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
44 static int handle_flash_fill_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
45 static int handle_flash_protect_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
47 /* flash drivers
49 extern flash_driver_t lpc2000_flash;
50 extern flash_driver_t cfi_flash;
51 extern flash_driver_t at91sam7_flash;
52 extern flash_driver_t str7x_flash;
53 extern flash_driver_t str9x_flash;
54 extern flash_driver_t aduc702x_flash;
55 extern flash_driver_t stellaris_flash;
56 extern flash_driver_t str9xpec_flash;
57 extern flash_driver_t stm32x_flash;
58 extern flash_driver_t tms470_flash;
59 extern flash_driver_t ecosflash_flash;
60 extern flash_driver_t lpc288x_flash;
61 extern flash_driver_t ocl_flash;
62 extern flash_driver_t pic32mx_flash;
63 extern flash_driver_t avr_flash;
65 flash_driver_t *flash_drivers[] = {
66 &lpc2000_flash,
67 &cfi_flash,
68 &at91sam7_flash,
69 &str7x_flash,
70 &str9x_flash,
71 &aduc702x_flash,
72 &stellaris_flash,
73 &str9xpec_flash,
74 &stm32x_flash,
75 &tms470_flash,
76 &ecosflash_flash,
77 &lpc288x_flash,
78 &ocl_flash,
79 &pic32mx_flash,
80 &avr_flash,
81 NULL,
84 flash_bank_t *flash_banks;
85 static command_t *flash_cmd;
87 /* wafer thin wrapper for invoking the flash driver */
88 static int flash_driver_write(struct flash_bank_s *bank, uint8_t *buffer, u32 offset, u32 count)
90 int retval;
92 retval=bank->driver->write(bank, buffer, offset, count);
93 if (retval!=ERROR_OK)
95 LOG_ERROR("error writing to flash at address 0x%08x at offset 0x%8.8x (%d)", bank->base, offset, retval);
98 return retval;
101 static int flash_driver_erase(struct flash_bank_s *bank, int first, int last)
103 int retval;
105 retval=bank->driver->erase(bank, first, last);
106 if (retval!=ERROR_OK)
108 LOG_ERROR("failed erasing sectors %d to %d (%d)", first, last, retval);
111 return retval;
114 int flash_driver_protect(struct flash_bank_s *bank, int set, int first, int last)
116 int retval;
118 retval=bank->driver->protect(bank, set, first, last);
119 if (retval!=ERROR_OK)
121 LOG_ERROR("failed setting protection for areas %d to %d (%d)", first, last, retval);
124 return retval;
127 int flash_register_commands(struct command_context_s *cmd_ctx)
129 flash_cmd = register_command(cmd_ctx, NULL, "flash", NULL, COMMAND_ANY, NULL);
131 register_command(cmd_ctx, flash_cmd, "bank", handle_flash_bank_command, COMMAND_CONFIG, "flash bank <driver> <base> <size> <chip_width> <bus_width> <target> [driver_options ...]");
132 return ERROR_OK;
135 static int jim_flash_banks(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
137 flash_bank_t *p;
139 if (argc != 1) {
140 Jim_WrongNumArgs(interp, 1, argv, "no arguments to flash_banks command");
141 return JIM_ERR;
144 Jim_Obj *list=Jim_NewListObj(interp, NULL, 0);
145 for (p = flash_banks; p; p = p->next)
147 Jim_Obj *elem=Jim_NewListObj(interp, NULL, 0);
149 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "name", -1));
150 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, p->driver->name, -1));
151 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "base", -1));
152 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->base));
153 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "size", -1));
154 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->size));
155 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "bus_width", -1));
156 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->bus_width));
157 Jim_ListAppendElement(interp, elem, Jim_NewStringObj(interp, "chip_width", -1));
158 Jim_ListAppendElement(interp, elem, Jim_NewIntObj(interp, p->chip_width));
160 Jim_ListAppendElement(interp, list, elem);
163 Jim_SetResult(interp, list);
165 return JIM_OK;
168 int flash_init_drivers(struct command_context_s *cmd_ctx)
170 register_jim(cmd_ctx, "ocd_flash_banks", jim_flash_banks, "return information about the flash banks");
172 if (flash_banks)
174 register_command(cmd_ctx, flash_cmd, "info", handle_flash_info_command, COMMAND_EXEC,
175 "print info about flash bank <num>");
176 register_command(cmd_ctx, flash_cmd, "probe", handle_flash_probe_command, COMMAND_EXEC,
177 "identify flash bank <num>");
178 register_command(cmd_ctx, flash_cmd, "erase_check", handle_flash_erase_check_command, COMMAND_EXEC,
179 "check erase state of sectors in flash bank <num>");
180 register_command(cmd_ctx, flash_cmd, "protect_check", handle_flash_protect_check_command, COMMAND_EXEC,
181 "check protection state of sectors in flash bank <num>");
182 register_command(cmd_ctx, flash_cmd, "erase_sector", handle_flash_erase_command, COMMAND_EXEC,
183 "erase sectors at <bank> <first> <last>");
184 register_command(cmd_ctx, flash_cmd, "erase_address", handle_flash_erase_address_command, COMMAND_EXEC,
185 "erase address range <address> <length>");
187 register_command(cmd_ctx, flash_cmd, "fillw", handle_flash_fill_command, COMMAND_EXEC,
188 "fill with pattern (no autoerase) <address> <word_pattern> <count>");
189 register_command(cmd_ctx, flash_cmd, "fillh", handle_flash_fill_command, COMMAND_EXEC,
190 "fill with pattern <address> <halfword_pattern> <count>");
191 register_command(cmd_ctx, flash_cmd, "fillb", handle_flash_fill_command, COMMAND_EXEC,
192 "fill with pattern <address> <byte_pattern> <count>");
194 register_command(cmd_ctx, flash_cmd, "write_bank", handle_flash_write_bank_command, COMMAND_EXEC,
195 "write binary data to <bank> <file> <offset>");
196 register_command(cmd_ctx, flash_cmd, "write_image", handle_flash_write_image_command, COMMAND_EXEC,
197 "write_image [erase] <file> [offset] [type]");
198 register_command(cmd_ctx, flash_cmd, "protect", handle_flash_protect_command, COMMAND_EXEC,
199 "set protection of sectors at <bank> <first> <last> <on|off>");
202 return ERROR_OK;
205 flash_bank_t *get_flash_bank_by_num_noprobe(int num)
207 flash_bank_t *p;
208 int i = 0;
210 for (p = flash_banks; p; p = p->next)
212 if (i++ == num)
214 return p;
217 LOG_ERROR("flash bank %d does not exist", num);
218 return NULL;
221 int flash_get_bank_count(void)
223 flash_bank_t *p;
224 int i = 0;
225 for (p = flash_banks; p; p = p->next)
227 i++;
229 return i;
232 flash_bank_t *get_flash_bank_by_num(int num)
234 flash_bank_t *p = get_flash_bank_by_num_noprobe(num);
235 int retval;
237 if (p == NULL)
238 return NULL;
240 retval = p->driver->auto_probe(p);
242 if (retval != ERROR_OK)
244 LOG_ERROR("auto_probe failed %d\n", retval);
245 return NULL;
247 return p;
250 static int handle_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
252 int retval;
253 int i;
254 int found = 0;
255 target_t *target;
257 if (argc < 6)
259 return ERROR_COMMAND_SYNTAX_ERROR;
262 if ((target = get_target(args[5])) == NULL)
264 LOG_ERROR("target '%s' not defined", args[5]);
265 return ERROR_FAIL;
268 for (i = 0; flash_drivers[i]; i++)
270 if (strcmp(args[0], flash_drivers[i]->name) == 0)
272 flash_bank_t *p, *c;
274 /* register flash specific commands */
275 if (flash_drivers[i]->register_commands(cmd_ctx) != ERROR_OK)
277 LOG_ERROR("couldn't register '%s' commands", args[0]);
278 return ERROR_FAIL;
281 c = malloc(sizeof(flash_bank_t));
282 c->target = target;
283 c->driver = flash_drivers[i];
284 c->driver_priv = NULL;
285 c->base = strtoul(args[1], NULL, 0);
286 c->size = strtoul(args[2], NULL, 0);
287 c->chip_width = strtoul(args[3], NULL, 0);
288 c->bus_width = strtoul(args[4], NULL, 0);
289 c->num_sectors = 0;
290 c->sectors = NULL;
291 c->next = NULL;
293 if ((retval=flash_drivers[i]->flash_bank_command(cmd_ctx, cmd, args, argc, c)) != ERROR_OK)
295 LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8x", args[0], c->base);
296 free(c);
297 return retval;
300 /* put flash bank in linked list */
301 if (flash_banks)
303 int bank_num = 0;
304 /* find last flash bank */
305 for (p = flash_banks; p && p->next; p = p->next) bank_num++;
306 if (p)
307 p->next = c;
308 c->bank_number = bank_num + 1;
310 else
312 flash_banks = c;
313 c->bank_number = 0;
316 found = 1;
320 /* no matching flash driver found */
321 if (!found)
323 LOG_ERROR("flash driver '%s' not found", args[0]);
324 return ERROR_FAIL;
327 return ERROR_OK;
330 static int handle_flash_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
332 flash_bank_t *p;
333 u32 i = 0;
334 int j = 0;
335 int retval;
337 if (argc != 1)
339 return ERROR_COMMAND_SYNTAX_ERROR;
342 for (p = flash_banks; p; p = p->next, i++)
344 if (i == strtoul(args[0], NULL, 0))
346 char buf[1024];
348 /* attempt auto probe */
349 if ((retval = p->driver->auto_probe(p)) != ERROR_OK)
350 return retval;
352 command_print(cmd_ctx, "#%i: %s at 0x%8.8x, size 0x%8.8x, buswidth %i, chipwidth %i",
353 i, p->driver->name, p->base, p->size, p->bus_width, p->chip_width);
354 for (j = 0; j < p->num_sectors; j++)
356 char *protect_state;
358 if (p->sectors[j].is_protected == 0)
359 protect_state = "not protected";
360 else if (p->sectors[j].is_protected == 1)
361 protect_state = "protected";
362 else
363 protect_state = "protection state unknown";
365 command_print(cmd_ctx, "\t#%3i: 0x%8.8x (0x%x %ikB) %s",
366 j, p->sectors[j].offset, p->sectors[j].size, p->sectors[j].size>>10,
367 protect_state);
370 *buf = '\0'; /* initialize buffer, otherwise it migh contain garbage if driver function fails */
371 retval = p->driver->info(p, buf, sizeof(buf));
372 command_print(cmd_ctx, "%s", buf);
373 if (retval != ERROR_OK)
374 LOG_ERROR("error retrieving flash info (%d)", retval);
378 return ERROR_OK;
381 static int handle_flash_probe_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
383 flash_bank_t *p;
384 int retval;
386 if (argc != 1)
388 return ERROR_COMMAND_SYNTAX_ERROR;
391 p = get_flash_bank_by_num_noprobe(strtoul(args[0], NULL, 0));
392 if (p)
394 if ((retval = p->driver->probe(p)) == ERROR_OK)
396 command_print(cmd_ctx, "flash '%s' found at 0x%8.8x", p->driver->name, p->base);
398 else if (retval == ERROR_FLASH_BANK_INVALID)
400 command_print(cmd_ctx, "probing failed for flash bank '#%s' at 0x%8.8x",
401 args[0], p->base);
403 else
405 command_print(cmd_ctx, "unknown error when probing flash bank '#%s' at 0x%8.8x",
406 args[0], p->base);
409 else
411 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
414 return ERROR_OK;
417 static int handle_flash_erase_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
419 flash_bank_t *p;
420 int retval;
422 if (argc != 1)
424 return ERROR_COMMAND_SYNTAX_ERROR;
427 p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
428 if (p)
430 int j;
431 if ((retval = p->driver->erase_check(p)) == ERROR_OK)
433 command_print(cmd_ctx, "successfully checked erase state");
435 else
437 command_print(cmd_ctx, "unknown error when checking erase state of flash bank #%s at 0x%8.8x",
438 args[0], p->base);
441 for (j = 0; j < p->num_sectors; j++)
443 char *erase_state;
445 if (p->sectors[j].is_erased == 0)
446 erase_state = "not erased";
447 else if (p->sectors[j].is_erased == 1)
448 erase_state = "erased";
449 else
450 erase_state = "erase state unknown";
452 command_print(cmd_ctx, "\t#%3i: 0x%8.8x (0x%x %ikB) %s",
453 j, p->sectors[j].offset, p->sectors[j].size, p->sectors[j].size>>10,
454 erase_state);
458 return ERROR_OK;
461 static int handle_flash_erase_address_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
463 flash_bank_t *p;
464 int retval;
465 int address;
466 int length;
467 duration_t duration;
468 char *duration_text;
470 target_t *target = get_current_target(cmd_ctx);
472 if (argc != 2)
474 return ERROR_COMMAND_SYNTAX_ERROR;
477 address = strtoul(args[0], NULL, 0);
478 length = strtoul(args[1], NULL, 0);
479 if (length <= 0)
481 command_print(cmd_ctx, "Length must be >0");
482 return ERROR_COMMAND_SYNTAX_ERROR;
485 p = get_flash_bank_by_addr(target, address);
486 if (p == NULL)
488 return ERROR_FAIL;
491 /* We can't know if we did a resume + halt, in which case we no longer know the erased state */
492 flash_set_dirty();
494 duration_start_measure(&duration);
496 if ((retval = flash_erase_address_range(target, address, length)) == ERROR_OK)
498 if ((retval = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
500 return retval;
502 command_print(cmd_ctx, "erased address 0x%8.8x length %i in %s", address, length, duration_text);
503 free(duration_text);
506 return retval;
509 static int handle_flash_protect_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
511 flash_bank_t *p;
512 int retval;
514 if (argc != 1)
516 return ERROR_COMMAND_SYNTAX_ERROR;
519 p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
520 if (p)
522 if ((retval = p->driver->protect_check(p)) == ERROR_OK)
524 command_print(cmd_ctx, "successfully checked protect state");
526 else if (retval == ERROR_FLASH_OPERATION_FAILED)
528 command_print(cmd_ctx, "checking protection state failed (possibly unsupported) by flash #%s at 0x%8.8x", args[0], p->base);
530 else
532 command_print(cmd_ctx, "unknown error when checking protection state of flash bank '#%s' at 0x%8.8x", args[0], p->base);
535 else
537 return ERROR_COMMAND_SYNTAX_ERROR;
540 return ERROR_OK;
543 static int handle_flash_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
545 if (argc > 2)
547 int first = strtoul(args[1], NULL, 0);
548 int last = strtoul(args[2], NULL, 0);
549 int retval;
550 flash_bank_t *p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
551 duration_t duration;
552 char *duration_text;
554 duration_start_measure(&duration);
556 if (!p)
558 return ERROR_COMMAND_SYNTAX_ERROR;
561 if ((retval = flash_driver_erase(p, first, last)) == ERROR_OK)
563 if ((retval = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
565 return retval;
568 command_print(cmd_ctx, "erased sectors %i through %i on flash bank %li in %s",
569 first, last, strtoul(args[0], 0, 0), duration_text);
570 free(duration_text);
573 else
575 return ERROR_COMMAND_SYNTAX_ERROR;
578 return ERROR_OK;
581 static int handle_flash_protect_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
583 if (argc > 3)
585 int first = strtoul(args[1], NULL, 0);
586 int last = strtoul(args[2], NULL, 0);
587 int set;
588 int retval;
589 flash_bank_t *p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
590 if (!p)
592 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
593 return ERROR_OK;
596 if (strcmp(args[3], "on") == 0)
597 set = 1;
598 else if (strcmp(args[3], "off") == 0)
599 set = 0;
600 else
602 return ERROR_COMMAND_SYNTAX_ERROR;
605 retval = flash_driver_protect(p, set, first, last);
606 if (retval == ERROR_OK)
608 command_print(cmd_ctx, "%s protection for sectors %i through %i on flash bank %li",
609 (set) ? "set" : "cleared", first,
610 last, strtoul(args[0], 0, 0));
613 else
615 return ERROR_COMMAND_SYNTAX_ERROR;
619 return ERROR_OK;
622 static int handle_flash_write_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
624 target_t *target = get_current_target(cmd_ctx);
626 image_t image;
627 u32 written;
629 duration_t duration;
630 char *duration_text;
632 int retval, retvaltemp;
634 if (argc < 1)
636 return ERROR_COMMAND_SYNTAX_ERROR;
639 /* flash auto-erase is disabled by default*/
640 int auto_erase = 0;
642 if (strcmp(args[0], "erase")==0)
644 auto_erase = 1;
645 args++;
646 argc--;
647 command_print(cmd_ctx, "auto erase enabled");
650 if (argc < 1)
652 return ERROR_COMMAND_SYNTAX_ERROR;
655 if (!target)
657 LOG_ERROR("no target selected");
658 return ERROR_FAIL;
661 duration_start_measure(&duration);
663 if (argc >= 2)
665 image.base_address_set = 1;
666 image.base_address = strtoul(args[1], NULL, 0);
668 else
670 image.base_address_set = 0;
671 image.base_address = 0x0;
674 image.start_address_set = 0;
676 retval = image_open(&image, args[0], (argc == 3) ? args[2] : NULL);
677 if (retval != ERROR_OK)
679 return retval;
682 retval = flash_write(target, &image, &written, auto_erase);
683 if (retval != ERROR_OK)
685 image_close(&image);
686 return retval;
689 if ((retvaltemp = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
691 image_close(&image);
692 return retvaltemp;
694 if (retval == ERROR_OK)
696 command_print(cmd_ctx, "wrote %u byte from file %s in %s (%f kb/s)",
697 written, args[0], duration_text,
698 (float)written / 1024.0 / ((float)duration.duration.tv_sec + ((float)duration.duration.tv_usec / 1000000.0)));
700 free(duration_text);
702 image_close(&image);
704 return retval;
707 static int handle_flash_fill_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
709 int err = ERROR_OK, retval;
710 u32 address;
711 u32 pattern;
712 u32 count;
713 uint8_t chunk[1024];
714 uint8_t readback[1024];
715 u32 wrote = 0;
716 u32 cur_size = 0;
717 u32 chunk_count;
718 char *duration_text;
719 duration_t duration;
720 target_t *target = get_current_target(cmd_ctx);
721 u32 i;
722 u32 wordsize;
724 if (argc != 3)
726 return ERROR_COMMAND_SYNTAX_ERROR;
729 address = strtoul(args[0], NULL, 0);
730 pattern = strtoul(args[1], NULL, 0);
731 count = strtoul(args[2], NULL, 0);
733 if(count == 0)
734 return ERROR_OK;
736 switch(cmd[4])
738 case 'w':
739 wordsize=4;
740 break;
741 case 'h':
742 wordsize=2;
743 break;
744 case 'b':
745 wordsize=1;
746 break;
747 default:
748 return ERROR_COMMAND_SYNTAX_ERROR;
751 chunk_count = MIN(count, (1024 / wordsize));
752 switch(wordsize)
754 case 4:
755 for(i = 0; i < chunk_count; i++)
757 target_buffer_set_u32(target, chunk + i * wordsize, pattern);
759 break;
760 case 2:
761 for(i = 0; i < chunk_count; i++)
763 target_buffer_set_u16(target, chunk + i * wordsize, pattern);
765 break;
766 case 1:
767 memset(chunk, pattern, chunk_count);
768 break;
769 default:
770 LOG_ERROR("BUG: can't happen");
771 exit(-1);
774 duration_start_measure(&duration);
776 for (wrote=0; wrote<(count*wordsize); wrote += cur_size)
778 cur_size = MIN( (count*wordsize - wrote), sizeof(chunk) );
779 flash_bank_t *bank;
780 bank = get_flash_bank_by_addr(target, address);
781 if(bank == NULL)
783 return ERROR_FAIL;
785 err = flash_driver_write(bank, chunk, address - bank->base + wrote, cur_size);
786 if (err!=ERROR_OK)
787 return err;
789 err = target_read_buffer(target, address + wrote, cur_size, readback);
790 if (err!=ERROR_OK)
791 return err;
793 unsigned i;
794 for (i=0; i<cur_size; i++)
796 if (readback[i]!=chunk[i])
798 LOG_ERROR("Verfication error address 0x%08x, read back 0x%02x, expected 0x%02x", address + wrote + i, readback[i], chunk[i]);
799 return ERROR_FAIL;
805 if ((retval = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
807 return retval;
810 if(err == ERROR_OK)
812 float speed;
813 speed=wrote / 1024.0;
814 speed/=((float)duration.duration.tv_sec + ((float)duration.duration.tv_usec / 1000000.0));
815 command_print(cmd_ctx, "wrote %d bytes to 0x%8.8x in %s (%f kb/s)",
816 count*wordsize, address, duration_text,
817 speed);
819 free(duration_text);
820 return ERROR_OK;
823 static int handle_flash_write_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
825 u32 offset;
826 uint8_t *buffer;
827 u32 buf_cnt;
829 fileio_t fileio;
831 duration_t duration;
832 char *duration_text;
834 int retval, retvaltemp;
835 flash_bank_t *p;
837 if (argc != 3)
839 return ERROR_COMMAND_SYNTAX_ERROR;
842 duration_start_measure(&duration);
844 offset = strtoul(args[2], NULL, 0);
845 p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
846 if (!p)
848 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
849 return ERROR_OK;
852 if (fileio_open(&fileio, args[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
854 return ERROR_OK;
857 buffer = malloc(fileio.size);
858 if (fileio_read(&fileio, fileio.size, buffer, &buf_cnt) != ERROR_OK)
860 free(buffer);
861 fileio_close(&fileio);
862 return ERROR_OK;
865 retval = flash_driver_write(p, buffer, offset, buf_cnt);
867 free(buffer);
868 buffer = NULL;
870 if ((retvaltemp = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
872 fileio_close(&fileio);
873 return retvaltemp;
875 if (retval==ERROR_OK)
877 command_print(cmd_ctx, "wrote %lld byte from file %s to flash bank %li at offset 0x%8.8x in %s (%f kb/s)",
878 fileio.size, args[1], strtoul(args[0], NULL, 0), offset, duration_text,
879 (float)fileio.size / 1024.0 / ((float)duration.duration.tv_sec + ((float)duration.duration.tv_usec / 1000000.0)));
881 free(duration_text);
883 fileio_close(&fileio);
885 return retval;
888 void flash_set_dirty(void)
890 flash_bank_t *c;
891 int i;
893 /* set all flash to require erasing */
894 for (c = flash_banks; c; c = c->next)
896 for (i = 0; i < c->num_sectors; i++)
898 c->sectors[i].is_erased = 0;
903 /* lookup flash bank by address */
904 flash_bank_t *get_flash_bank_by_addr(target_t *target, u32 addr)
906 flash_bank_t *c;
908 /* cycle through bank list */
909 for (c = flash_banks; c; c = c->next)
911 int retval;
912 retval = c->driver->auto_probe(c);
914 if (retval != ERROR_OK)
916 LOG_ERROR("auto_probe failed %d\n", retval);
917 return NULL;
919 /* check whether address belongs to this flash bank */
920 if ((addr >= c->base) && (addr <= c->base + (c->size - 1)) && target == c->target)
921 return c;
923 LOG_ERROR("No flash at address 0x%08x\n", addr);
924 return NULL;
927 /* erase given flash region, selects proper bank according to target and address */
928 int flash_erase_address_range(target_t *target, u32 addr, u32 length)
930 flash_bank_t *c;
931 int first = -1;
932 int last = -1;
933 int i;
935 if ((c = get_flash_bank_by_addr(target, addr)) == NULL)
936 return ERROR_FLASH_DST_OUT_OF_BANK; /* no corresponding bank found */
938 if (c->size == 0 || c->num_sectors == 0)
940 LOG_ERROR("Bank is invalid");
941 return ERROR_FLASH_BANK_INVALID;
944 if (length == 0)
946 /* special case, erase whole bank when length is zero */
947 if (addr != c->base)
948 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
950 return flash_driver_erase(c, 0, c->num_sectors - 1);
953 /* check whether it fits */
954 if (addr + length - 1 > c->base + c->size - 1)
955 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
957 addr -= c->base;
959 for (i = 0; i < c->num_sectors; i++)
961 /* check whether sector overlaps with the given range and is not yet erased */
962 if (addr < c->sectors[i].offset + c->sectors[i].size && addr + length > c->sectors[i].offset && c->sectors[i].is_erased != 1) {
963 /* if first is not set yet then this is the first sector */
964 if (first == -1)
965 first = i;
966 last = i; /* and it is the last one so far in any case */
970 if( first == -1 || last == -1 )
971 return ERROR_OK;
973 return flash_driver_erase(c, first, last);
976 /* write (optional verify) an image to flash memory of the given target */
977 int flash_write(target_t *target, image_t *image, u32 *written, int erase)
979 int retval=ERROR_OK;
981 int section;
982 u32 section_offset;
983 flash_bank_t *c;
984 int *padding;
986 section = 0;
987 section_offset = 0;
989 if (written)
990 *written = 0;
992 if (erase)
994 /* assume all sectors need erasing - stops any problems
995 * when flash_write is called multiple times */
997 flash_set_dirty();
1000 /* allocate padding array */
1001 padding = malloc(image->num_sections * sizeof(padding));
1003 /* loop until we reach end of the image */
1004 while (section < image->num_sections)
1006 u32 buffer_size;
1007 uint8_t *buffer;
1008 int section_first;
1009 int section_last;
1010 u32 run_address = image->sections[section].base_address + section_offset;
1011 u32 run_size = image->sections[section].size - section_offset;
1012 int pad_bytes = 0;
1014 if (image->sections[section].size == 0)
1016 LOG_WARNING("empty section %d", section);
1017 section++;
1018 section_offset = 0;
1019 continue;
1022 /* find the corresponding flash bank */
1023 if ((c = get_flash_bank_by_addr(target, run_address)) == NULL)
1025 section++; /* and skip it */
1026 section_offset = 0;
1027 continue;
1030 /* collect consecutive sections which fall into the same bank */
1031 section_first = section;
1032 section_last = section;
1033 padding[section] = 0;
1034 while ((run_address + run_size - 1 < c->base + c->size - 1)
1035 && (section_last + 1 < image->num_sections))
1037 if (image->sections[section_last + 1].base_address < (run_address + run_size))
1039 LOG_DEBUG("section %d out of order(very slightly surprising, but supported)", section_last + 1);
1040 break;
1042 /* if we have multiple sections within our image, flash programming could fail due to alignment issues
1043 * attempt to rebuild a consecutive buffer for the flash loader */
1044 pad_bytes = (image->sections[section_last + 1].base_address) - (run_address + run_size);
1045 if ((run_address + run_size + pad_bytes) > (c->base + c->size))
1046 break;
1047 padding[section_last] = pad_bytes;
1048 run_size += image->sections[++section_last].size;
1049 run_size += pad_bytes;
1050 padding[section_last] = 0;
1052 LOG_INFO("Padding image section %d with %d bytes", section_last-1, pad_bytes );
1055 /* fit the run into bank constraints */
1056 if (run_address + run_size - 1 > c->base + c->size - 1)
1058 LOG_WARNING("writing %d bytes only - as image section is %d bytes and bank is only %d bytes", \
1059 c->base + c->size - run_address, run_size, c->size);
1060 run_size = c->base + c->size - run_address;
1063 /* allocate buffer */
1064 buffer = malloc(run_size);
1065 buffer_size = 0;
1067 /* read sections to the buffer */
1068 while (buffer_size < run_size)
1070 u32 size_read;
1072 size_read = run_size - buffer_size;
1073 if (size_read > image->sections[section].size - section_offset)
1074 size_read = image->sections[section].size - section_offset;
1076 if ((retval = image_read_section(image, section, section_offset,
1077 size_read, buffer + buffer_size, &size_read)) != ERROR_OK || size_read == 0)
1079 free(buffer);
1080 free(padding);
1081 return retval;
1084 /* see if we need to pad the section */
1085 while (padding[section]--)
1086 (buffer+buffer_size)[size_read++] = 0xff;
1088 buffer_size += size_read;
1089 section_offset += size_read;
1091 if (section_offset >= image->sections[section].size)
1093 section++;
1094 section_offset = 0;
1098 retval = ERROR_OK;
1100 if (erase)
1102 /* calculate and erase sectors */
1103 retval = flash_erase_address_range( target, run_address, run_size );
1106 if (retval == ERROR_OK)
1108 /* write flash sectors */
1109 retval = flash_driver_write(c, buffer, run_address - c->base, run_size);
1112 free(buffer);
1114 if (retval != ERROR_OK)
1116 free(padding);
1117 return retval; /* abort operation */
1120 if (written != NULL)
1121 *written += run_size; /* add run size to total written counter */
1124 free(padding);
1126 return retval;
1129 int default_flash_mem_blank_check(struct flash_bank_s *bank)
1131 target_t *target = bank->target;
1132 uint8_t buffer[1024];
1133 int buffer_size = sizeof(buffer);
1134 int i;
1135 u32 nBytes;
1137 if (bank->target->state != TARGET_HALTED)
1139 LOG_ERROR("Target not halted");
1140 return ERROR_TARGET_NOT_HALTED;
1143 for (i = 0; i < bank->num_sectors; i++)
1145 u32 j;
1146 bank->sectors[i].is_erased = 1;
1148 for (j = 0; j < bank->sectors[i].size; j += buffer_size)
1150 u32 chunk;
1151 int retval;
1152 chunk = buffer_size;
1153 if (chunk > (j - bank->sectors[i].size))
1155 chunk = (j - bank->sectors[i].size);
1158 retval = target_read_memory(target, bank->base + bank->sectors[i].offset + j, 4, chunk/4, buffer);
1159 if (retval != ERROR_OK)
1160 return retval;
1162 for (nBytes = 0; nBytes < chunk; nBytes++)
1164 if (buffer[nBytes] != 0xFF)
1166 bank->sectors[i].is_erased = 0;
1167 break;
1173 return ERROR_OK;
1176 int default_flash_blank_check(struct flash_bank_s *bank)
1178 target_t *target = bank->target;
1179 int i;
1180 int retval;
1181 int fast_check = 0;
1182 u32 blank;
1184 if (bank->target->state != TARGET_HALTED)
1186 LOG_ERROR("Target not halted");
1187 return ERROR_TARGET_NOT_HALTED;
1190 for (i = 0; i < bank->num_sectors; i++)
1192 u32 address = bank->base + bank->sectors[i].offset;
1193 u32 size = bank->sectors[i].size;
1195 if ((retval = target_blank_check_memory(target, address, size, &blank)) != ERROR_OK)
1197 fast_check = 0;
1198 break;
1200 if (blank == 0xFF)
1201 bank->sectors[i].is_erased = 1;
1202 else
1203 bank->sectors[i].is_erased = 0;
1204 fast_check = 1;
1207 if (!fast_check)
1209 LOG_USER("Running slow fallback erase check - add working memory");
1210 return default_flash_mem_blank_check(bank);
1213 return ERROR_OK;