[mirror_ubuntu-focal-kernel.git] / arch / arm / include / asm / hw_breakpoint.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _ARM_HW_BREAKPOINT_H
#define _ARM_HW_BREAKPOINT_H

#ifdef __KERNEL__

struct task_struct;

#ifdef CONFIG_HAVE_HW_BREAKPOINT

struct arch_hw_breakpoint_ctrl {
		u32 __reserved	: 9,
		mismatch	: 1,
				: 9,
		len		: 8,
		type		: 2,
		privilege	: 2,
		enabled		: 1;
};

struct arch_hw_breakpoint {
	u32	address;
	u32	trigger;
	struct	arch_hw_breakpoint_ctrl step_ctrl;
	struct	arch_hw_breakpoint_ctrl ctrl;
};

static inline u32 encode_ctrl_reg(struct arch_hw_breakpoint_ctrl ctrl)
{
	return (ctrl.mismatch << 22) | (ctrl.len << 5) | (ctrl.type << 3) |
		(ctrl.privilege << 1) | ctrl.enabled;
}

static inline void decode_ctrl_reg(u32 reg,
				   struct arch_hw_breakpoint_ctrl *ctrl)
{
	ctrl->enabled	= reg & 0x1;
	reg >>= 1;
	ctrl->privilege	= reg & 0x3;
	reg >>= 2;
	ctrl->type	= reg & 0x3;
	reg >>= 2;
	ctrl->len	= reg & 0xff;
	reg >>= 17;
	ctrl->mismatch	= reg & 0x1;
}

/* Debug architecture numbers. */
#define ARM_DEBUG_ARCH_RESERVED	0	/* In case of ptrace ABI updates. */
#define ARM_DEBUG_ARCH_V6	1
#define ARM_DEBUG_ARCH_V6_1	2
#define ARM_DEBUG_ARCH_V7_ECP14	3
#define ARM_DEBUG_ARCH_V7_MM	4
#define ARM_DEBUG_ARCH_V7_1	5
#define ARM_DEBUG_ARCH_V8	6

/* Breakpoint */
#define ARM_BREAKPOINT_EXECUTE	0

/* Watchpoints */
#define ARM_BREAKPOINT_LOAD	1
#define ARM_BREAKPOINT_STORE	2
#define ARM_FSR_ACCESS_MASK	(1 << 11)

/* Privilege Levels */
#define ARM_BREAKPOINT_PRIV	1
#define ARM_BREAKPOINT_USER	2

/* Lengths */
#define ARM_BREAKPOINT_LEN_1	0x1
#define ARM_BREAKPOINT_LEN_2	0x3
#define ARM_BREAKPOINT_LEN_4	0xf
#define ARM_BREAKPOINT_LEN_8	0xff

/* Limits */
#define ARM_MAX_BRP		16
#define ARM_MAX_WRP		16
#define ARM_MAX_HBP_SLOTS	(ARM_MAX_BRP + ARM_MAX_WRP)

/* DSCR method of entry bits. */
#define ARM_DSCR_MOE(x)			((x >> 2) & 0xf)
#define ARM_ENTRY_BREAKPOINT		0x1
#define ARM_ENTRY_ASYNC_WATCHPOINT	0x2
#define ARM_ENTRY_SYNC_WATCHPOINT	0xa

/* DSCR monitor/halting bits. */
#define ARM_DSCR_HDBGEN		(1 << 14)
#define ARM_DSCR_MDBGEN		(1 << 15)

/* OSLSR os lock model bits */
#define ARM_OSLSR_OSLM0		(1 << 0)

/* opcode2 numbers for the co-processor instructions. */
#define ARM_OP2_BVR		4
#define ARM_OP2_BCR		5
#define ARM_OP2_WVR		6
#define ARM_OP2_WCR		7

/* Base register numbers for the debug registers. */
#define ARM_BASE_BVR		64
#define ARM_BASE_BCR		80
#define ARM_BASE_WVR		96
#define ARM_BASE_WCR		112

/* Accessor macros for the debug registers. */
#define ARM_DBG_READ(N, M, OP2, VAL) do {\
	asm volatile("mrc p14, 0, %0, " #N "," #M ", " #OP2 : "=r" (VAL));\
} while (0)

