f6859b2993974dc7a2a4c2dee99f6e8211038bf8
[openocd.git] / src / target / armv8.h
1 /***************************************************************************
2 * Copyright (C) 2015 by David Ung *
3 * *
4 * This program is free software; you can redistribute it and/or modify *
5 * it under the terms of the GNU General Public License as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
8 * *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
13 * *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program; if not, write to the *
16 * Free Software Foundation, Inc., *
17 ***************************************************************************/
18
19 #ifndef OPENOCD_TARGET_ARMV8_H
20 #define OPENOCD_TARGET_ARMV8_H
21
22 #include "arm_adi_v5.h"
23 #include "arm.h"
24 #include "armv4_5_mmu.h"
25 #include "armv4_5_cache.h"
26 #include "armv8_dpm.h"
27
28 enum {
29 ARMV8_R0,
30 ARMV8_R1,
31 ARMV8_R2,
32 ARMV8_R3,
33 ARMV8_R4,
34 ARMV8_R5,
35 ARMV8_R6,
36 ARMV8_R7,
37 ARMV8_R8,
38 ARMV8_R9,
39 ARMV8_R10,
40 ARMV8_R11,
41 ARMV8_R12,
42 ARMV8_R13,
43 ARMV8_R14,
44 ARMV8_R15,
45 ARMV8_R16,
46 ARMV8_R17,
47 ARMV8_R18,
48 ARMV8_R19,
49 ARMV8_R20,
50 ARMV8_R21,
51 ARMV8_R22,
52 ARMV8_R23,
53 ARMV8_R24,
54 ARMV8_R25,
55 ARMV8_R26,
56 ARMV8_R27,
57 ARMV8_R28,
58 ARMV8_R29,
59 ARMV8_R30,
60 ARMV8_R31,
61
62 ARMV8_PC = 32,
63 ARMV8_xPSR = 33,
64
65 ARMV8_LAST_REG,
66 };
67
68
69 #define ARMV8_COMMON_MAGIC 0x0A450AAA
70
71 /* VA to PA translation operations opc2 values*/
72 #define V2PCWPR 0
73 #define V2PCWPW 1
74 #define V2PCWUR 2
75 #define V2PCWUW 3
76 #define V2POWPR 4
77 #define V2POWPW 5
78 #define V2POWUR 6
79 #define V2POWUW 7
80 /* L210/L220 cache controller support */
81 struct armv8_l2x_cache {
82 uint32_t base;
83 uint32_t way;
84 };
85
86 struct armv8_cachesize {
87 uint32_t level_num;
88 /* cache dimensionning */
89 uint32_t linelen;
90 uint32_t associativity;
91 uint32_t nsets;
92 uint32_t cachesize;
93 /* info for set way operation on cache */
94 uint32_t index;
95 uint32_t index_shift;
96 uint32_t way;
97 uint32_t way_shift;
98 };
99
100 struct armv8_cache_common {
101 int ctype;
102 struct armv8_cachesize d_u_size; /* data cache */
103 struct armv8_cachesize i_size; /* instruction cache */
104 int i_cache_enabled;
105 int d_u_cache_enabled;
106 /* l2 external unified cache if some */
107 void *l2_cache;
108 int (*flush_all_data_cache)(struct target *target);
109 int (*display_cache_info)(struct command_context *cmd_ctx,
110 struct armv8_cache_common *armv8_cache);
111 };
112
113 struct armv8_mmu_common {
114 /* following field mmu working way */
115 int32_t ttbr1_used; /* -1 not initialized, 0 no ttbr1 1 ttbr1 used and */
116 uint64_t ttbr0_mask;/* masked to be used */
117 uint32_t os_border;
118
119 int (*read_physical_memory)(struct target *target, target_addr_t address,
120 uint32_t size, uint32_t count, uint8_t *buffer);
121 struct armv8_cache_common armv8_cache;
122 uint32_t mmu_enabled;
123 };
124
125 struct armv8_common {
126 struct arm arm;
127 int common_magic;
128 struct reg_cache *core_cache;
129
130 /* Core Debug Unit */
131 struct arm_dpm dpm;
132 uint32_t debug_base;
133 uint32_t cti_base;
134 struct adiv5_ap *debug_ap;
135
136 /* mdir */
137 uint8_t multi_processor_system;
138 uint8_t cluster_id;
139 uint8_t cpu_id;
140
141 /* armv8 aarch64 need below information for page translation */
142 uint8_t va_size;
143 uint8_t pa_size;
144 uint32_t page_size;
145 uint64_t ttbr_base;
146
147 /* cache specific to V7 Memory Management Unit compatible with v4_5*/
148 struct armv8_mmu_common armv8_mmu;
149
150 /* Direct processor core register read and writes */
151 int (*load_core_reg_u64)(struct target *target, uint32_t num, uint64_t *value);
152 int (*store_core_reg_u64)(struct target *target, uint32_t num, uint64_t value);
153
154 int (*examine_debug_reason)(struct target *target);
155 int (*post_debug_entry)(struct target *target);
156
157 void (*pre_restore_context)(struct target *target);
158 };
159
160 static inline struct armv8_common *
161 target_to_armv8(struct target *target)
162 {
163 return container_of(target->arch_info, struct armv8_common, arm);
164 }
165
166 /* register offsets from armv8.debug_base */
167 #define CPUV8_DBG_MAINID0 0xD00
168 #define CPUV8_DBG_CPUFEATURE0 0xD20
169 #define CPUV8_DBG_DBGFEATURE0 0xD28
170 #define CPUV8_DBG_MEMFEATURE0 0xD38
171
172 #define CPUV8_DBG_LOCKACCESS 0xFB0
173 #define CPUV8_DBG_LOCKSTATUS 0xFB4
174
175 #define CPUV8_DBG_EDESR 0x20
176 #define CPUV8_DBG_EDECR 0x24
177 #define CPUV8_DBG_WFAR0 0x30
178 #define CPUV8_DBG_WFAR1 0x34
179 #define CPUV8_DBG_DSCR 0x088
180 #define CPUV8_DBG_DRCR 0x090
181 #define CPUV8_DBG_PRCR 0x310
182 #define CPUV8_DBG_PRSR 0x314
183
184 #define CPUV8_DBG_DTRRX 0x080
185 #define CPUV8_DBG_ITR 0x084
186 #define CPUV8_DBG_SCR 0x088
187 #define CPUV8_DBG_DTRTX 0x08c
188
189 #define CPUV8_DBG_BVR_BASE 0x400
190 #define CPUV8_DBG_BCR_BASE 0x408
191 #define CPUV8_DBG_WVR_BASE 0x800
192 #define CPUV8_DBG_WCR_BASE 0x808
193 #define CPUV8_DBG_VCR 0x01C
194
195 #define CPUV8_DBG_OSLAR 0x300
196
197 #define CPUV8_DBG_AUTHSTATUS 0xFB8
198
199 /*define CTI(cross trigger interface)*/
200 #define CTI_CTR 0x0
201 #define CTI_INACK 0x10
202 #define CTI_APPSET 0x14
203 #define CTI_APPCLEAR 0x18
204 #define CTI_APPPULSE 0x1C
205 #define CTI_INEN0 0x20
206 #define CTI_INEN1 0x24
207 #define CTI_INEN2 0x28
208 #define CTI_INEN3 0x2C
209 #define CTI_INEN4 0x30
210 #define CTI_INEN5 0x34
211 #define CTI_INEN6 0x38
212 #define CTI_INEN7 0x3C
213 #define CTI_OUTEN0 0xA0
214 #define CTI_OUTEN1 0xA4
215 #define CTI_OUTEN2 0xA8
216 #define CTI_OUTEN3 0xAC
217 #define CTI_OUTEN4 0xB0
218 #define CTI_OUTEN5 0xB4
219 #define CTI_OUTEN6 0xB8
220 #define CTI_OUTEN7 0xBC
221 #define CTI_TRIN_STATUS 0x130
222 #define CTI_TROUT_STATUS 0x134
223 #define CTI_CHIN_STATUS 0x138
224 #define CTI_CHOU_STATUS 0x13C
225 #define CTI_GATE 0x140
226 #define CTI_UNLOCK 0xFB0
227
228 #define CTI_CHNL(x) (1 << x)
229 #define CTI_TRIG_HALT 0
230 #define CTI_TRIG_RESUME 1
231 #define CTI_TRIG(n) (1 << CTI_TRIG_##n)
232
233 #define PAGE_SIZE_4KB 0x1000
234 #define PAGE_SIZE_4KB_LEVEL0_BITS 39
235 #define PAGE_SIZE_4KB_LEVEL1_BITS 30
236 #define PAGE_SIZE_4KB_LEVEL2_BITS 21
237 #define PAGE_SIZE_4KB_LEVEL3_BITS 12
238
239 #define PAGE_SIZE_4KB_LEVEL0_MASK ((0x1FFULL) << PAGE_SIZE_4KB_LEVEL0_BITS)
240 #define PAGE_SIZE_4KB_LEVEL1_MASK ((0x1FFULL) << PAGE_SIZE_4KB_LEVEL1_BITS)
241 #define PAGE_SIZE_4KB_LEVEL2_MASK ((0x1FFULL) << PAGE_SIZE_4KB_LEVEL2_BITS)
242 #define PAGE_SIZE_4KB_LEVEL3_MASK ((0x1FFULL) << PAGE_SIZE_4KB_LEVEL3_BITS)
243
244 #define PAGE_SIZE_4KB_TRBBASE_MASK 0xFFFFFFFFF000
245
246 int armv8_arch_state(struct target *target);
247 int armv8_identify_cache(struct target *target);
248 int armv8_init_arch_info(struct target *target, struct armv8_common *armv8);
249 int armv8_mmu_translate_va_pa(struct target *target, target_addr_t va,
250 target_addr_t *val, int meminfo);
251 int armv8_mmu_translate_va(struct target *target, target_addr_t va, target_addr_t *val);
252
253 int armv8_handle_cache_info_command(struct command_context *cmd_ctx,
254 struct armv8_cache_common *armv8_cache);
255
256 void armv8_set_cpsr(struct arm *arm, uint32_t cpsr);
257
258 extern const struct command_registration armv8_command_handlers[];
259
260 #endif