flash/nor/nrf5: remove useless page padding and UICR autoerase
[openocd.git] / src / flash / nor / nrf5.c
index 4fa62e30ad421aa816b7a480ba70c811e0d1ddf4..4addb61d42a87f93a0decccec33ed242701faf1d 100644 (file)
@@ -26,6 +26,7 @@
 #include <target/algorithm.h>
 #include <target/armv7m.h>
 #include <helper/types.h>
+#include <helper/time_support.h>
 
 enum {
        NRF5_FLASH_BASE = 0x00000000,
@@ -88,7 +89,7 @@ enum nrf5_uicr_registers {
 
 enum nrf5_nvmc_registers {
        NRF5_NVMC_BASE = 0x4001E000, /* Non-Volatile Memory
-                                      * Controller Regsters */
+                                      * Controller Registers */
 
 #define NRF5_NVMC_REG(offset) (NRF5_NVMC_BASE + offset)
 
@@ -108,12 +109,11 @@ enum nrf5_nvmc_config_bits {
 
 struct nrf5_info {
        uint32_t code_page_size;
+       uint32_t refcount;
 
-       struct {
+       struct nrf5_bank {
+               struct nrf5_info *chip;
                bool probed;
-               int (*write) (struct flash_bank *bank,
-                             struct nrf5_info *chip,
-                             const uint8_t *buffer, uint32_t offset, uint32_t count);
        } bank[2];
        struct target *target;
 };
@@ -135,11 +135,16 @@ struct nrf5_device_spec {
 .flash_size_kb = (fsize),                           \
 }
 
-/* The known devices table below is derived from the "nRF51 Series
- * Compatibility Matrix" document, which can be found by searching for
- * ATTN-51 on the Nordic Semi website:
+/* The known devices table below is derived from the "nRF5x series
+ * compatibility matrix" documents, which can be found in the "DocLib" of
+ * nordic:
  *
- * http://www.nordicsemi.com/eng/content/search?SearchText=ATTN-51
+ * https://www.nordicsemi.com/DocLib/Content/Comp_Matrix/nRF51/latest/COMP/nrf51/nRF51422_ic_revision_overview
+ * https://www.nordicsemi.com/DocLib/Content/Comp_Matrix/nRF51/latest/COMP/nrf51/nRF51822_ic_revision_overview
+ * https://www.nordicsemi.com/DocLib/Content/Comp_Matrix/nRF51/latest/COMP/nrf51/nRF51824_ic_revision_overview
+ * https://www.nordicsemi.com/DocLib/Content/Comp_Matrix/nRF52810/latest/COMP/nrf52810/nRF52810_ic_revision_overview
+ * https://www.nordicsemi.com/DocLib/Content/Comp_Matrix/nRF52832/latest/COMP/nrf52832/ic_revision_overview
+ * https://www.nordicsemi.com/DocLib/Content/Comp_Matrix/nRF52840/latest/COMP/nrf52840/nRF52840_ic_revision_overview
  *
  * Up to date with Matrix v2.0, plus some additional HWIDs.
  *
@@ -155,6 +160,11 @@ static const struct nrf5_device_spec nrf5_known_devices_table[] = {
        NRF5_DEVICE_DEF(0x0020, "51822", "CEAA", "BA",    256),
        NRF5_DEVICE_DEF(0x002F, "51822", "CEAA", "B0",    256),
 
+       /* Some early nRF51-DK (PCA10028) & nRF51-Dongle (PCA10031) boards
+          with built-in jlink seem to use engineering samples not listed
+          in the nRF51 Series Compatibility Matrix V1.0. */
+       NRF5_DEVICE_DEF(0x0071, "51822", "QFAC", "AB",    256),
+
        /* nRF51822 Devices (IC rev 2). */
        NRF5_DEVICE_DEF(0x002A, "51822", "QFAA", "FA0",   256),
        NRF5_DEVICE_DEF(0x0044, "51822", "QFAA", "GC0",   256),
@@ -175,6 +185,7 @@ static const struct nrf5_device_spec nrf5_known_devices_table[] = {
        NRF5_DEVICE_DEF(0x007D, "51822", "CDAB", "A0",    128),
        NRF5_DEVICE_DEF(0x0079, "51822", "CEAA", "E0",    256),
        NRF5_DEVICE_DEF(0x0087, "51822", "CFAC", "A0",    256),
+       NRF5_DEVICE_DEF(0x008F, "51822", "QFAA", "H1",    256),
 
        /* nRF51422 Devices (IC rev 1). */
        NRF5_DEVICE_DEF(0x001E, "51422", "QFAA", "CA",    256),
@@ -196,22 +207,26 @@ static const struct nrf5_device_spec nrf5_known_devices_table[] = {
        NRF5_DEVICE_DEF(0x007A, "51422", "CEAA", "C0",    256),
        NRF5_DEVICE_DEF(0x0088, "51422", "CFAC", "A0",    256),
 
+       /* nRF52810 Devices */
+       NRF5_DEVICE_DEF(0x0142, "52810", "QFAA", "B0",    192),
+       NRF5_DEVICE_DEF(0x0143, "52810", "QCAA", "C0",    192),
+
        /* nRF52832 Devices */
        NRF5_DEVICE_DEF(0x00C7, "52832", "QFAA", "B0",    512),
+       NRF5_DEVICE_DEF(0x0139, "52832", "QFAA", "E0",    512),
+       NRF5_DEVICE_DEF(0x00E3, "52832", "CIAA", "B0",    512),
 
-       /* Some early nRF51-DK (PCA10028) & nRF51-Dongle (PCA10031) boards
-          with built-in jlink seem to use engineering samples not listed
-          in the nRF51 Series Compatibility Matrix V1.0. */
-       NRF5_DEVICE_DEF(0x0071, "51822", "QFAC", "AB",    256),
+       /* nRF52840 Devices */
+       NRF5_DEVICE_DEF(0x0150, "52840", "QIAA", "C0",    1024),
 };
 
 static int nrf5_bank_is_probed(struct flash_bank *bank)
 {
-       struct nrf5_info *chip = bank->driver_priv;
+       struct nrf5_bank *nbank = bank->driver_priv;
 
-       assert(chip != NULL);
+       assert(nbank != NULL);
 
-       return chip->bank[bank->bank_number].probed;
+       return nbank->probed;
 }
 static int nrf5_probe(struct flash_bank *bank);
 
@@ -222,7 +237,8 @@ static int nrf5_get_probed_chip_if_halted(struct flash_bank *bank, struct nrf5_i
                return ERROR_TARGET_NOT_HALTED;
        }
 
-       *chip = bank->driver_priv;
+       struct nrf5_bank *nbank = bank->driver_priv;
+       *chip = nbank->chip;
 
        int probed = nrf5_bank_is_probed(bank);
        if (probed < 0)
@@ -237,7 +253,8 @@ static int nrf5_wait_for_nvmc(struct nrf5_info *chip)
 {
        uint32_t ready;
        int res;
-       int timeout = 100;
+       int timeout_ms = 340;
+       int64_t ts_start = timeval_ms();
 
        do {
                res = target_read_u32(chip->target, NRF5_NVMC_READY, &ready);
@@ -249,8 +266,9 @@ static int nrf5_wait_for_nvmc(struct nrf5_info *chip)
                if (ready == 0x00000001)
                        return ERROR_OK;
 
-               alive_sleep(1);
-       } while (timeout--);
+               keep_alive();
+
+       } while ((timeval_ms()-ts_start) < timeout_ms);
 
        LOG_DEBUG("Timed out waiting for NVMC_READY");
        return ERROR_FLASH_BUSY;
@@ -362,7 +380,8 @@ static int nrf5_protect_check(struct flash_bank *bank)
        if (bank->base == NRF5_UICR_BASE)
                return ERROR_OK;
 
-       struct nrf5_info *chip = bank->driver_priv;
+       struct nrf5_bank *nbank = bank->driver_priv;
+       struct nrf5_info *chip = nbank->chip;
 
        assert(chip != NULL);
 
@@ -448,7 +467,8 @@ static int nrf5_probe(struct flash_bank *bank)
 {
        uint32_t hwid;
        int res;
-       struct nrf5_info *chip = bank->driver_priv;
+       struct nrf5_bank *nbank = bank->driver_priv;
+       struct nrf5_info *chip = nbank->chip;
 
        res = target_read_u32(chip->target, NRF5_FICR_CONFIGID, &hwid);
        if (res != ERROR_OK) {
@@ -530,7 +550,6 @@ static int nrf5_probe(struct flash_bank *bank)
                bank->sectors[0].size = bank->size;
                bank->sectors[0].offset = 0;
 
-               /* mark as unknown */
                bank->sectors[0].is_erased = 0;
                bank->sectors[0].is_protected = 0;
 
@@ -552,17 +571,6 @@ static int nrf5_auto_probe(struct flash_bank *bank)
                return nrf5_probe(bank);
 }
 
-static struct flash_sector *nrf5_find_sector_by_address(struct flash_bank *bank, uint32_t address)
-{
-       struct nrf5_info *chip = bank->driver_priv;
-
-       for (int i = 0; i < bank->num_sectors; i++)
-               if (bank->sectors[i].offset <= address &&
-                   address < (bank->sectors[i].offset + chip->code_page_size))
-                       return &bank->sectors[i];
-       return NULL;
-}
-
 static int nrf5_erase_all(struct nrf5_info *chip)
 {
        LOG_DEBUG("Erasing all non-volatile memory");
@@ -614,9 +622,6 @@ static int nrf5_erase_page(struct flash_bank *bank,
                                               sector->offset);
        }
 
-       if (res == ERROR_OK)
-               sector->is_erased = 1;
-
        return res;
 }
 
@@ -645,19 +650,17 @@ static const uint8_t nrf5_flash_write_code[] = {
 
 
 /* Start a low level flash write for the specified region */
-static int nrf5_ll_flash_write(struct nrf5_info *chip, uint32_t offset, const uint8_t *buffer, uint32_t bytes)
+static int nrf5_ll_flash_write(struct nrf5_info *chip, uint32_t address, const uint8_t *buffer, uint32_t bytes)
 {
        struct target *target = chip->target;
        uint32_t buffer_size = 8192;
        struct working_area *write_algorithm;
        struct working_area *source;
-       uint32_t address = NRF5_FLASH_BASE + offset;
        struct reg_param reg_params[4];
        struct armv7m_algorithm armv7m_info;
        int retval = ERROR_OK;
 
-
-       LOG_DEBUG("Writing buffer to flash offset=0x%"PRIx32" bytes=0x%"PRIx32, offset, bytes);
+       LOG_DEBUG("Writing buffer to flash address=0x%"PRIx32" bytes=0x%"PRIx32, address, bytes);
        assert(bytes % 4 == 0);
 
        /* allocate working area with flash programming code */
@@ -666,7 +669,7 @@ static int nrf5_ll_flash_write(struct nrf5_info *chip, uint32_t offset, const ui
                LOG_WARNING("no working area available, falling back to slow memory writes");
 
                for (; bytes > 0; bytes -= 4) {
-                       retval = target_write_memory(chip->target, offset, 4, 1, buffer);
+                       retval = target_write_memory(target, address, 4, 1, buffer);
                        if (retval != ERROR_OK)
                                return retval;
 
@@ -674,17 +677,13 @@ static int nrf5_ll_flash_write(struct nrf5_info *chip, uint32_t offset, const ui
                        if (retval != ERROR_OK)
                                return retval;
 
-                       offset += 4;
+                       address += 4;
                        buffer += 4;
                }
 
                return ERROR_OK;
        }
 
-       LOG_WARNING("using fast async flash loader. This is currently supported");
-       LOG_WARNING("only with ST-Link and CMSIS-DAP. If you have issues, add");
-       LOG_WARNING("\"set WORKAREASIZE 0\" before sourcing nrf51.cfg/nrf52.cfg to disable it");
-
        retval = target_write_buffer(target, write_algorithm->address,
                                sizeof(nrf5_flash_write_code),
                                nrf5_flash_write_code);
@@ -735,55 +734,30 @@ static int nrf5_ll_flash_write(struct nrf5_info *chip, uint32_t offset, const ui
        return retval;
 }
 
-/* Check and erase flash sectors in specified range then start a low level page write.
-   start/end must be sector aligned.
-*/
-static int nrf5_write_pages(struct flash_bank *bank, uint32_t start, uint32_t end, const uint8_t *buffer)
+static int nrf5_write(struct flash_bank *bank, const uint8_t *buffer,
+                                       uint32_t offset, uint32_t count)
 {
-       int res = ERROR_FAIL;
-       struct nrf5_info *chip = bank->driver_priv;
-       struct flash_sector *sector;
-       uint32_t offset;
-
-       assert(start % chip->code_page_size == 0);
-       assert(end % chip->code_page_size == 0);
-
-       /* Erase all sectors */
-       for (offset = start; offset < end; offset += chip->code_page_size) {
-               sector = nrf5_find_sector_by_address(bank, offset);
-               if (!sector) {
-                       LOG_ERROR("Invalid sector @ 0x%08"PRIx32, offset);
-                       return ERROR_FLASH_SECTOR_INVALID;
-               }
+       struct nrf5_info *chip;
 
-               if (sector->is_protected) {
-                       LOG_ERROR("Can't erase protected sector @ 0x%08"PRIx32, offset);
-                       goto error;
-               }
+       int res = nrf5_get_probed_chip_if_halted(bank, &chip);
+       if (res != ERROR_OK)
+               return res;
 
-               if (sector->is_erased != 1) {   /* 1 = erased, 0= not erased, -1 = unknown */
-                       res = nrf5_erase_page(bank, chip, sector);
-                       if (res != ERROR_OK) {
-                               LOG_ERROR("Failed to erase sector @ 0x%08"PRIx32, sector->offset);
-                               goto error;
-                       }
-               }
-               sector->is_erased = 0;
-       }
+       assert(offset % 4 == 0);
+       assert(count % 4 == 0);
 
        res = nrf5_nvmc_write_enable(chip);
        if (res != ERROR_OK)
                goto error;
 
-       res = nrf5_ll_flash_write(chip, start, buffer, (end - start));
+       res = nrf5_ll_flash_write(chip, bank->base + offset, buffer, count);
        if (res != ERROR_OK)
-               goto set_read_only;
+               goto error;
 
        return nrf5_nvmc_read_only(chip);
 
-set_read_only:
-       nrf5_nvmc_read_only(chip);
 error:
+       nrf5_nvmc_read_only(chip);
        LOG_ERROR("Failed to write to nrf5 flash");
        return res;
 }
@@ -804,126 +778,31 @@ static int nrf5_erase(struct flash_bank *bank, int first, int last)
        return res;
 }
 
-static int nrf5_code_flash_write(struct flash_bank *bank,
-                                 struct nrf5_info *chip,
-                                 const uint8_t *buffer, uint32_t offset, uint32_t count)
+static void nrf5_free_driver_priv(struct flash_bank *bank)
 {
-
-       int res;
-       /* Need to perform reads to fill any gaps we need to preserve in the first page,
-          before the start of buffer, or in the last page, after the end of buffer */
-       uint32_t first_page = offset/chip->code_page_size;
-       uint32_t last_page = DIV_ROUND_UP(offset+count, chip->code_page_size);
-
-       uint32_t first_page_offset = first_page * chip->code_page_size;
-       uint32_t last_page_offset = last_page * chip->code_page_size;
-
-       LOG_DEBUG("Padding write from 0x%08"PRIx32"-0x%08"PRIx32" as 0x%08"PRIx32"-0x%08"PRIx32,
-               offset, offset+count, first_page_offset, last_page_offset);
-
-       uint32_t page_cnt = last_page - first_page;
-       uint8_t buffer_to_flash[page_cnt*chip->code_page_size];
-
-       /* Fill in any space between start of first page and start of buffer */
-       uint32_t pre = offset - first_page_offset;
-       if (pre > 0) {
-               res = target_read_memory(bank->target,
-                                       first_page_offset,
-                                       1,
-                                       pre,
-                                       buffer_to_flash);
-               if (res != ERROR_OK)
-                       return res;
+       struct nrf5_bank *nbank = bank->driver_priv;
+       struct nrf5_info *chip = nbank->chip;
+       if (chip == NULL)
+               return;
+
+       chip->refcount--;
+       if (chip->refcount == 0) {
+               free(chip);
+               bank->driver_priv = NULL;
        }
-
-       /* Fill in main contents of buffer */
-       memcpy(buffer_to_flash+pre, buffer, count);
-
-       /* Fill in any space between end of buffer and end of last page */
-       uint32_t post = last_page_offset - (offset+count);
-       if (post > 0) {
-               /* Retrieve the full row contents from Flash */
-               res = target_read_memory(bank->target,
-                                       offset + count,
-                                       1,
-                                       post,
-                                       buffer_to_flash+pre+count);
-               if (res != ERROR_OK)
-                       return res;
-       }
-
-       return nrf5_write_pages(bank, first_page_offset, last_page_offset, buffer_to_flash);
 }
 
-static int nrf5_uicr_flash_write(struct flash_bank *bank,
-                                 struct nrf5_info *chip,
-                                 const uint8_t *buffer, uint32_t offset, uint32_t count)
-{
-       int res;
-       uint8_t uicr[NRF5_UICR_SIZE];
-       struct flash_sector *sector = &bank->sectors[0];
-
-       if ((offset + count) > NRF5_UICR_SIZE)
-               return ERROR_FAIL;
-
-       res = target_read_memory(bank->target,
-                                NRF5_UICR_BASE,
-                                1,
-                                NRF5_UICR_SIZE,
-                                uicr);
-
-       if (res != ERROR_OK)
-               return res;
-
-       if (sector->is_erased != 1) {
-               res = nrf5_erase_page(bank, chip, sector);
-               if (res != ERROR_OK)
-                       return res;
-       }
-
-       res = nrf5_nvmc_write_enable(chip);
-       if (res != ERROR_OK)
-               return res;
-
-       memcpy(&uicr[offset], buffer, count);
-
-       res = nrf5_ll_flash_write(chip, NRF5_UICR_BASE, uicr, NRF5_UICR_SIZE);
-       if (res != ERROR_OK) {
-               nrf5_nvmc_read_only(chip);
-               return res;
-       }
-
-       return nrf5_nvmc_read_only(chip);
-}
-
-
-static int nrf5_write(struct flash_bank *bank, const uint8_t *buffer,
-                      uint32_t offset, uint32_t count)
-{
-       int res;
-       struct nrf5_info *chip;
-
-       res = nrf5_get_probed_chip_if_halted(bank, &chip);
-       if (res != ERROR_OK)
-               return res;
-
-       return chip->bank[bank->bank_number].write(bank, chip, buffer, offset, count);
-}
-
-
 FLASH_BANK_COMMAND_HANDLER(nrf5_flash_bank_command)
 {
        static struct nrf5_info *chip;
+       struct nrf5_bank *nbank = NULL;
 
        switch (bank->base) {
        case NRF5_FLASH_BASE:
-               bank->bank_number = 0;
-               break;
        case NRF5_UICR_BASE:
-               bank->bank_number = 1;
                break;
        default:
-               LOG_ERROR("Invalid bank address 0x%08" PRIx32, bank->base);
+               LOG_ERROR("Invalid bank address " TARGET_ADDR_FMT, bank->base);
                return ERROR_FAIL;
        }
 
@@ -938,15 +817,19 @@ FLASH_BANK_COMMAND_HANDLER(nrf5_flash_bank_command)
 
        switch (bank->base) {
        case NRF5_FLASH_BASE:
-               chip->bank[bank->bank_number].write = nrf5_code_flash_write;
+               nbank = &chip->bank[0];
                break;
        case NRF5_UICR_BASE:
-               chip->bank[bank->bank_number].write = nrf5_uicr_flash_write;
+               nbank = &chip->bank[1];
                break;
        }
+       assert(nbank != NULL);
 
-       chip->bank[bank->bank_number].probed = false;
-       bank->driver_priv = chip;
+       chip->refcount++;
+       nbank->chip = chip;
+       nbank->probed = false;
+       bank->driver_priv = nbank;
+       bank->write_start_alignment = bank->write_end_alignment = 4;
 
        return ERROR_OK;
 }
@@ -991,9 +874,6 @@ COMMAND_HANDLER(nrf5_handle_mass_erase_command)
                return res;
        }
 
-       for (int i = 0; i < bank->num_sectors; i++)
-               bank->sectors[i].is_erased = 1;
-
        res = nrf5_protect_check(bank);
        if (res != ERROR_OK) {
                LOG_ERROR("Failed to check chip's write protection");
@@ -1004,8 +884,6 @@ COMMAND_HANDLER(nrf5_handle_mass_erase_command)
        if (res != ERROR_OK)
                return res;
 
-       bank->sectors[0].is_erased = 1;
-
        return ERROR_OK;
 }
 
@@ -1139,6 +1017,7 @@ static const struct command_registration nrf5_exec_command_handlers[] = {
                .handler        = nrf5_handle_mass_erase_command,
                .mode           = COMMAND_EXEC,
                .help           = "Erase all flash contents of the chip.",
+               .usage          = "",
        },
        COMMAND_REGISTRATION_DONE
 };
@@ -1161,7 +1040,7 @@ static const struct command_registration nrf5_command_handlers[] = {
        COMMAND_REGISTRATION_DONE
 };
 
-struct flash_driver nrf5_flash = {
+const struct flash_driver nrf5_flash = {
        .name                   = "nrf5",
        .commands               = nrf5_command_handlers,
        .flash_bank_command     = nrf5_flash_bank_command,
@@ -1174,11 +1053,12 @@ struct flash_driver nrf5_flash = {
        .auto_probe             = nrf5_auto_probe,
        .erase_check            = default_flash_blank_check,
        .protect_check          = nrf5_protect_check,
+       .free_driver_priv       = nrf5_free_driver_priv,
 };
 
 /* We need to retain the flash-driver name as well as the commands
  * for backwards compatability */
-struct flash_driver nrf51_flash = {
+const struct flash_driver nrf51_flash = {
        .name                   = "nrf51",
        .commands               = nrf5_command_handlers,
        .flash_bank_command     = nrf5_flash_bank_command,
@@ -1191,4 +1071,5 @@ struct flash_driver nrf51_flash = {
        .auto_probe             = nrf5_auto_probe,
        .erase_check            = default_flash_blank_check,
        .protect_check          = nrf5_protect_check,
+       .free_driver_priv       = nrf5_free_driver_priv,
 };

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)