Use proper kdoc style comments for this API function. Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org> Reviewed-by: Richard Henderson <richard.henderson@linaro.org> Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Message-Id: <20230829161528.2707696-13-alex.bennee@linaro.org>
		
			
				
	
	
		
			55 lines
		
	
	
		
			1.6 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			55 lines
		
	
	
		
			1.6 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
#ifndef GDBSTUB_H
 | 
						|
#define GDBSTUB_H
 | 
						|
 | 
						|
#define DEFAULT_GDBSTUB_PORT "1234"
 | 
						|
 | 
						|
/* GDB breakpoint/watchpoint types */
 | 
						|
#define GDB_BREAKPOINT_SW        0
 | 
						|
#define GDB_BREAKPOINT_HW        1
 | 
						|
#define GDB_WATCHPOINT_WRITE     2
 | 
						|
#define GDB_WATCHPOINT_READ      3
 | 
						|
#define GDB_WATCHPOINT_ACCESS    4
 | 
						|
 | 
						|
 | 
						|
/* Get or set a register.  Returns the size of the register.  */
 | 
						|
typedef int (*gdb_get_reg_cb)(CPUArchState *env, GByteArray *buf, int reg);
 | 
						|
typedef int (*gdb_set_reg_cb)(CPUArchState *env, uint8_t *buf, int reg);
 | 
						|
 | 
						|
/**
 | 
						|
 * gdb_register_coprocessor() - register a supplemental set of registers
 | 
						|
 * @cpu - the CPU associated with registers
 | 
						|
 * @get_reg - get function (gdb reading)
 | 
						|
 * @set_reg - set function (gdb modifying)
 | 
						|
 * @num_regs - number of registers in set
 | 
						|
 * @xml - xml name of set
 | 
						|
 * @gpos - non-zero to append to "general" register set at @gpos
 | 
						|
 */
 | 
						|
void gdb_register_coprocessor(CPUState *cpu,
 | 
						|
                              gdb_get_reg_cb get_reg, gdb_set_reg_cb set_reg,
 | 
						|
                              int num_regs, const char *xml, int g_pos);
 | 
						|
 | 
						|
/**
 | 
						|
 * gdbserver_start: start the gdb server
 | 
						|
 * @port_or_device: connection spec for gdb
 | 
						|
 *
 | 
						|
 * For CONFIG_USER this is either a tcp port or a path to a fifo. For
 | 
						|
 * system emulation you can use a full chardev spec for your gdbserver
 | 
						|
 * port.
 | 
						|
 */
 | 
						|
int gdbserver_start(const char *port_or_device);
 | 
						|
 | 
						|
void gdb_set_stop_cpu(CPUState *cpu);
 | 
						|
 | 
						|
/**
 | 
						|
 * gdb_has_xml() - report of gdb supports modern target descriptions
 | 
						|
 *
 | 
						|
 * This will report true if the gdb negotiated qXfer:features:read
 | 
						|
 * target descriptions.
 | 
						|
 */
 | 
						|
bool gdb_has_xml(void);
 | 
						|
 | 
						|
/* in gdbstub-xml.c, generated by scripts/feature_to_c.sh */
 | 
						|
extern const char *const xml_builtin[][2];
 | 
						|
 | 
						|
#endif
 |