X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=tcl%2Ftarget%2Freadme.txt;h=f028b11c732325343af0cd41aba00a617282164f;hp=ca23c64bb0214e4f78d0abca029d08302832f2db;hb=45a86f8e2a58c7c0acb6328a660846946e81ed1c;hpb=dbbc9c41f7db210b0a4e226540a28e0a8a5019bf diff --git a/tcl/target/readme.txt b/tcl/target/readme.txt index ca23c64bb0..f028b11c73 100644 --- a/tcl/target/readme.txt +++ b/tcl/target/readme.txt @@ -1,5 +1,5 @@ Prerequisites: -The users of OpenOCD as well as computer programs interacting with OpenOCD are expecting that certain commands +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: @@ -8,30 +8,30 @@ Rules to follow when writing scripts: reset flash info and - reset + reset flash erase_address and reset init load - -In most cases this can be accomplished by specifying the default startup mode as reset_init (target command + +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 + +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...) +(turn off remapping, checksums, etc...) flash write_image [file] verify_image [file] -4. jtag_khz sets the maximum speed (or alternatively RCLK). If invoked +4. adapter_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, +files, so any adapter_khz in interface/xxx.cfg will be overridden by +target/xxx.cfg. adapter_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,