xref: /freebsd/sys/riscv/include/db_machdep.h (revision f7c32ed617858bcd22f8d1b03199099d50125721)
1 /*-
2  * Copyright (c) 2015-2016 Ruslan Bukin <br@bsdpad.com>
3  * All rights reserved.
4  *
5  * Portions of this software were developed by SRI International and the
6  * University of Cambridge Computer Laboratory under DARPA/AFRL contract
7  * FA8750-10-C-0237 ("CTSRD"), as part of the DARPA CRASH research programme.
8  *
9  * Portions of this software were developed by the University of Cambridge
10  * Computer Laboratory as part of the CTSRD Project, with support from the
11  * UK Higher Education Innovation Fund (HEIF).
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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  * $FreeBSD$
35  */
36 
37 #ifndef	_MACHINE_DB_MACHDEP_H_
38 #define	_MACHINE_DB_MACHDEP_H_
39 
40 #include <machine/riscvreg.h>
41 #include <machine/frame.h>
42 #include <machine/trap.h>
43 
44 #define	T_BREAKPOINT	(SCAUSE_BREAKPOINT)
45 #define	T_WATCHPOINT	(0)
46 
47 typedef vm_offset_t	db_addr_t;
48 typedef long		db_expr_t;
49 
50 #define	PC_REGS()	((db_addr_t)kdb_frame->tf_sepc)
51 
52 #define	BKPT_INST	(0x00100073)
53 #define	BKPT_SIZE	(INSN_SIZE)
54 #define	BKPT_SET(inst)	(BKPT_INST)
55 
56 #define	BKPT_SKIP do {							\
57 	uint32_t _instr;						\
58 									\
59 	_instr = db_get_value(PC_REGS(), sizeof(uint32_t), FALSE);	\
60 	if ((_instr & 0x3) == 0x3)					\
61 		kdb_frame->tf_sepc += 4;	/* ebreak */		\
62 	else								\
63 		kdb_frame->tf_sepc += 2;	/* c.ebreak */		\
64 } while (0)
65 
66 #define	db_clear_single_step	kdb_cpu_clear_singlestep
67 #define	db_set_single_step	kdb_cpu_set_singlestep
68 
69 #define	IS_BREAKPOINT_TRAP(type, code)	(type == T_BREAKPOINT)
70 #define	IS_WATCHPOINT_TRAP(type, code)	(type == T_WATCHPOINT)
71 
72 #define	inst_trap_return(ins)	(ins == 0x10000073)	/* eret */
73 #define	inst_return(ins)	(ins == 0x00008067)	/* ret */
74 #define	inst_call(ins)		(((ins) & 0x7f) == 111 || \
75 				 ((ins) & 0x7f) == 103) /* jal, jalr */
76 
77 #define	inst_load(ins) ({							\
78 	uint32_t tmp_instr = db_get_value(PC_REGS(), sizeof(uint32_t), FALSE);	\
79 	is_load_instr(tmp_instr);						\
80 })
81 
82 #define	inst_store(ins) ({							\
83 	uint32_t tmp_instr = db_get_value(PC_REGS(), sizeof(uint32_t), FALSE);	\
84 	is_store_instr(tmp_instr);						\
85 })
86 
87 #define	is_load_instr(ins)	(((ins) & 0x7f) == 3)
88 #define	is_store_instr(ins)	(((ins) & 0x7f) == 35)
89 
90 #define	next_instr_address(pc, bd)	((bd) ? (pc) : ((pc) + 4))
91 
92 #define	DB_ELFSIZE		64
93 
94 #endif /* !_MACHINE_DB_MACHDEP_H_ */
95