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"
17 proc add_help_text {cmd cmd_help} {
19 lappend ocd_helptext [list $cmd $cmd_help]
23 # FIX!!! need to figure out how to feed back relevant output
24 # from e.g. "flash banks" command...
25 proc board_produce {filename serialnumber} {
27 openocd "flash write_image erase $filename [flash] bin"]]
28 openocd "verify_image $filename [flash] bin"]]
29 echo "Successfully ran production procedure"
33 echo "Production test not implemented"
36 # Show flash in human readable form
37 # This is an example of a human readable form of a low level fn
38 proc flash_banks_pretty {} {
41 foreach {a} [flash_banks] {
43 set result "$result\n"
45 set result [format "$result#%d: %s at 0x%08x, size 0x%08x, buswidth %d, chipwidth %d" $i [lindex $a 0] [lindex $a 1] [lindex $a 2] [lindex $a 3] [lindex $a 4]]
51 # We need to explicitly redirect this to the OpenOCD command
52 # as Tcl defines the exit proc
57 # We have currently converted only "flash banks" to tcl.
59 if {[string compare [lindex $args 0] banks]==0} {
60 return [flash_banks_pretty]
62 openocd_throw "flash $args"
65 #Print help text for a command. Word wrap
66 #help text that is too wide inside column.
67 proc tcl_help {args} {
70 foreach a [lsort $ocd_helptext] {
71 if {[string length $cmd]==0||[string first $cmd $a]!=-1} {
73 set cmdname [lindex $a 0]
77 if {$n > [string length $h]} {break}
79 set next_a [expr $n+$w]
80 if {[string length $h]>$n+$w} {
81 set xxxx [string range $h $n [expr $n+$w]]
82 for {set lastpos [expr [string length $xxxx]-1]} {$lastpos>=0&&[string compare [string range $xxxx $lastpos $lastpos] " "]!=0} {set lastpos [expr $lastpos-1]} {
86 set next_a [expr $lastpos+$n+1]
91 puts [format "%-25s %s" $cmdname [string range $h $n [expr $next_a-1]] ]
99 add_help_text tcl_help "Tcl implementation of help command"
102 # If a fn is unknown to Tcl, we try to execute it as an OpenOCD command
103 proc unknown {args} {
104 if {[string length $args]>0} {
106 # We need to add back quotes for arguments w/space
107 # for args without space, we can add quotes anyway
109 set cmd "$cmd \"$a\""
113 # openocd_throw outputs while running and also sets the
114 # primary return value to the output of the command
116 # The primary return value have been set by "openocd" above,
117 # so we need to clear it, lest we print out the output from