ed905e9424af034f6c9c7300f994eb50dbb88b57
[openocd.git] / src / flash / startup.tcl
1 # Defines basic Tcl procs for OpenOCD flash module
2
3 #
4 # program utility proc
5 # usage: program filename
6 # optional args: verify, reset, exit and address
7 #
8
9 proc program_error {description exit} {
10 if {$exit == 1} {
11 echo $description
12 shutdown error
13 }
14
15 error $description
16 }
17
18 proc program {filename args} {
19 set exit 0
20
21 foreach arg $args {
22 if {[string equal $arg "verify"]} {
23 set verify 1
24 } elseif {[string equal $arg "reset"]} {
25 set reset 1
26 } elseif {[string equal $arg "exit"]} {
27 set exit 1
28 } else {
29 set address $arg
30 }
31 }
32
33 # make sure init is called
34 if {[catch {init}] != 0} {
35 program_error "** OpenOCD init failed **" 1
36 }
37
38 # reset target and call any init scripts
39 if {[catch {reset init}] != 0} {
40 program_error "** Unable to reset target **" $exit
41 }
42
43 # start programming phase
44 echo "** Programming Started **"
45 if {[info exists address]} {
46 set flash_args "$filename $address"
47 } else {
48 set flash_args "$filename"
49 }
50
51 if {[catch {eval flash write_image erase $flash_args}] == 0} {
52 echo "** Programming Finished **"
53 if {[info exists verify]} {
54 # verify phase
55 echo "** Verify Started **"
56 if {[catch {eval verify_image $flash_args}] == 0} {
57 echo "** Verified OK **"
58 } else {
59 program_error "** Verify Failed **" $exit
60 }
61 }
62
63 if {[info exists reset]} {
64 # reset target if requested
65 if {$exit == 1} {
66 # also disable target polling, we are shutting down anyway
67 poll off
68 }
69 echo "** Resetting Target **"
70 reset run
71 }
72 } else {
73 program_error "** Programming Failed **" $exit
74 }
75
76 if {$exit == 1} {
77 shutdown
78 }
79 return
80 }
81
82 add_help_text program "write an image to flash, address is only required for binary images. verify, reset, exit are optional"
83 add_usage_text program "<filename> \[address\] \[verify\] \[reset\] \[exit\]"
84
85 # stm32f0x uses the same flash driver as the stm32f1x
86 # this alias enables the use of either name.
87 proc stm32f0x args {
88 eval stm32f1x $args
89 }
90
91 # stm32f3x uses the same flash driver as the stm32f1x
92 # this alias enables the use of either name.
93 proc stm32f3x args {
94 eval stm32f1x $args
95 }
96
97 # stm32f4x uses the same flash driver as the stm32f2x
98 # this alias enables the use of either name.
99 proc stm32f4x args {
100 eval stm32f2x $args
101 }
102
103 # ease migration to updated flash driver
104 proc stm32x args {
105 echo "DEPRECATED! use 'stm32f1x $args' not 'stm32x $args'"
106 eval stm32f1x $args
107 }
108
109 proc stm32f2xxx args {
110 echo "DEPRECATED! use 'stm32f2x $args' not 'stm32f2xxx $args'"
111 eval stm32f2x $args
112 }