pic32mx: Fix byte order bug
[openocd.git] / src / flash / nor / pic32mx.c
index 363f49e84a84f670643cd91fc7b588ce7b8274b3..2b27ec5b8bd5cddbc812e0dfa0867c1a69f81baf 100644 (file)
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
  ***************************************************************************/
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
+#include <jtag/jtag.h>
 #include "imp.h"
-#include "pic32mx.h"
 #include <target/algorithm.h>
 #include <target/mips32.h>
 #include <target/mips_m4k.h>
 
+#define PIC32MX_MANUF_ID       0x029
+
+/* pic32mx memory locations */
+
+#define PIC32MX_PHYS_RAM                       0x00000000
+#define PIC32MX_PHYS_PGM_FLASH         0x1D000000
+#define PIC32MX_PHYS_PERIPHERALS       0x1F800000
+#define PIC32MX_PHYS_BOOT_FLASH                0x1FC00000
+
+/*
+ * Translate Virtual and Physical addresses.
+ * Note: These macros only work for KSEG0/KSEG1 addresses.
+ */
+
+#define Virt2Phys(v)   ((v) & 0x1FFFFFFF)
+
+/* pic32mx configuration register locations */
+
+#define PIC32MX_DEVCFG0_1_2    0xBFC00BFC
+#define PIC32MX_DEVCFG0                0xBFC02FFC
+#define PIC32MX_DEVCFG1                0xBFC02FF8
+#define PIC32MX_DEVCFG2                0xBFC02FF4
+#define PIC32MX_DEVCFG3                0xBFC02FF0
+#define PIC32MX_DEVID          0xBF80F220
+
+#define PIC32MX_BMXPFMSZ       0xBF882060
+#define PIC32MX_BMXBOOTSZ      0xBF882070
+#define PIC32MX_BMXDRMSZ       0xBF882040
+
+/* pic32mx flash controller register locations */
+
+#define PIC32MX_NVMCON         0xBF80F400
+#define PIC32MX_NVMCONCLR      0xBF80F404
+#define PIC32MX_NVMCONSET      0xBF80F408
+#define PIC32MX_NVMCONINV      0xBF80F40C
+#define NVMCON_NVMWR           (1 << 15)
+#define NVMCON_NVMWREN         (1 << 14)
+#define NVMCON_NVMERR          (1 << 13)
+#define NVMCON_LVDERR          (1 << 12)
+#define NVMCON_LVDSTAT         (1 << 11)
+#define NVMCON_OP_PFM_ERASE            0x5
+#define NVMCON_OP_PAGE_ERASE   0x4
+#define NVMCON_OP_ROW_PROG             0x3
+#define NVMCON_OP_WORD_PROG            0x1
+#define NVMCON_OP_NOP                  0x0
+
+#define PIC32MX_NVMKEY         0xBF80F410
+#define PIC32MX_NVMADDR                0xBF80F420
+#define PIC32MX_NVMADDRCLR     0xBF80F424
+#define PIC32MX_NVMADDRSET     0xBF80F428
+#define PIC32MX_NVMADDRINV     0xBF80F42C
+#define PIC32MX_NVMDATA                0xBF80F430
+#define PIC32MX_NVMSRCADDR     0xBF80F440
+
+/* flash unlock keys */
+
+#define NVMKEY1                        0xAA996655
+#define NVMKEY2                        0x556699AA
+
+#define MX_1_2                 1       /* PIC32mx1xx/2xx */
+
+struct pic32mx_flash_bank {
+       int probed;
+       int dev_type;           /* Default 0. 1 for Pic32MX1XX/2XX variant */
+};
+
+/*
+ * DEVID values as per PIC32MX Flash Programming Specification Rev J
+ */
+
 static const struct pic32mx_devs_s {
-       uint8_t devid;
-       char *name;
+       uint32_t devid;
+       const char *name;
 } pic32mx_devs[] = {
-       {0x38, "360F512L"},
-       {0x34, "360F256L"},
-       {0x2D, "340F128L"},
-       {0x2A, "320F128L"},
-       {0x16, "340F512H"},
-       {0x12, "340F256H"},
-       {0x0D, "340F128H"},
-       {0x0A, "320F128H"},
-       {0x06, "320F064H"},
-       {0x02, "320F032H"},
-       {0x07, "795F512L"},
-       {0x0E, "795F512H"},
-       {0x11, "675F512L"},
-       {0x0C, "675F512H"},
-       {0x0F, "575F512L"},
-       {0x09, "575F512H"},
-       {0x17, "575F256H"},
-       {0x78, "460F512L"},
-       {0x74, "460F256L"},
-       {0x6D, "440F128L"},
-       {0x56, "440F512H"},
-       {0x52, "440F256H"},
-       {0x4D, "440F128H"},
-       {0x42, "420F032H"},
-       {0x00, NULL}
+       {0x04A07053, "110F016B"},
+       {0x04A09053, "110F016C"},
+       {0x04A0B053, "110F016D"},
+       {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"},
+       {0x0092A053, "320F128L"},
+       {0x00916053, "340F512H"},
+       {0x00912053, "340F256H"},
+       {0x0090D053, "340F128H"},
+       {0x0090A053, "320F128H"},
+       {0x00906053, "320F064H"},
+       {0x00902053, "320F032H"},
+       {0x00978053, "460F512L"},
+       {0x00974053, "460F256L"},
+       {0x0096D053, "440F128L"},
+       {0x00952053, "440F256H"},
+       {0x00956053, "440F512H"},
+       {0x0094D053, "440F128H"},
+       {0x00942053, "420F032H"},
+       {0x04307053, "795F512L"},
+       {0x0430E053, "795F512H"},
+       {0x04306053, "775F512L"},
+       {0x0430D053, "775F512H"},
+       {0x04312053, "775F256L"},
+       {0x04303053, "775F256H"},
+       {0x04417053, "764F128L"},
+       {0x0440B053, "764F128H"},
+       {0x04341053, "695F512L"},
+       {0x04325053, "695F512H"},
+       {0x04311053, "675F512L"},
+       {0x0430C053, "675F512H"},
+       {0x04305053, "675F256L"},
+       {0x0430B053, "675F256H"},
+       {0x04413053, "664F128L"},
+       {0x04407053, "664F128H"},
+       {0x04411053, "664F064L"},
+       {0x04405053, "664F064H"},
+       {0x0430F053, "575F512L"},
+       {0x04309053, "575F512H"},
+       {0x04333053, "575F256L"},
+       {0x04317053, "575F256H"},
+       {0x0440F053, "564F128L"},
+       {0x04403053, "564F128H"},
+       {0x0440D053, "564F064L"},
+       {0x04401053, "564F064H"},
+       {0x04400053, "534F064H"},
+       {0x0440C053, "534F064L"},
+       {0x00000000, NULL}
 };
 
 /* flash bank pic32mx <base> <size> 0 0 <target#>
@@ -71,16 +187,13 @@ FLASH_BANK_COMMAND_HANDLER(pic32mx_flash_bank_command)
        struct pic32mx_flash_bank *pic32mx_info;
 
        if (CMD_ARGC < 6)
-       {
-               LOG_WARNING("incomplete flash_bank pic32mx configuration");
-               return ERROR_FLASH_BANK_INVALID;
-       }
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
        pic32mx_info = malloc(sizeof(struct pic32mx_flash_bank));
        bank->driver_priv = pic32mx_info;
 
-       pic32mx_info->write_algorithm = NULL;
        pic32mx_info->probed = 0;
+       pic32mx_info->dev_type = 0;
 
        return ERROR_OK;
 }
@@ -100,8 +213,7 @@ static uint32_t pic32mx_wait_status_busy(struct flash_bank *bank, int timeout)
        uint32_t status;
 
        /* wait for busy to clear */
-       while (((status = pic32mx_get_flash_status(bank)) & NVMCON_NVMWR) && (timeout-- > 0))
-       {
+       while (((status = pic32mx_get_flash_status(bank)) & NVMCON_NVMWR) && (timeout-- > 0)) {
                LOG_DEBUG("status: 0x%" PRIx32, status);
                alive_sleep(1);
        }
@@ -136,30 +248,39 @@ 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;
 
-       if (target->state != TARGET_HALTED)
-       {
+       if (target->state != TARGET_HALTED) {
                LOG_ERROR("Target not halted");
                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 */
-       else if (Virt2Phys(bank->base) == PIC32MX_PHYS_BOOT_FLASH)
-       {
+               num_pages = 0xffff;                     /* All pages protected */
+       else if (Virt2Phys(bank->base) == PIC32MX_PHYS_BOOT_FLASH) {
                if (devcfg0 & (1 << 24))
-                       num_pages = 0;       /* All pages unprotected */
+                       num_pages = 0;                  /* All pages unprotected */
                else
-                       num_pages = 0xffff;  /* All pages protected */
+                       num_pages = 0xffff;             /* All pages protected */
+       } else {
+               /* pgm flash */
+               if (pic32mx_info->dev_type == MX_1_2)
+                       num_pages = (~devcfg0 >> 10) & 0x3f;
+               else
+                       num_pages = (~devcfg0 >> 12) & 0xff;
        }
-       else /* pgm flash */
-               num_pages = (~devcfg0 >> 12) & 0xff;
 
        for (s = 0; s < bank->num_sectors && s < num_pages; s++)
                bank->sectors[s].is_protected = 1;
@@ -175,15 +296,13 @@ static int pic32mx_erase(struct flash_bank *bank, int first, int last)
        int i;
        uint32_t status;
 
-       if (bank->target->state != TARGET_HALTED)
-       {
+       if (bank->target->state != TARGET_HALTED) {
                LOG_ERROR("Target not halted");
                return ERROR_TARGET_NOT_HALTED;
        }
 
        if ((first == 0) && (last == (bank->num_sectors - 1))
-               && (Virt2Phys(bank->base) == PIC32MX_PHYS_PGM_FLASH))
-       {
+               && (Virt2Phys(bank->base) == PIC32MX_PHYS_PGM_FLASH)) {
                /* this will only erase the Program Flash (PFM), not the Boot Flash (BFM)
                 * we need to use the MTAP to perform a full erase */
                LOG_DEBUG("Erasing entire program flash");
@@ -195,8 +314,7 @@ static int pic32mx_erase(struct flash_bank *bank, int first, int last)
                return ERROR_OK;
        }
 
-       for (i = first; i <= last; i++)
-       {
+       for (i = first; i <= last; i++) {
                target_write_u32(target, PIC32MX_NVMADDR, Virt2Phys(bank->base + bank->sectors[i].offset));
 
                status = pic32mx_nvm_exec(bank, NVMCON_OP_PAGE_ERASE, 10);
@@ -213,13 +331,9 @@ static int pic32mx_erase(struct flash_bank *bank, int first, int last)
 
 static int pic32mx_protect(struct flash_bank *bank, int set, int first, int last)
 {
-       struct pic32mx_flash_bank *pic32mx_info = NULL;
        struct target *target = bank->target;
 
-       pic32mx_info = bank->driver_priv;
-
-       if (target->state != TARGET_HALTED)
-       {
+       if (target->state != TARGET_HALTED) {
                LOG_ERROR("Target not halted");
                return ERROR_TARGET_NOT_HALTED;
        }
@@ -227,7 +341,9 @@ static int pic32mx_protect(struct flash_bank *bank, int set, int first, int last
        return ERROR_OK;
 }
 
-static const uint32_t pic32mx_flash_write_code[] = {
+/* see contib/loaders/flash/pic32mx.s for src */
+
+static uint32_t pic32mx_flash_write_code[] = {
                                        /* write: */
        0x3C08AA99,             /* lui $t0, 0xaa99 */
        0x35086655,             /* ori $t0, 0x6655 */
@@ -283,7 +399,7 @@ static const uint32_t pic32mx_flash_write_code[] = {
        0x1600FFFD,             /* bne $s0, $zero, waitflash */
        0x00000000,             /* nop */
        0x00000000,             /* nop */
-       0x00000000,     /* nop */
+       0x00000000,             /* nop */
        0x00000000,             /* nop */
        0x00000000,             /* nop */
        0x8D510000,             /* lw $s1, 0($t2) */
@@ -299,9 +415,11 @@ static int pic32mx_write_block(struct flash_bank *bank, uint8_t *buffer,
 {
        struct target *target = bank->target;
        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[3];
+       uint32_t row_size;
        int retval = ERROR_OK;
 
        struct pic32mx_flash_bank *pic32mx_info = bank->driver_priv;
@@ -309,33 +427,47 @@ static int pic32mx_write_block(struct flash_bank *bank, uint8_t *buffer,
 
        /* flash write code */
        if (target_alloc_working_area(target, sizeof(pic32mx_flash_write_code),
-                       &pic32mx_info->write_algorithm) != ERROR_OK)
-       {
+                       &write_algorithm) != ERROR_OK) {
                LOG_WARNING("no working area available, can't do block memory writes");
                return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
        };
 
-       if ((retval = target_write_buffer(target,
-                       pic32mx_info->write_algorithm->address,
-                       sizeof(pic32mx_flash_write_code),
-                       (uint8_t*)pic32mx_flash_write_code)) != ERROR_OK)
+       /* 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;
+       }
+
+       uint8_t code[sizeof(pic32mx_flash_write_code)];
+       target_buffer_set_u32_array(target, code, ARRAY_SIZE(pic32mx_flash_write_code),
+                       pic32mx_flash_write_code);
+       retval = target_write_buffer(target, write_algorithm->address, sizeof(code), code);
+       if (retval != ERROR_OK)
                return retval;
 
        /* memory buffer */
-       while (target_alloc_working_area_try(target, buffer_size, &source) != ERROR_OK)
-       {
+       while (target_alloc_working_area_try(target, buffer_size, &source) != ERROR_OK) {
                buffer_size /= 2;
-               if (buffer_size <= 256)
-               {
-                       /* if we already allocated the writing code, but failed to get a
+               if (buffer_size <= 256) {
+                       /* we already allocated the writing code, but failed to get a
                         * buffer, free the algorithm */
-                       if (pic32mx_info->write_algorithm)
-                               target_free_working_area(target, pic32mx_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;
                }
-       };
+       }
 
        mips32_info.common_magic = MIPS32_COMMON_MAGIC;
        mips32_info.isa_mode = MIPS32_ISA_MIPS32;
@@ -344,25 +476,51 @@ 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);
 
-       while (count > 0)
-       {
-               uint32_t status;
-               uint32_t thisrun_count = (count > (buffer_size / 4)) ?
-                               (buffer_size / 4) : count;
+       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;
 
-               if ((retval = target_write_buffer(target, source->address,
-                               thisrun_count * 4, buffer)) != ERROR_OK)
-                       break;
+       while (count > 0) {
+               uint32_t status;
+               uint32_t thisrun_count;
+
+               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);
 
-               if ((retval = target_run_algorithm(target, 0, NULL, 3, reg_params,
-                               pic32mx_info->write_algorithm->address,
-                               0,
-                               10000, &mips32_info)) != ERROR_OK)
-               {
+               retval = target_run_algorithm(target, 0, NULL, 3, reg_params,
+                               write_algorithm->address,
+                               0, 10000, &mips32_info);
+               if (retval != ERROR_OK) {
                        LOG_ERROR("error executing pic32mx flash write algorithm");
                        retval = ERROR_FLASH_OPERATION_FAILED;
                        break;
@@ -370,15 +528,13 @@ static int pic32mx_write_block(struct flash_bank *bank, uint8_t *buffer,
 
                status = buf_get_u32(reg_params[0].value, 0, 32);
 
-               if (status & NVMCON_NVMERR)
-               {
+               if (status & NVMCON_NVMERR) {
                        LOG_ERROR("Flash write error NVMERR (status = 0x%08" PRIx32 ")", status);
                        retval = ERROR_FLASH_OPERATION_FAILED;
                        break;
                }
 
-               if (status & NVMCON_LVDERR)
-               {
+               if (status & NVMCON_LVDERR) {
                        LOG_ERROR("Flash write error LVDERR (status = 0x%08" PRIx32 ")", status);
                        retval = ERROR_FLASH_OPERATION_FAILED;
                        break;
@@ -387,15 +543,21 @@ 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);
-       target_free_working_area(target, pic32mx_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]);
 
+       if (new_buffer != NULL)
+               free(new_buffer);
        return retval;
 }
 
@@ -418,8 +580,7 @@ static int pic32mx_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offs
        uint32_t status;
        int retval;
 
-       if (bank->target->state != TARGET_HALTED)
-       {
+       if (bank->target->state != TARGET_HALTED) {
                LOG_ERROR("Target not halted");
                return ERROR_TARGET_NOT_HALTED;
        }
@@ -427,53 +588,43 @@ static int pic32mx_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offs
        LOG_DEBUG("writing to flash at address 0x%08" PRIx32 " at offset 0x%8.8" PRIx32
                        " count: 0x%8.8" PRIx32 "", bank->base, offset, count);
 
-       if (offset & 0x3)
-       {
+       if (offset & 0x3) {
                LOG_WARNING("offset 0x%" PRIx32 "breaks required 4-byte alignment", offset);
                return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
        }
 
        /* multiple words (4-byte) to be programmed? */
-       if (words_remaining > 0)
-       {
+       if (words_remaining > 0) {
                /* try using a block write */
-               if ((retval = pic32mx_write_block(bank, buffer, offset, words_remaining)) != ERROR_OK)
-               {
-                       if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE)
-                       {
+               retval = pic32mx_write_block(bank, buffer, offset, words_remaining);
+               if (retval != ERROR_OK) {
+                       if (retval == ERROR_TARGET_RESOURCE_NOT_AVAILABLE) {
                                /* if block write failed (no sufficient working area),
                                 * we use normal (slow) single dword accesses */
                                LOG_WARNING("couldn't use block writes, falling back to single memory accesses");
+                       } else if (retval == ERROR_FLASH_OPERATION_FAILED) {
+                               LOG_ERROR("flash writing failed");
+                               return retval;
                        }
-                       else if (retval == ERROR_FLASH_OPERATION_FAILED)
-                       {
-                               LOG_ERROR("flash writing failed with error code: 0x%x", retval);
-                               return ERROR_FLASH_OPERATION_FAILED;
-                       }
-               }
-               else
-               {
+               } else {
                        buffer += words_remaining * 4;
                        address += words_remaining * 4;
                        words_remaining = 0;
                }
        }
 
-       while (words_remaining > 0)
-       {
+       while (words_remaining > 0) {
                uint32_t value;
                memcpy(&value, buffer + bytes_written, sizeof(uint32_t));
 
                status = pic32mx_write_word(bank, address, value);
 
-               if (status & NVMCON_NVMERR)
-               {
+               if (status & NVMCON_NVMERR) {
                        LOG_ERROR("Flash write error NVMERR (status = 0x%08" PRIx32 ")", status);
                        return ERROR_FLASH_OPERATION_FAILED;
                }
 
-               if (status & NVMCON_LVDERR)
-               {
+               if (status & NVMCON_LVDERR) {
                        LOG_ERROR("Flash write error LVDERR (status = 0x%08" PRIx32 ")", status);
                        return ERROR_FLASH_OPERATION_FAILED;
                }
@@ -483,21 +634,18 @@ static int pic32mx_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offs
                address += 4;
        }
 
-       if (bytes_remaining)
-       {
+       if (bytes_remaining) {
                uint32_t value = 0xffffffff;
                memcpy(&value, buffer + bytes_written, bytes_remaining);
 
                status = pic32mx_write_word(bank, address, value);
 
-               if (status & NVMCON_NVMERR)
-               {
+               if (status & NVMCON_NVMERR) {
                        LOG_ERROR("Flash write error NVMERR (status = 0x%08" PRIx32 ")", status);
                        return ERROR_FLASH_OPERATION_FAILED;
                }
 
-               if (status & NVMCON_LVDERR)
-               {
+               if (status & NVMCON_LVDERR) {
                        LOG_ERROR("Flash write error LVDERR (status = 0x%08" PRIx32 ")", status);
                        return ERROR_FLASH_OPERATION_FAILED;
                }
@@ -520,10 +668,10 @@ static int pic32mx_probe(struct flash_bank *bank)
        pic32mx_info->probed = 0;
 
        device_id = ejtag_info->idcode;
-       LOG_INFO("device id = 0x%08" PRIx32 " (manuf 0x%03x dev 0x%02x, ver 0x%02x)",
+       LOG_INFO("device id = 0x%08" PRIx32 " (manuf 0x%03x dev 0x%04x, ver 0x%02x)",
                          device_id,
                          (unsigned)((device_id >> 1) & 0x7ff),
-                         (unsigned)((device_id >> 12) & 0xff),
+                         (unsigned)((device_id >> 12) & 0xffff),
                          (unsigned)((device_id >> 28) & 0xf));
 
        if (((device_id >> 1) & 0x7ff) != PIC32MX_MANUF_ID) {
@@ -531,10 +679,22 @@ 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)
-       {
+
+       if (Virt2Phys(bank->base) == PIC32MX_PHYS_BOOT_FLASH) {
                /* 0x1FC00000: Boot flash size */
 #if 0
                /* for some reason this register returns 8k for the boot bank size
@@ -546,22 +706,27 @@ 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
-       {
+       } 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);
+                       }
                }
        }
 
        LOG_INFO("flash size = %" PRId32 "kbytes", num_pages / 1024);
 
-       if (bank->sectors)
-       {
+       if (bank->sectors) {
                free(bank->sectors);
                bank->sectors = NULL;
        }
@@ -572,8 +737,7 @@ static int pic32mx_probe(struct flash_bank *bank)
        bank->num_sectors = num_pages;
        bank->sectors = malloc(sizeof(struct flash_sector) * num_pages);
 
-       for (i = 0; i < (int)num_pages; i++)
-       {
+       for (i = 0; i < (int)num_pages; i++) {
                bank->sectors[i].offset = i * page_size;
                bank->sectors[i].size = page_size;
                bank->sectors[i].is_erased = -1;
@@ -611,21 +775,19 @@ static int pic32mx_info(struct flash_bank *bank, char *buf, int buf_size)
                return ERROR_FLASH_OPERATION_FAILED;
        }
 
-       for (i = 0; pic32mx_devs[i].name != NULL; i++)
-       {
-               if (pic32mx_devs[i].devid == ((device_id >> 12) & 0xff)) {
+       for (i = 0; pic32mx_devs[i].name != NULL; i++) {
+               if (pic32mx_devs[i].devid == (device_id & 0x0fffffff)) {
                        printed = snprintf(buf, buf_size, "PIC32MX%s", pic32mx_devs[i].name);
                        break;
                }
        }
 
-       if (pic32mx_devs[i].name == NULL) {
+       if (pic32mx_devs[i].name == NULL)
                printed = snprintf(buf, buf_size, "Unknown");
-       }
 
        buf += printed;
        buf_size -= printed;
-       printed = snprintf(buf, buf_size, "  Ver: 0x%02x",
+       snprintf(buf, buf_size, " Ver: 0x%02x",
                        (unsigned)((device_id >> 28) & 0xf));
 
        return ERROR_OK;
@@ -637,10 +799,7 @@ COMMAND_HANDLER(pic32mx_handle_pgm_word_command)
        int status, res;
 
        if (CMD_ARGC != 3)
-       {
-               command_print(CMD_CTX, "pic32mx pgm_word <addr> <value> <bank>");
-               return ERROR_OK;
-       }
+               return ERROR_COMMAND_SYNTAX_ERROR;
 
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
        COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], value);
@@ -650,8 +809,7 @@ COMMAND_HANDLER(pic32mx_handle_pgm_word_command)
        if (ERROR_OK != retval)
                return retval;
 
-       if (address < bank->base || address >= (bank->base + bank->size))
-       {
+       if (address < bank->base || address >= (bank->base + bank->size)) {
                command_print(CMD_CTX, "flash address '%s' is out of bounds", CMD_ARGV[0]);
                return ERROR_OK;
        }
@@ -679,10 +837,9 @@ COMMAND_HANDLER(pic32mx_handle_unlock_command)
        struct mips_ejtag *ejtag_info;
        int timeout = 10;
 
-       if (CMD_ARGC < 1)
-       {
+       if (CMD_ARGC < 1) {
                command_print(CMD_CTX, "pic32mx unlock <bank>");
-               return ERROR_OK;
+               return ERROR_COMMAND_SYNTAX_ERROR;
        }
 
        struct flash_bank *bank;
@@ -701,32 +858,28 @@ COMMAND_HANDLER(pic32mx_handle_unlock_command)
        /* first check status of device */
        mchip_cmd = MCHP_STATUS;
        mips_ejtag_drscan_8(ejtag_info, &mchip_cmd);
-       if (mchip_cmd & (1 << 7))
-       {
+       if (mchip_cmd & (1 << 7)) {
                /* device is not locked */
                command_print(CMD_CTX, "pic32mx is already unlocked, erasing anyway");
        }
 
        /* unlock/erase device */
-       mchip_cmd = MCHP_ASERT_RST;
-       mips_ejtag_drscan_8(ejtag_info, &mchip_cmd);
+       mips_ejtag_drscan_8_out(ejtag_info, MCHP_ASERT_RST);
+       jtag_add_sleep(200);
 
-       mchip_cmd = MCHP_ERASE;
-       mips_ejtag_drscan_8(ejtag_info, &mchip_cmd);
+       mips_ejtag_drscan_8_out(ejtag_info, MCHP_ERASE);
 
        do {
                mchip_cmd = MCHP_STATUS;
                mips_ejtag_drscan_8(ejtag_info, &mchip_cmd);
-               if (timeout-- == 0)
-               {
+               if (timeout-- == 0) {
                        LOG_DEBUG("timeout waiting for unlock: 0x%" PRIx32 "", mchip_cmd);
                        break;
                }
                alive_sleep(1);
        } while ((mchip_cmd & (1 << 2)) || (!(mchip_cmd & (1 << 3))));
 
-       mchip_cmd = MCHP_DE_ASSERT_RST;
-       mips_ejtag_drscan_8(ejtag_info, &mchip_cmd);
+       mips_ejtag_drscan_8_out(ejtag_info, MCHP_DE_ASSERT_RST);
 
        /* select ejtag tap */
        mips_ejtag_set_instr(ejtag_info, MTAP_SW_ETAP);
@@ -741,6 +894,7 @@ COMMAND_HANDLER(pic32mx_handle_unlock_command)
 static const struct command_registration pic32mx_exec_command_handlers[] = {
        {
                .name = "pgm_word",
+               .usage = "<addr> <value> <bank>",
                .handler = pic32mx_handle_pgm_word_command,
                .mode = COMMAND_EXEC,
                .help = "program a word",
@@ -760,6 +914,7 @@ static const struct command_registration pic32mx_command_handlers[] = {
                .name = "pic32mx",
                .mode = COMMAND_ANY,
                .help = "pic32mx flash command group",
+               .usage = "",
                .chain = pic32mx_exec_command_handlers,
        },
        COMMAND_REGISTRATION_DONE
@@ -775,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)