- stm32x flash driver: add support for low density devices

[openocd.git] / doc / openocd.texi

diff --git a/doc/openocd.texi b/doc/openocd.texi
index e53d9caefaf0f551e53b082251143b26cbc8f429..b436ab721e76f129bd4cfad90a0dadedeaa3a8bc 100644 (file)
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -51,6 +51,7 @@ This manual documents edition @value{EDITION} of the Open On-Chip Debugger
 * Target library::    Target library
 * Commands::          OpenOCD Commands
 * Sample Scripts::    Sample Target Scripts
+* TFTP::              TFTP
 * GDB and OpenOCD::   Using GDB and OpenOCD
 * TCL and OpenOCD::   Using TCL and OpenOCD
 * TCL scripting API:: Tcl scripting API
@@ -571,11 +572,13 @@ Currently, there are no options available for the ep93xx interface.
 @item @b{cortex_m3}
 @item @b{feroceon}
 @item @b{xscale}
+@item @b{arm11}
 @item @b{mips_m4k}
 @end itemize
 
 If you want to use a target board that is not on this list, see Adding a new
-target board
+target board.
+The @option{target types} command can be used to get the list of targets supported from within openocd.
 
 Endianess may be @option{little} or @option{big}.
 
@@ -633,6 +636,16 @@ be detected and the normal reset behaviour used.
 Supported variants are @option{ixp42x}, @option{ixp45x}, @option{ixp46x},
 @option{pxa250}, @option{pxa255}, @option{pxa26x}.
 
+@subsection arm11 options
+@cindex arm11 options
+
+@subsection mips_m4k options
+@cindex mips_m4k options
+Use variant @option{ejtag_srst} when debugging targets that
+do not provide a functional SRST line on the EJTAG connector.
+This causes openocd to instead use an EJTAG software reset command to reset the processor.
+You still need to enable @option{srst} on the reset configuration command to enable openocd hardware reset functionality.
+
 @section Flash configuration
 @cindex Flash configuration
 
@@ -936,11 +949,18 @@ These commands allow accesses of a specific size to the memory system:
 @item @b{fast_load_image} <@var{file}> <@var{address}> [@option{bin}|@option{ihex}|@option{elf}]
 @cindex fast_load_image
 @anchor{fast_load_image}
-@*Same functionality and arguments as load_image, but image is stored in memory
+@*Normally you should be using @b{load_image} or GDB load. However, for
+testing purposes or when IO overhead is significant(OpenOCD running on embedded
+host), then storing the image in memory and uploading the image to the target
+can be a way to upload e.g. multiple debug sessions when the binary does not change.
+Arguments as @b{load_image}, but image is stored in OpenOCD host
+memory, i.e. does not affect target.  This approach is also useful when profiling
+target programming performance as IO and target programming can easily be profiled
+seperately.
 @item @b{fast_load}
 @cindex fast_image
 @anchor{fast_image}
-@*Load active fast load image to current target
+@*Loads image stored in memory by @b{fast_load_image} to current target. Must be preceeded by fast_load_image.
 @item @b{dump_image} <@var{file}> <@var{address}> <@var{size}>
 @cindex dump_image
 @anchor{dump_image}
@@ -1739,6 +1759,15 @@ is a ARM920T (2x16kByte cache) or ARM922T (2x8kByte cache).
 @*Translate a virtual address to a physical address. 
 @end itemize
 
+@subsection CORTEX_M3 specific commands
+@cindex CORTEX_M3 specific commands
+
+@itemize @bullet
+@item @b{cortex_m3 maskisr} <@var{on}|@var{off}>
+@cindex cortex_m3 maskisr
+@*Enable masking (disabling) interrupts during target step/resume.
+@end itemize
+
 @page
 @section Debug commands
 @cindex Debug commands
@@ -1809,6 +1838,22 @@ See libdcc in the contrib dir for more details.
 @*Enable/disable target debugmsgs requests. debugmsgs enable messages to be sent to the debugger while the target is running.
 @end itemize
 
+@node TFTP
+@chapter TFTP
+@cindex TFTP
+If OpenOCD runs on an embedded host(as ZY1000 does), then tftp can
+be used to access files on PCs(either developer PC or some other PC).
+
+The way this works is to prefix a filename by "/tftp/ip/" and append
+the tftp path on the tftp server(tftpd). E.g. "load_image /tftp/10.0.0.96/c:\temp\abc.elf"
+will load c:\temp\abc.elf from the developer pc (10.0.0.96) into memory as
+if the file was hosted on the embedded host.
+
+In order to achieve decent performance, you must choose a tftp server
+that supports a packet size bigger than the default packet size(512 bytes). There
+are numerous tftp servers out there(free and commercial) and you will have to do
+a bit of googling to find something that fits your requirements.
+
 @node Sample Scripts
 @chapter Sample Scripts
 @cindex scripts
@@ -2065,6 +2110,22 @@ halt
 @chapter FAQ
 @cindex faq
 @enumerate
+@item Why does not backslashes in paths under Windows doesn't work?
+
+OpenOCD uses Tcl and a backslash is an escape char. Use @{ and @}
+around Windows filenames. 
+
+@smallexample
+> echo \a
+
+> echo @{\a@}
+\a
+> echo "\a"
+
+>
+@end smallexample
+To 
+
 @item OpenOCD complains about a missing cygwin1.dll.
 
 Make sure you have Cygwin installed, or at least a version of OpenOCD that