1 /***************************************************************************
2 * Copyright (C) 2007 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
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. *
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. *
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 ***************************************************************************/
26 #include "oocd_trace.h"
29 * This is "proof of concept" code, for prototype hardware:
30 * https://lists.berlios.de/pipermail/openocd-development/2007-September/000336.html
34 static int oocd_trace_read_reg(struct oocd_trace
*oocd_trace
, int reg
, uint32_t *value
)
36 size_t bytes_written
, bytes_read
, bytes_to_read
;
39 cmd
= 0x10 | (reg
& 0x7);
40 bytes_written
= write(oocd_trace
->tty_fd
, &cmd
, 1);
43 while (bytes_to_read
> 0)
45 bytes_read
= read(oocd_trace
->tty_fd
, ((uint8_t*)value
) + 4 - bytes_to_read
, bytes_to_read
);
46 bytes_to_read
-= bytes_read
;
49 LOG_DEBUG("reg #%i: 0x%8.8x\n", reg
, *value
);
54 static int oocd_trace_write_reg(struct oocd_trace
*oocd_trace
, int reg
, uint32_t value
)
59 data
[0] = 0x18 | (reg
& 0x7);
60 data
[1] = value
& 0xff;
61 data
[2] = (value
& 0xff00) >> 8;
62 data
[3] = (value
& 0xff0000) >> 16;
63 data
[4] = (value
& 0xff000000) >> 24;
65 bytes_written
= write(oocd_trace
->tty_fd
, data
, 5);
66 LOG_DEBUG("reg #%i: 0x%8.8x\n", reg
, value
);
71 static int oocd_trace_read_memory(struct oocd_trace
*oocd_trace
, uint8_t *data
, uint32_t address
, uint32_t size
)
73 size_t bytes_written
, bytes_to_read
;
77 oocd_trace_write_reg(oocd_trace
, OOCD_TRACE_ADDRESS
, address
);
78 oocd_trace_write_reg(oocd_trace
, OOCD_TRACE_SDRAM_COUNTER
, size
);
81 bytes_written
= write(oocd_trace
->tty_fd
, &cmd
, 1);
83 bytes_to_read
= size
* 16;
84 while (bytes_to_read
> 0)
86 if ((bytes_read
= read(oocd_trace
->tty_fd
,
87 ((uint8_t*)data
) + (size
* 16) - bytes_to_read
, bytes_to_read
)) < 0)
89 LOG_DEBUG("read() returned %zi (%s)", bytes_read
, strerror(errno
));
92 bytes_to_read
-= bytes_read
;
98 static int oocd_trace_init(struct etm_context
*etm_ctx
)
101 struct oocd_trace
*oocd_trace
= etm_ctx
->capture_driver_priv
;
104 oocd_trace
->tty_fd
= open(oocd_trace
->tty
, O_RDWR
| O_NOCTTY
| O_NONBLOCK
);
106 if (oocd_trace
->tty_fd
< 0)
108 LOG_ERROR("can't open tty");
109 return ERROR_ETM_CAPTURE_INIT_FAILED
;
112 /* clear input & output buffers, then switch to "blocking mode" */
113 tcflush(oocd_trace
->tty_fd
, TCOFLUSH
);
114 tcflush(oocd_trace
->tty_fd
, TCIFLUSH
);
115 fcntl(oocd_trace
->tty_fd
, F_SETFL
, fcntl(oocd_trace
->tty_fd
, F_GETFL
) & ~O_NONBLOCK
);
117 tcgetattr(oocd_trace
->tty_fd
, &oocd_trace
->oldtio
); /* save current port settings */
119 bzero(&oocd_trace
->newtio
, sizeof(oocd_trace
->newtio
));
120 oocd_trace
->newtio
.c_cflag
= CS8
| CLOCAL
| CREAD
| B2500000
;
122 oocd_trace
->newtio
.c_iflag
= IGNPAR
| IGNBRK
| IXON
| IXOFF
;
123 oocd_trace
->newtio
.c_oflag
= 0;
125 /* set input mode (non-canonical, no echo,...) */
126 oocd_trace
->newtio
.c_lflag
= 0;
128 cfmakeraw(&oocd_trace
->newtio
);
129 oocd_trace
->newtio
.c_cc
[VTIME
] = 1; /* inter-character timer used */
130 oocd_trace
->newtio
.c_cc
[VMIN
] = 0; /* blocking read until 0 chars received */
132 tcflush(oocd_trace
->tty_fd
, TCIFLUSH
);
133 tcsetattr(oocd_trace
->tty_fd
, TCSANOW
, &oocd_trace
->newtio
);
135 /* occasionally one bogus character is left in the input buffer
136 * read up any leftover characters to ensure communication is in sync */
137 while ((bytes_read
= read(oocd_trace
->tty_fd
, trash
, sizeof(trash
))) > 0)
139 LOG_DEBUG("%zi bytes read\n", bytes_read
);
145 static trace_status_t
oocd_trace_status(struct etm_context
*etm_ctx
)
147 struct oocd_trace
*oocd_trace
= etm_ctx
->capture_driver_priv
;
150 oocd_trace_read_reg(oocd_trace
, OOCD_TRACE_STATUS
, &status
);
152 /* if tracing is currently idle, return this information */
153 if (etm_ctx
->capture_status
== TRACE_IDLE
)
155 return etm_ctx
->capture_status
;
157 else if (etm_ctx
->capture_status
& TRACE_RUNNING
)
159 /* check Full bit to identify an overflow */
161 etm_ctx
->capture_status
|= TRACE_OVERFLOWED
;
163 /* check Triggered bit to identify trigger condition */
165 etm_ctx
->capture_status
|= TRACE_TRIGGERED
;
169 etm_ctx
->capture_status
&= ~TRACE_RUNNING
;
170 etm_ctx
->capture_status
|= TRACE_COMPLETED
;
174 return etm_ctx
->capture_status
;
177 static int oocd_trace_read_trace(struct etm_context
*etm_ctx
)
179 struct oocd_trace
*oocd_trace
= etm_ctx
->capture_driver_priv
;
180 uint32_t status
, address
;
181 uint32_t first_frame
= 0x0;
182 uint32_t num_frames
= 1048576;
186 oocd_trace_read_reg(oocd_trace
, OOCD_TRACE_STATUS
, &status
);
187 oocd_trace_read_reg(oocd_trace
, OOCD_TRACE_ADDRESS
, &address
);
189 /* check if we overflowed, and adjust first frame of the trace accordingly
190 * if we didn't overflow, read only up to the frame that would be written next,
191 * i.e. don't read invalid entries
194 first_frame
= address
;
196 num_frames
= address
;
198 /* read data into temporary array for unpacking
199 * one frame from OpenOCD + trace corresponds to 16 trace cycles
201 trace_data
= malloc(sizeof(uint8_t) * num_frames
* 16);
202 oocd_trace_read_memory(oocd_trace
, trace_data
, first_frame
, num_frames
);
204 if (etm_ctx
->trace_depth
> 0)
206 free(etm_ctx
->trace_data
);
209 etm_ctx
->trace_depth
= num_frames
* 16;
210 etm_ctx
->trace_data
= malloc(sizeof(struct etmv1_trace_data
) * etm_ctx
->trace_depth
);
212 for (i
= 0; i
< num_frames
* 16; i
++)
214 etm_ctx
->trace_data
[i
].pipestat
= (trace_data
[i
] & 0x7);
215 etm_ctx
->trace_data
[i
].packet
= (trace_data
[i
] & 0x78) >> 3;
216 etm_ctx
->trace_data
[i
].flags
= 0;
218 if ((trace_data
[i
] & 0x80) >> 7)
220 etm_ctx
->trace_data
[i
].flags
|= ETMV1_TRACESYNC_CYCLE
;
223 if (etm_ctx
->trace_data
[i
].pipestat
== STAT_TR
)
225 etm_ctx
->trace_data
[i
].pipestat
= etm_ctx
->trace_data
[i
].packet
& 0x7;
226 etm_ctx
->trace_data
[i
].flags
|= ETMV1_TRIGGER_CYCLE
;
235 static int oocd_trace_start_capture(struct etm_context
*etm_ctx
)
237 struct oocd_trace
*oocd_trace
= etm_ctx
->capture_driver_priv
;
238 uint32_t control
= 0x1; /* 0x1: enabled */
239 uint32_t trigger_count
;
241 if (((etm_ctx
->control
& ETM_PORT_MODE_MASK
) != ETM_PORT_NORMAL
)
242 || ((etm_ctx
->control
& ETM_PORT_WIDTH_MASK
) != ETM_PORT_4BIT
))
244 LOG_DEBUG("OpenOCD + trace only supports normal 4-bit ETM mode");
245 return ERROR_ETM_PORTMODE_NOT_SUPPORTED
;
248 if ((etm_ctx
->control
& ETM_PORT_CLOCK_MASK
) == ETM_PORT_HALF_CLOCK
)
250 control
|= 0x2; /* half rate clock, capture at twice the clock rate */
253 /* OpenOCD + trace holds up to 16 million samples,
254 * but trigger counts is set in multiples of 16 */
255 trigger_count
= (1048576 * /* trigger_percent */ 50) / 100;
257 /* capturing always starts at address zero */
258 oocd_trace_write_reg(oocd_trace
, OOCD_TRACE_ADDRESS
, 0x0);
259 oocd_trace_write_reg(oocd_trace
, OOCD_TRACE_TRIGGER_COUNTER
, trigger_count
);
260 oocd_trace_write_reg(oocd_trace
, OOCD_TRACE_CONTROL
, control
);
262 /* we're starting a new trace, initialize capture status */
263 etm_ctx
->capture_status
= TRACE_RUNNING
;
268 static int oocd_trace_stop_capture(struct etm_context
*etm_ctx
)
270 struct oocd_trace
*oocd_trace
= etm_ctx
->capture_driver_priv
;
272 /* trace stopped, just clear running flag, but preserve others */
273 etm_ctx
->capture_status
&= ~TRACE_RUNNING
;
275 oocd_trace_write_reg(oocd_trace
, OOCD_TRACE_CONTROL
, 0x0);
280 COMMAND_HANDLER(handle_oocd_trace_config_command
)
282 struct target
*target
;
287 LOG_ERROR("incomplete 'oocd_trace config <target> <tty>' command");
291 target
= get_current_target(CMD_CTX
);
292 arm
= target_to_arm(target
);
295 command_print(CMD_CTX
, "current target isn't an ARM");
301 struct oocd_trace
*oocd_trace
= malloc(sizeof(struct oocd_trace
));
303 arm
->etm
->capture_driver_priv
= oocd_trace
;
304 oocd_trace
->etm_ctx
= arm
->etm
;
306 /* copy name of TTY device used to communicate with OpenOCD + trace */
307 oocd_trace
->tty
= strndup(CMD_ARGV
[1], 256);
311 LOG_ERROR("target has no ETM defined, OpenOCD + trace left unconfigured");
317 COMMAND_HANDLER(handle_oocd_trace_status_command
)
319 struct target
*target
;
321 struct oocd_trace
*oocd_trace
;
324 target
= get_current_target(CMD_CTX
);
326 arm
= target_to_arm(target
);
329 command_print(CMD_CTX
, "current target isn't an ARM");
335 command_print(CMD_CTX
, "current target doesn't have an ETM configured");
339 if (strcmp(arm
->etm
->capture_driver
->name
, "oocd_trace") != 0)
341 command_print(CMD_CTX
, "current target's ETM capture driver isn't 'oocd_trace'");
345 oocd_trace
= (struct oocd_trace
*)arm
->etm
->capture_driver_priv
;
347 oocd_trace_read_reg(oocd_trace
, OOCD_TRACE_STATUS
, &status
);
350 command_print(CMD_CTX
, "trace clock locked");
352 command_print(CMD_CTX
, "no trace clock");
357 COMMAND_HANDLER(handle_oocd_trace_resync_command
)
359 struct target
*target
;
361 struct oocd_trace
*oocd_trace
;
362 size_t bytes_written
;
363 uint8_t cmd_array
[1];
365 target
= get_current_target(CMD_CTX
);
367 arm
= target_to_arm(target
);
370 command_print(CMD_CTX
, "current target isn't an ARM");
376 command_print(CMD_CTX
, "current target doesn't have an ETM configured");
380 if (strcmp(arm
->etm
->capture_driver
->name
, "oocd_trace") != 0)
382 command_print(CMD_CTX
, "current target's ETM capture driver isn't 'oocd_trace'");
386 oocd_trace
= (struct oocd_trace
*)arm
->etm
->capture_driver_priv
;
390 bytes_written
= write(oocd_trace
->tty_fd
, cmd_array
, 1);
392 command_print(CMD_CTX
, "requesting traceclock resync");
393 LOG_DEBUG("resyncing traceclk pll");
398 static const struct command_registration oocd_trace_all_command_handlers
[] = {
401 .handler
= handle_oocd_trace_config_command
,
402 .mode
= COMMAND_CONFIG
,
407 .handler
= handle_oocd_trace_status_command
,
408 .mode
= COMMAND_EXEC
,
409 .help
= "display OpenOCD + trace status",
413 .handler
= handle_oocd_trace_resync_command
,
414 .mode
= COMMAND_EXEC
,
415 .help
= "resync OpenOCD + trace capture clock",
417 COMMAND_REGISTRATION_DONE
419 static const struct command_registration oocd_trace_command_handlers
[] = {
421 .name
= "oocd_trace",
423 .help
= "OpenOCD trace capture driver command group",
424 .chain
= oocd_trace_all_command_handlers
,
426 COMMAND_REGISTRATION_DONE
429 struct etm_capture_driver oocd_trace_capture_driver
=
431 .name
= "oocd_trace",
432 .commands
= oocd_trace_command_handlers
,
433 .init
= oocd_trace_init
,
434 .status
= oocd_trace_status
,
435 .start_capture
= oocd_trace_start_capture
,
436 .stop_capture
= oocd_trace_stop_capture
,
437 .read_trace
= oocd_trace_read_trace
,
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)