target_t -> struct target
[fw/openocd] / src / target / cortex_m3.h
1 /***************************************************************************
2  *   Copyright (C) 2005 by Dominic Rath                                    *
3  *   Dominic.Rath@gmx.de                                                   *
4  *                                                                         *
5  *   Copyright (C) 2006 by Magnus Lundin                                   *
6  *   lundin@mlu.mine.nu                                                    *
7  *                                                                         *
8  *   Copyright (C) 2008 by Spencer Oliver                                  *
9  *   spen@spen-soft.co.uk                                                  *
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 CORTEX_M3_H
27 #define CORTEX_M3_H
28
29 #include "register.h"
30 #include "target.h"
31 #include "armv7m.h"
32
33
34 #define CORTEX_M3_COMMON_MAGIC 0x1A451A45
35
36 #define SYSTEM_CONTROL_BASE 0x400FE000
37
38 #define CPUID           0xE000ED00
39 /* Debug Control Block */
40 #define DCB_DHCSR       0xE000EDF0
41 #define DCB_DCRSR       0xE000EDF4
42 #define DCB_DCRDR       0xE000EDF8
43 #define DCB_DEMCR       0xE000EDFC
44
45 #define DCRSR_WnR       (1 << 16)
46
47 #define DWT_CTRL        0xE0001000
48 #define DWT_CYCCNT      0xE0001004
49 #define DWT_COMP0       0xE0001020
50 #define DWT_MASK0       0xE0001024
51 #define DWT_FUNCTION0   0xE0001028
52
53 #define FP_CTRL         0xE0002000
54 #define FP_REMAP        0xE0002004
55 #define FP_COMP0        0xE0002008
56 #define FP_COMP1        0xE000200C
57 #define FP_COMP2        0xE0002010
58 #define FP_COMP3        0xE0002014
59 #define FP_COMP4        0xE0002018
60 #define FP_COMP5        0xE000201C
61 #define FP_COMP6        0xE0002020
62 #define FP_COMP7        0xE0002024
63
64 /* DCB_DHCSR bit and field definitions */
65 #define DBGKEY          (0xA05F << 16)
66 #define C_DEBUGEN       (1 << 0)
67 #define C_HALT          (1 << 1)
68 #define C_STEP          (1 << 2)
69 #define C_MASKINTS      (1 << 3)
70 #define S_REGRDY        (1 << 16)
71 #define S_HALT          (1 << 17)
72 #define S_SLEEP         (1 << 18)
73 #define S_LOCKUP        (1 << 19)
74 #define S_RETIRE_ST     (1 << 24)
75 #define S_RESET_ST      (1 << 25)
76
77 /* DCB_DEMCR bit and field definitions */
78 #define TRCENA                  (1 << 24)
79 #define VC_HARDERR              (1 << 10)
80 #define VC_INTERR               (1 << 9)
81 #define VC_BUSERR               (1 << 8)
82 #define VC_STATERR              (1 << 7)
83 #define VC_CHKERR               (1 << 6)
84 #define VC_NOCPERR              (1 << 5)
85 #define VC_MMERR                (1 << 4)
86 #define VC_CORERESET    (1 << 0)
87
88 #define NVIC_ICTR               0xE000E004
89 #define NVIC_ISE0               0xE000E100
90 #define NVIC_ICSR               0xE000ED04
91 #define NVIC_AIRCR              0xE000ED0C
92 #define NVIC_SHCSR              0xE000ED24
93 #define NVIC_CFSR               0xE000ED28
94 #define NVIC_MMFSRb             0xE000ED28
95 #define NVIC_BFSRb              0xE000ED29
96 #define NVIC_USFSRh             0xE000ED2A
97 #define NVIC_HFSR               0xE000ED2C
98 #define NVIC_DFSR               0xE000ED30
99 #define NVIC_MMFAR              0xE000ED34
100 #define NVIC_BFAR               0xE000ED38
101
102 /* NVIC_AIRCR bits */
103 #define AIRCR_VECTKEY           (0x5FA << 16)
104 #define AIRCR_SYSRESETREQ       (1 << 2)
105 #define AIRCR_VECTCLRACTIVE     (1 << 1)
106 #define AIRCR_VECTRESET         (1 << 0)
107 /* NVIC_SHCSR bits */
108 #define SHCSR_BUSFAULTENA       (1 << 17)
109 /* NVIC_DFSR bits */
110 #define DFSR_HALTED                     1
111 #define DFSR_BKPT                       2
112 #define DFSR_DWTTRAP            4
113 #define DFSR_VCATCH                     8
114
115 #define FPCR_CODE 0
116 #define FPCR_LITERAL 1
117 #define FPCR_REPLACE_REMAP  (0 << 30)
118 #define FPCR_REPLACE_BKPT_LOW  (1 << 30)
119 #define FPCR_REPLACE_BKPT_HIGH  (2 << 30)
120 #define FPCR_REPLACE_BKPT_BOTH  (3 << 30)
121
122 struct cortex_m3_fp_comparator
123 {
124         int used;
125         int type;
126         uint32_t fpcr_value;
127         uint32_t fpcr_address;
128 };
129
130 struct cortex_m3_dwt_comparator
131 {
132         int used;
133         uint32_t comp;
134         uint32_t mask;
135         uint32_t function;
136         uint32_t dwt_comparator_address;
137 };
138
139 struct cortex_m3_common
140 {
141         int common_magic;
142         struct arm_jtag jtag_info;
143
144         /* Context information */
145         uint32_t dcb_dhcsr;
146         uint32_t nvic_dfsr;  /* Debug Fault Status Register - shows reason for debug halt */
147         uint32_t nvic_icsr;  /* Interrupt Control State Register - shows active and pending IRQ */
148
149         /* Flash Patch and Breakpoint (FPB) */
150         int fp_num_lit;
151         int fp_num_code;
152         int fp_code_available;
153         int fpb_enabled;
154         int auto_bp_type;
155         struct cortex_m3_fp_comparator *fp_comparator_list;
156
157         /* Data Watchpoint and Trace (DWT) */
158         int dwt_num_comp;
159         int dwt_comp_available;
160         struct cortex_m3_dwt_comparator *dwt_comparator_list;
161         struct reg_cache *dwt_cache;
162
163         struct armv7m_common armv7m;
164 };
165
166 static inline struct cortex_m3_common *
167 target_to_cm3(struct target *target)
168 {
169         return container_of(target->arch_info,
170                         struct cortex_m3_common, armv7m);
171 }
172
173 #endif /* CORTEX_M3_H */