embeddedice.c 15.4 KB
Newer Older
1
2
3
4
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
5
 *   Copyright (C) 2007,2008 yvind Harboe                                 *
6
7
 *   oyvind.harboe@zylin.com                                               *
 *                                                                         *
8
9
10
 *   Copyright (C) 2008 by Spencer Oliver                                  *
 *   spen@spen-soft.co.uk                                                  *
 *                                                                         *
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "embeddedice.h"

#include "armv4_5.h"
#include "arm7_9_common.h"

#include "log.h"
#include "arm_jtag.h"
#include "types.h"
#include "binarybuffer.h"
#include "target.h"
#include "register.h"
#include "jtag.h"

#include <stdlib.h>

45
bitfield_desc_t embeddedice_comms_ctrl_bitfield_desc[] =
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
{
	{"R", 1},
	{"W", 1},
	{"reserved", 26},
	{"version", 4}
};

int embeddedice_reg_arch_info[] =
{
	0x0, 0x1, 0x4, 0x5,
	0x8, 0x9, 0xa, 0xb, 0xc, 0xd,
	0x10, 0x11, 0x12, 0x13, 0x14, 0x15,
	0x2
};

char* embeddedice_reg_list[] =
{
	"debug_ctrl",
	"debug_status",
65

66
67
	"comms_ctrl",
	"comms_data",
68

69
70
71
72
73
74
	"watch 0 addr value",
	"watch 0 addr mask",
	"watch 0 data value",
	"watch 0 data mask",
	"watch 0 control value",
	"watch 0 control mask",
75

76
77
78
79
80
81
	"watch 1 addr value",
	"watch 1 addr mask",
	"watch 1 data value",
	"watch 1 data mask",
	"watch 1 control value",
	"watch 1 control mask",
82

83
84
85
86
87
88
	"vector catch"
};

int embeddedice_reg_arch_type = -1;

int embeddedice_get_reg(reg_t *reg);
89
void embeddedice_set_reg(reg_t *reg, u32 value);
90
91
int embeddedice_set_reg_w_exec(reg_t *reg, u8 *buf);

92
void embeddedice_write_reg(reg_t *reg, u32 value);
93
94
95
96
int embeddedice_read_reg(reg_t *reg);