#define ARM_DBG_WRITE(N, M, OP2, VAL) do {\
	asm volatile("mcr p14, 0, %0, " #N "," #M ", " #OP2 : : "r" (VAL));\
} while (0)

struct notifier_block;
struct perf_event;
struct pmu;

extern int arch_bp_generic_fields(struct arch_hw_breakpoint_ctrl ctrl,
				  int *gen_len, int *gen_type);
extern int arch_check_bp_in_kernelspace(struct perf_event *bp);
extern int arch_validate_hwbkpt_settings(struct perf_event *bp);
extern int hw_breakpoint_exceptions_notify(struct notifier_block *unused,
					   unsigned long val, void *data);

extern u8 arch_get_debug_arch(void);
extern u8 arch_get_max_wp_len(void);
extern void clear_ptrace_hw_breakpoint(struct task_struct *tsk);

int arch_install_hw_breakpoint(struct perf_event *bp);
void arch_uninstall_hw_breakpoint(struct perf_event *bp);
void hw_breakpoint_pmu_read(struct perf_event *bp);
int hw_breakpoint_slots(int type);

#else
static inline void clear_ptrace_hw_breakpoint(struct task_struct *tsk) {}

#endif	/* CONFIG_HAVE_HW_BREAKPOINT */
#endif	/* __KERNEL__ */
#endif	/* _ARM_HW_BREAKPOINT_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
f81ef4a9 WD	2	#ifndef _ARM_HW_BREAKPOINT_H
	3	#define _ARM_HW_BREAKPOINT_H
	4
	5	#ifdef __KERNEL__
864232fa WD	6
	7	struct task_struct;
	8
	9	#ifdef CONFIG_HAVE_HW_BREAKPOINT
	10
f81ef4a9 WD	11	struct arch_hw_breakpoint_ctrl {
	12	u32 __reserved : 9,
	13	mismatch : 1,
	14	: 9,
	15	len : 8,
	16	type : 2,
	17	privilege : 2,
	18	enabled : 1;
	19	};
	20
	21	struct arch_hw_breakpoint {
	22	u32 address;
	23	u32 trigger;
9ebb3cbc WD	24	struct arch_hw_breakpoint_ctrl step_ctrl;
9ebb3cbc WD	25	struct arch_hw_breakpoint_ctrl ctrl;
f81ef4a9 WD	26	};
	27
	28	static inline u32 encode_ctrl_reg(struct arch_hw_breakpoint_ctrl ctrl)
	29	{
	30	return (ctrl.mismatch << 22) \| (ctrl.len << 5) \| (ctrl.type << 3) \|
	31	(ctrl.privilege << 1) \| ctrl.enabled;
	32	}
	33
	34	static inline void decode_ctrl_reg(u32 reg,
	35	struct arch_hw_breakpoint_ctrl *ctrl)
	36	{
	37	ctrl->enabled = reg & 0x1;
	38	reg >>= 1;
	39	ctrl->privilege = reg & 0x3;
	40	reg >>= 2;
	41	ctrl->type = reg & 0x3;
	42	reg >>= 2;
	43	ctrl->len = reg & 0xff;
	44	reg >>= 17;
	45	ctrl->mismatch = reg & 0x1;
	46	}
	47
	48	/* Debug architecture numbers. */
	49	#define ARM_DEBUG_ARCH_RESERVED 0 /* In case of ptrace ABI updates. */
	50	#define ARM_DEBUG_ARCH_V6 1
	51	#define ARM_DEBUG_ARCH_V6_1 2
	52	#define ARM_DEBUG_ARCH_V7_ECP14 3
	53	#define ARM_DEBUG_ARCH_V7_MM 4
b5d5b8f9	54	#define ARM_DEBUG_ARCH_V7_1 5
5b61d4a5	55	#define ARM_DEBUG_ARCH_V8 6
f81ef4a9 WD	56
	57	/* Breakpoint */
	58	#define ARM_BREAKPOINT_EXECUTE 0
	59
	60	/* Watchpoints */
	61	#define ARM_BREAKPOINT_LOAD 1
	62	#define ARM_BREAKPOINT_STORE 2
