mspdebug/drivers/device.h

211 lines
5.7 KiB
C

/* MSPDebug - debugging tool for MSP430 MCUs
* Copyright (C) 2009, 2010 Daniel Beer
*
* 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
*/
#ifndef DEVICE_H_
#define DEVICE_H_
#include <stdint.h>
#include "util.h"
#include "powerbuf.h"
#include "chipinfo.h"
#include "bytes.h"
struct device;
typedef struct device *device_t;
typedef enum {
DEVICE_CTL_RESET,
DEVICE_CTL_RUN,
DEVICE_CTL_HALT,
DEVICE_CTL_STEP,
DEVICE_CTL_SECURE
} device_ctl_t;
typedef enum {
DEVICE_STATUS_HALTED,
DEVICE_STATUS_RUNNING,
DEVICE_STATUS_INTR,
DEVICE_STATUS_ERROR
} device_status_t;
typedef enum {
DEVICE_ERASE_ALL,
DEVICE_ERASE_MAIN,
DEVICE_ERASE_SEGMENT
} device_erase_type_t;
#define DEVICE_NUM_REGS 16
#define DEVICE_MAX_BREAKPOINTS 32
#define DEVICE_BP_ENABLED 0x01
#define DEVICE_BP_DIRTY 0x02
typedef enum {
DEVICE_BPTYPE_BREAK,
DEVICE_BPTYPE_WATCH,
DEVICE_BPTYPE_READ,
DEVICE_BPTYPE_WRITE
} device_bptype_t;
struct device_breakpoint {
device_bptype_t type;
address_t addr;
int flags;
};
#define DEVICE_FLAG_JTAG 0x01 /* default is SBW */
#define DEVICE_FLAG_LONG_PW 0x02
#define DEVICE_FLAG_TTY 0x04 /* default is USB */
#define DEVICE_FLAG_FORCE_RESET 0x08
#define DEVICE_FLAG_DO_FWUPDATE 0x10
#define DEVICE_FLAG_SKIP_CLOSE 0x20
struct device_args {
int flags;
int vcc_mv;
const char *path;
const char *forced_chip_id;
const char *requested_serial;
const char *require_fwupdate;
const char *bsl_entry_seq;
int bsl_gpio_used;
int bsl_gpio_rts;
int bsl_gpio_dtr;
};
struct device_class {
const char *name;
const char *help;
/* Create a new device */
device_t (*open)(const struct device_args *args);
/* Close the connection to the device and destroy the driver object */
void (*destroy)(device_t dev);
/* Read/write memory */
int (*readmem)(device_t dev, address_t addr,
uint8_t *mem, address_t len);
int (*writemem)(device_t dev, address_t addr,
const uint8_t *mem, address_t len);
/* Erase memory */
int (*erase)(device_t dev, device_erase_type_t type,
address_t address);
/* Read/write registers */
int (*getregs)(device_t dev, address_t *regs);
int (*setregs)(device_t dev, const address_t *regs);
/* CPU control */
int (*ctl)(device_t dev, device_ctl_t op);
/* Wait a little while for the CPU to change state */
device_status_t (*poll)(device_t dev);
};
struct device {
const struct device_class *type;
uint8_t dev_id[3];
/* Breakpoint table. This should not be modified directly.
* Instead, you should use the device_setbrk() helper function. This
* will set the appropriate flags and ensure that the breakpoint is
* reloaded before the next run.
*/
int max_breakpoints;
struct device_breakpoint breakpoints[DEVICE_MAX_BREAKPOINTS];
/* Power sample buffer, if power profiling is supported by this
* device.
*/
powerbuf_t power_buf;
/* Chip information data.
*/
const struct chipinfo *chip;
int need_probe;
};
/* Probe the device memory and extract ID bytes. This should be called
* after the device structure is ready.
*/
int device_probe_id(device_t dev, const char *force_id);
/* Determine, from the device ID bytes, whether this chip is an FRAM or
* flash-based device.
*/
int device_is_fram(device_t dev);
/* Set or clear a breakpoint. The index of the modified entry is
* returned, or -1 if no free entries were available. The modified
* entry is flagged so that it will be reloaded on the next run.
*
* If which is specified, a particular breakpoint slot is
* modified. Otherwise, if which < 0, breakpoint slots are selected
* automatically.
*/
int device_setbrk(device_t dev, int which, int enabled, address_t address,
device_bptype_t type);
extern device_t device_default;
/* Helper macros for operating on the default device */
#define device_destroy() device_default->type->destroy(device_default)
#define device_readmem(addr, mem, len) \
device_default->type->readmem(device_default, addr, mem, len)
#define device_writemem(addr, mem, len) \
device_default->type->writemem(device_default, addr, mem, len)
#define device_getregs(regs) \
device_default->type->getregs(device_default, regs)
#define device_setregs(regs) \
device_default->type->setregs(device_default, regs)
#define device_ctl(op) \
device_default->type->ctl(device_default, op)
#define device_poll() \
device_default->type->poll(device_default)
int device_erase(device_erase_type_t et, address_t addr);
address_t check_range(const struct chipinfo *chip,
address_t addr, address_t size,
const struct chipinfo_memory **m_ret);
int readmem(device_t dev, address_t addr,
uint8_t *mem, address_t len,
int (*read_words)(device_t dev,
const struct chipinfo_memory *m,
address_t addr, address_t len,
uint8_t *data)
);
int writemem(device_t dev, address_t addr,
const uint8_t *mem, address_t len,
int (*write_words)(device_t dev,
const struct chipinfo_memory *m,
address_t addr, address_t len,
const uint8_t *data),
int (*read_words)(device_t dev,
const struct chipinfo_memory *m,
address_t addr, address_t len,
uint8_t *data)
);
#endif