X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=doc%2Fopenocd.texi;h=039f4b2b6f2951fcd027e1ae86dd5e3e8b4ffda9;hp=19736ace3042fef4b6a80eb4c6a1f6a6f49cdc7a;hb=06b1bfed107d5d2508a586fc30345b5a137beec2;hpb=82e4477e4718cfae97c4ce67cd5d83e40dde4c54 diff --git a/doc/openocd.texi b/doc/openocd.texi index 19736ace30..039f4b2b6f 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -159,6 +159,10 @@ locations, i.e. /usr/include, /usr/lib. @node Running @chapter Running @cindex running openocd +@cindex --configfile +@cindex --debug_level +@cindex --logfile +@cindex --search The OpenOCD runs as a daemon, waiting for connections from clients (Telnet or GDB). Run with @option{--help} or @option{-h} to view the available command line arguments. @@ -172,7 +176,10 @@ the most information, including debug messages. The default setting is "2", outp only informational messages, warnings and errors. You can also change this setting from within a telnet or gdb session (@option{debug_level }). -You can redirect all output from the daemon to a file using the @option{-l } switch. +You can redirect all output from the daemon to a file using the @option{-l } switch. + +Search paths for config/script files can be added to openocd by using +the @option{-s } switch. @node Configuration @chapter Configuration @@ -434,6 +441,7 @@ Defines a target that should be debugged. Currently supported types are: @item arm926ejs @item arm966e @item cortex_m3 +@item feroceon @item xscale @end itemize @@ -532,8 +540,8 @@ Supported variants are @option{ixp42x}, @option{ixp45x}, @option{ixp46x}, Configures a flash bank at <@var{base}> of <@var{size}> bytes and <@var{chip_width}> and <@var{bus_width}> bytes using the selected flash . -@item @b{flash autoerase} <@option{on}|@option{off}> -@cindex flash autoerase +@item @b{flash auto_erase} <@option{on}|@option{off}> +@cindex flash auto_erase auto erase flash banks prior to writing. Currently only works when using @option{flash write_image} command. Default is @option{off}. @end itemize @@ -651,14 +659,23 @@ Poll the target for its current state. If the target is in debug mode, architect specific information about the current state are printed. An optional parameter allows continuous polling to be enabled and disabled. -@item @b{halt} +@item @b{halt} [@option{ms}] @cindex halt -Send a halt request to the target. The debugger signals the debug request, -and waits for the target to enter debug mode. +Send a halt request to the target and waits for it to halt for [@option{ms}]. +Default [@option{ms}] is 5 seconds if no arg given. +Optional arg @option{ms} is a timeout in milliseconds. Using 0 as the [@option{ms}] +will stop openocd from waiting. + +@item @b{wait_halt} [@option{ms}] +@cindex wait_halt +Wait for the target to enter debug mode. Optional [@option{ms}] is +a timeout in milliseconds. Default [@option{ms}] is 5 seconds if no +arg given. @item @b{resume} [@var{address}] @cindex resume Resume the target at its current code position, or at an optional address. +Openocd will wait 5 seconds for the target to resume. @item @b{step} [@var{address}] @cindex step