1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * PowerPC BookIII S hardware breakpoint definitions
4  *
5  * Copyright 2010, IBM Corporation.
6  * Author: K.Prasad <prasad@linux.vnet.ibm.com>
7  */
8 
9 #ifndef _PPC_BOOK3S_64_HW_BREAKPOINT_H
10 #define _PPC_BOOK3S_64_HW_BREAKPOINT_H
11 
12 #ifdef	__KERNEL__
13 struct arch_hw_breakpoint {
14 	unsigned long	address;
15 	u16		type;
16 	u16		len; /* length of the target data symbol */
17 	u16		hw_len; /* length programmed in hw */
18 };
19 
20 /* Note: Don't change the the first 6 bits below as they are in the same order
21  * as the dabr and dabrx.
22  */
23 #define HW_BRK_TYPE_READ		0x01
24 #define HW_BRK_TYPE_WRITE		0x02
25 #define HW_BRK_TYPE_TRANSLATE		0x04
26 #define HW_BRK_TYPE_USER		0x08
27 #define HW_BRK_TYPE_KERNEL		0x10
28 #define HW_BRK_TYPE_HYP			0x20
29 #define HW_BRK_TYPE_EXTRANEOUS_IRQ	0x80
30 
31 /* bits that overlap with the bottom 3 bits of the dabr */
32 #define HW_BRK_TYPE_RDWR	(HW_BRK_TYPE_READ | HW_BRK_TYPE_WRITE)
33 #define HW_BRK_TYPE_DABR	(HW_BRK_TYPE_RDWR | HW_BRK_TYPE_TRANSLATE)
34 #define HW_BRK_TYPE_PRIV_ALL	(HW_BRK_TYPE_USER | HW_BRK_TYPE_KERNEL | \
35 				 HW_BRK_TYPE_HYP)
36 
37 #define HW_BREAKPOINT_ALIGN 0x7
38 
39 #define DABR_MAX_LEN	8
40 #define DAWR_MAX_LEN	512
41 
42 #ifdef CONFIG_HAVE_HW_BREAKPOINT
43 #include <linux/kdebug.h>
44 #include <asm/reg.h>
45 #include <asm/debug.h>
46 
47 struct perf_event_attr;
48 struct perf_event;
49 struct pmu;
50 struct perf_sample_data;
51 struct task_struct;
52 
53 extern int hw_breakpoint_slots(int type);
54 extern int arch_bp_generic_fields(int type, int *gen_bp_type);
55 extern int arch_check_bp_in_kernelspace(struct arch_hw_breakpoint *hw);
56 extern int hw_breakpoint_arch_parse(struct perf_event *bp,
57 				    const struct perf_event_attr *attr,
58 				    struct arch_hw_breakpoint *hw);
59 extern int hw_breakpoint_exceptions_notify(struct notifier_block *unused,
60 						unsigned long val, void *data);
61 int arch_install_hw_breakpoint(struct perf_event *bp);
62 void arch_uninstall_hw_breakpoint(struct perf_event *bp);
63 void arch_unregister_hw_breakpoint(struct perf_event *bp);
64 void hw_breakpoint_pmu_read(struct perf_event *bp);
65 extern void flush_ptrace_hw_breakpoint(struct task_struct *tsk);
66 
67 extern struct pmu perf_ops_bp;
68 extern void ptrace_triggered(struct perf_event *bp,
69 			struct perf_sample_data *data, struct pt_regs *regs);
70 static inline void hw_breakpoint_disable(void)
71 {
72 	struct arch_hw_breakpoint brk;
73 
74 	brk.address = 0;
75 	brk.type = 0;
76 	brk.len = 0;
77 	brk.hw_len = 0;
78 	if (ppc_breakpoint_available())
79 		__set_breakpoint(&brk);
80 }
81 extern void thread_change_pc(struct task_struct *tsk, struct pt_regs *regs);
82 int hw_breakpoint_handler(struct die_args *args);
83 
84 #else	/* CONFIG_HAVE_HW_BREAKPOINT */
85 static inline void hw_breakpoint_disable(void) { }
86 static inline void thread_change_pc(struct task_struct *tsk,
87 					struct pt_regs *regs) { }
88 
89 #endif	/* CONFIG_HAVE_HW_BREAKPOINT */
90 
91 
92 #ifdef CONFIG_PPC_DAWR
93 extern bool dawr_force_enable;
94 static inline bool dawr_enabled(void)
95 {
96 	return dawr_force_enable;
97 }
98 int set_dawr(struct arch_hw_breakpoint *brk);
99 #else
100 static inline bool dawr_enabled(void) { return false; }
101 static inline int set_dawr(struct arch_hw_breakpoint *brk) { return -1; }
102 #endif
103 
104 #endif	/* __KERNEL__ */
105 #endif	/* _PPC_BOOK3S_64_HW_BREAKPOINT_H */
106