pic32mx.c File Reference

Include dependency graph for pic32mx.c:

Go to the source code of this file.

Data Structures
struct	pic32mx_devs_s
struct	pic32mx_flash_bank

Macros
#define	MX_17X_27X   2 /* PIC32mx17x/27x */
#define	MX_1XX_2XX   1 /* PIC32mx1xx/2xx */
#define	NVMCON_LVDERR   (1 << 12)
#define	NVMCON_LVDSTAT   (1 << 11)
#define	NVMCON_NVMERR   (1 << 13)
#define	NVMCON_NVMWR   (1 << 15)
#define	NVMCON_NVMWREN   (1 << 14)
#define	NVMCON_OP_NOP   0x0
#define	NVMCON_OP_PAGE_ERASE   0x4
#define	NVMCON_OP_PFM_ERASE   0x5
#define	NVMCON_OP_ROW_PROG   0x3
#define	NVMCON_OP_WORD_PROG   0x1
#define	NVMKEY1   0xAA996655
#define	NVMKEY2   0x556699AA
#define	PIC32MX_BMXBOOTSZ   0xBF882070
#define	PIC32MX_BMXDRMSZ   0xBF882040
#define	PIC32MX_BMXPFMSZ   0xBF882060
#define	PIC32MX_DEVCFG0   0xBFC02FFC
#define	PIC32MX_DEVCFG0_1XX_2XX   0xBFC00BFC
#define	PIC32MX_DEVCFG1   0xBFC02FF8
#define	PIC32MX_DEVCFG2   0xBFC02FF4
#define	PIC32MX_DEVCFG3   0xBFC02FF0
#define	PIC32MX_DEVID   0xBF80F220
#define	PIC32MX_MANUF_ID   0x029
#define	PIC32MX_NVMADDR   0xBF80F420
#define	PIC32MX_NVMADDRCLR   0xBF80F424
#define	PIC32MX_NVMADDRINV   0xBF80F42C
#define	PIC32MX_NVMADDRSET   0xBF80F428
#define	PIC32MX_NVMCON   0xBF80F400
#define	PIC32MX_NVMCONCLR   0xBF80F404
#define	PIC32MX_NVMCONINV   0xBF80F40C
#define	PIC32MX_NVMCONSET   0xBF80F408
#define	PIC32MX_NVMDATA   0xBF80F430
#define	PIC32MX_NVMKEY   0xBF80F410
#define	PIC32MX_NVMSRCADDR   0xBF80F440
#define	PIC32MX_PHYS_BOOT_FLASH   0x1FC00000
#define	PIC32MX_PHYS_PERIPHERALS   0x1F800000
#define	PIC32MX_PHYS_PGM_FLASH   0x1D000000
#define	PIC32MX_PHYS_RAM   0x00000000
#define	virt2phys(v)   ((v) & 0x1FFFFFFF)

Functions
	COMMAND_HANDLER (pic32mx_handle_pgm_word_command)
	COMMAND_HANDLER (pic32mx_handle_unlock_command)
	FLASH_BANK_COMMAND_HANDLER (pic32mx_flash_bank_command)
static int	pic32mx_auto_probe (struct flash_bank *bank)
static int	pic32mx_erase (struct flash_bank *bank, unsigned int first, unsigned int last)
static uint32_t	pic32mx_get_flash_status (struct flash_bank *bank)
static int	pic32mx_info (struct flash_bank *bank, struct command_invocation *cmd)
static int	pic32mx_nvm_exec (struct flash_bank *bank, uint32_t op, uint32_t timeout)
static int	pic32mx_probe (struct flash_bank *bank)
static int	pic32mx_protect (struct flash_bank *bank, int set, unsigned int first, unsigned int last)
static int	pic32mx_protect_check (struct flash_bank *bank)
static uint32_t	pic32mx_wait_status_busy (struct flash_bank *bank, int timeout)
static int	pic32mx_write (struct flash_bank *bank, const uint8_t *buffer, uint32_t offset, uint32_t count)
static int	pic32mx_write_block (struct flash_bank *bank, const uint8_t *buffer, uint32_t offset, uint32_t count)
static int	pic32mx_write_word (struct flash_bank *bank, uint32_t address, uint32_t word)

