oocd_trace.c 12.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/***************************************************************************
 *   Copyright (C) 2007 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
 *   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

24
#include "armv4_5.h"
25
26
#include "oocd_trace.h"

zwelch's avatar
zwelch committed
27
28
29
30
31
/*
 * This is "proof of concept" code, for prototype hardware:
 * https://lists.berlios.de/pipermail/openocd-development/2007-September/000336.html
 */

32

33
34
static int oocd_trace_register_commands(struct command_context_s *cmd_ctx);

35
static int oocd_trace_read_reg(oocd_trace_t *oocd_trace, int reg, uint32_t *value)
36
37
{
	size_t bytes_written, bytes_read, bytes_to_read;
38
	uint8_t cmd;
39
40
41
42
43
44
45

	cmd = 0x10 | (reg & 0x7);
	bytes_written = write(oocd_trace->tty_fd, &cmd, 1);

	bytes_to_read = 4;
	while (bytes_to_read > 0)
	{
46
		bytes_read = read(oocd_trace->tty_fd, ((uint8_t*)value) + 4 - bytes_to_read, bytes_to_read);
47
48
49
		bytes_to_read -= bytes_read;
	}

50
	LOG_DEBUG("reg #%i: 0x%8.8x\n", reg, *value);
51

52
53
54
	return ERROR_OK;
}

55
static int oocd_trace_write_reg(oocd_trace_t *oocd_trace, int reg, uint32_t value)
56
{
57
	size_t bytes_written;
58
	uint8_t data[5];
59

60
61
62
63
64
	data[0] = 0x18 | (reg & 0x7);
	data[1] = value & 0xff;
	data[2] = (value & 0xff00) >> 8;
	data[3] = (value & 0xff0000) >> 16;
	data[4] = (value & 0xff000000) >> 24;
65

66
67
	bytes_written = write(oocd_trace->tty_fd, data, 5);
	LOG_DEBUG("reg #%i: 0x%8.8x\n", reg, value);
68

69
	return ERROR_OK;
70
71
}

72
static int oocd_trace_read_memory(oocd_trace_t *oocd_trace, uint8_t *data, uint32_t address, uint32_t size)
73
{
74
75
	size_t bytes_written, bytes_to_read;
	ssize_t bytes_read;
76
	uint8_t cmd;
77
78
79
80
81
82
83
84
85
86
87

	oocd_trace_write_reg(oocd_trace, OOCD_TRACE_ADDRESS, address);
	oocd_trace_write_reg(oocd_trace, OOCD_TRACE_SDRAM_COUNTER, size);

	cmd = 0x20;
	bytes_written = write(oocd_trace->tty_fd, &cmd, 1);

	bytes_to_read = size * 16;
	while (bytes_to_read > 0)
	{
		if ((bytes_read = read(oocd_trace->tty_fd,
88
				((uint8_t*)data) + (size * 16) - bytes_to_read, bytes_to_read)) < 0)
89
		{
90
			LOG_DEBUG("read() returned %zi (%s)", bytes_read, strerror(errno));
91
92
93
94
		}
		else
			bytes_to_read -= bytes_read;
	}
95

96
97
98
	return ERROR_OK;
}

99
static int oocd_trace_init(etm_context_t *etm_ctx)
100
{
101
	uint8_t trash[256];
102
	oocd_trace_t *oocd_trace = etm_ctx->capture_driver_priv;
103
	size_t bytes_read;
104

105
106
	oocd_trace->tty_fd = open(oocd_trace->tty, O_RDWR | O_NOCTTY | O_NONBLOCK);

zwelch's avatar
zwelch committed
107
	if (oocd_trace->tty_fd < 0)
108
	{
109
		LOG_ERROR("can't open tty");
110
111
112
113
114
115
116
		return ERROR_ETM_CAPTURE_INIT_FAILED;
	}

	/* clear input & output buffers, then switch to "blocking mode" */
	tcflush(oocd_trace->tty_fd, TCOFLUSH);
	tcflush(oocd_trace->tty_fd, TCIFLUSH);
	fcntl(oocd_trace->tty_fd, F_SETFL, fcntl(oocd_trace->tty_fd, F_GETFL) & ~O_NONBLOCK);
117

118
	tcgetattr(oocd_trace->tty_fd, &oocd_trace->oldtio); /* save current port settings */
119

120
121
	bzero(&oocd_trace->newtio, sizeof(oocd_trace->newtio));
	oocd_trace->newtio.c_cflag = CS8 | CLOCAL | CREAD | B2500000;
122

123
124
	oocd_trace->newtio.c_iflag = IGNPAR | IGNBRK | IXON | IXOFF;
	oocd_trace->newtio.c_oflag = 0;
125

126
127
	/* set input mode (non-canonical, no echo,...) */
	oocd_trace->newtio.c_lflag = 0;
128

129
130
131
	cfmakeraw(&oocd_trace->newtio);
	oocd_trace->newtio.c_cc[VTIME] = 1;   /* inter-character timer used */
	oocd_trace->newtio.c_cc[VMIN] = 0;   /* blocking read until 0 chars received */
132

133
134
	tcflush(oocd_trace->tty_fd, TCIFLUSH);
	tcsetattr(oocd_trace->tty_fd, TCSANOW, &oocd_trace->newtio);
135

136
137
138
139
	/* occasionally one bogus character is left in the input buffer
	 * read up any leftover characters to ensure communication is in sync */
	while ((bytes_read = read(oocd_trace->tty_fd, trash, sizeof(trash))) > 0)
	{
140
		LOG_DEBUG("%zi bytes read\n", bytes_read);
141
	};
142

143
144
145
	return ERROR_OK;
}

