]> git.sur5r.net Git - openocd/blob - src/target/armv7a.h
Remove FSF address from GPL notices
[openocd] / src / target / armv7a.h
1 /***************************************************************************
2  *    Copyright (C) 2009 by David Brownell                                 *
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, see <http://www.gnu.org/licenses/>. *
16  ***************************************************************************/
17
18 #ifndef ARMV7A_H
19 #define ARMV7A_H
20
21 #include "arm_adi_v5.h"
22 #include "armv7a_cache.h"
23 #include "arm.h"
24 #include "armv4_5_mmu.h"
25 #include "armv4_5_cache.h"
26 #include "arm_dpm.h"
27
28 enum {
29         ARM_PC  = 15,
30         ARM_CPSR = 16
31 };
32
33 #define ARMV7_COMMON_MAGIC 0x0A450999
34
35 /* VA to PA translation operations opc2 values*/
36 #define V2PCWPR  0
37 #define V2PCWPW  1
38 #define V2PCWUR  2
39 #define V2PCWUW  3
40 #define V2POWPR  4
41 #define V2POWPW  5
42 #define V2POWUR  6
43 #define V2POWUW  7
44 /*   L210/L220 cache controller support */
45 struct armv7a_l2x_cache {
46         uint32_t base;
47         uint32_t way;
48 };
49
50 struct armv7a_cachesize {
51         uint32_t level_num;
52         /*  cache dimensionning */
53         uint32_t linelen;
54         uint32_t associativity;
55         uint32_t nsets;
56         uint32_t cachesize;
57         /* info for set way operation on cache */
58         uint32_t index;
59         uint32_t index_shift;
60         uint32_t way;
61         uint32_t way_shift;
62 };
63
64 /* information about one architecture cache at any level */
65 struct armv7a_arch_cache {
66         int ctype;                              /* cache type, CLIDR encoding */
67         struct armv7a_cachesize d_u_size;       /* data cache */
68         struct armv7a_cachesize i_size;         /* instruction cache */
69 };
70
71 /* common cache information */
72 struct armv7a_cache_common {
73         int info;                               /* -1 invalid, else valid */
74         int loc;                                /* level of coherency */
75         uint32_t dminline;                      /* minimum d-cache linelen */
76         uint32_t iminline;                      /* minimum i-cache linelen */
77         struct armv7a_arch_cache arch[6];       /* cache info, L1 - L7 */
78         int i_cache_enabled;
79         int d_u_cache_enabled;
80         int auto_cache_enabled;                 /* openocd automatic
81                                                  * cache handling */
82         /* outer unified cache if some */
83         void *outer_cache;
84         int (*flush_all_data_cache)(struct target *target);
85 };
86
87 struct armv7a_mmu_common {
88         /* following field mmu working way */
89         int32_t cached;     /* 0: not initialized, 1: initialized */
90         uint32_t ttbcr;     /* cache for ttbcr register */
91         uint32_t ttbr_mask[2];
92         uint32_t ttbr_range[2];
93
94         int (*read_physical_memory)(struct target *target, uint32_t address, uint32_t size,
95                         uint32_t count, uint8_t *buffer);
96         struct armv7a_cache_common armv7a_cache;
97         uint32_t mmu_enabled;
98 };
99
100 struct armv7a_common {
101         struct arm arm;
102         int common_magic;
103         struct reg_cache *core_cache;
104
105         /* Core Debug Unit */
106         struct arm_dpm dpm;
107         uint32_t debug_base;
108         struct adiv5_ap *debug_ap;
109         struct adiv5_ap *memory_ap;
110         bool memory_ap_available;
111         /* mdir */
112         uint8_t multi_processor_system;
113         uint8_t cluster_id;
114         uint8_t cpu_id;
115         bool is_armv7r;
116         uint32_t rev;
117         uint32_t partnum;
118         uint32_t arch;
119         uint32_t variant;
120         uint32_t implementor;
121
122         /* cache specific to V7 Memory Management Unit compatible with v4_5*/
123         struct armv7a_mmu_common armv7a_mmu;
124
125         int (*examine_debug_reason)(struct target *target);
126         int (*post_debug_entry)(struct target *target);
127
128         void (*pre_restore_context)(struct target *target);
129 };
130
131 static inline struct armv7a_common *
132 target_to_armv7a(struct target *target)
133 {
134         return container_of(target->arch_info, struct armv7a_common, arm);
135 }
136
137 /* register offsets from armv7a.debug_base */
138
139 /* See ARMv7a arch spec section C10.2 */
140 #define CPUDBG_DIDR             0x000
141
142 /* See ARMv7a arch spec section C10.3 */
143 #define CPUDBG_WFAR             0x018
144 /* PCSR at 0x084 -or- 0x0a0 -or- both ... based on flags in DIDR */
145 #define CPUDBG_DSCR             0x088
146 #define CPUDBG_DRCR             0x090
147 #define CPUDBG_PRCR             0x310
148 #define CPUDBG_PRSR             0x314
149
150 /* See ARMv7a arch spec section C10.4 */
151 #define CPUDBG_DTRRX            0x080
152 #define CPUDBG_ITR              0x084
153 #define CPUDBG_DTRTX            0x08c
154
155 /* See ARMv7a arch spec section C10.5 */
156 #define CPUDBG_BVR_BASE         0x100
157 #define CPUDBG_BCR_BASE         0x140
158 #define CPUDBG_WVR_BASE         0x180
159 #define CPUDBG_WCR_BASE         0x1C0
160 #define CPUDBG_VCR              0x01C
161
162 /* See ARMv7a arch spec section C10.6 */
163 #define CPUDBG_OSLAR            0x300
164 #define CPUDBG_OSLSR            0x304
165 #define CPUDBG_OSSRR            0x308
166 #define CPUDBG_ECR              0x024
167
168 /* See ARMv7a arch spec section C10.7 */
169 #define CPUDBG_DSCCR            0x028
170 #define CPUDBG_DSMCR            0x02C
171
172 /* See ARMv7a arch spec section C10.8 */
173 #define CPUDBG_AUTHSTATUS       0xFB8
174
175 int armv7a_arch_state(struct target *target);
176 int armv7a_identify_cache(struct target *target);
177 int armv7a_init_arch_info(struct target *target, struct armv7a_common *armv7a);
178 int armv7a_mmu_translate_va_pa(struct target *target, uint32_t va,
179                 uint32_t *val, int meminfo);
180 int armv7a_mmu_translate_va(struct target *target,  uint32_t va, uint32_t *val);
181
182 int armv7a_handle_cache_info_command(struct command_context *cmd_ctx,
183                 struct armv7a_cache_common *armv7a_cache);
184
185 extern const struct command_registration armv7a_command_handlers[];
186
187 #endif /* ARMV4_5_H */