Audit and remove redundant uses of replacements.h in the tree.

[fw/openocd] / src / target / target / readme.txt

diff --git a/src/target/target/readme.txt b/src/target/target/readme.txt
index 19a7d3a23685659d92f9d6a92b2f54f3128afc0e..ca23c64bb0214e4f78d0abca029d08302832f2db 100644 (file)
--- a/src/target/target/readme.txt
+++ b/src/target/target/readme.txt
@@ -10,9 +10,32 @@ Rules to follow when writing scripts:
 and
        reset 
        flash erase_address <start> <len>
+and
+       reset init
+       load
        
 In most cases this can be accomplished by specifying the default startup mode as reset_init (target command 
 in the configuration file).
  
 2. If the target is correctly configured, flash must be writable without any other helper commands. It is 
 assumed that all write-protect mechanisms should be disabled.
+
+3. The configuration scripts should be defined such as the binary that was written to flash verifies
+(turn off remapping, checksums, etc...) 
+
+flash write_image [file] <parameters>
+verify_image [file] <parameters>
+
+4. jtag_khz sets the maximum speed (or alternatively RCLK). If invoked
+multiple times only the last setting is used.
+
+interface/xxx.cfg files are always executed *before* target/xxx.cfg
+files, so any jtag_khz in interface/xxx.cfg will be overridden by
+target/xxx.cfg. jtag_khz in interface/xxx.cfg would then, effectively,
+set the default JTAG speed.
+
+Note that a target/xxx.cfg file can invoke another target/yyy.cfg file,
+so one can create target subtype configurations where e.g. only
+amount of DRAM, oscillator speeds differ and having a single
+config file for the default/common settings.
+