[mirror_ubuntu-focal-kernel.git] / include / linux / kgdb.h

/*
 * 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>
#include <linux/atomic.h>
#ifdef CONFIG_HAVE_ARCH_KGDB
#include <asm/kgdb.h>
#endif

#ifdef CONFIG_KGDB
struct pt_regs;

/**
 *	kgdb_skipexception - (optional) exit kgdb_handle_exception early
 *	@exception: Exception vector number
 *	@regs: Current &struct pt_regs.
 *
 *	On some architectures it is required to skip a breakpoint
 *	exception when it occurs after a breakpoint has been removed.
 *	This can be implemented in the architecture specific portion of kgdb.
 */
extern int kgdb_skipexception(int exception, struct pt_regs *regs);

struct tasklet_struct;
struct task_struct;
struct uart_port;

/**
 *	kgdb_breakpoint - compiled in breakpoint
 *
 *	This will be implemented as a static inline per architecture.  This
 *	function is called by the kgdb core to execute an architecture
 *	specific trap to cause kgdb to enter the exception processing.
 *
 */
void kgdb_breakpoint(void);

extern int kgdb_connected;
extern int kgdb_io_module_registered;

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,
	BP_ACCESS_WATCHPOINT,
	BP_POKE_BREAKPOINT,
};

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;
};

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
#ifndef KGDB_MAX_BREAKPOINTS
# define KGDB_MAX_BREAKPOINTS	1000
#endif

#define KGDB_HW_BREAKPOINT	1

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

/**
 *	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);

/**
 *	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);

/**
 *	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);

/**
 *	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);

/**
 *	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);

/**
 *	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);

/**
 *	kgdb_call_nmi_hook - Call kgdb_nmicallback() on the current CPU
 *	@ignored: This parameter is only here to match the prototype.
 *
 *	If you're using the default implementation of kgdb_roundup_cpus()
 *	this function will be called per CPU.  If you don't implement
 *	kgdb_call_nmi_hook() a default will be used.
 */

extern void kgdb_call_nmi_hook(void *ignored);

/**
 *	kgdb_roundup_cpus - Get other CPUs into a holding pattern
 *
 *	On SMP systems, we need to get the attention of the other CPUs
 *	and get them into a known state.  This should do what is needed
 *	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.  Normally
 *	those architectures can just not implement this and get the default.
 *
 *	On non-SMP systems, this is not called.
 */
extern void kgdb_roundup_cpus(void);

/**
 *	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);


/* Optional functions. */
extern int kgdb_validate_break_address(unsigned long addr);
extern int kgdb_arch_set_breakpoint(struct kgdb_bkpt *bpt);
extern int kgdb_arch_remove_breakpoint(struct kgdb_bkpt *bpt);

/**
 *	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);


/**
 * 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.
 * @disable_hw_break: Allow an architecture to specify how to disable
 * hardware breakpoints for a single cpu.
 * @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.
 * @enable_nmi: Manage NMI-triggered entry to KGDB
 */
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);
	void	(*disable_hw_break)(struct pt_regs *regs);
	void	(*remove_all_hw_break)(void);
	void	(*correct_hw_break)(void);

	void	(*enable_nmi)(bool on);
};

/**
 * 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.
 * @is_console: 1 if the end device is a console 0 if the I/O device is
 * not a console
 */
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);
	int			is_console;
};

extern const struct kgdb_arch		arch_kgdb_ops;

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

#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

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);
extern struct kgdb_io *dbg_io_ops;

extern int kgdb_hex2long(char **ptr, unsigned long *long_val);
extern char *kgdb_mem2hex(char *mem, char *buf, int count);
extern int kgdb_hex2mem(char *buf, char *mem, int count);

extern int kgdb_isremovedbreak(unsigned long addr);
extern void kgdb_schedule_breakpoint(void);

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);
extern int kgdb_nmicallin(int cpu, int trapnr, void *regs, int err_code,
			  atomic_t *snd_rdy);
extern void gdbstub_exit(int status);

extern int			kgdb_single_step;
extern atomic_t			kgdb_active;
#define in_dbg_master() \
	(irqs_disabled() && (smp_processor_id() == atomic_read(&kgdb_active)))
