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 # FIX!!! need to figure out how to feed back relevant output
26 # from e.g. "flash banks" command...
27 proc board_produce
{filename serialnumber
} {
29 openocd
"flash write_image erase $filename [flash] bin"]]
30 openocd
"verify_image $filename [flash] bin"]]
31 echo
"Successfully ran production procedure"
35 echo
"Production test not implemented"
38 # Show flash in human readable form
39 # This is an example of a human readable form of a low level fn
43 foreach {a
} [ocd_flash_banks
] {
45 set result
"$result\n"
47 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
)]
53 # We need to explicitly redirect this to the OpenOCD command
54 # as Tcl defines the exit proc
59 #Print help text for a command. Word wrap
60 #help text that is too wide inside column.
64 foreach a
[lsort $ocd_helptext] {
65 if {[string length
$cmd]==0||
[string first
$cmd $a]!=-1||
[string first
$cmd [lindex $a 1]]!=-1} {
67 set cmdname
[lindex $a 0]
71 if {$n > [string length
$h]} {break}
73 set next_a
[expr $n+$w]
74 if {[string length
$h]>$n+$w} {
75 set xxxx
[string range
$h $n [expr $n+$w]]
76 for {set lastpos
[expr [string length
$xxxx]-1]} {$lastpos>=0&&[string compare
[string range
$xxxx $lastpos $lastpos] " "]!=0} {set lastpos
[expr $lastpos-1]} {
80 set next_a
[expr $lastpos+$n+1]
85 puts [format "%-25s %s" $cmdname [string range
$h $n [expr $next_a-1]] ]
93 add_help_text help
"Tcl implementation of help command"
96 # If a fn is unknown to Tcl, we try to execute it as an OpenOCD command
98 # We also support two level commands. "flash banks" is translated to
100 proc unknown {args
} {
101 # do the name mangling from "flash banks" to "flash_banks"
102 if {[llength $args]>=2} {
103 set cmd_name
"[lindex $args 0]_[lindex $args 1]"
104 # Fix?? add a check here if this is a command?
105 # we'll strip away args until we fail anyway...
106 return [eval "$cmd_name [lrange $args 2 end]"]
108 # This really is an unknown command.
109 return -code error "Unknown command: $args"
112 proc new_target_name
{ } {
113 return [target number
[expr [target count
] - 1 ]]
117 proc target_script
{target_num eventname scriptname
} {
119 set tname
[target number
$target_num]
121 if { 0 == [string compare
$eventname "reset"] } {
122 $tname configure
-event reset-init
"script $scriptname"
126 if { 0 == [string compare
$eventname "post_reset"] } {
127 $tname configure
-event reset-init
"script $scriptname"
131 if { 0 == [string compare
$eventname "pre_reset"] } {
132 $tname configure
-event reset-start
"script $scriptname"
136 if { 0 == [string compare
$eventname "gdb_program_config"] } {
137 $tname configure
-event old-gdb_program_config
"script $scriptname"
141 return -code error "Unknown target (old) event: $eventname (try $tname configure -event NAME)"
145 add_help_text target_script
"DEPRECATED please see the new TARGETNAME configure -event interface"
147 # Try flipping / and \ to find file if the filename does not
148 # match the precise spelling
149 proc find
{filename} {
150 if {[catch {ocd_find
$filename} t
]==0} {
153 if {[catch {ocd_find
[string map
{\ /} $filename} t
]==0} {
156 if {[catch {ocd_find
[string map
{/ \\} $filename} t
]==0} {
159 # make sure error message matches original input string
160 return -code error "Can't find $filename"
162 add_help_text find
"<file> - print full path to file according to OpenOCD search rules"
165 proc script
{filename} {
166 source [find
$filename]
169 #proc daemon_reset {} {
170 # puts "Daemon reset is obsolete. Use -c init -c \"reset halt\" at end of openocd command line instead");
173 add_help_text script
"<filename> - filename of OpenOCD script (tcl) to run"
175 # Handle GDB 'R' packet. Can be overriden by configuration script,
176 # but it's not something one would expect target scripts to do
178 proc ocd_gdb_restart
{target_num
} {
179 # Fix!!! we're resetting all targets here! Really we should reset only
184 # If RCLK is not supported, use fallback_speed_khz
185 proc jtag_rclk
{fallback_speed_khz
} {
186 if {[catch {jtag_khz
0}]!=0} {
187 jtag_khz
$fallback_speed_khz
191 add_help_text jtag_rclk
"fallback_speed_khz - set JTAG speed to RCLK or use fallback speed"
193 proc ocd_process_reset
{ MODE
} {
195 # If this target must be halted...
197 if { 0 == [string compare
$MODE halt
] } {
200 if { 0 == [string compare
$MODE init
] } {
203 if { 0 == [string compare
$MODE run
] } {
207 return -error "Invalid mode: $MODE, must be one of: halt, init, or run";
210 foreach t
[ target names
] {
212 $t invoke-event reset-start
215 # Init the tap controller.
218 # Examine all targets.
219 foreach t
[ target names
] {
223 # Let the C code know we are asserting reset.
224 foreach t
[ target names
] {
225 $t invoke-event reset-assert-pre
226 # C code needs to know if we expect to 'halt'
227 $t arp_reset assert
$halt
228 $t invoke-event reset-assert-post
231 # Now de-assert reset.
232 foreach t
[ target names
] {
233 $t invoke-event reset-deassert-pre
234 # Again, de-assert code needs to know..
235 $t arp_reset deassert
$halt
236 $t invoke-event reset-deassert-post
239 # Pass 1 - Now try to halt.
241 foreach t
[target names
] {
243 # Wait upto 1 second for target to halt. Why 1sec? Cause
244 # the JTAG tap reset signal might be hooked to a slow
245 # resistor/capacitor circuit - and it might take a while
248 # Catch, but ignore any errors.
249 catch { $t arp_waitstate halted
1000 }
254 if { 0 != [string compare
$s "halted" ] } {
255 return -error [format "TARGET: %s - Not halted" $t]
260 #Pass 2 - if needed "init"
261 if { 0 == [string compare init
$MODE] } {
262 foreach t
[target names
] {
263 set err
[catch "$t arp_waitstate halted 5000"]
266 $t invoke-event reset-init
271 foreach t
[ target names
] {
272 $t invoke-event reset-end
276 # stubs for targets scripts that do not have production procedure
277 proc production_info
{} {
278 return "Imagine an explanation here..."
280 add_help_text production_info
"Displays information on production procedure for target script"
282 proc production
{firmwarefile serialnumber
} {
283 puts "Imagine production procedure running successfully. Programmed $firmwarefile with serial number $serialnumber"
286 add_help_text production
"Runs production procedure. Throws exception if procedure failed. Prints progress messages."
288 proc production_test
{} {
289 puts "Imagine nifty test procedure having run to completion here."
291 add_help_text production
"Runs test procedure. Throws exception if procedure failed. Prints progress messages."
294 return [eval "load_image $args"]
296 add_help_text
load "synonym to load_image"
299 return [eval "verify_image $args"]
302 add_help_text verify
"synonym to verify_image"
305 add_help_text telnet_async
"<enable/disable> - enable/disable async messages. Default 0."
307 global telnet_async_state
308 set telnet_async_state
0
309 proc telnet_async
{state
} {
310 global telnet_async_state
311 if {[string compare
$state enable
]==0} {
312 set telnet_async_state
1
313 } elseif
{[string compare
$state disable
]==0} {
314 set telnet_async_state
0
316 return -code error "Illegal option $state"
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)