gdb: connect will now fail if flash autoprobe fails
[fw/openocd] / src / flash / nor / tcl.c
index 65523fbe4bfda55256930a8c4cfb92aa8e2cfb96..66b8ac3402634a6574308da71839bd1d1dbe550c 100644 (file)
 #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)
 {
@@ -37,13 +42,7 @@ COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
        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);
 }
 
 
@@ -198,14 +197,29 @@ COMMAND_HANDLER(handle_flash_erase_address_command)
        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");
@@ -224,7 +238,7 @@ COMMAND_HANDLER(handle_flash_erase_address_command)
        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))
        {
@@ -290,9 +304,12 @@ COMMAND_HANDLER(handle_flash_erase_command)
        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)
@@ -300,7 +317,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;
@@ -330,9 +346,10 @@ COMMAND_HANDLER(handle_flash_protect_command)
        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)
@@ -343,7 +360,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;
@@ -414,7 +430,7 @@ 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
        {
@@ -693,9 +709,12 @@ static const struct command_registration flash_exec_command_handlers[] = {
                .name = "erase_address",
                .handler = handle_flash_erase_address_command,
                .mode = COMMAND_EXEC,
-               .usage = "address length",
-               .help = "Erase flash blocks starting at address "
-                       "and continuing for length bytes.",
+               .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",
@@ -751,7 +770,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;
@@ -766,7 +785,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
@@ -901,7 +920,7 @@ COMMAND_HANDLER(handle_flash_init_command)
 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 = "bank_id driver_name base_address size_bytes "
                        "chip_width_bytes bus_width_bytes target "
@@ -912,19 +931,19 @@ static const struct command_registration flash_config_command_handlers[] = {
        {
                .name = "init",
                .mode = COMMAND_CONFIG,
-               .handler = &handle_flash_init_command,
+               .handler = handle_flash_init_command,
                .help = "Initialize flash devices.",
        },
        {
                .name = "banks",
                .mode = COMMAND_ANY,
-               .handler = &handle_flash_banks_command,
+               .handler = handle_flash_banks_command,
                .help = "Display table with information about flash banks.",
        },
        {
                .name = "list",
                .mode = COMMAND_ANY,
-               .jim_handler = &jim_flash_list,
+               .jim_handler = jim_flash_list,
                .help = "Returns a list of details about the flash banks.",
        },
        COMMAND_REGISTRATION_DONE