Pic32mx: make row programming work with any offset
[openocd.git] / src / flash / nor / pic32mx.c
index 242780ff96ea7f94fd6e51932b676cd9561e262d..0b43c1b5595cd5b7ef426b5bc8358046dd09fab8 100644 (file)
@@ -28,6 +28,7 @@
 #include "config.h"
 #endif
 
+#include <jtag/jtag.h>
 #include "imp.h"
 #include <target/algorithm.h>
 #include <target/mips32.h>
@@ -51,6 +52,7 @@
 
 /* pic32mx configuration register locations */
 
+#define PIC32MX_DEVCFG0_1_2    0xBFC00BFC
 #define PIC32MX_DEVCFG0                0xBFC02FFC
 #define PIC32MX_DEVCFG1                0xBFC02FF8
 #define PIC32MX_DEVCFG2                0xBFC02FF4
 #define NVMKEY1                        0xAA996655
 #define NVMKEY2                        0x556699AA
 
+#define MX_1_2                 1       /* PIC32mx1xx/2xx */
+
 struct pic32mx_flash_bank {
        struct working_area *write_algorithm;
        int probed;
+       int dev_type;           /* Default 0. 1 for Pic32MX1XX/2XX variant */
 };
 
 /*
- * DEVID values as per PIC32MX Flash Programming Specification Rev H
+ * DEVID values as per PIC32MX Flash Programming Specification Rev J
  */
 
 static const struct pic32mx_devs_s {
@@ -110,12 +115,24 @@ static const struct pic32mx_devs_s {
        {0x04A06053, "120F032B"},
        {0x04A08053, "120F032C"},
        {0x04A0A053, "120F032D"},
+       {0x04D07053, "130F064B"},
+       {0x04D09053, "130F064C"},
+       {0x04D0B053, "130F064D"},
+       {0x04D06053, "150F128B"},
+       {0x04D08053, "150F128C"},
+       {0x04D0A053, "150F128D"},
        {0x04A01053, "210F016B"},
        {0x04A03053, "210F016C"},
        {0x04A05053, "210F016D"},
        {0x04A00053, "220F032B"},
        {0x04A02053, "220F032C"},
        {0x04A04053, "220F032D"},
+       {0x04D01053, "230F064B"},
+       {0x04D03053, "230F064C"},
+       {0x04D05053, "230F064D"},
+       {0x04D00053, "250F128B"},
+       {0x04D02053, "250F128C"},
+       {0x04D04053, "250F128D"},
        {0x00938053, "360F512L"},
        {0x00934053, "360F256L"},
        {0x0092D053, "340F128L"},
@@ -178,6 +195,7 @@ FLASH_BANK_COMMAND_HANDLER(pic32mx_flash_bank_command)
 
        pic32mx_info->write_algorithm = NULL;
        pic32mx_info->probed = 0;
+       pic32mx_info->dev_type = 0;
 
        return ERROR_OK;
 }
@@ -232,7 +250,9 @@ static int pic32mx_nvm_exec(struct flash_bank *bank, uint32_t op, uint32_t timeo
 static int pic32mx_protect_check(struct flash_bank *bank)
 {
        struct target *target = bank->target;
+       struct pic32mx_flash_bank *pic32mx_info = bank->driver_priv;
 
+       uint32_t config0_address;
        uint32_t devcfg0;
        int s;
        int num_pages;
@@ -242,7 +262,12 @@ static int pic32mx_protect_check(struct flash_bank *bank)
                return ERROR_TARGET_NOT_HALTED;
        }
 
-       target_read_u32(target, PIC32MX_DEVCFG0, &devcfg0);
+       if (pic32mx_info->dev_type == MX_1_2)
+               config0_address = PIC32MX_DEVCFG0_1_2;
+       else
+               config0_address = PIC32MX_DEVCFG0;
+
+       target_read_u32(target, config0_address, &devcfg0);
 
        if ((devcfg0 & (1 << 28)) == 0) /* code protect bit */
                num_pages = 0xffff;                     /* All pages protected */
@@ -251,8 +276,13 @@ static int pic32mx_protect_check(struct flash_bank *bank)
                        num_pages = 0;                  /* All pages unprotected */
                else
                        num_pages = 0xffff;             /* All pages protected */
-       } else /* pgm flash */
-               num_pages = (~devcfg0 >> 12) & 0xff;
+       } else {
+               /* pgm flash */
+               if (pic32mx_info->dev_type == MX_1_2)
+                       num_pages = (~devcfg0 >> 10) & 0x3f;
+               else
+                       num_pages = (~devcfg0 >> 12) & 0xff;
+       }
 
        for (s = 0; s < bank->num_sectors && s < num_pages; s++)
                bank->sectors[s].is_protected = 1;
