flash: iterating over an address range now handles multiple banks
[fw/openocd] / src / flash / nor / core.c
index 232d503714fb8ffb38c5dbe28279a9132584c684..ff467d3d0cc6766214c6dc4efa955bfa5b7b3779 100644 (file)
@@ -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  *
@@ -54,74 +55,27 @@ int flash_driver_erase(struct flash_bank *bank, int first, int last)
 int flash_driver_protect(struct flash_bank *bank, int set, int first, int last)
 {
        int retval;
-       bool updated = false;
-
-       /* NOTE: "first == last" means (un?)protect just that sector.
-        code including Lower level ddrivers may rely on this "first <= last"
-        * invariant.
-       */
 
        /* callers may not supply illegal parameters ... */
        if (first < 0 || first > last || last >= bank->num_sectors)
+       {
+               LOG_ERROR("illegal sector range");
                return ERROR_FAIL;
+       }
 
        /* force "set" to 0/1 */
        set = !!set;
 
-       /*
-        * Filter out what trivial nonsense we can, so drivers don't have to.
+       /* DANGER!
         *
-        * Don't tell drivers to change to the current state...  it's needless,
-        * and reducing the amount of work to be done (potentially to nothing)
-        * speeds at least some things up.
-        */
-scan:
-       for (int i = first; i <= last; i++) {
-               struct flash_sector *sector = bank->sectors + i;
-
-               /* Only filter requests to protect the already-protected, or
-                * to unprotect the already-unprotected.  Changing from the
-                * unknown state (-1) to a known one is unwise but allowed;
-                * protection status is best checked first.
-                */
-               if (sector->is_protected != set)
-                       continue;
-
-               /* Shrink this range of sectors from the start; don't overrun
-                * the end.  Also shrink from the end; don't overun the start.
-                *
-                * REVISIT we could handle discontiguous regions by issuing
-                * more than one driver request.  How much would that matter?
-                */
-               if (i == first && i != last) {
-                       updated = true;
-                       first++;
-               } else if (i == last && i != first) {
-                       updated = true;
-                       last--;
-               }
-       }
-
-       /* updating the range affects the tests in the scan loop above; so
-        * re-scan, to make sure we didn't miss anything.
-        */
-       if (updated) {
-               updated = false;
-               goto scan;
-       }
-
-       /* Single sector, already protected?  Nothing to do!
-        * We may have trimmed our parameters into this degenerate case.
+        * We must not use any cached information about protection state!!!!
         *
-        * FIXME repeating the "is_protected==set" test is a giveaway that
-        * this fast-exit belongs earlier, in the trim-it-down loop; mve.
-        * */
-       if (first == last && bank->sectors[first].is_protected == set)
-               return ERROR_OK;
-
-
-       /* Note that we don't pass illegal parameters to drivers; any
-        * trimming just turns one valid range into another one.
+        * There are a million things that could change the protect state:
+        *
+        * the target could have reset, power cycled, been hot plugged,
+        * the application could have run, etc.
+        *
+        * Drivers only receive valid sector range.
         */
        retval = bank->driver->protect(bank, set, first, last);
        if (retval != ERROR_OK)
@@ -147,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 */
@@ -201,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;
@@ -220,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);
@@ -241,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;
 
@@ -255,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)
@@ -372,7 +379,7 @@ int default_flash_blank_check(struct flash_bank *bank)
  * sectors will be added to the range, and that reason string is used when
  * warning about those additions.
  */