extern bool dbg_is_early;
extern void __init dbg_late_init(void);
extern void kgdb_panic(const char *msg);
#else /* ! CONFIG_KGDB */
#define in_dbg_master() (0)
#define dbg_late_init()
static inline void kgdb_panic(const char *msg) {}
#endif /* ! CONFIG_KGDB */
#endif /* _KGDB_H_ */
Commit	Line	Data
dc7d5527 JW	1	/*
	2	* This provides the callbacks and functions that KGDB needs to share between
	3	* the core, I/O and arch-specific portions.
	4	*
	5	* Author: Amit Kale <amitkale@linsyssoft.com> and
	6	* Tom Rini <trini@kernel.crashing.org>
	7	*
	8	* 2001-2004 (c) Amit S. Kale and 2003-2005 (c) MontaVista Software, Inc.
	9	* This file is licensed under the terms of the GNU General Public License
	10	* version 2. This program is licensed "as is" without any warranty of any
	11	* kind, whether express or implied.
	12	*/
	13	#ifndef _KGDB_H_
	14	#define _KGDB_H_
	15
dc7d5527 JW	16	#include <linux/linkage.h>
dc7d5527 JW	17	#include <linux/init.h>
60063497	18	#include <linux/atomic.h>
dcc78711	19	#ifdef CONFIG_HAVE_ARCH_KGDB
dc7d5527	20	#include <asm/kgdb.h>
dcc78711	21	#endif
dc7d5527	22
dcc78711	23	#ifdef CONFIG_KGDB
dc7d5527 JW	24	struct pt_regs;
dc7d5527 JW	25
e3e2aaf7 JW	26	/**
e3e2aaf7 JW	27	* kgdb_skipexception - (optional) exit kgdb_handle_exception early
dc7d5527 JW	28	* @exception: Exception vector number
	29	* @regs: Current &struct pt_regs.
	30	*
e3e2aaf7 JW	31	* On some architectures it is required to skip a breakpoint
e3e2aaf7 JW	32	* exception when it occurs after a breakpoint has been removed.
b11e1eca	33	* This can be implemented in the architecture specific portion of kgdb.
dc7d5527 JW	34	*/
	35	extern int kgdb_skipexception(int exception, struct pt_regs *regs);
	36
dc7d5527 JW	37	struct tasklet_struct;
	38	struct task_struct;
	39	struct uart_port;
	40
e3e2aaf7 JW	41	/**
	42	* kgdb_breakpoint - compiled in breakpoint
	43	*
b11e1eca	44	* This will be implemented as a static inline per architecture. This
e3e2aaf7 JW	45	* function is called by the kgdb core to execute an architecture
	46	* specific trap to cause kgdb to enter the exception processing.
	47	*
	48	*/
dc7d5527 JW	49	void kgdb_breakpoint(void);
	50
	51	extern int kgdb_connected;
f503b5ae	52	extern int kgdb_io_module_registered;
dc7d5527 JW	53
	54	extern atomic_t kgdb_setting_breakpoint;
	55	extern atomic_t kgdb_cpu_doing_single_step;
	56
	57	extern struct task_struct *kgdb_usethread;
	58	extern struct task_struct *kgdb_contthread;
	59
	60	enum kgdb_bptype {
	61	BP_BREAKPOINT = 0,
	62	BP_HARDWARE_BREAKPOINT,
	63	BP_WRITE_WATCHPOINT,
	64	BP_READ_WATCHPOINT,
3751d3e8 JW	65	BP_ACCESS_WATCHPOINT,
3751d3e8 JW	66	BP_POKE_BREAKPOINT,
dc7d5527 JW	67	};
	68
	69	enum kgdb_bpstate {
	70	BP_UNDEFINED = 0,
	71	BP_REMOVED,
	72	BP_SET,
	73	BP_ACTIVE
	74	};
	75
	76	struct kgdb_bkpt {
	77	unsigned long bpt_addr;
	78	unsigned char saved_instr[BREAK_INSTR_SIZE];
	79	enum kgdb_bptype type;
	80	enum kgdb_bpstate state;
	81	};
	82
534af108 JW	83	struct dbg_reg_def_t {
	84	char *name;
	85	int size;
	86	int offset;
	87	};
	88
	89	#ifndef DBG_MAX_REG_NUM
	90	#define DBG_MAX_REG_NUM 0
	91	#else
	92	extern struct dbg_reg_def_t dbg_reg_def[];
	93	extern char dbg_get_reg(int regno, void mem, struct pt_regs *regs);
	94	extern int dbg_set_reg(int regno, void mem, struct pt_regs regs);
	95	#endif