Variables
static const struct command_registration	pic32mx_command_handlers []
static const struct pic32mx_devs_s	pic32mx_devs []
static const struct command_registration	pic32mx_exec_command_handlers []
const struct flash_driver	pic32mx_flash
static uint32_t	pic32mx_flash_write_code []

Macro Definition Documentation

MX_17X_27X

#define MX_17X_27X   2 /* PIC32mx17x/27x */

Definition at line 84 of file pic32mx.c.

MX_1XX_2XX

#define MX_1XX_2XX   1 /* PIC32mx1xx/2xx */

Definition at line 83 of file pic32mx.c.

NVMCON_LVDERR

#define NVMCON_LVDERR   (1 << 12)

Definition at line 62 of file pic32mx.c.

NVMCON_LVDSTAT

#define NVMCON_LVDSTAT   (1 << 11)

Definition at line 63 of file pic32mx.c.

NVMCON_NVMERR

#define NVMCON_NVMERR   (1 << 13)

Definition at line 61 of file pic32mx.c.

NVMCON_NVMWR

#define NVMCON_NVMWR   (1 << 15)

Definition at line 59 of file pic32mx.c.

NVMCON_NVMWREN

#define NVMCON_NVMWREN   (1 << 14)

Definition at line 60 of file pic32mx.c.

NVMCON_OP_NOP

#define NVMCON_OP_NOP   0x0

Definition at line 68 of file pic32mx.c.

NVMCON_OP_PAGE_ERASE

#define NVMCON_OP_PAGE_ERASE   0x4

Definition at line 65 of file pic32mx.c.

NVMCON_OP_PFM_ERASE

#define NVMCON_OP_PFM_ERASE   0x5

Definition at line 64 of file pic32mx.c.

NVMCON_OP_ROW_PROG

#define NVMCON_OP_ROW_PROG   0x3

Definition at line 66 of file pic32mx.c.

NVMCON_OP_WORD_PROG

#define NVMCON_OP_WORD_PROG   0x1

Definition at line 67 of file pic32mx.c.

NVMKEY1

#define NVMKEY1   0xAA996655

Definition at line 80 of file pic32mx.c.

NVMKEY2

#define NVMKEY2   0x556699AA

Definition at line 81 of file pic32mx.c.

PIC32MX_BMXBOOTSZ

#define PIC32MX_BMXBOOTSZ   0xBF882070

Definition at line 50 of file pic32mx.c.

PIC32MX_BMXDRMSZ

#define PIC32MX_BMXDRMSZ   0xBF882040

Definition at line 51 of file pic32mx.c.

PIC32MX_BMXPFMSZ

#define PIC32MX_BMXPFMSZ   0xBF882060

Definition at line 49 of file pic32mx.c.

PIC32MX_DEVCFG0

#define PIC32MX_DEVCFG0   0xBFC02FFC

Definition at line 43 of file pic32mx.c.

PIC32MX_DEVCFG0_1XX_2XX

#define PIC32MX_DEVCFG0_1XX_2XX   0xBFC00BFC

Definition at line 42 of file pic32mx.c.

PIC32MX_DEVCFG1

#define PIC32MX_DEVCFG1   0xBFC02FF8

Definition at line 44 of file pic32mx.c.

PIC32MX_DEVCFG2

#define PIC32MX_DEVCFG2   0xBFC02FF4

Definition at line 45 of file pic32mx.c.

PIC32MX_DEVCFG3

#define PIC32MX_DEVCFG3   0xBFC02FF0

Definition at line 46 of file pic32mx.c.

PIC32MX_DEVID

#define PIC32MX_DEVID   0xBF80F220

Definition at line 47 of file pic32mx.c.

PIC32MX_MANUF_ID

#define PIC32MX_MANUF_ID   0x029

Definition at line 24 of file pic32mx.c.

PIC32MX_NVMADDR

#define PIC32MX_NVMADDR   0xBF80F420

Definition at line 71 of file pic32mx.c.

PIC32MX_NVMADDRCLR

#define PIC32MX_NVMADDRCLR   0xBF80F424

Definition at line 72 of file pic32mx.c.

PIC32MX_NVMADDRINV

#define PIC32MX_NVMADDRINV   0xBF80F42C

Definition at line 74 of file pic32mx.c.

PIC32MX_NVMADDRSET

