src/startup.tcl

   1 #
   2 # Defines basic Tcl procs that must be there for
   3 # OpenOCD to work.
   4 #
   5 # Embedded into OpenOCD executable
   6 #
   7
   8
   9 # Help text list. A list of command + help text pairs.
  10 #
  11 # Commands can be more than one word and they are stored
  12 # as "flash banks" "help text x x x"
  13
  14 proc add_help_text {cmd cmd_help} {
  15         global ocd_helptext
  16         lappend ocd_helptext [list $cmd $cmd_help]
  17 }
  18
  19 proc get_help_text {} {
  20         global ocd_helptext
  21         return $ocd_helptext
  22 }
  23
  24 # Production command
  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} {
  28         openocd "reset init"
  29         openocd "flash write_image erase $filename [flash] bin"]]
  30         openocd "verify_image $filename [flash] bin"]]
  31         echo "Successfully ran production procedure"
  32 }
  33
  34 proc board_test {} {
  35         echo "Production test not implemented"
  36 }
  37
  38 # Show flash in human readable form
  39 # This is an example of a human readable form of a low level fn
  40 proc flash_banks {} {
  41         set i 0
  42         set result ""
  43         foreach {a} [openocd_flash_banks] {
  44                 if {$i > 0} {
  45                         set result "$result\n"
  46                 }
  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)]
  48                 set i [expr $i+1]
  49         }
  50         return $result
  51 }
  52
  53 # We need to explicitly redirect this to the OpenOCD command
  54 # as Tcl defines the exit proc
  55 proc exit {} {
  56         openocd_throw exit
  57 }
  58
  59 #Print help text for a command. Word wrap
  60 #help text that is too wide inside column.
  61 proc help {args} {
  62         global ocd_helptext
  63         set cmd $args
  64         foreach a [lsort $ocd_helptext] {
  65                 if {[string length $cmd]==0||[string first $cmd $a]!=-1||[string first $cmd [lindex $a 1]]!=-1} {
  66                         set w 50
  67                         set cmdname [lindex $a 0]
  68                         set h [lindex $a 1]
  69                         set n 0
  70                         while 1 {
  71                                 if {$n > [string length $h]} {break}
  72
  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]} {
  77                                         }
  78                                         #set next_a -1
  79                                         if {$lastpos!=-1} {
  80                                                 set next_a [expr $lastpos+$n+1]
  81                                         }
  82                                 }
  83
  84
  85                                 puts [format "%-25s %s" $cmdname [string range $h $n [expr $next_a-1]] ]
  86                                 set cmdname ""
  87                                 set n [expr $next_a]
  88                         }
  89                 }
  90         }
  91 }
  92
  93 add_help_text help "Tcl implementation of help command"
  94
  95
  96 #a bit of backwards compatibility
  97 proc openocd_throw {cmd} {
  98         return [eval $cmd]
  99 }
 100
 101 #a bit of backwards compatibility
 102 proc openocd {cmd} {
 103         return [eval $cmd]
 104 }
 105
 106 # If a fn is unknown to Tcl, we try to execute it as an OpenOCD command
 107 #
 108 # We also support two level commands. "flash banks" is translated to
 109 # flash_banks
 110 proc unknown {args} {
 111         # do the name mangling from "flash banks" to "flash_banks"
 112         if {[llength $args]>=2} {
 113                 set cmd_name "[lindex $args 0]_[lindex $args 1]"
 114                 # Fix?? add a check here if this is a command?
 115                 # we'll strip away args until we fail anyway...
 116                 return [eval "$cmd_name [lrange $args 2 end]"]
 117         }
 118         # This really is an unknown command.
 119         puts "Unknown command: $args"
 120 }
 121
 122
 123 proc target_script {target_num eventname scriptname} {
 124         if {[string compare $eventname reset]==0} {
 125                 set eventname post_reset
 126         }
 127
 128         # This is the script we invoke
 129         proc "target_[set eventname]_[set target_num]" {} "script $scriptname"
 130
 131 }
 132
 133 # Try flipping / and \ to find file if the filename does not
 134 # match the precise spelling
 135 proc find {filename} {
 136         if {[catch {openocd_find $filename} t]==0} {
 137                 return $t
 138         }
 139         if {[catch {openocd_find [string map {\ /} $filename} t]==0} {
 140                 return $t
 141         }
 142         if {[catch {openocd_find [string map {/ \\} $filename} t]==0} {
 143                 return $t
 144         }
 145         # make sure error message matches original input string
 146         return [openocd_find $filename]
 147 }
 148 add_help_text find "<file> - print full path to file according to OpenOCD search rules"
 149
 150 # Run script
 151 proc script {filename} {
 152         source [find $filename]
 153 }
 154
 155 add_help_text script "<filename> - filename of OpenOCD script (tcl) to run"
 156
 157 add_help_text target_script "<target#> <event=reset/pre_reset/post_halt/pre_resume/gdb_program_config> <script_file>"
 158