xref: /freebsd/sys/arm64/include/debug_monitor.h (revision fe6060f10f634930ff71b7c50291ddc610da2475)
1 /*-
2  * Copyright (c) 2014 The FreeBSD Foundation
3  *
4  * This software was developed by Semihalf under
5  * the sponsorship of the FreeBSD Foundation.
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  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _MACHINE_DEBUG_MONITOR_H_
32 #define	_MACHINE_DEBUG_MONITOR_H_
33 
34 #define	DBG_BRP_MAX	16
35 #define	DBG_WRP_MAX	16
36 
37 struct debug_monitor_state {
38 	uint32_t	dbg_enable_count;
39 	uint32_t	dbg_flags;
40 #define	DBGMON_ENABLED		(1 << 0)
41 #define	DBGMON_KERNEL		(1 << 1)
42 	uint64_t	dbg_bcr[DBG_BRP_MAX];
43 	uint64_t	dbg_bvr[DBG_BRP_MAX];
44 	uint64_t	dbg_wcr[DBG_WRP_MAX];
45 	uint64_t	dbg_wvr[DBG_WRP_MAX];
46 };
47 
48 #ifdef _KERNEL
49 
50 enum dbg_access_t {
51 	HW_BREAKPOINT_X		= 0,
52 	HW_BREAKPOINT_R		= 1,
53 	HW_BREAKPOINT_W		= 2,
54 	HW_BREAKPOINT_RW	= HW_BREAKPOINT_R | HW_BREAKPOINT_W,
55 };
56 
57 void dbg_monitor_init(void);
58 void dbg_register_sync(struct debug_monitor_state *);
59 int dbg_setup_watchpoint(struct debug_monitor_state *, vm_offset_t, vm_size_t,
60     enum dbg_access_t);
61 int dbg_remove_watchpoint(struct debug_monitor_state *, vm_offset_t, vm_size_t);
62 
63 #ifdef DDB
64 void dbg_show_watchpoint(void);
65 #endif
66 
67 #endif /* _KERNEL */
68 
69 #endif /* _MACHINE_DEBUG_MONITOR_H_ */
70