1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
27 #include "time_support.h"
35 #include <sys/types.h>
40 /* command handlers */
41 int handle_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
42 int handle_flash_banks_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
43 int handle_flash_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
44 int handle_flash_probe_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
45 int handle_flash_erase_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
46 int handle_flash_erase_address_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
47 int handle_flash_protect_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
48 int handle_flash_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
49 int handle_flash_write_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
50 int handle_flash_write_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
51 int handle_flash_write_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
52 int handle_flash_protect_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
53 int handle_flash_auto_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
54 flash_bank_t *get_flash_bank_by_addr(target_t *target, u32 addr);
58 extern flash_driver_t lpc2000_flash;
59 extern flash_driver_t cfi_flash;
60 extern flash_driver_t at91sam7_flash;
61 extern flash_driver_t str7x_flash;
62 extern flash_driver_t str9x_flash;
63 extern flash_driver_t stellaris_flash;
64 extern flash_driver_t str9xpec_flash;
65 extern flash_driver_t stm32x_flash;
66 extern flash_driver_t tms470_flash;
67 extern flash_driver_t ecosflash_flash;
69 flash_driver_t *flash_drivers[] =
84 flash_bank_t *flash_banks;
85 static command_t *flash_cmd;
86 static int auto_erase = 0;
88 /* wafer thin wrapper for invoking the flash driver */
89 static int flash_driver_write(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count)
93 retval=bank->driver->write(bank, buffer, offset, count);
96 ERROR("error writing to flash at address 0x%08x at offset 0x%8.8x", bank->base, offset);
102 static int flash_driver_erase(struct flash_bank_s *bank, int first, int last)
106 retval=bank->driver->erase(bank, first, last);
107 if (retval!=ERROR_OK)
109 ERROR("failed erasing sectors %d to %d", first, last);
115 int flash_driver_protect(struct flash_bank_s *bank, int set, int first, int last)
119 retval=bank->driver->protect(bank, set, first, last);
120 if (retval!=ERROR_OK)
122 ERROR("failed setting protection for areas %d to %d", first, last);
129 int flash_register_commands(struct command_context_s *cmd_ctx)
131 flash_cmd = register_command(cmd_ctx, NULL, "flash", NULL, COMMAND_ANY, NULL);
133 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 ...]");
134 register_command(cmd_ctx, flash_cmd, "auto_erase", handle_flash_auto_erase_command, COMMAND_ANY,
135 "auto erase flash sectors <on|off>");
139 int flash_init_drivers(struct command_context_s *cmd_ctx)
143 register_command(cmd_ctx, flash_cmd, "banks", handle_flash_banks_command, COMMAND_EXEC,
144 "list configured flash banks ");
145 register_command(cmd_ctx, flash_cmd, "info", handle_flash_info_command, COMMAND_EXEC,
146 "print info about flash bank <num>");
147 register_command(cmd_ctx, flash_cmd, "probe", handle_flash_probe_command, COMMAND_EXEC,
148 "identify flash bank <num>");
149 register_command(cmd_ctx, flash_cmd, "erase_check", handle_flash_erase_check_command, COMMAND_EXEC,
150 "check erase state of sectors in flash bank <num>");
151 register_command(cmd_ctx, flash_cmd, "protect_check", handle_flash_protect_check_command, COMMAND_EXEC,
152 "check protection state of sectors in flash bank <num>");
153 register_command(cmd_ctx, flash_cmd, "erase_sector", handle_flash_erase_command, COMMAND_EXEC,
154 "erase sectors at <bank> <first> <last>");
155 register_command(cmd_ctx, flash_cmd, "erase_address", handle_flash_erase_address_command, COMMAND_EXEC,
156 "erase address range <address> <length>");
157 register_command(cmd_ctx, flash_cmd, "write_bank", handle_flash_write_bank_command, COMMAND_EXEC,
158 "write binary data to <bank> <file> <offset>");
159 register_command(cmd_ctx, flash_cmd, "write_image", handle_flash_write_image_command, COMMAND_EXEC,
160 "write_image <file> [offset] [type]");
161 register_command(cmd_ctx, flash_cmd, "protect", handle_flash_protect_command, COMMAND_EXEC,
162 "set protection of sectors at <bank> <first> <last> <on|off>");
168 flash_bank_t *get_flash_bank_by_num_noprobe(int num)
173 for (p = flash_banks; p; p = p->next)
180 ERROR("flash bank %d does not exist", num);
184 int flash_get_bank_count()
188 for (p = flash_banks; p; p = p->next)
195 flash_bank_t *get_flash_bank_by_num(int num)
197 flash_bank_t *p = get_flash_bank_by_num_noprobe(num);
203 retval = p->driver->auto_probe(p);
205 if (retval != ERROR_OK)
207 ERROR("auto_probe failed %d\n", retval);
213 int handle_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
221 return ERROR_COMMAND_SYNTAX_ERROR;
224 if ((target = get_target_by_num(strtoul(args[5], NULL, 0))) == NULL)
226 ERROR("target %lu not defined", strtoul(args[5], NULL, 0));
230 for (i = 0; flash_drivers[i]; i++)
232 if (strcmp(args[0], flash_drivers[i]->name) == 0)
236 /* register flash specific commands */
237 if (flash_drivers[i]->register_commands(cmd_ctx) != ERROR_OK)
239 ERROR("couldn't register '%s' commands", args[0]);
243 c = malloc(sizeof(flash_bank_t));
245 c->driver = flash_drivers[i];
246 c->driver_priv = NULL;
247 c->base = strtoul(args[1], NULL, 0);
248 c->size = strtoul(args[2], NULL, 0);
249 c->chip_width = strtoul(args[3], NULL, 0);
250 c->bus_width = strtoul(args[4], NULL, 0);
255 if (flash_drivers[i]->flash_bank_command(cmd_ctx, cmd, args, argc, c) != ERROR_OK)
257 ERROR("'%s' driver rejected flash bank at 0x%8.8x", args[0], c->base);
262 /* put flash bank in linked list */
265 /* find last flash bank */
266 for (p = flash_banks; p && p->next; p = p->next);
279 /* no matching flash driver found */
282 ERROR("flash driver '%s' not found", args[0]);
289 int handle_flash_banks_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
296 command_print(cmd_ctx, "no flash banks configured");
300 for (p = flash_banks; p; p = p->next)
302 command_print(cmd_ctx, "#%i: %s at 0x%8.8x, size 0x%8.8x, buswidth %i, chipwidth %i",
303 i++, p->driver->name, p->base, p->size, p->bus_width, p->chip_width);
309 int handle_flash_info_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
317 return ERROR_COMMAND_SYNTAX_ERROR;
320 for (p = flash_banks; p; p = p->next, i++)
322 if (i == strtoul(args[0], NULL, 0))
326 /* attempt auto probe */
327 p->driver->auto_probe(p);
329 command_print(cmd_ctx, "#%i: %s at 0x%8.8x, size 0x%8.8x, buswidth %i, chipwidth %i",
330 i, p->driver->name, p->base, p->size, p->bus_width, p->chip_width);
331 for (j = 0; j < p->num_sectors; j++)
333 char *erase_state, *protect_state;
335 if (p->sectors[j].is_erased == 0)
336 erase_state = "not erased";
337 else if (p->sectors[j].is_erased == 1)
338 erase_state = "erased";
340 erase_state = "erase state unknown";
342 if (p->sectors[j].is_protected == 0)
343 protect_state = "not protected";
344 else if (p->sectors[j].is_protected == 1)
345 protect_state = "protected";
347 protect_state = "protection state unknown";
349 command_print(cmd_ctx, "\t#%i: 0x%8.8x (0x%x %ikB) %s, %s",
350 j, p->sectors[j].offset, p->sectors[j].size, p->sectors[j].size>>10,
351 erase_state, protect_state);
354 p->driver->info(p, buf, 1024);
355 command_print(cmd_ctx, "%s", buf);
362 int handle_flash_probe_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
369 return ERROR_COMMAND_SYNTAX_ERROR;
372 p = get_flash_bank_by_num_noprobe(strtoul(args[0], NULL, 0));
375 if ((retval = p->driver->probe(p)) == ERROR_OK)
377 command_print(cmd_ctx, "flash '%s' found at 0x%8.8x", p->driver->name, p->base);
379 else if (retval == ERROR_FLASH_BANK_INVALID)
381 command_print(cmd_ctx, "probing failed for flash bank '#%s' at 0x%8.8x",
386 command_print(cmd_ctx, "unknown error when probing flash bank '#%s' at 0x%8.8x",
392 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
398 int handle_flash_erase_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
405 return ERROR_COMMAND_SYNTAX_ERROR;
408 p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
411 if ((retval = p->driver->erase_check(p)) == ERROR_OK)
413 command_print(cmd_ctx, "successfully checked erase state", p->driver->name, p->base);
417 command_print(cmd_ctx, "unknown error when checking erase state of flash bank #%s at 0x%8.8x",
425 int handle_flash_erase_address_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
434 target_t *target = get_current_target(cmd_ctx);
438 return ERROR_COMMAND_SYNTAX_ERROR;
441 address = strtoul(args[0], NULL, 0);
442 length = strtoul(args[1], NULL, 0);
445 command_print(cmd_ctx, "Length must be >0");
446 return ERROR_COMMAND_SYNTAX_ERROR;
449 p = get_flash_bank_by_addr(target, address);
452 return ERROR_COMMAND_SYNTAX_ERROR;
455 /* We can't know if we did a resume + halt, in which case we no longer know the erased state */
458 duration_start_measure(&duration);
460 if ((retval = flash_erase_address_range(target, address, length)) == ERROR_OK)
462 duration_stop_measure(&duration, &duration_text);
463 command_print(cmd_ctx, "erased address 0x%8.8x length %i in %s", address, length, duration_text);
470 int handle_flash_protect_check_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
477 return ERROR_COMMAND_SYNTAX_ERROR;
480 p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
483 if ((retval = p->driver->protect_check(p)) == ERROR_OK)
485 command_print(cmd_ctx, "successfully checked protect state");
487 else if (retval == ERROR_FLASH_OPERATION_FAILED)
489 command_print(cmd_ctx, "checking protection state failed (possibly unsupported) by flash #%s at 0x%8.8x", args[0], p->base);
493 command_print(cmd_ctx, "unknown error when checking protection state of flash bank '#%s' at 0x%8.8x", args[0], p->base);
498 return ERROR_COMMAND_SYNTAX_ERROR;
504 int handle_flash_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
508 int first = strtoul(args[1], NULL, 0);
509 int last = strtoul(args[2], NULL, 0);
511 flash_bank_t *p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
515 duration_start_measure(&duration);
519 return ERROR_COMMAND_SYNTAX_ERROR;
522 if ((retval = flash_driver_erase(p, first, last)) == ERROR_OK)
524 duration_stop_measure(&duration, &duration_text);
526 command_print(cmd_ctx, "erased sectors %i through %i on flash bank %i in %s", first, last, strtoul(args[0], 0, 0), duration_text);
532 return ERROR_COMMAND_SYNTAX_ERROR;
538 int handle_flash_protect_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
542 int first = strtoul(args[1], NULL, 0);
543 int last = strtoul(args[2], NULL, 0);
546 flash_bank_t *p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
549 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
553 if (strcmp(args[3], "on") == 0)
555 else if (strcmp(args[3], "off") == 0)
559 return ERROR_COMMAND_SYNTAX_ERROR;
562 retval = flash_driver_protect(p, set, first, last);
563 if (retval == ERROR_OK)
565 command_print(cmd_ctx, "%s protection for sectors %i through %i on flash bank %i", (set) ? "set" : "cleared", first, last, strtoul(args[0], 0, 0));
570 return ERROR_COMMAND_SYNTAX_ERROR;
577 int handle_flash_write_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
579 target_t *target = get_current_target(cmd_ctx);
591 return ERROR_COMMAND_SYNTAX_ERROR;
597 ERROR("no target selected");
601 duration_start_measure(&duration);
605 image.base_address_set = 1;
606 image.base_address = strtoul(args[1], NULL, 0);
610 image.base_address_set = 0;
611 image.base_address = 0x0;
614 image.start_address_set = 0;
616 retval = image_open(&image, args[0], (argc == 3) ? args[2] : NULL);
617 if (retval != ERROR_OK)
622 retval = flash_write(target, &image, &written, auto_erase);
624 if (retval != ERROR_OK)
630 duration_stop_measure(&duration, &duration_text);
631 if (retval == ERROR_OK)
633 command_print(cmd_ctx, "wrote %u byte from file %s in %s (%f kb/s)",
634 written, args[0], duration_text,
635 (float)written / 1024.0 / ((float)duration.duration.tv_sec + ((float)duration.duration.tv_usec / 1000000.0)));
644 int handle_flash_write_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
660 return ERROR_COMMAND_SYNTAX_ERROR;
663 duration_start_measure(&duration);
665 offset = strtoul(args[2], NULL, 0);
666 p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
669 command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
673 if (fileio_open(&fileio, args[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
678 buffer = malloc(fileio.size);
679 if (fileio_read(&fileio, fileio.size, buffer, &buf_cnt) != ERROR_OK)
684 retval = flash_driver_write(p, buffer, offset, buf_cnt);
688 duration_stop_measure(&duration, &duration_text);
689 if (retval!=ERROR_OK)
691 command_print(cmd_ctx, "wrote %"PRIi64" byte from file %s to flash bank %i at offset 0x%8.8x in %s (%f kb/s)",
692 fileio.size, args[1], strtoul(args[0], NULL, 0), offset, duration_text,
693 (float)fileio.size / 1024.0 / ((float)duration.duration.tv_sec + ((float)duration.duration.tv_usec / 1000000.0)));
697 fileio_close(&fileio);
702 void flash_set_dirty(void)
707 /* set all flash to require erasing */
708 for (c = flash_banks; c; c = c->next)
710 for (i = 0; i < c->num_sectors; i++)
712 c->sectors[i].is_erased = 0;
717 /* lookup flash bank by address */
718 flash_bank_t *get_flash_bank_by_addr(target_t *target, u32 addr)
722 /* cycle through bank list */
723 for (c = flash_banks; c; c = c->next)
726 retval = c->driver->auto_probe(c);
728 if (retval != ERROR_OK)
730 ERROR("auto_probe failed %d\n", retval);
733 /* check whether address belongs to this flash bank */
734 if ((addr >= c->base) && (addr < c->base + c->size) && target == c->target)
737 ERROR("No flash at address 0x%08x\n", addr);
741 /* erase given flash region, selects proper bank according to target and address */
742 int flash_erase_address_range(target_t *target, u32 addr, u32 length)
749 if ((c = get_flash_bank_by_addr(target, addr)) == NULL)
750 return ERROR_FLASH_DST_OUT_OF_BANK; /* no corresponding bank found */
752 if (c->size == 0 || c->num_sectors == 0)
753 return ERROR_FLASH_BANK_INVALID;
757 /* special case, erase whole bank when length is zero */
759 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
761 return flash_driver_erase(c, 0, c->num_sectors - 1);
764 /* check whether it fits */
765 if (addr + length > c->base + c->size)
766 return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
770 for (i = 0; i < c->num_sectors; i++)
772 /* check whether sector overlaps with the given range and is not yet erased */
773 if (addr < c->sectors[i].offset + c->sectors[i].size && addr + length > c->sectors[i].offset && c->sectors[i].is_erased != 1) {
774 /* if first is not set yet then this is the first sector */
777 last = i; /* and it is the last one so far in any case */
781 if( first == -1 || last == -1 )
784 return flash_driver_erase(c, first, last);
787 /* write (optional verify) an image to flash memory of the given target */
788 int flash_write(target_t *target, image_t *image, u32 *written, int erase)
804 /* assume all sectors need erasing - stops any problems
805 * when flash_write is called multiple times */
810 /* loop until we reach end of the image */
811 while (section < image->num_sections)
817 u32 run_address = image->sections[section].base_address + section_offset;
818 u32 run_size = image->sections[section].size - section_offset;
820 if (image->sections[section].size == 0)
822 WARNING("empty section %d", section);
828 /* find the corresponding flash bank */
829 if ((c = get_flash_bank_by_addr(target, run_address)) == NULL)
831 section++; /* and skip it */
836 /* collect consecutive sections which fall into the same bank */
837 section_first = section;
838 section_last = section;
839 while ((run_address + run_size < c->base + c->size)
840 && (section_last + 1 < image->num_sections))
842 if (image->sections[section_last + 1].base_address < (run_address + run_size))
844 DEBUG("section %d out of order(very slightly surprising, but supported)", section_last + 1);
847 if (image->sections[section_last + 1].base_address != (run_address + run_size))
849 run_size += image->sections[++section_last].size;
852 /* fit the run into bank constraints */
853 if (run_address + run_size > c->base + c->size)
854 run_size = c->base + c->size - run_address;
856 /* allocate buffer */
857 buffer = malloc(run_size);
860 /* read sections to the buffer */
861 while (buffer_size < run_size)
865 if (buffer_size - run_size <= image->sections[section].size - section_offset)
866 size_read = buffer_size - run_size;
868 size_read = image->sections[section].size - section_offset;
870 if ((retval = image_read_section(image, section, section_offset,
871 size_read, buffer + buffer_size, &size_read)) != ERROR_OK || size_read == 0)
878 buffer_size += size_read;
879 section_offset += size_read;
881 if (section_offset >= image->sections[section].size)
892 /* calculate and erase sectors */
893 retval = flash_erase_address_range( target, run_address, run_size );
896 if (retval == ERROR_OK)
898 /* write flash sectors */
899 retval = flash_driver_write(c, buffer, run_address - c->base, run_size);
904 if (retval != ERROR_OK)
906 return retval; /* abort operation */
910 *written += run_size; /* add run size to total written counter */
916 int handle_flash_auto_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
920 return ERROR_COMMAND_SYNTAX_ERROR;
924 if (strcmp(args[0], "on") == 0)
926 else if (strcmp(args[0], "off") == 0)
929 return ERROR_COMMAND_SYNTAX_ERROR;