flash: fix error handling
[openocd.git] / src / flash / nor / tcl.c
index 38cb65588c3df186c3b9c7d05bd3c8a7ea358d49..8604b4b33a66eb07d9d0e191dec78e0d827956c1 100644 (file)
@@ -35,50 +35,48 @@ COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
                struct flash_bank **bank)
 {
        const char *name = CMD_ARGV[name_index];
-       *bank = get_flash_bank_by_name(name);
+       int retval = get_flash_bank_by_name(name, bank);
+       if (retval != ERROR_OK)
+               return retval;
        if (*bank)
                return ERROR_OK;
 
        unsigned bank_num;
        COMMAND_PARSE_NUMBER(uint, name, bank_num);
 
-       *bank = get_flash_bank_by_num(bank_num);
-       if (!*bank)
-       {
-               command_print(CMD_CTX, "flash bank '%s' not found", name);
-               return ERROR_INVALID_ARGUMENTS;
-       }
-       return ERROR_OK;
+       return get_flash_bank_by_num(bank_num, bank);
 }
 
 
 COMMAND_HANDLER(handle_flash_info_command)
 {
        struct flash_bank *p;
-       uint32_t i = 0;
        int j = 0;
        int retval;
 
        if (CMD_ARGC != 1)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       unsigned bank_nr;
-       COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], bank_nr);
+       retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
+       if (retval != ERROR_OK)
+               return retval;
 
-       for (p = flash_bank_list(); p; p = p->next, i++)
+       if (p != NULL)
        {
-               if (i != bank_nr)
-                       continue;
-
                char buf[1024];
 
                /* attempt auto probe */
                if ((retval = p->driver->auto_probe(p)) != ERROR_OK)
                        return retval;
 
+               /* We must query the hardware to avoid printing stale information! */
+               retval = p->driver->protect_check(p);
+               if (retval != ERROR_OK)
+                       return retval;
+
                command_print(CMD_CTX,
-                             "#%" PRIi32 " : %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", buswidth %i, chipwidth %i",
-                             i,
+                             "#%" PRIu32 " : %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", buswidth %i, chipwidth %i",
+                             p->bank_number,
                              p->driver->name,
                              p->base,
                              p->size,
@@ -116,6 +114,7 @@ COMMAND_HANDLER(handle_flash_info_command)
 
 COMMAND_HANDLER(handle_flash_probe_command)
 {
+       struct flash_bank *p;
        int retval;
 
        if (CMD_ARGC != 1)
@@ -123,32 +122,24 @@ COMMAND_HANDLER(handle_flash_probe_command)
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       unsigned bank_nr;
-       COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], bank_nr);
-       struct flash_bank *p = get_flash_bank_by_num_noprobe(bank_nr);
+       retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
+       if (retval != ERROR_OK)
+               return retval;
+
        if (p)
        {
                if ((retval = p->driver->probe(p)) == ERROR_OK)
                {
                        command_print(CMD_CTX, "flash '%s' found at 0x%8.8" PRIx32, p->driver->name, p->base);
                }
-               else if (retval == ERROR_FLASH_BANK_INVALID)
-               {
-                       command_print(CMD_CTX, "probing failed for flash bank '#%s' at 0x%8.8" PRIx32,
-                                                 CMD_ARGV[0], p->base);
-               }
-               else
-               {
-                       command_print(CMD_CTX, "unknown error when probing flash bank '#%s' at 0x%8.8" PRIx32,
-                                                 CMD_ARGV[0], p->base);
-               }
        }
        else
        {
                command_print(CMD_CTX, "flash bank '#%s' is out of bounds", CMD_ARGV[0]);
+               retval = ERROR_FAIL;
        }
 
-       return ERROR_OK;
+       return retval;
 }
 
 COMMAND_HANDLER(handle_flash_erase_check_command)
