openocd: build: add SPDX tag
[fw/openocd] / src / target / startup.tcl
index d480f335dd0fbc09f7c6d1eff17bcd88378015e0..290e79d1eee3ab13a1f193f887114c813b313dd1 100644 (file)
@@ -1,20 +1,10 @@
-#########
+# SPDX-License-Identifier: GPL-2.0-or-later
 
-# 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
-}
+# Defines basic Tcl procs for OpenOCD target module
 
+proc new_target_name { } {
+       return [target number [expr {[target count] - 1}]]
+}
 
 global in_process_reset
 set in_process_reset 0
@@ -28,7 +18,7 @@ proc ocd_process_reset { MODE } {
        }
 
        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} {
@@ -42,18 +32,17 @@ proc ocd_process_reset_inner { MODE } {
        set targets [target names]
 
        # If this target must be halted...
-       set halt -1
-       if { 0 == [string compare $MODE halt] } {
-               set halt 1
-       }
-       if { 0 == [string compare $MODE init] } {
-               set halt 1;
-       }
-       if { 0 == [string compare $MODE run ] } {
-               set halt 0;
-       }
-       if { $halt < 0 } {
-               return -error "Invalid mode: $MODE, must be one of: halt, init, or run";
+       switch $MODE {
+               halt -
+               init {
+                       set halt 1
+               }
+               run {
+                       set halt 0
+               }
+               default {
+                       return -code error "Invalid mode: $MODE, must be one of: halt, init, or run";
+               }
        }
 
        # Target event handlers *might* change which TAPs are enabled
@@ -75,8 +64,14 @@ proc ocd_process_reset_inner { MODE } {
 
        # Examine all targets on enabled taps.
        foreach t $targets {
-               if {[jtag tapisenabled [$t cget -chain-position]]} {
-                       $t arp_examine
+               if {![using_jtag] || [jtag tapisenabled [$t cget -chain-position]]} {
+                       $t invoke-event examine-start
+                       set err [catch "$t arp_examine allow-defer"]
+                       if { $err } {
+                               $t invoke-event examine-fail
+                       } else {
+                               $t invoke-event examine-end
+                       }
                }
        }
 
@@ -87,7 +82,7 @@ proc ocd_process_reset_inner { MODE } {
        }
        foreach t $targets {
                # C code needs to know if we expect to 'halt'
-               if {[jtag tapisenabled [$t cget -chain-position]]} {
+               if {![using_jtag] || [jtag tapisenabled [$t cget -chain-position]]} {
                        $t arp_reset assert $halt
                }
        }
@@ -102,7 +97,7 @@ proc ocd_process_reset_inner { MODE } {
        }
        foreach t $targets {
                # Again, de-assert code needs to know if we 'halt'
-               if {[jtag tapisenabled [$t cget -chain-position]]} {
+               if {![using_jtag] || [jtag tapisenabled [$t cget -chain-position]]} {
                        $t arp_reset deassert $halt
                }
        }
@@ -115,11 +110,17 @@ proc ocd_process_reset_inner { MODE } {
        # first executing any instructions.
        if { $halt } {
                foreach t $targets {
-                       if {[jtag tapisenabled [$t cget -chain-position]] == 0} {
+                       if {[using_jtag] && ![jtag tapisenabled [$t cget -chain-position]]} {
+                               continue
+                       }
+
+                       # don't wait for targets where examination is deferred
+                       # they can not be halted anyway at this point
+                       if { ![$t was_examined] && [$t examine_deferred] } {
                                continue
                        }
 
-                       # Wait upto 1 second for target to halt.  Why 1sec? Cause
+                       # Wait up to 1 second for target to halt. Why 1sec? Cause
                        # the JTAG tap reset signal might be hooked to a slow
                        # resistor/capacitor circuit - and it might take a while
                        # to charge
@@ -130,16 +131,22 @@ proc ocd_process_reset_inner { MODE } {
                        # Did we succeed?
                        set s [$t curstate]
 
-                       if { 0 != [string compare $s "halted" ] } {
-                               return -error [format "TARGET: %s - Not halted" $t]
+                       if { $s != "halted" } {
+                               return -code error [format "TARGET: %s - Not halted" $t]
                        }
                }
        }
 
        #Pass 2 - if needed "init"
-       if { 0 == [string compare init $MODE] } {
+       if { $MODE == "init" } {
                foreach t $targets {
-                       if {[jtag tapisenabled [$t cget -chain-position]] == 0} {
+                       if {[using_jtag] && ![jtag tapisenabled [$t cget -chain-position]]} {
+                               continue
+                       }
+
+                       # don't wait for targets where examination is deferred
+                       # they can not be halted anyway at this point
+                       if { ![$t was_examined] && [$t examine_deferred] } {
                                continue
                        }
 
@@ -156,10 +163,110 @@ proc ocd_process_reset_inner { MODE } {
        }
 }
 
+proc using_jtag {} {
+       set _TRANSPORT [ transport select ]
+       expr { [ string first "jtag" $_TRANSPORT ] != -1 }
+}
+
+proc using_swd {} {
+       set _TRANSPORT [ transport select ]
+       expr { [ string first "swd" $_TRANSPORT ] != -1 }
+}
+
+proc using_hla {} {
+       set _TRANSPORT [ transport select ]
+       expr { [ string first "hla" $_TRANSPORT ] != -1 }
+}
+
 #########
 
-# Temporary migration aid.  May be removed starting in January 2011.
-proc armv4_5 params {
-       echo "DEPRECATED! use 'arm $params' not 'armv4_5 $params'"
-       arm $params
+# Target/chain configuration scripts can either execute commands directly
+# or define a procedure which is executed once all configuration
+# scripts have completed.
+#
+# By default(classic) the config scripts will set up the target configuration
+proc init_targets {} {
+}
+
+proc set_default_target_event {t e s} {
+       if {[$t cget -event $e] == ""} {
+               $t configure -event $e $s
+       }
+}
+
+proc init_target_events {} {
+       set targets [target names]
+
+       foreach t $targets {
+               set_default_target_event $t gdb-flash-erase-start "reset init"
+               set_default_target_event $t gdb-flash-write-end "reset halt"
+               set_default_target_event $t gdb-attach "halt 1000"
+       }
+}
+
+# Additionally board config scripts can define a procedure init_board that will be executed after init and init_targets
+proc init_board {} {
+}
+
+proc mem2array {arrayname bitwidth address count {phys ""}} {
+       echo "DEPRECATED! use 'read_memory' not 'mem2array'"
+
+       upvar $arrayname $arrayname
+       set $arrayname ""
+       set i 0
+
+       foreach elem [read_memory $address $bitwidth $count {*}$phys] {
+               set ${arrayname}($i) $elem
+               incr i
+       }
+}
+
+proc array2mem {arrayname bitwidth address count {phys ""}} {
+       echo "DEPRECATED! use 'write_memory' not 'array2mem'"
+
+       upvar $arrayname $arrayname
+       set data ""
+
+       for {set i 0} {$i < $count} {incr i} {
+               lappend data [expr $${arrayname}($i)]
+       }
+
+       write_memory $address $bitwidth $data {*}$phys
+}
+
+# smp_on/smp_off were already DEPRECATED in v0.11.0 through http://openocd.zylin.com/4615
+lappend _telnet_autocomplete_skip "aarch64 smp_on"
+proc "aarch64 smp_on" {args} {
+       echo "DEPRECATED! use 'aarch64 smp on' not 'aarch64 smp_on'"
+       eval aarch64 smp on $args
+}
+
+lappend _telnet_autocomplete_skip "aarch64 smp_off"
+proc "aarch64 smp_off" {args} {
+       echo "DEPRECATED! use 'aarch64 smp off' not 'aarch64 smp_off'"
+       eval aarch64 smp off $args
+}
+
+lappend _telnet_autocomplete_skip "cortex_a smp_on"
+proc "cortex_a smp_on" {args} {
+       echo "DEPRECATED! use 'cortex_a smp on' not 'cortex_a smp_on'"
+       eval cortex_a smp on $args
+}
+
+lappend _telnet_autocomplete_skip "cortex_a smp_off"
+proc "cortex_a smp_off" {args} {
+       echo "DEPRECATED! use 'cortex_a smp off' not 'cortex_a smp_off'"
+       eval cortex_a smp off $args
+}
+
+lappend _telnet_autocomplete_skip "mips_m4k smp_on"
+proc "mips_m4k smp_on" {args} {
+       echo "DEPRECATED! use 'mips_m4k smp on' not 'mips_m4k smp_on'"
+       eval mips_m4k smp on $args
+}
+
+lappend _telnet_autocomplete_skip "mips_m4k smp_off"
+proc "mips_m4k smp_off" {args} {
+       echo "DEPRECATED! use 'mips_m4k smp off' not 'mips_m4k smp_off'"
+       eval mips_m4k smp off $args
 }