aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAustin Morton <austinpmorton@gmail.com>2015-03-09 05:34:52 -0400
committerPaul Fertser <fercerpav@gmail.com>2015-09-05 09:19:26 +0100
commitd28ab08cfafb3ad7ff8dc539644883217e89f8c4 (patch)
tree92ed1864558e06752ac1906d86459a924755b3ed /doc
parent85903156d70aec211b3c66326aeffc6ceba6ebb4 (diff)
downloadriscv-openocd-d28ab08cfafb3ad7ff8dc539644883217e89f8c4.zip
riscv-openocd-d28ab08cfafb3ad7ff8dc539644883217e89f8c4.tar.gz
riscv-openocd-d28ab08cfafb3ad7ff8dc539644883217e89f8c4.tar.bz2
server: tcl_trace command
Implements async target trace output to the tcl server Change-Id: I0178f6404447337d523782a1d2c317457030da40 Signed-off-by: Austin Morton <austinpmorton@gmail.com> Reviewed-on: http://openocd.zylin.com/2588 Tested-by: jenkins Reviewed-by: Paul Fertser <fercerpav@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/openocd.texi26
1 files changed, 25 insertions, 1 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi
index 63ab5de..21141ca 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -7570,7 +7570,7 @@ Defaulting to 0.
@cindex ITM
@cindex ETM
-@deffn Command {tpiu config} (@option{disable} | ((@option{external} | @option{internal @var{filename}}) @
+@deffn Command {tpiu config} (@option{disable} | ((@option{external} | @option{internal (@var{filename} | -)}) @
(@option{sync @var{port_width}} | ((@option{manchester} | @option{uart}) @var{formatter_enable})) @
@var{TRACECLKIN_freq} [@var{trace_freq}]))
@@ -7594,6 +7594,8 @@ output externally (with an additional UART or logic analyzer hardware);
@item @option{internal @var{filename}} configure TPIU and debug adapter to
gather trace data and append it to @var{filename} (which can be
either a regular file or a named pipe);
+@item @option{internal -} configure TPIU and debug adapter to
+gather trace data, but not write to any file. Useful in conjunction with the @command{tcl_trace} command;
@item @option{sync @var{port_width}} use synchronous parallel trace output
mode, and set port width to @var{port_width};
@item @option{manchester} use asynchronous SWO mode with Manchester
@@ -8699,6 +8701,28 @@ Defaults to off.
@end deffn
+@section Tcl RPC server trace output
+@cindex RPC trace output
+
+Trace data is sent asynchronously to other commands being executed over
+the RPC server, so the port must be polled continuously.
+
+Target trace data is emitted as a Tcl associative array in the following format.
+
+@verbatim
+type target_trace data [trace-data-hex-encoded]
+@end verbatim
+
+@deffn {Command} tcl_trace [on/off]
+Toggle output of target trace data to the current Tcl RPC server.
+Only available from the Tcl RPC server.
+Defaults to off.
+
+See an example application here:
+@url{https://github.com/apmorton/OpenOcdTraceUtil} [OpenOcdTraceUtil]
+
+@end deffn
+
@node FAQ
@chapter FAQ
@cindex faq