xref: /netbsd-src/sys/arch/mips/include/db_machdep.h (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1 /* $NetBSD: db_machdep.h,v 1.30 2017/11/06 03:47:47 christos Exp $ */
2 
3 /*
4  * Copyright (c) 1997 Jonathan Stone (hereinafter referred to as the author)
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *      This product includes software developed by Jonathan Stone for
18  *      the NetBSD Project.
19  * 4. The name of the author may not be used to endorse or promote products
20  *    derived from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34 #ifndef	_MIPS_DB_MACHDEP_H_
35 #define	_MIPS_DB_MACHDEP_H_
36 
37 #include <uvm/uvm_param.h>		/* XXX  boolean_t */
38 #include <mips/trap.h>			/* T_BREAK */
39 #include <mips/reg.h>			/* register state */
40 #include <mips/regnum.h>		/* symbolic register indices */
41 #include <mips/pcb.h>
42 
43 #define	DB_ELF_SYMBOLS
44 
45 typedef	vaddr_t		db_addr_t;	/* address - unsigned */
46 #ifdef __mips_n32
47 #define	DDB_EXPR_FMT	"ll"		/* expression is long long */
48 typedef	int64_t		db_expr_t;	/* expression - signed */
49 #else
50 #define	DDB_EXPR_FMT	"l"		/* expression is long */
51 typedef	long		db_expr_t;	/* expression - signed */
52 #endif
53 
54 typedef struct reg db_regs_t;
55 
56 extern db_regs_t	ddb_regs;	/* register state */
57 #define	DDB_REGS	(&ddb_regs)
58 
59 #define	PC_REGS(regs)	((regs)->r_regs[_R_PC])
60 
61 #define PC_ADVANCE(regs) do {						\
62 	if ((db_get_value((regs)->r_regs[_R_PC], sizeof(int), false) &\
63 	     0xfc00003f) == 0xd)					\
64 		(regs)->r_regs[_R_PC] += BKPT_SIZE;			\
65 } while(0)
66 
67 /* Similar to PC_ADVANCE(), except only advance on cpu_Debugger()'s bpt */
68 #define PC_BREAK_ADVANCE(regs) do {					 \
69 	if (db_get_value((regs)->r_regs[_R_PC], sizeof(int), false) == 0xd) \
70 		(regs)->r_regs[_R_PC] += BKPT_SIZE;			 \
71 } while(0)
72 
73 #define	BKPT_ADDR(addr)	(addr)		/* breakpoint address */
74 #define BKPT_INST	0x0001000D
75 #define	BKPT_SIZE	(4)		/* size of breakpoint inst */
76 #define	BKPT_SET(inst, addr)	(BKPT_INST)
77 
78 #define	IS_BREAKPOINT_TRAP(type, code)	((type) == T_BREAK)
79 #define IS_WATCHPOINT_TRAP(type, code)	(0)	/* XXX mips3 watchpoint */
80 
81 /*
82  * Interface to  disassembly (shared with mdb)
83  */
84 db_addr_t	db_disasm_insn(int insn, db_addr_t loc, bool altfmt);
85 
86 
87 /*
88  * Entrypoints to DDB for kernel, keyboard drivers, init hook
89  */
90 void 	kdb_kbd_trap(db_regs_t *);
91 int 	kdb_trap(int type, struct reg *);
92 
93 static inline void
94 db_set_ddb_regs(int type, struct reg *regs)
95 {
96 	ddb_regs = *regs;
97 }
98 
99 
100 /*
101  * Constants for KGDB.
102  */
103 typedef	mips_reg_t	kgdb_reg_t;
104 #define	KGDB_NUMREGS	90
105 #define	KGDB_BUFLEN	1024
106 
107 /*
108  * MIPS cpus have no hardware single-step.
109  */
110 #define SOFTWARE_SSTEP
111 
112 #define inst_trap_return(ins)	((ins)&0)
113 
114 bool	inst_branch(int inst);
115 bool	inst_call(int inst);
116 bool	inst_return(int inst);
117 bool	inst_load(int inst);
118 bool	inst_store(int inst);
119 bool	inst_unconditional_flow_transfer(int inst);
120 db_addr_t branch_taken(int inst, db_addr_t pc, db_regs_t *regs);
121 db_addr_t next_instr_address(db_addr_t pc, bool bd);
122 
123 bool ddb_running_on_this_cpu_p(void);
124 bool ddb_running_on_any_cpu_p(void);
125 void db_resume_others(void);
126 
127 /*
128  * We have machine-dependent commands.
129  */
130 #define DB_MACHINE_COMMANDS
131 
132 #endif	/* _MIPS_DB_MACHDEP_H_ */
133