#define PIC32MX_NVMADDRSET   0xBF80F428

Definition at line 73 of file pic32mx.c.

PIC32MX_NVMCON

#define PIC32MX_NVMCON   0xBF80F400

Definition at line 55 of file pic32mx.c.

PIC32MX_NVMCONCLR

#define PIC32MX_NVMCONCLR   0xBF80F404

Definition at line 56 of file pic32mx.c.

PIC32MX_NVMCONINV

#define PIC32MX_NVMCONINV   0xBF80F40C

Definition at line 58 of file pic32mx.c.

PIC32MX_NVMCONSET

#define PIC32MX_NVMCONSET   0xBF80F408

Definition at line 57 of file pic32mx.c.

PIC32MX_NVMDATA

#define PIC32MX_NVMDATA   0xBF80F430

Definition at line 75 of file pic32mx.c.

PIC32MX_NVMKEY

#define PIC32MX_NVMKEY   0xBF80F410

Definition at line 70 of file pic32mx.c.

PIC32MX_NVMSRCADDR

#define PIC32MX_NVMSRCADDR   0xBF80F440

Definition at line 76 of file pic32mx.c.

PIC32MX_PHYS_BOOT_FLASH

#define PIC32MX_PHYS_BOOT_FLASH   0x1FC00000

Definition at line 31 of file pic32mx.c.

PIC32MX_PHYS_PERIPHERALS

#define PIC32MX_PHYS_PERIPHERALS   0x1F800000

Definition at line 30 of file pic32mx.c.

PIC32MX_PHYS_PGM_FLASH

#define PIC32MX_PHYS_PGM_FLASH   0x1D000000

Definition at line 29 of file pic32mx.c.

PIC32MX_PHYS_RAM

#define PIC32MX_PHYS_RAM   0x00000000

Definition at line 28 of file pic32mx.c.

virt2phys

#define virt2phys

(

v

)

((v) & 0x1FFFFFFF)

Definition at line 38 of file pic32mx.c.

Function Documentation

COMMAND_HANDLER() [1/2]

COMMAND_HANDLER

(

pic32mx_handle_pgm_word_command

)

Definition at line 826 of file pic32mx.c.

References bank, flash_bank::base, CALL_COMMAND_HANDLER, CMD, CMD_ARGC, CMD_ARGV, COMMAND_PARSE_NUMBER, command_print(), ERROR_COMMAND_SYNTAX_ERROR, ERROR_FLASH_OPERATION_FAILED, ERROR_OK, NVMCON_LVDERR, NVMCON_NVMERR, pic32mx_write_word(), and status.

COMMAND_HANDLER() [2/2]

COMMAND_HANDLER

(

pic32mx_handle_unlock_command

)

Definition at line 862 of file pic32mx.c.

References alive_sleep(), bank, CALL_COMMAND_HANDLER, CMD, CMD_ARGC, command_print(), mips32_common::ejtag_info, ERROR_COMMAND_SYNTAX_ERROR, ERROR_OK, jtag_add_sleep(), LOG_DEBUG, MCHP_ASERT_RST, MCHP_DE_ASSERT_RST, MCHP_ERASE, MCHP_STATUS, mips_m4k_common::mips32, mips_ejtag_drscan_8(), mips_ejtag_drscan_8_out(), mips_ejtag_set_instr(), MTAP_COMMAND, MTAP_SW_ETAP, MTAP_SW_MTAP, NULL, and target_to_m4k().

FLASH_BANK_COMMAND_HANDLER()

FLASH_BANK_COMMAND_HANDLER

(

pic32mx_flash_bank_command

)

Definition at line 193 of file pic32mx.c.

References bank, CMD_ARGC, ERROR_COMMAND_SYNTAX_ERROR, ERROR_OK, and pic32mx_info().

pic32mx_auto_probe()

static int pic32mx_auto_probe ( struct flash_bank *  bank )

static

Definition at line 784 of file pic32mx.c.

References bank, ERROR_OK, pic32mx_info(), and pic32mx_probe().

pic32mx_erase()

static int pic32mx_erase ( struct flash_bank *  bank, unsigned int  first, unsigned int  last  )

static

Definition at line 312 of file pic32mx.c.

