use COMMAND_REGISTER macro
[fw/openocd] / src / flash / flash.c
index 2c63b827c9d7f81527d14e935a9cd480b589b452..7bc74ab73a7edae8124e7607cbda4b55b5afc7a1 100644 (file)
@@ -28,6 +28,7 @@
 #endif
 
 #include "flash.h"
+#include "common.h"
 #include "image.h"
 #include "time_support.h"
 
@@ -180,6 +181,25 @@ int flash_get_bank_count(void)
        return i;
 }
 
+struct flash_bank *get_flash_bank_by_name(const char *name)
+{
+       unsigned requested = get_flash_name_index(name);
+       unsigned found = 0;
+
+       struct flash_bank *bank;
+       for (bank = flash_banks; NULL != bank; bank = bank->next)
+       {
+               if (strcmp(bank->name, name) == 0)
+                       return bank;
+               if (!flash_driver_name_matches(bank->driver->name, name))
+                       continue;
+               if (++found < requested)
+                       continue;
+               return bank;
+       }
+       return NULL;
+}
+
 struct flash_bank *get_flash_bank_by_num(int num)
 {
        struct flash_bank *p = get_flash_bank_by_num_noprobe(num);
@@ -198,10 +218,14 @@ struct flash_bank *get_flash_bank_by_num(int num)
        return p;
 }
 
-COMMAND_HELPER(flash_command_get_bank_by_num,
-       unsigned name_index, struct flash_bank **bank)
+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);
+       if (*bank)
+               return ERROR_OK;
+
        unsigned bank_num;
        COMMAND_PARSE_NUMBER(uint, name, bank_num);
 
@@ -217,25 +241,27 @@ COMMAND_HELPER(flash_command_get_bank_by_num,
 
 COMMAND_HANDLER(handle_flash_bank_command)
 {
-       int retval;
-       int i;
-       int found = 0;
-       struct target *target;
-
-       if (CMD_ARGC < 6)
+       if (CMD_ARGC < 7)
        {
+               LOG_ERROR("usage: flash bank <name> <driver> "
+                               "<base> <size> <chip_width> <bus_width>");
                return ERROR_COMMAND_SYNTAX_ERROR;
        }
+       // save bank name and advance arguments for compatibility
+       const char *bank_name = *CMD_ARGV++;
+       CMD_ARGC--;
 
+       struct target *target;
        if ((target = get_target(CMD_ARGV[5])) == NULL)
        {
                LOG_ERROR("target '%s' not defined", CMD_ARGV[5]);
                return ERROR_FAIL;
        }
 
-       for (i = 0; flash_drivers[i]; i++)
+       const char *driver_name = CMD_ARGV[0];
+       for (unsigned i = 0; flash_drivers[i]; i++)
        {
-               if (strcmp(CMD_ARGV[0], flash_drivers[i]->name) != 0)
+               if (strcmp(driver_name, flash_drivers[i]->name) != 0)
                        continue;
 
                struct flash_bank *p, *c;
@@ -243,11 +269,12 @@ COMMAND_HANDLER(handle_flash_bank_command)
                /* register flash specific commands */
                if (flash_drivers[i]->register_commands(CMD_CTX) != ERROR_OK)
                {
-                       LOG_ERROR("couldn't register '%s' commands", CMD_ARGV[0]);
+                       LOG_ERROR("couldn't register '%s' commands", driver_name);
                        return ERROR_FAIL;
                }
 
                c = malloc(sizeof(struct flash_bank));
+               c->name = strdup(bank_name);
                c->target = target;
                c->driver = flash_drivers[i];
                c->driver_priv = NULL;
@@ -259,10 +286,12 @@ COMMAND_HANDLER(handle_flash_bank_command)
                c->sectors = NULL;
                c->next = NULL;
 
+               int retval;
                retval = CALL_COMMAND_HANDLER(flash_drivers[i]->flash_bank_command, c);
                if (ERROR_OK != retval)
                {
-                       LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8" PRIx32 , CMD_ARGV[0], c->base);
+                       LOG_ERROR("'%s' driver rejected flash bank at 0x%8.8" PRIx32,
+                                       driver_name, c->base);
                        free(c);
                        return retval;
                }
@@ -283,17 +312,12 @@ COMMAND_HANDLER(handle_flash_bank_command)
                        c->bank_number = 0;
                }
 
-               found = 1;
+               return ERROR_OK;
        }
 
        /* no matching flash driver found */
-       if (!found)
-       {
-               LOG_ERROR("flash driver '%s' not found", CMD_ARGV[0]);
-               return ERROR_FAIL;
-       }
-
-       return ERROR_OK;
+       LOG_ERROR("flash driver '%s' not found", driver_name);
+       return ERROR_FAIL;
 }
 
 COMMAND_HANDLER(handle_flash_info_command)
