aboutsummaryrefslogtreecommitdiff
path: root/src/target/arm_dpm.h
blob: 0172d9a23dc11ce0a412d39ba1468ebe585d7593 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
/*
 * Copyright (C) 2009 by David Brownell
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef OPENOCD_TARGET_ARM_DPM_H
#define OPENOCD_TARGET_ARM_DPM_H

/**
 * @file
 * This is the interface to the Debug Programmers Model for ARMv6 and
 * ARMv7 processors.  ARMv6 processors (such as ARM11xx implementations)
 * introduced a model which became part of the ARMv7-AR architecture
 * which is most familiar through the Cortex-A series parts.  While
 * specific details differ (like how to write the instruction register),
 * the high level models easily support shared code because those
 * registers are compatible.
 */

struct dpm_bpwp {
	unsigned number;
	uint32_t address;
	uint32_t control;
	/* true if hardware state needs flushing */
	bool dirty;
};

struct dpm_bp {
	struct breakpoint *bp;
	struct dpm_bpwp bpwp;
};

struct dpm_wp {
	struct watchpoint *wp;
	struct dpm_bpwp bpwp;
};

/**
 * This wraps an implementation of DPM primitives.  Each interface
 * provider supplies a structure like this, which is the glue between
 * upper level code and the lower level hardware access.
 *
 * It is a PRELIMINARY AND INCOMPLETE set of primitives, starting with
 * support for CPU register access.
 */
struct arm_dpm {
	struct arm *arm;

	/** Cache of DIDR */
	uint64_t didr;

	/** Invoke before a series of instruction operations */
	int (*prepare)(struct arm_dpm *dpm);

	/** Invoke after a series of instruction operations */
	int (*finish)(struct arm_dpm *dpm);

	/** Runs one instruction. */
	int (*instr_execute)(struct arm_dpm *dpm, uint32_t opcode);

	/* WRITE TO CPU */

	/** Runs one instruction, writing data to DCC before execution. */
	int (*instr_write_data_dcc)(struct arm_dpm *dpm,
			uint32_t opcode, uint32_t data);

	int (*instr_write_data_dcc_64)(struct arm_dpm *dpm,
			uint32_t opcode, uint64_t data);

	/** Runs one instruction, writing data to R0 before execution. */
	int (*instr_write_data_r0)(struct arm_dpm *dpm,
			uint32_t opcode, uint32_t data);

	/** Runs one instruction, writing data to R0 before execution. */
	int (*instr_write_data_r0_64)(struct arm_dpm *dpm,
			uint32_t opcode, uint64_t data);

	/** Optional core-specific operation invoked after CPSR writes. */
	int (*instr_cpsr_sync)(struct arm_dpm *dpm);

	/* READ FROM CPU */

	/** Runs one instruction, reading data from dcc after execution. */
	int (*instr_read_data_dcc)(struct arm_dpm *dpm,
			uint32_t opcode, uint32_t *data);

	int (*instr_read_data_dcc_64)(struct arm_dpm *dpm,
			uint32_t opcode, uint64_t *data);

	/** Runs one instruction, reading data from r0 after execution. */
	int (*instr_read_data_r0)(struct arm_dpm *dpm,
			uint32_t opcode, uint32_t *data);

	int (*instr_read_data_r0_64)(struct arm_dpm *dpm,
			uint32_t opcode, uint64_t *data);

	struct reg *(*arm_reg_current)(struct arm *arm,
			unsigned regnum);

	/* BREAKPOINT/WATCHPOINT SUPPORT */

	/**
	 * Enables one breakpoint or watchpoint by writing to the
	 * hardware registers.  The specified breakpoint/watchpoint
	 * must currently be disabled.  Indices 0..15 are used for
	 * breakpoints; indices 16..31 are for watchpoints.
	 */
	int (*bpwp_enable)(struct arm_dpm *dpm, unsigned index_value,
			uint32_t addr, uint32_t control);

	/**
	 * Disables one breakpoint or watchpoint by clearing its
	 * hardware control registers.  Indices are the same ones
	 * accepted by bpwp_enable().
	 */
	int (*bpwp_disable)(struct arm_dpm *dpm, unsigned index_value);

	/* The breakpoint and watchpoint arrays are private to the
	 * DPM infrastructure.  There are nbp indices in the dbp
	 * array.  There are nwp indices in the dwp array.
	 */

	unsigned nbp;
	unsigned nwp;
	struct dpm_bp *dbp;
	struct dpm_wp *dwp;

	/**
	 * Target dependent watchpoint address.
	 * Either the address of the instruction which triggered a watchpoint
	 * or the memory address whose access triggered a watchpoint.
	 */
	target_addr_t wp_addr;

	/** Recent value of DSCR. */
	uint32_t dscr;

	/** Recent exception level on armv8 */
	unsigned int last_el;

	/* FIXME -- read/write DCSR methods and symbols */
};

int arm_dpm_setup(struct arm_dpm *dpm);
int arm_dpm_initialize(struct arm_dpm *dpm);

int arm_dpm_read_reg(struct arm_dpm *dpm, struct reg *r, unsigned regnum);
int arm_dpm_read_current_registers(struct arm_dpm *dpm);
int arm_dpm_modeswitch(struct arm_dpm *dpm, enum arm_mode mode);

