Added the faux flash driver and target. Used for testing.
[openocd.git] / src / flash / flash.c
index 3798413a04580b986bd85729a49148d18600fb72..db04e6e52f9d982176f60d9fd309ce5787173339 100644 (file)
@@ -2,7 +2,7 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
+ *   Copyright (C) 2007,2008 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   Copyright (C) 2008 by Spencer Oliver                                  *
@@ -43,11 +43,15 @@ static int handle_flash_write_bank_command(struct command_context_s *cmd_ctx, ch
 static int handle_flash_write_image_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 static int handle_flash_fill_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
 static int handle_flash_protect_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
+static int flash_write_unlock(target_t *target, image_t *image, uint32_t *written, int erase, bool unlock);
 
 /* flash drivers
  */
 extern flash_driver_t lpc2000_flash;
+extern flash_driver_t lpc288x_flash;
+extern flash_driver_t lpc2900_flash;
 extern flash_driver_t cfi_flash;
+extern flash_driver_t at91sam3_flash;
 extern flash_driver_t at91sam7_flash;
 extern flash_driver_t str7x_flash;
 extern flash_driver_t str9x_flash;
@@ -57,15 +61,18 @@ extern flash_driver_t str9xpec_flash;
 extern flash_driver_t stm32x_flash;
 extern flash_driver_t tms470_flash;
 extern flash_driver_t ecosflash_flash;
-extern flash_driver_t lpc288x_flash;
 extern flash_driver_t ocl_flash;
 extern flash_driver_t pic32mx_flash;
 extern flash_driver_t avr_flash;
+extern flash_driver_t faux_flash;
 
 flash_driver_t *flash_drivers[] = {
        &lpc2000_flash,
+       &lpc288x_flash,
+       &lpc2900_flash,
        &cfi_flash,
        &at91sam7_flash,
+       &at91sam3_flash,
        &str7x_flash,
        &str9x_flash,
        &aduc702x_flash,
@@ -74,10 +81,10 @@ flash_driver_t *flash_drivers[] = {
        &stm32x_flash,
        &tms470_flash,
        &ecosflash_flash,
-       &lpc288x_flash,
        &ocl_flash,
        &pic32mx_flash,
        &avr_flash,
+       &faux_flash,
        NULL,
 };
 
@@ -92,7 +99,7 @@ static int flash_driver_write(struct flash_bank_s *bank, uint8_t *buffer, uint32
        retval = bank->driver->write(bank, buffer, offset, count);
        if (retval != ERROR_OK)
        {
-               LOG_ERROR("error writing to flash at address 0x%08" PRIx32 " at offset 0x%8.8" PRIx32 " (%d)", 
+               LOG_ERROR("error writing to flash at address 0x%08" PRIx32 " at offset 0x%8.8" PRIx32 " (%d)",
                          bank->base, offset, retval);
        }
 
@@ -195,7 +202,7 @@ int flash_init_drivers(struct command_context_s *cmd_ctx)
                register_command(cmd_ctx, flash_cmd, "write_bank", handle_flash_write_bank_command, COMMAND_EXEC,
                                                 "write binary data to <bank> <file> <offset>");
                register_command(cmd_ctx, flash_cmd, "write_image", handle_flash_write_image_command, COMMAND_EXEC,
-                                                "write_image [erase] <file> [offset] [type]");
+                                                "write_image [erase] [unlock] <file> [offset] [type]");
                register_command(cmd_ctx, flash_cmd, "protect", handle_flash_protect_command, COMMAND_EXEC,
                                                 "set protection of sectors at <bank> <first> <last> <on | off>");
        }
@@ -350,13 +357,13 @@ static int handle_flash_info_command(struct command_context_s *cmd_ctx, char *cm
                        if ((retval = p->driver->auto_probe(p)) != ERROR_OK)
                                return retval;
 
-                       command_print(cmd_ctx, 
+                       command_print(cmd_ctx,
                                      "#%" PRIi32 " : %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", buswidth %i, chipwidth %i",
                                      i,
-                                     p->driver->name, 
-                                     p->base, 
-                                     p->size, 
-                                     p->bus_width, 
+                                     p->driver->name,
+                                     p->base,
+                                     p->size,
+                                     p->bus_width,
                                      p->chip_width);
                        for (j = 0; j < p->num_sectors; j++)
                        {
@@ -369,11 +376,11 @@ static int handle_flash_info_command(struct command_context_s *cmd_ctx, char *cm
                                else
                                        protect_state = "protection state unknown";
 
-                               command_print(cmd_ctx, 
+                               command_print(cmd_ctx,
                                              "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s",
                                              j,
-                                             p->sectors[j].offset, 
-                                             p->sectors[j].size, 
+                                             p->sectors[j].offset,
+                                             p->sectors[j].size,
                                              p->sectors[j].size >> 10,
                                              protect_state);
                        }
@@ -462,9 +469,9 @@ static int handle_flash_erase_check_command(struct command_context_s *cmd_ctx, c
 
                        command_print(cmd_ctx,
                                      "\t#%3i: 0x%8.8" PRIx32 " (0x%" PRIx32 " %" PRIi32 "kB) %s",
-                                     j, 
-                                     p->sectors[j].offset, 
-                                     p->sectors[j].size, 
+                                     j,
+                                     p->sectors[j].offset,
+                                     p->sectors[j].size,
                                      p->sectors[j].size >> 10,
                                      erase_state);
                }
@@ -555,82 +562,122 @@ static int handle_flash_protect_check_command(struct command_context_s *cmd_ctx,
        return ERROR_OK;
 }
 
-static int handle_flash_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static int flash_check_sector_parameters(struct command_context_s *cmd_ctx,
+               uint32_t first, uint32_t last, uint32_t num_sectors)
+{
+       if (!(first <= last)) {
+               command_print(cmd_ctx, "ERROR: "
+                               "first sector must be <= last sector");
+               return ERROR_FAIL;
+       }
+
+       if (!(last <= (num_sectors - 1))) {
+               command_print(cmd_ctx, "ERROR: last sector must be <= %d",
+                               (int) num_sectors - 1);
+               return ERROR_FAIL;
+       }
+
+       return ERROR_OK;
+}
+
+static int handle_flash_erase_command(struct command_context_s *cmd_ctx,
+               char *cmd, char **args, int argc)
 {
        if (argc > 2)
        {
-               int first = strtoul(args[1], NULL, 0);
-               int last = strtoul(args[2], NULL, 0);
+               uint32_t bank_nr;
+               uint32_t first;
+               uint32_t last;
                int retval;
-               flash_bank_t *p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
-               duration_t duration;
-               char *duration_text;
 
-               duration_start_measure(&duration);
+               if ((retval = parse_u32(args[0], &bank_nr)) != ERROR_OK)
+                       return retval;
 
+               flash_bank_t *p = get_flash_bank_by_num(bank_nr);
                if (!p)
-               {
-                       return ERROR_COMMAND_SYNTAX_ERROR;
-               }
+                       return ERROR_OK;
 
-               if ((retval = flash_driver_erase(p, first, last)) == ERROR_OK)
-               {
-                       if ((retval = duration_stop_measure(&duration, &duration_text)) != ERROR_OK)
-                       {
+               if ((retval = parse_u32(args[1], &first)) != ERROR_OK)
+                       return retval;
+               if (strcmp(args[2], "last") == 0)
+                       last = p->num_sectors - 1;
+               else
+                       if ((retval = parse_u32(args[2], &last)) != ERROR_OK)
                                return retval;
-                       }
 
-                       command_print(cmd_ctx, "erased sectors %i through %i on flash bank %li in %s",
-                               first, last, strtoul(args[0], 0, 0), duration_text);
+               if ((retval = flash_check_sector_parameters(cmd_ctx,
+                               first, last, p->num_sectors)) != ERROR_OK)
+                       return retval;
+
+               duration_t duration;
+               char *duration_text;
+               duration_start_measure(&duration);
+
+               if ((retval = flash_driver_erase(p, first, last)) == ERROR_OK) {
+                       if ((retval = duration_stop_measure(&duration,
+                                               &duration_text)) != ERROR_OK)
+                               return retval;
+                       command_print(cmd_ctx, "erased sectors %i through %i "
+                                       "on flash bank %i in %s",
+                               (int) first, (int) last, (int) bank_nr,
+                               duration_text);
                        free(duration_text);
                }
        }
        else
-       {
                return ERROR_COMMAND_SYNTAX_ERROR;
-       }
 
        return ERROR_OK;
 }
 
-static int handle_flash_protect_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+static int handle_flash_protect_command(struct command_context_s *cmd_ctx,
+               char *cmd, char **args, int argc)
 {
        if (argc > 3)
        {
-               int first = strtoul(args[1], NULL, 0);
-               int last = strtoul(args[2], NULL, 0);
-               int set;
+               uint32_t bank_nr;
+               uint32_t first;
+               uint32_t last;
                int retval;
-               flash_bank_t *p = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
+               int set;
+
+               if ((retval = parse_u32(args[0], &bank_nr)) != ERROR_OK)
+                       return retval;
+
+               flash_bank_t *p = get_flash_bank_by_num(bank_nr);
                if (!p)
-               {
-                       command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
                        return ERROR_OK;
-               }
+
+               if ((retval = parse_u32(args[1], &first)) != ERROR_OK)
+                       return retval;
+               if (strcmp(args[2], "last") == 0)
+                       last = p->num_sectors - 1;
+               else
+                       if ((retval = parse_u32(args[2], &last)) != ERROR_OK)
+                               return retval;
 
                if (strcmp(args[3], "on") == 0)
                        set = 1;
                else if (strcmp(args[3], "off") == 0)
                        set = 0;
                else
-               {
                        return ERROR_COMMAND_SYNTAX_ERROR;
-               }
+
+               if ((retval = flash_check_sector_parameters(cmd_ctx,
+                               first, last, p->num_sectors)) != ERROR_OK)
+                       return retval;
 
                retval = flash_driver_protect(p, set, first, last);
-               if (retval == ERROR_OK)
-               {
-                       command_print(cmd_ctx, "%s protection for sectors %i through %i on flash bank %li",
-                               (set) ? "set" : "cleared", first,
-                               last, strtoul(args[0], 0, 0));
+               if (retval == ERROR_OK) {
+                       command_print(cmd_ctx, "%s protection for sectors %i "
+                                       "through %i on flash bank %i",
+                               (set) ? "set" : "cleared", (int) first,
+                               (int) last, (int) bank_nr);
                }
        }
        else
-       {
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       }
-
        return ERROR_OK;
 }
 
@@ -653,13 +700,26 @@ static int handle_flash_write_image_command(struct command_context_s *cmd_ctx, c
 
        /* flash auto-erase is disabled by default*/
        int auto_erase = 0;
+       bool auto_unlock = false;
 
-       if (strcmp(args[0], "erase") == 0)
+       for (;;)
        {
-               auto_erase = 1;
-               args++;
-               argc--;
-               command_print(cmd_ctx, "auto erase enabled");
+               if (strcmp(args[0], "erase") == 0)
+               {
+                       auto_erase = 1;
+                       args++;
+                       argc--;
+                       command_print(cmd_ctx, "auto erase enabled");
+               } else if (strcmp(args[0], "unlock") == 0)
+               {
+                       auto_unlock = true;
+                       args++;
+                       argc--;
+                       command_print(cmd_ctx, "auto unlock enabled");
+               } else
+               {
+                       break;
+               }
        }
 
        if (argc < 1)
@@ -694,7 +754,7 @@ static int handle_flash_write_image_command(struct command_context_s *cmd_ctx, c
                return retval;
        }
 
-       retval = flash_write(target, &image, &written, auto_erase);
+       retval = flash_write_unlock(target, &image, &written, auto_erase, auto_unlock);
        if (retval != ERROR_OK)
        {
                image_close(&image);
@@ -706,15 +766,16 @@ static int handle_flash_write_image_command(struct command_context_s *cmd_ctx, c
                image_close(&image);
                return retvaltemp;
        }
-       if (retval == ERROR_OK)
-       {
-               command_print(cmd_ctx, 
-                                         "wrote %" PRIu32 " byte from file %s in %s (%f kb/s)",
-                                         written,
-                                         args[0], 
-                                         duration_text,
-                                         (float)written / 1024.0 / ((float)duration.duration.tv_sec + ((float)duration.duration.tv_usec / 1000000.0)));
-       }
+
+       float speed;
+
+       speed = written / 1024.0;
+       speed /= ((float)duration.duration.tv_sec
+                       + ((float)duration.duration.tv_usec / 1000000.0));
+       command_print(cmd_ctx,
+                       "wrote %" PRIu32 " byte from file %s in %s (%f kb/s)",
+                       written, args[0], duration_text, speed);
+
        free(duration_text);
 
        image_close(&image);
@@ -813,7 +874,7 @@ static int handle_flash_fill_command(struct command_context_s *cmd_ctx, char *cm
                {
                        if (readback[i]!=chunk[i])
                        {
-                               LOG_ERROR("Verfication error address 0x%08" PRIx32 ", read back 0x%02x, expected 0x%02x", 
+                               LOG_ERROR("Verfication error address 0x%08" PRIx32 ", read back 0x%02x, expected 0x%02x",
                                                  address + wrote + i, readback[i], chunk[i]);
                                return ERROR_FAIL;
                        }
@@ -826,18 +887,15 @@ static int handle_flash_fill_command(struct command_context_s *cmd_ctx, char *cm
                return retval;
        }
 
-       if (err == ERROR_OK)
-       {
-               float speed;
-               speed = wrote / 1024.0;
-               speed/=((float)duration.duration.tv_sec + ((float)duration.duration.tv_usec / 1000000.0));
-               command_print(cmd_ctx, 
-                                         "wrote %" PRId32 " bytes to 0x%8.8" PRIx32 " in %s (%f kb/s)",
-                                         count*wordsize, 
-                                         address, 
-                                         duration_text,
-                                         speed);
-       }
+       float speed;
+
+       speed = wrote / 1024.0;
+       speed /= ((float)duration.duration.tv_sec
+                       + ((float)duration.duration.tv_usec / 1000000.0));
+       command_print(cmd_ctx,
+                       "wrote %" PRIu32 " bytes to 0x%8.8" PRIx32 " in %s (%f kb/s)",
+                       wrote, address, duration_text, speed);
+
        free(duration_text);
        return ERROR_OK;
 }
@@ -896,12 +954,12 @@ static int handle_flash_write_bank_command(struct command_context_s *cmd_ctx, ch
        }
        if (retval == ERROR_OK)
        {
-       command_print(cmd_ctx, 
+       command_print(cmd_ctx,
                                  "wrote  %lld byte from file %s to flash bank %li at offset 0x%8.8" PRIx32 " in %s (%f kb/s)",
-                                 fileio.size, 
-                                 args[1], 
-                                 strtoul(args[0], NULL, 0), 
-                                 offset, 
+                                 fileio.size,
+                                 args[1],
+                                 strtoul(args[0], NULL, 0),
+                                 offset,
                                  duration_text,
                                  (float)fileio.size / 1024.0 / ((float)duration.duration.tv_sec + ((float)duration.duration.tv_usec / 1000000.0)));
        }
@@ -952,7 +1010,8 @@ flash_bank_t *get_flash_bank_by_addr(target_t *target, uint32_t addr)
 }
 
 /* erase given flash region, selects proper bank according to target and address */
-int flash_erase_address_range(target_t *target, uint32_t addr, uint32_t length)
+static int flash_iterate_address_range(target_t *target, uint32_t addr, uint32_t length,
+               int (*callback)(struct flash_bank_s *bank, int first, int last))
 {
        flash_bank_t *c;
        int first = -1;
@@ -974,7 +1033,7 @@ int flash_erase_address_range(target_t *target, uint32_t addr, uint32_t length)
                if (addr != c->base)
                        return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
 
-               return flash_driver_erase(c, 0, c->num_sectors - 1);
+               return callback(c, 0, c->num_sectors - 1);
        }
 
        /* check whether it fits */
@@ -997,11 +1056,29 @@ int flash_erase_address_range(target_t *target, uint32_t addr, uint32_t length)
        if (first == -1 || last == -1)
                return ERROR_OK;
 
-       return flash_driver_erase(c, first, last);
+       return callback(c, first, last);
+}
+
+
+
+int flash_erase_address_range(target_t *target, uint32_t addr, uint32_t length)
+{
+       return flash_iterate_address_range(target, addr, length, &flash_driver_erase);
+}
+
+static int flash_driver_unprotect(struct flash_bank_s *bank, int first, int last)
+{
+       return flash_driver_protect(bank, 0, first, last);
+}
+
+static int flash_unlock_address_range(target_t *target, uint32_t addr, uint32_t length)
+{
+       return flash_iterate_address_range(target, addr, length, &flash_driver_unprotect);
 }
 
+
 /* write (optional verify) an image to flash memory of the given target */
-int flash_write(target_t *target, image_t *image, uint32_t *written, int erase)
+static int flash_write_unlock(target_t *target, image_t *image, uint32_t *written, int erase, bool unlock)
 {
        int retval = ERROR_OK;
 
@@ -1124,10 +1201,17 @@ int flash_write(target_t *target, image_t *image, uint32_t *written, int erase)
 
                retval = ERROR_OK;
 
-               if (erase)
+               if (unlock)
+               {
+                       retval = flash_unlock_address_range(target, run_address, run_size);
+               }
+               if (retval == ERROR_OK)
                {
-                       /* calculate and erase sectors */
-                       retval = flash_erase_address_range(target, run_address, run_size);
+                       if (erase)
+                       {
+                               /* calculate and erase sectors */
+                               retval = flash_erase_address_range(target, run_address, run_size);
+                       }
                }
 
                if (retval == ERROR_OK)
@@ -1153,6 +1237,11 @@ int flash_write(target_t *target, image_t *image, uint32_t *written, int erase)
        return retval;
 }
 
+int flash_write(target_t *target, image_t *image, uint32_t *written, int erase)
+{
+       return flash_write_unlock(target, image, written, erase, false);
+}
+
 int default_flash_mem_blank_check(struct flash_bank_s *bank)
 {
        target_t *target = bank->target;

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)