#include <helper/time_support.h>
#include <target/image.h>
+/**
+ * @file
+ * Implements Tcl commands used to access NOR flash facilities.
+ */
+
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,
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;
+ return retval;
}
COMMAND_HANDLER(handle_flash_probe_command)
{
+ struct flash_bank *p;
int retval;
if (CMD_ARGC != 1)
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)
erase_state);
}
- return ERROR_OK;
+ return retval;
}
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);
+ 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)
+ {
+ do_pad = true;
+ } else if (strcmp("unlock", CMD_ARGV[0]) == 0)
+ {
+ do_unlock = true;
+ } else
+ {
+ return ERROR_COMMAND_SYNTAX_ERROR;
+ }
+ CMD_ARGC--;
+ CMD_ARGV++;
+ }
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);
- COMMAND_PARSE_NUMBER(int, CMD_ARGV[0], address);
- COMMAND_PARSE_NUMBER(int, 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();
struct duration bench;
duration_start(&bench);
- retval = flash_erase_address_range(target, 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,
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)
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;
{
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;
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)
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;
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;
+ return retval;
}
COMMAND_HANDLER(handle_flash_write_image_command)
if (CMD_ARGC >= 2)
{
image.base_address_set = 1;
- COMMAND_PARSE_NUMBER(int, CMD_ARGV[1], image.base_address);
+ COMMAND_PARSE_NUMBER(llong, CMD_ARGV[1], image.base_address);
}
else
{
if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
{
- command_print(CMD_CTX, "wrote %" PRIu32 " byte from file %s "
- "in %fs (%0.3f kb/s)", written, CMD_ARGV[0],
+ command_print(CMD_CTX, "wrote %" PRIu32 " bytes from file %s "
+ "in %fs (%0.3f KiB/s)", written, CMD_ARGV[0],
duration_elapsed(&bench), duration_kbps(&bench, written));
}
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;
{
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);
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;
}
}
- 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));
}
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);
if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
{
- command_print(CMD_CTX, "wrote %zu byte from file %s to flash bank %u"
- " at offset 0x%8.8" PRIx32 " in %fs (%0.3f kb/s)",
- fileio.size, CMD_ARGV[1], p->bank_number, offset,
- duration_elapsed(&bench), duration_kbps(&bench, fileio.size));
+ command_print(CMD_CTX, "wrote %ld 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,
+ duration_elapsed(&bench), duration_kbps(&bench, filesize));
}
fileio_close(&fileio);
static const struct command_registration flash_exec_command_handlers[] = {
{
.name = "probe",
- .handler = &handle_flash_probe_command,
+ .handler = handle_flash_probe_command,
.mode = COMMAND_EXEC,
- .usage = "<bank>",
- .help = "identify flash bank",
+ .usage = "bank_id",
+ .help = "Identify a flash bank.",
},
{
.name = "info",
- .handler = &handle_flash_info_command,
+ .handler = handle_flash_info_command,
.mode = COMMAND_EXEC,
- .usage = "<bank>",
- .help = "print bank information",
+ .usage = "bank_id",
+ .help = "Print information about a flash bank.",
},
{
.name = "erase_check",
- .handler = &handle_flash_erase_check_command,
+ .handler = handle_flash_erase_check_command,
.mode = COMMAND_EXEC,
- .usage = "<bank>",
- .help = "check erase state of sectors",
- },
- {
- .name = "protect_check",
- .handler = &handle_flash_protect_check_command,
- .mode = COMMAND_EXEC,
- .usage = "<bank>",
- .help = "check protection state of sectors",
+ .usage = "bank_id",
+ .help = "Check erase state of all blocks in a "
+ "flash bank.",
},
{
.name = "erase_sector",
- .handler = &handle_flash_erase_command,
+ .handler = handle_flash_erase_command,
.mode = COMMAND_EXEC,
- .usage = "<bank> <first> <last>",
- .help = "erase sectors",
+ .usage = "bank_id first_sector_num last_sector_num",
+ .help = "Erase a range of sectors in a flash bank.",
},
{
.name = "erase_address",
- .handler = &handle_flash_erase_address_command,
+ .handler = handle_flash_erase_address_command,
.mode = COMMAND_EXEC,
- .usage = "<address> <length>",
- .help = "erase address range",
+ .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. "
+ "If 'unlock' is specified, then the flash is unprotected "
+ "before erasing.",
},
{
.name = "fillw",
- .handler = &handle_flash_fill_command,
+ .handler = handle_flash_fill_command,
.mode = COMMAND_EXEC,
- .usage = "<address> <word_pattern> <count>",
- .help = "fill with pattern (no autoerase)",
+ .usage = "address value n",
+ .help = "Fill n words with 32-bit value, starting at "
+ "word address. (No autoerase.)",
},
{
.name = "fillh",
- .handler = &handle_flash_fill_command,
+ .handler = handle_flash_fill_command,
.mode = COMMAND_EXEC,
- .usage = "<address> <halfword_pattern> <count>",
- .help = "fill with pattern",
+ .usage = "address value n",
+ .help = "Fill n halfwords with 16-bit value, starting at "
+ "word address. (No autoerase.)",
},
{
.name = "fillb",
- .handler = &handle_flash_fill_command,
+ .handler = handle_flash_fill_command,
.mode = COMMAND_EXEC,
- .usage = "<address> <byte_pattern> <count>",
- .help = "fill with pattern",
-
+ .usage = "address value n",
+ .help = "Fill n bytes with 8-bit value, starting at "
+ "word address. (No autoerase.)",
},
{
.name = "write_bank",
- .handler = &handle_flash_write_bank_command,
+ .handler = handle_flash_write_bank_command,
.mode = COMMAND_EXEC,
- .usage = "<bank> <file> <offset>",
- .help = "write binary data",
+ .usage = "bank_id filename offset",
+ .help = "Write binary data from file to flash bank, "
+ "starting at specified byte offset from the "
+ "beginning of the bank.",
},
{
.name = "write_image",
- .handler = &handle_flash_write_image_command,
+ .handler = handle_flash_write_image_command,
.mode = COMMAND_EXEC,
- .usage = "[erase] [unlock] <file> [offset] [type]",
- .help = "write an image to flash"
+ .usage = "[erase] [unlock] filename [offset [file_type]]",
+ .help = "Write an image to flash. Optionally first unprotect "
+ "and/or erase the region to be used. Allow optional "
+ "offset from beginning of bank (defaults to zero)",
},
{
.name = "protect",
- .handler = &handle_flash_protect_command,
+ .handler = handle_flash_protect_command,
.mode = COMMAND_EXEC,
- .usage = "<bank> <first> <last> <on | off>",
- .help = "set protection of sectors",
+ .usage = "bank_id first_sector [last_sector|'last'] "
+ "('on'|'off')",
+ .help = "Turn protection on or off for a range of sectors "
+ "in a given flash bank.",
},
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;
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
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)
{
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,
- driver_name, c->base);
+ LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8" PRIx32 "Usage %s",
+ driver_name, c->base, driver->usage);
free(c);
return retval;
}
+ if (driver->usage == NULL)
+ LOG_DEBUG("'%s' driver usage field missing", driver_name);
+
flash_bank_add(c);
return ERROR_OK;
COMMAND_HANDLER(handle_flash_banks_command)
{
if (CMD_ARGC != 0)
- return ERROR_INVALID_ARGUMENTS;
+ return ERROR_COMMAND_SYNTAX_ERROR;
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;
static const struct command_registration flash_config_command_handlers[] = {
{
.name = "bank",
- .handler = &handle_flash_bank_command,
+ .handler = handle_flash_bank_command,
.mode = COMMAND_CONFIG,
- .usage = "<name> <driver> <base> <size> "
- "<chip_width> <bus_width> <target> "
+ .usage = "bank_id driver_name base_address size_bytes "
+ "chip_width_bytes bus_width_bytes target "
"[driver_options ...]",
.help = "Define a new bank with the given name, "
"using the specified NOR flash driver.",
{
.name = "init",
.mode = COMMAND_CONFIG,
- .handler = &handle_flash_init_command,
- .help = "initialize flash devices",
+ .handler = handle_flash_init_command,
+ .help = "Initialize flash devices.",
},
{
.name = "banks",
.mode = COMMAND_ANY,
- .handler = &handle_flash_banks_command,
- .help = "return readable information about the flash banks",
+ .handler = handle_flash_banks_command,
+ .help = "Display table with information about flash banks.",
},
{
.name = "list",
.mode = COMMAND_ANY,
- .jim_handler = &jim_flash_list,
- .help = "returns a list of details about the flash banks",
+ .jim_handler = jim_flash_list,
+ .help = "Returns a list of details about the flash banks.",
},
COMMAND_REGISTRATION_DONE
};
projects / fw / openocd / blobdiff