add overridable Tcl "init_reset"
[fw/openocd] / src / helper / startup.tcl
index 8c3ece56af6e938cf2795bd0c8c468bdeec50aa2..b12d02bbe8ebd84719e3872c4c49195eedd58e5c 100644 (file)
@@ -24,16 +24,16 @@ proc get_help_text {} {
 
 # Show flash in human readable form
 # This is an example of a human readable form of a low level fn
-proc flash_banks {} { 
-       set i 0         
+proc flash_banks {} {
+       set i 0
        set result ""
        foreach {a} [ocd_flash_banks] {
                if {$i > 0} {
                        set result "$result\n"
                }
                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)]
-               set i [expr $i+1]       
-       }       
+               set i [expr $i+1]
+       }
        return $result
 }
 
@@ -56,7 +56,7 @@ proc help {args} {
                        set n 0
                        while 1 {
                                if {$n > [string length $h]} {break}
-                               
+
                                set next_a [expr $n+$w]
                                if {[string length $h]>$n+$w} {
                                        set xxxx [string range $h $n [expr $n+$w]]
@@ -67,8 +67,8 @@ proc help {args} {
                                                set next_a [expr $lastpos+$n+1]
                                        }
                                }
-                               
-                               
+
+
                                puts [format "%-25s %s" $cmdname [string range $h $n [expr $next_a-1]] ]
                                set cmdname ""
                                set n [expr $next_a]
@@ -134,6 +134,23 @@ proc ocd_gdb_restart {target_id} {
        reset halt
 }
 
+
+# This reset logic may be overridden by board/target/... scripts as needed
+# to provide a reset that, if possible, is close to a power-up reset.
+#
+# Exit requirements include:  (a) JTAG must be working, (b) the scan
+# chain was validated with "jtag arp_init" (or equivalent), (c) nothing
+# stays in reset.  No TAP-specific scans were performed.  It's OK if
+# some targets haven't been reset yet; they may need TAP-specific scans.
+#
+# The "mode" values include:  halt, init, run (from "reset" command);
+# startup (at OpenOCD server startup, when JTAG may not yet work); and
+# potentially more (for reset types like cold, warm, etc)
+proc init_reset { mode } {
+       jtag arp_init-reset
+}
+
+
 global in_process_reset
 set in_process_reset 0
 
@@ -144,11 +161,11 @@ proc ocd_process_reset { MODE } {
                set in_process_reset 0
                return -code error "'reset' can not be invoked recursively"
        }
-       
+
        set in_process_reset 1
-       set success [expr [catch {ocd_process_reset_inner $MODE} result]==0] 
+       set success [expr [catch {ocd_process_reset_inner $MODE} result]==0]
        set in_process_reset 0
-       
+
        if {$success} {
                return $result
        } else {
@@ -189,10 +206,7 @@ proc ocd_process_reset_inner { MODE } {
 
        # Use TRST or TMS/TCK operations to reset all the tap controllers.
        # TAP reset events get reported; they might enable some taps.
-       #
-       # REVISIT arp_init-reset pulses SRST (if it can) with TRST active;
-       # but SRST events aren't reported (unlike "jtag arp_reset", below)
-       jtag arp_init-reset
+       init_reset $MODE
 
        # Examine all targets on enabled taps.
        foreach t $targets {
@@ -202,27 +216,32 @@ proc ocd_process_reset_inner { MODE } {
        }
 
        # Assert SRST, and report the pre/post events.
-       #
-       # REVISIT this presumes a single-target config, since SRST
-       # applies to the whole device-under-test.  When two targets
-       # both need special setup before SRST, it's only done for
-       # the first one...
+       # Note:  no target sees SRST before "pre" or after "post".
        foreach t $targets {
                $t invoke-event reset-assert-pre
+       }
+       foreach t $targets {
                # C code needs to know if we expect to 'halt'
                if {[jtag tapisenabled [$t cget -chain-position]]} {
                        $t arp_reset assert $halt
                }
+       }
+       foreach t $targets {
                $t invoke-event reset-assert-post
        }
 
        # Now de-assert SRST, and report the pre/post events.
+       # Note:  no target sees !SRST before "pre" or after "post".
        foreach t $targets {
                $t invoke-event reset-deassert-pre
-               # Again, de-assert code needs to know..
+       }
+       foreach t $targets {
+               # Again, de-assert code needs to know if we 'halt'
                if {[jtag tapisenabled [$t cget -chain-position]]} {
                        $t arp_reset deassert $halt
                }
+       }
+       foreach t $targets {
                $t invoke-event reset-deassert-post
        }
 
@@ -239,13 +258,13 @@ proc ocd_process_reset_inner { MODE } {
                        # the JTAG tap reset signal might be hooked to a slow
                        # resistor/capacitor circuit - and it might take a while
                        # to charge
-                       
+
                        # Catch, but ignore any errors.
                        catch { $t arp_waitstate halted 1000 }
-                       
+
                        # Did we succeed?
                        set s [$t curstate]
-                       
+
                        if { 0 != [string compare $s "halted" ] } {
                                return -error [format "TARGET: %s - Not halted" $t]
                        }
@@ -262,7 +281,7 @@ proc ocd_process_reset_inner { MODE } {
                        set err [catch "$t arp_waitstate halted 5000"]
                        # Did it halt?
                        if { $err == 0 } {
-                               $t invoke-event reset-init              
+                               $t invoke-event reset-init
                        }
                }
        }
@@ -294,13 +313,13 @@ add_help_text cpu "<name> - prints out target options and a comment on CPU which
 # A list of names of CPU and options required
 set ocd_cpu_list {
        {
-               name IXP42x 
-               options {xscale -variant IXP42x} 
+               name IXP42x
+               options {xscale -variant IXP42x}
                comment {IXP42x cpu}
        }
        {
-               name arm7 
-               options {arm7tdmi -variant arm7tdmi} 
+               name arm7
+               options {arm7tdmi -variant arm7tdmi}
                comment {vanilla ARM7}
        }
 }
@@ -312,7 +331,7 @@ proc ocd_cpu {args} {
        global ocd_cpu_list
        foreach a [lsort $ocd_cpu_list] {
                if {[string length $args]==0||[string first [string toupper $name] [string toupper "$a(name)$a(options)$a(comment)"]]!=-1} {
-                       lappend result $a 
+                       lappend result $a
                }
        }
        return $result
@@ -352,5 +371,15 @@ proc capture_catch {a} {
        catch {
                capture {uplevel $a}
        } result
-       return $result 
+       return $result
+}
+
+
+# Executed during "init". Can be overridden
+# by board/target/... scripts
+proc jtag_init {} {
+       if {[catch {jtag arp_init} err]!=0} {
+               # try resetting additionally
+               init_reset startup
+       }
 }