@@ -200,43 +191,49 @@ COMMAND_HANDLER(handle_flash_erase_check_command)
 COMMAND_HANDLER(handle_flash_erase_address_command)
 {
        struct flash_bank *p;
-       int retval;
-       int address;
-       int length;
+       int retval = ERROR_OK;
+       uint32_t address;
+       uint32_t length;
        bool do_pad = false;
+       bool do_unlock = false;
        struct target *target = get_current_target(CMD_CTX);
 
-       switch (CMD_ARGC) {
-       case 3:
+       while (CMD_ARGC >= 3)
+       {
                /* Optionally pad out the address range to block/sector
                 * boundaries.  We can't know if there's data in that part
                 * of the flash; only do padding if we're told to.
                 */
-               if (strcmp("pad", CMD_ARGV[0]) != 0)
+               if (strcmp("pad", CMD_ARGV[0]) == 0)
+               {
+                       do_pad = true;
+               } else if (strcmp("unlock", CMD_ARGV[0]) == 0)
+               {
+                       do_unlock = true;
+               } else
+               {
                        return ERROR_COMMAND_SYNTAX_ERROR;
-               do_pad = true;
+               }
                CMD_ARGC--;
                CMD_ARGV++;
-               /* FALL THROUGH */
-       case 2:
-               COMMAND_PARSE_NUMBER(int, CMD_ARGV[0], address);
-               COMMAND_PARSE_NUMBER(int, CMD_ARGV[1], length);
-               break;
-       default:
+       }
+       if (CMD_ARGC != 2)
+       {
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
+
        if (length <= 0)
        {
                command_print(CMD_CTX, "Length must be >0");
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       p = get_flash_bank_by_addr(target, address);
-       if (p == NULL)
-       {
-               return ERROR_FAIL;
-       }
+       retval = get_flash_bank_by_addr(target, address, true, &p);
+       if (retval != ERROR_OK)
+               return retval;
 
        /* We can't know if we did a resume + halt, in which case we no longer know the erased state */
        flash_set_dirty();
@@ -244,42 +241,24 @@ COMMAND_HANDLER(handle_flash_erase_address_command)
        struct duration bench;
        duration_start(&bench);
 
-       retval = flash_erase_address_range(target, do_pad, address, length);
-
-       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
+       if (do_unlock)
        {
-               command_print(CMD_CTX, "erased address 0x%8.8x (length %i)"
-                               " in %fs (%0.3f kb/s)", address, length,
-                               duration_elapsed(&bench), duration_kbps(&bench, length));
+               retval = flash_unlock_address_range(target, address, length);
        }
 
-       return retval;
-}
-
-COMMAND_HANDLER(handle_flash_protect_check_command)
-{
-       if (CMD_ARGC != 1)
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
-       struct flash_bank *p;
-       int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
-       if (ERROR_OK != retval)
-               return retval;
-
-       if ((retval = p->driver->protect_check(p)) == ERROR_OK)
+       if (retval == ERROR_OK)
        {
-               command_print(CMD_CTX, "successfully checked protect state");
+               retval = flash_erase_address_range(target, do_pad, address, length);
        }
-       else if (retval == ERROR_FLASH_OPERATION_FAILED)
-       {
-               command_print(CMD_CTX, "checking protection state failed (possibly unsupported) by flash #%s at 0x%8.8" PRIx32, CMD_ARGV[0], p->base);
-       }
-       else
+
+       if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
        {
-               command_print(CMD_CTX, "unknown error when checking protection state of flash bank '#%s' at 0x%8.8" PRIx32, CMD_ARGV[0], p->base);
+               command_print(CMD_CTX, "erased address 0x%8.8x (length %i)"
+                               " in %fs (%0.3f KiB/s)", address, length,
+                               duration_elapsed(&bench), duration_kbps(&bench, length));
        }
 
-       return ERROR_OK;
+       return retval;
 }
 
 static int flash_check_sector_parameters(struct command_context *cmd_ctx,
@@ -305,14 +284,15 @@ COMMAND_HANDLER(handle_flash_erase_command)
        if (CMD_ARGC != 3)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       uint32_t bank_nr;
        uint32_t first;
        uint32_t last;
 
-       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], bank_nr);
-       struct flash_bank *p = get_flash_bank_by_num(bank_nr);
-       if (!p)
-               return ERROR_OK;
+       struct flash_bank *p;
+       int retval;
+
+       retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
+       if (retval != ERROR_OK)
+               return retval;
 
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
        if (strcmp(CMD_ARGV[2], "last") == 0)
@@ -320,7 +300,6 @@ COMMAND_HANDLER(handle_flash_erase_command)
        else
                COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);
 
-       int retval;
        if ((retval = flash_check_sector_parameters(CMD_CTX,
                        first, last, p->num_sectors)) != ERROR_OK)
                return retval;
@@ -334,7 +313,7 @@ COMMAND_HANDLER(handle_flash_erase_command)
        {
                command_print(CMD_CTX, "erased sectors %" PRIu32 " "
                                "through %" PRIu32" on flash bank %" PRIu32 " "
-                               "in %fs", first, last, bank_nr, duration_elapsed(&bench));
+                               "in %fs", first, last, p->bank_number, duration_elapsed(&bench));
        }
 
        return ERROR_OK;