146
static trace_status_t oocd_trace_status(etm_context_t *etm_ctx)
147
148
{
	oocd_trace_t *oocd_trace = etm_ctx->capture_driver_priv;
149
	uint32_t status;
150

151
	oocd_trace_read_reg(oocd_trace, OOCD_TRACE_STATUS, &status);
152

153
154
155
156
157
158
159
160
161
162
	/* if tracing is currently idle, return this information */
	if (etm_ctx->capture_status == TRACE_IDLE)
	{
		return etm_ctx->capture_status;
	}
	else if (etm_ctx->capture_status & TRACE_RUNNING)
	{
		/* check Full bit to identify an overflow */
		if (status & 0x4)
			etm_ctx->capture_status |= TRACE_OVERFLOWED;
163

164
165
166
		/* check Triggered bit to identify trigger condition */
		if (status & 0x2)
			etm_ctx->capture_status |= TRACE_TRIGGERED;
167

168
169
170
171
172
173
		if (status & 0x1)
		{
			etm_ctx->capture_status &= ~TRACE_RUNNING;
			etm_ctx->capture_status |= TRACE_COMPLETED;
		}
	}
174

175
176
177
	return etm_ctx->capture_status;
}

178
static int oocd_trace_read_trace(etm_context_t *etm_ctx)
179
180
{
	oocd_trace_t *oocd_trace = etm_ctx->capture_driver_priv;
181
182
183
	uint32_t status, address;
	uint32_t first_frame = 0x0;
	uint32_t num_frames = 1048576;
184
	uint8_t *trace_data;
185
	uint32_t i;
186

187
188
	oocd_trace_read_reg(oocd_trace, OOCD_TRACE_STATUS, &status);
	oocd_trace_read_reg(oocd_trace, OOCD_TRACE_ADDRESS, &address);
189
190
191
192
193
194
195
196
197
198

	/* check if we overflowed, and adjust first frame of the trace accordingly
	 * if we didn't overflow, read only up to the frame that would be written next,
	 * i.e. don't read invalid entries
	 */
	if (status & 0x4)
		first_frame = address;
	else
		num_frames = address;

199
	/* read data into temporary array for unpacking
zwelch's avatar
zwelch committed
200
	 * one frame from OpenOCD + trace corresponds to 16 trace cycles
201
	 */
202
	trace_data = malloc(sizeof(uint8_t) * num_frames * 16);
203
204
205
206
207
208
209
210
211
	oocd_trace_read_memory(oocd_trace, trace_data, first_frame, num_frames);

	if (etm_ctx->trace_depth > 0)
	{
		free(etm_ctx->trace_data);
	}

	etm_ctx->trace_depth = num_frames * 16;
	etm_ctx->trace_data = malloc(sizeof(etmv1_trace_data_t) * etm_ctx->trace_depth);
212

213
214
215
216
217
	for (i = 0; i < num_frames * 16; i++)
	{
		etm_ctx->trace_data[i].pipestat = (trace_data[i] & 0x7);
		etm_ctx->trace_data[i].packet = (trace_data[i] & 0x78) >> 3;
		etm_ctx->trace_data[i].flags = 0;
218

219
220
221
222
223
224
225
226
227
228
229
		if ((trace_data[i] & 0x80) >> 7)
		{
			etm_ctx->trace_data[i].flags |= ETMV1_TRACESYNC_CYCLE;
		}

		if (etm_ctx->trace_data[i].pipestat == STAT_TR)
		{
			etm_ctx->trace_data[i].pipestat = etm_ctx->trace_data[i].packet & 0x7;
			etm_ctx->trace_data[i].flags |= ETMV1_TRIGGER_CYCLE;
		}
	}
230

231
232
233
234
235
	free(trace_data);

	return ERROR_OK;
}

