X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=doc%2Fopenocd.texi;h=9a697e1d4713a62e8cbebd922a0ff316fe1000f7;hp=c708c20613b11d62e9a82c8cca04d62db4d471ec;hb=1d0cf0df37a4e831ca3121ba8987d5848cad3e42;hpb=c50047bb418da6a4ed735ca87acee04e7fd2dbe7 diff --git a/doc/openocd.texi b/doc/openocd.texi index c708c20613..9a697e1d47 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