@@ -345,14 +324,15 @@ COMMAND_HANDLER(handle_flash_protect_command)
        if (CMD_ARGC != 4)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       uint32_t bank_nr;
        uint32_t first;
        uint32_t last;
 
-       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], bank_nr);
-       struct flash_bank *p = get_flash_bank_by_num(bank_nr);
-       if (!p)
-               return ERROR_OK;
+       struct flash_bank *p;
+       int retval;
+
+       retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
+       if (retval != ERROR_OK)
+               return retval;
 
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], first);
        if (strcmp(CMD_ARGV[2], "last") == 0)
@@ -363,7 +343,6 @@ COMMAND_HANDLER(handle_flash_protect_command)
        bool set;
        COMMAND_PARSE_ON_OFF(CMD_ARGV[3], set);
 
-       int retval;
        if ((retval = flash_check_sector_parameters(CMD_CTX,
                        first, last, p->num_sectors)) != ERROR_OK)
                return retval;
@@ -371,9 +350,9 @@ COMMAND_HANDLER(handle_flash_protect_command)
        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 %i",
+                               "through %i on flash bank %" PRIu32 "",
                        (set) ? "set" : "cleared", (int) first,
-                       (int) last, (int) bank_nr);
+                       (int) last, p->bank_number);
        }
 
        return ERROR_OK;
@@ -460,7 +439,7 @@ COMMAND_HANDLER(handle_flash_write_image_command)
        if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
        {
                command_print(CMD_CTX, "wrote %" PRIu32 " bytes from file %s "
-                               "in %fs (%0.3f kb/s)", written, CMD_ARGV[0],
+                               "in %fs (%0.3f KiB/s)", written, CMD_ARGV[0],
                                duration_elapsed(&bench), duration_kbps(&bench, written));
        }
 
@@ -479,7 +458,7 @@ COMMAND_HANDLER(handle_flash_fill_command)
        uint32_t cur_size = 0;
        uint32_t chunk_count;
        struct target *target = get_current_target(CMD_CTX);
-       uint32_t i;
+       unsigned i;
        uint32_t wordsize;
        int retval = ERROR_OK;
 
@@ -556,12 +535,9 @@ COMMAND_HANDLER(handle_flash_fill_command)
        {
                struct flash_bank *bank;
 
-               bank = get_flash_bank_by_addr(target, address);
-               if (bank == NULL)
-               {
-                       retval = ERROR_FAIL;
+               retval = get_flash_bank_by_addr(target, address, true, &bank );
+               if (retval != ERROR_OK)
                        goto done;
-               }
 
                cur_size = MIN((count * wordsize - wrote), chunksize);
                err = flash_driver_write(bank, chunk, address - bank->base + wrote, cur_size);
@@ -571,19 +547,18 @@ COMMAND_HANDLER(handle_flash_fill_command)
                        goto done;
                }
 
-               err = target_read_buffer(target, address + wrote, cur_size, readback);
+               err = flash_driver_read(bank, readback, address - bank->base + wrote, cur_size);
                if (err != ERROR_OK)
                {
                        retval = err;
                        goto done;
                }
 
