]> git.sur5r.net Git - openocd/blobdiff - src/flash/nor/tcl.c
helper/fileio: Remove nested struct
[openocd] / src / flash / nor / tcl.c
index 57c3be508de6551c64bfdd3267bcc4cf04932a1c..cf0daf34b77c5a37f61a1641fbad5c8601340572 100644 (file)
  * Implements Tcl commands used to access NOR flash facilities.
  */
 
-COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
-       struct flash_bank **bank)
+COMMAND_HELPER(flash_command_get_bank_maybe_probe, unsigned name_index,
+              struct flash_bank **bank, bool do_probe)
 {
        const char *name = CMD_ARGV[name_index];
-       int retval = get_flash_bank_by_name(name, bank);
+       int retval;
+       if (do_probe) {
+               retval = get_flash_bank_by_name(name, bank);
+       } else {
+               *bank  = get_flash_bank_by_name_noprobe(name);
+               retval = ERROR_OK;
+       }
+
        if (retval != ERROR_OK)
                return retval;
        if (*bank)
@@ -44,7 +51,20 @@ COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
        unsigned bank_num;
        COMMAND_PARSE_NUMBER(uint, name, bank_num);
 
-       return get_flash_bank_by_num(bank_num, bank);
+       if (do_probe) {
+               return get_flash_bank_by_num(bank_num, bank);
+       } else {
+               *bank  = get_flash_bank_by_num_noprobe(bank_num);
+               retval = (bank) ? ERROR_OK : ERROR_FAIL;
+               return retval;
+       }
+}
+
+COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
+       struct flash_bank **bank)
+{
+       return CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe,
+                                   name_index, bank, true);
 }
 
 COMMAND_HANDLER(handle_flash_info_command)
@@ -74,7 +94,7 @@ COMMAND_HANDLER(handle_flash_info_command)
                        return retval;
 
                command_print(CMD_CTX,
-                       "#%" PRIu32 " : %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32
+                       "#%d : %s at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32
                        ", buswidth %i, chipwidth %i",
                        p->bank_number,
                        p->driver->name,
@@ -101,12 +121,13 @@ COMMAND_HANDLER(handle_flash_info_command)
                                protect_state);
                }
 
-               *buf = '\0';    /* initialize buffer, otherwise it migh contain garbage if driver
-                                *function fails */
-               retval = p->driver->info(p, buf, sizeof(buf));
-               command_print(CMD_CTX, "%s", buf);
-               if (retval != ERROR_OK)
-                       LOG_ERROR("error retrieving flash info");
+               if (p->driver->info != NULL) {
+                       retval = p->driver->info(p, buf, sizeof(buf));
+                       if (retval == ERROR_OK)
+                               command_print(CMD_CTX, "%s", buf);
+                       else
+                               LOG_ERROR("error retrieving flash info");
+               }
        }
 
        return retval;
@@ -120,7 +141,7 @@ COMMAND_HANDLER(handle_flash_probe_command)
        if (CMD_ARGC != 1)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
-       retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
+       retval = CALL_COMMAND_HANDLER(flash_command_get_bank_maybe_probe, 0, &p, false);
        if (retval != ERROR_OK)
                return retval;
 
@@ -235,7 +256,7 @@ COMMAND_HANDLER(handle_flash_erase_address_command)
                retval = flash_erase_address_range(target, do_pad, address, length);
 
        if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
-               command_print(CMD_CTX, "erased address 0x%8.8x (length %i)"
+               command_print(CMD_CTX, "erased address 0x%8.8" PRIx32 " (length %" PRIi32 ")"
                        " in %fs (%0.3f KiB/s)", address, length,
                        duration_elapsed(&bench), duration_kbps(&bench, length));
        }
@@ -293,7 +314,7 @@ COMMAND_HANDLER(handle_flash_erase_command)
 
        if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
                command_print(CMD_CTX, "erased sectors %" PRIu32 " "
-                       "through %" PRIu32 " on flash bank %" PRIu32 " "
+                       "through %" PRIu32 " on flash bank %d "
                        "in %fs", first, last, p->bank_number, duration_elapsed(&bench));
        }
 
