Fast MSP430 Flash writes.
[goodfet] / client / goodfet.bsl
1 #!/usr/bin/env python
2 # Serial Bootstrap Loader software for the MSP430 embedded proccessor.
3 #
4 # (C) 2001-2003 Chris Liechti <cliechti@gmx.net>
5 # this is distributed under a free software license, see license-bsl.txt
6 #
7 # fixes from Colin Domoney
8 #
9 # based on the application note slas96b.pdf from Texas Instruments, Inc.,
10 # Volker Rzehak
11 # additional infos from slaa089a.pdf
12
13 # Forked by Travis Goodspeed <travis at tnbelt.com> for use with the GoodFET
14 # JTAG programmer.
15
16 import sys, time, string, cStringIO, struct
17 sys.path.append("/usr/lib/tinyos")
18 import serial, os, glob
19
20 #forked from TinyOS Telos version.
21 VERSION = string.split("Revision: 1.39-goodfet-8 ")[1] 
22
23 DEBUG = 0                                       #disable debug messages by default
24
25 #copy of the patch file provided by TI
26 #this part is (C) by Texas Instruments
27 PATCH = """@0220
28 31 40 1A 02 09 43 B0 12 2A 0E B0 12 BA 0D 55 42
29 0B 02 75 90 12 00 1F 24 B0 12 BA 02 55 42 0B 02
30 75 90 16 00 16 24 75 90 14 00 11 24 B0 12 84 0E
31 06 3C B0 12 94 0E 03 3C 21 53 B0 12 8C 0E B2 40
32 10 A5 2C 01 B2 40 00 A5 28 01 30 40 42 0C 30 40
33 76 0D 30 40 AC 0C 16 42 0E 02 17 42 10 02 E2 B2
34 08 02 14 24 B0 12 10 0F 36 90 00 10 06 28 B2 40
35 00 A5 2C 01 B2 40 40 A5 28 01 D6 42 06 02 00 00
36 16 53 17 83 EF 23 B0 12 BA 02 D3 3F B0 12 10 0F
37 17 83 FC 23 B0 12 BA 02 D0 3F 18 42 12 02 B0 12
38 10 0F D2 42 06 02 12 02 B0 12 10 0F D2 42 06 02
39 13 02 38 E3 18 92 12 02 BF 23 E2 B3 08 02 BC 23
40 30 41
41 q
42 """
43
44 #These BSL's are (C) by TI. They come with the application note slaa089a
45 F1X_BSL = """@0220
46 24 02 2E 02 31 40 20 02 2B D2 C0 43 EA FF 32 C2
47 F2 C0 32 00 00 00 B2 40 80 5A 20 01 F2 40 85 00
48 57 00 F2 40 80 00 56 00 E2 D3 21 00 E2 D3 22 00
49 E2 C3 26 00 E2 C2 2A 00 E2 C2 2E 00 B2 40 10 A5
50 2C 01 B2 40 00 A5 28 01 3B C0 3A 00 B0 12 D6 04
51 82 43 12 02 09 43 36 40 0A 02 37 42 B0 12 AC 05
52 C6 4C 00 00 16 53 17 83 F9 23 D2 92 0C 02 0D 02
53 28 20 55 42 0B 02 75 90 12 00 80 24 75 90 10 00
54 6D 24 B0 12 9C 04 55 42 0B 02 75 90 18 00 31 24
55 75 90 1E 00 B8 24 75 90 20 00 17 24 2B B2 11 24
56 75 90 16 00 22 24 75 90 14 00 B3 24 75 90 1A 00
57 18 24 75 90 1C 00 45 24 04 3C B0 12 36 05 BE 3F
58 21 53 B0 12 3C 05 BA 3F 03 43 B0 12 36 05 D2 42
59 0E 02 56 00 D2 42 0F 02 57 00 D2 42 10 02 16 02
60 AD 3F B0 12 36 05 10 42 0E 02 16 42 0E 02 15 43
61 07 3C 36 40 FE FF B2 40 06 A5 10 02 35 40 0C 00
62 B2 40 00 A5 2C 01 92 42 10 02 28 01 B6 43 00 00
63 92 B3 2C 01 FD 23 15 83 F3 23 36 90 FE FF CD 27
64 37 40 80 00 36 F0 80 FF 36 90 00 11 0E 28 07 57
65 36 F0 00 FF 36 90 00 12 08 28 07 57 36 F0 00 FE
66 04 3C 16 42 0E 02 17 42 10 02 35 43 75 96 03 20
67 17 83 FC 23 B2 3F 82 46 00 02 B3 3F 36 40 E0 FF
68 37 40 20 00 B0 12 AC 05 7C 96 01 24 2B D3 17 83
69 F9 23 2B C2 B0 12 9C 04 2B D2 9F 3F 16 42 0E 02
70 17 42 10 02 2B B2 38 24 3B D0 10 00 B0 12 AC 05
71 36 90 00 10 06 2C 36 90 00 01 09 2C C6 4C 00 00
72 25 3C B2 40 00 A5 2C 01 B2 40 40 A5 28 01 16 B3
73 03 20 C2 4C 14 02 1A 3C C2 4C 15 02 86 9A FD FF
74 08 24 2B D3 3B B0 20 00 04 20 3B D0 20 00 82 46
75 00 02 36 90 01 02 04 28 3B D2 3B B0 10 00 02 24
76 3B C0 32 00 1A 42 14 02 86 4A FF FF 16 53 17 83
77 CD 23 B0 12 9C 04 61 3F B0 12 AC 05 17 83 FC 23
78 B0 12 9C 04 5E 3F B2 40 F0 0F 0E 02 B2 40 10 00
79 10 02 B2 40 80 00 0A 02 D2 42 10 02 0C 02 D2 42
80 10 02 0D 02 82 43 12 02 09 43 36 40 0A 02 27 42
81 7C 46 B0 12 40 05 17 83 FB 23 16 42 0E 02 17 42
82 10 02 36 90 00 01 0A 28 B2 46 14 02 5C 42 14 02
83 B0 12 40 05 17 83 5C 42 15 02 01 3C 7C 46 B0 12
84 40 05 17 83 EE 23 B2 E3 12 02 5C 42 12 02 B0 12
85 40 05 5C 42 13 02 B0 12 40 05 E0 3E 18 42 12 02
86 B0 12 AC 05 C2 4C 12 02 B0 12 AC 05 C2 4C 13 02
87 38 E3 3B B2 0A 24 86 9A FE FF 07 24 3B B0 20 00
88 04 20 16 53 82 46 00 02 2B D3 18 92 12 02 08 23
89 2B B3 06 23 30 41 E2 B2 28 00 FD 27 E2 B2 28 00
90 FD 23 B2 40 24 02 60 01 E2 B2 28 00 FD 27 15 42
91 70 01 05 11 05 11 05 11 82 45 02 02 05 11 82 45
92 04 02 B2 80 1E 00 04 02 57 42 16 02 37 80 03 00
93 05 11 05 11 17 53 FD 23 35 50 40 A5 82 45 2A 01
94 35 42 B2 40 24 02 60 01 92 92 70 01 02 02 FC 2F
95 15 83 F7 23 09 43 7C 40 90 00 02 3C 7C 40 A0 00
96 C2 43 07 02 C9 EC 12 02 19 E3 1B C3 55 42 07 02
97 55 45 56 05 00 55 0C 2E 2E 2E 2E 2E 2E 2E 2E 1A
98 34 34 92 42 70 01 72 01 B2 50 0C 00 72 01 07 3C
99 1B B3 0B 20 82 43 62 01 92 B3 62 01 FD 27 E2 C3
100 21 00 0A 3C 4C 11 F6 2B 1B E3 82 43 62 01 92 B3
101 62 01 FD 27 E2 D3 21 00 92 52 02 02 72 01 D2 53
102 07 02 F0 90 0C 00 61 FC D1 23 30 41 C2 43 09 02
103 1B C3 55 42 09 02 55 45 BC 05 00 55 0C 56 56 56
104 56 56 56 56 56 36 76 00 E2 B2 28 00 FD 23 92 42
105 70 01 72 01 92 52 04 02 72 01 82 43 62 01 92 B3
106 62 01 FD 27 E2 B2 28 00 1E 28 2B D3 1C 3C 4C 10
107 1A 3C 82 43 62 01 92 B3 62 01 FD 27 E2 B2 28 00
108 01 28 1B E3 1B B3 01 24 2B D3 C9 EC 12 02 19 E3
109 0A 3C 82 43 62 01 92 B3 62 01 FD 27 E2 B2 28 00
110 E6 2B 4C 10 1B E3 92 52 02 02 72 01 D2 53 09 02
111 C0 3F 82 43 62 01 92 B3 62 01 FD 27 E2 B2 28 00
112 01 2C 2B D3 30 41
113 q
114 """
115
116 F4X_BSL = """@0220
117 24 02 2E 02 31 40 20 02 2B D2 C0 43 EA FF 32 C2
118 F2 C0 32 00 00 00 B2 40 80 5A 20 01 32 D0 40 00
119 C2 43 50 00 F2 40 98 00 51 00 F2 C0 80 00 52 00
120 D2 D3 21 00 D2 D3 22 00 D2 C3 26 00 E2 C3 22 00
121 E2 C3 26 00 B2 40 10 A5 2C 01 B2 40 00 A5 28 01
122 3B C0 3A 00 B0 12 DE 04 82 43 12 02 09 43 36 40
123 0A 02 37 42 B0 12 B4 05 C6 4C 00 00 16 53 17 83
124 F9 23 D2 92 0C 02 0D 02 28 20 55 42 0B 02 75 90
125 12 00 80 24 75 90 10 00 6D 24 B0 12 A4 04 55 42
126 0B 02 75 90 18 00 31 24 75 90 1E 00 B8 24 75 90
127 20 00 17 24 2B B2 11 24 75 90 16 00 22 24 75 90
128 14 00 B3 24 75 90 1A 00 18 24 75 90 1C 00 45 24
129 04 3C B0 12 3E 05 BE 3F 21 53 B0 12 44 05 BA 3F
130 03 43 B0 12 3E 05 D2 42 0E 02 50 00 D2 42 0F 02
131 51 00 D2 42 10 02 16 02 AD 3F B0 12 3E 05 10 42
132 0E 02 16 42 0E 02 15 43 07 3C 36 40 FE FF B2 40
133 06 A5 10 02 35 40 0C 00 B2 40 00 A5 2C 01 92 42
134 10 02 28 01 B6 43 00 00 92 B3 2C 01 FD 23 15 83
135 F3 23 36 90 FE FF CD 27 37 40 80 00 36 F0 80 FF
136 36 90 00 11 0E 28 07 57 36 F0 00 FF 36 90 00 12
137 08 28 07 57 36 F0 00 FE 04 3C 16 42 0E 02 17 42
138 10 02 35 43 75 96 03 20 17 83 FC 23 B2 3F 82 46
139 00 02 B3 3F 36 40 E0 FF 37 40 20 00 B0 12 B4 05
140 7C 96 01 24 2B D3 17 83 F9 23 2B C2 B0 12 A4 04
141 2B D2 9F 3F 16 42 0E 02 17 42 10 02 2B B2 38 24
142 3B D0 10 00 B0 12 B4 05 36 90 00 10 06 2C 36 90
143 00 01 09 2C C6 4C 00 00 25 3C B2 40 00 A5 2C 01
144 B2 40 40 A5 28 01 16 B3 03 20 C2 4C 14 02 1A 3C
145 C2 4C 15 02 86 9A FD FF 08 24 2B D3 3B B0 20 00
146 04 20 3B D0 20 00 82 46 00 02 36 90 01 02 04 28
147 3B D2 3B B0 10 00 02 24 3B C0 32 00 1A 42 14 02
148 86 4A FF FF 16 53 17 83 CD 23 B0 12 A4 04 61 3F
149 B0 12 B4 05 17 83 FC 23 B0 12 A4 04 5E 3F B2 40
150 F0 0F 0E 02 B2 40 10 00 10 02 B2 40 80 00 0A 02
151 D2 42 10 02 0C 02 D2 42 10 02 0D 02 82 43 12 02
152 09 43 36 40 0A 02 27 42 7C 46 B0 12 48 05 17 83
153 FB 23 16 42 0E 02 17 42 10 02 36 90 00 01 0A 28
154 B2 46 14 02 5C 42 14 02 B0 12 48 05 17 83 5C 42
155 15 02 01 3C 7C 46 B0 12 48 05 17 83 EE 23 B2 E3
156 12 02 5C 42 12 02 B0 12 48 05 5C 42 13 02 B0 12
157 48 05 E0 3E 18 42 12 02 B0 12 B4 05 C2 4C 12 02
158 B0 12 B4 05 C2 4C 13 02 38 E3 3B B2 0A 24 86 9A
159 FE FF 07 24 3B B0 20 00 04 20 16 53 82 46 00 02
160 2B D3 18 92 12 02 08 23 2B B3 06 23 30 41 E2 B3
161 20 00 FD 27 E2 B3 20 00 FD 23 B2 40 24 02 60 01
162 E2 B3 20 00 FD 27 15 42 70 01 05 11 05 11 05 11
163 82 45 02 02 05 11 82 45 04 02 B2 80 1E 00 04 02
164 57 42 16 02 37 80 03 00 05 11 05 11 17 53 FD 23
165 35 50 40 A5 82 45 2A 01 35 42 B2 40 24 02 60 01
166 92 92 70 01 02 02 FC 2F 15 83 F7 23 09 43 7C 40
167 90 00 02 3C 7C 40 A0 00 C2 43 07 02 C9 EC 12 02
168 19 E3 1B C3 55 42 07 02 55 45 5E 05 00 55 0C 2E
169 2E 2E 2E 2E 2E 2E 2E 1A 34 34 92 42 70 01 72 01
170 B2 50 0C 00 72 01 07 3C 1B B3 0B 20 82 43 62 01
171 92 B3 62 01 FD 27 D2 C3 21 00 0A 3C 4C 11 F6 2B
172 1B E3 82 43 62 01 92 B3 62 01 FD 27 D2 D3 21 00
173 92 52 02 02 72 01 D2 53 07 02 F0 90 0C 00 59 FC
174 D1 23 30 41 C2 43 09 02 1B C3 55 42 09 02 55 45
175 C4 05 00 55 0C 56 56 56 56 56 56 56 56 36 76 00
176 E2 B3 20 00 FD 23 92 42 70 01 72 01 92 52 04 02
177 72 01 82 43 62 01 92 B3 62 01 FD 27 E2 B3 20 00
178 1E 28 2B D3 1C 3C 4C 10 1A 3C 82 43 62 01 92 B3
179 62 01 FD 27 E2 B3 20 00 01 28 1B E3 1B B3 01 24
180 2B D3 C9 EC 12 02 19 E3 0A 3C 82 43 62 01 92 B3
181 62 01 FD 27 E2 B3 20 00 E6 2B 4C 10 1B E3 92 52
182 02 02 72 01 D2 53 09 02 C0 3F 82 43 62 01 92 B3
183 62 01 FD 27 E2 B3 20 00 01 2C 2B D3 30 41
184 q
185 """
186
187 #cpu types for "change baudrate"
188 #use strings as ID so that they can be used in outputs too
189 F1x                     = "F1x family"
190 F2x                     = "F2x family"
191 F4x                     = "F4x family"
192
193 #known device list
194 deviceids = {
195     0xf149: F1x,
196     0xf16c: F1x, #for GoodFET10 to '20
197     0xf112: F1x,
198     0xf413: F4x,
199     0xf123: F1x,
200     0xf449: F4x,
201     0x1232: F1x,
202     0xf26f: F2x, #for GoodFET20
203     0xf227: F2x, #for GoodFET30
204 }
205
206 #GoodFET firmware
207 firmware = {
208     0xf16c: "http://goodfet.sourceforge.net/dist/msp430x1612.hex",
209     0xf26f: "http://goodfet.sourceforge.net/dist/msp430x2618.hex",
210     0xf227: "http://goodfet.sourceforge.net/dist/msp430x2274.hex"
211 }
212
213 class BSLException(Exception):
214     pass
215
216 class LowLevel:
217     "lowlevel communication"
218     #Constants
219     MODE_SSP                = 0
220     MODE_BSL                = 1
221
222     BSL_SYNC                = 0x80
223     BSL_TXPWORD             = 0x10
224     BSL_TXBLK               = 0x12 #Transmit block to boot loader
225     BSL_RXBLK               = 0x14 #Receive  block from boot loader
226     BSL_ERASE               = 0x16 #Erase one segment
227     BSL_MERAS               = 0x18 #Erase complete FLASH memory
228     BSL_CHANGEBAUD          = 0x20 #Change baudrate
229     BSL_LOADPC              = 0x1A #Load PC and start execution
230     BSL_TXVERSION           = 0x1E #Get BSL version
231
232     #Upper limit of address range that might be modified by
233     #"BSL checksum bug".
234     BSL_CRITICAL_ADDR       = 0x0A00
235
236     #Header Definitions
237     CMD_FAILED              = 0x70
238     DATA_FRAME              = 0x80
239     DATA_ACK                = 0x90
240     DATA_NAK                = 0xA0
241
242     QUERY_POLL              = 0xB0
243     QUERY_RESPONSE          = 0x50
244
245     OPEN_CONNECTION         = 0xC0
246     ACK_CONNECTION          = 0x40
247
248     DEFAULT_TIMEOUT         =   1
249     DEFAULT_PROLONG         =  10
250     MAX_FRAME_SIZE          = 256
251     MAX_DATA_BYTES          = 250
252     MAX_DATA_WORDS          = 125
253
254     MAX_FRAME_COUNT         = 16
255
256     #Error messages
257     ERR_COM                 = "Unspecific error"
258     ERR_RX_NAK              = "NAK received (wrong password?)"
259     #ERR_CMD_NOT_COMPLETED   = "Command did not send ACK: indicates that it didn't complete correctly"
260     ERR_CMD_FAILED          = "Command failed, is not defined or is not allowed"
261     ERR_BSL_SYNC            = "Bootstrap loader synchronization error"
262     ERR_FRAME_NUMBER        = "Frame sequence number error."
263
264     def calcChecksum(self, data, length):
265         """Calculates a checksum of "data"."""
266         checksum = 0
267
268         for i in range(length/2):
269             checksum = checksum ^ (ord(data[i*2]) | (ord(data[i*2+1]) << 8))    #xor-ing
270         return 0xffff & (checksum ^ 0xffff)         #inverting
271
272     def __init__(self, aTimeout = None, aProlongFactor = None):
273         """init bsl object, don't connect yet"""
274         if aTimeout is None:
275             self.timeout = self.DEFAULT_TIMEOUT
276         else:
277             self.timeout = aTimeout
278         if aProlongFactor is None:
279             self.prolongFactor = self.DEFAULT_PROLONG
280         else:
281             self.prolongFactor = aProlongFactor
282
283         #flags for inverted use of control pins
284         #used for some hardware
285         self.invertRST = 0
286         self.invertTEST = 0
287         self.swapRSTTEST = 0
288         self.telosLatch = 0
289         self.telosI2C = 0
290         
291         self.protocolMode = self.MODE_BSL
292         self.BSLMemAccessWarning = 0                #Default: no warning.
293         self.slowmode = 0
294
295     def comInit(self, port):
296         """Tries to open the serial port given and
297         initialises the port and variables.
298         The timeout and the number of allowed errors is multiplied by
299         'aProlongFactor' after transmission of a command to give
300         plenty of time to the micro controller to finish the command.
301         Returns zero if the function is successful."""
302         if DEBUG > 1: sys.stderr.write("* comInit()\n")
303         self.seqNo = 0
304         self.reqNo = 0
305         self.rxPtr = 0
306         self.txPtr = 0
307         # Startup-Baudrate: 9600,8,E,1, 1s timeout
308         self.serialport = serial.Serial(
309             port,
310             9600,
311             parity = serial.PARITY_EVEN,
312             timeout = self.timeout
313         )
314         if DEBUG: sys.stderr.write("using serial port %r\n" % self.serialport.portstr)
315         self.SetRSTpin()                        #enable power
316         self.SetTESTpin()                       #enable power
317         self.serialport.flushInput()
318         self.serialport.flushOutput()
319
320     def comDone(self):
321         """Closes the used serial port.
322         This function must be called at the end of a program,
323         otherwise the serial port might not be released and can not be
324         used in other programs.
325         Returns zero if the function is successful."""
326         if DEBUG > 1: sys.stderr.write("* comDone()")
327         self.SetRSTpin(1)                       #disable power
328         self.SetTESTpin(0)                      #disable power
329         self.serialport.close()
330
331     def comRxHeader(self):
332         """receive header and split data"""
333         if DEBUG > 1: sys.stderr.write("* comRxHeader()\n")
334
335         hdr = self.serialport.read(1)
336         if not hdr: raise BSLException("Timeout")
337         rxHeader = ord(hdr) & 0xf0;
338         rxNum    = ord(hdr) & 0x0f;
339
340         if self.protocolMode == self.MODE_BSL:
341             self.reqNo = 0
342             self.seqNo = 0
343             rxNum = 0
344         if DEBUG > 1: sys.stderr.write("* comRxHeader() OK\n")
345         return rxHeader, rxNum
346
347     def comRxFrame(self, rxNum):
348         if DEBUG > 1: sys.stderr.write("* comRxFrame()\n")
349         rxFrame = chr(self.DATA_FRAME | rxNum)
350
351         if DEBUG > 2: sys.stderr.write("  comRxFrame() header...\n")
352         rxFramedata = self.serialport.read(3)
353         if len(rxFramedata) != 3: raise BSLException("Timeout")
354         rxFrame = rxFrame + rxFramedata
355
356         if DEBUG > 3: sys.stderr.write("  comRxFrame() check header...\n")
357         if rxFrame[1] == chr(0) and rxFrame[2] == rxFrame[3]:   #Add. header info. correct?
358             rxLengthCRC = ord(rxFrame[2]) + 2       #Add CRC-Bytes to length
359             if DEBUG > 2: sys.stderr.write("  comRxFrame() receiving data, size: %s\n" % rxLengthCRC)
360
361             rxFramedata = self.serialport.read(rxLengthCRC)
362             if len(rxFramedata) != rxLengthCRC: raise BSLException("Timeout")
363             rxFrame = rxFrame + rxFramedata
364             #Check received frame:
365             if DEBUG > 3: sys.stderr.write("  comRxFrame() crc check\n")
366             #rxLength+4: Length with header but w/o CRC:
367             checksum = self.calcChecksum(rxFrame, ord(rxFrame[2]) + 4)
368             if rxFrame[ord(rxFrame[2])+4] == chr(0xff & checksum) and \
369                rxFrame[ord(rxFrame[2])+5] == chr(0xff & (checksum >> 8)): #Checksum correct?
370                 #Frame received correctly (=> send next frame)
371                 if DEBUG > 2: sys.stderr.write("* comRxFrame() OK\n")
372                 return rxFrame
373             else:
374                 if DEBUG: sys.stderr.write("  comRxFrame() Checksum wrong\n")
375         else:
376             if DEBUG: sys.stderr.write("  comRxFrame() Header corrupt %r" % rxFrame)
377         raise BSLException(self.ERR_COM)            #Frame has errors!
378
379     def comTxHeader(self, txHeader):
380         """send header"""
381         if DEBUG > 1: sys.stderr.write("* txHeader()\n")
382         self.serialport.write(txHeader)
383
384     def comTxRx(self, cmd, dataOut, length):
385         """Sends the command cmd with the data given in dataOut to the
386         microcontroller and expects either an acknowledge or a frame
387         with result from the microcontroller.  The results are stored
388         in dataIn (if not a NULL pointer is passed).
389         In this routine all the necessary protocol stuff is handled.
390         Returns zero if the function was successful."""
391         if DEBUG > 1: sys.stderr.write("* comTxRx()\n")
392         txFrame     = []
393         rxHeader    = 0
394         rxNum       = 0
395
396         dataOut = list(dataOut)     #convert to a list for simpler data fill in
397         #Transmitting part ----------------------------------------
398         #Prepare data for transmit
399         if (length % 2) != 0:
400             #/* Fill with one byte to have even number of bytes to send */
401             if self.protocolMode == self.MODE_BSL:
402                 dataOut.append(0xFF)  #fill with 0xFF
403             else:
404                 dataOut.append(0)     #fill with zero
405
406         txFrame = "%c%c%c%c" % (self.DATA_FRAME | self.seqNo, cmd, len(dataOut), len(dataOut))
407
408         self.reqNo = (self.seqNo + 1) % self.MAX_FRAME_COUNT
409
410         txFrame = txFrame + string.join(dataOut,'')
411         checksum = self.calcChecksum(txFrame, length + 4)
412         txFrame = txFrame + chr(checksum & 0xff)
413         txFrame = txFrame + chr((checksum >> 8) & 0xff)
414
415         accessAddr = (0x0212 + (checksum^0xffff)) & 0xfffe  #0x0212: Address of wCHKSUM
416         if self.BSLMemAccessWarning and accessAddr < self.BSL_CRITICAL_ADDR:
417             sys.stderr.write("WARNING: This command might change data at address %04x or %04x!\n" % (accessAddr, accessAddr + 1))
418
419         self.serialport.flushInput()                #clear receiving queue
420         #TODO: Check after each transmitted character,
421         #TODO: if microcontroller did send a character (probably a NAK!).
422         for c in txFrame:
423             self.serialport.write(c)
424             if DEBUG > 3: sys.stderr.write("\ttx %02x" % ord(c))
425             #if self.serialport.inWaiting(): break  #abort when BSL replies, probably NAK
426         else:
427             if DEBUG > 1: sys.stderr.write( "  comTxRx() transmit OK\n")
428
429         #Receiving part -------------------------------------------
430         rxHeader, rxNum = self.comRxHeader()        #receive header
431         if DEBUG > 1: sys.stderr.write("  comTxRx() rxHeader=0x%02x, rxNum=%d, seqNo=%d, reqNo=%s\n" % (rxHeader, rxNum, self.seqNo, self.reqNo))
432         if rxHeader == self.DATA_ACK:               #acknowledge/OK
433             if DEBUG > 2: sys.stderr.write("  comTxRx() DATA_ACK\n")
434             if rxNum == self.reqNo:
435                 self.seqNo = self.reqNo
436                 if DEBUG > 2: sys.stderr.write("* comTxRx() DATA_ACK OK\n")
437                 return          #Acknowledge received correctly => next frame
438             raise BSLException(self.ERR_FRAME_NUMBER)
439         elif rxHeader == self.DATA_NAK:             #not acknowledge/error
440             if DEBUG > 2: sys.stderr.write("* comTxRx() DATA_NAK\n")
441             raise BSLException(self.ERR_RX_NAK)
442         elif rxHeader == self.DATA_FRAME:           #receive data
443             if DEBUG > 2: sys.stderr.write("* comTxRx() DATA_FRAME\n")
444             if rxNum == self.reqNo:
445                 rxFrame = self.comRxFrame(rxNum)
446                 return rxFrame
447             raise BSLException(self.ERR_FRAME_NUMBER)
448         elif rxHeader == self.CMD_FAILED:           #Frame ok, but command failed.
449             if DEBUG > 2: sys.stderr.write("*  comTxRx() CMD_FAILED\n")
450             raise BSLException(self.ERR_CMD_FAILED)
451
452         raise BSLException("Unknown header 0x%02x\nAre you downloading to RAM into an old device that requires the patch? Try option -U" % rxHeader)
453
454     def SetDTR(self, level, invert):
455         """Controls DTR pin (0: GND; 1: VCC; unless inverted flag is set)"""
456         if invert:
457             self.serialport.setDTR(not level)
458         else:
459             self.serialport.setDTR(level)
460         if self.slowmode:
461             time.sleep(0.040)
462
463     def SetRTS(self, level, invert):
464         """Controls RTS pin (0: GND; 1: VCC; unless inverted flag is set)"""
465         if invert:
466             self.serialport.setRTS(not level)
467         else:
468             self.serialport.setRTS(level)
469         if self.slowmode:
470             time.sleep(0.040)
471
472     def SetRSTpin(self, level=1):
473         """Controls RST/NMI pin (0: GND; 1: VCC; unless inverted flag is set)"""
474         if self.swapRSTTEST:
475             self.SetRTS(level, self.invertRST)
476         else:
477             self.SetDTR(level, self.invertRST)
478
479     def SetTESTpin(self, level=1):
480         """Controls TEST pin (inverted on board: 0: VCC; 1: GND; unless inverted flag is set)"""
481         if self.swapRSTTEST:
482             self.SetDTR(level, self.invertTEST)
483         else:
484             self.SetRTS(level, self.invertTEST)
485
486     def telosSetSCL(self, level):
487         self.serialport.setRTS(not level)
488
489     def telosSetSDA(self, level):
490         self.serialport.setDTR(not level)
491
492     def telosI2CStart(self):
493         self.telosSetSDA(1)
494         self.telosSetSCL(1)
495         self.telosSetSDA(0)
496
497     def telosI2CStop(self):
498         self.telosSetSDA(0)
499         self.telosSetSCL(1)
500         self.telosSetSDA(1)
501
502     def telosI2CWriteBit(self, bit):
503         self.telosSetSCL(0)
504         self.telosSetSDA(bit)
505         time.sleep(2e-6)
506         self.telosSetSCL(1)
507         time.sleep(1e-6)
508         self.telosSetSCL(0)
509
510     def telosI2CWriteByte(self, byte):
511         self.telosI2CWriteBit( byte & 0x80 );
512         self.telosI2CWriteBit( byte & 0x40 );
513         self.telosI2CWriteBit( byte & 0x20 );
514         self.telosI2CWriteBit( byte & 0x10 );
515         self.telosI2CWriteBit( byte & 0x08 );
516         self.telosI2CWriteBit( byte & 0x04 );
517         self.telosI2CWriteBit( byte & 0x02 );
518         self.telosI2CWriteBit( byte & 0x01 );
519         self.telosI2CWriteBit( 0 );  # "acknowledge"
520
521     def telosI2CWriteCmd(self, addr, cmdbyte):
522         self.telosI2CStart()
523         self.telosI2CWriteByte( 0x90 | (addr << 1) )
524         self.telosI2CWriteByte( cmdbyte )
525         self.telosI2CStop()
526
527     def telosBReset(self,invokeBSL=0):
528
529         # "BSL entry sequence at dedicated JTAG pins"
530         # rst !s0: 0 0 0 0 1 1
531         # tck !s1: 1 0 1 0 0 1
532         #   s0|s1: 1 3 1 3 2 0
533
534         # "BSL entry sequence at shared JTAG pins"
535         # rst !s0: 0 0 0 0 1 1
536         # tck !s1: 0 1 0 1 1 0
537         #   s0|s1: 3 1 3 1 0 2
538
539         if invokeBSL:
540           self.telosI2CWriteCmd(0,1)
541           self.telosI2CWriteCmd(0,3)
542           self.telosI2CWriteCmd(0,1)
543           self.telosI2CWriteCmd(0,3)
544           self.telosI2CWriteCmd(0,2)
545           self.telosI2CWriteCmd(0,0)
546         else:
547           self.telosI2CWriteCmd(0,3)
548           self.telosI2CWriteCmd(0,2)
549         self.telosI2CWriteCmd(0,0)
550         time.sleep(0.250)       #give MSP430's oscillator time to stabilize
551         self.serialport.flushInput()  #clear buffers
552
553     def bslReset(self, invokeBSL=0):
554         """Applies BSL entry sequence on RST/NMI and TEST/VPP pins
555         Parameters:
556             invokeBSL = 1: complete sequence
557             invokeBSL = 0: only RST/NMI pin accessed
558
559         RST is inverted twice on boot loader hardware
560         TEST is inverted (only once)
561         Need positive voltage on DTR, RTS for power-supply of hardware"""
562         if self.telosI2C:
563           self.telosBReset(invokeBSL)
564           return
565
566         if DEBUG > 1: sys.stderr.write("* bslReset(invokeBSL=%s)\n" % invokeBSL)
567         self.SetRSTpin(1)       #power suply
568         self.SetTESTpin(1)      #power suply
569         time.sleep(0.250)       #charge capacitor on boot loader hardware
570
571         if self.telosLatch:
572           self.SetTESTpin(0)
573           self.SetRSTpin(0)
574           self.SetTESTpin(1)
575
576         self.SetRSTpin(0)       #RST  pin: GND
577         if invokeBSL:
578             self.SetTESTpin(1)  #TEST pin: GND
579             self.SetTESTpin(0)  #TEST pin: Vcc
580             self.SetTESTpin(1)  #TEST pin: GND
581             self.SetTESTpin(0)  #TEST pin: Vcc
582             self.SetRSTpin (1)  #RST  pin: Vcc
583             self.SetTESTpin(1)  #TEST pin: GND
584         else:
585             self.SetRSTpin(1)   #RST  pin: Vcc
586         time.sleep(0.250)       #give MSP430's oscillator time to stabilize
587
588         self.serialport.flushInput()    #clear buffers
589
590     def bslSync(self,wait=0):
591         """Transmits Synchronization character and expects to receive Acknowledge character
592         if wait is 0 it must work the first time. otherwise if wait is 1
593         it is retried (forever).
594         """
595         loopcnt = 5                                 #Max. tries to get synchronization
596
597         if DEBUG > 1: sys.stderr.write("* bslSync(wait=%d)\n" % wait)
598         while wait or loopcnt:
599             loopcnt = loopcnt - 1                   #count down tries
600             self.serialport.flushInput()            #clear input, in case a prog is running
601
602             self.serialport.write(chr(self.BSL_SYNC))   #Send synchronization byte
603             c = self.serialport.read(1)             #read answer
604             if c == chr(self.DATA_ACK):             #ACk
605                 if DEBUG > 1: sys.stderr.write("  bslSync() OK\n")
606                 return                              #Sync. successful
607             elif not c:                             #timeout
608                     if loopcnt > 4:
609                         if DEBUG > 1:
610                             sys.stderr.write("  bslSync() timeout, retry ...\n")
611                     elif loopcnt == 4:
612                         #nmi may have caused the first reset to be ignored, try again
613                         self.bslReset(0) 
614                         self.bslReset(1)
615                     elif loopcnt > 0:
616                         if DEBUG > 1:
617                             sys.stderr.write("  bslSync() timeout, retry ...\n")
618                     else :
619                         if DEBUG > 1:
620                             sys.stderr.write("  bslSync() timeout\n")
621             else:                                   #garbage
622                 if DEBUG > 1: sys.stderr.write("  bslSync() failed (0x%02x), retry ...\n" % ord(c))
623                 
624                 raise BSLException(self.ERR_BSL_SYNC)       #Sync. failed
625
626     def bslTxRx(self, cmd, addr, length = 0, blkout = None, wait=0):
627         """Transmits a command (cmd) with its parameters:
628         start-address (addr), length (len) and additional
629         data (blkout) to boot loader.
630         wait specified if the bsl sync should be tried once or
631         repeated, forever
632         Parameters return by boot loader are passed via blkin.
633         """
634         if DEBUG > 1: sys.stderr.write("* bslTxRx()\n")
635
636         if cmd == self.BSL_TXBLK:
637             #Align to even start address
638             if (addr % 2) != 0:
639                 addr = addr - 1                     #Decrement address and
640                 blkout = chr(0xFF) + blkOut         #fill first byte of blkout with 0xFF
641                 length = length + 1
642             #Make sure that len is even
643             if (length % 2) != 0:
644                 blkout = blkout + chr(0xFF)         #Inc. len and fill last byte of blkout with 0xFF
645                 length = length + 1
646
647         elif cmd == self.BSL_RXBLK:
648             #Align to even start address
649             if (addr % 2) != 0:
650                 addr = addr - 1                     #Decrement address but
651                 length = length + 1                 #request an additional byte
652             #Make sure that len is even
653             if (length % 2) != 0:
654                 length = length + 1
655
656         #if cmd == self.BSL_TXBLK or cmd == self.BSL_TXPWORD:
657         #    length = len + 4
658
659         #Add necessary information data to frame
660         dataOut =  struct.pack("<HH", addr, length)
661
662         if blkout: #Copy data out of blkout into frame
663             dataOut = dataOut + blkout
664
665         self.bslSync(wait)                          #synchronize BSL
666         rxFrame = self.comTxRx(cmd, dataOut, len(dataOut))  #Send frame
667         if rxFrame:                                 #test answer
668             return rxFrame[4:] #return only data w/o [hdr,null,len,len]
669         else:
670             return rxFrame
671
672
673 class Segment:
674     """store a string with memory contents along with its startaddress"""
675     def __init__(self, startaddress = 0, data=None):
676         if data is None:
677             self.data = ''
678         else:
679             self.data = data
680         self.startaddress = startaddress
681
682     def __getitem__(self, index):
683         return self.data[index]
684
685     def __len__(self):
686         return len(self.data)
687
688     def __repr__(self):
689         return "Segment(startaddress = 0x%04x, data=%r)" % (self.startaddress, self.data)
690
691 class Memory:
692     """represent memory contents. with functions to load files"""
693     def __init__(self, filename=None):
694         self.segments = []
695         if filename:
696             self.filename = filename
697             self.loadFile(filename)
698
699     def append(self, seg):
700         self.segments.append(seg)
701
702     def __getitem__(self, index):
703         return self.segments[index]
704
705     def __len__(self):
706         return len(self.segments)
707
708     def loadIHex(self, file):
709         """load data from a (opened) file in Intel-HEX format"""
710         segmentdata = []
711         currentAddr = 0
712         startAddr   = 0
713         lines = file.readlines()
714         for l in lines:
715             if l[0] != ':': raise BSLException("File Format Error\n")
716             l = l.strip()       #fix CR-LF issues...
717             length  = int(l[1:3],16)
718             address = int(l[3:7],16)
719             type    = int(l[7:9],16)
720             check   = int(l[-2:],16)
721             if type == 0x00:
722                 if currentAddr != address:
723                     if segmentdata:
724                         self.segments.append( Segment(startAddr, string.join(segmentdata,'')) )
725                     startAddr = currentAddr = address
726                     segmentdata = []
727                 for i in range(length):
728                     segmentdata.append( chr(int(l[9+2*i:11+2*i],16)) )
729                 currentAddr = length + currentAddr
730             elif type in (0x01, 0x02, 0x03, 0x04, 0x05):
731                 pass
732             else:
733                 sys.stderr.write("Ignored unknown field (type 0x%02x) in ihex file.\n" % type)
734         if segmentdata:
735             self.segments.append( Segment(startAddr, string.join(segmentdata,'')) )
736
737     def loadTIText(self, file):
738         """load data from a (opened) file in TI-Text format"""
739         next        = 1
740         startAddr   = 0
741         segmentdata = []
742         #Convert data for MSP430, TXT-File is parsed line by line
743         while next >= 1:
744             #Read one line
745             l = file.readline()
746             if not l: break #EOF
747             l = l.strip()
748             if l[0] == 'q': break
749             elif l[0] == '@':        #if @ => new address => send frame and set new addr.
750                 #create a new segment
751                 if segmentdata:
752                     self.segments.append( Segment(startAddr, string.join(segmentdata,'')) )
753                 startAddr = int(l[1:],16)
754                 segmentdata = []
755             else:
756                 for i in string.split(l):
757                     segmentdata.append(chr(int(i,16)))
758         if segmentdata:
759             self.segments.append( Segment(startAddr, string.join(segmentdata,'')) )
760
761     def loadELF(self, file):
762         """load data from a (opened) file in ELF object format.
763         File must be seekable"""
764         import elf
765         obj = elf.ELFObject()
766         obj.fromFile(file)
767         if obj.e_type != elf.ELFObject.ET_EXEC:
768             raise Exception("No executable")
769         for section in obj.getSections():
770             if DEBUG:
771                 sys.stderr.write("ELF section %s at 0x%04x %d bytes\n" % (section.name, section.lma, len(section.data)))
772             if len(section.data):
773                 self.segments.append( Segment(section.lma, section.data) )
774         
775     def loadFile(self, filename):
776         """fill memory with the contents of a file. file type is determined from extension"""
777         #TODO: do a contents based detection
778         if filename[-4:].lower() == '.txt':
779             self.loadTIText(open(filename, "rb"))
780         elif filename[-4:].lower() in ('.a43', '.hex'):
781             self.loadIHex(open(filename, "rb"))
782         else:
783             self.loadELF(open(filename, "rb"))
784
785     def getMemrange(self, fromadr, toadr):
786         """get a range of bytes from the memory. unavailable values are filled with 0xff."""
787         res = ''
788         toadr = toadr + 1   #python indxes are excluding end, so include it
789         while fromadr < toadr:
790             #print "fromto: %04x %04x" % (fromadr, toadr)
791             for seg in self.segments:
792                 #print seg
793                 segend = seg.startaddress + len(seg.data)
794                 if seg.startaddress <= fromadr and fromadr < segend:
795                     #print "startok 0x%04x %d" % (seg.startaddress, len(seg.data))
796                     #print ("0x%04x "*3) % (segend, fromadr, toadr)
797                     if toadr > segend:   #not all data in segment
798                         #print "out of segment"
799                         catchlength = segend-fromadr
800                     else:
801                         catchlength = toadr-fromadr
802                     #print toadr-fromadr
803                     #print catchlength
804                     res = res + seg.data[fromadr-seg.startaddress : fromadr-seg.startaddress+catchlength]
805                     fromadr = fromadr + catchlength    #adjust start
806                     if len(res) >= toadr-fromadr:
807                         break#return res
808             else:
809                     res = res + chr(255)
810                     fromadr = fromadr + 1 #adjust start
811                     #print "fill FF"
812         #print "res: %r" % res
813         return res
814
815
816 class BootStrapLoader(LowLevel):
817     """higher level Bootstrap Loader functions."""
818
819     ERR_VERIFY_FAILED       = "Error: verification failed"
820     ERR_ERASE_CHECK_FAILED  = "Error: erase check failed"
821
822     ACTION_PROGRAM          = 0x01 #Mask: program data
823     ACTION_VERIFY           = 0x02 #Mask: verify data
824     ACTION_ERASE_CHECK      = 0x04 #Mask: erase check
825
826     #Max. bytes sent within one frame if parsing a TI TXT file.
827     #( >= 16 and == n*16 and <= MAX_DATA_BYTES!)
828     MAXDATA                 = 240-16
829
830
831     def __init__(self, *args, **kargs):
832         LowLevel.__init__(self, *args, **kargs)
833         self.byteCtr        = 0
834         self.meraseCycles   = 1
835         self.patchRequired  = 0
836         self.patchLoaded    = 0
837         self.bslVer         = 0
838         self.passwd         = None
839         self.data           = None
840         self.maxData        = self.MAXDATA
841         self.cpu            = None
842
843
844     def preparePatch(self):
845         """prepare to download patch"""
846         if DEBUG > 1: sys.stderr.write("* preparePatch()\n")
847
848         if self.patchLoaded:
849             #Load PC with 0x0220.
850             #This will invoke the patched bootstrap loader subroutines.
851             self.bslTxRx(self.BSL_LOADPC,           #Command: Load PC
852                            0x0220)                  #Address to load into PC
853             self.BSLMemAccessWarning = 0 #Error is removed within workaround code
854         return
855
856     def postPatch(self):
857         """setup after the patch is loaded"""
858         if DEBUG > 1: sys.stderr.write("* postPatch()\n")
859         if self.patchLoaded:
860             self.BSLMemAccessWarning = 1                #Turn warning back on.
861
862     
863     def verifyBlk(self, addr, blkout, action):
864         """verify memory against data or 0xff"""
865         if DEBUG > 1: sys.stderr.write("* verifyBlk()\n")
866
867         if action & self.ACTION_VERIFY or action & self.ACTION_ERASE_CHECK:
868             if DEBUG: sys.stderr.write("  Check starting at 0x%04x, %d bytes ... \n" % (addr, len(blkout)))
869
870             self.preparePatch()
871             blkin = self.bslTxRx(self.BSL_RXBLK, addr, len(blkout))
872             self.postPatch()
873
874             for i in range(len(blkout)):
875                 if action & self.ACTION_VERIFY:
876                     #Compare data in blkout and blkin
877                     if blkin[i] != blkout[i]:
878                         sys.stderr.write("Verification failed at 0x%04x (0x%02x, 0x%02x)\n" % (addr+i, ord(blkin[i]), ord(blkout[i])))
879                         sys.stderr.flush()
880                         raise BSLException(self.ERR_VERIFY_FAILED)      #Verify failed!
881                     continue
882                 elif action & self.ACTION_ERASE_CHECK:
883                     #Compare data in blkin with erase pattern
884                     if blkin[i] != chr(0xff):
885                         sys.stderr.write("Erase Check failed at 0x%04x (0x%02x)\n" % (addr+i, ord(blkin[i])))
886                         sys.stderr.flush()
887                         raise BSLException(self.ERR_ERASE_CHECK_FAILED) #Erase Check failed!
888                     continue
889     def readBlk(self,adr,len):
890         """Read a block of memory."""
891         blkin = self.bslTxRx(self.BSL_RXBLK, addr, len(blkout))
892         
893     def programBlk(self, addr, blkout, action):
894         """program a memory block"""
895         if DEBUG > 1: sys.stderr.write("* programBlk()\n")
896
897         #Check, if specified range is erased
898         self.verifyBlk(addr, blkout, action & self.ACTION_ERASE_CHECK)
899
900         if action & self.ACTION_PROGRAM:
901             if DEBUG: sys.stderr.write("  Program starting at 0x%04x, %i bytes ...\n" % (addr, len(blkout)))
902             self.preparePatch()
903             #Program block
904             self.bslTxRx(self.BSL_TXBLK, addr, len(blkout), blkout)
905             self.postPatch()
906
907         #Verify block
908         self.verifyBlk(addr, blkout, action & self.ACTION_VERIFY)
909
910     #segments:
911     #list of tuples or lists:
912     #segements = [ (addr1, [d0,d1,d2,...]), (addr2, [e0,e1,e2,...])]
913     def programData(self, segments, action):
914         """programm or verify data"""
915         if DEBUG > 1: sys.stderr.write("* programData()\n")
916         for seg in segments:
917             currentAddr = seg.startaddress
918             pstart = 0
919             while pstart<len(seg.data):
920                 length = self.MAXDATA
921                 if pstart+length > len(seg.data):
922                     length = len(seg.data) - pstart
923                 self.programBlk(currentAddr, seg.data[pstart:pstart+length], action)
924                 pstart = pstart + length
925                 currentAddr = currentAddr + length
926                 self.byteCtr = self.byteCtr + length #total sum
927     
928     def uploadData(self, startaddress, size, wait=0):
929         """upload a datablock"""
930         if DEBUG > 1: sys.stderr.write("* uploadData()\n")
931         data = ''
932         pstart = 0
933         while pstart<size:
934             length = self.maxData
935             if pstart+length > size:
936                 length = size - pstart
937             data = data + self.bslTxRx(self.BSL_RXBLK,
938                                        pstart+startaddress,
939                                        length,
940                                        wait=wait)[:-2] #cut away checksum
941             pstart = pstart + length
942         return data
943
944     def txPasswd(self, passwd=None, wait=0):
945         """transmit password, default if None is given."""
946         if DEBUG > 1: sys.stderr.write("* txPassword(%r)\n" % passwd)
947         if passwd is None:
948             #Send "standard" password to get access to protected functions.
949             sys.stderr.write("Transmit default password ...\n")
950             sys.stderr.flush()
951             #Flash is completely erased, the contents of all Flash cells is 0xff
952             passwd = chr(0xff)*32
953         else:
954             #sanity check of password
955             if len(passwd) != 32:
956                 raise ValueError, "password has wrong length (%d)\n" % len(passwd)
957             sys.stderr.write('Transmit password ...\n')
958             sys.stderr.flush()
959         #send the password
960         self.bslTxRx(self.BSL_TXPWORD,      #Command: Transmit Password
961                        0xffe0,              #Address of interupt vectors
962                        0x0020,              #Number of bytes
963                        passwd,              #password
964                        wait=wait)           #if wait is 1, try to sync forever
965
966
967     #-----------------------------------------------------------------
968
969     def actionMassErase(self):
970         """Erase the flash memory completely (with mass erase command)"""
971         sys.stderr.write("Mass Erase...\n")
972         sys.stderr.flush()
973         self.bslReset(1)                            #Invoke the boot loader.
974         for i in range(self.meraseCycles):
975             if i == 1: sys.stderr.write("Additional Mass Erase Cycles...\n")
976             self.bslTxRx(self.BSL_MERAS,            #Command: Mass Erase
977                                 0xff00,             #Any address within flash memory.
978                                 0xa506)             #Required setting for mass erase!
979         self.passwd = None                          #No password file required!
980         #print "Mass Erase complete"
981         #Transmit password to get access to protected BSL functions.
982         self.txPasswd()
983
984     def actionStartBSL(self, usepatch=1, adjsp=1, replacementBSL=None, forceBSL=0, mayuseBSL=0, speed=None, bslreset=1):
985         """start BSL, download patch if desired and needed, adjust SP if desired"""
986         sys.stderr.write("Invoking BSL...\n")
987         sys.stderr.flush()
988         
989         #for '30, invertTEST=0, else =1
990         if bslreset:
991             self.bslReset(1)                        #Invoke the boot loader.
992         
993         
994         self.txPasswd(self.passwd)                  #transmit password
995
996         #Read actual bootstrap loader version.
997         #sys.stderr.write("Reading BSL version ...\n")
998         blkin = self.bslTxRx(self.BSL_RXBLK,        #Command: Read/Receive Block
999                           0x0ff0,                   #Start address
1000                           16)                       #No. of bytes to read
1001         dev_id, bslVerHi, bslVerLo = struct.unpack(">H8xBB4x", blkin[:-2]) #cut away checksum and extract data
1002         self.dev_id=dev_id;
1003         
1004         
1005         if self.cpu is None:                        #cpy type forced?
1006             if deviceids.has_key(dev_id):
1007                 self.cpu = deviceids[dev_id]        #try to autodectect CPU type
1008                 
1009                 if DEBUG:
1010                     sys.stderr.write("Autodetect successful: %04x -> %s\n" % (dev_id, self.cpu))
1011             else:
1012                 sys.stderr.write("Autodetect failed! Unkown ID: %04x. Trying to continue anyway.\n" % dev_id)
1013                 self.cpu = F1x                      #assume something and try anyway..
1014
1015         sys.stderr.write("Current bootstrap loader version: %x.%x (Device ID: %04x)\n" % (bslVerHi, bslVerLo, dev_id))
1016         sys.stderr.flush()
1017         self.bslVer = (bslVerHi << 8) | bslVerLo
1018
1019         if self.bslVer <= 0x0110:                   #check if patch is needed
1020             self.BSLMemAccessWarning = 1
1021         else:
1022             self.BSLMemAccessWarning = 0 #Fixed in newer versions of BSL.
1023
1024         if self.bslVer <= 0x0130 and adjsp:
1025             #only do this on BSL where it's needed to prevent
1026             #malfunction with F4xx devices/ newer ROM-BSLs
1027             
1028             #Execute function within bootstrap loader
1029             #to prepare stack pointer for the following patch.
1030             #This function will lock the protected functions again.
1031             sys.stderr.write("Adjust SP. Load PC with 0x0C22 ...\n")
1032             self.bslTxRx(self.BSL_LOADPC,           #Command: Load PC
1033                                 0x0C22)             #Address to load into PC
1034             #Re-send password to re-gain access to protected functions.
1035             self.txPasswd(self.passwd)
1036
1037         #get internal BSL replacement if needed or forced by the user
1038         #required if speed is set but an old BSL is in the device
1039         #if a BSL is given by the user, that one is used and not the internal one
1040         if ((mayuseBSL and speed and self.bslVer < 0x0150) or forceBSL) and replacementBSL is None:
1041             replacementBSL = Memory() #File to program
1042             if self.cpu == F4x:
1043                 if DEBUG:
1044                     sys.stderr.write("Using built in BSL replacement for F4x devices\n")
1045                     sys.stderr.flush()
1046                 replacementBSL.loadTIText(cStringIO.StringIO(F4X_BSL))  #parse embedded BSL
1047             else:
1048                 if DEBUG:
1049                     sys.stderr.write("Using built in BSL replacement for F1x devices\n")
1050                     sys.stderr.flush()
1051                 replacementBSL.loadTIText(cStringIO.StringIO(F1X_BSL))  #parse embedded BSL
1052     
1053         #now download the new BSL, if allowed and needed (version lower than the
1054         #the replacement) or forced
1055         if replacementBSL is not None:
1056             self.actionDownloadBSL(replacementBSL)
1057
1058         #debug message with the real BSL version in use (may have changed after replacement BSL)
1059         if DEBUG:
1060             sys.stderr.write("Current bootstrap loader version: 0x%04x\n" % (self.bslVer,))
1061             sys.stderr.flush()
1062
1063         #now apply workarounds or patches if BSL in use requires that
1064         if self.bslVer <= 0x0110:                   #check if patch is needed
1065             if usepatch:                            #test if patch is desired
1066                 sys.stderr.write("Patch for flash programming required!\n")
1067                 self.patchRequired = 1
1068
1069                 sys.stderr.write("Load and verify patch ...\n")
1070                 sys.stderr.flush()
1071                 #Programming and verification is done in one pass.
1072                 #The patch file is only read and parsed once.
1073                 segments = Memory()                     #data to program
1074                 segments.loadTIText(cStringIO.StringIO(PATCH))  #parse embedded patch
1075                 #program patch
1076                 self.programData(segments, self.ACTION_PROGRAM | self.ACTION_VERIFY)
1077                 self.patchLoaded = 1
1078             else:
1079                 if DEBUG:
1080                     sys.stderr.write("Device needs patch, but not applied (usepatch is false).\n")    #message if not patched
1081
1082         #should the baudrate be changed?
1083         if speed is not None:
1084             self.actionChangeBaudrate(speed)            #change baudrate
1085
1086     def actionDownloadBSL(self, bslsegments):
1087         sys.stderr.write("Load new BSL into RAM...\n")
1088         sys.stderr.flush()
1089         self.programData(bslsegments, self.ACTION_PROGRAM)
1090         sys.stderr.write("Verify new BSL...\n")
1091         sys.stderr.flush()
1092         self.programData(bslsegments, self.ACTION_VERIFY) #File to verify
1093
1094         #Read startvector of bootstrap loader
1095         #blkin = self.bslTxRx(self.BSL_RXBLK, 0x0300, 2)
1096         #blkin = self.bslTxRx(self.BSL_RXBLK, 0x0220, 2)
1097         blkin = self.bslTxRx(self.BSL_RXBLK, bslsegments[0].startaddress, 2)
1098         startaddr = struct.unpack("<H", blkin[:2])[0]
1099
1100         sys.stderr.write("Starting new BSL at 0x%04x...\n" % startaddr)
1101         sys.stderr.flush()
1102         self.bslTxRx(self.BSL_LOADPC,  #Command: Load PC
1103                      startaddr)        #Address to load into PC
1104
1105         #BSL-Bugs should be fixed within "new" BSL
1106         self.BSLMemAccessWarning = 0
1107         self.patchRequired = 0
1108         self.patchLoaded   = 0
1109
1110         #Re-send password to re-gain access to protected functions.
1111         self.txPasswd(self.passwd)
1112
1113         #update version info
1114         #verison only valid for the internal ones, but it also makes sure 
1115         #that the patches are not applied if the user d/ls one
1116         self.bslVer = 0x0150
1117
1118     def actionEraseCheck(self):
1119         """check the erasure of required flash cells."""
1120         sys.stderr.write("Erase Check by file ...\n")
1121         sys.stderr.flush()
1122         if self.data is not None:
1123             self.programData(self.data, self.ACTION_ERASE_CHECK)
1124         else:
1125             raise BSLException, "cannot do erase check against data with not knowing the actual data"
1126
1127     def actionProgram(self):
1128         """program data into flash memory."""
1129         if self.data is not None:
1130             sys.stderr.write("Program ...\n")
1131             sys.stderr.flush()
1132             self.programData(self.data, self.ACTION_PROGRAM)
1133             sys.stderr.write("%i bytes programmed.\n" % self.byteCtr)
1134             sys.stderr.flush()
1135         else:
1136             raise BSLException, "programming without data not possible"
1137     def actionFromweb(self):
1138         """Grab GoodFET firmware from the web, then flash it."""
1139         print "Grabbing %x firmware." % self.dev_id;
1140         print "%s" % firmware[self.dev_id];
1141         fn="/tmp/.goodfet.hex"
1142         os.system("curl %s >%s" % (firmware[self.dev_id],fn))
1143         
1144         fw=Memory(fn);
1145         #fw.loadIhex(open(fn,"rb"));
1146         
1147         sys.stderr.write("Program ...\n")
1148         sys.stderr.flush()
1149         self.programData(fw, self.ACTION_PROGRAM | self.ACTION_VERIFY)
1150         sys.stderr.write("%i bytes programmed.\n" % self.byteCtr)
1151         sys.stderr.flush()
1152         
1153     def actionVerify(self):
1154         """Verify programmed data"""
1155         if self.data is not None:
1156             sys.stderr.write("Verify ...\n")
1157             sys.stderr.flush()
1158             self.programData(self.data, self.ACTION_VERIFY)
1159         else:
1160             raise BSLException, "verify without data not possible"
1161
1162     def actionReset(self):
1163         """perform a reset, start user programm"""
1164         sys.stderr.write("Reset device ...\n")
1165         sys.stderr.flush()
1166         self.bslReset(0) #only reset
1167
1168     def actionRun(self, address=0x220):
1169         """start program at specified address"""
1170         sys.stderr.write("Load PC with 0x%04x ...\n" % address)
1171         sys.stderr.flush()
1172         self.bslTxRx(self.BSL_LOADPC, #Command: Load PC
1173                             address)  #Address to load into PC
1174
1175     #table with values from slaa089a.pdf
1176     bauratetable = {
1177         F1x: {
1178              9600:[0x8580, 0x0000],
1179             19200:[0x86e0, 0x0001],
1180             38400:[0x87e0, 0x0002],
1181         },
1182         F2x: {
1183              9600:[0x8580, 0x0000],
1184             19200:[0x8B00, 0x0001],
1185             38400:[0x8C80, 0x0002],
1186         },
1187         F4x: {
1188              9600:[0x9800, 0x0000],
1189             19200:[0xb000, 0x0001],
1190             38400:[0xc800, 0x0002],
1191         },
1192     }
1193     def actionChangeBaudrate(self, baudrate=9600):
1194         """change baudrate. first the command is sent, then the comm
1195         port is reprogrammed. only possible with newer MSP430-BSL versions.
1196         (ROM >=1.6, downloadable >=1.5)"""
1197         try:
1198             baudconfigs = self.bauratetable[self.cpu]
1199         except KeyError:
1200             raise ValueError, "unknown CPU type %s, can't switch baudrate" % self.cpu
1201         try:
1202             a,l = baudconfigs[baudrate]
1203         except KeyError:
1204             raise ValueError, "baudrate not valid. valid values are %r" % baudconfigs.keys()
1205         
1206         sys.stderr.write("Changing baudrate to %d ...\n" % baudrate)
1207         sys.stderr.flush()
1208         self.bslTxRx(self.BSL_CHANGEBAUD,   #Command: change baudrate
1209                     a, l)                   #args are coded in adr and len
1210         time.sleep(0.010)                   #recomended delay
1211         self.serialport.setBaudrate(baudrate)
1212
1213     def actionReadBSLVersion(self):
1214         """informational output of BSL version number.
1215         (newer MSP430-BSLs only)"""
1216         ans = self.bslTxRx(self.BSL_TXVERSION, 0) #Command: receive version info
1217         #the following values are in big endian style!!!
1218         family_type, bsl_version = struct.unpack(">H8xH4x", ans[:-2]) #cut away checksum and extract data
1219         print "Device Type: 0x%04x\nBSL version: 0x%04x\n" % (family_type, bsl_version)
1220
1221
1222 def usage():
1223     """print some help message"""
1224     sys.stderr.write("""
1225 USAGE: %s [options] [file]
1226 Version: %s
1227
1228 If "-" is specified as file the data is read from the stdinput.
1229 A file ending with ".txt" is considered to be in TIText format,
1230 '.a43' and '.hex' as IntelHex and all other filenames are
1231 considered as ELF files.
1232
1233 General options:
1234   -h, --help            Show this help screen.
1235   -c, --comport=port    Specify the communication port to be used.
1236                         (Default is 0)
1237                                 0->COM1 / ttyS0
1238                                 1->COM2 / ttyS1
1239                                 etc.
1240   -P, --password=file   Specify a file with the interrupt vectors that
1241                         are used as password. This can be any file that
1242                         has previously been used to program the device.
1243                         (e.g. -P INT_VECT.TXT).
1244   -f, --framesize=num   Max. number of data bytes within one transmitted
1245                         frame (16 to 240 in steps of 16) (e.g. -f 240).
1246   -m, --erasecycles=num Number of mass erase cycles (default is 1). Some
1247                         old F149 devices need additional erase cycles.
1248                         On newer devices it is no longer needed. (e.g. for
1249                         an old F149: -m20)
1250   -U, --unpatched       Do not download the BSL patch, even when it is
1251                         needed. This is used when a program is downloaded
1252                         into RAM and executed from there (and where flash
1253                         programming is not needed.)
1254   -D, --debug           Increase level of debug messages. This won't be
1255                         very useful for the average user...
1256   -I, --intelhex        Force fileformat to IntelHex
1257   -T, --titext          Force fileformat to be TIText
1258   -N, --notimeout       Don't use timeout on serial port (use with care)
1259   -B, --bsl=bsl.txt     Load and use new BSL from the TI Text file
1260   -S, --speed=baud      Reconfigure speed, only possible with newer
1261                         MSP403-BSL versions (>1.5, read slaa089a.pdf for
1262                         details). If the --bsl option is not used, an
1263                         internal BSL replacement will be loaded.
1264                         Needs a target with at least 2kB RAM!
1265                         Possible values are 9600, 19200, 38400
1266                         (default 9600)
1267   -1, --f1x             Specify CPU family, in case autodetect fails
1268   -2, --f2x             Specify CPU family, in case autodetect fails
1269   -4, --f4x             Specify CPU family, in case autodetect fails
1270                         --F1x and --f2x are only needed when the "change
1271                         baudrate" feature is used and the autodetect feature
1272                         fails. If the device ID that is uploaded is known, it
1273                         has precedence to the command line option.
1274   --invert-reset        Invert signal on RST pin (used for some BSL hardware)
1275   --invert-test         Invert signal on TEST/TCK pin (used for some BSL
1276                         hardware)
1277   --swap-reset-test     Swap the RST and TEST pins (used for some BSL hardware)
1278   --telos-latch         Special twiddle in BSL reset for Telos hardware
1279   --telos-i2c           DTR/RTS map via an I2C switch to TCK/RST in Telos Rev.B
1280   --telos               Implies options --invert-reset, --invert-test, 
1281                         --swap-reset-test, and --telos-latch
1282   --telosb              Implies options --swap-reset-test, --telos-i2c,
1283                         --no-BSL-download, and --speed=38400
1284   --goodfet10
1285   --goodfet20
1286   --goodfet30
1287   --tmote               Identical operation to --telosb
1288   --no-BSL-download     Do not download replacement BSL (disable automatic)
1289   --force-BSL-download  Download replacement BSL even if not needed (the one
1290                         in the device would have the required features)
1291   --slow                Add delays when operating the conrol pins. Useful if
1292                         the pins/circuit has high capacitance.
1293
1294 Program Flow Specifiers:
1295   -e, --masserase       Mass Erase (clear all flash memory)
1296   -E, --erasecheck      Erase Check by file
1297   -p, --program         Program file
1298   -v, --verify          Verify by file
1299
1300 The order of the above options matters! The table is ordered by normal
1301 execution order. For the options "Epv" a file must be specified.
1302 Program flow specifiers default to "pvr" if a file is given.
1303 Don't forget to specify "e" or "eE" when programming flash!
1304
1305 Data retreiving:
1306   -u, --upload=addr     Upload a datablock (see also: -s).
1307   -s, --size=num        Size of the data block do upload. (Default is 2)
1308   -x, --hex             Show a hexadecimal display of the uploaded data.
1309                         (Default)
1310   -b, --bin             Get binary uploaded data. This can be used
1311                         to redirect the output into a file.
1312
1313 Do before exit:
1314   -g, --go=address      Start programm execution at specified address.
1315                         This implies option --wait.
1316   -r, --reset           Reset connected MSP430. Starts application.
1317                         This is a normal device reset and will start
1318                         the programm that is specified in the reset
1319                         vector. (see also -g)
1320   -w, --wait            Wait for <ENTER> before closing serial port.
1321
1322 If it says "NAK received" it's probably because you specified no or a
1323 wrong password.
1324 """ % (sys.argv[0], VERSION))
1325
1326 #add some arguments to a function, but don't call it yet, instead return
1327 #a wrapper object for later invocation
1328 class curry:
1329     """create a callable with some arguments specified in advance"""
1330     def __init__(self, fun, *args, **kwargs):
1331         self.fun = fun
1332         self.pending = args[:]
1333         self.kwargs = kwargs.copy()
1334
1335     def __call__(self, *args, **kwargs):
1336         if kwargs and self.kwargs:
1337             kw = self.kwargs.copy()
1338             kw.update(kwargs)
1339         else:
1340             kw = kwargs or self.kwargs
1341         return apply(self.fun, self.pending + args, kw)
1342
1343     def __repr__(self):
1344         #first try if it a function
1345         try:
1346             return "curry(%s, %r, %r)" % (self.fun.func_name, self.pending, self.kwargs)
1347         except AttributeError:
1348             #fallback for callable classes
1349             return "curry(%s, %r, %r)" % (self.fun, self.pending, self.kwargs)
1350
1351 def hexify(line, bytes, width=16):
1352     return  '%04x  %s%s %s' % (
1353         line,
1354         ('%02x '*len(bytes)) % tuple(bytes),
1355         '   '* (width-len(bytes)),
1356         ('%c'*len(bytes)) % tuple(map(lambda x: (x>=32 and x<127) and x or ord('.'), bytes))
1357         )
1358
1359 #Main:
1360 def main(itest=1):
1361     global DEBUG
1362     import getopt
1363     filetype    = None
1364     filename    = None
1365     comPort     = None     #Default setting.
1366     speed       = None
1367     unpatched   = 0
1368     reset       = 0
1369     wait        = 0     #wait at the end
1370     goaddr      = None
1371     bsl         = BootStrapLoader()
1372     toinit      = []
1373     todo        = []
1374     startaddr   = None
1375     size        = 2
1376     hexoutput   = 1
1377     notimeout   = 0
1378     bslrepl     = None
1379     mayuseBSL   = 1
1380     forceBSL    = 0
1381     dumpivt     = 0
1382     dumpinfo    = 0
1383     
1384     bsl.invertRST = 1
1385     bsl.invertTEST = itest
1386     
1387     if comPort is None and os.environ.get("GOODFET")!=None:
1388         glob_list = glob.glob(os.environ.get("GOODFET"));
1389         if len(glob_list) > 0:
1390             comPort = glob_list[0];
1391     if comPort is None:
1392         glob_list = glob.glob("/dev/tty.usbserial*");
1393         if len(glob_list) > 0:
1394             comPort = glob_list[0];
1395     if comPort is None:
1396         glob_list = glob.glob("/dev/ttyUSB*");
1397         if len(glob_list) > 0:
1398             comPort = glob_list[0];
1399     
1400     
1401     sys.stderr.write("MSP430 Bootstrap Loader Version: %s\n" % VERSION)
1402
1403     try:
1404         opts, args = getopt.getopt(sys.argv[1:],
1405             "hc:P:wf:m:eEpvrg:UDudsxbITNB:S:V14",
1406             ["help", "comport=", "password=", "wait", "framesize=",
1407              "erasecycles=", "masserase", "erasecheck", "program",
1408              "verify", "reset", "go=", "unpatched", "debug",
1409              "upload=", "download=", "size=", "hex", "bin",
1410              "intelhex", "titext", "notimeout", "bsl=", "speed=",
1411              "bslversion", "f1x", "f2x", "f4x", "invert-reset", "invert-test",
1412              "swap-reset-test", "telos-latch", "telos-i2c", "telos", "telosb",
1413              "tmote","no-BSL-download", "force-BSL-download", "slow",
1414              "dumpivt", "dumpinfo", "fromweb",
1415         "goodfet30", "goodfet20", "goodfet10"
1416         ]
1417         )
1418     except getopt.GetoptError:
1419         # print help information and exit:
1420         usage()
1421         sys.exit(2)
1422
1423     for o, a in opts:
1424         if o in ("-h", "--help"):
1425             usage()
1426             sys.exit()
1427         elif o in ("-c", "--comport"):
1428             try:
1429                 comPort = int(a)                    #try to convert decimal
1430             except ValueError:
1431                 comPort = a                         #take the string and let serial driver decide
1432         elif o in ("-P", "--password"):
1433             #extract password from file
1434             bsl.passwd = Memory(a).getMemrange(0xffe0, 0xffff)
1435         elif o in ("-w", "--wait"):
1436             wait = 1
1437         elif o in ("--dumpivt"):
1438             dumpivt=1;
1439         elif o in ("--dumpinfo"):
1440             dumpinfo=1;
1441         elif o in ("-f", "--framesize"):
1442             try:
1443                 maxData = int(a)                    #try to convert decimal
1444             except ValueError:
1445                 sys.stderr.write("framesize must be a valid number\n")
1446                 sys.exit(2)
1447             #Make sure that conditions for maxData are met:
1448             #( >= 16 and == n*16 and <= MAX_DATA_BYTES!)
1449             if maxData > BootStrapLoader.MAX_DATA_BYTES:
1450                 maxData = BootStrapLoader.MAX_DATA_BYTES
1451             elif maxData < 16:
1452                 maxData = 16
1453             bsl.maxData = maxData - (maxData % 16)
1454             sys.stderr.write( "Max. number of data bytes within one frame set to %i.\n" % maxData)
1455         elif o in ("-m", "--erasecycles"):
1456             try:
1457                 meraseCycles = int(a)               #try to convert decimal
1458             except ValueError:
1459                 sys.stderr.write("erasecycles must be a valid number\n")
1460                 sys.exit(2)
1461             #sanity check of value
1462             if meraseCycles < 1:
1463                 sys.stderr.write("erasecycles must be a positive number\n")
1464                 sys.exit(2)
1465             if meraseCycles > 20:
1466                 sys.stderr.write("warning: erasecycles set to a large number (>20): %d\n" % meraseCycles)
1467             sys.stderr.write( "Number of mass erase cycles set to %i.\n" % meraseCycles)
1468             bsl.meraseCycles = meraseCycles
1469         elif o in ("-e", "--masserase"):
1470             toinit.append(bsl.actionMassErase)        #Erase Flash
1471         elif o in ("-E", "--erasecheck"):
1472             toinit.append(bsl.actionEraseCheck)       #Erase Check (by file)
1473         elif o in ("-p", "--program"):
1474             todo.append(bsl.actionProgram)          #Program file
1475         elif o in ("--fromweb"):
1476             toinit.append(bsl.actionMassErase)        #Erase Flash
1477             todo.append(bsl.actionFromweb)          #Program GoodFET code
1478         elif o in ("-v", "--verify"):
1479             todo.append(bsl.actionVerify)           #Verify file
1480         elif o in ("-r", "--reset"):
1481             reset = 1
1482         elif o in ("-g", "--go"):
1483             try:
1484                 goaddr = int(a)                    #try to convert decimal
1485             except ValueError:
1486                 try:
1487                     goaddr = int(a[2:],16)         #try to convert hex
1488                 except ValueError:
1489                     sys.stderr.write("go address must be a valid number\n")
1490                     sys.exit(2)
1491             wait = 1
1492         elif o in ("-U", "--unpatched"):
1493             unpatched = 1
1494         elif o in ("-D", "--debug"):
1495             DEBUG = DEBUG + 1
1496         elif o in ("-u", "--upload"):
1497             try:
1498                 startaddr = int(a)                  #try to convert decimal
1499             except ValueError:
1500                 try:
1501                     startaddr = int(a,16)           #try to convert hex
1502                 except ValueError:
1503                     sys.stderr.write("upload address must be a valid number\n")
1504                     sys.exit(2)
1505         elif o in ("-s", "--size"):
1506             try:
1507                 size = int(a)
1508             except ValueError:
1509                 try:
1510                     size = int(a,16)
1511                 except ValueError:
1512                     sys.stderr.write("size must be a valid number\n")
1513                     sys.exit(2)
1514         elif o in ("-x", "--hex"):
1515             hexoutput = 1
1516         elif o in ("-b", "--bin"):
1517             hexoutput = 0
1518         elif o in ("-I", "--intelhex"):
1519             filetype = 0
1520         elif o in ("-T", "--titext"):
1521             filetype = 1
1522         elif o in ("-N", "--notimeout"):
1523             notimeout = 1
1524         elif o in ("-B", "--bsl"):
1525             bslrepl = Memory() #File to program
1526             bslrepl.loadFile(a)
1527         elif o in ("-V", "--bslversion"):
1528             todo.append(bsl.actionReadBSLVersion) #load replacement BSL as first item
1529         elif o in ("-S", "--speed"):
1530             try:
1531                 speed = int(a)                    #try to convert decimal
1532             except ValueError:
1533                 sys.stderr.write("speed must be decimal number\n")
1534                 sys.exit(2)
1535         elif o in ("-1", "--f1x"):
1536             bsl.cpu = F1x
1537         elif o in ("-2", "--f2x"):
1538             bsl.cpu = F2x
1539         elif o in ("-4", "--f4x"):
1540             bsl.cpu = F4x
1541         elif o in ("--invert-reset", ):
1542             bsl.invertRST = 1
1543         elif o in ("--invert-test", ):
1544             bsl.invertTEST = 1
1545         elif o in ("--swap-reset-test", ):
1546             bsl.swapRSTTEST = 1
1547         elif o in ("--telos-latch", ):
1548             bsl.telosLatch = 1
1549         elif o in ("--telos-i2c", ):
1550             bsl.telosI2C = 1
1551         elif o in ("--telos", ):
1552             bsl.invertRST = 1
1553             bsl.invertTEST = 1
1554             bsl.swapRSTTEST = 1
1555             bsl.telosLatch = 1
1556         elif o in ("--goodfet10", ):
1557             bsl.invertRST = 1
1558             bsl.invertTEST = 1
1559         elif o in ("--goodfet20", ):
1560             bsl.invertRST = 1
1561             bsl.invertTEST = 1
1562         elif o in ("--goodfet30", ):
1563             bsl.invertRST = 1
1564             bsl.invertTEST = 0
1565         elif o in ("--telosb", ):
1566             bsl.swapRSTTEST = 1
1567             bsl.telosI2C = 1
1568             mayuseBSL = 0
1569             speed = 38400
1570         elif o in ("--tmote", ):
1571             bsl.swapRSTTEST = 1
1572             bsl.telosI2C = 1
1573             mayuseBSL = 0
1574             speed = 38400
1575         elif o in ("--no-BSL-download", ):
1576             mayuseBSL = 0
1577         elif o in ("--force-BSL-download", ):
1578             forceBSL = 1
1579         elif o in ("--slow", ):
1580             bsl.slowmode = 1
1581
1582     if len(args) == 0:
1583         sys.stderr.write("Use -h for help\n");
1584         sys.stderr.write("Use --fromweb to upgrade a GoodFET.\n")
1585     elif len(args) == 1:                            #a filename is given
1586         if not todo:                                #if there are no actions yet
1587             todo.extend([                           #add some useful actions...
1588                 bsl.actionProgram,
1589                 bsl.actionVerify,
1590             ])
1591         filename = args[0]
1592     else:                                           #number of args is wrong
1593         usage()
1594         sys.exit(2)
1595
1596     if DEBUG:   #debug infos
1597         sys.stderr.write("Debug level set to %d\n" % DEBUG)
1598         sys.stderr.write("Python version: %s\n" % sys.version)
1599
1600     #sanity check of options
1601     if notimeout and goaddr is not None and startaddr is not None:
1602         sys.stderr.write("Option --notimeout can not be used together with both --upload and --go\n")
1603         sys.exit(1)
1604
1605     if notimeout:
1606         sys.stderr.write("Warning: option --notimeout can cause improper function in some cases!\n")
1607         bsl.timeout = 0
1608
1609     if goaddr and reset:
1610         sys.stderr.write("Warning: option --reset ignored as --go is specified!\n")
1611         reset = 0
1612
1613     if startaddr and reset:
1614         sys.stderr.write("Warning: option --reset ignored as --upload is specified!\n")
1615         reset = 0
1616
1617     sys.stderr.flush()
1618     
1619     #prepare data to download
1620     bsl.data = Memory()                             #prepare downloaded data
1621     if filetype is not None:                        #if the filetype is given...
1622         if filename is None:
1623             raise ValueError("no filename but filetype specified")
1624         if filename == '-':                         #get data from stdin
1625             file = sys.stdin
1626         else:
1627             file = open(filename, "rb")             #or from a file
1628         if filetype == 0:                           #select load function
1629             bsl.data.loadIHex(file)                 #intel hex
1630         elif filetype == 1:
1631             bsl.data.loadTIText(file)               #TI's format
1632         else:
1633             raise ValueError("illegal filetype specified")
1634     else:                                           #no filetype given...
1635         if filename == '-':                         #for stdin:
1636             bsl.data.loadIHex(sys.stdin)            #assume intel hex
1637         elif filename:
1638             bsl.data.loadFile(filename)             #autodetect otherwise
1639
1640     if DEBUG > 3: sys.stderr.write("File: %r" % filename)
1641
1642     bsl.comInit(comPort)                            #init port
1643
1644     #initialization list
1645     if toinit:  #erase and erase check
1646         if DEBUG: sys.stderr.write("Preparing device ...\n")
1647         #bsl.actionStartBSL(usepatch=0, adjsp=0)     #no workarounds needed
1648         #if speed: bsl.actionChangeBaudrate(speed)   #change baud rate as fast as possible
1649         for f in toinit: f()
1650
1651     if todo or goaddr or startaddr:
1652         if DEBUG: sys.stderr.write("Actions ...\n")
1653         #connect to the BSL
1654         bsl.actionStartBSL(
1655             usepatch=not unpatched,
1656             replacementBSL=bslrepl,
1657             forceBSL=forceBSL,
1658             mayuseBSL=mayuseBSL,
1659             speed=speed,
1660         )
1661
1662     #work list
1663     if todo:
1664         if DEBUG > 0:       #debug
1665             #show a nice list of sheduled actions
1666             sys.stderr.write("TODO list:\n")
1667             for f in todo:
1668                 try:
1669                     sys.stderr.write("   %s\n" % f.func_name)
1670                 except AttributeError:
1671                     sys.stderr.write("   %r\n" % f)
1672         for f in todo: f()                          #work through todo list
1673
1674     if reset:                                       #reset device first if desired
1675         bsl.actionReset()
1676     if dumpivt:
1677         bsl.txPasswd(); #default pass
1678         data=bsl.uploadData(0xc00,1024);
1679         hex="";
1680         for c in data:
1681             hex+=("%02x "%ord(c));
1682         print hex;
1683     if dumpinfo:
1684         bsl.txPasswd(); #default pass
1685         data=bsl.uploadData(0x1000,256);
1686         hex="@1000\n";
1687         for c in data:
1688             hex+=("%02x "%ord(c));
1689         hex+="\nq\n";
1690         print hex;
1691     
1692     if goaddr is not None:                          #start user programm at specified address
1693         bsl.actionRun(goaddr)                       #load PC and execute
1694
1695     #upload datablock and output
1696     if startaddr is not None:
1697         if goaddr:                                  #if a program was started...
1698             #don't restart BSL but wait for the device to enter it itself
1699             sys.stderr.write("Waiting for device to reconnect for upload: ")
1700             sys.stderr.flush()
1701             bsl.txPasswd(bsl.passwd, wait=1)        #synchronize, try forever...
1702             data = bsl.uploadData(startaddr, size)  #upload data
1703         else:
1704             data = bsl.uploadData(startaddr, size)  #upload data
1705         if hexoutput:                               #depending on output format
1706             m = 0
1707             while m < len(data):                    #print a hex display
1708                 print hexify(startaddr+m, map(ord,data[m:m+16]))
1709                 m = m + 16
1710         else:
1711             sys.stdout.write(data)                  #binary output w/o newline!
1712         wait = 0    #wait makes no sense as after the upload the device is still in BSL
1713
1714     if wait:                                        #wait at the end if desired
1715         sys.stderr.write("Press <ENTER> ...\n")     #display a prompt
1716         sys.stderr.flush()
1717         raw_input()                                 #wait for newline
1718
1719     bsl.comDone()           #Release serial communication port
1720
1721 if __name__ == '__main__':
1722     try:
1723         main(1)
1724     except SystemExit:
1725         raise               #let pass exit() calls
1726     except KeyboardInterrupt:
1727         if DEBUG: raise     #show full trace in debug mode
1728         sys.stderr.write("user abort.\n")   #short messy in user mode
1729         sys.exit(1)         #set errorlevel for script usage
1730     except Exception, msg:  #every Exception is caught and displayed
1731         if DEBUG: raise     #show full trace in debug mode
1732         #sys.stderr.write("\nAn error occoured:\n%s\n" % msg) #short messy in user mode
1733         #sys.exit(1)         #set errorlevel for script usage
1734         main(0);