X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Ftarget%2Ftarget%2Freadme.txt;h=fade6591357de353ad35c99f023a46051356d96f;hp=b8bf5dcf88ead2ac5bc5d12fccbcf1f5c53f7a8b;hb=be968a54002b3387e0316c2fcce4ee93da840caa;hpb=d3f0549f08d8aac36143bca9e7f7e1308383b7c2

diff --git a/src/target/target/readme.txt b/src/target/target/readme.txt
index b8bf5dcf88..fade659135 100644
--- a/src/target/target/readme.txt
+++ b/src/target/target/readme.txt
@@ -1,18 +1,41 @@
-Prerequisites:
-The users of OpenOCD as well as computer programs interacting with OpenOCD are expecting that certain commands 
-do the same thing across all the targets.
-
-Rules to follow when writing scripts:
-
-1. The configuration script should be defined such as , for example, the following sequences are working:
-	reset
-	flash info <bank>
-and
-	reset 
-	flash erase_address <start> <len>
-	
-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.
+Prerequisites:
+The users of OpenOCD as well as computer programs interacting with OpenOCD are expecting that certain commands 
+do the same thing across all the targets.
+
+Rules to follow when writing scripts:
+
+1. The configuration script should be defined such as , for example, the following sequences are working:
+	reset
+	flash info <bank>
+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, oscilator speeds differ and having a single
+config file for the default/common settings.
+