@@ -403,7 +427,7 @@ COMMAND_HANDLER(handle_flash_erase_check_command)
        }
 
        struct flash_bank *p;
-       int retval = CALL_COMMAND_HANDLER(flash_command_get_bank_by_num, 0, &p);
+       int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
@@ -491,7 +515,7 @@ COMMAND_HANDLER(handle_flash_protect_check_command)
                return ERROR_COMMAND_SYNTAX_ERROR;
 
        struct flash_bank *p;
-       int retval = CALL_COMMAND_HANDLER(flash_command_get_bank_by_num, 0, &p);
+       int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
@@ -577,7 +601,6 @@ COMMAND_HANDLER(handle_flash_protect_command)
        uint32_t bank_nr;
        uint32_t first;
        uint32_t last;
-       int set;
 
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], bank_nr);
        struct flash_bank *p = get_flash_bank_by_num(bank_nr);
@@ -590,12 +613,8 @@ COMMAND_HANDLER(handle_flash_protect_command)
        else
                COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], last);
 
-       if (strcmp(CMD_ARGV[3], "on") == 0)
-               set = 1;
-       else if (strcmp(CMD_ARGV[3], "off") == 0)
-               set = 0;
-       else
-               return ERROR_COMMAND_SYNTAX_ERROR;
+       bool set;
+       COMMAND_PARSE_ON_OFF(CMD_ARGV[3], set);
 
        int retval;
        if ((retval = flash_check_sector_parameters(CMD_CTX,
@@ -709,24 +728,40 @@ COMMAND_HANDLER(handle_flash_fill_command)
        uint32_t address;
        uint32_t pattern;
        uint32_t count;
-       uint8_t chunk[1024];
-       uint8_t readback[1024];
        uint32_t wrote = 0;
        uint32_t cur_size = 0;
        uint32_t chunk_count;
        struct target *target = get_current_target(CMD_CTX);
        uint32_t i;
        uint32_t wordsize;
+       int retval = ERROR_OK;
+
+       static size_t const chunksize = 1024;
+       uint8_t *chunk = malloc(chunksize);
+       if (chunk == NULL)
+               return ERROR_FAIL;
+
+       uint8_t *readback = malloc(chunksize);
+       if (readback == NULL)
+       {
+               free(chunk);
+               return ERROR_FAIL;
+       }
+
 
        if (CMD_ARGC != 3)
-               return ERROR_COMMAND_SYNTAX_ERROR;
+       {
+               retval = ERROR_COMMAND_SYNTAX_ERROR;
+               goto done;
+       }
+
 
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], pattern);
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[2], count);
 
        if (count == 0)
-               return ERROR_OK;
+               goto done;
 
        switch (CMD_NAME[4])
        {
@@ -740,10 +775,11 @@ COMMAND_HANDLER(handle_flash_fill_command)
                wordsize = 1;
                break;
        default:
-               return ERROR_COMMAND_SYNTAX_ERROR;
+               retval = ERROR_COMMAND_SYNTAX_ERROR;
+               goto done;
        }
 
