#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)
{
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);
}
int retval;
int address;
int length;
-
+ bool do_pad = false;
struct target *target = get_current_target(CMD_CTX);
- if (CMD_ARGC != 2)
+ switch (CMD_ARGC) {
+ case 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)
+ 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:
return ERROR_COMMAND_SYNTAX_ERROR;
+ }
- 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");
struct duration bench;
duration_start(&bench);
- retval = flash_erase_address_range(target, address, length);
+ retval = flash_erase_address_range(target, do_pad, address, length);
if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
{
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 = get_flash_bank_by_num(bank_nr, &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;
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 = get_flash_bank_by_num(bank_nr, &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;
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 "
+ command_print(CMD_CTX, "wrote %" PRIu32 " bytes from file %s "
"in %fs (%0.3f kb/s)", written, CMD_ARGV[0],
duration_elapsed(&bench), duration_kbps(&bench, written));
}
for (wrote = 0; wrote < (count*wordsize); wrote += cur_size)
{
- cur_size = MIN((count*wordsize - wrote), sizeof(chunk));
struct flash_bank *bank;
+
bank = get_flash_bank_by_addr(target, address);
if (bank == NULL)
{
retval = ERROR_FAIL;
goto done;
}
+
+ cur_size = MIN((count * wordsize - wrote), chunksize);
err = flash_driver_write(bank, chunk, address - bank->base + wrote, cur_size);
if (err != ERROR_OK)
{
duration_elapsed(&bench), duration_kbps(&bench, wrote));
}
- done:
+done:
free(readback);
free(chunk);
if ((ERROR_OK == retval) && (duration_measure(&bench) == ERROR_OK))
{
- command_print(CMD_CTX, "wrote %zu byte from file %s to flash bank %u"
+ 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)",
- fileio.size, CMD_ARGV[1], p->bank_number, offset,
+ (long)fileio.size, CMD_ARGV[1], p->bank_number, offset,
duration_elapsed(&bench), duration_kbps(&bench, fileio.size));
}
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",
+ .usage = "bank_id",
+ .help = "Check erase state of all blocks in a "
+ "flash bank.",
},
{
.name = "protect_check",
- .handler = &handle_flash_protect_check_command,
+ .handler = handle_flash_protect_check_command,
.mode = COMMAND_EXEC,
- .usage = "<bank>",
- .help = "check protection state of sectors",
+ .usage = "bank_id",
+ .help = "Check protection 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'] 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.",
},
{
.name = "fillw",
- .handler = &handle_flash_fill_command,
+ .handler = handle_flash_fill_command,
.mode = COMMAND_EXEC,
- .usage = "<bank> <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 = "<bank> <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 = "<bank> <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 = "<bank> [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 retval;
}
- return ERROR_OK;
+ flash_bank_add(c);
+ return ERROR_OK;
}
+COMMAND_HANDLER(handle_flash_banks_command)
+{
+ if (CMD_ARGC != 0)
+ return ERROR_INVALID_ARGUMENTS;
+
+ 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,
+ p->bus_width, p->chip_width);
+ }
+ return ERROR_OK;
+}
-static int jim_flash_banks(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+static int jim_flash_list(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
{
- if (argc != 1) {
- Jim_WrongNumArgs(interp, 1, argv, "no arguments to flash_banks command");
+ if (argc != 1)
+ {
+ Jim_WrongNumArgs(interp, 1, argv,
+ "no arguments to 'flash list' command");
return JIM_ERR;
}
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,
- .jim_handler = &jim_flash_banks,
- .help = "return 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.",
},
COMMAND_REGISTRATION_DONE
};
projects / fw / openocd / blobdiff