kgdb.h 10.7 KB
Newer Older
Jason Wessel's avatar
Jason Wessel committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/*
 * This provides the callbacks and functions that KGDB needs to share between
 * the core, I/O and arch-specific portions.
 *
 * Author: Amit Kale <amitkale@linsyssoft.com> and
 *         Tom Rini <trini@kernel.crashing.org>
 *
 * 2001-2004 (c) Amit S. Kale and 2003-2005 (c) MontaVista Software, Inc.
 * This file is licensed under the terms of the GNU General Public License
 * version 2. This program is licensed "as is" without any warranty of any
 * kind, whether express or implied.
 */
#ifndef _KGDB_H_
#define _KGDB_H_

#include <linux/linkage.h>
#include <linux/init.h>
18
#include <linux/atomic.h>
19
#ifdef CONFIG_HAVE_ARCH_KGDB
Jason Wessel's avatar
Jason Wessel committed
20
#include <asm/kgdb.h>
21
#endif
Jason Wessel's avatar
Jason Wessel committed
22

23
#ifdef CONFIG_KGDB
Jason Wessel's avatar
Jason Wessel committed
24 25
struct pt_regs;

Jason Wessel's avatar
Jason Wessel committed
26 27
/**
 *	kgdb_skipexception - (optional) exit kgdb_handle_exception early
Jason Wessel's avatar
Jason Wessel committed
28 29 30
 *	@exception: Exception vector number
 *	@regs: Current &struct pt_regs.
 *
Jason Wessel's avatar
Jason Wessel committed
31 32
 *	On some architectures it is required to skip a breakpoint
 *	exception when it occurs after a breakpoint has been removed.
33
 *	This can be implemented in the architecture specific portion of kgdb.
Jason Wessel's avatar
Jason Wessel committed
34 35 36 37 38 39 40
 */
extern int kgdb_skipexception(int exception, struct pt_regs *regs);

struct tasklet_struct;
struct task_struct;
struct uart_port;

Jason Wessel's avatar
Jason Wessel committed
41 42 43
/**
 *	kgdb_breakpoint - compiled in breakpoint
 *
44
 *	This will be implemented as a static inline per architecture.  This
Jason Wessel's avatar
Jason Wessel committed
45 46 47 48
 *	function is called by the kgdb core to execute an architecture
 *	specific trap to cause kgdb to enter the exception processing.
 *
 */
Jason Wessel's avatar
Jason Wessel committed
49 50 51
void kgdb_breakpoint(void);

extern int kgdb_connected;
52
extern int kgdb_io_module_registered;
Jason Wessel's avatar
Jason Wessel committed
53 54 55 56 57 58 59 60 61 62 63 64

extern atomic_t			kgdb_setting_breakpoint;
extern atomic_t			kgdb_cpu_doing_single_step;

extern struct task_struct	*kgdb_usethread;
extern struct task_struct	*kgdb_contthread;

enum kgdb_bptype {
	BP_BREAKPOINT = 0,
	BP_HARDWARE_BREAKPOINT,
	BP_WRITE_WATCHPOINT,
	BP_READ_WATCHPOINT,
65 66
	BP_ACCESS_WATCHPOINT,
	BP_POKE_BREAKPOINT,
Jason Wessel's avatar
Jason Wessel committed
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
};

enum kgdb_bpstate {
	BP_UNDEFINED = 0,
	BP_REMOVED,
	BP_SET,
	BP_ACTIVE
};

struct kgdb_bkpt {
	unsigned long		bpt_addr;
	unsigned char		saved_instr[BREAK_INSTR_SIZE];
	enum kgdb_bptype	type;
	enum kgdb_bpstate	state;
};

83 84 85 86 87 88 89 90 91 92 93 94 95
struct dbg_reg_def_t {
	char *name;
	int size;
	int offset;
};

#ifndef DBG_MAX_REG_NUM
#define DBG_MAX_REG_NUM 0
#else
extern struct dbg_reg_def_t dbg_reg_def[];
extern char *dbg_get_reg(int regno, void *mem, struct pt_regs *regs);
extern int dbg_set_reg(int regno, void *mem, struct pt_regs *regs);
#endif
Jason Wessel's avatar
Jason Wessel committed
96 97 98 99 100 101 102 103 104 105
#ifndef KGDB_MAX_BREAKPOINTS
# define KGDB_MAX_BREAKPOINTS	1000
#endif

