From 99b03d3bfbde879f07b02990c9d8bec3b0ee3927 Mon Sep 17 00:00:00 2001 From: Paul Fertser Date: Thu, 21 Dec 2017 13:40:29 +0300 Subject: [PATCH] doc: add SVF optional arguments descriptions Change-Id: I1a3e5b04b6bc4821c4d11c8fcb33b426d6d41bfb Signed-off-by: Paul Fertser Reviewed-on: http://openocd.zylin.com/4314 Tested-by: jenkins Reviewed-by: Jim Norris Reviewed-by: Karl Palsson --- doc/openocd.texi | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/doc/openocd.texi b/doc/openocd.texi index ebd03c4cb..8ff9010a6 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -8779,11 +8779,27 @@ way to represent JTAG test patterns in text files. In a debug session using JTAG for its transport protocol, OpenOCD supports running such test files. -@deffn Command {svf} filename [@option{quiet}] +@deffn Command {svf} @file{filename} [@option{-tap @var{tapname}}] [@option{[-]quiet}] @ + [@option{[-]nil}] [@option{[-]progress}] [@option{[-]ignore_error}] This issues a JTAG reset (Test-Logic-Reset) and then runs the SVF script from @file{filename}. -Unless the @option{quiet} option is specified, -each command is logged before it is executed. + +Arguments can be specified in any order; the optional dash doesn't +affect their semantics. + +Command options: +@itemize @minus +@item @option{-tap @var{tapname}} ignore IR and DR headers and footers +specified by the SVF file with HIR, TIR, HDR and TDR commands; +instead, calculate them automatically according to the current JTAG +chain configuration, targetting @var{tapname}; +@item @option{[-]quiet} do not log every command before execution; +@item @option{[-]nil} ``dry run'', i.e., do not perform any operations +on the real interface; +@item @option{[-]progress} enable progress indication; +@item @option{[-]ignore_error} continue execution despite TDO check +errors. +@end itemize @end deffn @section XSVF: Xilinx Serial Vector Format