2 # Serial Bootstrap Loader software for the MSP430 embedded proccessor.
4 # (C) 2001-2003 Chris Liechti <cliechti@gmx.net>
5 # this is distributed under a free software license, see license-bsl.txt
7 # fixes from Colin Domoney
9 # based on the application note slas96b.pdf from Texas Instruments, Inc.,
11 # additional infos from slaa089a.pdf
13 # Forked by Travis Goodspeed <travis at tnbelt.com> for use with the GoodFET
16 import sys, time, string, cStringIO, struct
17 sys.path.append("/usr/lib/tinyos")
18 import serial, os, glob
20 #forked from TinyOS Telos version.
21 VERSION = string.split("Revision: 1.39-goodfet-8 ")[1]
23 DEBUG = 0 #disable debug messages by default
25 #copy of the patch file provided by TI
26 #this part is (C) by Texas Instruments
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
44 #These BSL's are (C) by TI. They come with the application note slaa089a
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
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
187 #cpu types for "change baudrate"
188 #use strings as ID so that they can be used in outputs too
196 0xf16c: F1x, #for GoodFET10 to '20
202 0xf26f: F2x, #for GoodFET20
203 0xf227: F2x, #for GoodFET30
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"
213 class BSLException(Exception):
217 "lowlevel communication"
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
232 #Upper limit of address range that might be modified by
234 BSL_CRITICAL_ADDR = 0x0A00
243 QUERY_RESPONSE = 0x50
245 OPEN_CONNECTION = 0xC0
246 ACK_CONNECTION = 0x40
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."
264 def calcChecksum(self, data, length):
265 """Calculates a checksum of "data"."""
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
272 def __init__(self, aTimeout = None, aProlongFactor = None):
273 """init bsl object, don't connect yet"""
275 self.timeout = self.DEFAULT_TIMEOUT
277 self.timeout = aTimeout
278 if aProlongFactor is None:
279 self.prolongFactor = self.DEFAULT_PROLONG
281 self.prolongFactor = aProlongFactor
283 #flags for inverted use of control pins
284 #used for some hardware
291 self.protocolMode = self.MODE_BSL
292 self.BSLMemAccessWarning = 0 #Default: no warning.
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")
307 # Startup-Baudrate: 9600,8,E,1, 1s timeout
308 self.serialport = serial.Serial(
311 parity = serial.PARITY_EVEN,
312 timeout = self.timeout
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()
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()
331 def comRxHeader(self):
332 """receive header and split data"""
333 if DEBUG > 1: sys.stderr.write("* comRxHeader()\n")
335 hdr = self.serialport.read(1)
336 if not hdr: raise BSLException("Timeout")
337 rxHeader = ord(hdr) & 0xf0;
338 rxNum = ord(hdr) & 0x0f;
340 if self.protocolMode == self.MODE_BSL:
344 if DEBUG > 1: sys.stderr.write("* comRxHeader() OK\n")
345 return rxHeader, rxNum
347 def comRxFrame(self, rxNum):
348 if DEBUG > 1: sys.stderr.write("* comRxFrame()\n")
349 rxFrame = chr(self.DATA_FRAME | rxNum)
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
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)
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")
374 if DEBUG: sys.stderr.write(" comRxFrame() Checksum wrong\n")
376 if DEBUG: sys.stderr.write(" comRxFrame() Header corrupt %r" % rxFrame)
377 raise BSLException(self.ERR_COM) #Frame has errors!
379 def comTxHeader(self, txHeader):
381 if DEBUG > 1: sys.stderr.write("* txHeader()\n")
382 self.serialport.write(txHeader)
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")
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
404 dataOut.append(0) #fill with zero
406 txFrame = "%c%c%c%c" % (self.DATA_FRAME | self.seqNo, cmd, len(dataOut), len(dataOut))
408 self.reqNo = (self.seqNo + 1) % self.MAX_FRAME_COUNT
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)
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))
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!).
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
427 if DEBUG > 1: sys.stderr.write( " comTxRx() transmit OK\n")
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)
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)
452 raise BSLException("Unknown header 0x%02x\nAre you downloading to RAM into an old device that requires the patch? Try option -U" % rxHeader)
454 def SetDTR(self, level, invert):
455 """Controls DTR pin (0: GND; 1: VCC; unless inverted flag is set)"""
457 self.serialport.setDTR(not level)
459 self.serialport.setDTR(level)
463 def SetRTS(self, level, invert):
464 """Controls RTS pin (0: GND; 1: VCC; unless inverted flag is set)"""
466 self.serialport.setRTS(not level)
468 self.serialport.setRTS(level)
472 def SetRSTpin(self, level=1):
473 """Controls RST/NMI pin (0: GND; 1: VCC; unless inverted flag is set)"""
475 self.SetRTS(level, self.invertRST)
477 self.SetDTR(level, self.invertRST)
479 def SetTESTpin(self, level=1):
480 """Controls TEST pin (inverted on board: 0: VCC; 1: GND; unless inverted flag is set)"""
482 self.SetDTR(level, self.invertTEST)
484 self.SetRTS(level, self.invertTEST)
486 def telosSetSCL(self, level):
487 self.serialport.setRTS(not level)
489 def telosSetSDA(self, level):
490 self.serialport.setDTR(not level)
492 def telosI2CStart(self):
497 def telosI2CStop(self):
502 def telosI2CWriteBit(self, bit):
504 self.telosSetSDA(bit)
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"
521 def telosI2CWriteCmd(self, addr, cmdbyte):
523 self.telosI2CWriteByte( 0x90 | (addr << 1) )
524 self.telosI2CWriteByte( cmdbyte )
527 def telosBReset(self,invokeBSL=0):
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
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
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)
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
553 def bslReset(self, invokeBSL=0):
554 """Applies BSL entry sequence on RST/NMI and TEST/VPP pins
556 invokeBSL = 1: complete sequence
557 invokeBSL = 0: only RST/NMI pin accessed
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"""
563 self.telosBReset(invokeBSL)
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
576 self.SetRSTpin(0) #RST pin: GND
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
585 self.SetRSTpin(1) #RST pin: Vcc
586 time.sleep(0.250) #give MSP430's oscillator time to stabilize
588 self.serialport.flushInput() #clear buffers
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).
595 loopcnt = 5 #Max. tries to get synchronization
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
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
610 sys.stderr.write(" bslSync() timeout, retry ...\n")
612 #nmi may have caused the first reset to be ignored, try again
617 sys.stderr.write(" bslSync() timeout, retry ...\n")
620 sys.stderr.write(" bslSync() timeout\n")
622 if DEBUG > 1: sys.stderr.write(" bslSync() failed (0x%02x), retry ...\n" % ord(c))
624 raise BSLException(self.ERR_BSL_SYNC) #Sync. failed
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
632 Parameters return by boot loader are passed via blkin.
634 if DEBUG > 1: sys.stderr.write("* bslTxRx()\n")
636 if cmd == self.BSL_TXBLK:
637 #Align to even start address
639 addr = addr - 1 #Decrement address and
640 blkout = chr(0xFF) + blkOut #fill first byte of blkout with 0xFF
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
647 elif cmd == self.BSL_RXBLK:
648 #Align to even start address
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:
656 #if cmd == self.BSL_TXBLK or cmd == self.BSL_TXPWORD:
659 #Add necessary information data to frame
660 dataOut = struct.pack("<HH", addr, length)
662 if blkout: #Copy data out of blkout into frame
663 dataOut = dataOut + blkout
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]
674 """store a string with memory contents along with its startaddress"""
675 def __init__(self, startaddress = 0, data=None):
680 self.startaddress = startaddress
682 def __getitem__(self, index):
683 return self.data[index]
686 return len(self.data)
689 return "Segment(startaddress = 0x%04x, data=%r)" % (self.startaddress, self.data)
692 """represent memory contents. with functions to load files"""
693 def __init__(self, filename=None):
696 self.filename = filename
697 self.loadFile(filename)
699 def append(self, seg):
700 self.segments.append(seg)
702 def __getitem__(self, index):
703 return self.segments[index]
706 return len(self.segments)
708 def loadIHex(self, file):
709 """load data from a (opened) file in Intel-HEX format"""
713 lines = file.readlines()
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)
722 if currentAddr != address:
724 self.segments.append( Segment(startAddr, string.join(segmentdata,'')) )
725 startAddr = currentAddr = address
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):
733 sys.stderr.write("Ignored unknown field (type 0x%02x) in ihex file.\n" % type)
735 self.segments.append( Segment(startAddr, string.join(segmentdata,'')) )
737 def loadTIText(self, file):
738 """load data from a (opened) file in TI-Text format"""
742 #Convert data for MSP430, TXT-File is parsed line by line
748 if l[0] == 'q': break
749 elif l[0] == '@': #if @ => new address => send frame and set new addr.
750 #create a new segment
752 self.segments.append( Segment(startAddr, string.join(segmentdata,'')) )
753 startAddr = int(l[1:],16)
756 for i in string.split(l):
757 segmentdata.append(chr(int(i,16)))
759 self.segments.append( Segment(startAddr, string.join(segmentdata,'')) )
761 def loadELF(self, file):
762 """load data from a (opened) file in ELF object format.
763 File must be seekable"""
765 obj = elf.ELFObject()
767 if obj.e_type != elf.ELFObject.ET_EXEC:
768 raise Exception("No executable")
769 for section in obj.getSections():
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) )
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"))
783 self.loadELF(open(filename, "rb"))
785 def getMemrange(self, fromadr, toadr):
786 """get a range of bytes from the memory. unavailable values are filled with 0xff."""
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:
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
801 catchlength = toadr-fromadr
804 res = res + seg.data[fromadr-seg.startaddress : fromadr-seg.startaddress+catchlength]
805 fromadr = fromadr + catchlength #adjust start
806 if len(res) >= toadr-fromadr:
810 fromadr = fromadr + 1 #adjust start
812 #print "res: %r" % res
816 class BootStrapLoader(LowLevel):
817 """higher level Bootstrap Loader functions."""
819 ERR_VERIFY_FAILED = "Error: verification failed"
820 ERR_ERASE_CHECK_FAILED = "Error: erase check failed"
822 ACTION_PROGRAM = 0x01 #Mask: program data
823 ACTION_VERIFY = 0x02 #Mask: verify data
824 ACTION_ERASE_CHECK = 0x04 #Mask: erase check
826 #Max. bytes sent within one frame if parsing a TI TXT file.
827 #( >= 16 and == n*16 and <= MAX_DATA_BYTES!)
831 def __init__(self, *args, **kargs):
832 LowLevel.__init__(self, *args, **kargs)
834 self.meraseCycles = 1
835 self.patchRequired = 0
840 self.maxData = self.MAXDATA
844 def preparePatch(self):
845 """prepare to download patch"""
846 if DEBUG > 1: sys.stderr.write("* preparePatch()\n")
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
857 """setup after the patch is loaded"""
858 if DEBUG > 1: sys.stderr.write("* postPatch()\n")
860 self.BSLMemAccessWarning = 1 #Turn warning back on.
863 def verifyBlk(self, addr, blkout, action):
864 """verify memory against data or 0xff"""
865 if DEBUG > 1: sys.stderr.write("* verifyBlk()\n")
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)))
871 blkin = self.bslTxRx(self.BSL_RXBLK, addr, len(blkout))
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])))
880 raise BSLException(self.ERR_VERIFY_FAILED) #Verify failed!
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])))
887 raise BSLException(self.ERR_ERASE_CHECK_FAILED) #Erase Check failed!
889 def readBlk(self,adr,len):
890 """Read a block of memory."""
891 blkin = self.bslTxRx(self.BSL_RXBLK, addr, len(blkout))
893 def programBlk(self, addr, blkout, action):
894 """program a memory block"""
895 if DEBUG > 1: sys.stderr.write("* programBlk()\n")
897 #Check, if specified range is erased
898 self.verifyBlk(addr, blkout, action & self.ACTION_ERASE_CHECK)
900 if action & self.ACTION_PROGRAM:
901 if DEBUG: sys.stderr.write(" Program starting at 0x%04x, %i bytes ...\n" % (addr, len(blkout)))
904 self.bslTxRx(self.BSL_TXBLK, addr, len(blkout), blkout)
908 self.verifyBlk(addr, blkout, action & self.ACTION_VERIFY)
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")
917 currentAddr = seg.startaddress
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
928 def uploadData(self, startaddress, size, wait=0):
929 """upload a datablock"""
930 if DEBUG > 1: sys.stderr.write("* uploadData()\n")
934 length = self.maxData
935 if pstart+length > size:
936 length = size - pstart
937 data = data + self.bslTxRx(self.BSL_RXBLK,
940 wait=wait)[:-2] #cut away checksum
941 pstart = pstart + length
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)
948 #Send "standard" password to get access to protected functions.
949 sys.stderr.write("Transmit default password ...\n")
951 #Flash is completely erased, the contents of all Flash cells is 0xff
952 passwd = chr(0xff)*32
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')
960 self.bslTxRx(self.BSL_TXPWORD, #Command: Transmit Password
961 0xffe0, #Address of interupt vectors
962 0x0020, #Number of bytes
964 wait=wait) #if wait is 1, try to sync forever
967 #-----------------------------------------------------------------
969 def actionMassErase(self):
970 """Erase the flash memory completely (with mass erase command)"""
971 sys.stderr.write("Mass Erase...\n")
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.
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")
989 self.bslReset(1) #Invoke the boot loader.
990 self.txPasswd(self.passwd) #transmit password
992 #Read actual bootstrap loader version.
993 #sys.stderr.write("Reading BSL version ...\n")
994 blkin = self.bslTxRx(self.BSL_RXBLK, #Command: Read/Receive Block
995 0x0ff0, #Start address
996 16) #No. of bytes to read
997 dev_id, bslVerHi, bslVerLo = struct.unpack(">H8xBB4x", blkin[:-2]) #cut away checksum and extract data
1001 if self.cpu is None: #cpy type forced?
1002 if deviceids.has_key(dev_id):
1003 self.cpu = deviceids[dev_id] #try to autodectect CPU type
1006 sys.stderr.write("Autodetect successful: %04x -> %s\n" % (dev_id, self.cpu))
1008 sys.stderr.write("Autodetect failed! Unkown ID: %04x. Trying to continue anyway.\n" % dev_id)
1009 self.cpu = F1x #assume something and try anyway..
1011 sys.stderr.write("Current bootstrap loader version: %x.%x (Device ID: %04x)\n" % (bslVerHi, bslVerLo, dev_id))
1013 self.bslVer = (bslVerHi << 8) | bslVerLo
1015 if self.bslVer <= 0x0110: #check if patch is needed
1016 self.BSLMemAccessWarning = 1
1018 self.BSLMemAccessWarning = 0 #Fixed in newer versions of BSL.
1020 if self.bslVer <= 0x0130 and adjsp:
1021 #only do this on BSL where it's needed to prevent
1022 #malfunction with F4xx devices/ newer ROM-BSLs
1024 #Execute function within bootstrap loader
1025 #to prepare stack pointer for the following patch.
1026 #This function will lock the protected functions again.
1027 sys.stderr.write("Adjust SP. Load PC with 0x0C22 ...\n")
1028 self.bslTxRx(self.BSL_LOADPC, #Command: Load PC
1029 0x0C22) #Address to load into PC
1030 #Re-send password to re-gain access to protected functions.
1031 self.txPasswd(self.passwd)
1033 #get internal BSL replacement if needed or forced by the user
1034 #required if speed is set but an old BSL is in the device
1035 #if a BSL is given by the user, that one is used and not the internal one
1036 if ((mayuseBSL and speed and self.bslVer < 0x0150) or forceBSL) and replacementBSL is None:
1037 replacementBSL = Memory() #File to program
1040 sys.stderr.write("Using built in BSL replacement for F4x devices\n")
1042 replacementBSL.loadTIText(cStringIO.StringIO(F4X_BSL)) #parse embedded BSL
1045 sys.stderr.write("Using built in BSL replacement for F1x devices\n")
1047 replacementBSL.loadTIText(cStringIO.StringIO(F1X_BSL)) #parse embedded BSL
1049 #now download the new BSL, if allowed and needed (version lower than the
1050 #the replacement) or forced
1051 if replacementBSL is not None:
1052 self.actionDownloadBSL(replacementBSL)
1054 #debug message with the real BSL version in use (may have changed after replacement BSL)
1056 sys.stderr.write("Current bootstrap loader version: 0x%04x\n" % (self.bslVer,))
1059 #now apply workarounds or patches if BSL in use requires that
1060 if self.bslVer <= 0x0110: #check if patch is needed
1061 if usepatch: #test if patch is desired
1062 sys.stderr.write("Patch for flash programming required!\n")
1063 self.patchRequired = 1
1065 sys.stderr.write("Load and verify patch ...\n")
1067 #Programming and verification is done in one pass.
1068 #The patch file is only read and parsed once.
1069 segments = Memory() #data to program
1070 segments.loadTIText(cStringIO.StringIO(PATCH)) #parse embedded patch
1072 self.programData(segments, self.ACTION_PROGRAM | self.ACTION_VERIFY)
1073 self.patchLoaded = 1
1076 sys.stderr.write("Device needs patch, but not applied (usepatch is false).\n") #message if not patched
1078 #should the baudrate be changed?
1079 if speed is not None:
1080 self.actionChangeBaudrate(speed) #change baudrate
1082 def actionDownloadBSL(self, bslsegments):
1083 sys.stderr.write("Load new BSL into RAM...\n")
1085 self.programData(bslsegments, self.ACTION_PROGRAM)
1086 sys.stderr.write("Verify new BSL...\n")
1088 self.programData(bslsegments, self.ACTION_VERIFY) #File to verify
1090 #Read startvector of bootstrap loader
1091 #blkin = self.bslTxRx(self.BSL_RXBLK, 0x0300, 2)
1092 #blkin = self.bslTxRx(self.BSL_RXBLK, 0x0220, 2)
1093 blkin = self.bslTxRx(self.BSL_RXBLK, bslsegments[0].startaddress, 2)
1094 startaddr = struct.unpack("<H", blkin[:2])[0]
1096 sys.stderr.write("Starting new BSL at 0x%04x...\n" % startaddr)
1098 self.bslTxRx(self.BSL_LOADPC, #Command: Load PC
1099 startaddr) #Address to load into PC
1101 #BSL-Bugs should be fixed within "new" BSL
1102 self.BSLMemAccessWarning = 0
1103 self.patchRequired = 0
1104 self.patchLoaded = 0
1106 #Re-send password to re-gain access to protected functions.
1107 self.txPasswd(self.passwd)
1109 #update version info
1110 #verison only valid for the internal ones, but it also makes sure
1111 #that the patches are not applied if the user d/ls one
1112 self.bslVer = 0x0150
1114 def actionEraseCheck(self):
1115 """check the erasure of required flash cells."""
1116 sys.stderr.write("Erase Check by file ...\n")
1118 if self.data is not None:
1119 self.programData(self.data, self.ACTION_ERASE_CHECK)
1121 raise BSLException, "cannot do erase check against data with not knowing the actual data"
1123 def actionProgram(self):
1124 """program data into flash memory."""
1125 if self.data is not None:
1126 sys.stderr.write("Program ...\n")
1128 self.programData(self.data, self.ACTION_PROGRAM)
1129 sys.stderr.write("%i bytes programmed.\n" % self.byteCtr)
1132 raise BSLException, "programming without data not possible"
1133 def actionFromweb(self):
1134 """Grab GoodFET firmware from the web, then flash it."""
1135 print "Grabbing %x firmware." % self.dev_id;
1136 print "%s" % firmware[self.dev_id];
1137 fn="/tmp/.goodfet.hex"
1138 os.system("curl %s >%s" % (firmware[self.dev_id],fn))
1141 #fw.loadIhex(open(fn,"rb"));
1143 sys.stderr.write("Program ...\n")
1145 self.programData(fw, self.ACTION_PROGRAM | self.ACTION_VERIFY)
1146 sys.stderr.write("%i bytes programmed.\n" % self.byteCtr)
1149 def actionVerify(self):
1150 """Verify programmed data"""
1151 if self.data is not None:
1152 sys.stderr.write("Verify ...\n")
1154 self.programData(self.data, self.ACTION_VERIFY)
1156 raise BSLException, "verify without data not possible"
1158 def actionReset(self):
1159 """perform a reset, start user programm"""
1160 sys.stderr.write("Reset device ...\n")
1162 self.bslReset(0) #only reset
1164 def actionRun(self, address=0x220):
1165 """start program at specified address"""
1166 sys.stderr.write("Load PC with 0x%04x ...\n" % address)
1168 self.bslTxRx(self.BSL_LOADPC, #Command: Load PC
1169 address) #Address to load into PC
1171 #table with values from slaa089a.pdf
1174 9600:[0x8580, 0x0000],
1175 19200:[0x86e0, 0x0001],
1176 38400:[0x87e0, 0x0002],
1179 9600:[0x8580, 0x0000],
1180 19200:[0x8B00, 0x0001],
1181 38400:[0x8C80, 0x0002],
1184 9600:[0x9800, 0x0000],
1185 19200:[0xb000, 0x0001],
1186 38400:[0xc800, 0x0002],
1189 def actionChangeBaudrate(self, baudrate=9600):
1190 """change baudrate. first the command is sent, then the comm
1191 port is reprogrammed. only possible with newer MSP430-BSL versions.
1192 (ROM >=1.6, downloadable >=1.5)"""
1194 baudconfigs = self.bauratetable[self.cpu]
1196 raise ValueError, "unknown CPU type %s, can't switch baudrate" % self.cpu
1198 a,l = baudconfigs[baudrate]
1200 raise ValueError, "baudrate not valid. valid values are %r" % baudconfigs.keys()
1202 sys.stderr.write("Changing baudrate to %d ...\n" % baudrate)
1204 self.bslTxRx(self.BSL_CHANGEBAUD, #Command: change baudrate
1205 a, l) #args are coded in adr and len
1206 time.sleep(0.010) #recomended delay
1207 self.serialport.setBaudrate(baudrate)
1209 def actionReadBSLVersion(self):
1210 """informational output of BSL version number.
1211 (newer MSP430-BSLs only)"""
1212 ans = self.bslTxRx(self.BSL_TXVERSION, 0) #Command: receive version info
1213 #the following values are in big endian style!!!
1214 family_type, bsl_version = struct.unpack(">H8xH4x", ans[:-2]) #cut away checksum and extract data
1215 print "Device Type: 0x%04x\nBSL version: 0x%04x\n" % (family_type, bsl_version)
1219 """print some help message"""
1220 sys.stderr.write("""
1221 USAGE: %s [options] [file]
1224 If "-" is specified as file the data is read from the stdinput.
1225 A file ending with ".txt" is considered to be in TIText format,
1226 '.a43' and '.hex' as IntelHex and all other filenames are
1227 considered as ELF files.
1230 -h, --help Show this help screen.
1231 -c, --comport=port Specify the communication port to be used.
1236 -P, --password=file Specify a file with the interrupt vectors that
1237 are used as password. This can be any file that
1238 has previously been used to program the device.
1239 (e.g. -P INT_VECT.TXT).
1240 -f, --framesize=num Max. number of data bytes within one transmitted
1241 frame (16 to 240 in steps of 16) (e.g. -f 240).
1242 -m, --erasecycles=num Number of mass erase cycles (default is 1). Some
1243 old F149 devices need additional erase cycles.
1244 On newer devices it is no longer needed. (e.g. for
1246 -U, --unpatched Do not download the BSL patch, even when it is
1247 needed. This is used when a program is downloaded
1248 into RAM and executed from there (and where flash
1249 programming is not needed.)
1250 -D, --debug Increase level of debug messages. This won't be
1251 very useful for the average user...
1252 -I, --intelhex Force fileformat to IntelHex
1253 -T, --titext Force fileformat to be TIText
1254 -N, --notimeout Don't use timeout on serial port (use with care)
1255 -B, --bsl=bsl.txt Load and use new BSL from the TI Text file
1256 -S, --speed=baud Reconfigure speed, only possible with newer
1257 MSP403-BSL versions (>1.5, read slaa089a.pdf for
1258 details). If the --bsl option is not used, an
1259 internal BSL replacement will be loaded.
1260 Needs a target with at least 2kB RAM!
1261 Possible values are 9600, 19200, 38400
1263 -1, --f1x Specify CPU family, in case autodetect fails
1264 -2, --f2x Specify CPU family, in case autodetect fails
1265 -4, --f4x Specify CPU family, in case autodetect fails
1266 --F1x and --f2x are only needed when the "change
1267 baudrate" feature is used and the autodetect feature
1268 fails. If the device ID that is uploaded is known, it
1269 has precedence to the command line option.
1270 --invert-reset Invert signal on RST pin (used for some BSL hardware)
1271 --invert-test Invert signal on TEST/TCK pin (used for some BSL
1273 --swap-reset-test Swap the RST and TEST pins (used for some BSL hardware)
1274 --telos-latch Special twiddle in BSL reset for Telos hardware
1275 --telos-i2c DTR/RTS map via an I2C switch to TCK/RST in Telos Rev.B
1276 --telos Implies options --invert-reset, --invert-test,
1277 --swap-reset-test, and --telos-latch
1278 --telosb Implies options --swap-reset-test, --telos-i2c,
1279 --no-BSL-download, and --speed=38400
1283 --tmote Identical operation to --telosb
1284 --no-BSL-download Do not download replacement BSL (disable automatic)
1285 --force-BSL-download Download replacement BSL even if not needed (the one
1286 in the device would have the required features)
1287 --slow Add delays when operating the conrol pins. Useful if
1288 the pins/circuit has high capacitance.
1290 Program Flow Specifiers:
1291 -e, --masserase Mass Erase (clear all flash memory)
1292 -E, --erasecheck Erase Check by file
1293 -p, --program Program file
1294 -v, --verify Verify by file
1296 The order of the above options matters! The table is ordered by normal
1297 execution order. For the options "Epv" a file must be specified.
1298 Program flow specifiers default to "pvr" if a file is given.
1299 Don't forget to specify "e" or "eE" when programming flash!
1302 -u, --upload=addr Upload a datablock (see also: -s).
1303 -s, --size=num Size of the data block do upload. (Default is 2)
1304 -x, --hex Show a hexadecimal display of the uploaded data.
1306 -b, --bin Get binary uploaded data. This can be used
1307 to redirect the output into a file.
1310 -g, --go=address Start programm execution at specified address.
1311 This implies option --wait.
1312 -r, --reset Reset connected MSP430. Starts application.
1313 This is a normal device reset and will start
1314 the programm that is specified in the reset
1315 vector. (see also -g)
1316 -w, --wait Wait for <ENTER> before closing serial port.
1318 If it says "NAK received" it's probably because you specified no or a
1320 """ % (sys.argv[0], VERSION))
1322 #add some arguments to a function, but don't call it yet, instead return
1323 #a wrapper object for later invocation
1325 """create a callable with some arguments specified in advance"""
1326 def __init__(self, fun, *args, **kwargs):
1328 self.pending = args[:]
1329 self.kwargs = kwargs.copy()
1331 def __call__(self, *args, **kwargs):
1332 if kwargs and self.kwargs:
1333 kw = self.kwargs.copy()
1336 kw = kwargs or self.kwargs
1337 return apply(self.fun, self.pending + args, kw)
1340 #first try if it a function
1342 return "curry(%s, %r, %r)" % (self.fun.func_name, self.pending, self.kwargs)
1343 except AttributeError:
1344 #fallback for callable classes
1345 return "curry(%s, %r, %r)" % (self.fun, self.pending, self.kwargs)
1347 def hexify(line, bytes, width=16):
1348 return '%04x %s%s %s' % (
1350 ('%02x '*len(bytes)) % tuple(bytes),
1351 ' '* (width-len(bytes)),
1352 ('%c'*len(bytes)) % tuple(map(lambda x: (x>=32 and x<127) and x or ord('.'), bytes))
1361 comPort = None #Default setting.
1365 wait = 0 #wait at the end
1367 bsl = BootStrapLoader()
1383 if comPort is None and os.environ.get("GOODFET")!=None:
1384 glob_list = glob.glob(os.environ.get("GOODFET"));
1385 if len(glob_list) > 0:
1386 comPort = glob_list[0];
1388 glob_list = glob.glob("/dev/tty.usbserial*");
1389 if len(glob_list) > 0:
1390 comPort = glob_list[0];
1392 glob_list = glob.glob("/dev/ttyUSB*");
1393 if len(glob_list) > 0:
1394 comPort = glob_list[0];
1397 sys.stderr.write("MSP430 Bootstrap Loader Version: %s\n" % VERSION)
1400 opts, args = getopt.getopt(sys.argv[1:],
1401 "hc:P:wf:m:eEpvrg:UDudsxbITNB:S:V14",
1402 ["help", "comport=", "password=", "wait", "framesize=",
1403 "erasecycles=", "masserase", "erasecheck", "program",
1404 "verify", "reset", "go=", "unpatched", "debug",
1405 "upload=", "download=", "size=", "hex", "bin",
1406 "intelhex", "titext", "notimeout", "bsl=", "speed=",
1407 "bslversion", "f1x", "f2x", "f4x", "invert-reset", "invert-test",
1408 "swap-reset-test", "telos-latch", "telos-i2c", "telos", "telosb",
1409 "tmote","no-BSL-download", "force-BSL-download", "slow",
1410 "dumpivt", "dumpinfo", "fromweb",
1411 "goodfet30", "goodfet20", "goodfet10"
1414 except getopt.GetoptError:
1415 # print help information and exit:
1420 if o in ("-h", "--help"):
1423 elif o in ("-c", "--comport"):
1425 comPort = int(a) #try to convert decimal
1427 comPort = a #take the string and let serial driver decide
1428 elif o in ("-P", "--password"):
1429 #extract password from file
1430 bsl.passwd = Memory(a).getMemrange(0xffe0, 0xffff)
1431 elif o in ("-w", "--wait"):
1433 elif o in ("--dumpivt"):
1435 elif o in ("--dumpinfo"):
1437 elif o in ("-f", "--framesize"):
1439 maxData = int(a) #try to convert decimal
1441 sys.stderr.write("framesize must be a valid number\n")
1443 #Make sure that conditions for maxData are met:
1444 #( >= 16 and == n*16 and <= MAX_DATA_BYTES!)
1445 if maxData > BootStrapLoader.MAX_DATA_BYTES:
1446 maxData = BootStrapLoader.MAX_DATA_BYTES
1449 bsl.maxData = maxData - (maxData % 16)
1450 sys.stderr.write( "Max. number of data bytes within one frame set to %i.\n" % maxData)
1451 elif o in ("-m", "--erasecycles"):
1453 meraseCycles = int(a) #try to convert decimal
1455 sys.stderr.write("erasecycles must be a valid number\n")
1457 #sanity check of value
1458 if meraseCycles < 1:
1459 sys.stderr.write("erasecycles must be a positive number\n")
1461 if meraseCycles > 20:
1462 sys.stderr.write("warning: erasecycles set to a large number (>20): %d\n" % meraseCycles)
1463 sys.stderr.write( "Number of mass erase cycles set to %i.\n" % meraseCycles)
1464 bsl.meraseCycles = meraseCycles
1465 elif o in ("-e", "--masserase"):
1466 toinit.append(bsl.actionMassErase) #Erase Flash
1467 elif o in ("-E", "--erasecheck"):
1468 toinit.append(bsl.actionEraseCheck) #Erase Check (by file)
1469 elif o in ("-p", "--program"):
1470 todo.append(bsl.actionProgram) #Program file
1471 elif o in ("--fromweb"):
1472 toinit.append(bsl.actionMassErase) #Erase Flash
1473 todo.append(bsl.actionFromweb) #Program GoodFET code
1474 elif o in ("-v", "--verify"):
1475 todo.append(bsl.actionVerify) #Verify file
1476 elif o in ("-r", "--reset"):
1478 elif o in ("-g", "--go"):
1480 goaddr = int(a) #try to convert decimal
1483 goaddr = int(a[2:],16) #try to convert hex
1485 sys.stderr.write("go address must be a valid number\n")
1488 elif o in ("-U", "--unpatched"):
1490 elif o in ("-D", "--debug"):
1492 elif o in ("-u", "--upload"):
1494 startaddr = int(a) #try to convert decimal
1497 startaddr = int(a,16) #try to convert hex
1499 sys.stderr.write("upload address must be a valid number\n")
1501 elif o in ("-s", "--size"):
1508 sys.stderr.write("size must be a valid number\n")
1510 elif o in ("-x", "--hex"):
1512 elif o in ("-b", "--bin"):
1514 elif o in ("-I", "--intelhex"):
1516 elif o in ("-T", "--titext"):
1518 elif o in ("-N", "--notimeout"):
1520 elif o in ("-B", "--bsl"):
1521 bslrepl = Memory() #File to program
1523 elif o in ("-V", "--bslversion"):
1524 todo.append(bsl.actionReadBSLVersion) #load replacement BSL as first item
1525 elif o in ("-S", "--speed"):
1527 speed = int(a) #try to convert decimal
1529 sys.stderr.write("speed must be decimal number\n")
1531 elif o in ("-1", "--f1x"):
1533 elif o in ("-2", "--f2x"):
1535 elif o in ("-4", "--f4x"):
1537 elif o in ("--invert-reset", ):
1539 elif o in ("--invert-test", ):
1541 elif o in ("--swap-reset-test", ):
1543 elif o in ("--telos-latch", ):
1545 elif o in ("--telos-i2c", ):
1547 elif o in ("--telos", ):
1552 elif o in ("--goodfet10", ):
1555 elif o in ("--goodfet20", ):
1558 elif o in ("--goodfet30", ):
1561 elif o in ("--telosb", ):
1566 elif o in ("--tmote", ):
1571 elif o in ("--no-BSL-download", ):
1573 elif o in ("--force-BSL-download", ):
1575 elif o in ("--slow", ):
1579 sys.stderr.write("Use -h for help\n");
1580 sys.stderr.write("Use --fromweb to upgrade a GoodFET.\n")
1581 elif len(args) == 1: #a filename is given
1582 if not todo: #if there are no actions yet
1583 todo.extend([ #add some useful actions...
1588 else: #number of args is wrong
1592 if DEBUG: #debug infos
1593 sys.stderr.write("Debug level set to %d\n" % DEBUG)
1594 sys.stderr.write("Python version: %s\n" % sys.version)
1596 #sanity check of options
1597 if notimeout and goaddr is not None and startaddr is not None:
1598 sys.stderr.write("Option --notimeout can not be used together with both --upload and --go\n")
1602 sys.stderr.write("Warning: option --notimeout can cause improper function in some cases!\n")
1605 if goaddr and reset:
1606 sys.stderr.write("Warning: option --reset ignored as --go is specified!\n")
1609 if startaddr and reset:
1610 sys.stderr.write("Warning: option --reset ignored as --upload is specified!\n")
1615 #prepare data to download
1616 bsl.data = Memory() #prepare downloaded data
1617 if filetype is not None: #if the filetype is given...
1618 if filename is None:
1619 raise ValueError("no filename but filetype specified")
1620 if filename == '-': #get data from stdin
1623 file = open(filename, "rb") #or from a file
1624 if filetype == 0: #select load function
1625 bsl.data.loadIHex(file) #intel hex
1627 bsl.data.loadTIText(file) #TI's format
1629 raise ValueError("illegal filetype specified")
1630 else: #no filetype given...
1631 if filename == '-': #for stdin:
1632 bsl.data.loadIHex(sys.stdin) #assume intel hex
1634 bsl.data.loadFile(filename) #autodetect otherwise
1636 if DEBUG > 3: sys.stderr.write("File: %r" % filename)
1638 bsl.comInit(comPort) #init port
1640 #initialization list
1641 if toinit: #erase and erase check
1642 if DEBUG: sys.stderr.write("Preparing device ...\n")
1643 #bsl.actionStartBSL(usepatch=0, adjsp=0) #no workarounds needed
1644 #if speed: bsl.actionChangeBaudrate(speed) #change baud rate as fast as possible
1645 for f in toinit: f()
1647 if todo or goaddr or startaddr:
1648 if DEBUG: sys.stderr.write("Actions ...\n")
1651 usepatch=not unpatched,
1652 replacementBSL=bslrepl,
1654 mayuseBSL=mayuseBSL,
1660 if DEBUG > 0: #debug
1661 #show a nice list of sheduled actions
1662 sys.stderr.write("TODO list:\n")
1665 sys.stderr.write(" %s\n" % f.func_name)
1666 except AttributeError:
1667 sys.stderr.write(" %r\n" % f)
1668 for f in todo: f() #work through todo list
1670 if reset: #reset device first if desired
1673 bsl.txPasswd(); #default pass
1674 data=bsl.uploadData(0xc00,1024);
1677 hex+=("%02x "%ord(c));
1680 bsl.txPasswd(); #default pass
1681 data=bsl.uploadData(0x1000,256);
1684 hex+=("%02x "%ord(c));
1688 if goaddr is not None: #start user programm at specified address
1689 bsl.actionRun(goaddr) #load PC and execute
1691 #upload datablock and output
1692 if startaddr is not None:
1693 if goaddr: #if a program was started...
1694 #don't restart BSL but wait for the device to enter it itself
1695 sys.stderr.write("Waiting for device to reconnect for upload: ")
1697 bsl.txPasswd(bsl.passwd, wait=1) #synchronize, try forever...
1698 data = bsl.uploadData(startaddr, size) #upload data
1700 data = bsl.uploadData(startaddr, size) #upload data
1701 if hexoutput: #depending on output format
1703 while m < len(data): #print a hex display
1704 print hexify(startaddr+m, map(ord,data[m:m+16]))
1707 sys.stdout.write(data) #binary output w/o newline!
1708 wait = 0 #wait makes no sense as after the upload the device is still in BSL
1710 if wait: #wait at the end if desired
1711 sys.stderr.write("Press <ENTER> ...\n") #display a prompt
1713 raw_input() #wait for newline
1715 bsl.comDone() #Release serial communication port
1717 if __name__ == '__main__':
1721 raise #let pass exit() calls
1722 except KeyboardInterrupt:
1723 if DEBUG: raise #show full trace in debug mode
1724 sys.stderr.write("user abort.\n") #short messy in user mode
1725 sys.exit(1) #set errorlevel for script usage
1726 except Exception, msg: #every Exception is caught and displayed
1727 if DEBUG: raise #show full trace in debug mode
1728 sys.stderr.write("\nAn error occoured:\n%s\n" % msg) #short messy in user mode
1729 sys.exit(1) #set errorlevel for script usage