-       chunk_count = MIN(count, (1024 / wordsize));
+       chunk_count = MIN(count, (chunksize / wordsize));
        switch (wordsize)
        {
        case 4:
@@ -776,15 +812,22 @@ COMMAND_HANDLER(handle_flash_fill_command)
                bank = get_flash_bank_by_addr(target, address);
                if (bank == NULL)
                {
-                       return ERROR_FAIL;
+                       retval = ERROR_FAIL;
+                       goto done;
                }
                err = flash_driver_write(bank, chunk, address - bank->base + wrote, cur_size);
                if (err != ERROR_OK)
-                       return err;
+               {
+                       retval = err;
+                       goto done;
+               }
 
                err = target_read_buffer(target, address + wrote, cur_size, readback);
                if (err != ERROR_OK)
-                       return err;
+               {
+                       retval = err;
+                       goto done;
+               }
 
                unsigned i;
                for (i = 0; i < cur_size; i++)
@@ -793,7 +836,8 @@ COMMAND_HANDLER(handle_flash_fill_command)
                        {
                                LOG_ERROR("Verfication error address 0x%08" PRIx32 ", read back 0x%02x, expected 0x%02x",
                                                  address + wrote + i, readback[i], chunk[i]);
-                               return ERROR_FAIL;
+                               retval = ERROR_FAIL;
+                               goto done;
                        }
                }
        }
@@ -804,7 +848,12 @@ COMMAND_HANDLER(handle_flash_fill_command)
                                " in %fs (%0.3f kb/s)", wrote, address,
                                duration_elapsed(&bench), duration_kbps(&bench, wrote));
        }
-       return ERROR_OK;
+
+       done:
+       free(readback);
+       free(chunk);
+
+       return retval;
 }
 
 COMMAND_HANDLER(handle_flash_write_bank_command)
@@ -820,7 +869,7 @@ COMMAND_HANDLER(handle_flash_write_bank_command)
        duration_start(&bench);
 
        struct flash_bank *p;
-       int retval = CALL_COMMAND_HANDLER(flash_command_get_bank_by_num, 0, &p);
+       int retval = CALL_COMMAND_HANDLER(flash_command_get_bank, 0, &p);
        if (ERROR_OK != retval)
                return retval;
 
