openocd: build: add SPDX tag

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

diff --git a/src/flash/startup.tcl b/src/flash/startup.tcl
index 2c335d9f7b1e0a73dc915bb86873244f841c5448..654f201a4e0b057a71b242eb5224994de05f50be 100644 (file)
--- a/src/flash/startup.tcl
+++ b/src/flash/startup.tcl
@@ -1,16 +1,128 @@
+# SPDX-License-Identifier: GPL-2.0-or-later
+
 # Defines basic Tcl procs for OpenOCD flash module
 
-# Show flash in human readable form
-# This is an example of a human readable form of a low level fn
-proc flash_banks {} {
-       set i 0
-       set result ""
-       foreach {a} [ocd_flash banks] {
-               if {$i > 0} {
-                       set result "$result\n"
+#
+# program utility proc
+# usage: program filename
+# optional args: verify, reset, exit and address
+#
+
+lappend _telnet_autocomplete_skip program_error
+proc program_error {description exit} {
+       if {$exit == 1} {
+               echo $description
+               shutdown error
+       }
+
+       error $description
+}
+
+proc program {filename args} {
+       set exit 0
+       set needsflash 1
+
+       foreach arg $args {
+               if {[string equal $arg "preverify"]} {
+                       set preverify 1
+               } elseif {[string equal $arg "verify"]} {
+                       set verify 1
+               } elseif {[string equal $arg "reset"]} {
+                       set reset 1
+               } elseif {[string equal $arg "exit"]} {
+                       set exit 1
+               } else {
+                       set address $arg
+               }
+       }
+
+       # Set variables
+       set filename \{$filename\}
+       if {[info exists address]} {
+               set flash_args "$filename $address"
+       } else {
+               set flash_args "$filename"
+       }
+
+
+       # make sure init is called
+       if {[catch {init}] != 0} {
+               program_error "** OpenOCD init failed **" 1
+       }
+
+       # reset target and call any init scripts
+       if {[catch {reset init}] != 0} {
+               program_error "** Unable to reset target **" $exit
+       }
+
+       # Check whether programming is needed
+       if {[info exists preverify]} {
+               echo "**pre-verifying**"
+               if {[catch {eval verify_image $flash_args}] == 0} {
+                       echo "**Verified OK - No flashing**"
+                       set needsflash 0
                }
-               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)]
-               set i [expr $i+1]
        }
-       return $result
+
+       # start programming phase
+       if {$needsflash == 1} {
+               echo "** Programming Started **"
+
+               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 {
+                                       program_error "** Verify Failed **" $exit
+                               }
+                       }
+               } else {
+                       program_error "** Programming Failed **" $exit
+               }
+       }
+
+       if {[info exists reset]} {
+               # reset target if requested
+               if {$exit == 1} {
+                       # also disable target polling, we are shutting down anyway
+                       poll off
+               }
+               echo "** Resetting Target **"
+               reset run
+       }
+
+
+       if {$exit == 1} {
+               shutdown
+       }
+       return
 }
+
+add_help_text program "write an image to flash, address is only required for binary images. verify, reset, exit are optional"
+add_usage_text program "<filename> \[address\] \[pre-verify\] \[verify\] \[reset\] \[exit\]"
+
+# stm32[f0x|f3x] uses the same flash driver as the stm32f1x
+proc stm32f0x args { eval stm32f1x $args }
+proc stm32f3x args { eval stm32f1x $args }
+
+# stm32[f4x|f7x] uses the same flash driver as the stm32f2x
+proc stm32f4x args { eval stm32f2x $args }
+proc stm32f7x args { eval stm32f2x $args }
+
+# stm32lx driver supports both STM32 L0 and L1 devices
+proc stm32l0x args { eval stm32lx $args }
+proc stm32l1x args { eval stm32lx $args }
+
+# stm32[g0|g4|l5|u5|wb|wl] uses the same flash driver as the stm32l4x
+proc stm32g0x args { eval stm32l4x $args }
+proc stm32g4x args { eval stm32l4x $args }
+proc stm32l5x args { eval stm32l4x $args }
+proc stm32u5x args { eval stm32l4x $args }
+proc stm32wbx args { eval stm32l4x $args }
+proc stm32wlx args { eval stm32l4x $args }
+
+# gd32e23x uses the same flash driver as the stm32f1x
+proc gd32e23x args { eval stm32f1x $args }