command_handler: change 'args' to CMD_ARGV
[openocd.git] / src / flash / pic32mx.c
index 3e816b3941446fb14cb90f7e2f1463550e432890..05e047468d2a8c0cb2f119ea6c60000374e17fa8 100644 (file)
@@ -35,7 +35,7 @@ static
 struct pic32mx_devs_s {
        uint8_t devid;
        char    *name;
-       u32     pfm_size;
+       uint32_t        pfm_size;
 } pic32mx_devs[] = {
        { 0x78, "460F512L USB", 512 },
        { 0x74, "460F256L USB", 256 },
@@ -57,72 +57,22 @@ struct pic32mx_devs_s {
        { 0x00, NULL, 0 }
 };
 
-static int pic32mx_register_commands(struct command_context_s *cmd_ctx);
-static int pic32mx_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);
-static int pic32mx_erase(struct flash_bank_s *bank, int first, int last);
-static int pic32mx_protect(struct flash_bank_s *bank, int set, int first, int last);
-static int pic32mx_write(struct flash_bank_s *bank, uint8_t *buffer, u32 offset, u32 count);
-static int pic32mx_write_row(struct flash_bank_s *bank, u32 address, u32 srcaddr);
-static int pic32mx_write_word(struct flash_bank_s *bank, u32 address, u32 word);
-static int pic32mx_probe(struct flash_bank_s *bank);
-static int pic32mx_auto_probe(struct flash_bank_s *bank);
-//static int pic32mx_handle_part_id_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int pic32mx_protect_check(struct flash_bank_s *bank);
-static int pic32mx_info(struct flash_bank_s *bank, char *buf, int buf_size);
-
-#if 0
-int pic32mx_handle_lock_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-int pic32mx_handle_unlock_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-#endif
-static int pic32mx_handle_chip_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-static int pic32mx_handle_pgm_word_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
-//static int pic32mx_chip_erase(struct flash_bank_s *bank);
-
-flash_driver_t pic32mx_flash =
-{
-       .name = "pic32mx",
-       .register_commands = pic32mx_register_commands,
-       .flash_bank_command = pic32mx_flash_bank_command,
-       .erase = pic32mx_erase,
-       .protect = pic32mx_protect,
-       .write = pic32mx_write,
-       .probe = pic32mx_probe,
-       .auto_probe = pic32mx_auto_probe,
-       .erase_check = default_flash_mem_blank_check,
-       .protect_check = pic32mx_protect_check,
-       .info = pic32mx_info
-};
-
-static int pic32mx_register_commands(struct command_context_s *cmd_ctx)
-{
-       command_t *pic32mx_cmd = register_command(cmd_ctx, NULL, "pic32mx", NULL, COMMAND_ANY, "pic32mx flash specific commands");
-
-#if 0
-       register_command(cmd_ctx, pic32mx_cmd, "lock", pic32mx_handle_lock_command, COMMAND_EXEC,
-                                        "lock device");
-       register_command(cmd_ctx, pic32mx_cmd, "unlock", pic32mx_handle_unlock_command, COMMAND_EXEC,
-                                        "unlock protected device");
-#endif
-       register_command(cmd_ctx, pic32mx_cmd, "chip_erase", pic32mx_handle_chip_erase_command, COMMAND_EXEC,
-                                        "erase device");
-       register_command(cmd_ctx, pic32mx_cmd, "pgm_word", pic32mx_handle_pgm_word_command, COMMAND_EXEC,
-                                        "program a word");
-       return ERROR_OK;
-}
+static int pic32mx_write_row(struct flash_bank *bank, uint32_t address, uint32_t srcaddr);
+static int pic32mx_write_word(struct flash_bank *bank, uint32_t address, uint32_t word);
 
 /* flash bank pic32mx <base> <size> 0 0 <target#>
  */