-static int flash_iterate_address_range(struct target *target,
+static int flash_iterate_address_range_inner(struct target *target,
                char *pad_reason, uint32_t addr, uint32_t length,
                int (*callback)(struct flash_bank *bank, int first, int last))
 {
@@ -382,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)
        {
@@ -490,6 +498,43 @@ static int flash_iterate_address_range(struct target *target,
        return callback(c, first, last);
 }
 
+/* The inner fn only handles a single bank, we could be spanning
+ * multiple chips.
+ */
+static int flash_iterate_address_range(struct target *target,
+               char *pad_reason, uint32_t addr, uint32_t length,
+               int (*callback)(struct flash_bank *bank, int first, int last))
+{
+       struct flash_bank *c;
+       int retval = ERROR_OK;
+
+       /* Danger! zero-length iterations means entire bank! */
+       do
+       {
+               retval = get_flash_bank_by_addr(target, addr, true, &c);
+               if (retval != ERROR_OK)
+                       return retval;
+
+               uint32_t cur_length = length;
+               /* check whether it all fits in this bank */
+               if (addr + length - 1 > c->base + c->size - 1)
+               {
+                       LOG_DEBUG("iterating over more than one flash bank.");
+                       cur_length = c->base + c->size - addr;
+               }
+               retval = flash_iterate_address_range_inner(target,
+                               pad_reason, addr, cur_length,
+                               callback);
+               if (retval != ERROR_OK)
+                       break;
+
+               length -= cur_length;
+               addr += cur_length;
+       } while (length > 0);
+
+       return retval;
+}
+
 int flash_erase_address_range(struct target *target,
                bool pad, uint32_t addr, uint32_t length)
 {
@@ -502,7 +547,7 @@ static int flash_driver_unprotect(struct flash_bank *bank, int first, int last)
        return flash_driver_protect(bank, 0, first, last);
 }
 
-static int flash_unlock_address_range(struct target *target, uint32_t addr, uint32_t length)
+int flash_unlock_address_range(struct target *target, uint32_t addr, uint32_t length)
 {
        /* By default, pad to sector boundaries ... the real issue here
         * is that our (only) caller *permanently* removes protection,
@@ -514,9 +559,9 @@ static int flash_unlock_address_range(struct target *target, uint32_t addr, uint
 
 static int compare_section (const void * a, const void * b)
 {
-       struct imageection *b1, *b2;
-       b1=*((struct imageection **)a);
-       b2=*((struct imageection **)b);
+       struct imagesection *b1, *b2;
+       b1=*((struct imagesection **)a);
+       b2=*((struct imagesection **)b);
 
        if (b1->base_address == b2->base_address)
        {
@@ -560,7 +605,7 @@ int flash_write_unlock(struct target *target, struct image *image,
 
        /* This fn requires all sections to be in ascending order of addresses,
         * whereas an image can have sections out of order. */
-       struct imageection **sections = malloc(sizeof(struct imageection *) *
+       struct imagesection **sections = malloc(sizeof(struct imagesection *) *
                        image->num_sections);
        int i;
        for (i = 0; i < image->num_sections; i++)
@@ -568,7 +613,7 @@ int flash_write_unlock(struct target *target, struct image *image,
                sections[i] = &image->sections[i];
        }
 
-       qsort(sections, image->num_sections, sizeof(struct imageection *),
+       qsort(sections, image->num_sections, sizeof(struct imagesection *),
                        compare_section);
 
        /* loop until we reach end of the image */
@@ -591,7 +636,12 @@ 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)
+               retval = get_flash_bank_by_addr(target, run_address, false, &c);
+               if (retval != ERROR_OK)
+               {
+                       goto done;
+               }
+               if (c == NULL)
                {
                        section++; /* and skip it */
                        section_offset = 0;
@@ -639,7 +689,16 @@ 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)
+               {
+                       /* If we have more than one flash chip back to back, then we limit
+                        * the current write operation to the current chip.
+                        */
+                       LOG_DEBUG("Truncate flash run size to the current flash chip.");
+
+                       run_size = c->base + c->size - run_address;
+                       assert(run_size > 0);
+               }
 
                /* If we're applying any sector automagic, then pad this
                 * (maybe-combined) segment to the end of its last sector.
@@ -664,6 +723,12 @@ int flash_write_unlock(struct target *target, struct image *image,
 
                /* allocate buffer */
                buffer = malloc(run_size);
+               if (buffer == NULL)
+               {
+                       LOG_ERROR("Out of memory for flash bank buffer");
+                       retval = ERROR_FAIL;
+                       goto done;
+               }
                buffer_size = 0;
 
                /* read sections to the buffer */
@@ -681,9 +746,9 @@ int flash_write_unlock(struct target *target, struct image *image,
                         * list of pointers to sections to invoke image_read_section()...
                         */
                        intptr_t diff = (intptr_t)sections[section] - (intptr_t)image->sections;
-                       int t_section_num = diff / sizeof(struct imageection);
+                       int t_section_num = diff / sizeof(struct imagesection);
 
-                       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,
@@ -754,34 +819,3 @@ int flash_write(struct target *target, struct image *image,
 {
        return flash_write_unlock(target, image, written, erase, false);
 }
-
-/**
- * Invalidates cached flash state which a target can change as it runs.
- *
- * @param target The target being resumed
- *
- * OpenOCD caches some flash state for brief periods.  For example, a sector
- * that is protected must be unprotected before OpenOCD tries to write it,
- * Also, a sector that's not erased must be erased before it's written.
- *
- * As a rule, OpenOCD and target firmware can both modify the flash, so when
- * a target starts running, OpenOCD needs to invalidate its cached state.
- */
-void nor_resume(struct target *target)
-{
-       struct flash_bank *bank;
-
-       for (bank = flash_banks; bank; bank = bank->next) {
-               int i;
-
-               if (bank->target != target)
-                       continue;
-
-               for (i = 0; i < bank->num_sectors; i++) {
-                       struct flash_sector *sector = bank->sectors + i;
-
-                       sector->is_erased = -1;
-                       sector->is_protected = -1;
-               }
-       }
-}