dc7d5527 JW	96	#ifndef KGDB_MAX_BREAKPOINTS
	97	# define KGDB_MAX_BREAKPOINTS 1000
	98	#endif
	99
	100	#define KGDB_HW_BREAKPOINT 1
	101
	102	/*
	103	* Functions each KGDB-supporting architecture must provide:
	104	*/
	105
e3e2aaf7	106	/**
dc7d5527 JW	107	* kgdb_arch_init - Perform any architecture specific initalization.
	108	*
	109	* This function will handle the initalization of any architecture
	110	* specific callbacks.
	111	*/
	112	extern int kgdb_arch_init(void);
	113
e3e2aaf7	114	/**
dc7d5527 JW	115	* kgdb_arch_exit - Perform any architecture specific uninitalization.
	116	*
	117	* This function will handle the uninitalization of any architecture
	118	* specific callbacks, for dynamic registration and unregistration.
	119	*/
	120	extern void kgdb_arch_exit(void);
	121
e3e2aaf7	122	/**
dc7d5527 JW	123	* pt_regs_to_gdb_regs - Convert ptrace regs to GDB regs
	124	* @gdb_regs: A pointer to hold the registers in the order GDB wants.
	125	* @regs: The &struct pt_regs of the current process.
	126	*
	127	* Convert the pt_regs in @regs into the format for registers that
	128	* GDB expects, stored in @gdb_regs.
	129	*/
	130	extern void pt_regs_to_gdb_regs(unsigned long gdb_regs, struct pt_regs regs);
	131
e3e2aaf7	132	/**
dc7d5527 JW	133	* sleeping_thread_to_gdb_regs - Convert ptrace regs to GDB regs
	134	* @gdb_regs: A pointer to hold the registers in the order GDB wants.
	135	* @p: The &struct task_struct of the desired process.
	136	*
	137	* Convert the register values of the sleeping process in @p to
	138	* the format that GDB expects.
	139	* This function is called when kgdb does not have access to the
	140	* &struct pt_regs and therefore it should fill the gdb registers
	141	* @gdb_regs with what has been saved in &struct thread_struct
	142	* thread field during switch_to.
	143	*/
	144	extern void
	145	sleeping_thread_to_gdb_regs(unsigned long gdb_regs, struct task_struct p);
	146
e3e2aaf7	147	/**
dc7d5527 JW	148	* gdb_regs_to_pt_regs - Convert GDB regs to ptrace regs.
	149	* @gdb_regs: A pointer to hold the registers we've received from GDB.
	150	* @regs: A pointer to a &struct pt_regs to hold these values in.
	151	*
	152	* Convert the GDB regs in @gdb_regs into the pt_regs, and store them
	153	* in @regs.
	154	*/
	155	extern void gdb_regs_to_pt_regs(unsigned long gdb_regs, struct pt_regs regs);
	156
e3e2aaf7	157	/**
dc7d5527 JW	158	* kgdb_arch_handle_exception - Handle architecture specific GDB packets.
	159	* @vector: The error vector of the exception that happened.
	160	* @signo: The signal number of the exception that happened.
	161	* @err_code: The error code of the exception that happened.
	162	* @remcom_in_buffer: The buffer of the packet we have read.
	163	* @remcom_out_buffer: The buffer of %BUFMAX bytes to write a packet into.
	164	* @regs: The &struct pt_regs of the current process.
	165	*
	166	* This function MUST handle the 'c' and 's' command packets,
	167	* as well packets to set / remove a hardware breakpoint, if used.
	168	* If there are additional packets which the hardware needs to handle,
	169	* they are handled here. The code should return -1 if it wants to
	170	* process more packets, and a %0 or %1 if it wants to exit from the
	171	* kgdb callback.
	172	*/
	173	extern int
	174	kgdb_arch_handle_exception(int vector, int signo, int err_code,
	175	char *remcom_in_buffer,
	176	char *remcom_out_buffer,
	177	struct pt_regs *regs);
	178