reg_cache_t* embeddedice_build_reg_cache(target_t *target, arm7_9_common_t *arm7_9)
{
oharboe's avatar
oharboe committed
97
	int retval;
98
99
100
101
102
103
104
	reg_cache_t *reg_cache = malloc(sizeof(reg_cache_t));
	reg_t *reg_list = NULL;
	embeddedice_reg_t *arch_info = NULL;
	arm_jtag_t *jtag_info = &arm7_9->jtag_info;
	int num_regs;
	int i;
	int eice_version = 0;
105

106
107
108
	/* register a register arch-type for EmbeddedICE registers only once */
	if (embeddedice_reg_arch_type == -1)
		embeddedice_reg_arch_type = register_reg_arch_type(embeddedice_get_reg, embeddedice_set_reg_w_exec);
109

110
111
112
113
	if (arm7_9->has_vector_catch)
		num_regs = 17;
	else
		num_regs = 16;
114

115
116
117
	/* the actual registers are kept in two arrays */
	reg_list = calloc(num_regs, sizeof(reg_t));
	arch_info = calloc(num_regs, sizeof(embeddedice_reg_t));
118

119
120
121
122
123
	/* fill in values for the reg cache */
	reg_cache->name = "EmbeddedICE registers";
	reg_cache->next = NULL;
	reg_cache->reg_list = reg_list;
	reg_cache->num_regs = num_regs;
124

125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
	/* set up registers */
	for (i = 0; i < num_regs; i++)
	{
		reg_list[i].name = embeddedice_reg_list[i];
		reg_list[i].size = 32;
		reg_list[i].dirty = 0;
		reg_list[i].valid = 0;
		reg_list[i].bitfield_desc = NULL;
		reg_list[i].num_bitfields = 0;
		reg_list[i].value = calloc(1, 4);
		reg_list[i].arch_info = &arch_info[i];
		reg_list[i].arch_type = embeddedice_reg_arch_type;
		arch_info[i].addr = embeddedice_reg_arch_info[i];
		arch_info[i].jtag_info = jtag_info;
	}
140

141
142
	/* identify EmbeddedICE version by reading DCC control register */
	embeddedice_read_reg(&reg_list[EICE_COMMS_CTRL]);
oharboe's avatar
oharboe committed
143
144
145
146
147
148
149
150
151
152
	if ((retval=jtag_execute_queue())!=ERROR_OK)
	{
		for (i = 0; i < num_regs; i++)
		{
			free(reg_list[i].value);
		}
		free(reg_list);
		free(arch_info);
		return NULL;
	}
153

154
	eice_version = buf_get_u32(reg_list[EICE_COMMS_CTRL].value, 28, 4);
155

156
157
158
159
160
161
162
163
164
165
166
167
	switch (eice_version)
	{
		case 1:
			reg_list[EICE_DBG_CTRL].size = 3;
			reg_list[EICE_DBG_STAT].size = 5;
			break;
		case 2:
			reg_list[EICE_DBG_CTRL].size = 4;
			reg_list[EICE_DBG_STAT].size = 5;
			arm7_9->has_single_step = 1;
			break;
		case 3:
168
			LOG_ERROR("EmbeddedICE version 3 detected, EmbeddedICE handling might be broken");
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
			reg_list[EICE_DBG_CTRL].size = 6;
			reg_list[EICE_DBG_STAT].size = 5;
			arm7_9->has_single_step = 1;
			arm7_9->has_monitor_mode = 1;
			break;
		case 4:
			reg_list[EICE_DBG_CTRL].size = 6;
			reg_list[EICE_DBG_STAT].size = 5;
			arm7_9->has_monitor_mode = 1;
			break;
		case 5:
			reg_list[EICE_DBG_CTRL].size = 6;
			reg_list[EICE_DBG_STAT].size = 5;
			arm7_9->has_single_step = 1;
			arm7_9->has_monitor_mode = 1;
			break;
		case 6:
			reg_list[EICE_DBG_CTRL].size = 6;
			reg_list[EICE_DBG_STAT].size = 10;
			arm7_9->has_monitor_mode = 1;
			break;
		case 7:
191
			LOG_WARNING("EmbeddedICE version 7 detected, EmbeddedICE handling might be broken");
192
193
194
195
196
			reg_list[EICE_DBG_CTRL].size = 6;
			reg_list[EICE_DBG_STAT].size = 5;
			arm7_9->has_monitor_mode = 1;
			break;
		default:
197
			LOG_ERROR("unknown EmbeddedICE version (comms ctrl: 0x%8.8x)", buf_get_u32(reg_list[EICE_COMMS_CTRL].value, 0, 32));
198
	}
199

oharboe's avatar
oharboe committed
200
201
202
203
204
205
206
207
	return reg_cache;
}

int embeddedice_setup(target_t *target)
{
	int retval;
	armv4_5_common_t *armv4_5 = target->arch_info;
	arm7_9_common_t *arm7_9 = armv4_5->arch_info;
208

209
210
211
	/* explicitly disable monitor mode */
	if (arm7_9->has_monitor_mode)
	{
oharboe's avatar
oharboe committed
212
		reg_t *dbg_ctrl = &arm7_9->eice_cache->reg_list[EICE_DBG_CTRL];
213

oharboe's avatar
oharboe committed
214
215
216
217
218
		embeddedice_read_reg(dbg_ctrl);
		if ((retval=jtag_execute_queue())!=ERROR_OK)
			return retval;
		buf_set_u32(dbg_ctrl->value, 4, 1, 0);
		embeddedice_set_reg_w_exec(dbg_ctrl, dbg_ctrl->value);
219
	}
oharboe's avatar
oharboe committed
220
	return jtag_execute_queue();
221
222
223
224
}

int embeddedice_get_reg(reg_t *reg)
{
225
226
	int retval;
	if ((retval = embeddedice_read_reg(reg)) != ERROR_OK)
227
	{
228
		LOG_ERROR("BUG: error scheduling EmbeddedICE register read");
229
		return retval;
230
	}
231

232
	if ((retval = jtag_execute_queue()) != ERROR_OK)
233
	{
234
		LOG_ERROR("register read failed");
235
		return retval;
236
	}
237

238
239
240
241
242
243
244
245
246
247
248
	return ERROR_OK;
}

