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 # FIX!!! need to figure out how to feed back relevant output
26 # from e.g. "flash banks" command...
27 proc board_produce {filename serialnumber} {
29 openocd "flash write_image erase $filename [flash] bin"]]
30 openocd "verify_image $filename [flash] bin"]]
31 echo "Successfully ran production procedure"
35 echo "Production test not implemented"
38 # Show flash in human readable form
39 # This is an example of a human readable form of a low level fn
43 foreach {a} [openocd_flash_banks] {
45 set result "$result\n"
47 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)]
53 # We need to explicitly redirect this to the OpenOCD command
54 # as Tcl defines the exit proc
59 #Print help text for a command. Word wrap
60 #help text that is too wide inside column.
64 foreach a [lsort $ocd_helptext] {
65 if {[string length $cmd]==0||[string first $cmd $a]!=-1||[string first $cmd [lindex $a 1]]!=-1} {
67 set cmdname [lindex $a 0]
71 if {$n > [string length $h]} {break}
73 set next_a [expr $n+$w]
74 if {[string length $h]>$n+$w} {
75 set xxxx [string range $h $n [expr $n+$w]]
76 for {set lastpos [expr [string length $xxxx]-1]} {$lastpos>=0&&[string compare [string range $xxxx $lastpos $lastpos] " "]!=0} {set lastpos [expr $lastpos-1]} {
80 set next_a [expr $lastpos+$n+1]
85 puts [format "%-25s %s" $cmdname [string range $h $n [expr $next_a-1]] ]
93 add_help_text help "Tcl implementation of help command"
96 #a bit of backwards compatibility
97 proc openocd_throw {cmd} {
100 return $openocd_output
103 #a bit of backwards compatibility
105 set openocd_output ""
107 return $openocd_output
110 # If a fn is unknown to Tcl, we try to execute it as an OpenOCD command
112 # We also support two level commands. "flash banks" is translated to
114 proc unknown {args} {
115 # do the name mangling from "flash banks" to "flash_banks"
116 if {[llength $args]>=2} {
117 set cmd_name "[lindex $args 0]_[lindex $args 1]"
118 # Fix?? add a check here if this is a command?
119 # we'll strip away args until we fail anyway...
120 return [eval "$cmd_name [lrange $args 2 end]"]
122 # This really is an unknown command.
123 puts "Unknown command: $args"
127 proc target_script {target_num eventname scriptname} {
128 if {[string compare $eventname reset]==0} {
129 set eventname post_reset
132 # This is the script we invoke
133 proc "target_[set eventname]_[set target_num]" {} "script $scriptname"
137 # Try flipping / and \ to find file if the filename does not
138 # match the precise spelling
139 proc find {filename} {
140 if {[catch {openocd_find $filename} t]==0} {
143 if {[catch {openocd_find [string map {\ /} $filename} t]==0} {
146 if {[catch {openocd_find [string map {/ \\} $filename} t]==0} {
149 # make sure error message matches original input string
150 return [openocd_find $filename]
152 add_help_text find "<file> - print full path to file according to OpenOCD search rules"
155 proc script {filename} {
156 source [find $filename]
159 add_help_text script "<filename> - filename of OpenOCD script (tcl) to run"
161 add_help_text target_script "<target#> <event=reset/pre_reset/post_halt/pre_resume/gdb_program_config> <script_file>"