/* MSPDebug - debugging tool for MSP430 MCUs * Copyright (C) 2009-2012 Daniel Beer * Copyright (C) 2012-2015 Peter Bägel * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ /* jtag functions are taken from TIs SLAA149–September 2002 * * breakpoint implementation influenced by a posting of Ruisheng Lin * to Travis Goodspeed at 2012-09-20 found at: * http://sourceforge.net/p/goodfet/mailman/message/29860790/ * * * 2012-10-03 Peter Bägel (DF5EQ) * 2012-10-03 initial release Peter Bägel (DF5EQ) * 2014-12-26 jtag_single_step added Peter Bägel (DF5EQ) * 2015-02-21 jtag_set_breakpoint added Peter Bägel (DF5EQ) * jtag_cpu_state added */ #ifndef JTAGLIB_H_ #define JTAGLIB_H_ #include #include #include "device.h" #include "jtdev.h" #include "util.h" /* Colleciton of functions that need different implementation for different * CPU types (that is, 16-bit vs CPUX vs Xv2) */ struct jtaglib_funcs { unsigned int (*jlf_get_device)(struct jtdev *p); uint16_t (*jlf_read_mem)(struct jtdev *p, unsigned int format, address_t address); void (*jlf_read_mem_quick)(struct jtdev *p, address_t start_address, unsigned int word_count, uint16_t* data); void (*jlf_write_mem)(struct jtdev *p, unsigned int format, address_t address, uint16_t data); void (*jlf_write_mem_quick)(struct jtdev *p, address_t start_address, unsigned int word_count, const uint16_t* data); unsigned int (*jlf_execute_puc)(struct jtdev *p); void (*jlf_release_device)(struct jtdev *p, address_t address); int (*jlf_verify_mem)(struct jtdev *p, address_t start_address, unsigned int length, const uint16_t *data); int (*jlf_erase_check)(struct jtdev *p, address_t start_address, unsigned int length); void (*jlf_write_flash)(struct jtdev *p, address_t start_address, unsigned int word_count, const uint16_t *data); void (*jlf_erase_flash)(struct jtdev *p, unsigned int erase_mode, address_t erase_address); address_t (*jlf_read_reg)(struct jtdev *p, int reg); void (*jlf_write_reg)(struct jtdev *p, int reg, address_t value); void (*jlf_single_step)(struct jtdev *p); unsigned int (*jlf_set_breakpoint)(struct jtdev *p, int bp_num, address_t bp_addr); unsigned int (*jlf_cpu_state)(struct jtdev *p); int (*jlf_get_config_fuses)(struct jtdev *p); void (*jlf_context_save)(struct jtdev *p, bool after_puc); void (*jlf_context_restore)(struct jtdev *p); void (*jlf_regs_update)(struct jtdev *p); void (*jlf_regs_flush)(struct jtdev *p); }; extern const struct jtaglib_funcs jlf_cpu16; extern const struct jtaglib_funcs jlf_cpux; extern const struct jtaglib_funcs jlf_cpuxv2; /* Take target device under JTAG control. */ unsigned int jtag_init(struct jtdev *p); unsigned int jtag_get_device(struct jtdev *p); /* Read the target chip id. */ unsigned int jtag_chip_id(struct jtdev *p); /* Reads one byte/word from a given address */ uint16_t jtag_read_mem(struct jtdev *p, unsigned int format, address_t address); /* Reads an array of words from target memory */ void jtag_read_mem_quick(struct jtdev *p, address_t start_address, unsigned int word_count, uint16_t *data); /* Writes one byte/word at a given address */ void jtag_write_mem(struct jtdev *p, unsigned int format, address_t address, uint16_t data); /* Writes an array of words into target memory */ void jtag_write_mem_quick(struct jtdev *p, address_t start_address, unsigned int word_count, const uint16_t *data); /* This function checks if the JTAG access security fuse is blown */ int jtag_is_fuse_blown(struct jtdev *p); /* Execute a Power-Up Clear (PUC) using JTAG CNTRL SIG register */ unsigned int jtag_execute_puc(struct jtdev *p); /* Release the target device from JTAG control */ void jtag_release_device(struct jtdev *p, address_t address); /* Performs a verification over the given memory range */ int jtag_verify_mem(struct jtdev *p, address_t start_address, unsigned int word_count, const uint16_t *data); /* Performs an erase check over the given memory range */ int jtag_erase_check(struct jtdev *p, address_t start_address, unsigned int word_count); /* Programs/verifies an array of words into a FLASH */ void jtag_write_flash(struct jtdev *p, address_t start_address, unsigned int word_count, const uint16_t *data); /* Performs a mass erase or a segment erase of a FLASH module */ void jtag_erase_flash(struct jtdev *p, unsigned int erase_mode, address_t erase_address); /* Reads a register from the target CPU */ address_t jtag_read_reg(struct jtdev *p, int reg); /* Writes a value into a register of the target CPU */ void jtag_write_reg(struct jtdev *p, int reg, address_t value); void jtag_single_step(struct jtdev *p); unsigned int jtag_set_breakpoint(struct jtdev *p, int bp_num, address_t bp_addr); unsigned int jtag_cpu_state(struct jtdev *p); int jtag_get_config_fuses(struct jtdev *p); void jtag_dev_context_save(struct jtdev *p, bool after_puc); void jtag_dev_context_restore(struct jtdev *p); void jtag_dev_regs_update(struct jtdev *p); void jtag_dev_regs_flush(struct jtdev *p); /* Default low-level JTAG routines for jtdev implementations that don't have * their own implementations of these routines */ uint8_t jtag_default_ir_shift(struct jtdev *p, uint8_t ir); uint8_t jtag_default_dr_shift_8(struct jtdev *p, uint8_t dr); uint16_t jtag_default_dr_shift_16(struct jtdev *p, uint16_t dr); uint32_t jtag_default_dr_shift_20(struct jtdev *p, uint32_t dr); void jtag_default_tms_sequence(struct jtdev *p, int bits, unsigned int value); void jtag_default_init_dap(struct jtdev *p); void jtag_dev_default_context_save(struct jtdev *p, bool after_puc); void jtag_dev_default_context_restore(struct jtdev *p); void jtag_dev_default_regs_update(struct jtdev *p); void jtag_dev_default_regs_flush(struct jtdev *p); int jtag_refresh_bps(device_t dev, struct jtdev *p); int jtag_dev_readmem(device_t dev_base, address_t addr, uint8_t *mem, address_t len); int jtag_dev_writemem(device_t dev_base, address_t addr, const uint8_t *mem, address_t len); int jtag_dev_getregs(device_t dev_base, address_t *regs); int jtag_dev_setregs(device_t dev_base, const address_t *regs); int jtag_dev_ctl(device_t dev_base, device_ctl_t type); device_status_t jtag_dev_poll(device_t dev_base); int jtag_dev_erase(device_t dev_base, device_erase_type_t, address_t addr); int jtag_dev_getconfigfuses(device_t dev_base); int jtag_dev_init(struct jtdev *p); #endif