int embeddedice_read_reg_w_check(reg_t *reg, u8* check_value, u8* check_mask)
{
	embeddedice_reg_t *ice_reg = reg->arch_info;
	u8 reg_addr = ice_reg->addr & 0x1f;
	scan_field_t fields[3];
	u8 field1_out[1];
	u8 field2_out[1];

249
	jtag_add_end_state(TAP_IDLE);
250
	arm_jtag_scann(ice_reg->jtag_info, 0x2);
251

252
	arm_jtag_set_instr(ice_reg->jtag_info, ice_reg->jtag_info->intest_instr, NULL);
253

254
	fields[0].tap = ice_reg->jtag_info->tap;
255
256
257
258
259
260
261
262
	fields[0].num_bits = 32;
	fields[0].out_value = reg->value;
	fields[0].out_mask = NULL;
	fields[0].in_value = NULL;
	fields[0].in_check_value = NULL;
	fields[0].in_check_mask = NULL;
	fields[0].in_handler = NULL;
	fields[0].in_handler_priv = NULL;
263

264
	fields[1].tap = ice_reg->jtag_info->tap;
265
266
267
268
269
270
271
272
273
274
	fields[1].num_bits = 5;
	fields[1].out_value = field1_out;
	buf_set_u32(fields[1].out_value, 0, 5, reg_addr);
	fields[1].out_mask = NULL;
	fields[1].in_value = NULL;
	fields[1].in_check_value = NULL;
	fields[1].in_check_mask = NULL;
	fields[1].in_handler = NULL;
	fields[1].in_handler_priv = NULL;

275
	fields[2].tap = ice_reg->jtag_info->tap;
276
277
278
279
280
281
282
283
284
	fields[2].num_bits = 1;
	fields[2].out_value = field2_out;
	buf_set_u32(fields[2].out_value, 0, 1, 0);
	fields[2].out_mask = NULL;
	fields[2].in_value = NULL;
	fields[2].in_check_value = NULL;
	fields[2].in_check_mask = NULL;
	fields[2].in_handler = NULL;
	fields[2].in_handler_priv = NULL;
285

mifi's avatar
mifi committed
286
	jtag_add_dr_scan(3, fields, TAP_INVALID);
287

288
289
	fields[0].in_value = reg->value;
	jtag_set_check_value(fields+0, check_value, check_mask, NULL);
290

291
292
293
294
295
	/* when reading the DCC data register, leaving the address field set to
	 * EICE_COMMS_DATA would read the register twice
	 * reading the control register is safe
	 */
	buf_set_u32(fields[1].out_value, 0, 5, embeddedice_reg_arch_info[EICE_COMMS_CTRL]);
296

mifi's avatar
mifi committed
297
	jtag_add_dr_scan(3, fields, TAP_INVALID);
298
299
300
301
302
303
304
305
306
307
308
309
310
311

	return ERROR_OK;
}

/* receive <size> words of 32 bit from the DCC
 * we pretend the target is always going to be fast enough
 * (relative to the JTAG clock), so we don't need to handshake
 */
int embeddedice_receive(arm_jtag_t *jtag_info, u32 *data, u32 size)
{
	scan_field_t fields[3];
	u8 field1_out[1];
	u8 field2_out[1];

312
	jtag_add_end_state(TAP_IDLE);
313
314
	arm_jtag_scann(jtag_info, 0x2);
	arm_jtag_set_instr(jtag_info, jtag_info->intest_instr, NULL);
315

316
	fields[0].tap = jtag_info->tap;
317
318
319
320
321
322
323
324
	fields[0].num_bits = 32;
	fields[0].out_value = NULL;
	fields[0].out_mask = NULL;
	fields[0].in_value = NULL;
	fields[0].in_check_value = NULL;
	fields[0].in_check_mask = NULL;
	fields[0].in_handler = NULL;
	fields[0].in_handler_priv = NULL;
325

326
	fields[1].tap = jtag_info->tap;
327
328
329
330
331
332
333
334
335
336
	fields[1].num_bits = 5;
	fields[1].out_value = field1_out;
	buf_set_u32(fields[1].out_value, 0, 5, embeddedice_reg_arch_info[EICE_COMMS_DATA]);
	fields[1].out_mask = NULL;
	fields[1].in_value = NULL;
	fields[1].in_check_value = NULL;
	fields[1].in_check_mask = NULL;
	fields[1].in_handler = NULL;
	fields[1].in_handler_priv = NULL;

337
	fields[2].tap = jtag_info->tap;
338
339
340
341
342
343
344
345
346
	fields[2].num_bits = 1;
	fields[2].out_value = field2_out;
	buf_set_u32(fields[2].out_value, 0, 1, 0);
	fields[2].out_mask = NULL;
	fields[2].in_value = NULL;
	fields[2].in_check_value = NULL;
	fields[2].in_check_mask = NULL;
	fields[2].in_handler = NULL;
	fields[2].in_handler_priv = NULL;
347

mifi's avatar
mifi committed
348
	jtag_add_dr_scan(3, fields, TAP_INVALID);
349

350
351
352
353
354
355
356
	while (size > 0)
	{
		/* when reading the last item, set the register address to the DCC control reg,
		 * to avoid reading additional data from the DCC data reg
		 */
		if (size == 1)
			buf_set_u32(fields[1].out_value, 0, 5, embeddedice_reg_arch_info[EICE_COMMS_CTRL]);
357

358
359
		fields[0].in_handler = arm_jtag_buf_to_u32;
		fields[0].in_handler_priv = data;
mifi's avatar
mifi committed
360
		jtag_add_dr_scan(3, fields, TAP_INVALID);
361

362
363
364
		data++;
		size--;
	}
365

366
367
368
369
370
	return jtag_execute_queue();
}