@@ -331,7 +352,7 @@ 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 %" PRIu32 "",
+                       "through %i on flash bank %d",
                        (set) ? "set" : "cleared", (int) first,
                        (int) last, p->bank_number);
        }
@@ -348,14 +369,11 @@ COMMAND_HANDLER(handle_flash_write_image_command)
 
        int retval;
 
-       if (CMD_ARGC < 1)
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
        /* flash auto-erase is disabled by default*/
        int auto_erase = 0;
        bool auto_unlock = false;
 
-       for (;; ) {
+       while (CMD_ARGC) {
                if (strcmp(CMD_ARGV[0], "erase") == 0) {
                        auto_erase = 1;
                        CMD_ARGV++;
@@ -537,7 +555,7 @@ COMMAND_HANDLER(handle_flash_write_bank_command)
 {
        uint32_t offset;
        uint8_t *buffer;
-       struct fileio fileio;
+       struct fileio *fileio;
 
        if (CMD_ARGC != 3)
                return ERROR_COMMAND_SYNTAX_ERROR;
@@ -555,23 +573,23 @@ COMMAND_HANDLER(handle_flash_write_bank_command)
        if (fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY) != ERROR_OK)
                return ERROR_OK;
 
-       int filesize;
-       retval = fileio_size(&fileio, &filesize);
+       size_t filesize;
+       retval = fileio_size(fileio, &filesize);
        if (retval != ERROR_OK) {
-               fileio_close(&fileio);
+               fileio_close(fileio);
                return retval;
        }
 
        buffer = malloc(filesize);
        if (buffer == NULL) {
-               fileio_close(&fileio);
+               fileio_close(fileio);
                LOG_ERROR("Out of memory");
                return ERROR_FAIL;
        }
        size_t buf_cnt;
-       if (fileio_read(&fileio, filesize, buffer, &buf_cnt) != ERROR_OK) {
+       if (fileio_read(fileio, filesize, buffer, &buf_cnt) != ERROR_OK) {
                free(buffer);
-               fileio_close(&fileio);
+               fileio_close(fileio);
                return ERROR_OK;
        }
 
@@ -581,17 +599,176 @@ COMMAND_HANDLER(handle_flash_write_bank_command)
        buffer = NULL;
 
        if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK)) {
-               command_print(CMD_CTX, "wrote %ld bytes from file %s to flash bank %u"
+               command_print(CMD_CTX, "wrote %zu bytes from file %s to flash bank %u"
                        " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
-                       (long)filesize, CMD_ARGV[1], p->bank_number, offset,
+                       filesize, CMD_ARGV[1], p->bank_number, offset,
                        duration_elapsed(&bench), duration_kbps(&bench, filesize));
        }
 
-       fileio_close(&fileio);
+       fileio_close(fileio);
+
+       return retval;
+}
+
+COMMAND_HANDLER(handle_flash_read_bank_command)
+{
+       uint32_t offset;
+       uint8_t *buffer;
+       struct fileio *fileio;
+       uint32_t length;
+       size_t written;
+
+       if (CMD_ARGC != 4)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       struct duration bench;
+       duration_start(&bench);
+
+       struct flash_bank *p;
+       int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
+       if (ERROR_OK != retval)
+               return retval;
+
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[3], length);
+
+       buffer = malloc(length);
+       if (buffer == NULL) {
+               LOG_ERROR("Out of memory");
+               return ERROR_FAIL;
+       }
+
+       retval = flash_driver_read(p, buffer, offset, length);
+       if (retval != ERROR_OK) {
+               LOG_ERROR("Read error");
+               free(buffer);
+               return retval;
+       }
+
+       retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_WRITE, FILEIO_BINARY);
+       if (retval != ERROR_OK) {
+               LOG_ERROR("Could not open file");
+               free(buffer);
+               return retval;
+       }
+
+       retval = fileio_write(fileio, length, buffer, &written);
+       fileio_close(fileio);
+       free(buffer);
+       if (retval != ERROR_OK) {
+               LOG_ERROR("Could not write file");
+               return ERROR_FAIL;
+       }
+
+       if (duration_measure(&bench) == ERROR_OK)
+               command_print(CMD_CTX, "wrote %ld bytes to file %s from flash bank %u"
+                       " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
+                       (long)written, CMD_ARGV[1], p->bank_number, offset,
+                       duration_elapsed(&bench), duration_kbps(&bench, written));
 
        return retval;
 }
 