@@ -315,7 +345,7 @@ static int pic32mx_protect(struct flash_bank *bank, int set, int first, int last
 
 /* see contib/loaders/flash/pic32mx.s for src */
 
-static const uint32_t pic32mx_flash_write_code[] = {
+static uint32_t pic32mx_flash_write_code[] = {
                                        /* write: */
        0x3C08AA99,             /* lui $t0, 0xaa99 */
        0x35086655,             /* ori $t0, 0x6655 */
@@ -390,6 +420,7 @@ static int pic32mx_write_block(struct flash_bank *bank, uint8_t *buffer,
        struct working_area *source;
        uint32_t address = bank->base + offset;
        struct reg_param reg_params[3];
+       uint32_t row_size;
        int retval = ERROR_OK;
 
        struct pic32mx_flash_bank *pic32mx_info = bank->driver_priv;
@@ -402,6 +433,23 @@ static int pic32mx_write_block(struct flash_bank *bank, uint8_t *buffer,
                return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
        };
 
+       /* Change values for counters and row size, depending on variant */
+       if (pic32mx_info->dev_type == MX_1_2) {
+               /* 128 byte row */
+               pic32mx_flash_write_code[8] = 0x2CD30020;
+               pic32mx_flash_write_code[14] = 0x24840080;
+               pic32mx_flash_write_code[15] = 0x24A50080;
+               pic32mx_flash_write_code[17] = 0x24C6FFE0;
+               row_size = 128;
+       } else {
+               /* 512 byte row */
+               pic32mx_flash_write_code[8] = 0x2CD30080;
+               pic32mx_flash_write_code[14] = 0x24840200;
+               pic32mx_flash_write_code[15] = 0x24A50200;
+               pic32mx_flash_write_code[17] = 0x24C6FF80;
+               row_size = 512;
+       }
+
        retval = target_write_buffer(target, pic32mx_info->write_algorithm->address,
                        sizeof(pic32mx_flash_write_code), (uint8_t *)pic32mx_flash_write_code);
        if (retval != ERROR_OK)
@@ -419,7 +467,7 @@ static int pic32mx_write_block(struct flash_bank *bank, uint8_t *buffer,
                        LOG_WARNING("no large enough working area available, can't do block memory writes");
                        return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
                }
-       };
+       }
 
        mips32_info.common_magic = MIPS32_COMMON_MAGIC;
        mips32_info.isa_mode = MIPS32_ISA_MIPS32;
@@ -428,19 +476,46 @@ static int pic32mx_write_block(struct flash_bank *bank, uint8_t *buffer,
        init_reg_param(&reg_params[1], "a1", 32, PARAM_OUT);
        init_reg_param(&reg_params[2], "a2", 32, PARAM_OUT);
 
+       int row_offset = offset % row_size;
+       uint8_t *new_buffer = NULL;
+       if (row_offset && (count >= (row_size / 4))) {
+               new_buffer = malloc(buffer_size);
+               if (new_buffer == NULL) {
+                       LOG_ERROR("Out of memory");
+                       return ERROR_FAIL;
+               }
+               memset(new_buffer,  0xff, row_offset);
+               address -= row_offset;
+       } else
+               row_offset = 0;
+
        while (count > 0) {
                uint32_t status;
-               uint32_t thisrun_count = (count > (buffer_size / 4)) ?
-                               (buffer_size / 4) : count;
+               uint32_t thisrun_count;
 
-               retval = target_write_buffer(target, source->address,
-                               thisrun_count * 4, buffer);
-               if (retval != ERROR_OK)
-                       break;
+               if (row_offset) {
+                       thisrun_count = (count > ((buffer_size - row_offset) / 4)) ?
+                               ((buffer_size - row_offset) / 4) : count;
+
+                       memcpy(new_buffer + row_offset, buffer, thisrun_count * 4);
+
+                       retval = target_write_buffer(target, source->address,
+                               row_offset + thisrun_count * 4, new_buffer);
+                       if (retval != ERROR_OK)
+                               break;
+               } else {
+                       thisrun_count = (count > (buffer_size / 4)) ?
+                                       (buffer_size / 4) : count;
+
+                       retval = target_write_buffer(target, source->address,
+                                       thisrun_count * 4, buffer);
+                       if (retval != ERROR_OK)
+                               break;
+               }
 
                buf_set_u32(reg_params[0].value, 0, 32, Virt2Phys(source->address));
                buf_set_u32(reg_params[1].value, 0, 32, Virt2Phys(address));
-               buf_set_u32(reg_params[2].value, 0, 32, thisrun_count);
+               buf_set_u32(reg_params[2].value, 0, 32, thisrun_count + row_offset / 4);
 
                retval = target_run_algorithm(target, 0, NULL, 3, reg_params,
                                pic32mx_info->write_algorithm->address,
@@ -468,6 +543,10 @@ static int pic32mx_write_block(struct flash_bank *bank, uint8_t *buffer,
                buffer += thisrun_count * 4;
                address += thisrun_count * 4;
                count -= thisrun_count;
+               if (row_offset) {
+                       address += row_offset;
+                       row_offset = 0;
+               }
        }
 
        target_free_working_area(target, source);
@@ -477,6 +556,8 @@ static int pic32mx_write_block(struct flash_bank *bank, uint8_t *buffer,
        destroy_reg_param(&reg_params[1]);
        destroy_reg_param(&reg_params[2]);
 
+       if (new_buffer != NULL)
+               free(new_buffer);
        return retval;
 }
 
@@ -598,7 +679,20 @@ static int pic32mx_probe(struct flash_bank *bank)
                return ERROR_FLASH_OPERATION_FAILED;
        }
 
-       page_size = 4096;
+       /* Check for PIC32mx1xx/2xx */
+       for (i = 0; pic32mx_devs[i].name != NULL; i++) {
+               if (pic32mx_devs[i].devid == (device_id & 0x0fffffff)) {
+                       if ((*(pic32mx_devs[i].name) == '1') || (*(pic32mx_devs[i].name) == '2'))
+                               pic32mx_info->dev_type = MX_1_2;
+                       break;
+               }
+       }
+
+       if (pic32mx_info->dev_type == MX_1_2)
+               page_size = 1024;
+       else
+               page_size = 4096;
+
 
        if (Virt2Phys(bank->base) == PIC32MX_PHYS_BOOT_FLASH) {
                /* 0x1FC00000: Boot flash size */
@@ -612,13 +706,21 @@ static int pic32mx_probe(struct flash_bank *bank)
                }
 #else
                /* fixed 12k boot bank - see comments above */
-               num_pages = (12 * 1024);
+               if (pic32mx_info->dev_type == MX_1_2)
+                       num_pages = (3 * 1024);
+               else
+                       num_pages = (12 * 1024);
 #endif
        } else {
                /* read the flash size from the device */
                if (target_read_u32(target, PIC32MX_BMXPFMSZ, &num_pages) != ERROR_OK) {
-                       LOG_WARNING("PIC32MX flash size failed, probe inaccurate - assuming 512k flash");
-                       num_pages = (512 * 1024);
+                       if (pic32mx_info->dev_type == MX_1_2) {
+                               LOG_WARNING("PIC32MX flash size failed, probe inaccurate - assuming 32k flash");
+                               num_pages = (32 * 1024);
+                       } else {
+                               LOG_WARNING("PIC32MX flash size failed, probe inaccurate - assuming 512k flash");
+                               num_pages = (512 * 1024);
+                       }
                }
        }
 
@@ -763,6 +865,7 @@ COMMAND_HANDLER(pic32mx_handle_unlock_command)
 
        /* unlock/erase device */
        mips_ejtag_drscan_8_out(ejtag_info, MCHP_ASERT_RST);
+       jtag_add_sleep(200);
 
        mips_ejtag_drscan_8_out(ejtag_info, MCHP_ERASE);
 
@@ -827,7 +930,7 @@ struct flash_driver pic32mx_flash = {
        .read = default_flash_read,
        .probe = pic32mx_probe,
        .auto_probe = pic32mx_auto_probe,
-       .erase_check = default_flash_mem_blank_check,
+       .erase_check = default_flash_blank_check,
        .protect_check = pic32mx_protect_check,
        .info = pic32mx_info,
 };

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)