openocd/tcl/target
David Brownell 96f9790279 rename jtag_khz as adapter_khz
Globally rename "jtag_khz" as "adapter_khz", and move it out of the "jtag"
command group ...  it needs to be used with non-JTAG transports

Includes a migration aid (in jtag/startup.tcl) so that old user scripts
won't break.  That aid should Sunset in about a year.  (We may want to
update it to include a nag message too.)

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2010-03-15 08:37:43 -07:00
..
aduc702x.cfg target.cfg: update to use new flash configuration syntax 2009-12-17 11:39:09 +00:00
ar71xx.cfg more tcl/{board,target} cleanup 2009-12-15 14:45:26 -08:00
at91r40008.cfg AT91R40008/Ethernut 3 configuration 2010-02-02 11:09:53 -08:00
at91rm9200.cfg target.cfg: remove "-work-area-virt 0" 2009-11-08 08:52:40 -08:00
at91sam3u1c.cfg update 'flash bank' usage in scripts 2009-11-19 13:39:41 -08:00
at91sam3u1e.cfg update 'flash bank' usage in scripts 2009-11-19 13:39:41 -08:00
at91sam3u2c.cfg update 'flash bank' usage in scripts 2009-11-19 13:39:41 -08:00
at91sam3u2e.cfg update 'flash bank' usage in scripts 2009-11-19 13:39:41 -08:00
at91sam3u4c.cfg update 'flash bank' usage in scripts 2009-11-19 13:39:41 -08:00
at91sam3u4e.cfg tcl/target/at91sam3u4e.cfg: changed case in dependent file 2010-01-20 10:32:53 -08:00
at91sam3uXX.cfg target.cfg: (re)move some bogus reset_config lines 2009-11-10 09:25:26 -08:00
at91sam7sx.cfg update 'flash bank' usage in scripts 2009-11-19 13:39:41 -08:00
at91sam9rl.cfg target library: configuration files for openocd tested with Atmel SAM-ICE V6 JTAG. 2010-02-11 21:10:51 +01:00
at91sam9260.cfg target.cfg: remove "-work-area-virt 0" 2009-11-08 08:52:40 -08:00
at91sam9260_ext_RAM_ext_flash.cfg rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
c100.cfg rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
c100config.tcl Remove annoying EOL whitespace (again, sigh). 2009-09-30 23:02:15 +00:00
c100helper.tcl rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
c100regs.tcl Remove annoying end-of-line whitespace from tcl/* files 2009-09-21 18:48:22 +00:00
cs351x.cfg target.cfg: remove "-work-area-virt 0" 2009-11-08 08:52:40 -08:00
davinci.cfg fix syntax of mww phys. 2009-10-25 22:15:57 +01:00
dragonite.cfg Dragonite target script 2009-10-06 22:55:04 +00:00
dsp56321.cfg rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
epc9301.cfg update 'flash bank' usage in scripts 2009-11-19 13:39:41 -08:00
faux.cfg target.cfg: update to use new flash configuration syntax 2009-12-17 11:39:09 +00:00
feroceon.cfg Remove annoying end-of-line whitespace from tcl/* files 2009-09-21 18:48:22 +00:00
icepick.cfg Remove vim editor commands from TCL files. 2009-07-02 11:17:04 +00:00
imx.cfg Tcl and doc: update to match new 'arm mcr ...' etc 2009-12-01 01:10:19 -08:00
imx21.cfg Remove annoying end-of-line whitespace from tcl/* files 2009-09-21 18:48:22 +00:00
imx25.cfg iMX2* + ETB targets: hook up ETM and ETB 2009-11-13 16:56:11 -08:00
imx27.cfg iMX2* + ETB targets: hook up ETM and ETB 2009-11-13 16:56:11 -08:00
imx31.cfg imx31: move srst delay into config script 2009-12-15 07:55:20 +01:00
imx35.cfg ARM11: ETM + ETB support 2009-11-13 16:58:14 -08:00
is5114.cfg testing/examples/.../*cfg: rm jtag_device calls 2009-12-15 14:45:26 -08:00
ixp42x.cfg Remove annoying end-of-line whitespace from tcl/* files 2009-09-21 18:48:22 +00:00
lm3s9b9x.cfg update 'flash bank' usage in scripts 2009-11-19 13:39:41 -08:00
lm3s811.cfg update 'flash bank' usage in scripts 2009-11-19 13:39:41 -08:00
lm3s1968.cfg update 'flash bank' usage in scripts 2009-11-19 13:39:41 -08:00
lm3s6965.cfg rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
lpc1768.cfg LPC1768 updates, IAR board support 2010-03-02 15:02:01 -08:00
lpc2103.cfg update 'flash bank' usage in scripts 2009-11-19 13:39:41 -08:00
lpc2124.cfg rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
lpc2129.cfg update 'flash bank' usage in scripts 2009-11-19 13:39:41 -08:00
lpc2148.cfg update 'flash bank' usage in scripts 2009-11-19 13:39:41 -08:00
lpc2294.cfg update 'flash bank' usage in scripts 2009-11-19 13:39:41 -08:00
lpc2378.cfg rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
lpc2478.cfg update 'flash bank' usage in scripts 2009-11-19 13:39:41 -08:00
lpc2900.cfg target.cfg: update to use new flash configuration syntax 2009-12-17 11:39:09 +00:00
lpc3250.cfg scripts: Phytec/LPC2350 config scripts 2010-02-04 10:25:44 +01:00
mc13224v.cfg rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
mega128.cfg rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
netx500.cfg target.cfg: TAP id for Hilscher netX 500 2009-11-20 12:21:00 -08:00
omap2420.cfg OMAP2420: define reset-assert event 2009-12-07 14:57:43 -08:00
omap3530.cfg omap3530.cfg: use new "reset-assert" event 2009-11-27 18:50:31 -08:00
omap5912.cfg target.cfg: remove "-work-area-virt 0" 2009-11-08 08:52:40 -08:00
pic32mx.cfg PIC32MX: update cfg script 2010-03-15 09:38:46 +00:00
pxa3xx.cfg create target/pxa3xx.cfg 2009-11-29 12:57:05 -08:00
pxa255.cfg rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
pxa270.cfg target.cfg: remove "-work-area-virt 0" 2009-11-08 08:52:40 -08:00
readme.txt rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
sam7se512.cfg target.cfg: update to use new flash configuration syntax 2009-12-17 11:39:09 +00:00
sam7x256.cfg target.cfg: update to use new flash configuration syntax 2009-12-17 11:39:09 +00:00
samsung_s3c2410.cfg target.cfg: remove "-work-area-virt 0" 2009-11-08 08:52:40 -08:00
samsung_s3c2440.cfg target.cfg: remove "-work-area-virt 0" 2009-11-08 08:52:40 -08:00
samsung_s3c2450.cfg rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
samsung_s3c4510.cfg Remove annoying end-of-line whitespace from tcl/* files 2009-09-21 18:48:22 +00:00
samsung_s3c6410.cfg ARM11: ETM + ETB support 2009-11-13 16:58:14 -08:00
sharp_lh79532.cfg Remove annoying end-of-line whitespace from tcl/* files 2009-09-21 18:48:22 +00:00
smdk6410.cfg update 'flash bank' usage in scripts 2009-11-19 13:39:41 -08:00
smp8634.cfg David Brownell <david-b@pacbell.net> "set _TARGETNAME ..." cleanup 2009-09-04 05:17:03 +00:00
stellaris.cfg rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
stm32.cfg rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
str710.cfg rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
str730.cfg rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
str750.cfg rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
str912.cfg target.cfg: update to use new flash configuration syntax 2009-12-17 11:39:09 +00:00
telo.cfg rename jtag_khz as adapter_khz 2010-03-15 08:37:43 -07:00
test_reset_syntax_error.cfg Remove annoying end-of-line whitespace from tcl/* files 2009-09-21 18:48:22 +00:00
test_syntax_error.cfg Remove annoying end-of-line whitespace from tcl/* files 2009-09-21 18:48:22 +00:00
ti_dm355.cfg Add a new JTAG "setup" event; use for better DaVinci ICEpick support. 2009-10-05 08:20:28 +00:00
ti_dm365.cfg Add a new JTAG "setup" event; use for better DaVinci ICEpick support. 2009-10-05 08:20:28 +00:00
ti_dm6446.cfg Add a new JTAG "setup" event; use for better DaVinci ICEpick support. 2009-10-05 08:20:28 +00:00
tmpa900.cfg more tcl/{board,target} cleanup 2009-12-15 14:45:26 -08:00
tmpa910.cfg more tcl/{board,target} cleanup 2009-12-15 14:45:26 -08:00
xba_revA3.cfg update 'flash bank' usage in scripts 2009-11-19 13:39:41 -08:00

readme.txt

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. 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 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,
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.