6f26aa05	63	#define ARM_FSR_ACCESS_MASK (1 << 11)
f81ef4a9 WD	64
	65	/* Privilege Levels */
	66	#define ARM_BREAKPOINT_PRIV 1
	67	#define ARM_BREAKPOINT_USER 2
	68
	69	/* Lengths */
	70	#define ARM_BREAKPOINT_LEN_1 0x1
	71	#define ARM_BREAKPOINT_LEN_2 0x3
	72	#define ARM_BREAKPOINT_LEN_4 0xf
	73	#define ARM_BREAKPOINT_LEN_8 0xff
	74
	75	/* Limits */
	76	#define ARM_MAX_BRP 16
	77	#define ARM_MAX_WRP 16
	78	#define ARM_MAX_HBP_SLOTS (ARM_MAX_BRP + ARM_MAX_WRP)
	79
	80	/* DSCR method of entry bits. */
	81	#define ARM_DSCR_MOE(x) ((x >> 2) & 0xf)
	82	#define ARM_ENTRY_BREAKPOINT 0x1
	83	#define ARM_ENTRY_ASYNC_WATCHPOINT 0x2
	84	#define ARM_ENTRY_SYNC_WATCHPOINT 0xa
	85
	86	/* DSCR monitor/halting bits. */
	87	#define ARM_DSCR_HDBGEN (1 << 14)
	88	#define ARM_DSCR_MDBGEN (1 << 15)
	89
57ba8997 DE	90	/* OSLSR os lock model bits */
	91	#define ARM_OSLSR_OSLM0 (1 << 0)
	92
f81ef4a9 WD	93	/* opcode2 numbers for the co-processor instructions. */
	94	#define ARM_OP2_BVR 4
	95	#define ARM_OP2_BCR 5
	96	#define ARM_OP2_WVR 6
	97	#define ARM_OP2_WCR 7
	98
	99	/* Base register numbers for the debug registers. */
	100	#define ARM_BASE_BVR 64
	101	#define ARM_BASE_BCR 80
	102	#define ARM_BASE_WVR 96
	103	#define ARM_BASE_WCR 112
	104
	105	/* Accessor macros for the debug registers. */
9e962f76 DE	106	#define ARM_DBG_READ(N, M, OP2, VAL) do {\
9e962f76 DE	107	asm volatile("mrc p14, 0, %0, " #N "," #M ", " #OP2 : "=r" (VAL));\
f81ef4a9 WD	108	} while (0)
f81ef4a9 WD	109
9e962f76 DE	110	#define ARM_DBG_WRITE(N, M, OP2, VAL) do {\
9e962f76 DE	111	asm volatile("mcr p14, 0, %0, " #N "," #M ", " #OP2 : : "r" (VAL));\
f81ef4a9 WD	112	} while (0)
	113
	114	struct notifier_block;
	115	struct perf_event;
	116	struct pmu;
f81ef4a9	117
f81ef4a9 WD	118	extern int arch_bp_generic_fields(struct arch_hw_breakpoint_ctrl ctrl,
	119	int gen_len, int gen_type);
	120	extern int arch_check_bp_in_kernelspace(struct perf_event *bp);
	121	extern int arch_validate_hwbkpt_settings(struct perf_event *bp);
	122	extern int hw_breakpoint_exceptions_notify(struct notifier_block *unused,
	123	unsigned long val, void *data);
864232fa	124
f81ef4a9 WD	125	extern u8 arch_get_debug_arch(void);
f81ef4a9 WD	126	extern u8 arch_get_max_wp_len(void);
864232fa	127	extern void clear_ptrace_hw_breakpoint(struct task_struct *tsk);
f81ef4a9 WD	128
	129	int arch_install_hw_breakpoint(struct perf_event *bp);
	130	void arch_uninstall_hw_breakpoint(struct perf_event *bp);
	131	void hw_breakpoint_pmu_read(struct perf_event *bp);
	132	int hw_breakpoint_slots(int type);
	133
864232fa WD	134	#else
	135	static inline void clear_ptrace_hw_breakpoint(struct task_struct *tsk) {}
	136
	137	#endif /* CONFIG_HAVE_HW_BREAKPOINT */
f81ef4a9 WD	138	#endif /* __KERNEL__ */
f81ef4a9 WD	139	#endif /* _ARM_HW_BREAKPOINT_H */