- fix typo in openocd.texi

[openocd.git] / doc / openocd.texi

diff --git a/doc/openocd.texi b/doc/openocd.texi
index 60142be7a708e4ac901292afe5900f4ba6167765..a2a06251596a0d2eaa281b869d4aa6c597a4db9b 100644 (file)
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -262,7 +262,7 @@ Default behaviour is <@var{disable}>
 @cindex gdb_flash_program
 Set to <@var{enable}> so that openocd will program the flash memory when a
 vFlash packet is received.
-Default behaviour is <@var{disable}>
+Default behaviour is <@var{enable}>
 @item @b{daemon_startup} <@var{mode}>
 @cindex daemon_startup
 @option{mode} can either @option{attach} or @option{reset}
@@ -610,11 +610,6 @@ Supported variants are @option{ixp42x}, @option{ixp45x}, @option{ixp46x},
 @cindex flash bank
 Configures a flash bank at <@var{base}> of <@var{size}> bytes and <@var{chip_width}>
 and <@var{bus_width}> bytes using the selected flash <driver>.
-
-@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
 
 @subsection lpc2000 options
@@ -746,6 +741,22 @@ Close the OpenOCD daemon, disconnecting all clients (GDB, Telnet).
 @cindex debug_level
 Display or adjust debug level to n<0-3> 
 
+@item @b{fast} [@var{enable/disable}]
+@cindex fast
+Default disabled. Set default behaviour of OpenOCD to be "fast and dangerous". For instance ARM7/9 DCC memory
+downloads and fast memory access will work if the JTAG interface isn't too fast and
+the core doesn't run at a too low frequency. Note that this option only changes the default
+and that the indvidual options, like DCC memory downloads, can be enabled and disabled
+individually. 
+
+The target specific "dangerous" optimisation tweaking options may come and go
+as more robust and user friendly ways are found to ensure maximum throughput
+and robustness with a minimum of configuration. 
+
+Typically the "fast enable" is specified first on the command line:
+
+openocd -c "fast enable" -c "interface dummy" -f target/str710.cfg
+
 @item @b{log_output} <@var{file}>
 @cindex log_output
 Redirect logging to <file> (default: stderr) 
@@ -884,20 +895,17 @@ Erase sectors starting at <@var{address}> for <@var{length}> number of bytes
 @cindex flash write_bank
 Write the binary <@var{file}> to flash bank <@var{num}>, starting at
 <@option{offset}> bytes from the beginning of the bank.
-@item @b{flash write_image} <@var{file}> [@var{offset}] [@var{type}]
+@item @b{flash write_image} [@var{erase}] <@var{file}> [@var{offset}] [@var{type}]
 @cindex flash write_image
 Write the image <@var{file}> to the current target's flash bank(s). A relocation
 [@var{offset}] can be specified and the file [@var{type}] can be specified
 explicitly as @option{bin} (binary), @option{ihex} (Intel hex), @option{elf}
-(ELF file) or @option{s19} (Motorola s19).
+(ELF file) or @option{s19} (Motorola s19). Flash memory will be erased prior to programming
+if the @option{erase} parameter is given.
 @item @b{flash protect} <@var{num}> <@var{first}> <@var{last}> <@option{on}|@option{off}>
 @cindex flash protect
 Enable (@var{on}) or disable (@var{off}) protection of flash sectors <@var{first}> to
-<@var{last}> of @option{flash bank} <@var{num}>. 
-@item @b{flash auto_erase} <@var{on}|@var{off}>
-@cindex flash auto_erase
-Enable (@option{on}) to erase flash banks prior to writing using the flash @option{write_image} command
-only. Default is (@option{off}), flash banks have to be erased using @option{flash erase} command. 
+<@var{last}> of @option{flash bank} <@var{num}>.
 @end itemize
 
 @page
@@ -1279,10 +1287,10 @@ This is now handled in the @option{qSupported} PacketSize.
 @section Programming using gdb
 @cindex Programming using gdb
 
-By default the target memory map is not sent to gdb, this can be enabled by
+By default the target memory map is sent to gdb, this can be disabled by
 the following openocd config option:
 @smallexample
-gdb_memory_map enable
+gdb_memory_map disable
 @end smallexample
 For this to function correctly a valid flash config must also be configured
 in openocd. For speed also configure a valid working area.
@@ -1340,6 +1348,9 @@ use @option{flash write_bank} command with same args
 @item @b{arm7_9 fast_writes}
 @cindex arm7_9 fast_writes
 use @option{arm7_9 fast_memory_access} command with same args
+@item @b{flash auto_erase}
+@cindex flash auto_erase
+use @option{flash write_image} command passing @option{erase} as the first parameter.
 @end itemize
 
 @node FAQ