-               unsigned i;
                for (i = 0; i < cur_size; i++)
                {
                        if (readback[i]!=chunk[i])
                        {
-                               LOG_ERROR("Verfication error address 0x%08" PRIx32 ", read back 0x%02x, expected 0x%02x",
+                               LOG_ERROR("Verification error address 0x%08" PRIx32 ", read back 0x%02x, expected 0x%02x",
                                                  address + wrote + i, readback[i], chunk[i]);
                                retval = ERROR_FAIL;
                                goto done;
@@ -591,10 +566,10 @@ COMMAND_HANDLER(handle_flash_fill_command)
                }
        }
 
-       if (duration_measure(&bench) == ERROR_OK)
+       if ((retval == ERROR_OK) && (duration_measure(&bench) == ERROR_OK))
        {
                command_print(CMD_CTX, "wrote %" PRIu32 " bytes to 0x%8.8" PRIx32
-                               " in %fs (%0.3f kb/s)", wrote, address,
+                               " in %fs (%0.3f KiB/s)", wrote, address,
                                duration_elapsed(&bench), duration_kbps(&bench, wrote));
        }
 
@@ -646,7 +621,7 @@ COMMAND_HANDLER(handle_flash_write_bank_command)
        if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
        {
                command_print(CMD_CTX, "wrote %ld bytes from file %s to flash bank %u"
-                               " at offset 0x%8.8" PRIx32 " in %fs (%0.3f kb/s)",
+                               " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
                                (long)fileio.size, CMD_ARGV[1], p->bank_number, offset,
                                duration_elapsed(&bench), duration_kbps(&bench, fileio.size));
        }
@@ -694,14 +669,6 @@ static const struct command_registration flash_exec_command_handlers[] = {
                .help = "Check erase state of all blocks in a "
                        "flash bank.",
        },
-       {
-               .name = "protect_check",
-               .handler = handle_flash_protect_check_command,
-               .mode = COMMAND_EXEC,
-               .usage = "bank_id",
-               .help = "Check protection state of all blocks in a "
-                       "flash bank.",
-       },
        {
                .name = "erase_sector",
                .handler = handle_flash_erase_command,
@@ -713,12 +680,15 @@ static const struct command_registration flash_exec_command_handlers[] = {
                .name = "erase_address",
                .handler = handle_flash_erase_address_command,
                .mode = COMMAND_EXEC,
-               .usage = "['pad'] address length",
+               .usage = "['pad'] ['unlock'] address length",
                .help = "Erase flash sectors starting at address and "
                        "continuing for length bytes.  If 'pad' is specified, "
                        "data outside that range may also be erased: the start "
                        "address may be decreased, and length increased, so "
-                       "that all of the first and last sectors are erased.",
+                       "that all of the first and last sectors are erased. "
+                       "If 'unlock' is specified, then the flash is unprotected "
+                       "before erasing.",
+
        },
        {
                .name = "fillw",
@@ -774,7 +744,7 @@ static const struct command_registration flash_exec_command_handlers[] = {
        COMMAND_REGISTRATION_DONE
 };
 
-int flash_init_drivers(struct command_context *cmd_ctx)
+static int flash_init_drivers(struct command_context *cmd_ctx)
 {
        if (!flash_bank_list())
                return ERROR_OK;
@@ -789,7 +759,7 @@ COMMAND_HANDLER(handle_flash_bank_command)
        if (CMD_ARGC < 7)
        {
                LOG_ERROR("usage: flash bank <name> <driver> "
-                               "<base> <size> <chip_width> <bus_width>");
+                               "<base> <size> <chip_width> <bus_width> <target>");
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
        // save bank name and advance arguments for compatibility
@@ -812,6 +782,14 @@ COMMAND_HANDLER(handle_flash_bank_command)
                return ERROR_FAIL;
        }
 
+       /* check the flash bank name is unique */
+       if (get_flash_bank_by_name_noprobe(bank_name) != NULL)
+       {
+               /* flash bank name already exists  */
+               LOG_ERROR("flash bank name '%s' already exists", bank_name);
+               return ERROR_FAIL;
+       }
+
        /* register flash specific commands */
        if (NULL != driver->commands)
        {
@@ -861,8 +839,8 @@ COMMAND_HANDLER(handle_flash_banks_command)
        unsigned n = 0;
        for (struct flash_bank *p = flash_bank_list(); p; p = p->next, n++)
        {
-               LOG_USER("#%u: %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", "
-                       "buswidth %u, chipwidth %u", n,
+               LOG_USER("#%" PRIu32 " : %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", "
+                       "buswidth %u, chipwidth %u", p->bank_number,
                        p->driver->name, p->base, p->size,
                        p->bus_width, p->chip_width);
        }

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)