References bank, ERROR_FLASH_OPERATION_FAILED, ERROR_OK, ERROR_TARGET_NOT_HALTED, LOG_DEBUG, LOG_ERROR, NVMCON_LVDERR, NVMCON_NVMERR, NVMCON_OP_PAGE_ERASE, NVMCON_OP_PFM_ERASE, pic32mx_nvm_exec(), PIC32MX_NVMADDR, PIC32MX_PHYS_PGM_FLASH, status, TARGET_HALTED, target_write_u32(), and virt2phys.

pic32mx_get_flash_status()

static uint32_t pic32mx_get_flash_status ( struct flash_bank *  bank )

static

Definition at line 209 of file pic32mx.c.

References bank, PIC32MX_NVMCON, status, and target_read_u32().

Referenced by pic32mx_wait_status_busy().

pic32mx_info()

static int pic32mx_info ( struct flash_bank *  bank, struct command_invocation *  cmd  )

static

Definition at line 792 of file pic32mx.c.

References target::arch_info, bank, cmd, command_print_sameline(), mips32_common::ejtag_info, ERROR_FLASH_OPERATION_FAILED, ERROR_OK, mips_ejtag::idcode, pic32mx_devs_s::name, name, pic32mx_devs, and PIC32MX_MANUF_ID.

Referenced by FLASH_BANK_COMMAND_HANDLER(), pic32mx_auto_probe(), pic32mx_probe(), pic32mx_protect_check(), and pic32mx_write_block().

pic32mx_nvm_exec()

static int pic32mx_nvm_exec ( struct flash_bank *  bank, uint32_t  op, uint32_t  timeout  )

static

Definition at line 234 of file pic32mx.c.

References bank, NVMCON_NVMWR, NVMCON_NVMWREN, NVMKEY1, NVMKEY2, op, PIC32MX_NVMCON, PIC32MX_NVMCONCLR, PIC32MX_NVMCONSET, PIC32MX_NVMKEY, pic32mx_wait_status_busy(), status, and target_write_u32().

Referenced by pic32mx_erase(), and pic32mx_write_word().

pic32mx_probe()

static int pic32mx_probe ( struct flash_bank *  bank )

static

Definition at line 679 of file pic32mx.c.

References target::arch_info, bank, mips32_common::ejtag_info, ERROR_FLASH_OPERATION_FAILED, ERROR_OK, mips_ejtag::idcode, LOG_INFO, LOG_WARNING, MX_17X_27X, MX_1XX_2XX, pic32mx_devs_s::name, name, PIC32MX_BMXBOOTSZ, PIC32MX_BMXPFMSZ, pic32mx_devs, pic32mx_info(), PIC32MX_MANUF_ID, PIC32MX_PHYS_BOOT_FLASH, target_read_u32(), and virt2phys.

Referenced by pic32mx_auto_probe().

pic32mx_protect()

static int pic32mx_protect ( struct flash_bank *  bank, int  set, unsigned int  first, unsigned int  last  )

static

Definition at line 350 of file pic32mx.c.

References bank, ERROR_OK, ERROR_TARGET_NOT_HALTED, LOG_ERROR, target::state, and TARGET_HALTED.

pic32mx_protect_check()

static int pic32mx_protect_check ( struct flash_bank *  bank )

static

Definition at line 256 of file pic32mx.c.

References bank, ERROR_OK, ERROR_TARGET_NOT_HALTED, LOG_ERROR, MX_17X_27X, MX_1XX_2XX, PIC32MX_DEVCFG0, PIC32MX_DEVCFG0_1XX_2XX, pic32mx_info(), PIC32MX_PHYS_BOOT_FLASH, target::state, TARGET_HALTED, target_read_u32(), and virt2phys.

pic32mx_wait_status_busy()

static uint32_t pic32mx_wait_status_busy ( struct flash_bank *  bank, int  timeout  )

static

Definition at line 219 of file pic32mx.c.

References alive_sleep(), bank, LOG_DEBUG, NVMCON_NVMWR, pic32mx_get_flash_status(), and status.

Referenced by pic32mx_nvm_exec().

pic32mx_write()

static int pic32mx_write ( struct flash_bank *  bank, const uint8_t *  buffer, uint32_t  offset, uint32_t  count  )

static

Definition at line 596 of file pic32mx.c.