#define KGDB_HW_BREAKPOINT	1

/*
 * Functions each KGDB-supporting architecture must provide:
 */

Jason Wessel's avatar
Jason Wessel committed
106
/**
Jason Wessel's avatar
Jason Wessel committed
107 108 109 110 111 112 113
 *	kgdb_arch_init - Perform any architecture specific initalization.
 *
 *	This function will handle the initalization of any architecture
 *	specific callbacks.
 */
extern int kgdb_arch_init(void);

Jason Wessel's avatar
Jason Wessel committed
114
/**
Jason Wessel's avatar
Jason Wessel committed
115 116 117 118 119 120 121
 *	kgdb_arch_exit - Perform any architecture specific uninitalization.
 *
 *	This function will handle the uninitalization of any architecture
 *	specific callbacks, for dynamic registration and unregistration.
 */
extern void kgdb_arch_exit(void);

Jason Wessel's avatar
Jason Wessel committed
122
/**
Jason Wessel's avatar
Jason Wessel committed
123 124 125 126 127 128 129 130 131
 *	pt_regs_to_gdb_regs - Convert ptrace regs to GDB regs
 *	@gdb_regs: A pointer to hold the registers in the order GDB wants.
 *	@regs: The &struct pt_regs of the current process.
 *
 *	Convert the pt_regs in @regs into the format for registers that
 *	GDB expects, stored in @gdb_regs.
 */
extern void pt_regs_to_gdb_regs(unsigned long *gdb_regs, struct pt_regs *regs);

Jason Wessel's avatar
Jason Wessel committed
132
/**
Jason Wessel's avatar
Jason Wessel committed
133 134 135 136 137 138 139 140 141 142 143 144 145 146
 *	sleeping_thread_to_gdb_regs - Convert ptrace regs to GDB regs
 *	@gdb_regs: A pointer to hold the registers in the order GDB wants.
 *	@p: The &struct task_struct of the desired process.
 *
 *	Convert the register values of the sleeping process in @p to
 *	the format that GDB expects.
 *	This function is called when kgdb does not have access to the
 *	&struct pt_regs and therefore it should fill the gdb registers
 *	@gdb_regs with what has	been saved in &struct thread_struct
 *	thread field during switch_to.
 */
extern void
sleeping_thread_to_gdb_regs(unsigned long *gdb_regs, struct task_struct *p);

Jason Wessel's avatar
Jason Wessel committed
147
/**
Jason Wessel's avatar
Jason Wessel committed
148 149 150 151 152 153 154 155 156
 *	gdb_regs_to_pt_regs - Convert GDB regs to ptrace regs.
 *	@gdb_regs: A pointer to hold the registers we've received from GDB.
 *	@regs: A pointer to a &struct pt_regs to hold these values in.
 *
 *	Convert the GDB regs in @gdb_regs into the pt_regs, and store them
 *	in @regs.
 */
extern void gdb_regs_to_pt_regs(unsigned long *gdb_regs, struct pt_regs *regs);

Jason Wessel's avatar
Jason Wessel committed
157
/**
Jason Wessel's avatar
Jason Wessel committed
158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
 *	kgdb_arch_handle_exception - Handle architecture specific GDB packets.
 *	@vector: The error vector of the exception that happened.
 *	@signo: The signal number of the exception that happened.
 *	@err_code: The error code of the exception that happened.
 *	@remcom_in_buffer: The buffer of the packet we have read.
 *	@remcom_out_buffer: The buffer of %BUFMAX bytes to write a packet into.
 *	@regs: The &struct pt_regs of the current process.
 *
 *	This function MUST handle the 'c' and 's' command packets,
 *	as well packets to set / remove a hardware breakpoint, if used.
 *	If there are additional packets which the hardware needs to handle,
 *	they are handled here.  The code should return -1 if it wants to
 *	process more packets, and a %0 or %1 if it wants to exit from the
 *	kgdb callback.
 */
