- str9x flash support (Thanks to Spencer Oliver)
[fw/openocd] / src / target / embeddedice.c
1 /***************************************************************************
2  *   Copyright (C) 2005 by Dominic Rath                                    *
3  *   Dominic.Rath@gmx.de                                                   *
4  *                                                                         *
5  *   This program is free software; you can redistribute it and/or modify  *
6  *   it under the terms of the GNU General Public License as published by  *
7  *   the Free Software Foundation; either version 2 of the License, or     *
8  *   (at your option) any later version.                                   *
9  *                                                                         *
10  *   This program is distributed in the hope that it will be useful,       *
11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
13  *   GNU General Public License for more details.                          *
14  *                                                                         *
15  *   You should have received a copy of the GNU General Public License     *
16  *   along with this program; if not, write to the                         *
17  *   Free Software Foundation, Inc.,                                       *
18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
19  ***************************************************************************/
20 #ifdef HAVE_CONFIG_H
21 #include "config.h"
22 #endif
23
24 #include "embeddedice.h"
25
26 #include "armv4_5.h"
27 #include "arm7_9_common.h"
28
29 #include "log.h"
30 #include "arm_jtag.h"
31 #include "types.h"
32 #include "binarybuffer.h"
33 #include "target.h"
34 #include "register.h"
35 #include "jtag.h"
36
37 #include <stdlib.h>
38
39 bitfield_desc_t embeddedice_comms_ctrl_bitfield_desc[] = 
40 {
41         {"R", 1},
42         {"W", 1},
43         {"reserved", 26},
44         {"version", 4}
45 };
46
47 int embeddedice_reg_arch_info[] =
48 {
49         0x0, 0x1, 0x4, 0x5,
50         0x8, 0x9, 0xa, 0xb, 0xc, 0xd,
51         0x10, 0x11, 0x12, 0x13, 0x14, 0x15
52 };
53
54 char* embeddedice_reg_list[] =
55 {
56         "debug_ctrl",
57         "debug_status",
58         
59         "comms_ctrl",
60         "comms_data",
61         
62         "watch 0 addr value",
63         "watch 0 addr mask",
64         "watch 0 data value",
65         "watch 0 data mask",
66         "watch 0 control value",
67         "watch 0 control mask",
68         
69         "watch 1 addr value",
70         "watch 1 addr mask",
71         "watch 1 data value",
72         "watch 1 data mask",
73         "watch 1 control value",
74         "watch 1 control mask"
75 };
76
77 int embeddedice_reg_arch_type = -1;
78
79 int embeddedice_get_reg(reg_t *reg);
80 int embeddedice_set_reg(reg_t *reg, u32 value);
81 int embeddedice_set_reg_w_exec(reg_t *reg, u8 *buf);
82
83 int embeddedice_write_reg(reg_t *reg, u32 value);
84 int embeddedice_read_reg(reg_t *reg);
85
86 reg_cache_t* embeddedice_build_reg_cache(target_t *target, arm_jtag_t *jtag_info, int extra_reg)
87 {
88         reg_cache_t *reg_cache = malloc(sizeof(reg_cache_t));
89         reg_t *reg_list = NULL;
90         embeddedice_reg_t *arch_info = NULL;
91         int num_regs = 16 + extra_reg;
92         int i;
93         
94         /* register a register arch-type for EmbeddedICE registers only once */
95         if (embeddedice_reg_arch_type == -1)
96                 embeddedice_reg_arch_type = register_reg_arch_type(embeddedice_get_reg, embeddedice_set_reg_w_exec);
97         
98         /* the actual registers are kept in two arrays */
99         reg_list = calloc(num_regs, sizeof(reg_t));
100         arch_info = calloc(num_regs, sizeof(embeddedice_reg_t));
101         
102         /* fill in values for the reg cache */
103         reg_cache->name = "EmbeddedICE registers";
104         reg_cache->next = NULL;
105         reg_cache->reg_list = reg_list;
106         reg_cache->num_regs = num_regs;
107         
108         /* set up registers */
109         for (i = 0; i < num_regs - extra_reg; i++)
110         {
111                 reg_list[i].name = embeddedice_reg_list[i];
112                 reg_list[i].size = 32;
113                 reg_list[i].dirty = 0;
114                 reg_list[i].valid = 0;
115                 reg_list[i].bitfield_desc = NULL;
116                 reg_list[i].num_bitfields = 0;
117                 reg_list[i].value = calloc(1, 4);
118                 reg_list[i].arch_info = &arch_info[i];
119                 reg_list[i].arch_type = embeddedice_reg_arch_type;
120                 arch_info[i].addr = embeddedice_reg_arch_info[i];
121                 arch_info[i].jtag_info = jtag_info;
122         }
123         
124         /* there may be one extra reg (Abort status (ARM7 rev4) or Vector catch (ARM9)) */
125         if (extra_reg)
126         {
127                 reg_list[num_regs - 1].arch_info = &arch_info[num_regs - 1];
128                 reg_list[num_regs - 1].arch_type = embeddedice_reg_arch_type;
129                 arch_info[num_regs - 1].jtag_info = jtag_info;
130         }
131         
132         return reg_cache;
133 }
134
135 int embeddedice_get_reg(reg_t *reg)
136 {
137         if (embeddedice_read_reg(reg) != ERROR_OK)
138         {
139                 ERROR("BUG: error scheduling EmbeddedICE register read");
140                 exit(-1);
141         }
142         
143         if (jtag_execute_queue() != ERROR_OK)
144         {
145                 ERROR("register read failed");
146         }
147         
148         return ERROR_OK;
149 }
150
151 int embeddedice_read_reg_w_check(reg_t *reg, u8* check_value, u8* check_mask)
152 {
153         embeddedice_reg_t *ice_reg = reg->arch_info;
154         u8 reg_addr = ice_reg->addr & 0x1f;
155         scan_field_t fields[3];
156         
157         DEBUG("%i", ice_reg->addr);
158
159         jtag_add_end_state(TAP_RTI);
160         arm_jtag_scann(ice_reg->jtag_info, 0x2);
161         arm_jtag_set_instr(ice_reg->jtag_info, ice_reg->jtag_info->intest_instr);
162         
163         fields[0].device = ice_reg->jtag_info->chain_pos;
164         fields[0].num_bits = 32;
165         fields[0].out_value = reg->value;
166         fields[0].out_mask = NULL;
167         fields[0].in_value = NULL;
168         fields[0].in_check_value = NULL;
169         fields[0].in_check_mask = NULL;
170         fields[0].in_handler = NULL;
171         fields[0].in_handler_priv = NULL;
172         
173         fields[1].device = ice_reg->jtag_info->chain_pos;
174         fields[1].num_bits = 5;
175         fields[1].out_value = malloc(1);
176         buf_set_u32(fields[1].out_value, 0, 5, reg_addr);
177         fields[1].out_mask = NULL;
178         fields[1].in_value = NULL;
179         fields[1].in_check_value = NULL;
180         fields[1].in_check_mask = NULL;
181         fields[1].in_handler = NULL;
182         fields[1].in_handler_priv = NULL;
183
184         fields[2].device = ice_reg->jtag_info->chain_pos;
185         fields[2].num_bits = 1;
186         fields[2].out_value = malloc(1);
187         buf_set_u32(fields[2].out_value, 0, 1, 0);
188         fields[2].out_mask = NULL;
189         fields[2].in_value = NULL;
190         fields[2].in_check_value = NULL;
191         fields[2].in_check_mask = NULL;
192         fields[2].in_handler = NULL;
193         fields[2].in_handler_priv = NULL;
194         
195         jtag_add_dr_scan(3, fields, -1);
196         
197         fields[0].in_value = reg->value;
198         fields[0].in_check_value = check_value;
199         fields[0].in_check_mask = check_mask;
200         
201         /* when reading the DCC data register, leaving the address field set to
202          * EICE_COMMS_DATA would read the register twice
203          * reading the control register is safe
204          */
205         buf_set_u32(fields[1].out_value, 0, 5, embeddedice_reg_arch_info[EICE_COMMS_CTRL]);
206         
207         jtag_add_dr_scan(3, fields, -1);
208
209         free(fields[1].out_value);
210         free(fields[2].out_value);
211         
212         return ERROR_OK;
213 }
214
215 int embeddedice_read_reg(reg_t *reg)
216 {
217         return embeddedice_read_reg_w_check(reg, NULL, NULL);   
218 }
219
220 int embeddedice_set_reg(reg_t *reg, u32 value)
221 {
222         if (embeddedice_write_reg(reg, value) != ERROR_OK)
223         {
224                 ERROR("BUG: error scheduling EmbeddedICE register write");
225                 exit(-1);
226         }
227         
228         buf_set_u32(reg->value, 0, reg->size, value);
229         reg->valid = 1;
230         reg->dirty = 0;
231         
232         return ERROR_OK;
233 }
234
235 int embeddedice_set_reg_w_exec(reg_t *reg, u8 *buf)
236 {
237         embeddedice_set_reg(reg, buf_get_u32(buf, 0, reg->size));
238         
239         if (jtag_execute_queue() != ERROR_OK)
240         {
241                 ERROR("register write failed");
242                 exit(-1);
243         }
244         return ERROR_OK;
245 }
246
247 int embeddedice_write_reg(reg_t *reg, u32 value)
248 {
249         embeddedice_reg_t *ice_reg = reg->arch_info;
250         u8 reg_addr = ice_reg->addr & 0x1f;
251         scan_field_t fields[3];
252         
253         DEBUG("%i: 0x%8.8x", ice_reg->addr, value);
254         
255         jtag_add_end_state(TAP_RTI);
256         arm_jtag_scann(ice_reg->jtag_info, 0x2);
257         arm_jtag_set_instr(ice_reg->jtag_info, ice_reg->jtag_info->intest_instr);
258         
259         fields[0].device = ice_reg->jtag_info->chain_pos;
260         fields[0].num_bits = 32;
261         fields[0].out_value = malloc(4);
262         buf_set_u32(fields[0].out_value, 0, 32, value);
263         fields[0].out_mask = NULL;
264         fields[0].in_value = NULL;
265         fields[0].in_check_value = NULL;
266         fields[0].in_check_mask = NULL;
267         fields[0].in_handler = NULL;
268         fields[0].in_handler_priv = NULL;
269         
270         fields[1].device = ice_reg->jtag_info->chain_pos;
271         fields[1].num_bits = 5;
272         fields[1].out_value = malloc(1);
273         buf_set_u32(fields[1].out_value, 0, 5, reg_addr);
274         fields[1].out_mask = NULL;
275         fields[1].in_value = NULL;
276         fields[1].in_check_value = NULL;
277         fields[1].in_check_mask = NULL;
278         fields[1].in_handler = NULL;
279         fields[1].in_handler_priv = NULL;
280
281         fields[2].device = ice_reg->jtag_info->chain_pos;
282         fields[2].num_bits = 1;
283         fields[2].out_value = malloc(1);
284         buf_set_u32(fields[2].out_value, 0, 1, 1);
285         fields[2].out_mask = NULL;
286         fields[2].in_value = NULL;
287         fields[2].in_check_value = NULL;
288         fields[2].in_check_mask = NULL;
289         fields[2].in_handler = NULL;
290         fields[2].in_handler_priv = NULL;
291         
292         jtag_add_dr_scan(3, fields, -1);
293         
294         free(fields[0].out_value);
295         free(fields[1].out_value);
296         free(fields[2].out_value);
297         
298         return ERROR_OK;
299 }
300
301 int embeddedice_store_reg(reg_t *reg)
302 {
303         return embeddedice_write_reg(reg, buf_get_u32(reg->value, 0, reg->size));
304 }
305