272 lines
11 KiB
C
272 lines
11 KiB
C
/***************************************************************************
|
|
* Copyright (C) 2005 by Dominic Rath *
|
|
* Dominic.Rath@gmx.de *
|
|
* *
|
|
* 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., *
|
|
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
|
|
***************************************************************************/
|
|
#ifndef TARGET_H
|
|
#define TARGET_H
|
|
|
|
#include "register.h"
|
|
#include "breakpoints.h"
|
|
#include "algorithm.h"
|
|
#include "trace.h"
|
|
|
|
#include "command.h"
|
|
#include "types.h"
|
|
|
|
#include <sys/time.h>
|
|
#include <time.h>
|
|
|
|
struct reg_s;
|
|
struct command_context_s;
|
|
|
|
enum target_state
|
|
{
|
|
TARGET_UNKNOWN = 0,
|
|
TARGET_RUNNING = 1,
|
|
TARGET_HALTED = 2,
|
|
TARGET_RESET = 3,
|
|
TARGET_DEBUG_RUNNING = 4,
|
|
};
|
|
|
|
extern char *target_state_strings[];
|
|
|
|
enum daemon_startup_mode
|
|
{
|
|
DAEMON_ATTACH, /* simply attach to the target */
|
|
DAEMON_RESET, /* reset target (behaviour defined by reset_mode */
|
|
};
|
|
|
|
extern enum daemon_startup_mode startup_mode;
|
|
|
|
enum target_reset_mode
|
|
{
|
|
RESET_RUN = 0, /* reset and let target run */
|
|
RESET_HALT = 1, /* reset and halt target out of reset */
|
|
RESET_INIT = 2, /* reset and halt target out of reset, then run init script */
|
|
RESET_RUN_AND_HALT = 3, /* reset and let target run, halt after n milliseconds */
|
|
RESET_RUN_AND_INIT = 4, /* reset and let target run, halt after n milliseconds, then run init script */
|
|
};
|
|
|
|
enum target_debug_reason
|
|
{
|
|
DBG_REASON_DBGRQ = 0,
|
|
DBG_REASON_BREAKPOINT = 1,
|
|
DBG_REASON_WATCHPOINT = 2,
|
|
DBG_REASON_WPTANDBKPT = 3,
|
|
DBG_REASON_SINGLESTEP = 4,
|
|
DBG_REASON_NOTHALTED = 5
|
|
};
|
|
|
|
extern char *target_debug_reason_strings[];
|
|
|
|
enum target_endianess
|
|
{
|
|
TARGET_BIG_ENDIAN = 0, TARGET_LITTLE_ENDIAN = 1
|
|
};
|
|
|
|
extern char *target_endianess_strings[];
|
|
|
|
struct target_s;
|
|
|
|
typedef struct working_area_s
|
|
{
|
|
u32 address;
|
|
u32 size;
|
|
int free;
|
|
u8 *backup;
|
|
struct working_area_s **user;
|
|
struct working_area_s *next;
|
|
} working_area_t;
|
|
|
|
typedef struct target_type_s
|
|
{
|
|
char *name;
|
|
|
|
/* poll current target status */
|
|
int (*poll)(struct target_s *target);
|
|
/* Invoked only from target_arch_state().
|
|
* Issue USER() w/architecture specific status. */
|
|
int (*arch_state)(struct target_s *target);
|
|
|
|
/* target request support */
|
|
int (*target_request_data)(struct target_s *target, u32 size, u8 *buffer);
|
|
|
|
/* target execution control */
|
|
int (*halt)(struct target_s *target);
|
|
int (*resume)(struct target_s *target, int current, u32 address, int handle_breakpoints, int debug_execution);
|
|
int (*step)(struct target_s *target, int current, u32 address, int handle_breakpoints);
|
|
|
|
/* target reset control */
|
|
int (*assert_reset)(struct target_s *target);
|
|
int (*deassert_reset)(struct target_s *target);
|
|
int (*soft_reset_halt)(struct target_s *target);
|
|
int (*prepare_reset_halt)(struct target_s *target);
|
|
|
|
/* target register access for gdb */
|
|
int (*get_gdb_reg_list)(struct target_s *target, struct reg_s **reg_list[], int *reg_list_size);
|
|
|
|
/* target memory access
|
|
* size: 1 = byte (8bit), 2 = half-word (16bit), 4 = word (32bit)
|
|
* count: number of items of <size>
|
|
*/
|
|
int (*read_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
|
|
int (*write_memory)(struct target_s *target, u32 address, u32 size, u32 count, u8 *buffer);
|
|
|
|
/* write target memory in multiples of 4 byte, optimized for writing large quantities of data */
|
|
int (*bulk_write_memory)(struct target_s *target, u32 address, u32 count, u8 *buffer);
|
|
|
|
int (*checksum_memory)(struct target_s *target, u32 address, u32 count, u32* checksum);
|
|
|
|
/* target break-/watchpoint control
|
|
* rw: 0 = write, 1 = read, 2 = access
|
|
*/
|
|
int (*add_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
|
|
int (*remove_breakpoint)(struct target_s *target, breakpoint_t *breakpoint);
|
|
int (*add_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
|
|
int (*remove_watchpoint)(struct target_s *target, watchpoint_t *watchpoint);
|
|
|
|
/* target algorithm support */
|
|
int (*run_algorithm)(struct target_s *target, int num_mem_params, mem_param_t *mem_params, int num_reg_params, reg_param_t *reg_param, u32 entry_point, u32 exit_point, int timeout_ms, void *arch_info);
|
|
|
|
int (*register_commands)(struct command_context_s *cmd_ctx);
|
|
int (*target_command)(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct target_s *target);
|
|
int (*init_target)(struct command_context_s *cmd_ctx, struct target_s *target);
|
|
int (*quit)(void);
|
|
|
|
int (*virt2phys)(struct target_s *target, u32 address, u32 *physical);
|
|
int (*mmu)(struct target_s *target, int *enabled);
|
|
|
|
} target_type_t;
|
|
|
|
typedef struct target_s
|
|
{
|
|
target_type_t *type; /* target type definition (name, access functions) */
|
|
enum target_reset_mode reset_mode; /* what to do after a reset */
|
|
int run_and_halt_time; /* how long the target should run after a run_and_halt reset */
|
|
char *reset_script; /* script file to initialize the target after a reset */
|
|
char *post_halt_script; /* script file to execute after the target halted */
|
|
char *pre_resume_script; /* script file to execute before the target resumed */
|
|
char *gdb_program_script; /* script file to execute before programming vis gdb */
|
|
u32 working_area; /* working area (initialized RAM). Evaluated
|
|
upon first allocation from virtual/physical address.
|
|
*/
|
|
u32 working_area_virt; /* virtual address */
|
|
u32 working_area_phys; /* physical address */
|
|
u32 working_area_size; /* size in bytes */
|
|
u32 backup_working_area; /* whether the content of the working area has to be preserved */
|
|
struct working_area_s *working_areas;/* list of allocated working areas */
|
|
enum target_debug_reason debug_reason;/* reason why the target entered debug state */
|
|
enum target_endianess endianness; /* target endianess */
|
|
enum target_state state; /* the current backend-state (running, halted, ...) */
|
|
struct reg_cache_s *reg_cache; /* the first register cache of the target (core regs) */
|
|
struct breakpoint_s *breakpoints; /* list of breakpoints */
|
|
struct watchpoint_s *watchpoints; /* list of watchpoints */
|
|
struct trace_s *trace_info; /* generic trace information */
|
|
struct debug_msg_receiver_s *dbgmsg;/* list of debug message receivers */
|
|
u32 dbg_msg_enabled; /* debug message status */
|
|
void *arch_info; /* architecture specific information */
|
|
struct target_s *next; /* next target in list */
|
|
} target_t;
|
|
|
|
enum target_event
|
|
{
|
|
TARGET_EVENT_HALTED, /* target entered debug state from normal execution or reset */
|
|
TARGET_EVENT_RESUMED, /* target resumed to normal execution */
|
|
TARGET_EVENT_RESET, /* target entered reset */
|
|
TARGET_EVENT_DEBUG_HALTED, /* target entered debug state, but was executing on behalf of the debugger */
|
|
TARGET_EVENT_DEBUG_RESUMED, /* target resumed to execute on behalf of the debugger */
|
|
TARGET_EVENT_GDB_PROGRAM /* target about to be be programmed by gdb */
|
|
};
|
|
|
|
typedef struct target_event_callback_s
|
|
{
|
|
int (*callback)(struct target_s *target, enum target_event event, void *priv);
|
|
void *priv;
|
|
struct target_event_callback_s *next;
|
|
} target_event_callback_t;
|
|
|
|
typedef struct target_timer_callback_s
|
|
{
|
|
int (*callback)(void *priv);
|
|
int time_ms;
|
|
int periodic;
|
|
struct timeval when;
|
|
void *priv;
|
|
struct target_timer_callback_s *next;
|
|
} target_timer_callback_t;
|
|
|
|
extern int target_register_commands(struct command_context_s *cmd_ctx);
|
|
extern int target_register_user_commands(struct command_context_s *cmd_ctx);
|
|
extern int target_init(struct command_context_s *cmd_ctx);
|
|
extern int target_init_reset(struct command_context_s *cmd_ctx);
|
|
extern int handle_target(void *priv);
|
|
extern int target_process_reset(struct command_context_s *cmd_ctx);
|
|
|
|
extern int target_register_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
|
|
extern int target_unregister_event_callback(int (*callback)(struct target_s *target, enum target_event event, void *priv), void *priv);
|
|
extern int target_call_event_callbacks(target_t *target, enum target_event event);
|
|
|
|
extern int target_register_timer_callback(int (*callback)(void *priv), int time_ms, int periodic, void *priv);
|
|
extern int target_unregister_timer_callback(int (*callback)(void *priv), void *priv);
|
|
extern int target_call_timer_callbacks();
|
|
|
|
extern target_t* get_current_target(struct command_context_s *cmd_ctx);
|
|
extern int get_num_by_target(target_t *query_target);
|
|
extern target_t* get_target_by_num(int num);
|
|
|
|
extern int target_write_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
|
|
extern int target_read_buffer(struct target_s *target, u32 address, u32 size, u8 *buffer);
|
|
extern int target_checksum_memory(struct target_s *target, u32 address, u32 size, u32* crc);
|
|
|
|
extern int target_alloc_working_area(struct target_s *target, u32 size, working_area_t **area);
|
|
extern int target_free_working_area(struct target_s *target, working_area_t *area);
|
|
extern int target_free_all_working_areas(struct target_s *target);
|
|
|
|
extern target_t *targets;
|
|
|
|
extern target_event_callback_t *target_event_callbacks;
|
|
extern target_timer_callback_t *target_timer_callbacks;
|
|
|
|
extern u32 target_buffer_get_u32(target_t *target, u8 *buffer);
|
|
extern u16 target_buffer_get_u16(target_t *target, u8 *buffer);
|
|
extern void target_buffer_set_u32(target_t *target, u8 *buffer, u32 value);
|
|
extern void target_buffer_set_u16(target_t *target, u8 *buffer, u16 value);
|
|
|
|
int target_read_u32(struct target_s *target, u32 address, u32 *value);
|
|
int target_read_u16(struct target_s *target, u32 address, u16 *value);
|
|
int target_read_u8(struct target_s *target, u32 address, u8 *value);
|
|
int target_write_u32(struct target_s *target, u32 address, u32 value);
|
|
int target_write_u16(struct target_s *target, u32 address, u16 value);
|
|
int target_write_u8(struct target_s *target, u32 address, u8 value);
|
|
|
|
/* Issues USER() statements with target state information */
|
|
int target_arch_state(struct target_s *target);
|
|
|
|
#define ERROR_TARGET_INVALID (-300)
|
|
#define ERROR_TARGET_INIT_FAILED (-301)
|
|
#define ERROR_TARGET_TIMEOUT (-302)
|
|
#define ERROR_TARGET_ALREADY_HALTED (-303)
|
|
#define ERROR_TARGET_NOT_HALTED (-304)
|
|
#define ERROR_TARGET_FAILURE (-305)
|
|
#define ERROR_TARGET_UNALIGNED_ACCESS (-306)
|
|
#define ERROR_TARGET_DATA_ABORT (-307)
|
|
#define ERROR_TARGET_RESOURCE_NOT_AVAILABLE (-308)
|
|
#define ERROR_TARGET_TRANSLATION_FAULT (-309)
|
|
|
|
#endif /* TARGET_H */
|