Ensure Cortex-M reset wakes device from sleep (wfi/wfe)
[fw/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, write to the                         *
16  *   Free Software Foundation, Inc.,                                       *
17  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
18  ***************************************************************************/
19
20 #ifndef ARMV7A_H
21 #define ARMV7A_H
22
23 #include "arm_adi_v5.h"
24 #include "arm.h"
25 #include "armv4_5_mmu.h"
26 #include "armv4_5_cache.h"
27 #include "arm_dpm.h"
28
29 enum {
30         ARM_PC  = 15,
31         ARM_CPSR = 16
32 };
33
34 #define ARMV7_COMMON_MAGIC 0x0A450999
35
36 /* VA to PA translation operations opc2 values*/
37 #define V2PCWPR  0
38 #define V2PCWPW  1
39 #define V2PCWUR  2
40 #define V2PCWUW  3
41 #define V2POWPR  4
42 #define V2POWPW  5
43 #define V2POWUR  6
44 #define V2POWUW  7
45 /*   L210/L220 cache controller support */
46 struct armv7a_l2x_cache {
47         uint32_t base;
48         uint32_t way;
49 };
50
51 struct armv7a_cachesize {
52         uint32_t level_num;
53         /*  cache dimensionning */
54         uint32_t linelen;
55         uint32_t associativity;
56         uint32_t nsets;
57         uint32_t cachesize;
58         /* info for set way operation on cache */
59         uint32_t index;
60         uint32_t index_shift;
61         uint32_t way;
62         uint32_t way_shift;
63 };
64
65 struct armv7a_cache_common {
66         int ctype;
67         struct armv7a_cachesize d_u_size;       /* data cache */
68         struct armv7a_cachesize i_size;         /* instruction cache */
69         int i_cache_enabled;
70         int d_u_cache_enabled;
71         /* l2 external unified cache if some */
72         void *l2_cache;
73         int (*flush_all_data_cache)(struct target *target);
74         int (*display_cache_info)(struct command_context *cmd_ctx,
75                         struct armv7a_cache_common *armv7a_cache);
76 };
77
78 struct armv7a_mmu_common {
79         /* following field mmu working way */
80         int32_t ttbr1_used; /*  -1 not initialized, 0 no ttbr1 1 ttbr1 used and  */
81         uint32_t ttbr0_mask;/*  masked to be used  */
82         uint32_t os_border;
83
84         int (*read_physical_memory)(struct target *target, uint32_t address, uint32_t size,
85                         uint32_t count, uint8_t *buffer);
86         struct armv7a_cache_common armv7a_cache;
87         uint32_t mmu_enabled;
88 };
89
90 struct armv7a_common {
91         struct arm arm;
92         int common_magic;
93         struct reg_cache *core_cache;
94
95         struct adiv5_dap dap;
96
97         /* Core Debug Unit */
98         struct arm_dpm dpm;
99         uint32_t debug_base;
100         uint8_t debug_ap;
101         uint8_t memory_ap;
102         /* mdir */
103         uint8_t multi_processor_system;
104         uint8_t cluster_id;
105         uint8_t cpu_id;
106
107         /* cache specific to V7 Memory Management Unit compatible with v4_5*/
108         struct armv7a_mmu_common armv7a_mmu;
109
110         int (*examine_debug_reason)(struct target *target);
111         int (*post_debug_entry)(struct target *target);
112
113         void (*pre_restore_context)(struct target *target);
114 };
115
116 static inline struct armv7a_common *
117 target_to_armv7a(struct target *target)
118 {
119         return container_of(target->arch_info, struct armv7a_common, arm);
120 }
121
122 /* register offsets from armv7a.debug_base */
123
124 /* See ARMv7a arch spec section C10.2 */
125 #define CPUDBG_DIDR             0x000
126
127 /* See ARMv7a arch spec section C10.3 */
128 #define CPUDBG_WFAR             0x018
129 /* PCSR at 0x084 -or- 0x0a0 -or- both ... based on flags in DIDR */
130 #define CPUDBG_DSCR             0x088
131 #define CPUDBG_DRCR             0x090
132 #define CPUDBG_PRCR             0x310
133 #define CPUDBG_PRSR             0x314
134
135 /* See ARMv7a arch spec section C10.4 */
136 #define CPUDBG_DTRRX            0x080
137 #define CPUDBG_ITR              0x084
138 #define CPUDBG_DTRTX            0x08c
139
140 /* See ARMv7a arch spec section C10.5 */
141 #define CPUDBG_BVR_BASE         0x100
142 #define CPUDBG_BCR_BASE         0x140
143 #define CPUDBG_WVR_BASE         0x180
144 #define CPUDBG_WCR_BASE         0x1C0
145 #define CPUDBG_VCR              0x01C
146
147 /* See ARMv7a arch spec section C10.6 */
148 #define CPUDBG_OSLAR            0x300
149 #define CPUDBG_OSLSR            0x304
150 #define CPUDBG_OSSRR            0x308
151 #define CPUDBG_ECR              0x024
152
153 /* See ARMv7a arch spec section C10.7 */
154 #define CPUDBG_DSCCR            0x028
155
156 /* See ARMv7a arch spec section C10.8 */
157 #define CPUDBG_AUTHSTATUS       0xFB8
158
159 int armv7a_arch_state(struct target *target);
160 int armv7a_identify_cache(struct target *target);
161 int armv7a_init_arch_info(struct target *target, struct armv7a_common *armv7a);
162 int armv7a_mmu_translate_va_pa(struct target *target, uint32_t va,
163                 uint32_t *val, int meminfo);
164 int armv7a_mmu_translate_va(struct target *target,  uint32_t va, uint32_t *val);
165
166 int armv7a_handle_cache_info_command(struct command_context *cmd_ctx,
167                 struct armv7a_cache_common *armv7a_cache);
168
169 extern const struct command_registration armv7a_command_handlers[];
170
171 #endif /* ARMV4_5_H */