target: don't include "log.h" from "armv4_5.h"
[openocd.git] / src / target / armv4_5.h
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2008 by Spencer Oliver *
6 * spen@spen-soft.co.uk *
7 * *
8 * Copyright (C) 2009 by √ėyvind Harboe *
9 * oyvind.harboe@zylin.com *
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 * This program is distributed in the hope that it will be useful, *
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
19 * GNU General Public License for more details. *
20 * *
21 * You should have received a copy of the GNU General Public License *
22 * along with this program; if not, write to the *
23 * Free Software Foundation, Inc., *
24 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 ***************************************************************************/
26 #ifndef ARMV4_5_H
27 #define ARMV4_5_H
28
29 #include "target.h"
30
31 typedef enum armv4_5_mode
32 {
33 ARMV4_5_MODE_USR = 16,
34 ARMV4_5_MODE_FIQ = 17,
35 ARMV4_5_MODE_IRQ = 18,
36 ARMV4_5_MODE_SVC = 19,
37 ARMV4_5_MODE_ABT = 23,
38 ARMV4_5_MODE_UND = 27,
39 ARMV4_5_MODE_SYS = 31,
40 ARMV4_5_MODE_ANY = -1
41 } armv4_5_mode_t;
42
43 int armv4_5_mode_to_number(enum armv4_5_mode mode);
44 enum armv4_5_mode armv4_5_number_to_mode(int number);
45
46 extern const char **armv4_5_mode_strings;
47
48 typedef enum armv4_5_state
49 {
50 ARMV4_5_STATE_ARM,
51 ARMV4_5_STATE_THUMB,
52 ARMV4_5_STATE_JAZELLE,
53 } armv4_5_state_t;
54
55 extern char* armv4_5_state_strings[];
56
57 extern int armv4_5_core_reg_map[7][17];
58
59 #define ARMV4_5_CORE_REG_MODE(cache, mode, num) \
60 cache->reg_list[armv4_5_core_reg_map[armv4_5_mode_to_number(mode)][num]]
61 #define ARMV4_5_CORE_REG_MODENUM(cache, mode, num) \
62 cache->reg_list[armv4_5_core_reg_map[mode][num]]
63
64 /* offsets into armv4_5 core register cache */
65 enum
66 {
67 ARMV4_5_CPSR = 31,
68 ARMV4_5_SPSR_FIQ = 32,
69 ARMV4_5_SPSR_IRQ = 33,
70 ARMV4_5_SPSR_SVC = 34,
71 ARMV4_5_SPSR_ABT = 35,
72 ARMV4_5_SPSR_UND = 36
73 };
74
75 #define ARMV4_5_COMMON_MAGIC 0x0A450A45
76
77 /* NOTE: this is being morphed into a generic toplevel holder for ARMs. */
78 #define armv4_5_common_s arm
79
80 /**
81 * Represents a generic ARM core, with standard application registers.
82 *
83 * There are sixteen application registers (including PC, SP, LR) and a PSR.
84 * Cortex-M series cores do not support as many core states or shadowed
85 * registers as traditional ARM cores, and only support Thumb2 instructions.
86 */
87 struct arm
88 {
89 int common_magic;
90 struct reg_cache *core_cache;
91
92 int /* armv4_5_mode */ core_mode;
93 enum armv4_5_state core_state;
94
95 /** Flag reporting unavailability of the BKPT instruction. */
96 bool is_armv4;
97
98 /** Handle for the Embedded Trace Module, if one is present. */
99 struct etm_context *etm;
100
101 int (*full_context)(struct target *target);
102 int (*read_core_reg)(struct target *target,
103 int num, enum armv4_5_mode mode);
104 int (*write_core_reg)(struct target *target,
105 int num, enum armv4_5_mode mode, uint32_t value);
106 void *arch_info;
107 };
108
109 #define target_to_armv4_5 target_to_arm
110
111 /** Convert target handle to generic ARM target state handle. */
112 static inline struct arm *target_to_arm(struct target *target)
113 {
114 return target->arch_info;
115 }
116
117 static inline bool is_arm(struct arm *arm)
118 {
119 return arm && arm->common_magic == ARMV4_5_COMMON_MAGIC;
120 }
121
122 struct armv4_5_algorithm
123 {
124 int common_magic;
125
126 enum armv4_5_mode core_mode;
127 enum armv4_5_state core_state;
128 };
129
130 struct armv4_5_core_reg
131 {
132 int num;
133 enum armv4_5_mode mode;
134 struct target *target;
135 struct arm *armv4_5_common;
136 };
137
138 struct reg_cache* armv4_5_build_reg_cache(struct target *target,
139 struct arm *armv4_5_common);
140
141 int armv4_5_arch_state(struct target *target);
142 int armv4_5_get_gdb_reg_list(struct target *target,
143 struct reg **reg_list[], int *reg_list_size);
144
145 int armv4_5_register_commands(struct command_context *cmd_ctx);
146 int armv4_5_init_arch_info(struct target *target, struct arm *armv4_5);
147
148 int armv4_5_run_algorithm(struct target *target,
149 int num_mem_params, struct mem_param *mem_params,
150 int num_reg_params, struct reg_param *reg_params,
151 uint32_t entry_point, uint32_t exit_point,
152 int timeout_ms, void *arch_info);
153
154 int armv4_5_invalidate_core_regs(struct target *target);
155
156 int arm_checksum_memory(struct target *target,
157 uint32_t address, uint32_t count, uint32_t *checksum);
158 int arm_blank_check_memory(struct target *target,
159 uint32_t address, uint32_t count, uint32_t *blank);
160
161
162 /* ARM mode instructions
163 */
164
165 /* Store multiple increment after
166 * Rn: base register
167 * List: for each bit in list: store register
168 * S: in priviledged mode: store user-mode registers
169 * W = 1: update the base register. W = 0: leave the base register untouched
170 */
171 #define ARMV4_5_STMIA(Rn, List, S, W) (0xe8800000 | ((S) << 22) | ((W) << 21) | ((Rn) << 16) | (List))
172
173 /* Load multiple increment after
174 * Rn: base register
175 * List: for each bit in list: store register
176 * S: in priviledged mode: store user-mode registers
177 * W = 1: update the base register. W = 0: leave the base register untouched
178 */
179 #define ARMV4_5_LDMIA(Rn, List, S, W) (0xe8900000 | ((S) << 22) | ((W) << 21) | ((Rn) << 16) | (List))
180
181 /* MOV r8, r8 */
182 #define ARMV4_5_NOP (0xe1a08008)
183
184 /* Move PSR to general purpose register
185 * R = 1: SPSR R = 0: CPSR
186 * Rn: target register
187 */
188 #define ARMV4_5_MRS(Rn, R) (0xe10f0000 | ((R) << 22) | ((Rn) << 12))
189
190 /* Store register
191 * Rd: register to store
192 * Rn: base register
193 */
194 #define ARMV4_5_STR(Rd, Rn) (0xe5800000 | ((Rd) << 12) | ((Rn) << 16))
195
196 /* Load register
197 * Rd: register to load
198 * Rn: base register
199 */
200 #define ARMV4_5_LDR(Rd, Rn) (0xe5900000 | ((Rd) << 12) | ((Rn) << 16))
201
202 /* Move general purpose register to PSR
203 * R = 1: SPSR R = 0: CPSR
204 * Field: Field mask
205 * 1: control field 2: extension field 4: status field 8: flags field
206 * Rm: source register
207 */
208 #define ARMV4_5_MSR_GP(Rm, Field, R) (0xe120f000 | (Rm) | ((Field) << 16) | ((R) << 22))
209 #define ARMV4_5_MSR_IM(Im, Rotate, Field, R) (0xe320f000 | (Im) | ((Rotate) << 8) | ((Field) << 16) | ((R) << 22))
210
211 /* Load Register Halfword Immediate Post-Index
212 * Rd: register to load
213 * Rn: base register
214 */
215 #define ARMV4_5_LDRH_IP(Rd, Rn) (0xe0d000b2 | ((Rd) << 12) | ((Rn) << 16))
216
217 /* Load Register Byte Immediate Post-Index
218 * Rd: register to load
219 * Rn: base register
220 */
221 #define ARMV4_5_LDRB_IP(Rd, Rn) (0xe4d00001 | ((Rd) << 12) | ((Rn) << 16))
222
223 /* Store register Halfword Immediate Post-Index
224 * Rd: register to store
225 * Rn: base register
226 */
227 #define ARMV4_5_STRH_IP(Rd, Rn) (0xe0c000b2 | ((Rd) << 12) | ((Rn) << 16))
228
229 /* Store register Byte Immediate Post-Index
230 * Rd: register to store
231 * Rn: base register
232 */
233 #define ARMV4_5_STRB_IP(Rd, Rn) (0xe4c00001 | ((Rd) << 12) | ((Rn) << 16))
234
235 /* Branch (and Link)
236 * Im: Branch target (left-shifted by 2 bits, added to PC)
237 * L: 1: branch and link 0: branch only
238 */
239 #define ARMV4_5_B(Im, L) (0xea000000 | (Im) | ((L) << 24))
240
241 /* Branch and exchange (ARM state)
242 * Rm: register holding branch target address
243 */
244 #define ARMV4_5_BX(Rm) (0xe12fff10 | (Rm))
245
246 /* Move to ARM register from coprocessor
247 * CP: Coprocessor number
248 * op1: Coprocessor opcode
249 * Rd: destination register
250 * CRn: first coprocessor operand
251 * CRm: second coprocessor operand
252 * op2: Second coprocessor opcode
253 */
254 #define ARMV4_5_MRC(CP, op1, Rd, CRn, CRm, op2) (0xee100010 | (CRm) | ((op2) << 5) | ((CP) << 8) | ((Rd) << 12) | ((CRn) << 16) | ((op1) << 21))
255
256 /* Move to coprocessor from ARM register
257 * CP: Coprocessor number
258 * op1: Coprocessor opcode
259 * Rd: destination register
260 * CRn: first coprocessor operand
261 * CRm: second coprocessor operand
262 * op2: Second coprocessor opcode
263 */
264 #define ARMV4_5_MCR(CP, op1, Rd, CRn, CRm, op2) (0xee000010 | (CRm) | ((op2) << 5) | ((CP) << 8) | ((Rd) << 12) | ((CRn) << 16) | ((op1) << 21))
265
266 /* Breakpoint instruction (ARMv5)
267 * Im: 16-bit immediate
268 */
269 #define ARMV5_BKPT(Im) (0xe1200070 | ((Im & 0xfff0) << 8) | (Im & 0xf))
270
271
272 /* Thumb mode instructions
273 */
274
275 /* Store register (Thumb mode)
276 * Rd: source register
277 * Rn: base register
278 */
279 #define ARMV4_5_T_STR(Rd, Rn) ((0x6000 | (Rd) | ((Rn) << 3)) | ((0x6000 | (Rd) | ((Rn) << 3)) << 16))
280
281 /* Load register (Thumb state)
282 * Rd: destination register
283 * Rn: base register
284 */
285 #define ARMV4_5_T_LDR(Rd, Rn) ((0x6800 | ((Rn) << 3) | (Rd)) | ((0x6800 | ((Rn) << 3) | (Rd)) << 16))
286
287 /* Load multiple (Thumb state)
288 * Rn: base register
289 * List: for each bit in list: store register
290 */
291 #define ARMV4_5_T_LDMIA(Rn, List) ((0xc800 | ((Rn) << 8) | (List)) | ((0xc800 | ((Rn) << 8) | List) << 16))
292
293 /* Load register with PC relative addressing
294 * Rd: register to load
295 */
296 #define ARMV4_5_T_LDR_PCREL(Rd) ((0x4800 | ((Rd) << 8)) | ((0x4800 | ((Rd) << 8)) << 16))
297
298 /* Move hi register (Thumb mode)
299 * Rd: destination register
300 * Rm: source register
301 */
302 #define ARMV4_5_T_MOV(Rd, Rm) ((0x4600 | ((Rd) & 0x7) | (((Rd) & 0x8) << 4) | (((Rm) & 0x7) << 3) | (((Rm) & 0x8) << 3)) | ((0x4600 | ((Rd) & 0x7) | (((Rd) & 0x8) << 4) | (((Rm) & 0x7) << 3) | (((Rm) & 0x8) << 3)) << 16))
303
304 /* No operation (Thumb mode)
305 */
306 #define ARMV4_5_T_NOP (0x46c0 | (0x46c0 << 16))
307
308 /* Move immediate to register (Thumb state)
309 * Rd: destination register
310 * Im: 8-bit immediate value
311 */
312 #define ARMV4_5_T_MOV_IM(Rd, Im) ((0x2000 | ((Rd) << 8) | (Im)) | ((0x2000 | ((Rd) << 8) | (Im)) << 16))
313
314 /* Branch and Exchange
315 * Rm: register containing branch target
316 */
317 #define ARMV4_5_T_BX(Rm) ((0x4700 | ((Rm) << 3)) | ((0x4700 | ((Rm) << 3)) << 16))
318
319 /* Branch (Thumb state)
320 * Imm: Branch target
321 */
322 #define ARMV4_5_T_B(Imm) ((0xe000 | (Imm)) | ((0xe000 | (Imm)) << 16))
323
324 /* Breakpoint instruction (ARMv5) (Thumb state)
325 * Im: 8-bit immediate
326 */
327 #define ARMV5_T_BKPT(Im) ((0xbe00 | Im) | ((0xbe00 | Im) << 16))
328
329 /* build basic mrc/mcr opcode */
330
331 static inline uint32_t mrc_opcode(int cpnum, uint32_t op1, uint32_t op2, uint32_t CRn, uint32_t CRm)
332 {
333 uint32_t t = 0;
334 t|=op1<<21;
335 t|=op2<<5;
336 t|=CRn<<16;
337 t|=CRm<<0;
338 return t;
339 }
340
341 #endif /* ARMV4_5_H */

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)