+
+COMMAND_HANDLER(handle_flash_verify_bank_command)
+{
+       uint32_t offset;
+       uint8_t *buffer_file, *buffer_flash;
+       struct fileio *fileio;
+       size_t read_cnt;
+       size_t filesize;
+       int differ;
+
+       if (CMD_ARGC != 3)
+               return ERROR_COMMAND_SYNTAX_ERROR;
+
+       struct duration bench;
+       duration_start(&bench);
+
+       struct flash_bank *p;
+       int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
+       if (ERROR_OK != retval)
+               return retval;
+
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], offset);
+
+       retval = fileio_open(&fileio, CMD_ARGV[1], FILEIO_READ, FILEIO_BINARY);
+       if (retval != ERROR_OK) {
+               LOG_ERROR("Could not open file");
+               return retval;
+       }
+
+       retval = fileio_size(fileio, &filesize);
+       if (retval != ERROR_OK) {
+               fileio_close(fileio);
+               return retval;
+       }
+
+       buffer_file = malloc(filesize);
+       if (buffer_file == NULL) {
+               LOG_ERROR("Out of memory");
+               fileio_close(fileio);
+               return ERROR_FAIL;
+       }
+
+       retval = fileio_read(fileio, filesize, buffer_file, &read_cnt);
+       fileio_close(fileio);
+       if (retval != ERROR_OK) {
+               LOG_ERROR("File read failure");
+               free(buffer_file);
+               return retval;
+       }
+
+       if (read_cnt != filesize) {
+               LOG_ERROR("Short read");
+               free(buffer_file);
+               return ERROR_FAIL;
+       }
+
+       buffer_flash = malloc(filesize);
+       if (buffer_flash == NULL) {
+               LOG_ERROR("Out of memory");
+               free(buffer_file);
+               return ERROR_FAIL;
+       }
+
+       retval = flash_driver_read(p, buffer_flash, offset, read_cnt);
+       if (retval != ERROR_OK) {
+               LOG_ERROR("Flash read error");
+               free(buffer_flash);
+               free(buffer_file);
+               return retval;
+       }
+
+       if (duration_measure(&bench) == ERROR_OK)
+               command_print(CMD_CTX, "read %ld bytes from file %s and flash bank %u"
+                       " at offset 0x%8.8" PRIx32 " in %fs (%0.3f KiB/s)",
+                       (long)read_cnt, CMD_ARGV[1], p->bank_number, offset,
+                       duration_elapsed(&bench), duration_kbps(&bench, read_cnt));
+
+       differ = memcmp(buffer_file, buffer_flash, read_cnt);
+       command_print(CMD_CTX, "contents %s", differ ? "differ" : "match");
+       if (differ) {
+               uint32_t t;
+               int diffs = 0;
+               for (t = 0; t < read_cnt; t++) {
+                       if (buffer_flash[t] == buffer_file[t])
+                               continue;
+                       command_print(CMD_CTX, "diff %d address 0x%08x. Was 0x%02x instead of 0x%02x",
+                                       diffs, t + offset, buffer_flash[t], buffer_file[t]);
+                       if (diffs++ >= 127) {
+                               command_print(CMD_CTX, "More than 128 errors, the rest are not printed.");
+                               break;
+                       }
+                       keep_alive();
+               }
+       }
+       free(buffer_flash);
+       free(buffer_file);
+
+       return differ ? ERROR_FAIL : ERROR_OK;
+}
+
 void flash_set_dirty(void)
 {
        struct flash_bank *c;
@@ -604,6 +781,24 @@ void flash_set_dirty(void)
        }
 }
 
