c49c43e1b46d74451f85a8fe3b4885d8c9d86941
[openocd.git] / src / jtag / startup.tcl
1 # Defines basic Tcl procs for OpenOCD JTAG module
2
3 # Executed during "init". Can be overridden
4 # by board/target/... scripts
5 proc jtag_init {} {
6 if {[catch {jtag arp_init} err]!=0} {
7 # try resetting additionally
8 init_reset startup
9 }
10 }
11
12 # This reset logic may be overridden by board/target/... scripts as needed
13 # to provide a reset that, if possible, is close to a power-up reset.
14 #
15 # Exit requirements include: (a) JTAG must be working, (b) the scan
16 # chain was validated with "jtag arp_init" (or equivalent), (c) nothing
17 # stays in reset. No TAP-specific scans were performed. It's OK if
18 # some targets haven't been reset yet; they may need TAP-specific scans.
19 #
20 # The "mode" values include: halt, init, run (from "reset" command);
21 # startup (at OpenOCD server startup, when JTAG may not yet work); and
22 # potentially more (for reset types like cold, warm, etc)
23 proc init_reset { mode } {
24 jtag arp_init-reset
25 }
26
27 #########
28
29 # TODO: power_restore and power_dropout are currently neither
30 # documented nor supported except on ZY1000.
31
32 proc power_restore {} {
33 puts "Sensed power restore, running reset init and halting GDB."
34 reset init
35
36 # Halt GDB so user can deal with a detected power restore.
37 #
38 # After GDB is halted, then output is no longer forwarded
39 # to the GDB console.
40 set targets [target names]
41 foreach t $targets {
42 # New event script.
43 $t invoke-event arp_halt_gdb
44 }
45 }
46
47 add_help_text power_restore "Overridable procedure run when power restore is detected. Runs 'reset init' by default."
48
49 proc power_dropout {} {
50 puts "Sensed power dropout."
51 }
52
53 #########
54
55 # TODO: srst_deasserted and srst_asserted are currently neither
56 # documented nor supported except on ZY1000.
57
58 proc srst_deasserted {} {
59 puts "Sensed nSRST deasserted, running reset init and halting GDB."
60 reset init
61
62 # Halt GDB so user can deal with a detected reset.
63 #
64 # After GDB is halted, then output is no longer forwarded
65 # to the GDB console.
66 set targets [target names]
67 foreach t $targets {
68 # New event script.
69 $t invoke-event arp_halt_gdb
70 }
71 }
72
73 add_help_text srst_deasserted "Overridable procedure run when srst deassert is detected. Runs 'reset init' by default."
74
75 proc srst_asserted {} {
76 puts "Sensed nSRST asserted."
77 }
78
79 # BEGIN MIGRATION AIDS ... these adapter operations originally had
80 # JTAG-specific names despite the fact that the operations were not
81 # specific to JTAG.
82 #
83 # FIXME phase these aids out after about April 2011
84 #
85 proc jtag_khz args { eval adapter_khz $args }
86 # END MIGRATION AIDS