armv7m: use generic arm::core_mode
[openocd.git] / src / flash / nor / stm32lx.c
index 3863144029959d4c9461189a34dd90ec9871c71c..8b09387ed051c6ff989bea0fe37cca33e1c57f69 100644 (file)
@@ -32,6 +32,7 @@
 #include <helper/binarybuffer.h>
 #include <target/algorithm.h>
 #include <target/armv7m.h>
+#include <target/cortex_m.h>
 
 /* stm32lx flash register locations */
 
@@ -119,7 +120,6 @@ static int stm32lx_erase_sector(struct flash_bank *bank, int sector);
 static int stm32lx_wait_until_bsy_clear(struct flash_bank *bank);
 
 struct stm32lx_flash_bank {
-       struct working_area *write_algorithm;
        int probed;
 };
 
@@ -142,7 +142,6 @@ FLASH_BANK_COMMAND_HANDLER(stm32lx_flash_bank_command)
 
        bank->driver_priv = stm32lx_info;
 
-       stm32lx_info->write_algorithm = NULL;
        stm32lx_info->probed = 0;
 
        return ERROR_OK;
@@ -213,45 +212,35 @@ static int stm32lx_protect(struct flash_bank *bank, int set, int first,
 static int stm32lx_write_half_pages(struct flash_bank *bank, uint8_t *buffer,
                uint32_t offset, uint32_t count)
 {
-       struct stm32lx_flash_bank *stm32lx_info = bank->driver_priv;
        struct target *target = bank->target;
-       uint32_t buffer_size = 4096 * 4;
+       uint32_t buffer_size = 16384;
+       struct working_area *write_algorithm;
        struct working_area *source;
        uint32_t address = bank->base + offset;
 
-       struct reg_param reg_params[5];
+       struct reg_param reg_params[3];
        struct armv7m_algorithm armv7m_info;
 
        int retval = ERROR_OK;
-       uint32_t reg32;
-
-       /* see contib/loaders/flash/stm32lx.s for src */
 
-       static const uint16_t stm32lx_flash_write_code_16[] = {
-       /*      00000000 <write_word-0x4>: */
-                       0x2300, /* 0:   2300            movs    r3, #0 */
-                       0xe004, /* 2:   e004            b.n     e <test_done> */
+       /* see contib/loaders/flash/stm32lx.S for src */
 
-                       /*      00000004 <write_word>: */
-                       0xf851, 0xcb04, /* 4:   f851 cb04       ldr.w   ip, [r1], #4 */
-                       0xf840, 0xcb04, /* 8:   f840 cb04       str.w   ip, [r0], #4 */
-                       0x3301, /* c:   3301            adds    r3, #1 */
+       static const uint8_t stm32lx_flash_write_code[] = {
+               /* write_word: */
+               0x00, 0x23,             /* movs r3, #0 */
+               0x04, 0xe0,             /* b test_done */
 
-                       /*      0000000e <test_done>: */
-                       0x4293, /* e:   4293            cmp     r3, r2 */
-                       0xd3f8, /* 10:  d3f8            bcc.n   4 <write_word> */
-                       0xbe00, /* 12:  be00            bkpt    0x0000 */
+               /* write_word: */
+               0x51, 0xf8, 0x04, 0xcb, /* ldr ip, [r1], #4 */
+               0x40, 0xf8, 0x04, 0xcb, /* str ip, [r0], #4 */
+               0x01, 0x33,             /* adds r3, #1 */
 
-                       };
+               /* test_done: */
+               0x93, 0x42,             /* cmp r3, r2 */
+               0xf8, 0xd3,             /* bcc write_word */
+               0x00, 0xbe,             /* bkpt 0 */
+       };
 
-       /* Flip endian */
-       uint8_t stm32lx_flash_write_code[sizeof(stm32lx_flash_write_code_16)];
-       for (unsigned int i = 0; i < sizeof(stm32lx_flash_write_code_16) / 2; i++) {
-               stm32lx_flash_write_code[i * 2 + 0] = stm32lx_flash_write_code_16[i]
-                               & 0xff;
-               stm32lx_flash_write_code[i * 2 + 1] = (stm32lx_flash_write_code_16[i]
-                               >> 8) & 0xff;
-       }
        /* Check if there is an even number of half pages (128bytes) */
        if (count % 128) {
                LOG_ERROR("there should be an even number "
@@ -259,74 +248,77 @@ static int stm32lx_write_half_pages(struct flash_bank *bank, uint8_t *buffer,
                return ERROR_FAIL;
        }
 
-       /* Allocate working area */
-       reg32 = sizeof(stm32lx_flash_write_code);
-       /* Add bytes to make 4byte aligned */
-       reg32 += (4 - (reg32 % 4)) % 4;
-       retval = target_alloc_working_area(target, reg32,
-                       &stm32lx_info->write_algorithm);
-       if (retval != ERROR_OK)
-               return retval;
+       /* flash write code */
+       if (target_alloc_working_area(target, sizeof(stm32lx_flash_write_code),
+                       &write_algorithm) != ERROR_OK) {
+               LOG_DEBUG("no working area for block memory writes");
+               return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
+       };
 
        /* Write the flashing code */
        retval = target_write_buffer(target,
-                       stm32lx_info->write_algorithm->address,
+                       write_algorithm->address,
                        sizeof(stm32lx_flash_write_code),
                        (uint8_t *)stm32lx_flash_write_code);
        if (retval != ERROR_OK) {
-               target_free_working_area(target, stm32lx_info->write_algorithm);
+               target_free_working_area(target, write_algorithm);
                return retval;
        }
 
        /* Allocate half pages memory */
-       while (target_alloc_working_area_try(target, buffer_size, &source)
-                       != ERROR_OK) {
+       while (target_alloc_working_area_try(target, buffer_size, &source) != ERROR_OK) {
                if (buffer_size > 1024)
                        buffer_size -= 1024;
                else
                        buffer_size /= 2;
 
                if (buffer_size <= 256) {
-                       /* if we already allocated the writing code, but failed to get a
+                       /* we already allocated the writing code, but failed to get a
                         * buffer, free the algorithm */
-                       if (stm32lx_info->write_algorithm)
-                               target_free_working_area(target, stm32lx_info->write_algorithm);
+                       target_free_working_area(target, write_algorithm);
 
                        LOG_WARNING("no large enough working area available, can't do block memory writes");
                        return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
                }
        }
-       LOG_DEBUG("allocated working area for data (%" PRIx32 " bytes)", buffer_size);
 
        armv7m_info.common_magic = ARMV7M_COMMON_MAGIC;
-       armv7m_info.core_mode = ARMV7M_MODE_ANY;
+       armv7m_info.core_mode = ARM_MODE_ANY;
        init_reg_param(&reg_params[0], "r0", 32, PARAM_OUT);
        init_reg_param(&reg_params[1], "r1", 32, PARAM_OUT);
        init_reg_param(&reg_params[2], "r2", 32, PARAM_OUT);
-       init_reg_param(&reg_params[3], "r3", 32, PARAM_IN_OUT);
-       init_reg_param(&reg_params[4], "r4", 32, PARAM_OUT);
 
        /* Enable half-page write */
        retval = stm32lx_enable_write_half_page(bank);
        if (retval != ERROR_OK) {
                target_free_working_area(target, source);
-               target_free_working_area(target, stm32lx_info->write_algorithm);
+               target_free_working_area(target, write_algorithm);
 
                destroy_reg_param(&reg_params[0]);
                destroy_reg_param(&reg_params[1]);
                destroy_reg_param(&reg_params[2]);
-               destroy_reg_param(&reg_params[3]);
                return retval;
        }
 
+       struct armv7m_common *armv7m = target_to_armv7m(target);
+       if (armv7m == NULL) {
+
+               /* something is very wrong if armv7m is NULL */
+               LOG_ERROR("unable to get armv7m target");
+               return retval;
+       }
+
+       /* save any DEMCR flags and configure target to catch any Hard Faults */
+       uint32_t demcr_save = armv7m->demcr;
+       armv7m->demcr = VC_HARDERR;
+
        /* Loop while there are bytes to write */
        while (count > 0) {
                uint32_t this_count;
                this_count = (count > buffer_size) ? buffer_size : count;
 
                /* Write the next half pages */
-               retval = target_write_buffer(target, source->address, this_count,
-                               buffer);
+               retval = target_write_buffer(target, source->address, this_count, buffer);
                if (retval != ERROR_OK)
                        break;
 
@@ -341,10 +333,14 @@ static int stm32lx_write_half_pages(struct flash_bank *bank, uint8_t *buffer,
                /* 5: Execute the bunch of code */
                retval = target_run_algorithm(target, 0, NULL, sizeof(reg_params)
                                / sizeof(*reg_params), reg_params,
-                               stm32lx_info->write_algorithm->address, 0, 20000, &armv7m_info);
+                               write_algorithm->address, 0, 10000, &armv7m_info);
                if (retval != ERROR_OK)
                        break;
 
+               /* check for Hard Fault */
+               if (armv7m->exception_number == 3)
+                       break;
+
                /* 6: Wait while busy */
                retval = stm32lx_wait_until_bsy_clear(bank);
                if (retval != ERROR_OK)
@@ -355,106 +351,163 @@ static int stm32lx_write_half_pages(struct flash_bank *bank, uint8_t *buffer,
                count -= this_count;
        }
 
+       /* restore previous flags */
+       armv7m->demcr = demcr_save;
+
+       if (armv7m->exception_number == 3) {
+
+               /* the stm32l15x devices seem to have an issue when blank.
+                * if a ram loader is executed on a blank device it will
+                * Hard Fault, this issue does not happen for a already programmed device.
+                * A related issue is described in the stm32l151xx errata (Doc ID 17721 Rev 6 - 2.1.3).
+                * The workaround of handling the Hard Fault exception does work, but makes the
+                * loader more complicated, as a compromise we manually write the pages, programming time
+                * is reduced by 50% using this slower method.
+                */
+
+               LOG_WARNING("couldn't use loader, falling back to page memory writes");
+
+               while (count > 0) {
+                       uint32_t this_count;
+                       this_count = (count > 128) ? 128 : count;
+
+                       /* Write the next half pages */
+                       retval = target_write_buffer(target, address, this_count, buffer);
+                       if (retval != ERROR_OK)
+                               break;
+
+                       /* Wait while busy */
+                       retval = stm32lx_wait_until_bsy_clear(bank);
+                       if (retval != ERROR_OK)
+                               break;
+
+                       buffer += this_count;
+                       address += this_count;
+                       count -= this_count;
+               }
+       }
+
        if (retval == ERROR_OK)
                retval = stm32lx_lock_program_memory(bank);
 
        target_free_working_area(target, source);
-       target_free_working_area(target, stm32lx_info->write_algorithm);
+       target_free_working_area(target, write_algorithm);
 
        destroy_reg_param(&reg_params[0]);
        destroy_reg_param(&reg_params[1]);
        destroy_reg_param(&reg_params[2]);
-       destroy_reg_param(&reg_params[3]);
 
        return retval;
 }
+
 static int stm32lx_write(struct flash_bank *bank, uint8_t *buffer,
                uint32_t offset, uint32_t count)
 {
        struct target *target = bank->target;
 
        uint32_t halfpages_number;
-       uint32_t words_remaining;
-       uint32_t bytes_remaining;
+       uint32_t bytes_remaining = 0;
        uint32_t address = bank->base + offset;
        uint32_t bytes_written = 0;
-       int retval;
+       int retval, retval2;
 
        if (bank->target->state != TARGET_HALTED) {
                LOG_ERROR("Target not halted");
                return ERROR_TARGET_NOT_HALTED;
        }
 
-       if (offset & 0x1) {
-               LOG_ERROR("offset 0x%" PRIx32 " breaks required 2-byte alignment", offset);
+       if (offset & 0x3) {
+               LOG_ERROR("offset 0x%" PRIx32 " breaks required 4-byte alignment", offset);
                return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
        }
 
-       /* Check if there are some full half pages */
-       if (((offset % 128) == 0) && (count >= 128)) {
-               halfpages_number = count / 128;
-               words_remaining = (count - 128 * halfpages_number) / 4;
-               bytes_remaining = (count & 0x3);
-       } else {
-               halfpages_number = 0;
-               words_remaining = (count / 4);
-               bytes_remaining = (count & 0x3);
-       }
-
-       if (halfpages_number) {
-               retval = stm32lx_write_half_pages(bank, buffer, offset, 128
-                               * halfpages_number);
-               if (retval != ERROR_OK)
-                       return ERROR_FAIL;
-       }
-
-       bytes_written = 128 * halfpages_number;
-       address += bytes_written;
-
        retval = stm32lx_unlock_program_memory(bank);
        if (retval != ERROR_OK)
                return retval;
 
-       while (words_remaining > 0) {
-               uint32_t value;
-               uint8_t *p = buffer + bytes_written;
+       /* first we need to write any unaligned head bytes upto
+        * the next 128 byte page */
+
+       if (offset % 128)
+               bytes_remaining = MIN(count, 128 - (offset % 128));
 
-               /* Prepare the word, Little endian conversion */
-               value = p[0] + (p[1] << 8) + (p[2] << 16) + (p[3] << 24);
+       while (bytes_remaining > 0) {
+               uint8_t value[4] = {0xff, 0xff, 0xff, 0xff};
 
-               retval = target_write_u32(target, address, value);
+               /* copy remaining bytes into the write buffer */
+               uint32_t bytes_to_write = MIN(4, bytes_remaining);
+               memcpy(value, buffer + bytes_written, bytes_to_write);
+
+               retval = target_write_buffer(target, address, 4, value);
                if (retval != ERROR_OK)
-                       return retval;
+                       goto reset_pg_and_lock;
 
-               bytes_written += 4;
-               words_remaining--;
+               bytes_written += bytes_to_write;
+               bytes_remaining -= bytes_to_write;
                address += 4;
 
                retval = stm32lx_wait_until_bsy_clear(bank);
                if (retval != ERROR_OK)
-                       return retval;
+                       goto reset_pg_and_lock;
        }
 
-       if (bytes_remaining) {
-               uint8_t last_word[4] = {0xff, 0xff, 0xff, 0xff};
+       offset += bytes_written;
+       count -= bytes_written;
 
-               /* copy the last remaining bytes into the write buffer */
-               memcpy(last_word, buffer+bytes_written, bytes_remaining);
+       /* this should always pass this check here */
+       assert((offset % 128) == 0);
 
-               retval = target_write_buffer(target, address, 4, last_word);
+       /* calculate half pages */
+       halfpages_number = count / 128;
+
+       if (halfpages_number) {
+               retval = stm32lx_write_half_pages(bank, buffer + bytes_written, offset, 128 * halfpages_number);
+               if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE) {
+                       /* attempt slow memory writes */
+                       LOG_WARNING("couldn't use block writes, falling back to single memory accesses");
+                       halfpages_number = 0;
+               } else {
+                       if (retval != ERROR_OK)
+                               return ERROR_FAIL;
+               }
+       }
+
+       /* write any remaining bytes */
+       uint32_t page_bytes_written = 128 * halfpages_number;
+       bytes_written += page_bytes_written;
+       address += page_bytes_written;
+       bytes_remaining = count - page_bytes_written;
+
+       retval = stm32lx_unlock_program_memory(bank);
+       if (retval != ERROR_OK)
+               return retval;
+
+       while (bytes_remaining > 0) {
+               uint8_t value[4] = {0xff, 0xff, 0xff, 0xff};
+
+               /* copy remaining bytes into the write buffer */
+               uint32_t bytes_to_write = MIN(4, bytes_remaining);
+               memcpy(value, buffer + bytes_written, bytes_to_write);
+
+               retval = target_write_buffer(target, address, 4, value);
                if (retval != ERROR_OK)
-                       return retval;
+                       goto reset_pg_and_lock;
+
+               bytes_written += bytes_to_write;
+               bytes_remaining -= bytes_to_write;
+               address += 4;
 
                retval = stm32lx_wait_until_bsy_clear(bank);
                if (retval != ERROR_OK)
-                       return retval;
+                       goto reset_pg_and_lock;
        }
 
-       retval = stm32lx_lock_program_memory(bank);
-       if (retval != ERROR_OK)
-               return retval;
+reset_pg_and_lock:
+       retval2 = stm32lx_lock_program_memory(bank);
+       if (retval == ERROR_OK)
+               retval = retval2;
 
-       return ERROR_OK;
+       return retval;
 }
 
 static int stm32lx_probe(struct flash_bank *bank)
@@ -463,6 +516,7 @@ static int stm32lx_probe(struct flash_bank *bank)
        struct stm32lx_flash_bank *stm32lx_info = bank->driver_priv;
        int i;
        uint16_t flash_size_in_kb;
+       uint16_t max_flash_size_in_kb;
        uint32_t device_id;
 
        stm32lx_info->probed = 0;
@@ -474,31 +528,28 @@ static int stm32lx_probe(struct flash_bank *bank)
 
        LOG_DEBUG("device id = 0x%08" PRIx32 "", device_id);
 
+       /* set max flash size depending on family */
+       switch (device_id & 0xfff) {
+       case 0x416:
+               max_flash_size_in_kb = 128;
+               break;
+       case 0x436:
+               max_flash_size_in_kb = 384;
+               break;
+       default:
+               LOG_WARNING("Cannot identify target as a STM32L family.");
+               return ERROR_FAIL;
+       }
+
        /* get flash size from target. */
        retval = target_read_u16(target, F_SIZE, &flash_size_in_kb);
-       if (retval != ERROR_OK) {
-               LOG_WARNING("failed reading flash size, default to max target family");
-               /* failed reading flash size, default to max target family */
-               flash_size_in_kb = 0xffff;
-       }
 
-       if ((device_id & 0xfff) == 0x416) {
-               /* check for early silicon */
-               if (flash_size_in_kb == 0xffff) {
-                       /* number of sectors may be incorrrect on early silicon */
-                       LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming 128k flash");
-                       flash_size_in_kb = 128;
-               }
-       } else if ((device_id & 0xfff) == 0x436) {
-               /* check for early silicon */
-               if (flash_size_in_kb == 0xffff) {
-                       /* number of sectors may be incorrrect on early silicon */
-                       LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming 384k flash");
-                       flash_size_in_kb = 384;
-               }
-       } else {
-               LOG_WARNING("Cannot identify target as a STM32L family.");
-               return ERROR_FAIL;
+       /* failed reading flash size or flash size invalid (early silicon),
+        * default to max target family */
+       if (retval != ERROR_OK || flash_size_in_kb == 0xffff || flash_size_in_kb == 0) {
+               LOG_WARNING("STM32 flash size failed, probe inaccurate - assuming %dk flash",
+                       max_flash_size_in_kb);
+               flash_size_in_kb = max_flash_size_in_kb;
        }
 
        /* STM32L - we have 32 sectors, 16 pages per sector -> 512 pages
@@ -651,6 +702,10 @@ static int stm32lx_get_info(struct flash_bank *bank, char *buf, int buf_size)
                                snprintf(buf, buf_size, "Z");
                                break;
 
+                       case 0x1018:
+                               snprintf(buf, buf_size, "Y");
+                               break;
+
                        default:
                                snprintf(buf, buf_size, "unknown");
                                break;
@@ -705,6 +760,14 @@ static int stm32lx_unlock_program_memory(struct flash_bank *bank)
         * then by writing the 2 PRGKEY to the PRGKEYR register
         */
 
+       /* check flash is not already unlocked */
+       retval = target_read_u32(target, FLASH_PECR, &reg32);
+       if (retval != ERROR_OK)
+               return retval;
+
+       if ((reg32 & FLASH_PECR__PRGLOCK) == 0)
+               return ERROR_OK;
+
        /* To unlock the PECR write the 2 PEKEY to the PEKEYR register */
        retval = target_write_u32(target, FLASH_PEKEYR, PEKEY1);
        if (retval != ERROR_OK)
@@ -740,6 +803,7 @@ static int stm32lx_unlock_program_memory(struct flash_bank *bank)
                LOG_ERROR("PRGLOCK is not cleared :(");
                return ERROR_FLASH_OPERATION_FAILED;
        }
+
        return ERROR_OK;
 }
 

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)