2 # Defines basic Tcl procs that must be there for
5 # Embedded into OpenOCD executable
9 # Help text list. A list of command + help text pairs.
11 # Commands can be more than one word and they are stored
12 # as "flash banks" "help text x x x"
14 proc add_help_text
{cmd cmd_help
} {
16 lappend ocd_helptext
[list $cmd $cmd_help]
19 proc get_help_text
{} {
25 # Show flash in human readable form
26 # This is an example of a human readable form of a low level fn
30 foreach {a
} [ocd_flash_banks
] {
32 set result
"$result\n"
34 set result
[format "$result#%d: %s at 0x%08x, size 0x%08x, buswidth %d, chipwidth %d" $i $a(name
) $a(base
) $a(size
) $a(bus_width
) $a(chip_width
)]
40 # We need to explicitly redirect this to the OpenOCD command
41 # as Tcl defines the exit proc
46 #Print help text for a command. Word wrap
47 #help text that is too wide inside column.
51 foreach a
[lsort $ocd_helptext] {
52 if {[string length
$cmd]==0||
[string first
$cmd $a]!=-1||
[string first
$cmd [lindex $a 1]]!=-1} {
54 set cmdname
[lindex $a 0]
58 if {$n > [string length
$h]} {break}
60 set next_a
[expr $n+$w]
61 if {[string length
$h]>$n+$w} {
62 set xxxx
[string range
$h $n [expr $n+$w]]
63 for {set lastpos
[expr [string length
$xxxx]-1]} {$lastpos>=0&&[string compare
[string range
$xxxx $lastpos $lastpos] " "]!=0} {set lastpos
[expr $lastpos-1]} {
67 set next_a
[expr $lastpos+$n+1]
72 puts [format "%-25s %s" $cmdname [string range
$h $n [expr $next_a-1]] ]
80 add_help_text help
"Tcl implementation of help command"
83 # If a fn is unknown to Tcl, we try to execute it as an OpenOCD command
85 # We also support two level commands. "flash banks" is translated to
88 # do the name mangling from "flash banks" to "flash_banks"
89 if {[llength $args]>=2} {
90 set cmd_name
"[lindex $args 0]_[lindex $args 1]"
91 # Fix?? add a check here if this is a command?
92 # we'll strip away args until we fail anyway...
93 return [eval "$cmd_name [lrange $args 2 end]"]
95 # This really is an unknown command.
96 return -code error "Unknown command: $args"
99 proc new_target_name
{ } {
100 return [target number
[expr [target count
] - 1 ]]
104 proc target_script
{target_num eventname scriptname
} {
106 set tname
[target number
$target_num]
108 if { 0 == [string compare
$eventname "reset"] } {
109 $tname configure
-event reset-init
"script $scriptname"
113 if { 0 == [string compare
$eventname "post_reset"] } {
114 $tname configure
-event reset-init
"script $scriptname"
118 if { 0 == [string compare
$eventname "pre_reset"] } {
119 $tname configure
-event reset-start
"script $scriptname"
123 if { 0 == [string compare
$eventname "gdb_program_config"] } {
124 $tname configure
-event old-gdb_program_config
"script $scriptname"
128 return -code error "Unknown target (old) event: $eventname (try $tname configure -event NAME)"
132 add_help_text target_script
"DEPRECATED please see the new TARGETNAME configure -event interface"
134 # Try flipping / and \ to find file if the filename does not
135 # match the precise spelling
136 proc find
{filename} {
137 if {[catch {ocd_find
$filename} t
]==0} {
140 if {[catch {ocd_find
[string map
{\ /} $filename} t
]==0} {
143 if {[catch {ocd_find
[string map
{/ \\} $filename} t
]==0} {
146 # make sure error message matches original input string
147 return -code error "Can't find $filename"
149 add_help_text find
"<file> - print full path to file according to OpenOCD search rules"
152 proc script
{filename} {
153 source [find
$filename]
156 #proc daemon_reset {} {
157 # puts "Daemon reset is obsolete. Use -c init -c \"reset halt\" at end of openocd command line instead");
160 add_help_text script
"<filename> - filename of OpenOCD script (tcl) to run"
162 # Handle GDB 'R' packet. Can be overriden by configuration script,
163 # but it's not something one would expect target scripts to do
165 proc ocd_gdb_restart
{target_num
} {
166 # Fix!!! we're resetting all targets here! Really we should reset only
171 # If RCLK is not supported, use fallback_speed_khz
172 proc jtag_rclk
{fallback_speed_khz
} {
173 if {[catch {jtag_khz
0}]!=0} {
174 jtag_khz
$fallback_speed_khz
178 add_help_text jtag_rclk
"fallback_speed_khz - set JTAG speed to RCLK or use fallback speed"
180 proc ocd_process_reset
{ MODE
} {
182 # If this target must be halted...
184 if { 0 == [string compare
$MODE halt
] } {
187 if { 0 == [string compare
$MODE init
] } {
190 if { 0 == [string compare
$MODE run
] } {
194 return -error "Invalid mode: $MODE, must be one of: halt, init, or run";
197 foreach t
[ target names
] {
199 $t invoke-event reset-start
202 # Init the tap controller.
205 # Examine all targets.
206 foreach t
[ target names
] {
210 # Let the C code know we are asserting reset.
211 foreach t
[ target names
] {
212 $t invoke-event reset-assert-pre
213 # C code needs to know if we expect to 'halt'
214 $t arp_reset assert
$halt
215 $t invoke-event reset-assert-post
218 # Now de-assert reset.
219 foreach t
[ target names
] {
220 $t invoke-event reset-deassert-pre
221 # Again, de-assert code needs to know..
222 $t arp_reset deassert
$halt
223 $t invoke-event reset-deassert-post
226 # Pass 1 - Now try to halt.
228 foreach t
[target names
] {
230 # Wait upto 1 second for target to halt. Why 1sec? Cause
231 # the JTAG tap reset signal might be hooked to a slow
232 # resistor/capacitor circuit - and it might take a while
235 # Catch, but ignore any errors.
236 catch { $t arp_waitstate halted
1000 }
241 if { 0 != [string compare
$s "halted" ] } {
242 return -error [format "TARGET: %s - Not halted" $t]
247 #Pass 2 - if needed "init"
248 if { 0 == [string compare init
$MODE] } {
249 foreach t
[target names
] {
250 set err
[catch "$t arp_waitstate halted 5000"]
253 $t invoke-event reset-init
258 foreach t
[ target names
] {
259 $t invoke-event reset-end
263 # stubs for targets scripts that do not have production procedure
264 proc production_info
{} {
265 return "Imagine an explanation here..."
267 add_help_text production_info
"Displays information on production procedure for target script. Implement this procedure in target script."
269 proc production
{firmwarefile serialnumber
} {
270 puts "Imagine production procedure running successfully. Programmed $firmwarefile with serial number $serialnumber"
273 add_help_text production
"<serialnumber> - Runs production procedure. Throws exception if procedure failed. Prints progress messages. Implement this procedure in the target script."
275 proc production_test
{} {
276 puts "Imagine nifty test procedure having run to completion here."
278 add_help_text production
"Runs test procedure. Throws exception if procedure failed. Prints progress messages. Implement in target script."
281 return [eval "load_image $args"]
283 add_help_text
load "synonym to load_image"
286 return [eval "verify_image $args"]
289 add_help_text verify
"synonym to verify_image"
293 add_help_text cpu
"<name> - prints out target options and a comment on CPU which matches name"
295 # A list of names of CPU and options required
299 options {xscale
-variant IXP42x
}
304 options {arm7tdmi
-variant arm7tdmi
}
305 comment
{vanilla ARM7
}
309 # Invoked from Tcl code
310 proc ocd_cpu
{args
} {
314 foreach a
[lsort $ocd_cpu_list] {
315 if {[string length
$args]==0||
[string first
[string toupper
$name] [string toupper
"$a(name)$a(options)$a(comment)"]]!=-1} {
323 # 0123456789012345678901234567890123456789012345678901234567890123456789
324 puts "CPU Options Comment"
325 foreach a
[lsort [ocd_cpu
$args]] {
326 puts [format "%-20s%-40s%s" $a(name
) $a(options) $a(comment
)]
330 proc power_restore
{} {
331 puts "Sensed power restore."
335 add_help_text power_restore
"Overridable procedure run when power restore is detected. Runs 'reset init' by default."
337 proc power_dropout
{} {
338 puts "Sensed power dropout."
341 proc srst_deasserted
{} {
342 puts "Sensed nSRST deasserted."
345 add_help_text srst_deasserted
"Overridable procedure run when srst deassert is detected. Runs 'reset init' by default."
347 proc srst_asserted
{} {
348 puts "Sensed nSRST asserted."
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)