extern int
kgdb_arch_handle_exception(int vector, int signo, int err_code,
			   char *remcom_in_buffer,
			   char *remcom_out_buffer,
			   struct pt_regs *regs);

Jason Wessel's avatar
Jason Wessel committed
179
/**
Jason Wessel's avatar
Jason Wessel committed
180 181 182 183
 *	kgdb_roundup_cpus - Get other CPUs into a holding pattern
 *	@flags: Current IRQ state
 *
 *	On SMP systems, we need to get the attention of the other CPUs
184
 *	and get them into a known state.  This should do what is needed
Jason Wessel's avatar
Jason Wessel committed
185 186 187 188 189 190 191 192 193 194 195 196
 *	to get the other CPUs to call kgdb_wait(). Note that on some arches,
 *	the NMI approach is not used for rounding up all the CPUs. For example,
 *	in case of MIPS, smp_call_function() is used to roundup CPUs. In
 *	this case, we have to make sure that interrupts are enabled before
 *	calling smp_call_function(). The argument to this function is
 *	the flags that will be used when restoring the interrupts. There is
 *	local_irq_save() call before kgdb_roundup_cpus().
 *
 *	On non-SMP systems, this is not called.
 */
extern void kgdb_roundup_cpus(unsigned long flags);

197 198 199 200 201 202 203 204 205 206 207
/**
 *	kgdb_arch_set_pc - Generic call back to the program counter
 *	@regs: Current &struct pt_regs.
 *  @pc: The new value for the program counter
 *
 *	This function handles updating the program counter and requires an
 *	architecture specific implementation.
 */
extern void kgdb_arch_set_pc(struct pt_regs *regs, unsigned long pc);


Jason Wessel's avatar
Jason Wessel committed
208 209
/* Optional functions. */
extern int kgdb_validate_break_address(unsigned long addr);
210 211
extern int kgdb_arch_set_breakpoint(struct kgdb_bkpt *bpt);
extern int kgdb_arch_remove_breakpoint(struct kgdb_bkpt *bpt);
Jason Wessel's avatar
Jason Wessel committed
212

213 214 215 216 217 218 219 220 221 222 223
/**
 *	kgdb_arch_late - Perform any architecture specific initalization.
 *
 *	This function will handle the late initalization of any
 *	architecture specific callbacks.  This is an optional function for
 *	handling things like late initialization of hw breakpoints.  The
 *	default implementation does nothing.
 */
extern void kgdb_arch_late(void);


Jason Wessel's avatar
Jason Wessel committed
224
/**
Jason Wessel's avatar
Jason Wessel committed
225 226 227 228 229 230 231 232 233 234 235
 * struct kgdb_arch - Describe architecture specific values.
 * @gdb_bpt_instr: The instruction to trigger a breakpoint.
 * @flags: Flags for the breakpoint, currently just %KGDB_HW_BREAKPOINT.
 * @set_breakpoint: Allow an architecture to specify how to set a software
 * breakpoint.
 * @remove_breakpoint: Allow an architecture to specify how to remove a
 * software breakpoint.
 * @set_hw_breakpoint: Allow an architecture to specify how to set a hardware
 * breakpoint.
 * @remove_hw_breakpoint: Allow an architecture to specify how to remove a
 * hardware breakpoint.
236 237
 * @disable_hw_break: Allow an architecture to specify how to disable
 * hardware breakpoints for a single cpu.
Jason Wessel's avatar
Jason Wessel committed
238 239 240 241
 * @remove_all_hw_break: Allow an architecture to specify how to remove all
 * hardware breakpoints.
 * @correct_hw_break: Allow an architecture to specify how to correct the
 * hardware debug registers.
242
 * @enable_nmi: Manage NMI-triggered entry to KGDB
Jason Wessel's avatar
Jason Wessel committed
243 244 245 246 247 248 249 250 251
 */
struct kgdb_arch {
	unsigned char		gdb_bpt_instr[BREAK_INSTR_SIZE];
	unsigned long		flags;

