error handling: the error number is not part of the user interface
[openocd.git] / src / flash / nor / tcl.c
index 17c6e91037e20e1951ed548cd2ffb801b926df13..4c64a28d8458f3ce8a41f187b83dbb1f2af9a3ed 100644 (file)
@@ -35,7 +35,9 @@ 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;
 
@@ -49,21 +51,18 @@ COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
 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 */
@@ -76,8 +75,8 @@ COMMAND_HANDLER(handle_flash_info_command)
                        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,
@@ -107,7 +106,7 @@ COMMAND_HANDLER(handle_flash_info_command)
                retval = p->driver->info(p, buf, sizeof(buf));
                command_print(CMD_CTX, "%s", buf);
                if (retval != ERROR_OK)
-                       LOG_ERROR("error retrieving flash info (%d)", retval);
+                       LOG_ERROR("error retrieving flash info");
        }
 
        return ERROR_OK;
@@ -115,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)
@@ -122,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,8 +192,8 @@ COMMAND_HANDLER(handle_flash_erase_address_command)
 {
        struct flash_bank *p;
        int retval = ERROR_OK;
-       int address;
-       int length;
+       uint32_t address;
+       uint32_t length;
        bool do_pad = false;
        bool do_unlock = false;
        struct target *target = get_current_target(CMD_CTX);
@@ -230,8 +222,8 @@ COMMAND_HANDLER(handle_flash_erase_address_command)
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
-       COMMAND_PARSE_NUMBER(int, CMD_ARGV[0], address);
-       COMMAND_PARSE_NUMBER(int, CMD_ARGV[1], length);
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], length);
 
        if (length <= 0)
        {
@@ -239,11 +231,9 @@ COMMAND_HANDLER(handle_flash_erase_address_command)
                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();
@@ -264,7 +254,7 @@ COMMAND_HANDLER(handle_flash_erase_address_command)
        if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
        {
                command_print(CMD_CTX, "erased address 0x%8.8x (length %i)"
-                               " in %fs (%0.3f kb/s)", address, length,
+                               " in %fs (%0.3f KiB/s)", address, length,
                                duration_elapsed(&bench), duration_kbps(&bench, length));
        }
 
@@ -294,15 +284,13 @@ 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;
        int retval;
-       retval = get_flash_bank_by_num(bank_nr, &p);
+
+       retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
        if (retval != ERROR_OK)
                return retval;
 
@@ -325,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;
@@ -336,13 +324,13 @@ 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;
-       int retval = get_flash_bank_by_num(bank_nr, &p);
+       int retval;
+
+       retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
        if (retval != ERROR_OK)
                return retval;
 
@@ -362,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;
@@ -451,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));
        }
 
@@ -470,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;
 
@@ -547,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);
@@ -562,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;
@@ -582,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));
        }
 
@@ -620,9 +604,23 @@ COMMAND_HANDLER(handle_flash_write_bank_command)
                return ERROR_OK;
        }
 
-       buffer = malloc(fileio.size);
+       int filesize;
+       retval = fileio_size(&fileio, &filesize);
+       if (retval != ERROR_OK)
+       {
+               fileio_close(&fileio);
+               return retval;
+       }
+
+       buffer = malloc(filesize);
+       if (buffer == NULL)
+       {
+               fileio_close(&fileio);
+               LOG_ERROR("Out of memory");
+               return ERROR_FAIL;
+       }
        size_t buf_cnt;
-       if (fileio_read(&fileio, fileio.size, buffer, &buf_cnt) != ERROR_OK)
+       if (fileio_read(&fileio, filesize, buffer, &buf_cnt) != ERROR_OK)
        {
                free(buffer);
                fileio_close(&fileio);
@@ -637,9 +635,9 @@ 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)",
-                               (long)fileio.size, CMD_ARGV[1], p->bank_number, offset,
-                               duration_elapsed(&bench), duration_kbps(&bench, fileio.size));
+                               " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
+                               (long)filesize, CMD_ARGV[1], p->bank_number, offset,
+                               duration_elapsed(&bench), duration_kbps(&bench, filesize));
        }
 
        fileio_close(&fileio);
@@ -798,6 +796,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)
        {
@@ -847,9 +853,9 @@ 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,
-                       p->driver->name, p->base, p->size,
+               LOG_USER("#%" PRIu32 " : %s (%s) at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", "
+                       "buswidth %u, chipwidth %u", p->bank_number,
+                       p->name, p->driver->name, p->base, p->size,
                        p->bus_width, p->chip_width);
        }
        return ERROR_OK;

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)