+COMMAND_HANDLER(handle_flash_padded_value_command)
+{
+       if (CMD_ARGC != 2)
+               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;
+
+       COMMAND_PARSE_NUMBER(u8, CMD_ARGV[1], p->default_padded_value);
+
+       command_print(CMD_CTX, "Default padded value set to 0x%" PRIx8 " for flash bank %u", \
+                       p->default_padded_value, p->bank_number);
+
+       return retval;
+}
+
 static const struct command_registration flash_exec_command_handlers[] = {
        {
                .name = "probe",
@@ -690,6 +885,24 @@ static const struct command_registration flash_exec_command_handlers[] = {
                        "and/or erase the region to be used.  Allow optional "
                        "offset from beginning of bank (defaults to zero)",
        },
+       {
+               .name = "read_bank",
+               .handler = handle_flash_read_bank_command,
+               .mode = COMMAND_EXEC,
+               .usage = "bank_id filename offset length",
+               .help = "Read binary data from flash bank to file, "
+                       "starting at specified byte offset from the "
+                       "beginning of the bank.",
+       },
+       {
+               .name = "verify_bank",
+               .handler = handle_flash_verify_bank_command,
+               .mode = COMMAND_EXEC,
+               .usage = "bank_id filename offset",
+               .help = "Read binary data from flash bank and file, "
+                       "starting at specified byte offset from the "
+                       "beginning of the bank. Compare the contents.",
+       },
        {
                .name = "protect",
                .handler = handle_flash_protect_command,
@@ -699,6 +912,13 @@ static const struct command_registration flash_exec_command_handlers[] = {
                .help = "Turn protection on or off for a range of sectors "
                        "in a given flash bank.",
        },
+       {
+               .name = "padded_value",
+               .handler = handle_flash_padded_value_command,
+               .mode = COMMAND_EXEC,
+               .usage = "bank_id value",
+               .help = "Set default flash padded value",
+       },
        COMMAND_REGISTRATION_DONE
 };
 
@@ -711,7 +931,6 @@ static int flash_init_drivers(struct command_context *cmd_ctx)
        return register_commands(cmd_ctx, parent, flash_exec_command_handlers);
 }
 
-
 COMMAND_HANDLER(handle_flash_bank_command)
 {
        if (CMD_ARGC < 7) {
@@ -764,6 +983,7 @@ COMMAND_HANDLER(handle_flash_bank_command)
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], c->size);
        COMMAND_PARSE_NUMBER(int, CMD_ARGV[3], c->chip_width);
        COMMAND_PARSE_NUMBER(int, CMD_ARGV[4], c->bus_width);
+       c->default_padded_value = 0xff;
        c->num_sectors = 0;
        c->sectors = NULL;
        c->next = NULL;
@@ -771,7 +991,7 @@ COMMAND_HANDLER(handle_flash_bank_command)
        int retval;
        retval = CALL_COMMAND_HANDLER(driver->flash_bank_command, c);
        if (ERROR_OK != retval) {
-               LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8" PRIx32 "Usage %s",
+               LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8" PRIx32 "; usage: %s",
                        driver_name, c->base, driver->usage);
                free(c);
                return retval;
@@ -792,7 +1012,7 @@ COMMAND_HANDLER(handle_flash_banks_command)
 
        unsigned n = 0;
        for (struct flash_bank *p = flash_bank_list(); p; p = p->next, n++) {
-               LOG_USER("#%" PRIu32 " : %s (%s) at 0x%8.8" PRIx32 ", size 0x%8.8" PRIx32 ", "
+               LOG_USER("#%d : %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);