3cd99ac3 DA	179	/**
	180	* kgdb_call_nmi_hook - Call kgdb_nmicallback() on the current CPU
	181	* @ignored: This parameter is only here to match the prototype.
	182	*
	183	* If you're using the default implementation of kgdb_roundup_cpus()
	184	* this function will be called per CPU. If you don't implement
	185	* kgdb_call_nmi_hook() a default will be used.
	186	*/
	187
	188	extern void kgdb_call_nmi_hook(void *ignored);
	189
e3e2aaf7	190	/**
dc7d5527	191	* kgdb_roundup_cpus - Get other CPUs into a holding pattern
dc7d5527 JW	192	*
dc7d5527 JW	193	* On SMP systems, we need to get the attention of the other CPUs
b11e1eca	194	* and get them into a known state. This should do what is needed
dc7d5527	195	* to get the other CPUs to call kgdb_wait(). Note that on some arches,
3cd99ac3 DA	196	* the NMI approach is not used for rounding up all the CPUs. Normally
3cd99ac3 DA	197	* those architectures can just not implement this and get the default.
dc7d5527 JW	198	*
	199	* On non-SMP systems, this is not called.
	200	*/
9ef7fa50	201	extern void kgdb_roundup_cpus(void);
dc7d5527	202
84c08fd6 JW	203	/**
	204	* kgdb_arch_set_pc - Generic call back to the program counter
	205	* @regs: Current &struct pt_regs.
	206	* @pc: The new value for the program counter
	207	*
	208	* This function handles updating the program counter and requires an
	209	* architecture specific implementation.
	210	*/
	211	extern void kgdb_arch_set_pc(struct pt_regs *regs, unsigned long pc);
	212
	213
dc7d5527 JW	214	/* Optional functions. */
dc7d5527 JW	215	extern int kgdb_validate_break_address(unsigned long addr);
98b54aa1 JW	216	extern int kgdb_arch_set_breakpoint(struct kgdb_bkpt *bpt);
98b54aa1 JW	217	extern int kgdb_arch_remove_breakpoint(struct kgdb_bkpt *bpt);
dc7d5527	218
0b4b3827 JW	219	/**
	220	* kgdb_arch_late - Perform any architecture specific initalization.
	221	*
	222	* This function will handle the late initalization of any
	223	* architecture specific callbacks. This is an optional function for
	224	* handling things like late initialization of hw breakpoints. The
	225	* default implementation does nothing.
	226	*/
	227	extern void kgdb_arch_late(void);
	228
	229