236
static int oocd_trace_start_capture(etm_context_t *etm_ctx)
237
238
{
	oocd_trace_t *oocd_trace = etm_ctx->capture_driver_priv;
239
240
	uint32_t control = 0x1;	/* 0x1: enabled */
	uint32_t trigger_count;
241

242
243
244
	if (((etm_ctx->portmode & ETM_PORT_MODE_MASK) != ETM_PORT_NORMAL)
		|| ((etm_ctx->portmode & ETM_PORT_WIDTH_MASK) != ETM_PORT_4BIT))
	{
zwelch's avatar
zwelch committed
245
		LOG_DEBUG("OpenOCD + trace only supports normal 4-bit ETM mode");
246
247
		return ERROR_ETM_PORTMODE_NOT_SUPPORTED;
	}
248

249
250
251
252
	if ((etm_ctx->portmode & ETM_PORT_CLOCK_MASK) == ETM_PORT_HALF_CLOCK)
	{
		control |= 0x2;	/* half rate clock, capture at twice the clock rate */
	}
253

zwelch's avatar
zwelch committed
254
	/* OpenOCD + trace holds up to 16 million samples,
255
256
257
258
259
260
261
	 * but trigger counts is set in multiples of 16 */
	trigger_count = (1048576 * etm_ctx->trigger_percent) / 100;

	/* capturing always starts at address zero */
	oocd_trace_write_reg(oocd_trace, OOCD_TRACE_ADDRESS, 0x0);
	oocd_trace_write_reg(oocd_trace, OOCD_TRACE_TRIGGER_COUNTER, trigger_count);
	oocd_trace_write_reg(oocd_trace, OOCD_TRACE_CONTROL, control);
262

263
264
	/* we're starting a new trace, initialize capture status */
	etm_ctx->capture_status = TRACE_RUNNING;
265
266

	return ERROR_OK;
267
268
}

269
static int oocd_trace_stop_capture(etm_context_t *etm_ctx)
270
271
272
{
	oocd_trace_t *oocd_trace = etm_ctx->capture_driver_priv;

273
	/* trace stopped, just clear running flag, but preserve others */
274
	etm_ctx->capture_status &= ~TRACE_RUNNING;
275

276
	oocd_trace_write_reg(oocd_trace, OOCD_TRACE_CONTROL, 0x0);
277

278
279
280
281
282
283
284
285
286
287
288
289
290
291
	return ERROR_OK;
}

etm_capture_driver_t oocd_trace_capture_driver =
{
	.name = "oocd_trace",
	.register_commands = oocd_trace_register_commands,
	.init = oocd_trace_init,
	.status = oocd_trace_status,
	.start_capture = oocd_trace_start_capture,
	.stop_capture = oocd_trace_stop_capture,
	.read_trace = oocd_trace_read_trace,
};

292
static int handle_oocd_trace_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
293
294
{
	target_t *target;
David Brownell's avatar
David Brownell committed
295
	struct arm *arm;
296

297
298
	if (argc != 2)
	{
299
		LOG_ERROR("incomplete 'oocd_trace config <target> <tty>' command");
David Brownell's avatar
David Brownell committed
300
		return ERROR_FAIL;
301
	}
302

303
	target = get_current_target(cmd_ctx);
David Brownell's avatar
David Brownell committed
304
305
	arm = target_to_arm(target);
	if (!is_arm(arm))
306
	{
David Brownell's avatar
David Brownell committed
307
308
		command_print(cmd_ctx, "current target isn't an ARM");
		return ERROR_FAIL;
309
	}
310

David Brownell's avatar
David Brownell committed
311
	if (arm->etm)
312
313
	{
		oocd_trace_t *oocd_trace = malloc(sizeof(oocd_trace_t));
314

David Brownell's avatar
David Brownell committed
315
316
		arm->etm->capture_driver_priv = oocd_trace;
		oocd_trace->etm_ctx = arm->etm;
317

zwelch's avatar
zwelch committed
318
		/* copy name of TTY device used to communicate with OpenOCD + trace */
319
320
321
322
		oocd_trace->tty = strndup(args[1], 256);
	}
	else
	{
zwelch's avatar
zwelch committed
323
		LOG_ERROR("target has no ETM defined, OpenOCD + trace left unconfigured");
324
325
326
327
328
	}

	return ERROR_OK;
}

