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 if {[catch {info body
$cmd_name}]==0} {
92 # the command exists, try it...
93 return [eval "$cmd_name [lrange $args 2 end]"]
96 # This really is an unknown command.
97 return -code error "Unknown command: $args"
100 proc new_target_name
{ } {
101 return [target number
[expr [target count
] - 1 ]]
104 # Try flipping / and \ to find file if the filename does not
105 # match the precise spelling
106 proc find
{filename} {
107 if {[catch {ocd_find
$filename} t
]==0} {
110 if {[catch {ocd_find
[string map
{\ /} $filename} t
]==0} {
113 if {[catch {ocd_find
[string map
{/ \\} $filename} t
]==0} {
116 # make sure error message matches original input string
117 return -code error "Can't find $filename"
119 add_help_text find
"<file> - print full path to file according to OpenOCD search rules"
122 proc script
{filename} {
123 source [find
$filename]
126 add_help_text script
"<filename> - filename of OpenOCD script (tcl) to run"
128 # Handle GDB 'R' packet. Can be overriden by configuration script,
129 # but it's not something one would expect target scripts to do
131 proc ocd_gdb_restart
{target_id
} {
132 # Fix!!! we're resetting all targets here! Really we should reset only
138 # This reset logic may be overridden by board/target/... scripts as needed
139 # to provide a reset that, if possible, is close to a power-up reset.
141 # Exit requirements include: (a) JTAG must be working, (b) the scan
142 # chain was validated with "jtag arp_init" (or equivalent), (c) nothing
143 # stays in reset. No TAP-specific scans were performed. It's OK if
144 # some targets haven't been reset yet; they may need TAP-specific scans.
146 # The "mode" values include: halt, init, run (from "reset" command);
147 # startup (at OpenOCD server startup, when JTAG may not yet work); and
148 # potentially more (for reset types like cold, warm, etc)
149 proc init_reset
{ mode
} {
154 global in_process_reset
155 set in_process_reset
0
157 # Catch reset recursion
158 proc ocd_process_reset
{ MODE
} {
159 global in_process_reset
160 if {$in_process_reset} {
161 set in_process_reset
0
162 return -code error "'reset' can not be invoked recursively"
165 set in_process_reset
1
166 set success [expr [catch {ocd_process_reset_inner
$MODE} result
]==0]
167 set in_process_reset
0
172 return -code error $result
176 proc ocd_process_reset_inner
{ MODE
} {
177 set targets
[target names
]
179 # If this target must be halted...
181 if { 0 == [string compare
$MODE halt
] } {
184 if { 0 == [string compare
$MODE init
] } {
187 if { 0 == [string compare
$MODE run
] } {
191 return -error "Invalid mode: $MODE, must be one of: halt, init, or run";
194 # Target event handlers *might* change which TAPs are enabled
195 # or disabled, so we fire all of them. But don't issue any
196 # target "arp_*" commands, which may issue JTAG transactions,
197 # unless we know the underlying TAP is active.
199 # NOTE: ARP == "Advanced Reset Process" ... "advanced" is
200 # relative to a previous restrictive scheme
204 $t invoke-event reset-start
207 # Use TRST or TMS/TCK operations to reset all the tap controllers.
208 # TAP reset events get reported; they might enable some taps.
211 # Examine all targets on enabled taps.
213 if {[jtag tapisenabled
[$t cget
-chain-position
]]} {
218 # Assert SRST, and report the pre/post events.
219 # Note: no target sees SRST before "pre" or after "post".
221 $t invoke-event reset-assert-pre
224 # C code needs to know if we expect to 'halt'
225 if {[jtag tapisenabled
[$t cget
-chain-position
]]} {
226 $t arp_reset assert
$halt
230 $t invoke-event reset-assert-post
233 # Now de-assert SRST, and report the pre/post events.
234 # Note: no target sees !SRST before "pre" or after "post".
236 $t invoke-event reset-deassert-pre
239 # Again, de-assert code needs to know if we 'halt'
240 if {[jtag tapisenabled
[$t cget
-chain-position
]]} {
241 $t arp_reset deassert
$halt
245 $t invoke-event reset-deassert-post
248 # Pass 1 - Now wait for any halt (requested as part of reset
249 # assert/deassert) to happen. Ideally it takes effect without
250 # first executing any instructions.
253 if {[jtag tapisenabled
[$t cget
-chain-position
]] == 0} {
257 # Wait upto 1 second for target to halt. Why 1sec? Cause
258 # the JTAG tap reset signal might be hooked to a slow
259 # resistor/capacitor circuit - and it might take a while
262 # Catch, but ignore any errors.
263 catch { $t arp_waitstate halted
1000 }
268 if { 0 != [string compare
$s "halted" ] } {
269 return -error [format "TARGET: %s - Not halted" $t]
274 #Pass 2 - if needed "init"
275 if { 0 == [string compare init
$MODE] } {
277 if {[jtag tapisenabled
[$t cget
-chain-position
]] == 0} {
281 set err
[catch "$t arp_waitstate halted 5000"]
284 $t invoke-event reset-init
290 $t invoke-event reset-end
294 # stubs for targets scripts that do not have production procedure
295 proc production_info
{} {
296 return "Imagine an explanation here..."
298 add_help_text production_info
"Displays information on production procedure for target script. Implement this procedure in target script."
300 proc production
{firmwarefile serialnumber
} {
301 puts "Imagine production procedure running successfully. Programmed $firmwarefile with serial number $serialnumber"
304 add_help_text production
"<serialnumber> - Runs production procedure. Throws exception if procedure failed. Prints progress messages. Implement this procedure in the target script."
306 proc production_test
{} {
307 puts "Imagine nifty test procedure having run to completion here."
309 add_help_text production_test
"Runs test procedure. Throws exception if procedure failed. Prints progress messages. Implement in target script."
311 add_help_text cpu
"<name> - prints out target options and a comment on CPU which matches name"
313 # A list of names of CPU and options required
317 options {xscale
-variant IXP42x
}
322 options {arm7tdmi
-variant arm7tdmi
}
323 comment
{vanilla ARM7
}
327 # Invoked from Tcl code
328 proc ocd_cpu
{args
} {
332 foreach a
[lsort $ocd_cpu_list] {
333 if {[string length
$args]==0||
[string first
[string toupper
$name] [string toupper
"$a(name)$a(options)$a(comment)"]]!=-1} {
341 # 0123456789012345678901234567890123456789012345678901234567890123456789
342 puts "CPU Options Comment"
343 foreach a
[lsort [ocd_cpu
$args]] {
344 puts [format "%-20s%-40s%s" $a(name
) $a(options) $a(comment
)]
348 proc power_restore
{} {
349 puts "Sensed power restore."
353 add_help_text power_restore
"Overridable procedure run when power restore is detected. Runs 'reset init' by default."
355 proc power_dropout
{} {
356 puts "Sensed power dropout."
359 proc srst_deasserted
{} {
360 puts "Sensed nSRST deasserted."
363 add_help_text srst_deasserted
"Overridable procedure run when srst deassert is detected. Runs 'reset init' by default."
365 proc srst_asserted
{} {
366 puts "Sensed nSRST asserted."
369 # catch any exceptions, capture output and return output
370 proc capture_catch
{a
} {
378 # Executed during "init". Can be overridden
379 # by board/target/... scripts
381 if {[catch {jtag arp_init
} err
]!=0} {
382 # try resetting additionally
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)