1 /***************************************************************************
2 * Copyright (C) 2013-2015,2019-2020 Synopsys, Inc. *
3 * Frank Dols <frank.dols@synopsys.com> *
4 * Mischa Jonker <mischa.jonker@synopsys.com> *
5 * Anton Kolesov <anton.kolesov@synopsys.com> *
6 * Evgeniy Didin <didin@synopsys.com> *
8 * SPDX-License-Identifier: GPL-2.0-or-later *
9 ***************************************************************************/
11 #ifndef OPENOCD_TARGET_ARC_H
12 #define OPENOCD_TARGET_ARC_H
14 #include <helper/time_support.h>
15 #include <jtag/jtag.h>
17 #include "algorithm.h"
18 #include "breakpoints.h"
19 #include "jtag/interface.h"
22 #include "target_request.h"
23 #include "target_type.h"
24 #include "helper/bits.h"
30 #define ARC_COMMON_MAGIC 0xB32EB324 /* just a unique number */
32 #define AUX_DEBUG_REG 0x5
33 #define AUX_PC_REG 0x6
34 #define AUX_STATUS32_REG 0xA
37 #define SET_CORE_FORCE_HALT BIT(1)
38 #define SET_CORE_HALT_BIT BIT(0) /* STATUS32[0] = H field */
39 #define SET_CORE_ENABLE_INTERRUPTS BIT(31)
40 /* STATUS32[5] or AE bit indicates if the processor is in exception state */
41 #define SET_CORE_AE_BIT BIT(5)
42 /* Single instruction step bit in Debug register */
43 #define SET_CORE_SINGLE_INSTR_STEP BIT(11)
45 #define AUX_STATUS32_REG_HALT_BIT BIT(0)
46 #define AUX_STATUS32_REG_IE_BIT BIT(31) /* STATUS32[31] = IE field */
48 /* Reserved core registers */
49 #define CORE_R61_NUM (61)
50 #define CORE_R62_NUM (62)
52 #define CORE_REG_MAX_NUMBER (63)
54 /* Limit reg_type/reg_type_field name to 20 symbols */
55 #define REG_TYPE_MAX_NAME_LENGTH 20
57 /* ARC 32bits opcodes */
58 #define ARC_SDBBP_32 0x256F003FU /* BRK */
60 /* ARC 16bits opcodes */
61 #define ARC_SDBBP_16 0x7FFF /* BRK_S */
64 #define AUX_IC_IVIC_REG 0X10
65 #define IC_IVIC_INVALIDATE 0XFFFFFFFF
67 #define AUX_DC_IVDC_REG 0X47
68 #define DC_IVDC_INVALIDATE BIT(0)
69 #define AUX_DC_CTRL_REG 0X48
70 #define DC_CTRL_IM BIT(6)
72 /* L2 cache registers */
73 #define SLC_AUX_CACHE_CTRL 0x903
74 #define L2_CTRL_IM BIT(6)
75 #define L2_CTRL_BS BIT(8) /* Busy flag */
76 #define SLC_AUX_CACHE_FLUSH 0x904
77 #define L2_FLUSH_FL BIT(0)
78 #define SLC_AUX_CACHE_INV 0x905
79 #define L2_INV_IV BIT(0)
82 #define AP_AC_AT_INST_ADDR 0x0
83 #define AP_AC_AT_MEMORY_ADDR 0x2
84 #define AP_AC_AT_AUXREG_ADDR 0x4
86 #define AP_AC_TT_DISABLE 0x00
87 #define AP_AC_TT_WRITE 0x10
88 #define AP_AC_TT_READ 0x20
89 #define AP_AC_TT_READWRITE 0x30
91 struct arc_reg_bitfield
{
92 struct reg_data_type_bitfield bitfield
;
93 char name
[REG_TYPE_MAX_NAME_LENGTH
];
95 /* Register data type */
96 struct arc_reg_data_type
{
97 struct list_head list
;
98 struct reg_data_type data_type
;
99 struct reg_data_type_flags data_type_flags
;
100 struct reg_data_type_struct data_type_struct
;
101 char data_type_id
[REG_TYPE_MAX_NAME_LENGTH
];
102 struct arc_reg_bitfield
*bitfields
;
104 struct reg_data_type_struct_field
*reg_type_struct_field
;
105 struct reg_data_type_flags_field
*reg_type_flags_field
;
109 /* Standard GDB register types */
110 static const struct reg_data_type standard_gdb_types
[] = {
111 { .type
= REG_TYPE_INT
, .id
= "int" },
112 { .type
= REG_TYPE_INT8
, .id
= "int8" },
113 { .type
= REG_TYPE_INT16
, .id
= "int16" },
114 { .type
= REG_TYPE_INT32
, .id
= "int32" },
115 { .type
= REG_TYPE_INT64
, .id
= "int64" },
116 { .type
= REG_TYPE_INT128
, .id
= "int128" },
117 { .type
= REG_TYPE_UINT8
, .id
= "uint8" },
118 { .type
= REG_TYPE_UINT16
, .id
= "uint16" },
119 { .type
= REG_TYPE_UINT32
, .id
= "uint32" },
120 { .type
= REG_TYPE_UINT64
, .id
= "uint64" },
121 { .type
= REG_TYPE_UINT128
, .id
= "uint128" },
122 { .type
= REG_TYPE_CODE_PTR
, .id
= "code_ptr" },
123 { .type
= REG_TYPE_DATA_PTR
, .id
= "data_ptr" },
124 { .type
= REG_TYPE_FLOAT
, .id
= "float" },
125 { .type
= REG_TYPE_IEEE_SINGLE
, .id
= "ieee_single" },
126 { .type
= REG_TYPE_IEEE_DOUBLE
, .id
= "ieee_double" },
129 enum arc_actionpointype
{
134 /* Actionpoint related fields */
135 struct arc_actionpoint
{
138 uint32_t reg_address
;
139 enum arc_actionpointype type
;
143 uint32_t common_magic
;
145 struct arc_jtag jtag_info
;
147 struct reg_cache
*core_and_aux_cache
;
148 struct reg_cache
*bcr_cache
;
154 /* If true, then D$ has been already flushed since core has been
157 /* If true, then L2 has been already flushed since core has been
159 bool l2cache_flushed
;
160 /* If true, then caches have been already flushed since core has been
162 bool icache_invalidated
;
163 bool dcache_invalidated
;
164 bool l2cache_invalidated
;
166 /* Indicate if cach was built (for deinit function) */
167 bool core_aux_cache_built
;
168 bool bcr_cache_built
;
169 /* Closely Coupled memory(CCM) regions for performance-critical
170 * code (optional). */
171 uint32_t iccm0_start
;
173 uint32_t iccm1_start
;
180 /* Register descriptions */
181 struct list_head reg_data_types
;
182 struct list_head core_reg_descriptions
;
183 struct list_head aux_reg_descriptions
;
184 struct list_head bcr_reg_descriptions
;
185 unsigned long num_regs
;
186 unsigned long num_core_regs
;
187 unsigned long num_aux_regs
;
188 unsigned long num_bcr_regs
;
189 unsigned long last_general_reg
;
191 /* PC register location in register cache. */
192 unsigned long pc_index_in_cache
;
193 /* DEBUG register location in register cache. */
194 unsigned long debug_index_in_cache
;
197 unsigned int actionpoints_num
;
198 unsigned int actionpoints_num_avail
;
199 struct arc_actionpoint
*actionpoints_list
;
202 /* Borrowed from nds32.h */
203 #define CHECK_RETVAL(action) \
205 int __retval = (action); \
206 if (__retval != ERROR_OK) { \
207 LOG_DEBUG("error while calling \"%s\"", \
213 #define JIM_CHECK_RETVAL(action) \
215 int __retval = (action); \
216 if (__retval != JIM_OK) { \
217 LOG_DEBUG("error while calling \"%s\"", \
223 static inline struct arc_common
*target_to_arc(struct target
*target
)
225 return target
->arch_info
;
228 /* ----- Inlined functions ------------------------------------------------- */
231 * Convert data in host endianness to the middle endian. This is required to
232 * write 4-byte instructions.
234 static inline void arc_h_u32_to_me(uint8_t *buf
, int val
)
236 buf
[1] = (uint8_t) (val
>> 24);
237 buf
[0] = (uint8_t) (val
>> 16);
238 buf
[3] = (uint8_t) (val
>> 8);
239 buf
[2] = (uint8_t) (val
>> 0);
243 * Convert data in middle endian to host endian. This is required to read 32-bit
244 * instruction from little endian ARCs.
246 static inline uint32_t arc_me_to_h_u32(const uint8_t *buf
)
248 return (uint32_t)(buf
[2] | buf
[3] << 8 | buf
[0] << 16 | buf
[1] << 24);
252 /* ARC Register description */
253 struct arc_reg_desc
{
255 struct target
*target
;
260 /* Actual place of storing reg_value */
261 uint8_t reg_value
[4];
263 /* Actual place of storing register feature */
264 struct reg_feature feature
;
266 /* GDB XML feature */
267 char *gdb_xml_feature
;
269 /* Is this a register in g/G-packet? */
272 /* Architectural number: core reg num or AUX reg num */
275 /* Core or AUX register? */
278 /* Build configuration register? */
282 struct reg_data_type
*data_type
;
284 struct list_head list
;
288 #define ERROR_ARC_REGISTER_NOT_FOUND (-700)
289 #define ERROR_ARC_REGISTER_FIELD_NOT_FOUND (-701)
290 #define ERROR_ARC_REGISTER_IS_NOT_STRUCT (-702)
291 #define ERROR_ARC_FIELD_IS_NOT_BITFIELD (-703)
292 #define ERROR_ARC_REGTYPE_NOT_FOUND (-704)
294 void free_reg_desc(struct arc_reg_desc
*r
);
297 void arc_reg_data_type_add(struct target
*target
,
298 struct arc_reg_data_type
*data_type
);
300 int arc_reg_add(struct target
*target
, struct arc_reg_desc
*arc_reg
,
301 const char * const type_name
, const size_t type_name_len
);
303 struct reg
*arc_reg_get_by_name(struct reg_cache
*first
,
304 const char *name
, bool search_all
);
306 int arc_reg_get_field(struct target
*target
, const char *reg_name
,
307 const char *field_name
, uint32_t *value_ptr
);
309 int arc_cache_flush(struct target
*target
);
310 int arc_cache_invalidate(struct target
*target
);
312 int arc_add_auxreg_actionpoint(struct target
*target
,
313 uint32_t auxreg_addr
, uint32_t transaction
);
314 int arc_remove_auxreg_actionpoint(struct target
*target
, uint32_t auxreg_addr
);
315 int arc_set_actionpoints_num(struct target
*target
, uint32_t ap_num
);
317 #endif /* OPENOCD_TARGET_ARC_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)