int embeddedice_read_reg(reg_t *reg)
{
371
	return embeddedice_read_reg_w_check(reg, NULL, NULL);
372
373
}

374
void embeddedice_set_reg(reg_t *reg, u32 value)
375
{
376
	embeddedice_write_reg(reg, value);
377

378
379
380
	buf_set_u32(reg->value, 0, reg->size, value);
	reg->valid = 1;
	reg->dirty = 0;
381

382
383
384
385
}

int embeddedice_set_reg_w_exec(reg_t *reg, u8 *buf)
{
386
	int retval;
387
	embeddedice_set_reg(reg, buf_get_u32(buf, 0, reg->size));
388

389
	if ((retval = jtag_execute_queue()) != ERROR_OK)
390
	{
391
		LOG_ERROR("register write failed");
392
		return retval;
393
394
395
396
	}
	return ERROR_OK;
}

397
void embeddedice_write_reg(reg_t *reg, u32 value)
398
399
400
{
	embeddedice_reg_t *ice_reg = reg->arch_info;

401
	LOG_DEBUG("%i: 0x%8.8x", ice_reg->addr, value);
402

403
	jtag_add_end_state(TAP_IDLE);
404
	arm_jtag_scann(ice_reg->jtag_info, 0x2);
405

406
407
	arm_jtag_set_instr(ice_reg->jtag_info, ice_reg->jtag_info->intest_instr, NULL);

408
	u8 reg_addr = ice_reg->addr & 0x1f;
409
	embeddedice_write_reg_inner(ice_reg->jtag_info->tap, reg_addr, value);
410

411
412
}

413
void embeddedice_store_reg(reg_t *reg)
414
{
415
	embeddedice_write_reg(reg, buf_get_u32(reg->value, 0, reg->size));
416
417
418
419
420
421
422
423
424
425
426
427
428
}

/* send <size> words of 32 bit to the DCC
 * we pretend the target is always going to be fast enough
 * (relative to the JTAG clock), so we don't need to handshake
 */
int embeddedice_send(arm_jtag_t *jtag_info, u32 *data, u32 size)
{
	scan_field_t fields[3];
	u8 field0_out[4];
	u8 field1_out[1];
	u8 field2_out[1];

429
	jtag_add_end_state(TAP_IDLE);
430
431
432
	arm_jtag_scann(jtag_info, 0x2);
	arm_jtag_set_instr(jtag_info, jtag_info->intest_instr, NULL);

433
	fields[0].tap = jtag_info->tap;
434
435
436
437
438
439
440
441
442
	fields[0].num_bits = 32;
	fields[0].out_value = field0_out;
	fields[0].out_mask = NULL;
	fields[0].in_value = NULL;
	fields[0].in_check_value = NULL;
	fields[0].in_check_mask = NULL;
	fields[0].in_handler = NULL;
	fields[0].in_handler_priv = NULL;

443
	fields[1].tap = jtag_info->tap;
444
445
446
447
448
449
450
451
452
453
	fields[1].num_bits = 5;
	fields[1].out_value = field1_out;
	buf_set_u32(fields[1].out_value, 0, 5, embeddedice_reg_arch_info[EICE_COMMS_DATA]);
	fields[1].out_mask = NULL;
	fields[1].in_value = NULL;
	fields[1].in_check_value = NULL;
	fields[1].in_check_mask = NULL;
	fields[1].in_handler = NULL;
	fields[1].in_handler_priv = NULL;

454
	fields[2].tap = jtag_info->tap;
455
456
457
458
459
460
461
462
463
464
465
466
467
	fields[2].num_bits = 1;
	fields[2].out_value = field2_out;
	buf_set_u32(fields[2].out_value, 0, 1, 1);
	fields[2].out_mask = NULL;
	fields[2].in_value = NULL;
	fields[2].in_check_value = NULL;
	fields[2].in_check_mask = NULL;
	fields[2].in_handler = NULL;
	fields[2].in_handler_priv = NULL;

	while (size > 0)
	{
		buf_set_u32(fields[0].out_value, 0, 32, *data);
mifi's avatar
mifi committed
468
		jtag_add_dr_scan(3, fields, TAP_INVALID);
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486

		data++;
		size--;
	}

	/* call to jtag_execute_queue() intentionally omitted */
	return ERROR_OK;
}