int arm_dpm_write_dirty_registers(struct arm_dpm *dpm, bool bpwp);

void arm_dpm_report_wfar(struct arm_dpm *dpm, uint32_t wfar);

/* DSCR bits; see ARMv7a arch spec section C10.3.1.
 * Not all v7 bits are valid in v6.
 */
#define DSCR_CORE_HALTED            (0x1 <<  0)
#define DSCR_CORE_RESTARTED         (0x1 <<  1)
#define DSCR_ENTRY_MASK             (0xF <<  2)
#define DSCR_STICKY_ABORT_PRECISE   (0x1 <<  6)
#define DSCR_STICKY_ABORT_IMPRECISE (0x1 <<  7)
#define DSCR_STICKY_UNDEFINED       (0x1 <<  8)
#define DSCR_DBG_NOPWRDWN           (0x1 <<  9) /* v6 only */
#define DSCR_DBG_ACK                (0x1 << 10)
#define DSCR_INT_DIS                (0x1 << 11)
#define DSCR_CP14_USR_COMMS         (0x1 << 12)
#define DSCR_ITR_EN                 (0x1 << 13)
#define DSCR_HALT_DBG_MODE          (0x1 << 14)
#define DSCR_MON_DBG_MODE           (0x1 << 15)
#define DSCR_SEC_PRIV_INVASV_DIS    (0x1 << 16)
#define DSCR_SEC_PRIV_NINVASV_DIS   (0x1 << 17)
#define DSCR_NON_SECURE             (0x1 << 18)
#define DSCR_DSCRD_IMPRECISE_ABORT  (0x1 << 19)
#define DSCR_EXT_DCC_MASK           (0x3 << 20) /* DTR mode */  /* bits 22, 23 are reserved */
#define DSCR_INSTR_COMP             (0x1 << 24)
#define DSCR_PIPE_ADVANCE           (0x1 << 25)
#define DSCR_DTRTX_FULL_LATCHED     (0x1 << 26)
#define DSCR_DTRRX_FULL_LATCHED     (0x1 << 27) /* bit 28 is reserved */
#define DSCR_DTR_TX_FULL            (0x1 << 29)
#define DSCR_DTR_RX_FULL            (0x1 << 30) /* bit 31 is reserved */

#define DSCR_ENTRY(dscr)            ((dscr) & 0x3f)
#define DSCR_RUN_MODE(dscr)         ((dscr) & 0x03)


/* Methods of entry into debug mode */
#define DSCR_ENTRY_HALT_REQ           (0x03)
#define DSCR_ENTRY_BREAKPOINT         (0x07)
#define DSCR_ENTRY_IMPRECISE_WATCHPT  (0x0B)
#define DSCR_ENTRY_BKPT_INSTR         (0x0F)
#define DSCR_ENTRY_EXT_DBG_REQ        (0x13)
#define DSCR_ENTRY_VECT_CATCH         (0x17)
#define DSCR_ENTRY_D_SIDE_ABORT       (0x1B)  /* v6 only */
#define DSCR_ENTRY_I_SIDE_ABORT       (0x1F)  /* v6 only */
#define DSCR_ENTRY_OS_UNLOCK          (0x23)
#define DSCR_ENTRY_PRECISE_WATCHPT    (0x2B)

/* DTR modes */
#define DSCR_EXT_DCC_NON_BLOCKING     (0x0 << 20)
#define DSCR_EXT_DCC_STALL_MODE       (0x1 << 20)
#define DSCR_EXT_DCC_FAST_MODE        (0x2 << 20)  /* bits 22, 23 are reserved */





/* DRCR (debug run control register) bits */
#define DRCR_HALT				(1 << 0)
#define DRCR_RESTART			(1 << 1)
#define DRCR_CLEAR_EXCEPTIONS	(1 << 2)

void arm_dpm_report_dscr(struct arm_dpm *dpm, uint32_t dcsr);

/* PRCR (Device Power-down and Reset Control Register) bits */
#define PRCR_DEBUG_NO_POWER_DOWN         (1 << 0)
#define PRCR_WARM_RESET                  (1 << 1)
#define PRCR_HOLD_NON_DEBUG_RESET        (1 << 2)

/* PRSR (Device Power-down and Reset Status Register) bits */
#define PRSR_POWERUP_STATUS              (1 << 0)
#define PRSR_STICKY_POWERDOWN_STATUS     (1 << 1)
#define PRSR_RESET_STATUS                (1 << 2)
#define PRSR_STICKY_RESET_STATUS         (1 << 3)
#define PRSR_HALTED                      (1 << 4)  /* v7.1 Debug only */
#define PRSR_OSLK                        (1 << 5)  /* v7.1 Debug only */
#define PRSR_DLK                         (1 << 6)  /* v7.1 Debug only */

/* OSLSR (OS Lock Status Register) bits */
#define OSLSR_OSLM0                      (1 << 0)
#define OSLSR_OSLK                       (1 << 1)
#define OSLSR_NTT                        (1 << 2)
#define OSLSR_OSLM1                      (1 << 3)
#define OSLSR_OSLM                       (OSLSR_OSLM0|OSLSR_OSLM1)

#endif /* OPENOCD_TARGET_ARM_DPM_H */