References bank, buffer, count, ERROR_FLASH_DST_BREAKS_ALIGNMENT, ERROR_FLASH_OPERATION_FAILED, ERROR_OK, ERROR_TARGET_NOT_HALTED, ERROR_TARGET_RESOURCE_NOT_AVAILABLE, LOG_DEBUG, LOG_ERROR, LOG_WARNING, NVMCON_LVDERR, NVMCON_NVMERR, offset, pic32mx_write_block(), pic32mx_write_word(), status, TARGET_ADDR_FMT, and TARGET_HALTED.

pic32mx_write_block()

static int pic32mx_write_block ( struct flash_bank *  bank, const uint8_t *  buffer, uint32_t  offset, uint32_t  count  )

static

Definition at line 432 of file pic32mx.c.

References working_area::address, ARRAY_SIZE, bank, buf_get_u32(), buf_set_u32(), buffer, mips32_algorithm::common_magic, count, destroy_reg_param(), ERROR_FAIL, ERROR_FLASH_OPERATION_FAILED, ERROR_OK, ERROR_TARGET_RESOURCE_NOT_AVAILABLE, init_reg_param(), mips32_algorithm::isa_mode, LOG_ERROR, LOG_WARNING, MIPS32_COMMON_MAGIC, MIPS32_ISA_MIPS32, MX_17X_27X, MX_1XX_2XX, NULL, NVMCON_LVDERR, NVMCON_NVMERR, offset, PARAM_IN_OUT, PARAM_OUT, pic32mx_flash_write_code, pic32mx_info(), source, status, target_alloc_working_area(), target_alloc_working_area_try(), target_buffer_set_u32_array(), target_free_working_area(), target_run_algorithm(), target_write_buffer(), and virt2phys.

Referenced by pic32mx_write().

pic32mx_write_word()

static int pic32mx_write_word ( struct flash_bank *  bank, uint32_t  address, uint32_t  word  )

static

Definition at line 586 of file pic32mx.c.

References bank, NVMCON_OP_WORD_PROG, pic32mx_nvm_exec(), PIC32MX_NVMADDR, PIC32MX_NVMDATA, target_write_u32(), and virt2phys.

Referenced by COMMAND_HANDLER(), and pic32mx_write().

Variable Documentation

pic32mx_command_handlers

const struct command_registration pic32mx_command_handlers[]

static

Initial value:

= {
    {
        .name = "pic32mx",
        .mode = COMMAND_ANY,
        .help = "pic32mx flash command group",
        .usage = "",
        .chain = pic32mx_exec_command_handlers,
    },
    COMMAND_REGISTRATION_DONE
}

Definition at line 862 of file pic32mx.c.

pic32mx_devs

const struct pic32mx_devs_s pic32mx_devs[]

static

Referenced by pic32mx_info(), and pic32mx_probe().

pic32mx_exec_command_handlers

const struct command_registration pic32mx_exec_command_handlers[]

static

Initial value:

= {
    {
        .name = "pgm_word",
        .usage = "<addr> <value> <bank>",
        .handler = pic32mx_handle_pgm_word_command,
        .mode = COMMAND_EXEC,
        .help = "program a word",
    },
    {
        .name = "unlock",
        .handler = pic32mx_handle_unlock_command,
        .mode = COMMAND_EXEC,
        .usage = "bank_id",
        .help = "Unlock/Erase entire device.",
    },
    COMMAND_REGISTRATION_DONE
}

Definition at line 862 of file pic32mx.c.

pic32mx_flash

const struct flash_driver pic32mx_flash

Initial value:

= {
    .name = "pic32mx",
    .commands = pic32mx_command_handlers,
    .flash_bank_command = pic32mx_flash_bank_command,
    .erase = pic32mx_erase,
    .protect = pic32mx_protect,
    .write = pic32mx_write,
    .read = default_flash_read,
    .probe = pic32mx_probe,
    .auto_probe = pic32mx_auto_probe,
    .erase_check = default_flash_blank_check,
    .protect_check = pic32mx_protect_check,
    .info = pic32mx_info,
    .free_driver_priv = default_flash_free_driver_priv,
}

Definition at line 862 of file pic32mx.c.

pic32mx_flash_write_code

uint32_t pic32mx_flash_write_code[]

static

Definition at line 365 of file pic32mx.c.

Referenced by pic32mx_write_block().