-static int pic32mx_flash_bank_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank)
+FLASH_BANK_COMMAND_HANDLER(pic32mx_flash_bank_command)
 {
-       pic32mx_flash_bank_t *pic32mx_info;
+       struct pic32mx_flash_bank *pic32mx_info;
 
-       if (argc < 6)
+       if (CMD_ARGC < 6)
        {
                LOG_WARNING("incomplete flash_bank pic32mx configuration");
                return ERROR_FLASH_BANK_INVALID;
        }
 
-       pic32mx_info = malloc(sizeof(pic32mx_flash_bank_t));
+       pic32mx_info = malloc(sizeof(struct pic32mx_flash_bank));
        bank->driver_priv = pic32mx_info;
 
        pic32mx_info->write_algorithm = NULL;
@@ -131,38 +81,38 @@ static int pic32mx_flash_bank_command(struct command_context_s *cmd_ctx, char *c
        return ERROR_OK;
 }
 
-static u32 pic32mx_get_flash_status(flash_bank_t *bank)
+static uint32_t pic32mx_get_flash_status(struct flash_bank *bank)
 {
-       target_t *target = bank->target;
-       u32 status;
+       struct target *target = bank->target;
+       uint32_t status;
 
        target_read_u32(target, PIC32MX_NVMCON, &status);
 
        return status;
 }
 
-static u32 pic32mx_wait_status_busy(flash_bank_t *bank, int timeout)
+static uint32_t pic32mx_wait_status_busy(struct flash_bank *bank, int timeout)
 {
-       u32 status;
+       uint32_t status;
 
        /* wait for busy to clear */
        while (((status = pic32mx_get_flash_status(bank)) & NVMCON_NVMWR) && (timeout-- > 0))
        {
-               LOG_DEBUG("status: 0x%x", status);
+               LOG_DEBUG("status: 0x%" PRIx32, status);
                alive_sleep(1);
        }
-       if(timeout <= 0)
-               LOG_DEBUG("timeout: status: 0x%x", status);
+       if (timeout <= 0)
+               LOG_DEBUG("timeout: status: 0x%" PRIx32, status);
 
        return status;
 }
 
-static int pic32mx_nvm_exec(struct flash_bank_s *bank, u32 op, u32 timeout)
+static int pic32mx_nvm_exec(struct flash_bank *bank, uint32_t op, uint32_t timeout)
 {
-       target_t *target = bank->target;
-       u32 status;
+       struct target *target = bank->target;
+       uint32_t status;
 
-       target_write_u32(target, PIC32MX_NVMCON, NVMCON_NVMWREN|op);
+       target_write_u32(target, PIC32MX_NVMCON, NVMCON_NVMWREN | op);
 
        /* unlock flash registers */
        target_write_u32(target, PIC32MX_NVMKEY, NVMKEY1);
@@ -179,11 +129,11 @@ static int pic32mx_nvm_exec(struct flash_bank_s *bank, u32 op, u32 timeout)
        return status;
 }
 
-static int pic32mx_protect_check(struct flash_bank_s *bank)
+static int pic32mx_protect_check(struct flash_bank *bank)
 {
-       target_t *target = bank->target;
+       struct target *target = bank->target;
 
-       u32 devcfg0;
+       uint32_t devcfg0;
        int s;
        int num_pages;
 
@@ -194,11 +144,11 @@ static int pic32mx_protect_check(struct flash_bank_s *bank)
        }
 
        target_read_u32(target, PIC32MX_DEVCFG0, &devcfg0);
-       if((devcfg0 & (1<<28)) == 0) /* code protect bit */
+       if ((devcfg0 & (1 << 28)) == 0) /* code protect bit */
                num_pages = 0xffff;  /* All pages protected */
-       else if(bank->base == PIC32MX_KSEG1_BOOT_FLASH)
+       else if (bank->base == PIC32MX_KSEG1_BOOT_FLASH)
        {
-               if(devcfg0 & (1<<24))
+               if (devcfg0 & (1 << 24))
                        num_pages = 0;       /* All pages unprotected */
                else
                        num_pages = 0xffff;  /* All pages protected */
@@ -213,11 +163,11 @@ static int pic32mx_protect_check(struct flash_bank_s *bank)
        return ERROR_OK;
 }
 
-static int pic32mx_erase(struct flash_bank_s *bank, int first, int last)
+static int pic32mx_erase(struct flash_bank *bank, int first, int last)
 {
-       target_t *target = bank->target;
+       struct target *target = bank->target;
        int i;
-       u32 status;
+       uint32_t status;
 
        if (bank->target->state != TARGET_HALTED)
        {
@@ -229,25 +179,25 @@ static int pic32mx_erase(struct flash_bank_s *bank, int first, int last)
        {
                LOG_DEBUG("Erasing entire program flash");
                status = pic32mx_nvm_exec(bank, NVMCON_OP_PFM_ERASE, 50);
-               if( status & NVMCON_NVMERR )
+               if (status & NVMCON_NVMERR)
                        return ERROR_FLASH_OPERATION_FAILED;
-               if( status & NVMCON_LVDERR )
+               if (status & NVMCON_LVDERR)
                        return ERROR_FLASH_OPERATION_FAILED;
                return ERROR_OK;
        }
 
        for (i = first; i <= last; i++)
        {
-               if(bank->base >= PIC32MX_KSEG1_PGM_FLASH)
+               if (bank->base >= PIC32MX_KSEG1_PGM_FLASH)
                        target_write_u32(target, PIC32MX_NVMADDR, KS1Virt2Phys(bank->base + bank->sectors[i].offset));
                else
                        target_write_u32(target, PIC32MX_NVMADDR, KS0Virt2Phys(bank->base + bank->sectors[i].offset));
 
                status = pic32mx_nvm_exec(bank, NVMCON_OP_PAGE_ERASE, 10);
 
-               if( status & NVMCON_NVMERR )
+               if (status & NVMCON_NVMERR)
                        return ERROR_FLASH_OPERATION_FAILED;
-               if( status & NVMCON_LVDERR )
+               if (status & NVMCON_LVDERR)
                        return ERROR_FLASH_OPERATION_FAILED;
                bank->sectors[i].is_erased = 1;
        }
@@ -255,15 +205,15 @@ static int pic32mx_erase(struct flash_bank_s *bank, int first, int last)
        return ERROR_OK;
 }
 
-static int pic32mx_protect(struct flash_bank_s *bank, int set, int first, int last)
+static int pic32mx_protect(struct flash_bank *bank, int set, int first, int last)
 {
-       pic32mx_flash_bank_t *pic32mx_info = NULL;
-       target_t *target = bank->target;
+       struct pic32mx_flash_bank *pic32mx_info = NULL;
+       struct target *target = bank->target;
 #if 0
-       u16 prot_reg[4] = {0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF};
+       uint16_t prot_reg[4] = {0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF};
        int i, reg, bit;
        int status;
-       u32 protection;
+       uint32_t protection;
 #endif
 
        pic32mx_info = bank->driver_priv;
@@ -285,10 +235,10 @@ static int pic32mx_protect(struct flash_bank_s *bank, int set, int first, int la
         * high density - each bit refers to a 2bank protection */
        target_read_u32(target, PIC32MX_FLASH_WRPR, &protection);
 
-       prot_reg[0] = (u16)protection;
-       prot_reg[1] = (u16)(protection >> 8);
-       prot_reg[2] = (u16)(protection >> 16);
-       prot_reg[3] = (u16)(protection >> 24);
+       prot_reg[0] = (uint16_t)protection;
+       prot_reg[1] = (uint16_t)(protection >> 8);
+       prot_reg[2] = (uint16_t)(protection >> 16);
+       prot_reg[3] = (uint16_t)(protection >> 24);
 
        if (pic32mx_info->ppage_size == 2)
        {
@@ -313,7 +263,7 @@ static int pic32mx_protect(struct flash_bank_s *bank, int set, int first, int la
                        reg = (i / pic32mx_info->ppage_size) / 8;
                        bit = (i / pic32mx_info->ppage_size) - (reg * 8);
 
-                       if( set )
+                       if (set)
                                prot_reg[reg] &= ~(1 << bit);
                        else
                                prot_reg[reg] |= (1 << bit);
@@ -327,7 +277,7 @@ static int pic32mx_protect(struct flash_bank_s *bank, int set, int first, int la
                        reg = (i / pic32mx_info->ppage_size) / 8;
                        bit = (i / pic32mx_info->ppage_size) - (reg * 8);
 
-                       if( set )
+                       if (set)
                                prot_reg[reg] &= ~(1 << bit);
                        else
                                prot_reg[reg] |= (1 << bit);
@@ -348,16 +298,16 @@ static int pic32mx_protect(struct flash_bank_s *bank, int set, int first, int la
 #endif
 }
 
-static int pic32mx_write_block(struct flash_bank_s *bank, uint8_t *buffer, u32 offset, u32 count)
+static int pic32mx_write_block(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
 {
-       target_t *target = bank->target;
-       u32 buffer_size = 512;
-       working_area_t *source;
-       u32 address = bank->base + offset;
+       struct target *target = bank->target;
+       uint32_t buffer_size = 512;
+       struct working_area *source;
+       uint32_t address = bank->base + offset;
        int retval = ERROR_OK;
 #if 0
-       pic32mx_flash_bank_t *pic32mx_info = bank->driver_priv;
-       armv7m_algorithm_t armv7m_info;
+       struct pic32mx_flash_bank *pic32mx_info = bank->driver_priv;
+       struct armv7m_algorithm armv7m_info;
 
        uint8_t pic32mx_flash_write_code[] = {
                                                                        /* write: */
@@ -388,7 +338,7 @@ static int pic32mx_write_block(struct flash_bank_s *bank, uint8_t *buffer, u32 o
                return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
        };
 
-       if ((retval=target_write_buffer(target, pic32mx_info->write_algorithm->address, sizeof(pic32mx_flash_write_code), pic32mx_flash_write_code))!=ERROR_OK)
+       if ((retval = target_write_buffer(target, pic32mx_info->write_algorithm->address, sizeof(pic32mx_flash_write_code), pic32mx_flash_write_code)) != ERROR_OK)
                return retval;
 #endif
 
@@ -407,10 +357,10 @@ static int pic32mx_write_block(struct flash_bank_s *bank, uint8_t *buffer, u32 o
 
        while (count >= buffer_size/4)
        {
-               u32 status;
+               uint32_t status;
 
-               if ((retval = target_write_buffer(target, source->address, buffer_size, buffer))!=ERROR_OK) {
-                       LOG_ERROR("Failed to write row buffer (%d words) to RAM", buffer_size/4);
+               if ((retval = target_write_buffer(target, source->address, buffer_size, buffer)) != ERROR_OK) {
+                       LOG_ERROR("Failed to write row buffer (%d words) to RAM", (int)(buffer_size/4));
                        break;
                }
 
@@ -434,13 +384,13 @@ static int pic32mx_write_block(struct flash_bank_s *bank, uint8_t *buffer, u32 o
                }
 #endif
                status = pic32mx_write_row(bank, address, source->address);
-               if( status & NVMCON_NVMERR ) {
-                       LOG_ERROR("Flash write error NVMERR (status=0x%08x)", status);
+               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 ) {
-                       LOG_ERROR("Flash write error LVDERR (status=0x%08x)", status);
+               if (status & NVMCON_LVDERR) {
+                       LOG_ERROR("Flash write error LVDERR (status = 0x%08" PRIx32 ")", status);
                        retval = ERROR_FLASH_OPERATION_FAILED;
                        break;
                }
@@ -452,19 +402,19 @@ static int pic32mx_write_block(struct flash_bank_s *bank, uint8_t *buffer, u32 o
 
        target_free_working_area(target, source);
 
-       while(count > 0)
+       while (count > 0)
        {
-               u32 value;
-               memcpy(&value, buffer, sizeof(u32));
+               uint32_t value;
+               memcpy(&value, buffer, sizeof(uint32_t));
 
-               u32 status = pic32mx_write_word(bank, address, value);
-               if( status & NVMCON_NVMERR ) {
-                       LOG_ERROR("Flash write error NVMERR (status=0x%08x)", status);
+               uint32_t status = pic32mx_write_word(bank, address, value);
+               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 ) {
-                       LOG_ERROR("Flash write error LVDERR (status=0x%08x)", status);
+               if (status & NVMCON_LVDERR) {
+                       LOG_ERROR("Flash write error LVDERR (status = 0x%08" PRIx32 ")", status);
                        retval = ERROR_FLASH_OPERATION_FAILED;
                        break;
                }
@@ -477,11 +427,11 @@ static int pic32mx_write_block(struct flash_bank_s *bank, uint8_t *buffer, u32 o
        return retval;
 }
 
-static int pic32mx_write_word(struct flash_bank_s *bank, u32 address, u32 word)
+static int pic32mx_write_word(struct flash_bank *bank, uint32_t address, uint32_t word)
 {
-       target_t *target = bank->target;
+       struct target *target = bank->target;
 
-       if(bank->base >= PIC32MX_KSEG1_PGM_FLASH)
+       if (bank->base >= PIC32MX_KSEG1_PGM_FLASH)
                target_write_u32(target, PIC32MX_NVMADDR, KS1Virt2Phys(address));
        else
                target_write_u32(target, PIC32MX_NVMADDR, KS0Virt2Phys(address));
@@ -493,17 +443,17 @@ static int pic32mx_write_word(struct flash_bank_s *bank, u32 address, u32 word)
 /*
  * Write a 128 word (512 byte) row to flash address from RAM srcaddr.
  */
-static int pic32mx_write_row(struct flash_bank_s *bank, u32 address, u32 srcaddr)
+static int pic32mx_write_row(struct flash_bank *bank, uint32_t address, uint32_t srcaddr)
 {
-       target_t *target = bank->target;
+       struct target *target = bank->target;
 
-       LOG_DEBUG("addr: 0x%08x srcaddr: 0x%08x", address, srcaddr);
+       LOG_DEBUG("addr: 0x%08" PRIx32 " srcaddr: 0x%08" PRIx32 "", address, srcaddr);
 
-       if(address >= PIC32MX_KSEG1_PGM_FLASH)
+       if (address >= PIC32MX_KSEG1_PGM_FLASH)
                target_write_u32(target, PIC32MX_NVMADDR,    KS1Virt2Phys(address));
        else
                target_write_u32(target, PIC32MX_NVMADDR,    KS0Virt2Phys(address));
-       if(srcaddr >= PIC32MX_KSEG1_RAM)
+       if (srcaddr >= PIC32MX_KSEG1_RAM)
                target_write_u32(target, PIC32MX_NVMSRCADDR, KS1Virt2Phys(srcaddr));
        else
                target_write_u32(target, PIC32MX_NVMSRCADDR, KS0Virt2Phys(srcaddr));
@@ -511,13 +461,13 @@ static int pic32mx_write_row(struct flash_bank_s *bank, u32 address, u32 srcaddr
        return pic32mx_nvm_exec(bank, NVMCON_OP_ROW_PROG, 100);
 }
 
-static int pic32mx_write(struct flash_bank_s *bank, uint8_t *buffer, u32 offset, u32 count)
+static int pic32mx_write(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count)
 {
-       u32 words_remaining = (count / 4);
-       u32 bytes_remaining = (count & 0x00000003);
-       u32 address = bank->base + offset;
-       u32 bytes_written = 0;
-       u32 status;
+       uint32_t words_remaining = (count / 4);
+       uint32_t bytes_remaining = (count & 0x00000003);
+       uint32_t address = bank->base + offset;
+       uint32_t bytes_written = 0;
+       uint32_t status;
        int retval;
 
        if (bank->target->state != TARGET_HALTED)
@@ -528,7 +478,7 @@ static int pic32mx_write(struct flash_bank_s *bank, uint8_t *buffer, u32 offset,
 
        if (offset & 0x3)
        {
-               LOG_WARNING("offset 0x%breaks required 4-byte alignment", offset);
+               LOG_WARNING("offset 0x%" PRIx32 "breaks required 4-byte alignment", offset);
                return ERROR_FLASH_DST_BREAKS_ALIGNMENT;
        }
 
@@ -560,13 +510,13 @@ static int pic32mx_write(struct flash_bank_s *bank, uint8_t *buffer, u32 offset,
 
        while (words_remaining > 0)
        {
-               u32 value;
-               memcpy(&value, buffer + bytes_written, sizeof(u32));
+               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)
                        return ERROR_FLASH_OPERATION_FAILED;
-               if( status & NVMCON_LVDERR )
+               if (status & NVMCON_LVDERR)
                        return ERROR_FLASH_OPERATION_FAILED;
 
                bytes_written += 4;
@@ -576,53 +526,57 @@ static int pic32mx_write(struct flash_bank_s *bank, uint8_t *buffer, u32 offset,
 
        if (bytes_remaining)
        {
-               u32 value = 0xffffffff;
+               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)
                        return ERROR_FLASH_OPERATION_FAILED;
-               if( status & NVMCON_LVDERR )
+               if (status & NVMCON_LVDERR)
                        return ERROR_FLASH_OPERATION_FAILED;
        }
 
        return ERROR_OK;
 }
 
-static int pic32mx_probe(struct flash_bank_s *bank)
+static int pic32mx_probe(struct flash_bank *bank)
 {
-       target_t *target = bank->target;
-       pic32mx_flash_bank_t *pic32mx_info = bank->driver_priv;
-       mips32_common_t *mips32 = target->arch_info;
-       mips_ejtag_t *ejtag_info = &mips32->ejtag_info;
+       struct target *target = bank->target;
+       struct pic32mx_flash_bank *pic32mx_info = bank->driver_priv;
+       struct mips32_common *mips32 = target->arch_info;
+       struct mips_ejtag *ejtag_info = &mips32->ejtag_info;
        int i;
-       u16 num_pages = 0;
-       u32 device_id;
+       uint16_t num_pages = 0;
+       uint32_t device_id;
        int page_size;
 
        pic32mx_info->probed = 0;
 
        device_id = ejtag_info->idcode;
-       LOG_INFO( "device id = 0x%08x (manuf 0x%03x dev 0x%02x, ver 0x%03x)", device_id, (device_id>>1)&0x7ff, (device_id>>12)&0xff, (device_id>>20)&0xfff );
-
-       if(((device_id>>1)&0x7ff) != PIC32MX_MANUF_ID) {
-               LOG_WARNING( "Cannot identify target as a PIC32MX family." );
+       LOG_INFO("device id = 0x%08" PRIx32 " (manuf 0x%03x dev 0x%02x, ver 0x%03x)",
+                         device_id,
+                         (unsigned)((device_id >> 1)&0x7ff),
+                         (unsigned)((device_id >> 12)&0xff),
+                         (unsigned)((device_id >> 20)&0xfff));
+
+       if (((device_id >> 1)&0x7ff) != PIC32MX_MANUF_ID) {
+               LOG_WARNING("Cannot identify target as a PIC32MX family.");
                return ERROR_FLASH_OPERATION_FAILED;
        }
 
        page_size = 4096;
-       if(bank->base == PIC32MX_KSEG1_BOOT_FLASH || bank->base == 1) {
+       if (bank->base == PIC32MX_KSEG1_BOOT_FLASH || bank->base == 1) {
                /* 0xBFC00000: Boot flash size fixed at 12k */
                num_pages = 12;
        } else {
                /* 0xBD000000: Program flash size varies with device */
-               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 >> 12) & 0xff)) {
                                num_pages = pic32mx_devs[i].pfm_size;
                                break;
                        }
-               if(pic32mx_devs[i].name == NULL) {
-                       LOG_WARNING( "Cannot identify target as a PIC32MX family." );
+               if (pic32mx_devs[i].name == NULL) {
+                       LOG_WARNING("Cannot identify target as a PIC32MX family.");
                        return ERROR_FLASH_OPERATION_FAILED;
                }
        }
@@ -642,18 +596,18 @@ static int pic32mx_probe(struct flash_bank_s *bank)
        }
 #endif
 
-       LOG_INFO( "flash size = %dkbytes", num_pages );
+       LOG_INFO("flash size = %dkbytes", num_pages);
 
        /* calculate numbers of pages */
        num_pages /= (page_size / 1024);
 
-       if(bank->base == 0) bank->base = PIC32MX_KSEG1_PGM_FLASH;
-       if(bank->base == 1) bank->base = PIC32MX_KSEG1_BOOT_FLASH;
+       if (bank->base == 0) bank->base = PIC32MX_KSEG1_PGM_FLASH;
+       if (bank->base == 1) bank->base = PIC32MX_KSEG1_BOOT_FLASH;
        bank->size = (num_pages * page_size);
        bank->num_sectors = num_pages;
        bank->chip_width = 4;
        bank->bus_width  = 4;
-       bank->sectors = malloc(sizeof(flash_sector_t) * num_pages);
+       bank->sectors = malloc(sizeof(struct flash_sector) * num_pages);
 
        for (i = 0; i < num_pages; i++)
        {
@@ -668,70 +622,71 @@ static int pic32mx_probe(struct flash_bank_s *bank)
        return ERROR_OK;
 }
 
-static int pic32mx_auto_probe(struct flash_bank_s *bank)
+static int pic32mx_auto_probe(struct flash_bank *bank)
 {
-       pic32mx_flash_bank_t *pic32mx_info = bank->driver_priv;
+       struct pic32mx_flash_bank *pic32mx_info = bank->driver_priv;
        if (pic32mx_info->probed)
                return ERROR_OK;
        return pic32mx_probe(bank);
 }
 
 #if 0
-static int pic32mx_handle_part_id_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(pic32mx_handle_part_id_command)
 {
        return ERROR_OK;
 }
 #endif
 
-static int pic32mx_info(struct flash_bank_s *bank, char *buf, int buf_size)
+static int pic32mx_info(struct flash_bank *bank, char *buf, int buf_size)
 {
-       target_t *target = bank->target;
-       mips32_common_t *mips32 = target->arch_info;
-       mips_ejtag_t *ejtag_info = &mips32->ejtag_info;
-       u32 device_id;
+       struct target *target = bank->target;
+       struct mips32_common *mips32 = target->arch_info;
+       struct mips_ejtag *ejtag_info = &mips32->ejtag_info;
+       uint32_t device_id;
        int printed = 0, i;
 
        device_id = ejtag_info->idcode;
 
-       if(((device_id>>1)&0x7ff) != PIC32MX_MANUF_ID) {
-               snprintf(buf, buf_size, "Cannot identify target as a PIC32MX family (manufacturer 0x%03d != 0x%03d)\n", (device_id>>1)&0x7ff, PIC32MX_MANUF_ID);
+       if (((device_id >> 1)&0x7ff) != PIC32MX_MANUF_ID) {
+               snprintf(buf, buf_size,
+                                "Cannot identify target as a PIC32MX family (manufacturer 0x%03d != 0x%03d)\n",
+                                (unsigned)((device_id >> 1)&0x7ff),
+                                PIC32MX_MANUF_ID);
                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 >> 12) & 0xff)) {
                        printed = snprintf(buf, buf_size, "PIC32MX%s", pic32mx_devs[i].name);
                        break;
                }
-       if(pic32mx_devs[i].name == NULL) {
+       if (pic32mx_devs[i].name == NULL) {
                snprintf(buf, buf_size, "Cannot identify target as a PIC32MX family\n");
                return ERROR_FLASH_OPERATION_FAILED;
        }
        buf += printed;
        buf_size -= printed;
-       printed = snprintf(buf, buf_size, "  Ver: 0x%03x", (device_id>>20)&0xfff);
+       printed = snprintf(buf, buf_size, "  Ver: 0x%03x",
+                                          (unsigned)((device_id >> 20)&0xfff));
 
        return ERROR_OK;
 }
 
 #if 0
-int pic32mx_handle_lock_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(pic32mx_handle_lock_command)
 {
-       flash_bank_t *bank;
-       target_t *target = NULL;
-       pic32mx_flash_bank_t *pic32mx_info = NULL;
+       struct target *target = NULL;
+       struct pic32mx_flash_bank *pic32mx_info = NULL;
 
-       if (argc < 1)
+       if (CMD_ARGC < 1)
        {
                command_print(cmd_ctx, "pic32mx lock <bank>");
                return ERROR_OK;
        }
 
-       bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
-       if (!bank)
-       {
-               command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
-               return ERROR_OK;
-       }
+       struct flash_bank *bank;
+       int retval = CALL_COMMAND_HANDLER(flash_command_get_bank_by_num, 0, &bank);
+       if (ERROR_OK != retval)
+               return retval;
 
        pic32mx_info = bank->driver_priv;
 
@@ -763,24 +718,21 @@ int pic32mx_handle_lock_command(struct command_context_s *cmd_ctx, char *cmd, ch
        return ERROR_OK;
 }
 
-int pic32mx_handle_unlock_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(pic32mx_handle_unlock_command)
 {
-       flash_bank_t *bank;
-       target_t *target = NULL;
-       pic32mx_flash_bank_t *pic32mx_info = NULL;
+       struct target *target = NULL;
+       struct pic32mx_flash_bank *pic32mx_info = NULL;
 
-       if (argc < 1)
+       if (CMD_ARGC < 1)
        {
                command_print(cmd_ctx, "pic32mx unlock <bank>");
                return ERROR_OK;
        }
 
-       bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
-       if (!bank)
-       {
-               command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
-               return ERROR_OK;
-       }
+       struct flash_bank *bank;
+       int retval = CALL_COMMAND_HANDLER(flash_command_get_bank_by_num, 0, &bank);
+       if (ERROR_OK != retval)
+               return retval;
 
        pic32mx_info = bank->driver_priv;
 
@@ -811,11 +763,11 @@ int pic32mx_handle_unlock_command(struct command_context_s *cmd_ctx, char *cmd,
 #endif
 
 #if 0
-static int pic32mx_chip_erase(struct flash_bank_s *bank)
+static int pic32mx_chip_erase(struct flash_bank *bank)
 {
-       target_t *target = bank->target;
+       struct target *target = bank->target;
 #if 0
-       u32 status;
+       uint32_t status;
 #endif
 
        if (target->state != TARGET_HALTED)
@@ -833,19 +785,19 @@ static int pic32mx_chip_erase(struct flash_bank_s *bank)
 
        /* chip erase flash memory */
        target_write_u32(target, PIC32MX_FLASH_CR, FLASH_MER);
-       target_write_u32(target, PIC32MX_FLASH_CR, FLASH_MER|FLASH_STRT);
+       target_write_u32(target, PIC32MX_FLASH_CR, FLASH_MER | FLASH_STRT);
 
        status = pic32mx_wait_status_busy(bank, 10);
 
        target_write_u32(target, PIC32MX_FLASH_CR, FLASH_LOCK);
 
-       if( status & FLASH_WRPRTERR )
+       if (status & FLASH_WRPRTERR)
        {
                LOG_ERROR("pic32mx device protected");
                return ERROR_OK;
        }
 
-       if( status & FLASH_PGERR )
+       if (status & FLASH_PGERR)
        {
                LOG_ERROR("pic32mx device programming failed");
                return ERROR_OK;
@@ -856,24 +808,21 @@ static int pic32mx_chip_erase(struct flash_bank_s *bank)
 }
 #endif
 
-static int pic32mx_handle_chip_erase_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(pic32mx_handle_chip_erase_command)
 {
 #if 0
-       flash_bank_t *bank;
        int i;
 
-       if (argc != 0)
+       if (CMD_ARGC != 0)
        {
                command_print(cmd_ctx, "pic32mx chip_erase");
                return ERROR_OK;
        }
 
-       bank = get_flash_bank_by_num(strtoul(args[0], NULL, 0));
-       if (!bank)
-       {
-               command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[0]);
-               return ERROR_OK;
-       }
+       struct flash_bank *bank;
+       int retval = CALL_COMMAND_HANDLER(flash_command_get_bank_by_num, 0, &bank);
+       if (ERROR_OK != retval)
+               return retval;
 
        if (pic32mx_chip_erase(bank) == ERROR_OK)
        {
@@ -894,44 +843,77 @@ static int pic32mx_handle_chip_erase_command(struct command_context_s *cmd_ctx,
        return ERROR_OK;
 }
 
-static int pic32mx_handle_pgm_word_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
+COMMAND_HANDLER(pic32mx_handle_pgm_word_command)
 {
-       flash_bank_t *bank;
-       u32 address, value;
+       uint32_t address, value;
        int status, res;
 
-       if (argc != 3)
+       if (CMD_ARGC != 3)
        {
                command_print(cmd_ctx, "pic32mx pgm_word <addr> <value> <bank>");
                return ERROR_OK;
        }
 
-       address = strtoul(args[0], NULL, 0);
-       value   = strtoul(args[1], NULL, 0);
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[0], address);
+       COMMAND_PARSE_NUMBER(u32, CMD_ARGV[1], value);
 
-       bank = get_flash_bank_by_num(strtoul(args[2], NULL, 0));
-       if (!bank)
-       {
-               command_print(cmd_ctx, "flash bank '#%s' is out of bounds", args[2]);
-               return ERROR_OK;
-       }
-       if (address < bank->base || address >= (bank->base+bank->size))
+       struct flash_bank *bank;
+       int retval = CALL_COMMAND_HANDLER(flash_command_get_bank_by_num, 2, &bank);
+       if (ERROR_OK != retval)
+               return retval;
+
+       if (address < bank->base || address >= (bank->base + bank->size))
        {
-               command_print(cmd_ctx, "flash address '%s' is out of bounds", args[0]);
+               command_print(cmd_ctx, "flash address '%s' is out of bounds", CMD_ARGV[0]);
                return ERROR_OK;
        }
 
        res = ERROR_OK;
        status = pic32mx_write_word(bank, address, value);
-       if( status & NVMCON_NVMERR )
+       if (status & NVMCON_NVMERR)
                res = ERROR_FLASH_OPERATION_FAILED;
-       if( status & NVMCON_LVDERR )
+       if (status & NVMCON_LVDERR)
                res = ERROR_FLASH_OPERATION_FAILED;
 
        if (res == ERROR_OK)
                command_print(cmd_ctx, "pic32mx pgm word complete");
        else
-               command_print(cmd_ctx, "pic32mx pgm word failed (status=0x%x)", status);
+               command_print(cmd_ctx, "pic32mx pgm word failed (status = 0x%x)", status);
+
+       return ERROR_OK;
+}
 
+static int pic32mx_register_commands(struct command_context *cmd_ctx)
+{
+       struct command *pic32mx_cmd = register_command(cmd_ctx, NULL, "pic32mx",
+                       NULL, COMMAND_ANY, "pic32mx flash specific commands");
+#if 0
+       register_command(cmd_ctx, pic32mx_cmd, "lock",
+                       pic32mx_handle_lock_command, COMMAND_EXEC,
+                       "lock device");
+       register_command(cmd_ctx, pic32mx_cmd, "unlock",
+                       pic32mx_handle_unlock_command, COMMAND_EXEC,
+                       "unlock protected device");
+#endif
+       register_command(cmd_ctx, pic32mx_cmd, "chip_erase",
+                       pic32mx_handle_chip_erase_command, COMMAND_EXEC,
+                       "erase device");
+       register_command(cmd_ctx, pic32mx_cmd, "pgm_word",
+                       pic32mx_handle_pgm_word_command, COMMAND_EXEC,
+                       "program a word");
        return ERROR_OK;
 }
+
+struct flash_driver pic32mx_flash = {
+               .name = "pic32mx",
+               .register_commands = &pic32mx_register_commands,
+               .flash_bank_command = &pic32mx_flash_bank_command,
+               .erase = &pic32mx_erase,
+               .protect = &pic32mx_protect,
+               .write = &pic32mx_write,
+               .probe = &pic32mx_probe,
+               .auto_probe = &pic32mx_auto_probe,
+               .erase_check = &default_flash_mem_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)