X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=doc%2Fopenocd.texi;h=10d40570123b2b9355fd44c4676693fd240a1ebd;hb=4457800afe9ab2e1e7e466570b52a764cbd22574;hp=80bb33eca01d6585f9fed92e1bf4cb0a957b0bf7;hpb=a42f85fe9a52c295b9e5a629f6701c6ac899207a;p=openocd.git diff --git a/doc/openocd.texi b/doc/openocd.texi index 80bb33eca0..10d4057012 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -96,6 +96,12 @@ The main OpenOCD web site is available at @uref{http://openocd.berlios.de/web/} @chapter Building @cindex building OpenOCD +If you are interested in getting actual work done rather than building +OpenOCD, then check if your interface supplier provides binaries for +you. Chances are that that binary is from some SVN version that is more +stable than SVN trunk where bleeding edge development takes place. + + You can download the current SVN version with SVN client of your choice from the following repositories: @@ -257,6 +263,11 @@ OpenOCD command line using the @option{-c} command line switch. @item @b{telnet_port} <@var{number}> @cindex telnet_port Port on which to listen for incoming telnet connections +@item @b{tcl_port} <@var{number}> +@cindex tcl_port +Port on which to listen for incoming TCL syntax. This port is intended as +a simplified RPC connection that can be used by clients to issue commands +and get the output from the TCL engine. @item @b{gdb_port} <@var{number}> @cindex gdb_port First port on which to listen for incoming GDB connections. The GDB port for the @@ -287,11 +298,6 @@ Default behaviour is <@var{enable}> Set to <@var{enable}> to cause OpenOCD to program the flash memory when a vFlash packet is received. Default behaviour is <@var{enable}> - at item @b{tcl_port} <@var{number}> - at cindex tcl_port -Port on which to listen for incoming TCL syntax. This port is intended as -a simplified RPC connection that can be used by clients to issue commands -and get the output from the TCL engine. @end itemize @section JTAG interface configuration @@ -409,8 +415,7 @@ How long (in milliseconds) OpenOCD should wait after deasserting nSRST before starting new JTAG operations. @item @b{jtag_ntrst_delay} <@var{ms}> @cindex jtag_ntrst_delay -How long (in milliseconds) OpenOCD should wait after deasserting nTRST before -starting new JTAG operations. +Same @b{jtag_nsrst_delay}, but for nTRST The jtag_n[st]rst_delay options are useful if reset circuitry (like a reset supervisor, or on-chip features) keep a reset line asserted for some time after the external reset @@ -437,13 +442,20 @@ Currently supported cables are @cindex wiggler The original Wiggler layout, also supported by several clones, such as the Olimex ARM-JTAG +@item @b{wiggler2} +@cindex wiggler2 +Same as original wiggler except an led is fitted on D5. +@item @b{wiggler_ntrst_inverted} +@cindex wiggler_ntrst_inverted +Same as original wiggler except TRST is inverted. @item @b{old_amt_wiggler} @cindex old_amt_wiggler The Wiggler configuration that comes with Amontec's Chameleon Programmer. The new version available from the website uses the original Wiggler layout ('@var{wiggler}') @item @b{chameleon} @cindex chameleon -The Amontec Chameleon's CPLD when operated in configuration mode. This is only used to program the Chameleon itself, not a connected target. +The Amontec Chameleon's CPLD when operated in configuration mode. This is only used to +program the Chameleon itself, not a connected target. @item @b{dlc5} @cindex dlc5 The Xilinx Parallel cable III. @@ -454,7 +466,14 @@ This is also the layout used by the HollyGates design (see @uref{http://www.lartmaker.nl/projects/jtag/}). @item @b{flashlink} @cindex flashlink -The ST Parallel cable. +The ST Parallel cable. +@item @b{arm-jtag} +@cindex arm-jtag +Same as original wiggler except SRST and TRST connections reversed and +TRST is also inverted. +@item @b{altium} +@cindex altium +Altium Universal JTAG cable. @end itemize @item @b{parport_write_on_exit} <@var{on|off}> @cindex parport_write_on_exit @@ -689,6 +708,12 @@ stellaris flash plugin only require the @var{target#}. @b{flash bank stm32x} <@var{base}> <@var{size}> 0 0 <@var{target#}> stm32x flash plugin only require the @var{target#}. +@subsection aduc702x options +@cindex aduc702x options + +@b{flash bank aduc702x} <@var{base}> <@var{size}> 0 0 <@var{target#}> +aduc702x flash plugin require the flash @var{base}, @var{size} and @var{target#}. + @node Target library @chapter Target library @cindex Target library @@ -1269,6 +1294,11 @@ to debug remote targets. @section Connecting to gdb @cindex Connecting to gdb +Use GDB 6.7 or newer with OpenOCD if you run into trouble. For instance 6.3 has a +known bug where it produces bogus memory access errors, which has since +been fixed: look up 1836 in http://sourceware.org/cgi-bin/gnatsweb.pl?database=gdb + + A connection is typically started as follows: @smallexample target remote localhost:3333 @@ -1424,6 +1454,10 @@ Certain OpenOCD commands have been deprecated/removed during the various revisio @item @b{load_binary} @cindex load_binary use @option{load_image} command with same args +@item @b{target} +@cindex target +@option{target} no longer take the reset_init, reset_run, run_and_halt, run_and_init. The @option{reset} command +always does a @option{reset run} when passed no arguments. @item @b{dump_binary} @cindex dump_binary use @option{dump_image} command with same args