flash: stop caching protection state
[openocd.git] / src / flash / nor / core.c
index aedaa8661c66ecfa69e4f4dcb69f9e254a63c9a3..936f07ca62caa0990dafccfdb4f7829d87d23641 100644 (file)
@@ -1,6 +1,6 @@
 /***************************************************************************
  *   Copyright (C) 2005 by Dominic Rath <Dominic.Rath@gmx.de>              *
- *   Copyright (C) 2007,2008 Øyvind Harboe <oyvind.harboe@zylin.com>       *
+ *   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>             *
  *                                                                         *
@@ -36,7 +36,7 @@
  * primarily support access from Tcl scripts or from GDB.
  */
 
-struct flash_bank *flash_banks;
+static struct flash_bank *flash_banks;
 
 int flash_driver_erase(struct flash_bank *bank, int first, int last)
 {
@@ -55,6 +55,27 @@ int flash_driver_protect(struct flash_bank *bank, int set, int first, int last)
 {
        int retval;
 
+       /* 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;
+
+       /* DANGER!
+        *
+        * We must not use any cached information about protection state!!!!
+        *
+        * 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)
        {
@@ -152,22 +173,25 @@ struct flash_bank *get_flash_bank_by_name(const char *name)
        return NULL;
 }
 
-struct flash_bank *get_flash_bank_by_num(int num)
+int get_flash_bank_by_num(int num, struct flash_bank **bank)
 {
        struct flash_bank *p = get_flash_bank_by_num_noprobe(num);
        int retval;
 
        if (p == NULL)
-               return NULL;
+       {
+               return ERROR_FAIL;
+       }
 
        retval = p->driver->auto_probe(p);
 
        if (retval != ERROR_OK)
        {
                LOG_ERROR("auto_probe failed %d\n", retval);
-               return NULL;
+               return retval;
        }
-       return p;
+       *bank = p;
+       return ERROR_OK;
 }
 
 /* lookup flash bank by address */
@@ -324,14 +348,20 @@ static int flash_iterate_address_range(struct target *target,
        {
                /* special case, erase whole bank when length is zero */
                if (addr != c->base)
+               {
+                       LOG_ERROR("Whole bank access must start at beginning of bank.");
                        return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
+               }
 
                return callback(c, 0, c->num_sectors - 1);
        }
 
        /* check whether it all fits in this bank */
        if (addr + length - 1 > c->base + c->size - 1)
+       {
+               LOG_ERROR("Flash access does not fit into bank.");
                return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
+       }
 
        /** @todo: handle erasures that cross into adjacent banks */
 
@@ -402,7 +432,7 @@ static int flash_iterate_address_range(struct target *target,
                LOG_ERROR("address range 0x%8.8x .. 0x%8.8x "
                                "is not sector-aligned",
                                (unsigned) (c->base + addr),
-                               (unsigned) (last_addr - 1));
+                               (unsigned) (c->base + last_addr - 1));
                return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
        }
 
@@ -425,7 +455,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,
@@ -435,6 +465,25 @@ static int flash_unlock_address_range(struct target *target, uint32_t addr, uint
                        addr, length, &flash_driver_unprotect);
 }
 
+static int compare_section (const void * a, const void * b)
+{
+       struct imageection *b1, *b2;
+       b1=*((struct imageection **)a);
+       b2=*((struct imageection **)b);
+
+       if (b1->base_address == b2->base_address)
+       {
+               return 0;
+       } else if (b1->base_address > b2->base_address)
+       {
+               return 1;
+       } else
+       {
+               return -1;
+       }
+}
+
+
 int flash_write_unlock(struct target *target, struct image *image,
                uint32_t *written, int erase, bool unlock)
 {
@@ -445,12 +494,6 @@ int flash_write_unlock(struct target *target, struct image *image,
        struct flash_bank *c;
        int *padding;
 
-       /* REVISIT do_pad should perhaps just be another parameter.
-        * GDB wouldn't ever need it, since it erases separately.
-        * But "flash write_image" commands might want that option.
-        */
-       bool do_pad = false;
-
        section = 0;
        section_offset = 0;
 
@@ -468,6 +511,19 @@ int flash_write_unlock(struct target *target, struct image *image,
        /* allocate padding array */
        padding = calloc(image->num_sections, sizeof(*padding));
 
+       /* 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 *) *
+                       image->num_sections);
+       int i;
+       for (i = 0; i < image->num_sections; i++)
+       {
+               sections[i] = &image->sections[i];
+       }
+
+       qsort(sections, image->num_sections, sizeof(struct imageection *),
+                       compare_section);
+
        /* loop until we reach end of the image */
        while (section < image->num_sections)
        {
@@ -475,11 +531,11 @@ int flash_write_unlock(struct target *target, struct image *image,
                uint8_t *buffer;
                int section_first;
                int section_last;
-               uint32_t run_address = image->sections[section].base_address + section_offset;
-               uint32_t run_size = image->sections[section].size - section_offset;
+               uint32_t run_address = sections[section]->base_address + section_offset;
+               uint32_t run_size = sections[section]->size - section_offset;
                int pad_bytes = 0;
 
-               if (image->sections[section].size ==  0)
+               if (sections[section]->size ==  0)
                {
                        LOG_WARNING("empty section %d", section);
                        section++;
@@ -502,15 +558,12 @@ int flash_write_unlock(struct target *target, struct image *image,
                while ((run_address + run_size - 1 < c->base + c->size - 1)
                                && (section_last + 1 < image->num_sections))
                {
-                       if (image->sections[section_last + 1].base_address < (run_address + run_size))
+                       /* sections are sorted */
+                       assert(sections[section_last + 1]->base_address >= c->base);
+                       if (sections[section_last + 1]->base_address >= (c->base + c->size))
                        {
-                               LOG_DEBUG("section %d out of order "
-                                               "(surprising, but supported)",
-                                               section_last + 1);
-                               /* REVISIT this can break with autoerase ...
-                                * clobbering data after it's written.
-                                */
-                               break;
+                         /* Done with this bank */
+                         break;
                        }
 
                        /* FIXME This needlessly touches sectors BETWEEN the
@@ -530,26 +583,16 @@ int flash_write_unlock(struct target *target, struct image *image,
                        /* if we have multiple sections within our image,
                         * flash programming could fail due to alignment issues
                         * attempt to rebuild a consecutive buffer for the flash loader */
-                       pad_bytes = (image->sections[section_last + 1].base_address) - (run_address + run_size);
-                       if ((run_address + run_size + pad_bytes) > (c->base + c->size))
-                               break;
+                       pad_bytes = (sections[section_last + 1]->base_address) - (run_address + run_size);
                        padding[section_last] = pad_bytes;
-                       run_size += image->sections[++section_last].size;
+                       run_size += sections[++section_last]->size;
                        run_size += pad_bytes;
 
-                       LOG_INFO("Padding image section %d with %d bytes", section_last-1, pad_bytes);
+                       if (pad_bytes > 0)
+                               LOG_INFO("Padding image section %d with %d bytes", section_last-1, pad_bytes);
                }
 
-               /* fit the run into bank constraints */
-               if (run_address + run_size - 1 > c->base + c->size - 1)
-               {
-                       /* REVISIT isn't this superfluous, given the while()
-                        * loop conditions above??
-                        */
-                       LOG_WARNING("writing %d bytes only - as image section is %d bytes and bank is only %d bytes", \
-                                   (int)(c->base + c->size - run_address), (int)(run_size), (int)(c->size));
-                       run_size = c->base + c->size - run_address;
-               }
+               assert (run_address + run_size - 1 <= c->base + c->size - 1);
 
                /* If we're applying any sector automagic, then pad this
                 * (maybe-combined) segment to the end of its last sector.
@@ -582,15 +625,25 @@ int flash_write_unlock(struct target *target, struct image *image,
                        size_t size_read;
 
                        size_read = run_size - buffer_size;
-                       if (size_read > image->sections[section].size - section_offset)
-                           size_read = image->sections[section].size - section_offset;
+                       if (size_read > sections[section]->size - section_offset)
+                           size_read = sections[section]->size - section_offset;
 
-                       if ((retval = image_read_section(image, section, section_offset,
+                       /* KLUDGE!
+                        *
+                        * #¤%#"%¤% we have to figure out the section # from the sorted
+                        * 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);
+
+                       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,
                                        size_read, buffer + buffer_size, &size_read)) != ERROR_OK || size_read == 0)
                        {
                                free(buffer);
-                               free(padding);
-                               return retval;
+                               goto done;
                        }
 
                        /* see if we need to pad the section */
@@ -600,7 +653,7 @@ int flash_write_unlock(struct target *target, struct image *image,
                        buffer_size += size_read;
                        section_offset += size_read;
 
-                       if (section_offset >= image->sections[section].size)
+                       if (section_offset >= sections[section]->size)
                        {
                                section++;
                                section_offset = 0;
@@ -619,7 +672,7 @@ int flash_write_unlock(struct target *target, struct image *image,
                        {
                                /* calculate and erase sectors */
                                retval = flash_erase_address_range(target,
-                                               do_pad, run_address, run_size);
+                                               true, run_address, run_size);
                        }
                }
 
@@ -633,14 +686,17 @@ int flash_write_unlock(struct target *target, struct image *image,
 
                if (retval != ERROR_OK)
                {
-                       free(padding);
-                       return retval; /* abort operation */
+                       /* abort operation */
+                       goto done;
                }
 
                if (written != NULL)
                        *written += run_size; /* add run size to total written counter */
        }
 
+
+done:
+       free(sections);
        free(padding);
 
        return retval;

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)