	int	(*set_breakpoint)(unsigned long, char *);
	int	(*remove_breakpoint)(unsigned long, char *);
	int	(*set_hw_breakpoint)(unsigned long, int, enum kgdb_bptype);
	int	(*remove_hw_breakpoint)(unsigned long, int, enum kgdb_bptype);
252
	void	(*disable_hw_break)(struct pt_regs *regs);
Jason Wessel's avatar
Jason Wessel committed
253 254
	void	(*remove_all_hw_break)(void);
	void	(*correct_hw_break)(void);
255 256

	void	(*enable_nmi)(bool on);
Jason Wessel's avatar
Jason Wessel committed
257 258
};

Jason Wessel's avatar
Jason Wessel committed
259
/**
Jason Wessel's avatar
Jason Wessel committed
260 261 262 263 264 265 266 267 268 269
 * struct kgdb_io - Describe the interface for an I/O driver to talk with KGDB.
 * @name: Name of the I/O driver.
 * @read_char: Pointer to a function that will return one char.
 * @write_char: Pointer to a function that will write one char.
 * @flush: Pointer to a function that will flush any pending writes.
 * @init: Pointer to a function that will initialize the device.
 * @pre_exception: Pointer to a function that will do any prep work for
 * the I/O driver.
 * @post_exception: Pointer to a function that will do any cleanup work
 * for the I/O driver.
270 271
 * @is_console: 1 if the end device is a console 0 if the I/O device is
 * not a console
Jason Wessel's avatar
Jason Wessel committed
272 273 274 275 276 277 278 279 280
 */
struct kgdb_io {
	const char		*name;
	int			(*read_char) (void);
	void			(*write_char) (u8);
	void			(*flush) (void);
	int			(*init) (void);
	void			(*pre_exception) (void);
	void			(*post_exception) (void);
281
	int			is_console;
Jason Wessel's avatar
Jason Wessel committed
282 283 284 285
};

extern struct kgdb_arch		arch_kgdb_ops;

286
extern unsigned long kgdb_arch_pc(int exception, struct pt_regs *regs);
287

288 289 290 291 292 293 294 295 296 297
#ifdef CONFIG_SERIAL_KGDB_NMI
extern int kgdb_register_nmi_console(void);
extern int kgdb_unregister_nmi_console(void);
extern bool kgdb_nmi_poll_knock(void);
#else
static inline int kgdb_register_nmi_console(void) { return 0; }
static inline int kgdb_unregister_nmi_console(void) { return 0; }
static inline bool kgdb_nmi_poll_knock(void) { return 1; }
#endif

Jason Wessel's avatar
Jason Wessel committed
298 299
extern int kgdb_register_io_module(struct kgdb_io *local_kgdb_io_ops);
extern void kgdb_unregister_io_module(struct kgdb_io *local_kgdb_io_ops);
300
extern struct kgdb_io *dbg_io_ops;
Jason Wessel's avatar
Jason Wessel committed
301

302
extern int kgdb_hex2long(char **ptr, unsigned long *long_val);
303
extern char *kgdb_mem2hex(char *mem, char *buf, int count);
Jason Wessel's avatar
Jason Wessel committed
304 305 306
extern int kgdb_hex2mem(char *buf, char *mem, int count);

extern int kgdb_isremovedbreak(unsigned long addr);
307
extern void kgdb_schedule_breakpoint(void);
Jason Wessel's avatar
Jason Wessel committed
308 309 310 311 312

extern int
kgdb_handle_exception(int ex_vector, int signo, int err_code,
		      struct pt_regs *regs);
extern int kgdb_nmicallback(int cpu, void *regs);
313 314
extern int kgdb_nmicallin(int cpu, int trapnr, void *regs, int err_code,
			  atomic_t *snd_rdy);
315
extern void gdbstub_exit(int status);
Jason Wessel's avatar
Jason Wessel committed
316 317 318

extern int			kgdb_single_step;
extern atomic_t			kgdb_active;
319 320
#define in_dbg_master() \
	(raw_smp_processor_id() == atomic_read(&kgdb_active))
321 322
extern bool dbg_is_early;
extern void __init dbg_late_init(void);
323 324
#else /* ! CONFIG_KGDB */
#define in_dbg_master() (0)
325
#define dbg_late_init()
326
#endif /* ! CONFIG_KGDB */
Jason Wessel's avatar
Jason Wessel committed
327
#endif /* _KGDB_H_ */