e3e2aaf7	230	/**
dc7d5527 JW	231	* struct kgdb_arch - Describe architecture specific values.
	232	* @gdb_bpt_instr: The instruction to trigger a breakpoint.
	233	* @flags: Flags for the breakpoint, currently just %KGDB_HW_BREAKPOINT.
	234	* @set_breakpoint: Allow an architecture to specify how to set a software
	235	* breakpoint.
	236	* @remove_breakpoint: Allow an architecture to specify how to remove a
	237	* software breakpoint.
	238	* @set_hw_breakpoint: Allow an architecture to specify how to set a hardware
	239	* breakpoint.
	240	* @remove_hw_breakpoint: Allow an architecture to specify how to remove a
	241	* hardware breakpoint.
d7ba979d DD	242	* @disable_hw_break: Allow an architecture to specify how to disable
d7ba979d DD	243	* hardware breakpoints for a single cpu.
dc7d5527 JW	244	* @remove_all_hw_break: Allow an architecture to specify how to remove all
	245	* hardware breakpoints.
	246	* @correct_hw_break: Allow an architecture to specify how to correct the
	247	* hardware debug registers.
5a14fead	248	* @enable_nmi: Manage NMI-triggered entry to KGDB
dc7d5527 JW	249	*/
	250	struct kgdb_arch {
	251	unsigned char gdb_bpt_instr[BREAK_INSTR_SIZE];
	252	unsigned long flags;
	253
	254	int (set_breakpoint)(unsigned long, char );
	255	int (remove_breakpoint)(unsigned long, char );
	256	int (*set_hw_breakpoint)(unsigned long, int, enum kgdb_bptype);
	257	int (*remove_hw_breakpoint)(unsigned long, int, enum kgdb_bptype);
d7ba979d	258	void (disable_hw_break)(struct pt_regs regs);
dc7d5527 JW	259	void (*remove_all_hw_break)(void);
dc7d5527 JW	260	void (*correct_hw_break)(void);
5a14fead AV	261
5a14fead AV	262	void (*enable_nmi)(bool on);
dc7d5527 JW	263	};
dc7d5527 JW	264
e3e2aaf7	265	/**
dc7d5527 JW	266	* struct kgdb_io - Describe the interface for an I/O driver to talk with KGDB.
	267	* @name: Name of the I/O driver.
	268	* @read_char: Pointer to a function that will return one char.
	269	* @write_char: Pointer to a function that will write one char.
	270	* @flush: Pointer to a function that will flush any pending writes.
	271	* @init: Pointer to a function that will initialize the device.
	272	* @pre_exception: Pointer to a function that will do any prep work for
	273	* the I/O driver.
	274	* @post_exception: Pointer to a function that will do any cleanup work
	275	* for the I/O driver.
efe2f29e JW	276	* @is_console: 1 if the end device is a console 0 if the I/O device is
efe2f29e JW	277	* not a console
dc7d5527 JW	278	*/
	279	struct kgdb_io {
	280	const char *name;
	281	int (*read_char) (void);
	282	void (*write_char) (u8);
	283	void (*flush) (void);
	284	int (*init) (void);
	285	void (*pre_exception) (void);
	286	void (*post_exception) (void);
efe2f29e	287	int is_console;
dc7d5527 JW	288	};
dc7d5527 JW	289
cc028297	290	extern const struct kgdb_arch arch_kgdb_ops;
dc7d5527	291
107bcc6d	292	extern unsigned long kgdb_arch_pc(int exception, struct pt_regs *regs);
688b744d	293
0c57dfcc AV	294	#ifdef CONFIG_SERIAL_KGDB_NMI
	295	extern int kgdb_register_nmi_console(void);
	296	extern int kgdb_unregister_nmi_console(void);
	297	extern bool kgdb_nmi_poll_knock(void);
	298	#else
	299	static inline int kgdb_register_nmi_console(void) { return 0; }
	300	static inline int kgdb_unregister_nmi_console(void) { return 0; }
	301	static inline bool kgdb_nmi_poll_knock(void) { return 1; }
	302	#endif
	303
dc7d5527 JW	304	extern int kgdb_register_io_module(struct kgdb_io *local_kgdb_io_ops);
dc7d5527 JW	305	extern void kgdb_unregister_io_module(struct kgdb_io *local_kgdb_io_ops);
53197fc4	306	extern struct kgdb_io *dbg_io_ops;
dc7d5527	307
688b744d	308	extern int kgdb_hex2long(char *ptr, unsigned long long_val);
55751145	309	extern char kgdb_mem2hex(char mem, char *buf, int count);
dc7d5527 JW	310	extern int kgdb_hex2mem(char buf, char mem, int count);
	311
	312	extern int kgdb_isremovedbreak(unsigned long addr);
1cee5e35	313	extern void kgdb_schedule_breakpoint(void);
dc7d5527 JW	314
	315	extern int
	316	kgdb_handle_exception(int ex_vector, int signo, int err_code,
	317	struct pt_regs *regs);
	318	extern int kgdb_nmicallback(int cpu, void *regs);
fc8b1374 MT	319	extern int kgdb_nmicallin(int cpu, int trapnr, void *regs, int err_code,
fc8b1374 MT	320	atomic_t *snd_rdy);
d57f078b	321	extern void gdbstub_exit(int status);
dc7d5527 JW	322
	323	extern int kgdb_single_step;
	324	extern atomic_t kgdb_active;
dcc78711	325	#define in_dbg_master() \
b3acf7a8	326	(irqs_disabled() && (smp_processor_id() == atomic_read(&kgdb_active)))
0b4b3827 JW	327	extern bool dbg_is_early;
0b4b3827 JW	328	extern void __init dbg_late_init(void);
7d92bda2	329	extern void kgdb_panic(const char *msg);
dcc78711 JW	330	#else /* ! CONFIG_KGDB */
dcc78711 JW	331	#define in_dbg_master() (0)
0b4b3827	332	#define dbg_late_init()
7d92bda2	333	static inline void kgdb_panic(const char *msg) {}
dcc78711	334	#endif /* ! CONFIG_KGDB */
dc7d5527	335	#endif /* _KGDB_H_ */