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