flash: add error handling to get_flash_by_addr/name

[openocd.git] / src / flash / nor / core.c

diff --git a/src/flash/nor/core.c b/src/flash/nor/core.c
index 936f07ca62caa0990dafccfdb4f7829d87d23641..d2f2754d67ce714b94605f8211b7b50bd491cbb9 100644 (file)
--- a/src/flash/nor/core.c
+++ b/src/flash/nor/core.c
@@ -3,6 +3,7 @@
  *   Copyright (C) 2007-2010 Øyvind Harboe <oyvind.harboe@zylin.com>       *
  *   Copyright (C) 2008 by Spencer Oliver <spen@spen-soft.co.uk>           *
  *   Copyright (C) 2009 Zachary T Welch <zw@superlucidity.net>             *
+ *   Copyright (C) 2010 by Antonio Borneo <borneo.antonio@gmail.com>       *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
@@ -100,6 +101,29 @@ int flash_driver_write(struct flash_bank *bank,
        return retval;
 }
 
+int flash_driver_read(struct flash_bank *bank,
+               uint8_t *buffer, uint32_t offset, uint32_t count)
+{
+       int retval;
+
+       LOG_DEBUG("call flash_driver_read()");
+
+       retval = bank->driver->read(bank, buffer, offset, count);
+       if (retval != ERROR_OK)
+       {
+               LOG_ERROR("error reading to flash at address 0x%08" PRIx32 " at offset 0x%8.8" PRIx32 " (%d)",
+                         bank->base, offset, retval);
+       }
+
+       return retval;
+}
+
+int default_flash_read(struct flash_bank *bank,
+               uint8_t *buffer, uint32_t offset, uint32_t count)
+{
+       return target_read_buffer(bank->target, offset + bank->base, count, buffer);
+}
+
 void flash_bank_add(struct flash_bank *bank)
 {
        /* put flash bank in linked list */
@@ -154,7 +178,7 @@ int flash_get_bank_count(void)
        return i;
 }
 
-struct flash_bank *get_flash_bank_by_name(const char *name)
+struct flash_bank *get_flash_bank_by_name_noprobe(const char *name)
 {
        unsigned requested = get_flash_name_index(name);
        unsigned found = 0;
@@ -173,6 +197,27 @@ struct flash_bank *get_flash_bank_by_name(const char *name)
        return NULL;
 }
 
+int get_flash_bank_by_name(const char *name, struct flash_bank **bank_result)
+{
+       struct flash_bank *bank;
+       int retval;
+
+       bank = get_flash_bank_by_name_noprobe(name);
+       if (bank != NULL)
+       {
+               retval = bank->driver->auto_probe(bank);
+
+               if (retval != ERROR_OK)
+               {
+                       LOG_ERROR("auto_probe failed %d\n", retval);
+                       return retval;
+               }
+       }
+
+       *bank_result = bank;
+       return ERROR_OK;
+}
+
 int get_flash_bank_by_num(int num, struct flash_bank **bank)
 {
        struct flash_bank *p = get_flash_bank_by_num_noprobe(num);
@@ -194,8 +239,9 @@ int get_flash_bank_by_num(int num, struct flash_bank **bank)
        return ERROR_OK;
 }
 
-/* lookup flash bank by address */
-struct flash_bank *get_flash_bank_by_addr(struct target *target, uint32_t addr)
+/* lookup flash bank by address, bank not found is success, but
+ * result_bank is set to NULL. */
+int get_flash_bank_by_addr(struct target *target, uint32_t addr, bool check, struct flash_bank **result_bank)
 {
        struct flash_bank *c;
 
@@ -208,14 +254,22 @@ struct flash_bank *get_flash_bank_by_addr(struct target *target, uint32_t addr)
                if (retval != ERROR_OK)
                {
                        LOG_ERROR("auto_probe failed %d\n", retval);
-                       return NULL;
+                       return retval;
                }
                /* check whether address belongs to this flash bank */
                if ((addr >= c->base) && (addr <= c->base + (c->size - 1)) && target == c->target)
-                       return c;
+               {
+                       *result_bank = c;
+                       return ERROR_OK;
+               }
        }
-       LOG_ERROR("No flash at address 0x%08" PRIx32 "\n", addr);
-       return NULL;
+       *result_bank = NULL;
+       if (check)
+       {
+               LOG_ERROR("No flash at address 0x%08" PRIx32 "\n", addr);
+               return ERROR_FAIL;
+       }
+       return ERROR_OK;
 }
 
 int default_flash_mem_blank_check(struct flash_bank *bank)
@@ -335,8 +389,9 @@ static int flash_iterate_address_range(struct target *target,
        int last = -1;
        int i;
 
-       if ((c = get_flash_bank_by_addr(target, addr)) == NULL)
-               return ERROR_FLASH_DST_OUT_OF_BANK; /* no corresponding bank found */
+       int retval = get_flash_bank_by_addr(target, addr, true, &c);
+       if (retval != ERROR_OK)
+               return retval;
 
        if (c->size == 0 || c->num_sectors == 0)
        {
@@ -544,7 +599,11 @@ int flash_write_unlock(struct target *target, struct image *image,
                }
 
                /* find the corresponding flash bank */
-               if ((c = get_flash_bank_by_addr(target, run_address)) == NULL)
+               int retval;
+               retval = get_flash_bank_by_addr(target, run_address, false, &c);
+               if (retval != ERROR_OK)
+                       return retval;
+               if (c == NULL)
                {
                        section++; /* and skip it */
                        section_offset = 0;
@@ -592,7 +651,11 @@ int flash_write_unlock(struct target *target, struct image *image,
                                LOG_INFO("Padding image section %d with %d bytes", section_last-1, pad_bytes);
                }
 
-               assert (run_address + run_size - 1 <= c->base + c->size - 1);
+               if (run_address + run_size - 1 > c->base + c->size - 1)
+               {
+                       LOG_ERROR("The image is too big for the flash");
+                       return ERROR_FAIL;
+               }
 
                /* If we're applying any sector automagic, then pad this
                 * (maybe-combined) segment to the end of its last sector.
@@ -636,7 +699,7 @@ int flash_write_unlock(struct target *target, struct image *image,
                        intptr_t diff = (intptr_t)sections[section] - (intptr_t)image->sections;
                        int t_section_num = diff / sizeof(struct imageection);
 
-                       LOG_DEBUG("image_read_section: section = %d, t_section_num = %d, section_offset = %d, buffer_size = %d, size_read = %d", 
+                       LOG_DEBUG("image_read_section: section = %d, t_section_num = %d, section_offset = %d, buffer_size = %d, size_read = %d",
                                 (int)section,
 (int)t_section_num, (int)section_offset, (int)buffer_size, (int)size_read);
                        if ((retval = image_read_section(image, t_section_num, section_offset,