@@ -1133,10 +1182,10 @@ int flash_write(struct target *target, struct image *image, uint32_t *written, i
 int default_flash_mem_blank_check(struct flash_bank *bank)
 {
        struct target *target = bank->target;
-       uint8_t buffer[1024];
-       int buffer_size = sizeof(buffer);
+       const int buffer_size = 1024;
        int i;
        uint32_t nBytes;
+       int retval = ERROR_OK;
 
        if (bank->target->state != TARGET_HALTED)
        {
@@ -1144,6 +1193,8 @@ int default_flash_mem_blank_check(struct flash_bank *bank)
                return ERROR_TARGET_NOT_HALTED;
        }
 
+       uint8_t *buffer = malloc(buffer_size);
+
        for (i = 0; i < bank->num_sectors; i++)
        {
                uint32_t j;
@@ -1152,7 +1203,6 @@ int default_flash_mem_blank_check(struct flash_bank *bank)
                for (j = 0; j < bank->sectors[i].size; j += buffer_size)
                {
                        uint32_t chunk;
-                       int retval;
                        chunk = buffer_size;
                        if (chunk > (j - bank->sectors[i].size))
                        {
@@ -1161,7 +1211,9 @@ int default_flash_mem_blank_check(struct flash_bank *bank)
 
                        retval = target_read_memory(target, bank->base + bank->sectors[i].offset + j, 4, chunk/4, buffer);
                        if (retval != ERROR_OK)
-                               return retval;
+                       {
+                               goto done;
+                       }
 
                        for (nBytes = 0; nBytes < chunk; nBytes++)
                        {
@@ -1174,7 +1226,10 @@ int default_flash_mem_blank_check(struct flash_bank *bank)
                }
        }
 
-       return ERROR_OK;
+       done:
+       free(buffer);
+
+       return retval;
 }
 
 int default_flash_blank_check(struct flash_bank *bank)
@@ -1225,42 +1280,42 @@ int flash_init_drivers(struct command_context *cmd_ctx)
        if (!flash_banks)
                return ERROR_OK;
 
-       register_command(cmd_ctx, flash_cmd, "info",
+       COMMAND_REGISTER(cmd_ctx, flash_cmd, "info",
                        handle_flash_info_command, COMMAND_EXEC,
                        "print info about flash bank <num>");
-       register_command(cmd_ctx, flash_cmd, "probe",
+       COMMAND_REGISTER(cmd_ctx, flash_cmd, "probe",
                        handle_flash_probe_command, COMMAND_EXEC,
                        "identify flash bank <num>");
-       register_command(cmd_ctx, flash_cmd, "erase_check",
+       COMMAND_REGISTER(cmd_ctx, flash_cmd, "erase_check",
                        handle_flash_erase_check_command, COMMAND_EXEC,
                        "check erase state of sectors in flash bank <num>");
-       register_command(cmd_ctx, flash_cmd, "protect_check",
+       COMMAND_REGISTER(cmd_ctx, flash_cmd, "protect_check",
                        handle_flash_protect_check_command, COMMAND_EXEC,
                        "check protection state of sectors in flash bank <num>");
-       register_command(cmd_ctx, flash_cmd, "erase_sector",
+       COMMAND_REGISTER(cmd_ctx, flash_cmd, "erase_sector",
                        handle_flash_erase_command, COMMAND_EXEC,
                        "erase sectors at <bank> <first> <last>");
-       register_command(cmd_ctx, flash_cmd, "erase_address",
+       COMMAND_REGISTER(cmd_ctx, flash_cmd, "erase_address",
                        handle_flash_erase_address_command, COMMAND_EXEC,
                        "erase address range <address> <length>");
 
-       register_command(cmd_ctx, flash_cmd, "fillw",
+       COMMAND_REGISTER(cmd_ctx, flash_cmd, "fillw",
                        handle_flash_fill_command, COMMAND_EXEC,
                        "fill with pattern (no autoerase) <address> <word_pattern> <count>");
-       register_command(cmd_ctx, flash_cmd, "fillh",
+       COMMAND_REGISTER(cmd_ctx, flash_cmd, "fillh",
                        handle_flash_fill_command, COMMAND_EXEC,
                        "fill with pattern <address> <halfword_pattern> <count>");
-       register_command(cmd_ctx, flash_cmd, "fillb",
+       COMMAND_REGISTER(cmd_ctx, flash_cmd, "fillb",
                        handle_flash_fill_command, COMMAND_EXEC,
                        "fill with pattern <address> <byte_pattern> <count>");
 
-       register_command(cmd_ctx, flash_cmd, "write_bank",
+       COMMAND_REGISTER(cmd_ctx, flash_cmd, "write_bank",
                        handle_flash_write_bank_command, COMMAND_EXEC,
                        "write binary data to <bank> <file> <offset>");
-       register_command(cmd_ctx, flash_cmd, "write_image",
+       COMMAND_REGISTER(cmd_ctx, flash_cmd, "write_image",
                        handle_flash_write_image_command, COMMAND_EXEC,
                        "write_image [erase] [unlock] <file> [offset] [type]");
-       register_command(cmd_ctx, flash_cmd, "protect",
+       COMMAND_REGISTER(cmd_ctx, flash_cmd, "protect",
                        handle_flash_protect_command, COMMAND_EXEC,
                        "set protection of sectors at <bank> <first> <last> <on | off>");
 
@@ -1269,10 +1324,10 @@ int flash_init_drivers(struct command_context *cmd_ctx)
 
 int flash_register_commands(struct command_context *cmd_ctx)
 {
-       flash_cmd = register_command(cmd_ctx, NULL, "flash",
+       flash_cmd = COMMAND_REGISTER(cmd_ctx, NULL, "flash",
                        NULL, COMMAND_ANY, NULL);
 
-       register_command(cmd_ctx, flash_cmd, "bank",
+       COMMAND_REGISTER(cmd_ctx, flash_cmd, "bank",
                        handle_flash_bank_command, COMMAND_CONFIG,
                        "flash bank <driver> <base> <size> "
                        "<chip_width> <bus_width> <target> [driver_options ...]");