tcl: add flash programming helper

[openocd.git] / src / flash / startup.tcl

diff --git a/src/flash/startup.tcl b/src/flash/startup.tcl
index 5f40e64912a2515bed7a43403b2c3f60dcf63be9..82959c8a136b418890f3ddbb3cc94eee3d723e71 100644 (file)
--- a/src/flash/startup.tcl
+++ b/src/flash/startup.tcl
@@ -1,5 +1,73 @@
 # Defines basic Tcl procs for OpenOCD flash module
 
 # Defines basic Tcl procs for OpenOCD flash module
 

+#
+# program utility proc
+# usage: program filename
+# optional args: verify, reset and address
+#
+
+proc program {filename args} {
+
+       foreach arg $args {
+               if {[string equal $arg "verify"]} {
+                       set verify 1
+               } elseif {[string equal $arg "reset"]} {
+                       set reset 1
+               } else {
+                       set address $arg
+               }
+       }
+
+       # make sure init is called
+       if {[catch {init}] != 0} {
+               echo "** OpenOCD init Failed **"
+               shutdown
+               return
+       }
+
+       # reset target and call any init scripts
+       if {[catch {reset init}] != 0} {
+               echo "** Unable to reset target **"
+               shutdown
+               return
+       }
+
+       # start programming phase
+       echo "** Programming Started **"
+       if {[info exists address]} {
+               set flash_args "$filename $address"
+       } else {
+               set flash_args "$filename"
+       }
+
+       if {[catch {eval flash write_image erase $flash_args}] == 0} {
+               echo "** Programming Finished **"
+               if {[info exists verify]} {
+                       # verify phase
+                       echo "** Verify Started **"
+                       if {[catch {eval verify_image $flash_args}] == 0} {
+                               echo "** Verified OK **"
+                       } else {
+                               echo "** Verify Failed **"
+                       }
+               }
+
+               if {[info exists reset]} {
+                       # reset target if requested
+                       echo "** Resetting Target **"
+                       reset run
+               }
+       } else {
+               echo "** Programming Failed **"
+       }
+
+       # shutdown OpenOCD
+       shutdown
+}
+
+add_help_text program "write an image to flash, address is only required for binary images. verify, reset are optional"
+add_usage_text program "<filename> \[address\] \[verify\] \[reset\]"
+

 # ease migration to updated flash driver
 proc stm32x args {
        echo "DEPRECATED! use 'stm32f1x $args' not 'stm32x $args'"
 # ease migration to updated flash driver
 proc stm32x args {
        echo "DEPRECATED! use 'stm32f1x $args' not 'stm32x $args'"


@@ -10,4 +78,3 @@ proc stm32f2xxx args {
        echo "DEPRECATED! use 'stm32f2x $args' not 'stm32f2xxx $args'"
        eval stm32f2x $args
 }
        echo "DEPRECATED! use 'stm32f2x $args' not 'stm32f2xxx $args'"
        eval stm32f2x $args
 }

-