Revert "target: remove unused working area 'user' field"
[fw/openocd] / src / target / startup.tcl
index d480f335dd0fbc09f7c6d1eff17bcd88378015e0..90f947dfd7e344024f8611735364a854fe85d60a 100644 (file)
@@ -1,21 +1,9 @@
-#########
+# Defines basic Tcl procs for OpenOCD target module
 
-# 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
+proc new_target_name { } {
+       return [target number [expr [target count] - 1 ]]
 }
 
-
 global in_process_reset
 set in_process_reset 0
 
@@ -53,7 +41,7 @@ proc ocd_process_reset_inner { MODE } {
                set halt 0;
        }
        if { $halt < 0 } {
-               return -error "Invalid mode: $MODE, must be one of: halt, init, or run";
+               return -code error "Invalid mode: $MODE, must be one of: halt, init, or run";
        }
 
        # Target event handlers *might* change which TAPs are enabled
@@ -76,7 +64,11 @@ 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
+                       $t invoke-event examine-start
+                       set err [catch "$t arp_examine"]
+                       if { $err == 0 } {
+                               $t invoke-event examine-end
+                       }
                }
        }
 
@@ -131,7 +123,7 @@ proc ocd_process_reset_inner { MODE } {
                        set s [$t curstate]
 
                        if { 0 != [string compare $s "halted" ] } {
-                               return -error [format "TARGET: %s - Not halted" $t]
+                               return -code error [format "TARGET: %s - Not halted" $t]
                        }
                }
        }
@@ -163,3 +155,15 @@ 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 {} {
+}
+
+# Additionally board config scripts can define a procedure init_board that will be executed after init and init_targets
+proc init_board {} {
+}