329
static int handle_oocd_trace_status_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
330
331
{
	target_t *target;
David Brownell's avatar
David Brownell committed
332
	struct arm *arm;
333
	oocd_trace_t *oocd_trace;
334
	uint32_t status;
335

336
	target = get_current_target(cmd_ctx);
337

David Brownell's avatar
David Brownell committed
338
339
	arm = target_to_arm(target);
	if (!is_arm(arm))
340
	{
David Brownell's avatar
David Brownell committed
341
342
		command_print(cmd_ctx, "current target isn't an ARM");
		return ERROR_FAIL;
343
	}
344

David Brownell's avatar
David Brownell committed
345
	if (!arm->etm)
346
347
	{
		command_print(cmd_ctx, "current target doesn't have an ETM configured");
David Brownell's avatar
David Brownell committed
348
		return ERROR_FAIL;
349
	}
350

David Brownell's avatar
David Brownell committed
351
	if (strcmp(arm->etm->capture_driver->name, "oocd_trace") != 0)
352
353
	{
		command_print(cmd_ctx, "current target's ETM capture driver isn't 'oocd_trace'");
David Brownell's avatar
David Brownell committed
354
		return ERROR_FAIL;
355
	}
356

David Brownell's avatar
David Brownell committed
357
	oocd_trace = (oocd_trace_t*)arm->etm->capture_driver_priv;
358

359
	oocd_trace_read_reg(oocd_trace, OOCD_TRACE_STATUS, &status);
360

361
362
363
364
	if (status & 0x8)
		command_print(cmd_ctx, "trace clock locked");
	else
		command_print(cmd_ctx, "no trace clock");
365

366
367
368
	return ERROR_OK;
}

369
static int handle_oocd_trace_resync_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
370
371
{
	target_t *target;
David Brownell's avatar
David Brownell committed
372
	struct arm *arm;
373
374
	oocd_trace_t *oocd_trace;
	size_t bytes_written;
375
	uint8_t cmd_array[1];
376

377
	target = get_current_target(cmd_ctx);
378

David Brownell's avatar
David Brownell committed
379
380
	arm = target_to_arm(target);
	if (!is_arm(arm))
381
	{
David Brownell's avatar
David Brownell committed
382
383
		command_print(cmd_ctx, "current target isn't an ARM");
		return ERROR_FAIL;
384
	}
385

David Brownell's avatar
David Brownell committed
386
	if (!arm->etm)
387
388
	{
		command_print(cmd_ctx, "current target doesn't have an ETM configured");
David Brownell's avatar
David Brownell committed
389
		return ERROR_FAIL;
390
	}
391

David Brownell's avatar
David Brownell committed
392
	if (strcmp(arm->etm->capture_driver->name, "oocd_trace") != 0)
393
394
	{
		command_print(cmd_ctx, "current target's ETM capture driver isn't 'oocd_trace'");
David Brownell's avatar
David Brownell committed
395
		return ERROR_FAIL;
396
	}
397

David Brownell's avatar
David Brownell committed
398
	oocd_trace = (oocd_trace_t*)arm->etm->capture_driver_priv;
399

400
401
402
	cmd_array[0] = 0xf0;

	bytes_written = write(oocd_trace->tty_fd, cmd_array, 1);
403

404
	command_print(cmd_ctx, "requesting traceclock resync");
405
	LOG_DEBUG("resyncing traceclk pll");
406
407
408
409
410
411
412

	return ERROR_OK;
}

int oocd_trace_register_commands(struct command_context_s *cmd_ctx)
{
	command_t *oocd_trace_cmd;
413

zwelch's avatar
zwelch committed
414
	oocd_trace_cmd = register_command(cmd_ctx, NULL, "oocd_trace", NULL, COMMAND_ANY, "OpenOCD + trace");
415

416
417
	register_command(cmd_ctx, oocd_trace_cmd, "config", handle_oocd_trace_config_command, COMMAND_CONFIG, NULL);

zwelch's avatar
zwelch committed
418
419
	register_command(cmd_ctx, oocd_trace_cmd, "status", handle_oocd_trace_status_command, COMMAND_EXEC, "display OpenOCD + trace status");
	register_command(cmd_ctx, oocd_trace_cmd, "resync", handle_oocd_trace_resync_command, COMMAND_EXEC, "resync OpenOCD + trace capture clock");
420
421
422

	return ERROR_OK;
}