/* wait for DCC control register R/W handshake bit to become active
 */
int embeddedice_handshake(arm_jtag_t *jtag_info, int hsbit, u32 timeout)
{
	scan_field_t fields[3];
	u8 field0_in[4];
	u8 field1_out[1];
	u8 field2_out[1];
	int retval;
487
	u32 hsact;
488
489
490
491
492
493
494
495
496
497
	struct timeval lap;
	struct timeval now;

	if (hsbit == EICE_COMM_CTRL_WBIT)
		hsact = 1;
	else if (hsbit == EICE_COMM_CTRL_RBIT)
		hsact = 0;
	else
		return ERROR_INVALID_ARGUMENTS;

498
	jtag_add_end_state(TAP_IDLE);
499
500
501
	arm_jtag_scann(jtag_info, 0x2);
	arm_jtag_set_instr(jtag_info, jtag_info->intest_instr, NULL);

502
	fields[0].tap = jtag_info->tap;
503
504
505
506
507
508
509
510
511
	fields[0].num_bits = 32;
	fields[0].out_value = NULL;
	fields[0].out_mask = NULL;
	fields[0].in_value = field0_in;
	fields[0].in_check_value = NULL;
	fields[0].in_check_mask = NULL;
	fields[0].in_handler = NULL;
	fields[0].in_handler_priv = NULL;

512
	fields[1].tap = jtag_info->tap;
513
514
515
516
517
518
519
520
521
522
	fields[1].num_bits = 5;
	fields[1].out_value = field1_out;
	buf_set_u32(fields[1].out_value, 0, 5, embeddedice_reg_arch_info[EICE_COMMS_CTRL]);
	fields[1].out_mask = NULL;
	fields[1].in_value = NULL;
	fields[1].in_check_value = NULL;
	fields[1].in_check_mask = NULL;
	fields[1].in_handler = NULL;
	fields[1].in_handler_priv = NULL;

523
	fields[2].tap = jtag_info->tap;
524
525
526
527
528
529
530
531
532
533
	fields[2].num_bits = 1;
	fields[2].out_value = field2_out;
	buf_set_u32(fields[2].out_value, 0, 1, 0);
	fields[2].out_mask = NULL;
	fields[2].in_value = NULL;
	fields[2].in_check_value = NULL;
	fields[2].in_check_mask = NULL;
	fields[2].in_handler = NULL;
	fields[2].in_handler_priv = NULL;

mifi's avatar
mifi committed
534
	jtag_add_dr_scan(3, fields, TAP_INVALID);
535
536
537
	gettimeofday(&lap, NULL);
	do
	{
mifi's avatar
mifi committed
538
		jtag_add_dr_scan(3, fields, TAP_INVALID);
539
540
541
542
543
544
545
546
		if ((retval = jtag_execute_queue()) != ERROR_OK)
			return retval;

		if (buf_get_u32(field0_in, hsbit, 1) == hsact)
			return ERROR_OK;

		gettimeofday(&now, NULL);
	}
547
	while ((u32)((now.tv_sec-lap.tv_sec)*1000 + (now.tv_usec-lap.tv_usec)/1000) <= timeout);
548
549
550

	return ERROR_TARGET_TIMEOUT;
}
551
552

/* this is the inner loop of the open loop DCC write of data to target */
553
void MINIDRIVER(embeddedice_write_dcc)(jtag_tap_t *tap, int reg_addr, u8 *buffer, int little, int count)
554
555
556
557
{
	int i;
	for (i = 0; i < count; i++)
	{
558
		embeddedice_write_reg_inner(tap, reg_addr, fast_target_buffer_get_u32(buffer, little));
559
560
561
		buffer += 4;
	}
}