diff options
author | Austin Morton <austinpmorton@gmail.com> | 2015-02-21 04:20:33 -0500 |
---|---|---|
committer | Paul Fertser <fercerpav@gmail.com> | 2015-03-09 06:30:30 +0000 |
commit | 1d0cf0df37a4e831ca3121ba8987d5848cad3e42 (patch) | |
tree | f1a83b1fc467323c8d19024e4274c67c35f2ed34 /doc | |
parent | c50047bb418da6a4ed735ca87acee04e7fd2dbe7 (diff) |
server: tcl_notifications command
Implements async target notifications to the tcl server
Change-Id: I4d83e9fa209e95426c440030597f99e9f0c3b260
Signed-off-by: Austin Morton <austinpmorton@gmail.com>
Reviewed-on: http://openocd.zylin.com/2336
Reviewed-by: Paul Fertser <fercerpav@gmail.com>
Tested-by: jenkins
Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/openocd.texi | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi index c708c206..9a697e1d 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -8642,6 +8642,28 @@ Remember that most of the OpenOCD commands need to be prefixed with See @file{contrib/rpc_examples/} for specific client implementations. +@section Tcl RPC server notifications +@cindex RPC Notifications + +Notifications are sent asynchronously to other commands being executed over +the RPC server, so the port must be polled continuously. + +Target event, state and reset notifications are emitted as Tcl associative arrays +in the following format. + +@verbatim +type target_event event [event-name] +type target_state state [state-name] +type target_reset mode [reset-mode] +@end verbatim + +@deffn {Command} tcl_notifications [on/off] +Toggle output of target notifications to the current Tcl RPC server. +Only available from the Tcl RPC server. +Defaults to off. + +@end deffn + @node FAQ @chapter FAQ @cindex faq |